Code Engine REST API 入門指南

您可以使用 IBM Cloud® Code Engine API 來建立和管理您的 Code Engine 實體。

設定您的 API 環境

若要使用 API 來建立及管理 Code Engine 實體，請設定 API 環境。

開始之前，請下載並安裝 jq 工具，這是輕量型且彈性的指令行 JSON 處理器。此工具可讓您更容易使用從 Code Engine API 收到的 JSON 回應。

在 API 中執行範例 Curl 指令之前，請先設定 region、api_key 及 project_name 的值。例如，
```
region=us-south
api_key=YOUR_IBM_CLOUD_API_KEY
project_name=MY_PROJECT_NAME
```
- 若要探索您登入的 IBM Cloud 地區，請執行 ibmcloud region 指令。
- 如需 IBM Cloud API 金鑰的相關資訊，請參閱管理使用者 API 金鑰。
- 如需 Code Engine 專案的相關資訊，請參閱管理專案。

請檢查您是否具有有效的 IBM Cloud® Identity and Access Management (IAM) 存取記號。如需 IAM API 的相關資訊，請參閱使用 API 金鑰為使用者或服務 ID 建立 IAM 存取記號。

token=`curl -X POST "https://iam.cloud.ibm.com/identity/token" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -H "Accept: application/json" \
  -d "grant_type=urn:ibm:params:oauth:grant-type:apikey" \
  -d "apikey=${api_key}" \
  | jq .access_token -r`

使用鑑別記號和您在步驟 1 中定義的變數來擷取專案的專案 ID。在下列範例中，搭配使用 curl 與 jq，以剖析 Code Engine API 回應，並將專案 ID 儲存在變數中。例如，

project_id=`curl -X GET "https://api.${region}.codeengine.cloud.ibm.com/v2/projects" \
   -H "Authorization: ${token}" \
   | jq --arg project_name ${project_name} '.projects[] | select(.name == $project_name) | .id' -r`

在 API 中使用 Code Engine 應用程式

現在已設定 Code Engine API 環境，您已準備好使用 Code Engine 實體，例如應用程式或工作。在下列實務範例中，讓我們建立應用程式，存取它，然後刪除應用程式。

建立應用程式。使用先前設定的變數和專案 ID 來建構 URL，並傳送建立 my-app 應用程式的要求。例如，

curl -X POST "https://api.${region}.codeengine.cloud.ibm.com/v2/projects/${project_id}/apps" \
  -H "Authorization: ${token}" \
  -H "Content-Type: application/json" \
  -d '{ \
    "name": "my-app", \
    "image_reference": "icr.io/codeengine/helloworld" \
  }'

若要顯示 my-app 應用程式的詳細資料，請傳送 GET 要求。請務必參照應用程式的名稱。請注意，jq 的最後一行是選用的，但它會讓輸出更容易讀取。

curl -X GET "https://api.${region}.codeengine.cloud.ibm.com/v2/projects/${project_id}/apps/my-app" \
  -H "Authorization: ${token}" \
  -H "Content-Type: application/json" \
  | jq .

若要刪除應用程式，請重新傳送要求，但這次請使用 DELETE 方法而非 GET 方法。

curl -X DELETE "https://api.${region}.codeengine.cloud.ibm.com/v2/projects/${project_id}/apps/my-app" \
  -H "Authorization: ${token}" \
  -H "Content-Type: application/json"

(選用) 如果您傳送另一個 GET 要求來擷取 my-app 的相關資訊，則會收到 404 error，因為資源已不存在。

輸出範例

{
  "errors": [
    {
      "code": "resource_not_found",
      "message": "Resource not found."
    }
  ],
  "trace": "codeengine-api-34dc0040429941de8c9e02f0f1200af1",
  "status_code": 404
}

下一步

既然您已設定環境並使用 API 來採取 Code Engine 應用程式的首要步驟，您是否準備好進一步探索 Code Engine API?

如需數種語言的 Code Engine SDK 的相關資訊及範例，請參閱 Code Engine API 文件。

若要使用 API 開始使用 Code Engine 元件，請參閱

IBM Cloud® Code Engine 是設計成您不需要與建置它所依據的基礎技術互動。不過，如果您具有以 Kubernetes 或 Knative 為基礎的現有工具，則仍然可以將它與 Code Engine搭配使用。Code Engine 支援 Knative 和 Kubernetes API 及其 CLI 指令。如需相關資訊，請參閱搭配使用 Kubernetes 與 Code Engine 及搭配使用 Knative 與 Code Engine。