指令選項

--name, -n

要綁定的應用程式名稱。 此值為必填項目。

--no-wait, --nw

綁定服務實體，不要等待服務綁定就緒。 如果您指定 no-wait 選項，則會啟動服務連結建立，且指令會結束而不等待它完成。 使用 app get 指令來檢查應用程式連結狀態。 此值為選項。 預設值為 false。

--prefix, -p

針對此服務連結建立之環境變數的字首。 只能包含大寫字母、數字及底線 (_)，且不能以數字開頭。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

--role, -r

為此服務綁定建立的新服務憑證的服務角色名稱。 有效值包括 Reader, Writer, Manager 或特定於服務的角色。 選項預設為 Manager，如果不支援 Manager，則為服務提供的第一個角色。 如果指定 --service-credential，則會忽略此選項。 此值為選項。

為此服務綁定建立的新服務憑證的服務角色名稱。 有效值包括 Reader, Writer, Manager 或特定於服務的角色。 選項預設為 Manager，如果不支援 Manager，則為服務提供的第一個角色。 如果指定 --service-credential，則會忽略此選項。 此值為選項。

--service-credential, --sc

要用於此服務綁定的現有服務憑證的名稱。 如果您未指定服務實例認證，則會在連結動作期間產生新認證。 此值為選項。

--service-instance, --si

要連結至應用程式的現有 IBM Cloud 服務實例名稱。 此值為選項。

--service-instance-id, --siid

要連結至應用程式之現有 IBM Cloud 服務實例的 GUID。 此值為選項。

--wait, -w

綁定服務實體，並等待服務綁定就緒。 如果您指定 --wait 選項，應用程式連結會等待 --wait-timeout 選項所設定的時間上限 (以秒為單位)，讓應用程式連結順利完成。 如果應用程式連結未順利完成或在指定的 --wait-timeout 期間內失敗，則指令會失敗。 此值為選項。 預設值為 true。

--wait-timeout, --wto

等待服務綁定就緒的時間長度 (以秒為單位)。 如果指定 --wait 選項，則需要此值。 如果指定 --no-wait 選項，則會忽略此值。 預設值為 300。

範例

在此範例中，將稱為 my-object-storage 的 IBM Cloud Object Storage 服務實例連結至稱為 myapp 的應用程式。

ibmcloud ce application bind --name myapp --service-instance my-object-storage

輸出範例

Binding service instance...
Waiting for service binding to become ready...
Status: Pending (Processing Resource)
Status: Pending (Processing Resource)
Status: Creating service binding
Status: Creating service binding
Status: Ready
Waiting for application revision to become ready...
Traffic is not yet migrated to the latest revision.
Ingress has not yet been reconciled.
Waiting for load balancer to be ready
OK

指令選項

-n, --name

應用程式的名稱。 請使用專案內唯一的名稱。

• 名稱必須以小楷字母開頭。
• 名稱必須以小寫英數字元結尾。
• 名稱必須是 63 個字元或更少，且可以包含小寫字母、數字及連字號 (-)。

此值為必填項目。

--argument, --arg, -a

設定應用程式的引數。 為每個 --argument 選項指定一個引數; 例如 -a argA -a argB。 此值會置換儲存器映像檔內指定的預設值。 此值為選項。

--build-commit, --commit, --bcm, --cm, --revision

來源儲存庫中要取回的確定、標籤或分支。 只有在設定 --build-source 選項時，才容許建置確定選項。 此值為選項。

--build-context-dir, --context-dir, --bcdr, --cdr

儲存庫中包含建置套件檔案或 Dockerfile 的目錄。 只有在設定 --build-source 選項時，才容許建置環境定義目錄選項。 此值為選項。

--build-dockerfile, --dockerfile, --bdf, --df

Dockerfile 的路徑。 只有在名稱不是 Dockerfile 時，才指定此選項。 只有在設定 --build-source 選項時，才容許建置 dockerfile 選項。 此值為選項。 預設值為 Dockerfile。

--build-git-repo-secret, --git-repo-secret, --bgrs, --grs, --repo

SSH 密鑰的名稱，其中包含用來存取專用儲存庫的認證，該專用儲存庫包含用來建置容器映像檔的原始碼。 若要建立此 SSH 密鑰，請使用 secret create --format SSH 指令。 SSH 密鑰也用作 Git 儲存庫存取密鑰。 只有在 --build-source 選項設定為 Git 儲存庫的 URL 時，才允許使用此選項。 此值為選項。

--build-size, --size, --bsz, --sz

建立的大小，決定使用的資源量。 有效值為 small, medium, large, xlarge，和 xxlarge。 如需詳細資料，請參閱 判斷建置的大小。 只有在設定 --build-source 選項時，才容許建置大小選項。 此值為選項。 預設值為 medium。

--build-source, --source, --bsrc, --src

Git 儲存庫的 URL 或包含您原始碼的本機原始碼路徑；例如 https://github.com/IBM/CodeEngine 或 .。 此值為選項。

--build-strategy, --strategy, --bstr, --str

用於建置映像檔的策略。 有效值為 dockerfile 和 buildpacks。 只有在設定 --build-source 選項時，才容許建置策略選項。 如果未指定，則建置策略由 Code Engine 決定 (如果指定 --build-source 且來源位於本端機器上)。 此值為選項。 預設值為 dockerfile。

--build-timeout, --bto

在建置必須成功或失敗之前可以經過的時間量 (秒)。 只有在設定 --build-source 選項時，才容許建置逾時選項。 此值為選項。 預設值為 600。

--cluster-local, --cl

使用僅限專案端點來部署應用程式。 設定專案專用端點表示您的應用程式無法從公共網際網路存取，網路存取只能從在同一專案中執行的其他 Code Engine 元件進行。 此值為選項。 預設值為 false。

--command, --cmd, -c

設定應用程式的指令。 為每個 --command 選項指定一個指令; 例如 --cmd cmdA --cmd cmdB。 此值會置換儲存器映像檔內指定的預設指令。 此值為選項。

--concurrency, --cn

每個實體可同時處理的最大請求次數。 此值為選項。 預設值為 100。

--concurrency-target, --ct

在其中建立一個以上其他實例的每個實例的並行要求數臨界值。 使用此值可根據並行要求數擴增實例。 如果未指定 --concurrency-target，則此選項預設為 --concurrency 選項的值。 此值為選項。 預設值為 0。

--cpu

為應用程式實例設定的 CPU 數量。 如需有效值，請參閱 支援的記憶體及 CPU 組合。 此值為選項。 預設值為 1。

--env, -e

在應用程式中設定環境變數。 必須為 NAME=VALUE 格式。 此動作會新增環境變數或置換現有的環境變數。 為每個 --env 選項指定一個環境變數; 例如 --env envA=A --env envB=B。 此值為選項。

--env-cm, --env-from-configmap

使用下列其中一種方式，從儲存在此 configmap 中的鍵值組設定環境變數:

• 若要為名為 configmapName 的配置對映中的所有索引鍵新增環境變數，請使用值 configmapName。 您可以在參照 configmap 時指定字首來修改環境變數名稱。 若要指定字首，請使用值 PREFIX=CONFIGMAP_NAME。 每一個產生的環境變數都具有格式 <PREFIX><NAME_OF_KEY_IN_CONFIGMAP>。 例如，若要將 configmap configmapName 中金鑰的所有變數名稱的字首設為 CUSTOM_，請使用值 CUSTOM_=configmapName。 如果 configmap configmapName 包含 KEY_A，則環境變數名稱為 CUSTOM_KEY_A。
• 若要新增個別金鑰的環境變數，請使用格式 NAME:KEY_A,KEY_B。 例如，若要在名為 configmapName 的 configmap 中為單一索引鍵 key1 新增環境變數，請使用值 configmapName:key1。 若要將不同的名稱指派給參照的金鑰，請使用 NAME:NEW_NAME=KEY_A 格式。 例如，若要在名為 configmapName 的 configmap 中為單一索引鍵 key1 新增名為 myKey 的環境變數，請使用值 configmapName:myKey=key1。

此值為選項。

--env-sec, --env-from-secret

使用下列其中一種方式，從儲存在密鑰中的鍵值組設定環境變數:

• 若要在名為 secretName 的密鑰中新增所有金鑰的環境變數，請使用值 secretName。 您可以在參照密鑰時指定字首來修改環境變數名稱。 若要指定字首，請使用值 PREFIX=SECRET_NAME。 每一個產生的環境變數都具有格式 <PREFIX><NAME_OF_KEY_IN_SECRET>。 例如，若要將密鑰 secretName 中金鑰的所有變數名稱的字首設為 CUSTOM_，請使用值 CUSTOM_=secretName。 如果密鑰 secretName 包含 KEY_A，則環境變數名稱為 CUSTOM_KEY_A。
• 若要新增個別金鑰的環境變數，請使用格式 NAME:KEY_A,KEY_B。 例如，若要在名為 secretName 的密鑰中為單一金鑰 key1 新增環境變數，請使用值 secretName:key1。 若要將不同的名稱指派給參照的金鑰，請使用 NAME:NEW_NAME=KEY_A 格式。 例如，若要在名為 secretName 的密鑰中為單一金鑰 key1 新增名為 myKey 的環境變數，請使用值 secretName:myKey=key1。

此值為選項。

--ephemeral-storage, --es

要為應用程式實例設定的暫時儲存體數量。 使用 M 表示 megabytes，使用 G 表示 gigabytes。 此值為選項。 預設值為 400M。

--force, -f

請勿驗證指定的 configmap 和密鑰參照是否存在。 Configmap 參照是使用 --env-from-configmap 或 --mount-configmap 選項來指定。 密鑰參照以 --env-from-secret、--mount-secret 或 --registry-secret 選項指定。 此值為選項。 預設值為 false。

--image, -i

用於此應用程式的映像檔名稱。 格式為 REGISTRY/NAMESPACE/REPOSITORY:TAG，其中 REGISTRY 和 TAG 為選項。 如果未指定 REGISTRY，則默認為 docker.io。 如果未指定 TAG，則默認為 latest。 如果未指定 --build-source 選項，則必須使用 image 選項。 此值為選項。

--max-scale, --max, --maxscale

可用於此應用程式的實例數上限。 如果將此值設定為 0，應用程式會視需要調整比例。 應用程式調整大小僅受限於應用程式專案的每個資源配額的實例數。 請參閱 Code Engine的限制和配額。 此值為選項。 預設值為 10。

--memory, -m

為應用程式實例設定的記憶體數量。 使用 M 表示 megabytes，使用 G 表示 gigabytes。 如需有效值，請參閱 支援的記憶體及 CPU 組合。 此值為選項。 預設值為 4G。

--min-scale, --min, --minscale

可用於此應用程式的實例數下限。 此選項有助於確保在不需要時沒有任何實例在執行中。 此值為選項。 預設值為 0。

--mount-configmap, --mount-cm

透過提供裝載目錄及 configmap 名稱 (格式為 MOUNT_DIRECTORY=CONFIGMAP_NAME)，將 configmap 的內容新增至應用程式儲存器的檔案系統。 每一個裝載的 configmap 都必須使用唯一的裝載目錄。 對於 configmap 中的每一個鍵值組，會將一個檔案新增至指定的裝載目錄，其中檔名是索引鍵，檔案內容是鍵值組的值。 為每個 --mount-configmap 選項指定一個裝載配置; 例如 --mount-configmap /etc/config-a=config-a --mount-configmap /etc/config-b=config-b。 此值為選項。

--mount-data-store, --mount-ds

裝載持續資料儲存庫。 格式為 MOUNT_DIRECTORY=STORAGE_NAME [:SUBPATH]。 SUBPATH 是可選的。 此選項可以指定多次。 此值為選項。

--mount-secret, --mount-sec

透過提供裝載目錄及密鑰名稱 (格式為 MOUNT_DIRECTORY=SECRET_NAME)，將密鑰內容新增至應用程式儲存器的檔案系統。 每一個裝載密鑰都必須使用唯一的裝載目錄。 對於密鑰中的每一個鍵值組，會將一個檔案新增至指定的裝載目錄，其中檔名是金鑰，檔案的內容是鍵值組的值。 為每個 --mount-secret 選項指定一個裝載配置; 例如 --mount-secret /etc/secret-a=secret--a --mount-secret /etc/secret-b=secret-b。 此值為選項。

--no-cluster-local, --ncl

部署帶有公用端點的應用程式。 應用程式的部署方式是，它可以接收來自公共網際網路或 Code Engine 專案內元件的請求。 此值為選項。 預設值為 true。

--no-wait, --nw

建立應用程式，且不等待應用程式備妥。 如果您指定 --no-wait 選項，則應用程式會開始建立，且不會等待。 使用 app get 指令來檢查應用程式狀態。 此值為選項。 預設值為 false。

--output, -o

指定指令輸出的格式。 有效值為 json, yaml, jsonpath=JSONPATH_EXPRESSION, jsonpath-as-json=JSONPATH_EXPRESSION, url，和 project-url。 使用 jsonpath 來指定 JSON 輸出元素的路徑。 此值為選項。

--port, -p

應用程式接聽所在的埠。 格式為 [NAME:]PORT，其中 [NAME:] 為選項。 如果指定 [NAME:]，則有效值為 h2c 或 http1。 當 [NAME:] 未指定或為 http1 時，埠會使用 HTTP/1.1。 當 [NAME:] 為 h2c 時，埠會使用未加密的 HTTP/2。 依預設，Code Engine 會假設應用程式在埠 8080 上接聽送入的連線。 如果您的應用程式需要在埠 8080 以外的埠上接聽，請使用 --port 來指定埠。 此值為選項。

--probe-live, --pl

以 NAME=VALUE 格式配置此應用程式的活性探測。 NAME 的有效選項為: type、port、path、interval、initial-delay、timeout、failure-threshold。此選項可以指定多次。 需要 type 內容，有效值為 tcp 和 http。 例如，--probe-live類型=tcp --probe-liveport=8080。 如需使用探測器的相關資訊，如需使用探測器的相關資訊，請參閱 配置應用程式的探測器。 此值為選項。

--probe-ready, --pr

以 NAME=VALUE 格式配置此應用程式的就緒探測。 NAME 的有效選項為: type、port、path、interval、initial-delay、timeout、failure-threshold。此選項可以指定多次。 需要 type 內容，有效值為 tcp 和 http。 例如，--probe-ready類型=tcp --probe-readyport=8080。 如需使用探測器的相關資訊，如需使用探測器的相關資訊，請參閱 配置應用程式的探測器。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

--registry-secret, --rs

登錄密鑰的名稱。 當您下載容器映像檔時，會使用登錄密鑰向專用登錄進行鑑別。 此值為選項。

--request-timeout, --rt, --timeout, -t

在對應用程式提出的要求必須成功或失敗之前，可以經過的時間量 (以秒為單位)。 此值為選項。 預設值為 300。

--rn, --revision-name

修訂的名稱。 使用在應用程式中唯一的名稱。

• 名稱可以包含小寫字母、數字和連字符 (-)。
• 名稱必須以小寫英數字元結尾。
• 完整修訂名稱必須採用 Name_of_application-Name of revision 格式。
• 完整修訂名稱必須不超過 63 個字元。

此值為選項。

--scale-down-delay, --sdd

縮減應用程式之前，必須以減少並行處理的時間（秒）。 並行要求數目增加會導致應用程式擴增。 如果捨棄的要求數 (減少的並行性)，這個選項的指定時間量會決定縮減應用程式之前，減少的並行性需要持續多久。 依預設，如果偵測到減少的並行性，則會立即縮減應用程式。 此值為選項。 預設值為 0。

--service-account, --sa

服務帳戶的名稱。 服務帳戶提供在實例中執行之程序的身分。 對於內建服務帳戶，您可以使用縮短的名稱 manager、none、reader 及 writer。 您也可以使用字首為 Kubernetes Config Context 的完整名稱，可以使用 project current 指令來判定。 此值為選項。

--trusted-profiles-enabled, --trusted, --tpe

啟用計算資源記號裝載到此應用程式的儲存器。 此值為選項。 預設值為 false。

--user, -u

用來執行應用程式的使用者 ID (UID)。 此值會置換在應用程式 Dockerfile 中設定的任何使用者 ID。 ID 必須符合儲存器的作業系統需求。 此值為選項。 預設值為 0。

--visibility, -v

應用程式的可見性。 有效值為 public, private，和 project。 設定 public 的可見性表示您的應用程式可以接收來自公用網際網路或來自 Code Engine 專案內元件的要求。 設定 private 的可見性表示無法從公用網際網路存取您的應用程式，且只能從相同專案中執行的其他 IBM Cloud 使用「虛擬專用端點 (VPE)」或 Code Engine 元件進行網路存取。 只有在專案支援應用程式私有可見性的情況下，才能 private。 設定能見度為 project 表示您的應用程式無法從公共網際網路存取，只有在同一專案中執行的其他 Code Engine 元件才能進行網路存取。 此值為選項。

--wait, -w

建立應用程式並等待應用程式備妥。 如果您指定 --wait 選項，則應用程式建立會等待 --wait-timeout 選項所設定的時間上限 (以秒為單位)，讓應用程式變成備妥。 如果應用程式在指定的 wait-timeout 期間內未備妥，則應用程式建立會失敗。 此值為選項。 預設值為 true。

--wait-timeout, --wto

等待應用程式就緒的時間長度 (以秒為單位)。 如果指定 --wait 選項，則需要此值。 如果指定 --no-wait 選項，則會忽略此值。 預設值為 600。

範例

ibmcloud ce application create --name myapp --image icr.io/codeengine/hello

輸出範例

Creating application 'myapp'...
[...]
Run `ibmcloud ce application get -n 'myapp'` to check the application status.
OK

https://myapp.4svg40kna19.us-south.codeengine.appdomain.cloud

執行 ibmcloud ce application get -n 'myapp' 檢查應用程式狀態時，會顯示應用程式的 URL。

指令選項

--name, -n

應用程式的名稱。 此值為必填項目。

--force, -f

強制刪除，而不進行確認。 此值為選項。 預設值為 false。

--ignore-not-found, --inf

如果找不到，請不要失敗。 此值為選項。 預設值為 false。

--no-wait, --nw

刪除應用程式，且不等待刪除應用程式。 如果您指定 no-wait 選項，則應用程式刪除會開始且不等待。 使用 app get 指令來檢查應用程式狀態。 此值為選項。 預設值為 true。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

--wait, -w

刪除應用程式並等待刪除應用程式。 如果您指定 --wait 選項，應用程式刪除會等待 --wait-timeout 選項所設定的時間上限 (以秒為單位)，讓應用程式變成已刪除。 如果在指定的 --wait-timeout 期間內未刪除應用程式，則應用程式刪除會失敗。 此值為選項。 預設值為 false。

--wait-timeout, --wto

等待刪除應用程式的時間長度 (以秒為單位)。 如果指定 --wait 選項，則需要此值。 如果指定 --no-wait 選項，則會忽略此值。 預設值為 600。

範例

ibmcloud ce application delete --name myapp -f

輸出範例

Deleted application 'myapp'

指令選項

--application, --app, -a, --name, -n

顯示所指定應用程式之所有實例的事件。 如果未指定 --instance，則需要此值。

--instance, -i

特定應用程式實例的名稱。 使用 app get 指令來尋找實例名稱。 如果未指定 --application，則需要此值。

--output, -o

指定指令輸出的格式。 有效值為 json、yaml、jsonpath=JSONPATH_EXPRESSION 及 jsonpath-as-json=JSONPATH_EXPRESSION。 使用 jsonpath 來指定 JSON 輸出元素的路徑。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

範例

下列範例顯示所指定應用程式之所有實例的系統事件資訊。

ibmcloud ce application events --application myapp

Getting events for all instances of application 'myapp'...
OK

myapp-atfte-1-deployment-6b49c5fb85-kf4m2:
    Type    Reason     Age  Source                Messages
    Normal  Scheduled  31s  default-scheduler     Successfully assigned 4svg40kna19/myapp-atfte-1-deployment-6b49c5fb85-kf4m2 to 10.240.0.15
    Normal  Pulling    29s  kubelet, 10.240.0.15  Pulling image "icr.io/codeengine/hello@sha256:f0dc03250736a7b40a66ee70fee94fc470e08c864197aa2140054fee6ca9f9d6"
    Normal  Pulled     24s  kubelet, 10.240.0.15  Successfully pulled image "icr.io/codeengine/hello@sha256:f0dc03250736a7b40a66ee70fee94fc470e08c864197aa2140054fee6ca9f9d6" in 4.907426108s
    Normal  Created    24s  kubelet, 10.240.0.15  Created container user-container
    Normal  Started    24s  kubelet, 10.240.0.15  Started container user-container
    Normal  Pulled     24s  kubelet, 10.240.0.15  Container image "icr.io/obs/codeengine/knative-serving/queue-39be6f1d08a095bd076a71d288d295b6:v0.20.0-rc1@sha256:8988bea781130827b3e1006e6e5e7f49094343a5505c1927bb832be3470455f6" already present on machine
    Normal  Created    23s  kubelet, 10.240.0.15  Created container queue-proxy
    Normal  Started    23s  kubelet, 10.240.0.15  Started container queue-proxy

指定應用程式實例的系統事件資訊範例

下列範例顯示所指定應用程式實例的系統事件資訊。 使用 app get 指令來顯示應用程式的詳細資料，包括應用程式的執行中實例。

ibmcloud ce application events --instance myapp-li17x-1-deployment-69fd57bcb6-sr9tl

Getting events for application instance 'myapp-li17x-1-deployment-69fd57bcb6-sr9tl'...
OK

myapp-li17x-1-deployment-69fd57bcb6-sr9tl:
    Type     Reason     Age                    Source                Messages
    Normal   Scheduled  6m40s                  default-scheduler     Successfully assigned 4svg40kna19/myapp-li17x-1-deployment-69fd57bcb6-sr9tl to 10.240.64.6
    Normal   Pulling    6m39s                  kubelet, 10.240.64.6  Pulling image "icr.io/codeengine/hello@sha256:f0dc03250736a7b40a66ee70fee94fc470e08c864197aa2140054fee6ca9f9d6"
    Normal   Pulled     6m36s                  kubelet, 10.240.64.6  Successfully pulled image "icr.io/codeengine/hello@sha256:f0dc03250736a7b40a66ee70fee94fc470e08c864197aa2140054fee6ca9f9d6"
    Normal   Created    6m34s                  kubelet, 10.240.64.6  Created container user-container
    Normal   Started    6m33s                  kubelet, 10.240.64.6  Started container user-container
    Normal   Pulled     6m33s                  kubelet, 10.240.64.6  Container image "icr.io/obs/codeengine/knative-serving/queue-39be6f1d08a095bd076a71d288d295b6:v0.19.0-rc3@sha256:9cb525af53896afa6b5210b5ac56a893cf85b6cd013a61cb6503a005e40c5c6f" already present on machine
    Normal   Created    6m33s                  kubelet, 10.240.64.6  Created container queue-proxy
    Normal   Started    6m32s                  kubelet, 10.240.64.6  Started container queue-proxy
    [...]

指令選項

--name, -n

應用程式的名稱。 此值為必填項目。

--output, -o

指定指令輸出的格式。 有效值為 json, yaml, jsonpath=JSONPATH_EXPRESSION, jsonpath-as-json=JSONPATH_EXPRESSION, url，和 project-url。 使用 jsonpath 來指定 JSON 輸出元素的路徑。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

--show-all-revisions, -r

顯示此應用程式的所有修訂。 如果未指定，則只會顯示配置為接收資料流量的修訂。 此值為選項。 預設值為 false。

範例

ibmcloud ce application get --name myapp

輸出範例

Run 'ibmcloud ce application events -n myapp' to get the system events of the application instances.
Run 'ibmcloud ce application logs -f -n myapp' to follow the logs of the application instances.
OK

Name:          myapp
ID:            abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f
Project Name:  myproject
Project ID:    01234567-abcd-abcd-abcd-abcdabcd1111
Age:                31m
Created:            2021-09-09T14:01:02-04:00
URL:                https://myapp.abcdabcdabc.us-south.codeengine.appdomain.cloud
Cluster Local URL:  http://myapp.abcdabcdabc.svc.cluster.local
Console URL:        https://cloud.ibm.com/codeengine/project/us-south/01234567-abcd-abcd-abcd-abcdabcd1111/application/myapp/configuration
Status Summary:     Application deployed successfully  

Environment Variables:    
  Type     Name             Value  
  Literal  CE_API_BASE_URL  https://api.private.us-south.codeengine.cloud.ibm.com
  Literal  CE_APP           myapp  
  Literal  CE_DOMAIN        us-south.codeengine.appdomain.cloud  
  Literal  CE_PROJECT_ID    abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f
  Literal  CE_REGION        us-south  
  Literal  CE_SUBDOMAIN     abcdabcdab  
Image:                  icr.io/codeengine/helloworld  
Resource Allocation:      
  CPU:                1  
  Ephemeral Storage:  400M  
  Memory:             4G  

Revisions:     
  myapp-00001:    
    Age:                42s  
    Latest:             true  
    Traffic:            100%  
    Image:              icr.io/codeengine/helloworld (pinned to 1cee99)  
    Running Instances:  1  

Runtime:       
  Concurrency:       100  
  Maximum Scale:     10  
  Minimum Scale:     0  
  Scale Down Delay:  0  
  Timeout:           300  

Conditions:    
  Type                 OK    Age  Reason  
  ConfigurationsReady  true  25s    
  Ready                true  12s    
  RoutesReady          true  12s    

Events:        
  Type    Reason   Age  Source              Messages  
  Normal  Created  44s  service-controller  Created Configuration "myapp"  
  Normal  Created  43s  service-controller  Created Route "myapp"  

Instances:     
  Name                                    Revision     Running  Status   Restarts  Age  
  myapp-00001-deployment-d59b87654-xkqh7  myapp-00001  3/3      Running  0         43s

指令選項

--output, -o

指定指令輸出的格式。 有效值為 json、yaml、jsonpath=JSONPATH_EXPRESSION 及 jsonpath-as-json=JSONPATH_EXPRESSION。 使用 jsonpath 來指定 JSON 輸出元素的路徑。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

--sort-by, -s

指定清單排序的直欄。 有效值為 name 和 age。 此值為選項。 預設值為 name。

範例

ibmcloud ce app list --sort-by age

輸出範例

Listing all applications...
OK

Name           Status  URL                                                                    Latest                 Age   Conditions  Reason
myapptestapp2  Ready   https://myapptestapp2.4svg40kna19.us-south.codeengine.appdomain.cloud  myapptestapp2-emy0q-1  52s   3 OK / 3
myapptestapp1  Ready   https://myapptestapp1.4svg40kna19.us-south.codeengine.appdomain.cloud  myapptestapp1-ps4ca-1  104s  3 OK / 3
myapp-e        Ready   https://myapp-e.4svg40kna19.us-south.codeengine.appdomain.cloud        myapp-e-gx6xa-1        12m   3 OK / 3
myappd         Ready   https://myappd.4svg40kna19.us-south.codeengine.appdomain.cloud         myappd-lxjxm-1         13m   3 OK / 3
myappc         Ready   https://myappc.4svg40kna19.us-south.codeengine.appdomain.cloud         myappc-qffan-1         14m   3 OK / 3
myappb         Ready   https://myappb.4svg40kna19.us-south.codeengine.appdomain.cloud         myappb-i3hw3-1         15m   3 OK / 3
myapp          Ready   https://myapp.4svg40kna19.us-south.codeengine.appdomain.cloud          myapp-jmxwd-1          17m   3 OK / 3

指令選項

--all-containers, --all

顯示所指定應用程式實例之所有容器的日誌。 此值為選項。 預設值為 false。

--application, --app, -a, --name, -n

顯示所指定應用程式之所有實例的日誌。 如果未指定 --instance，則需要此值。

--follow, -f

遵循應用程式實例的日誌。 使用此選項來串流應用程式實例的日誌。 如果您指定 --follow 選項，則必須輸入 Ctrl+C 以終止此日誌指令。 此值為選項。 預設值為 false。

--instance, -i

特定應用程式實例的名稱。 使用 app get 指令來尋找實例名稱。 如果未指定 --application，則需要此值。

--output, -o

指定指令輸出的格式。 有效值為 json、yaml、jsonpath=JSONPATH_EXPRESSION 及 jsonpath-as-json=JSONPATH_EXPRESSION。 使用 jsonpath 來指定 JSON 輸出元素的路徑。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

--raw, -r

顯示不含實例及容器標籤的日誌。 此值為選項。 預設值為 false。

--tail, -t

將所指定應用程式實例之容器的日誌顯示限制為每個容器的最近行數上限。 例如，若要顯示所指定應用程式實例之儲存器日誌的最後 3 行，請指定 --tail 3。 如果未指定此選項，則會顯示所指定應用程式實例之儲存器的所有日誌行。 此值為選項。 預設值為 -1。

--timestamps, --ts

在日誌輸出的每一行包含時間戳記。 此值為選項。 預設值為 false。

範例

下列範例顯示應用程式特定實例的日誌。 使用 app get 指令來取得應用程式實例的名稱。

ibmcloud ce application logs --instance myapp-zhk9x-1-deployment-6f955f5cc5-abcde

輸出範例

Getting logs for application instance 'myapp-zhk9x-1-deployment-6f955f5cc5-abcde'...
OK

myapp-zhk9x-1-deployment-6f955f5cc5-abcde:
Server running at http://0.0.0.0:8080/

應用程式所有實例的日誌範例

下列範例顯示應用程式所有實例的日誌。

ibmcloud ce application logs --app myapp

Getting application 'myapp'...
Getting revisions for application 'myapp'...
Getting instances for application 'myapp'...
Getting logs for all instances of application 'myapp'...
OK

myapp-zhk9x-1-deployment-6f955f5cc5-abcde:
Server running at http://0.0.0.0:8080/

指令選項

--application, --app, -a, --name, -n

重新啟動所指定應用程式的所有執行中實例。 如果未指定 --instance，則需要此值。

--instance, -i

特定應用程式實例的名稱。 使用 app get 指令來尋找實例名稱。 如果未指定 --application，則需要此值。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

範例

ibmcloud ce application restart --name myapp

輸出範例

Restarting all running instances of application 'myapp'...
OK

指令選項

--name, -n

要解除綁定的應用程式名稱。 此值為必填項目。

--all, -A

解除綁定此應用程式的所有服務實體。 如果未指定 --binding，則需要此值。 預設值為 false。

--binding, -b

要解除綁定的名稱。 執行 ibmcloud ce app get -n APP_NAME 檢視綁定名稱。 如果未指定 --all，則需要此值。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

範例

在此範例中，移除應用程式 myapp 中的所有連結。

ibmcloud ce application unbind --name myapp --all

輸出範例

Removing service bindings...
OK

指令選項

--name, -n

應用程式的名稱。 此值為必填項目。

--argument, --arg, -a

設定應用程式的引數。 為每個 --argument 選項指定一個引數; 例如 -a argA -a argB。 此值為選項。

--arguments-clear, --ac

清除應用程式引數。 此值為選項。 預設值為 false。

--build-clear, --bc

從此應用程式中移除建置的關聯。 僅當您的應用程式目前具有相關聯的建置時，才容許建置清除選項。 此值為選項。 預設值為 false。

--build-commit, --commit, --bcm, --cm, --revision

來源儲存庫中要取回的確定、標籤或分支。 只有在 --build-source 選項設定為此 app update 指令上 Git 儲存庫的 URL，或您的應用程式目前有來自 Git 儲存庫來源的關聯建立時，才允許使用 build commit 選項。 此值為選項。

--build-commit-clear, --commit-clear, --bcmc, --cmc

清除來源儲存庫中要取回的確定、標籤或分支。 如果您的應用程式目前有相關聯的建置，則容許確定清除選項。 此值為選項。 預設值為 false。

--build-context-dir, --context-dir, --bcdr, --cdr

儲存庫中包含建置套件檔案或 Dockerfile 的目錄。 如果在這個 app update 指令上設定 --build-source 選項，或您的應用程式目前有相關聯的建置，則容許建置環境定義目錄選項。 此值為選項。

--build-dockerfile, --dockerfile, --bdf, --df

Dockerfile 的路徑。 只有在名稱不是 Dockerfile 時，才指定此選項。 只有在此 app update 指令上設定 --build-source 選項，或您的應用程式目前具有相關聯的建置時，才容許建置 dockerfile 選項。 此值為選項。 預設值為 Dockerfile。

--build-git-repo-secret, --git-repo-secret, --bgrs, --grs, --repo

SSH 密鑰的名稱，其中包含用來存取專用儲存庫的認證，該專用儲存庫包含用來建置容器映像檔的原始碼。 若要建立此 SSH 密鑰，請使用 secret create --format SSH 指令。 SSH 密鑰也用作 Git 儲存庫存取密鑰。 只有當 --build-source 選項在此 application update 指令上設定為 Git 儲存庫的 URL，或您的應用程式目前有一個來自 Git 儲存庫來源的關聯建立，才允許使用此選項。 此值為選項。

--build-git-repo-secret-clear, --git-repo-secret-clear, --bgrsc, --grsc

清除 SSH 密鑰。 如果您的應用程式目前具有相關聯的建置，則容許此選項。 此值為選項。 預設值為 false。

--build-size, --size, --bsz, --sz

建立的大小，決定使用的資源量。 有效值為 small, medium, large, xlarge，和 xxlarge。 如需詳細資料，請參閱 判斷建置的大小。 只有在這個 app update 指令中設定 --build-source 選項，或您的應用程式目前有相關聯的建置時，才容許建置大小選項。 此值為選項。 預設值為 medium。

--build-source, --source, --bsrc, --src

Git 儲存庫的 URL 或包含您原始碼的本機原始碼路徑；例如 https://github.com/IBM/CodeEngine 或 .。 此值為選項。

--build-strategy, --strategy, --bstr, --str

用於建置映像檔的策略。 有效值為 dockerfile 和 buildpacks。 只有在這個 app update 指令中設定 --build-source 選項，或您的應用程式目前有相關聯的建置時，才容許建置策略選項。 如果未指定，則建置策略由 Code Engine 決定 (如果指定 --build-source 且來源位於本端機器上)。 此值為選項。 預設值為 dockerfile。

--build-timeout, --bto

在建置必須成功或失敗之前可以經過的時間量 (秒)。 只有在這個 app update 指令中設定 --build-source 選項，或您的應用程式目前有相關聯的建置時，才容許建置逾時選項。 此值為選項。 預設值為 600。

--cluster-local, --cl

使用僅限專案端點來部署應用程式。 設定專案專用端點表示您的應用程式無法從公共網際網路存取，網路存取只能從在同一專案中執行的其他 Code Engine 元件進行。 此值為選項。 預設值為 false。

--command, --cmd, -c

設定應用程式的指令。 為每個 --command 選項指定一個指令; 例如 --cmd cmdA --cmd cmdB。 此值會置換儲存器映像檔內指定的預設指令。 此值為選項。

--commands-clear, --cc

清除應用程式指令。 此值為選項。 預設值為 false。

--concurrency, --cn

每個實體可同時處理的最大請求次數。 此值為選項。 預設值為 0。

--concurrency-target, --ct

在其中建立一個以上其他實例的每個實例的並行要求數臨界值。 使用此值可根據並行要求數擴增實例。 如果未指定 --concurrency-target，則此選項預設為 --concurrency 選項的值。 此值為選項。 預設值為 0。

--cpu

為應用程式實例設定的 CPU 數量。 如需有效值，請參閱 支援的記憶體及 CPU 組合。 此值為選項。 預設值為 0。

--env, -e

在應用程式中設定環境變數。 必須為 NAME=VALUE 格式。 此動作會新增環境變數或置換現有的環境變數。 為每個 --env 選項指定一個環境變數; 例如 --env envA=A --env envB=B。 此值為選項。

--env-cm, --env-from-configmap

使用下列其中一種方式，從儲存在此 configmap 中的鍵值組設定環境變數:

• 若要為名為 configmapName 的配置對映中的所有索引鍵新增環境變數，請使用值 configmapName。 您可以在參照 configmap 時指定字首來修改環境變數名稱。 若要指定字首，請使用值 PREFIX=CONFIGMAP_NAME。 每一個產生的環境變數都具有格式 <PREFIX><NAME_OF_KEY_IN_CONFIGMAP>。 例如，若要將 configmap configmapName 中金鑰的所有變數名稱的字首設為 CUSTOM_，請使用值 CUSTOM_=configmapName。 如果 configmap configmapName 包含 KEY_A，則環境變數名稱為 CUSTOM_KEY_A。
• 若要新增個別金鑰的環境變數，請使用格式 NAME:KEY_A,KEY_B。 例如，若要在名為 configmapName 的 configmap 中為單一索引鍵 key1 新增環境變數，請使用值 configmapName:key1。 若要將不同的名稱指派給參照的金鑰，請使用 NAME:NEW_NAME=KEY_A 格式。 例如，若要在名為 configmapName 的 configmap 中為單一索引鍵 key1 新增名為 myKey 的環境變數，請使用值 configmapName:myKey=key1。

此值為選項。

--env-from-configmap-rm, --env-cm-rm

使用 configmap 名稱來移除完整配置對映的環境變數參照。 若要移除配置對映的個別金鑰參照，請使用 --env-rm 選項。 此選項可以指定多次。 此值為選項。

--env-sec, --env-from-secret

使用下列其中一種方式，從儲存在密鑰中的鍵值組設定環境變數:

• 若要在名為 secretName 的密鑰中新增所有金鑰的環境變數，請使用值 secretName。 您可以在參照密鑰時指定字首來修改環境變數名稱。 若要指定字首，請使用值 PREFIX=SECRET_NAME。 每一個產生的環境變數都具有格式 <PREFIX><NAME_OF_KEY_IN_SECRET>。 例如，若要將密鑰 secretName 中金鑰的所有變數名稱的字首設為 CUSTOM_，請使用值 CUSTOM_=secretName。 如果密鑰 secretName 包含 KEY_A，則環境變數名稱為 CUSTOM_KEY_A。
• 若要新增個別金鑰的環境變數，請使用格式 NAME:KEY_A,KEY_B。 例如，若要在名為 secretName 的密鑰中為單一金鑰 key1 新增環境變數，請使用值 secretName:key1。 若要將不同的名稱指派給參照的金鑰，請使用 NAME:NEW_NAME=KEY_A 格式。 例如，若要在名為 secretName 的密鑰中為單一金鑰 key1 新增名為 myKey 的環境變數，請使用值 secretName:myKey=key1。

此值為選項。

--env-from-secret-rm, --env-sec-rm

使用密鑰名稱來移除完整密鑰的環境變數參照。 若要移除密鑰的個別金鑰參照，請使用 --env-rm 選項。 此選項可以指定多次。 此值為選項。

--env-rm

移除對 configmap 或密鑰中鍵值組之索引鍵的環境變數參照。 若要移除個別索引鍵參照及文字值，請指定索引鍵的名稱。 此選項可以指定多次。 此值為選項。

--ephemeral-storage, --es

要為應用程式實例設定的暫時儲存體數量。 使用 M 表示 megabytes，使用 G 表示 gigabytes。 此值為選項。

--force, -f

請勿驗證指定的 configmap 和密鑰參照是否存在。 Configmap 參照是使用 --env-from-configmap 或 --mount-configmap 選項來指定。 密鑰參照以 --env-from-secret、--mount-secret 或 --registry-secret 選項指定。 此值為選項。 預設值為 false。

--image, -i

用於此應用程式的映像檔名稱。 格式為 REGISTRY/NAMESPACE/REPOSITORY:TAG，其中 REGISTRY 和 TAG 為選項。 如果未指定 REGISTRY，則默認為 docker.io。 如果未指定 TAG，則默認為 latest。 此值為選項。

--max-scale, --max, --maxscale

可用於此應用程式的實例數上限。 如果將此值設定為 0，應用程式會視需要調整比例。 應用程式調整大小僅受限於應用程式專案的每個資源配額的實例數。 請參閱 Code Engine的限制和配額。 此值為選項。 預設值為 10。

--memory, -m

為應用程式實例設定的記憶體數量。 使用 M 表示 megabytes，使用 G 表示 gigabytes。 如需有效值，請參閱 支援的記憶體及 CPU 組合。 此值為選項。

--min-scale, --min, --minscale

可用於此應用程式的實例數下限。 此值為選項。 預設值為 0。

--mount-configmap, --mount-cm

透過提供裝載目錄及 configmap 名稱 (格式為 MOUNT_DIRECTORY=CONFIGMAP_NAME)，將 configmap 的內容新增至應用程式儲存器的檔案系統。 每一個裝載的 configmap 都必須使用唯一的裝載目錄。 對於 configmap 中的每一個鍵值組，會將一個檔案新增至指定的裝載目錄，其中檔名是索引鍵，檔案內容是鍵值組的值。 為每個 --mount-configmap 選項指定一個裝載配置; 例如 --mount-configmap /etc/config-a=config-a --mount-configmap /etc/config-b=config-b。 此值為選項。

--mount-data-store, --mount-ds

裝載持續資料儲存庫。 格式為 MOUNT_DIRECTORY=STORAGE_NAME [:SUBPATH]。 SUBPATH 是可選的。 此選項可以指定多次。 此值為選項。

--mount-rm

透過指定在其中裝載 configmap 或密碼的目錄，從應用程式儲存器的檔案系統中移除 configmap 或密碼的內容。 為每個 --mount-rm 選項指定一個裝載目錄; 例如 --mount-rm /etc/configmap-a --mount-rm /etc/secret-b。 此值為選項。

--mount-secret, --mount-sec

透過提供裝載目錄及密鑰名稱 (格式為 MOUNT_DIRECTORY=SECRET_NAME)，將密鑰內容新增至應用程式儲存器的檔案系統。 每一個裝載密鑰都必須使用唯一的裝載目錄。 對於密鑰中的每一個鍵值組，會將一個檔案新增至指定的裝載目錄，其中檔名是金鑰，檔案的內容是鍵值組的值。 為每個 --mount-secret 選項指定一個裝載配置; 例如 --mount-secret /etc/secret-a=secret--a --mount-secret /etc/secret-b=secret-b。 此值為選項。

--no-cluster-local, --ncl

部署帶有公用端點的應用程式。 應用程式的部署方式是，它可以接收來自公共網際網路或 Code Engine 專案內元件的請求。 此值為選項。 預設值為 true。

--no-wait, --nw

更新應用程式，且不等待應用程式備妥。 如果您指定 no-wait 選項，則應用程式更新會開始且不等待。 使用 app get 指令來檢查應用程式狀態。 此值為選項。 預設值為 false。

--output, -o

指定指令輸出的格式。 有效值為 json, yaml, jsonpath=JSONPATH_EXPRESSION, jsonpath-as-json=JSONPATH_EXPRESSION, url，和 project-url。 使用 jsonpath 來指定 JSON 輸出元素的路徑。 此值為選項。

--port, -p

應用程式接聽所在的埠。 格式為 [NAME:]PORT，其中 [NAME:] 為選項。 如果指定 [NAME:]，則有效值為 h2c 或 http1。 當 [NAME:] 未指定或為 http1 時，埠會使用 HTTP/1.1。 當 [NAME:] 為 h2c 時，埠會使用未加密的 HTTP/2。 依預設，Code Engine 會假設應用程式在埠 8080 上接聽送入的連線。 如果您的應用程式需要在埠 8080 以外的埠上接聽，請使用 --port 來指定埠。 此值為選項。

--probe-live, --pl

以 NAME=VALUE 格式配置此應用程式的活性探測。 NAME 的有效選項為: type、port、path、interval、initial-delay、timeout、failure-threshold。此選項可以指定多次。 需要 type 內容，有效值為 tcp 和 http。 例如，--probe-live類型=tcp --probe-liveport=8080。 如需使用探測器的相關資訊，如需使用探測器的相關資訊，請參閱 配置應用程式的探測器。 此值為選項。

--probe-live-clear, --plr

移除活性探測。 僅當您的應用程式目前具有存活性探測時，才容許此選項。 此值為選項。 預設值為 false。

--probe-ready, --pr

以 NAME=VALUE 格式配置此應用程式的就緒探測。 NAME 的有效選項為: type、port、path、interval、initial-delay、timeout、failure-threshold。此選項可以指定多次。 需要 type 內容，有效值為 tcp 和 http。 例如，--probe-ready類型=tcp --probe-readyport=8080。 如需使用探測器的相關資訊，如需使用探測器的相關資訊，請參閱 配置應用程式的探測器。 此值為選項。

--probe-ready-reset, --prr

將就緒探測重設為預設配置。 此值為選項。 預設值為 false。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

--rebuild

從來源重建映像檔。 如果您的應用程式目前有相關聯的建置，則容許重建選項。 此值為選項。 預設值為 false。

--registry-secret, --rs

登錄密鑰的名稱。 當您下載容器映像檔時，會使用登錄密鑰向專用登錄進行鑑別。 此值為選項。

--registry-secret-clear, --rsc

清除登錄密鑰。 此值為選項。 預設值為 false。

--request-timeout, --rt, --timeout, -t

在對應用程式提出的要求必須成功或失敗之前，可以經過的時間量 (以秒為單位)。 此值為選項。 預設值為 0。

--rn, --revision-name

修訂的名稱。 使用在應用程式中唯一的名稱。

• 名稱可以包含小寫字母、數字和連字符 (-)。
• 名稱必須以小寫英數字元結尾。
• 完整修訂名稱必須採用 Name_of_application-Name of revision 格式。
• 完整修訂名稱必須不超過 63 個字元。

此值為選項。

--scale-down-delay, --sdd

縮減應用程式之前，必須以減少並行處理的時間（秒）。 並行要求數目增加會導致應用程式擴增。 如果捨棄的要求數 (減少的並行性)，這個選項的指定時間量會決定縮減應用程式之前，減少的並行性需要持續多久。 依預設，如果偵測到減少的並行性，則會立即縮減應用程式。 此值為選項。 預設值為 0。

--service-account, --sa

服務帳戶的名稱。 服務帳戶提供在實例中執行之程序的身分。 對於內建服務帳戶，您可以使用縮短的名稱 manager、none、reader 及 writer。 您也可以使用字首為 Kubernetes Config Context 的完整名稱，可以使用 project current 指令來判定。 此值為選項。

--service-account-clear, --sac

清除服務帳戶。 此值為選項。 預設值為 false。

--trusted-profiles-enabled, --trusted, --tpe

啟用計算資源記號裝載到此應用程式的儲存器。 此值為選項。 預設值為 false。

--user, -u

用來執行應用程式的使用者 ID (UID)。 此值會置換在應用程式 Dockerfile 中設定的任何使用者 ID。 ID 必須符合儲存器的作業系統需求。 此值為選項。 預設值為 0。

--visibility, -v

應用程式的可見性。 有效值為 public, private，和 project。 設定 public 的可見性表示您的應用程式可以接收來自公用網際網路或來自 Code Engine 專案內元件的要求。 設定 private 的可見性表示無法從公用網際網路存取您的應用程式，且只能從相同專案中執行的其他 IBM Cloud 使用「虛擬專用端點 (VPE)」或 Code Engine 元件進行網路存取。 只有在專案支援應用程式私有可見性的情況下，才能 private。 設定能見度為 project 表示您的應用程式無法從公共網際網路存取，只有在同一專案中執行的其他 Code Engine 元件才能進行網路存取。 此值為選項。

--wait, -w

更新應用程式並等待應用程式備妥。 如果您指定 --wait 選項，應用程式更新會等待 --wait-timeout 選項所設定的時間上限 (以秒為單位)，讓應用程式變成備妥。 如果應用程式在指定的 --wait-timeout 期間內未備妥，則應用程式建立會失敗。 此值為選項。 預設值為 true。

--wait-timeout, --wto

等待應用程式更新的時間長度 (以秒為單位)。 如果指定 --wait 選項，則需要此值。 如果指定 --no-wait 選項，則會忽略此值。 預設值為 600。

範例

ibmcloud ce application update --name myapp --image icr.io/codeengine/hello

輸出範例

Updating application 'myapp' to latest revision.
[...]
Run 'ibmcloud ce application get -n myapp' to check the application status.
OK

https://myapp.4svg40kna19.us-south.codeengine.appdomain.cloud

指令選項

-n, --name

建置的名稱。 請使用專案內唯一的名稱。

• 名稱必須以小楷字母數字開頭和結束。
• 名稱必須不超過 63 個字元，且可以包含小寫英數字元及連字號 (-)。

此值為必填項目。

--build-type, --bt

建置的類型。 有效值為 git 和 local。 如果建置類型是 local，則 --source、--commit 和 --git-repo-secret 選項無效。 此值為選項。 預設值為 git。

--commit, --cm, --revision

來源儲存庫中要取回的確定、標籤或分支。 如果 --build-type 選項是 git，則容許確定選項; 如果 --build-type 選項是 local，則不容許確定選項。 此值為選項。

--context-dir, --cdr

儲存庫中包含建置套件檔案或 Dockerfile 的目錄。 此值為選項。

--dockerfile, --df

Dockerfile 的路徑。 只有在名稱不是 Dockerfile 時，才指定此選項。 此值為選項。 預設值為 Dockerfile。

--force, -f

不驗證指定的密鑰參照是否存在。 密鑰參照以 --get-repo-secret 或 --registry-secret 選項指定。 此值為選項。 預設值為 false。

--git-repo-secret, --grs, --repo, -r

SSH 密鑰的名稱，其中包含用來存取專用儲存庫的認證，該專用儲存庫包含用來建置容器映像檔的原始碼。 若要建立此 SSH 密鑰，請使用 secret create --format SSH 指令。 SSH 密鑰也用作 Git 儲存庫存取密鑰。 如果 --build-type 選項是 git，則容許此選項; 如果 --build-type 選項是 local，則不容許此選項。 此值為選項。

--image, -i

映像檔登錄的位置。 格式為 REGISTRY/NAMESPACE/REPOSITORY:TAG，其中 TAG 為選項。 如果未指定 TAG，則默認為 latest。 此值為選項。

--output, -o

指定指令輸出的格式。 有效值為 json、yaml、jsonpath=JSONPATH_EXPRESSION 及 jsonpath-as-json=JSONPATH_EXPRESSION。 使用 jsonpath 來指定 JSON 輸出元素的路徑。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

--registry-secret, --rs

用來存取登錄的登錄密鑰。 您可以執行 registry create 指令來新增登錄密鑰。 此值為選項。

--size, --sz

建立的大小，決定使用的資源量。 有效值為 small, medium, large, xlarge，和 xxlarge。 如需詳細資料，請參閱 判斷建置的大小。 此值為選項。 預設值為 medium。

--source, --src

包含您的原始碼的 Git 套件庫的 URL；例如 https://github.com/IBM/CodeEngine。 如果 --build-type 選項是 git，則需要來源選項; 如果 --build-type 選項是 local，則不容許來源選項。 此值為選項。

--strategy, --str

用於建置映像檔的策略。 對於應用程式和工作，有效值為 dockerfile 和 buildpacks。 對於函數，有效值的格式為 codebundle-[RUNTIME-ID]。 例如，如果您要使用執行時期 ID nodejs-20 為函數建置程式碼組合，請使用 codebundle-nodejs-20 作為建置策略。 您可以執行 ibmcloud ce fn runtimes 指令來尋找任何受支援函數執行時期的 ID。 此值為選項。 預設值為 dockerfile。

--timeout, --to

在建置必須成功或失敗之前可以經過的時間量 (秒)。 此值為選項。 預設值為 600。

範例

下列範例會從來源 Dockerfile 中建立名為 helloworld-build 的建置配置檔，該檔案位於 main 分支中 hello 目錄內的 https://github.com/IBM/CodeEngine 中，具有 dockerfile 策略和 medium 大小。 提交此建置時，所建置的容器映像檔會儲存在 Container Registry 實例中，該實例位於使用稱為 myregistry 的映像檔登錄密碼所存取的 us.icr.io/mynamespace/codeengine-helloworld。

ibmcloud ce build create --name helloworld-build --source https://github.com/IBM/CodeEngine  --context-dir /hello --commit main --strategy dockerfile --size medium --image us.icr.io/mynamespace/codeengine-helloworld --registry-secret myregistry

輸出範例

Creating build helloworld-build...
OK

指令選項

--name, -n

建置的名稱。 此值為必填項目。

--force, -f

強制刪除，而不進行確認。 此值為選項。 預設值為 false。

--ignore-not-found, --inf

如果找不到，請不要失敗。 此值為選項。 預設值為 false。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

範例

ibmcloud ce build delete --name helloworld-build

輸出範例

Are you sure you want to delete build helloworld-build? [y/N]> y
Deleting build 'helloworld-build'...
OK

指令選項

--name, -n

建置的名稱。 此值為必填項目。

--output, -o

指定指令輸出的格式。 有效值為 json、yaml、jsonpath=JSONPATH_EXPRESSION 及 jsonpath-as-json=JSONPATH_EXPRESSION。 使用 jsonpath 來指定 JSON 輸出元素的路徑。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

範例

ibmcloud ce build get --name helloworld-build

輸出範例

Getting build 'helloworld-build'
OK

Name:          helloworld-build
ID:            abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f
Project Name:  myproject
Project ID:    01234567-abcd-abcd-abcd-abcdabcd1111
Age:           15s
Created:       2021-03-14T14:48:19-05:00  
Status:        Succeeded
Reason:        all validations succeeded

Last Build Run:
  Name:     helloworld-build-run
  Age:      39d
  Created:  2021-09-30T15:19:33-04:00

Image:              us.icr.io/mynamespace/codeengine-helloworld
Registry Secret:    myregistry
Build Strategy:     dockerfile-medium
Timeout:            10m0s
Source:             https://github.com/IBM/CodeEngine
Commit:             main
Context Directory:  /hello
Dockerfile:         Dockerfile

Build Runs:
  Name                  Status                              Image                                        Age
  helloworld-build-run  All Steps have completed executing  us.icr.io/mynamespace/codeengine-helloworld  39d

指令選項

--output, -o

指定指令輸出的格式。 有效值為 json、yaml、jsonpath=JSONPATH_EXPRESSION 及 jsonpath-as-json=JSONPATH_EXPRESSION。 使用 jsonpath 來指定 JSON 輸出元素的路徑。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

--sort-by, -s

指定清單排序的直欄。 有效值為 name 和 age。 此值為選項。 預設值為 name。

範例

ibmcloud ce build list

輸出範例

Listing builds...
OK

Name                    Status     Reason                     Image                                               Build Strategy     Age    Last Build Run Name                        Last Build Run Age
myhellobuild           Succeeded  all validations succeeded  us.icr.io/mynamespace/codeengine-codeengine-200      dockerfile-medium  160d   myhellobuild-run-4xdnb                    160d
hello-build-5ckgs      Succeeded  all validations succeeded  us.icr.io/mynamespace/codeengine-codeengine-51       dockerfile-medium  39d    helloapp3-build-5ckgs-run-210803-2129500   39d
hello-build-pmg6v      Succeeded  all validations succeeded  us.icr.io/mynamespace/codeengine-codeengine-4f       dockerfile-medium  40d    hellooapp2-build-pmg6v-run-210802-2112310  40d
helloworld-build       Succeeded  all validations succeeded  us.icr.io/mynamespace/codeengine-helloworld          dockerfile-medium  39d    helloworld-build-run                       39d

指令選項

--name, -n

建置的名稱。 此值為必填項目。

--commit, --cm, --revision

來源儲存庫中要取回的確定、標籤或分支。 此值為選項。

--commit-clear, --cmc

清除來源儲存庫中要取回的確定、標籤或分支。 此值為選項。 預設值為 false。

--context-dir, --cdr

儲存庫中包含建置套件檔案或 Dockerfile 的目錄。 此值為選項。

--dockerfile, --df

Dockerfile 的路徑。 只有在名稱不是 Dockerfile 時，才指定此選項。 此值為選項。 預設值為 Dockerfile。

--force, -f

不驗證指定的密鑰參照是否存在。 密鑰參照以 --get-repo-secret 或 --registry-secret 選項指定。 此值為選項。 預設值為 false。

--git-repo-secret, --grs, --repo, -r

SSH 密鑰的名稱，其中包含用來存取專用儲存庫的認證，該專用儲存庫包含用來建置容器映像檔的原始碼。 若要建立此 SSH 密鑰，請使用 secret create --format SSH 指令。 SSH 密鑰也用作 Git 儲存庫存取密鑰。 此值為選項。

--git-repo-secret-clear, --grsc

清除 SSH 密鑰。 此值為選項。 預設值為 false。

--image, -i

映像檔登錄的位置。 格式為 REGISTRY/NAMESPACE/REPOSITORY:TAG，其中 TAG 為選項。 如果未指定 TAG，則默認為 latest。 此值為選項。

--output, -o

指定指令輸出的格式。 有效值為 json、yaml、jsonpath=JSONPATH_EXPRESSION 及 jsonpath-as-json=JSONPATH_EXPRESSION。 使用 jsonpath 來指定 JSON 輸出元素的路徑。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

--registry-secret, --rs

登錄密鑰的名稱。 當您下載容器映像檔時，會使用登錄密鑰向專用登錄進行鑑別。 此值為選項。

--size, --sz

建立的大小，決定使用的資源量。 有效值為 small, medium, large, xlarge，和 xxlarge。 如需詳細資料，請參閱 判斷建置的大小。 此值為選項。

--source, --src

包含您的原始碼的 Git 套件庫的 URL；例如 https://github.com/IBM/CodeEngine。 此值為選項。

--strategy, --str

用於建置映像檔的策略。 對於應用程式和工作，有效值為 dockerfile 和 buildpacks。 對於函數，有效值的格式為 codebundle-[RUNTIME-ID]。 例如，如果您要使用執行時期 ID nodejs-20 為函數建置程式碼組合，請使用 codebundle-nodejs-20 作為建置策略。 您可以執行 ibmcloud ce fn runtimes 指令來尋找任何受支援函數執行時期的 ID。 此值為選項。

--timeout, --to

在建置必須成功或失敗之前可以經過的時間量 (秒)。 此值為選項。 預設值為 600。

範例

ibmcloud ce build update --name helloworld-build --source https://github.com/IBM/CodeEngine  --context-dir /hello --commit main --timeout 900

輸出範例

Updating build helloworld-build...
OK

指令選項

--name, -n

建置執行的名稱。 此值為必填項目。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

範例

ibmcloud ce buildrun cancel --name mybuildrun

輸出範例

Cancelling build run 'mybuildrun'...
OK

指令選項

--build, -b

請利用這個選項來刪除指定建置的所有建置執行。 如果您未指定 --name 值，則需要 --build 選項。 此值為選項。

--force, -f

強制刪除，而不進行確認。 此值為選項。 預設值為 false。

--ignore-not-found, --inf

如果找不到，請不要失敗。 此值為選項。 預設值為 false。

--name, -n

建置執行的名稱。 如果您未指定 --build 值，則需要 --name 選項。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

範例

ibmcloud ce buildrun delete --name mybuildrun

輸出範例

Are you sure you want to delete build run mybuildrun? [y/N]> y
Deleting build run 'mybuildrun'...
OK

指令選項

--buildrun, -b, --br, --name, -n

建置執行的名稱。 此值為必填項目。

--output, -o

指定指令輸出的格式。 有效值為 json、yaml、jsonpath=JSONPATH_EXPRESSION 及 jsonpath-as-json=JSONPATH_EXPRESSION。 使用 jsonpath 來指定 JSON 輸出元素的路徑。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

範例

此範例顯示建置執行的系統事件資訊。

ibmcloud ce buildrun events --buildrun mybuildrun

輸出範例

Getting build run 'mybuildrun'...
Getting instances of build run 'mybuildrun'...
Getting events for build run 'mybuildrun'...
OK

mybuildrun-l4mr2-pod-89z4t:
    Type    Reason     Age  Source                  Messages
    Normal  Scheduled  33s  default-scheduler       Successfully assigned 4svg40kna19/mybuildrun-l4mr2-pod-89z4t to 10.240.128.97
    Normal  Pulled     31s  kubelet, 10.240.128.97  Container image "gcr.io/distroless/base@sha256:92720b2305d7315b5426aec19f8651e9e04222991f877cae71f40b3141d2f07e" already present on machine
    Normal  Created    31s  kubelet, 10.240.128.97  Created container working-dir-initializer
    Normal  Started    31s  kubelet, 10.240.128.97  Started container working-dir-initializer
    Normal  Pulled     30s  kubelet, 10.240.128.97  Container image "icr.io/obs/codeengine/tekton-pipeline/entrypoint-bff0a22da108bc2f16c818c97641a296:v0.20.1-rc2@sha256:19ec0672b5e84a4c5939c6ece6fa69efbce0d38479baf35ce894cf1c67f7e435" already present on machine
    Normal  Created    30s  kubelet, 10.240.128.97  Created container place-tools
    Normal  Started    29s  kubelet, 10.240.128.97  Started container place-tools
    Normal  Pulled     28s  kubelet, 10.240.128.97  Container image "gcr.io/distroless/base@sha256:92720b2305d7315b5426aec19f8651e9e04222991f877cae71f40b3141d2f07e" already present on machine
    Normal  Created    28s  kubelet, 10.240.128.97  Created container step-create-dir-image-l7lf2
    Normal  Created    25s  kubelet, 10.240.128.97  Created container step-git-source-source-46fm7
    Normal  Pulled     25s  kubelet, 10.240.128.97  Container image "icr.io/obs/codeengine/tekton-pipeline/git-init-4874978a9786b6625dd8b6ef2a21aa70:v0.20.1-rc2@sha256:5febfb32459a114b7beafdc593770a0f692a09d874ac6b59ce85507844641cdf" already present on machine
    Normal  Started    25s  kubelet, 10.240.128.97  Started container step-create-dir-image-l7lf2
    Normal  Started    24s  kubelet, 10.240.128.97  Started container step-git-source-source-46fm7
    Normal  Pulled     24s  kubelet, 10.240.128.97  Container image "icr.io/obs/codeengine/kaniko/executor:v1.3.0-rc1" already present on machine
    Normal  Created    24s  kubelet, 10.240.128.97  Created container step-build-and-push
    Normal  Started    24s  kubelet, 10.240.128.97  Started container step-build-and-push
    Normal  Pulled     24s  kubelet, 10.240.128.97  Container image "icr.io/obs/codeengine/tekton-pipeline/imagedigestexporter-6e7c518e6125f31761ebe0b96cc63971:v0.20.1-rc2@sha256:21b3120ce9b930b4eb1359eb20a3109e3a6643e9d2777ef9694efb033367e57c" already present on machine
    Normal  Created    24s  kubelet, 10.240.128.97  Created container step-image-digest-exporter-gnbrp
    Normal  Started    23s  kubelet, 10.240.128.97  Started container step-image-digest-exporter-gnbrp

指令選項

--name, -n

建置執行的名稱。 此值為必填項目。

--output, -o

指定指令輸出的格式。 有效值為 json、yaml、jsonpath=JSONPATH_EXPRESSION 及 jsonpath-as-json=JSONPATH_EXPRESSION。 使用 jsonpath 來指定 JSON 輸出元素的路徑。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

範例

ibmcloud ce buildrun get --name mybuildrun

輸出範例

Getting build run 'mybuildrun'...
Run 'ibmcloud ce buildrun events -n mybuildrun' to get the system events of the build run.
Run 'ibmcloud ce buildrun logs -f -n mybuildrun' to follow the logs of the build run.
OK

Name:          mybuildrun
ID:            abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f
Project Name:  myproject
Project ID:    01234567-abcd-abcd-abcd-abcdabcd1111
Age:           21m  
Created:       2021-03-14T14:50:13-05:00  

Summary:       Succeeded  
Status:        Succeeded  
Reason:        All Steps have completed executing  
Source:          
  Commit Branch:  main  
  Commit SHA:     abcdeb88263442e28af6ae26d2082dea1d6abcde  
  Commit Author:  myauthor  
Image Digest:  sha256:522488ca3b54eb65f8c1e609a7b27c08558d08166fe062e7dde6838d4a609d61  

Image:  us.icr.io/mynamespace/test

指令選項

--build, -b

使用這個選項時，只會顯示來自指定建置的建置執行。 此值為選項。

--output, -o

指定指令輸出的格式。 有效值為 json、yaml、jsonpath=JSONPATH_EXPRESSION 及 jsonpath-as-json=JSONPATH_EXPRESSION。 使用 jsonpath 來指定 JSON 輸出元素的路徑。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

--sort-by, -s

指定清單排序的直欄。 有效值為 name 和 age。 此值為選項。 預設值為 name。

範例

ibmcloud ce buildrun list

輸出範例

Listing builds...
OK

Name                                  Status     Build Name        Age
helloworld-build-run                  Succeeded  helloworld-build  5d22h
mybuildrun                            Succeeded  helloworld-build  7m23s
mybuildrun2                           Succeeded  helloworld-build  3m4s

指令選項

--buildrun, -b, --br, --name, -n

建置執行的名稱。 此值為必填項目。

--follow, -f

遵循建置執行的日誌。 使用這個選項來串流建置執行的日誌。 如果您指定 --follow 選項，則必須輸入 Ctrl+C 以終止此日誌指令。 此值為選項。 預設值為 false。

--output, -o

指定指令輸出的格式。 有效值為 json、yaml、jsonpath=JSONPATH_EXPRESSION 及 jsonpath-as-json=JSONPATH_EXPRESSION。 使用 jsonpath 來指定 JSON 輸出元素的路徑。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

--raw, -r

顯示不含實例及容器標籤的日誌。 此值為選項。 預設值為 false。

--tail, -t

將所指定建置執行之容器的日誌顯示限制為每個容器的最近行數上限。 例如，若要顯示所指定建置執行之儲存器日誌的最後 3 行，請指定 --tail 3。 如果未指定此選項，則會顯示所指定建置執行之儲存器的所有日誌行。 此值為選項。 預設值為 -1。

--timestamps, --ts

在日誌輸出的每一行包含時間戳記。 此值為選項。 預設值為 false。

範例

ibmcloud ce buildrun logs --name mybuildrun

輸出範例

Getting build run 'mybuildrun'...
Getting instances of build run 'mybuildrun'...
Getting logs for build run 'mybuildrun'...
OK

mybuildrun-v2mb8-pod-tlzdx/step-git-source-source-g2kbf:
{"level":"info","ts":1614089507.7123275,"caller":"git/git.go:165","msg":"Successfully cloned https://github.com/IBM/CodeEngine @ 433e2b8d6529e4a55f5e0f72d3772a79602a5ee8 (grafted, HEAD, origin/main) in path /workspace/source"}
{"level":"info","ts":1614089509.0128207,"caller":"git/git.go:203","msg":"Successfully initialized and updated submodules in path /workspace/source"}

mybuildrun-v2mb8-pod-tlzdx/step-build-and-push:
INFO[0000] Retrieving image manifest node:12-alpine
INFO[0000] Retrieving image node:12-alpine
INFO[0001] Retrieving image manifest node:12-alpine
INFO[0001] Retrieving image node:12-alpine
INFO[0001] Built cross stage deps: map[]
INFO[0001] Retrieving image manifest node:12-alpine
INFO[0001] Retrieving image node:12-alpine
INFO[0002] Retrieving image manifest node:12-alpine
INFO[0002] Retrieving image node:12-alpine
INFO[0002] Executing 0 build triggers
INFO[0002] Unpacking rootfs as cmd RUN npm install requires it.
INFO[0006] RUN npm install
INFO[0006] Taking snapshot of full filesystem...
INFO[0008] cmd: /bin/sh
INFO[0008] args: [-c npm install]
INFO[0008] Running: [/bin/sh -c npm install]
npm WARN saveError ENOENT: no such file or directory, open '/package.json'
npm notice created a lockfile as package-lock.json. You should commit this file.
npm WARN enoent ENOENT: no such file or directory, open '/package.json'
npm WARN !invalid#2 No description
npm WARN !invalid#2 No repository field.
npm WARN !invalid#2 No README data
npm WARN !invalid#2 No license field.

up to date in 0.27s
found 0 vulnerabilities

INFO[0010] Taking snapshot of full filesystem...
INFO[0010] COPY server.js .
INFO[0010] Taking snapshot of files...
INFO[0010] EXPOSE 8080
INFO[0010] cmd: EXPOSE
INFO[0010] Adding exposed port: 8080/tcp
INFO[0010] CMD [ "node", "server.js" ]

mybuildrun-v2mb8-pod-tlzdx/step-image-digest-exporter-hcvmf:
2021/02/23 14:11:43 warning: unsuccessful cred copy: ".docker" from "/tekton/creds" to "/tekton/home": unable to open destination: open /tekton/home/.docker/config.json: permission denied
{"severity":"INFO","timestamp":"2021-02-23T14:12:05.65581098Z","caller":"logging/config.go:115","message":"Successfully created the logger.","logging.googleapis.com/labels":{},"logging.googleapis.com/sourceLocation":{"file":"github.com/tektoncd/pipeline/vendor/knative.dev/pkg/logging/config.go","line":"115","function":"github.com/tektoncd/pipeline/vendor/knative.dev/pkg/logging.newLoggerFromConfig"}}
{"severity":"INFO","timestamp":"2021-02-23T14:12:05.655937558Z","caller":"logging/config.go:116","message":"Logging level set to: info","logging.googleapis.com/labels":{},"logging.googleapis.com/sourceLocation":{"file":"github.com/tektoncd/pipeline/vendor/knative.dev/pkg/logging/config.go","line":"116","function":"github.com/tektoncd/pipeline/vendor/knative.dev/pkg/logging.newLoggerFromConfig"}}

指令選項

--build, -b, --bd

要使用的建置配置名稱。 此值為選項。

--commit, --cm, --revision

來源儲存庫中要取回的確定、標籤或分支。 如果 --source 選項設定為 Git 儲存庫的 URL，則允許 build commit 選項；如果 --source 選項未設定為 Git 儲存庫的 URL，則不允許 build commit 選項。 此值為選項。

--context-dir, --cdr

儲存庫中包含建置套件檔案或 Dockerfile 的目錄。 如果未設定 --build 選項，則容許建置環境定義目錄選項; 如果設定 --build 選項，則 不 容許。 此值為選項。

--dockerfile, --df

Dockerfile 的路徑。 只有在名稱不是 Dockerfile 時，才指定此選項。 如果未設定 --build 選項，則容許建置 dockerfile 選項，如果設定 --build 選項，則 不 容許。 此值為選項。 預設值為 Dockerfile。

--git-repo-secret, --grs, --repo, -r

SSH 密鑰的名稱，其中包含用來存取專用儲存庫的認證，該專用儲存庫包含用來建置容器映像檔的原始碼。 若要建立此 SSH 密鑰，請使用 secret create --format SSH 指令。 SSH 密鑰也用作 Git 儲存庫存取密鑰。 只有在 --build-source 選項設定為 Git 儲存庫的 URL 時，才允許使用此選項。 此值為選項。

--image, -i

映像檔登錄的位置。 格式為 REGISTRY/NAMESPACE/REPOSITORY:TAG，其中 TAG 為選項。 如果未指定 TAG，則默認為 latest。 此值為選項。

-n, --name

建置執行的名稱。 請使用專案內唯一的名稱。 如果設定 --build 選項，則名稱選項是選用的。 如果未設定 --build 選項，則需要 name 選項。

• 名稱必須以小楷字母數字開頭和結束。
• 名稱必須不超過 63 個字元，且可以包含小寫英數字元及連字號 (-)。

此值為選項。

--no-wait, --nw

提交建置執行，且不等待此建置執行完成。 如果您指定 --no-wait 選項，則建置執行提交會開始且不等待。 使用 buildrun get 指令來檢查建置執行狀態。 此值為選項。 預設值為 true。

--output, -o

指定指令輸出的格式。 有效值為 json、yaml、jsonpath=JSONPATH_EXPRESSION 及 jsonpath-as-json=JSONPATH_EXPRESSION。 使用 jsonpath 來指定 JSON 輸出元素的路徑。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

--registry-secret, --rs

登錄密鑰的名稱。 當您下載容器映像檔時，會使用登錄密鑰向專用登錄進行鑑別。 如果未設定 --build 選項，則容許登錄密鑰選項，如果設定 --build 選項，則 不 容許。 此值為選項。

--service-account, --sa

服務帳戶的名稱。 服務帳戶提供在實例中執行之程序的身分。 對於內建服務帳戶，您可以使用縮短的名稱 manager、none、reader 及 writer。 您也可以使用字首為 Kubernetes Config Context 的完整名稱，可以使用 project current 指令來判定。 此值為選項。

--size, --sz

建立的大小，決定使用的資源量。 有效值為 small, medium, large, xlarge，和 xxlarge。 如需詳細資料，請參閱 判斷建置的大小。 如果未設定 --build 選項，則容許建置大小選項，如果設定 --build 選項，則 不 容許。 此值為選項。 預設值為 medium。

--source, --src

Git 儲存庫的 URL 或包含您原始碼的本機原始碼路徑；例如 https://github.com/IBM/CodeEngine 或 .。 如果設定 --build 選項，當相關建置上的 --build-type 選項為 local，且相關建置上的 --build-type 選項為 git 時 不 容許，則需要來源選項。 如果未設定 --build 選項，則來源選項是選用的。 此值為選項。 預設值為 .。

--strategy, --str

用於建置映像檔的策略。 對於應用程式和工作，有效值為 dockerfile 和 buildpacks。 對於函數，有效值的格式為 codebundle-[RUNTIME-ID]。 例如，如果您要使用執行時期 ID nodejs-20 為函數建置程式碼組合，請使用 codebundle-nodejs-20 作為建置策略。 您可以執行 ibmcloud ce fn runtimes 指令來尋找任何受支援函數執行時期的 ID。 如果未設定 --build 選項，則容許建置策略選項; 如果設定 --build 選項，則 不 容許。 如果未指定，則建置策略由 Code Engine 決定 (如果指定 --source 且來源位於本端機器上)。 此值為選項。 預設值為 dockerfile。

--timeout, --to

在建置執行必須成功或失敗之前可以經過的時間量 (秒)。 此值為選項。 預設值為 600。

--wait, -w

提交建置執行，並等待此建置執行完成。 如果您指定 --wait 選項，建置執行提交會等待建置執行完成的時間上限 (以秒為單位，由 --wait-timeout 選項設定)。 如果建置執行未在指定的 --wait-timeout 期間內完成，則建置執行提交會失敗。 此值為選項。 預設值為 false。

--wait-timeout, --wto

等待此建立執行完成的時間長度 (以秒為單位)。 如果指定 --wait 選項，則需要此值。 如果指定 --no-wait 選項，則會忽略此值。 預設值為 600。

範例

下列指令會提交稱為 mybuildrun 的建置執行，並使用稱為 helloworld-build 的建置配置檔。

ibmcloud ce buildrun submit --name mybuildrun --build helloworld-build

輸出範例

Submitting build run 'mybuildrun'...
Run 'ibmcloud ce buildrun get -n mybuildrun' to check the build run status.
OK

指令選項

-n, --name

configmap 的名稱。 請使用專案內唯一的名稱。

• 名稱必須以小楷字母數字開頭和結束。
• 名稱必須為 253 個字元或更少，且可以包含小寫字母、數字、句點 (.) 及連字號 (-)。

此值為必填項目。

--from-env-file, -e

從包含一或多行符合 KEY=VALUE 格式的檔案建立 configmap。 您必須提供檔案的路徑作為值。 指定檔案中的每一行都會新增為鍵值組。 指定檔案中任何空白或以 # 開頭的行都會被忽略。 如果未指定 --from-literal 或 --from-file，則需要此值。

--from-file, -f

從檔案建立 configmap。 您必須提供檔案的路徑作為值。 如果未指定 --from-literal 或 --from-env-file，則需要此值。

--from-literal, -l

從鍵值組建立配置對映。 必須為 KEY=VALUE 格式。 如果未指定 --from-file 或 --from-env-file，則需要此值。 此選項可以指定多次。

--output, -o

指定指令輸出的格式。 有效值為 json、yaml、jsonpath=JSONPATH_EXPRESSION 及 jsonpath-as-json=JSONPATH_EXPRESSION。 使用 jsonpath 來指定 JSON 輸出元素的路徑。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

範例

下列範例會建立名為 configmap-fromliteral 且具有兩個金鑰組值的 configmap: color=blue 和 size=large。

ibmcloud ce configmap create --name configmap-fromliteral --from-literal color=blue --from-literal size=large

輸出範例

Creating Configmap 'configmap-fromliteral'...
OK
Run 'ibmcloud ce configmap get -n configmap-fromliteral' to see more details.

具有來自多個檔案的值的 configmap 範例

下列範例會使用多個檔案中的值來建立名為 configmap-fromfile 的 configmap。

ibmcloud ce configmap create --name configmap-fromfile  --from-file ./color.txt --from-file ./size.txt

Creating configmap 'configmap-fromfile'...
OK
Run 'ibmcloud ce configmap get -n configmap-fromfile' to see more details.

指令選項

--name, -n

configmap 的名稱。 此值為必填項目。

--force, -f

強制刪除，而不進行確認。 此值為選項。 預設值為 false。

--ignore-not-found, --inf

如果找不到，請不要失敗。 此值為選項。 預設值為 false。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

範例

ibmcloud ce configmap delete --name configmap-fromliteral -f

輸出範例

Deleting Configmap 'configmap-fromliteral'...
OK

指令選項

--name, -n

configmap 的名稱。 此值為必填項目。

--output, -o

指定指令輸出的格式。 有效值為 json、yaml、jsonpath=JSONPATH_EXPRESSION 及 jsonpath-as-json=JSONPATH_EXPRESSION。 使用 jsonpath 來指定 JSON 輸出元素的路徑。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

範例

ibmcloud ce configmap get --name configmap-fromliteral

輸出範例

Getting configmap 'configmap-fromliteral'...
OK

Name:          configmap-fromliteral
ID:            abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f
Project Name:  myproject
Project ID:    01234567-abcd-abcd-abcd-abcdabcd1111
Age:           21s
Created:       2021-03-01T13:50:56-05:00

Data:
---
color: blue
size: large

指令選項

--output, -o

指定指令輸出的格式。 有效值為 json、yaml、jsonpath=JSONPATH_EXPRESSION 及 jsonpath-as-json=JSONPATH_EXPRESSION。 使用 jsonpath 來指定 JSON 輸出元素的路徑。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

--sort-by, -s

指定清單排序的直欄。 有效值為 name 和 age。 此值為選項。 預設值為 name。

範例

ibmcloud ce configmap list

輸出範例

Listing Configmaps...
Name                    Data   Age
configmap-fromfile      2      19m13s
configmap-fromliteral   2      16m12s

指令選項

--name, -n

configmap 的名稱。 此值為必填項目。

--from-env-file, -e

從包含一或多行符合 KEY=VALUE 格式的檔案更新 configmap。 您必須提供檔案的路徑作為值。 指定檔案中的每一行都會新增為鍵值組。 指定檔案中任何空白或以 # 開頭的行都會被忽略。 如果未指定 --from-literal 或 --from-file，則需要此值。 此選項可以指定多次。

--from-file, -f

從檔案更新配置對映。 您必須提供檔案的路徑作為值。 如果未指定 --from-literal 或 --from-env-file，則需要此值。 此選項可以指定多次。

--from-literal, -l

從鍵值組更新 configmap。 必須為 KEY=VALUE 格式。 如果未指定 --from-file 或 --from-env-file，則需要此值。 此選項可以指定多次。

--output, -o

指定指令輸出的格式。 有效值為 json、yaml、jsonpath=JSONPATH_EXPRESSION 及 jsonpath-as-json=JSONPATH_EXPRESSION。 使用 jsonpath 來指定 JSON 輸出元素的路徑。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

--rm

透過指定金鑰的名稱，移除 configmap 中的個別鍵值組。 此選項可以指定多次。 此值為選項。

範例

下列範例會使用使用者名稱及密碼值配對來更新名為 configmap-fromliteral 的 configmap。

ibmcloud ce configmap update --name configmap-fromliteral --from-literal username=devuser --from-literal password='A!B99c$D1Def'

輸出範例

Updating configmap 'configmap-fromliteral'...
OK
Run 'ibmcloud ce configmap get -n configmap-fromliteral' to see more details.

具有來自檔案的值的 configmap 範例

下列範例會使用檔案中的值來更新名為 configmap-fromfile 的 configmap。

ibmcloud ce configmap update --name configmap-fromfile  --from-file ./username.txt --from-file ./password.txt

Updating configmap 'configmap-fromfile'...
OK
Run 'ibmcloud ce configmap get -n configmap-fromfile' to see more details.

範例

ibmcloud ce connectivity outbound create --cidr-name allow-to-subnet-a --cidr 5.6.7.8/29

輸出範例

Creating allowed destination IP address range 'allow-to-subnet-a'...
OK

範例

ibmcloud ce connectivity outbound delete --cidr-name allow-to-subnet-a

輸出範例

Are you sure you want to delete an allowed destination IP address range 'allow-to-subnet-a'? [y/N]> y
Deleting allowed destination IP address range 'allow-to-subnet-a'...
OK

範例

ibmcloud ce connectivity outbound get --cidr-name allow-to-subnet-a

輸出範例

Getting allowed destination IP address range 'allow-to-subnet-a'...
OK

Project Name:      project123
Name:              allow-to-subnet-a
IP address range:  5.6.7.8/29
Type:              cidr_block

範例

ibmcloud ce connectivity outbound list

輸出範例

Name               Type        IP Address
allow-to-subnet-a  cidr_block  5.6.7.8/29
allow-to-subnet-b  cidr_block  11.12.13.0/24

範例

ibmcloud ce connectivity outbound update --cidr-name allow-to-subnet-a --cidr 5.6.7.0/27

輸出範例

Updating allowed destination IP address range 'allow-to-subnet-a'...
OK

指令選項

--domain-name, --dn, -n, --name

指定網域對映的名稱。 此名稱必須是有效的完整網域名稱 (FQDN)。 例如，www.example.com。 此值為必填項目。

--target, -t

目標應用程式或函數的名稱。 此值為必填項目。

--target-type, --type

目標的類型。 有效值為 application 或 function。 此值為必填項目。

--tls-secret, --secret, --tls

指定包含證書的 TLS 秘書，包括其所有中繼證書和網域名稱對應的對應私密金鑰。 憑證必須由授信公用憑證管理中心 (CA) 簽署。 不支援自簽憑證。 此值為必填項目。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

範例

下列範例會在 Code Engine myapp 應用程式與自訂網域 www.example.com 之間建立自訂網域對映，並使用 TLS 密鑰 mytlssecret。

ibmcloud ce domainmapping create --domain-name www.example.com --target myapp --tls-secret mytlssecret

輸出範例

OK
Domain mapping successfully created.

指令選項

--domain-name, --dn, -n, --name

網域對映的名稱。 此值為必填項目。

--force, -f

強制刪除，而不進行確認。 此值為選項。 預設值為 false。

--ignore-not-found, --inf

如果找不到，請不要失敗。 此值為選項。 預設值為 false。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

範例

ibmcloud ce domainmapping delete --name www.example.com -f

輸出範例

Deleting domain mapping 'www.example.com'...
OK

指令選項

--domain-name, --dn, -n, --name

網域對映的名稱。此值是 必要。

--output, -o

指定指令輸出的格式。 有效值為 json、yaml、jsonpath=JSONPATH_EXPRESSION 及 jsonpath-as-json=JSONPATH_EXPRESSION。 使用 jsonpath 來指定 JSON 輸出元素的路徑。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

範例

ibmcloud ce domainmapping get --name www.example.com

輸出範例

Getting domainmapping 'www.example.com'...
OK

Domain Name:  www.example.com  
CNAME:        custom.abcdabcdabc.us-south.codeengine.appdomain.cloud  
Target Name:  myapp  
Target Type:  app  
TLS Secret:   mytlssecret  
Status:       ready  

指令選項

--all, -a

顯示專案中的所有網域對映，包括自訂和系統網域對映。 此值為選項。 預設值為 false。

--output, -o

指定指令輸出的格式。 有效值為 json、yaml、jsonpath=JSONPATH_EXPRESSION 及 jsonpath-as-json=JSONPATH_EXPRESSION。 使用 jsonpath 來指定 JSON 輸出元素的路徑。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

--sort-by, -s

指定清單排序的直欄。 有效值為 name 和 age。 此值為選項。 預設值為 name。

範例

下列範例顯示所有自訂網域對映的清單。

ibmcloud ce domainmapping list

輸出範例

Listing domain mappings...
OK

Name              CNAME                                                        Target  Target-Type  Status  Secret Name  Age  
www.example.com   custom.abcdabcdabc.us-south.codeengine.appdomain.cloud       myapp   app          ready   mytlssecret  36m    

若要檢視應用程式的所有網域對映清單 (包括自訂網域對映及任何自動產生的系統網域對映)，請在 ibmcloud ce domainmapping list 指令中指定 --all 選項。

指令選項

--domain-name, --dn, -n, --name

網域對映的名稱。 此值為必填項目。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

--target, -t

目標應用程式或函數的名稱。 此值為選項。

--target-type, --type

目標的類型。 有效值為 application 或 function。 此值為選項。

--tls-secret, --secret, --tls

指定包含證書的 TLS 秘書，包括其所有中繼證書和網域名稱對應的對應私密金鑰。 憑證必須由授信公用憑證管理中心 (CA) 簽署。 不支援自簽憑證。 此值為選項。

範例

下列範例會更新 www.example.com 網域對映，以使用 mytlssecret2 而非 mytlssecret。

ibmcloud ce domainmapping update --domain-name www.example.com --tls-secret mytlssecret2

輸出範例

Updating domainmapping 'www.example.com'...

範例

ibmcloud ce experimental help

輸出範例

NAME:
  ibmcloud code-engine experimental - Experimental Code Engine commands

USAGE:
  ibmcloud code-engine experimental command [arguments...] [command options]

COMMANDS:
  help, h   Show help

Enter 'ibmcloud code-engine experimental help [command]' for more information about a command.

指令選項

--name, -n

要連結的函數名稱。 此值為必填項目。

--no-wait, --nw

綁定服務實體，不要等待服務綁定就緒。 如果您指定 no-wait 選項，則會啟動服務連結建立，且指令會結束而不等待它完成。 使用 function get 指令來檢查函數連結狀態。 此值為選項。 預設值為 false。

--prefix, -p

針對此服務連結建立之環境變數的字首。 只能包含大寫字母、數字及底線 (_)，且不能以數字開頭。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

--role, -r

為此服務綁定建立的新服務憑證的服務角色名稱。 有效值包括 Reader, Writer, Manager 或特定於服務的角色。 選項預設為 Manager，如果不支援 Manager，則為服務提供的第一個角色。 如果指定 --service-credential，則會忽略此選項。 此值為選項。

為此服務綁定建立的新服務憑證的服務角色名稱。 有效值包括 Reader, Writer, Manager 或特定於服務的角色。 選項預設為 Manager，如果不支援 Manager，則為服務提供的第一個角色。 如果指定 --service-credential，則會忽略此選項。 此值為選項。

--service-credential, --sc

要用於此服務綁定的現有服務憑證的名稱。 如果您未指定服務實例認證，則會在連結動作期間產生新認證。 此值為選項。

--service-instance, --si

要連結至函數的現有 IBM Cloud 服務實例名稱。 此值為選項。

--service-instance-id, --siid

要連結至函數之現有 IBM Cloud 服務實例的 GUID。 此值為選項。

--wait, -w

綁定服務實體，並等待服務綁定就緒。 如果您指定 --wait 選項，則函數連結會等待 --wait-timeout 選項所設定的時間上限 (以秒為單位)，讓函數連結順利完成。 如果函數連結未順利完成或在指定的 --wait-timeout 期間內失敗，則指令會失敗。 此值為選項。 預設值為 true。

--wait-timeout, --wto

等待服務綁定就緒的時間長度 (以秒為單位)。 如果指定 --wait 選項，則需要此值。 如果指定 --no-wait 選項，則會忽略此值。 預設值為 300。

範例

ibmcloud ce fn bind --name myfunction --service-instance my-object-storage

輸出範例

Binding service instance...
Status: Done
OK

指令選項

-n, --name

功能的名稱。 請使用專案內唯一的名稱。

• 名稱必須以小楷字母開頭。
• 名稱必須以小寫英數字元結尾。
• 名稱必須是 63 個字元或更少，且可以包含小寫字母、數字及連字號 (-)。

此值為必填項目。

--runtime, -r

用於函數的執行時期。 若要尋找此地區支援的執行時期，請執行 ibmcloud ce function runtimes。 請參閱 執行時期。 此值為必填項目。

--build-commit, --commit, --bcm, --cm, --revision

來源儲存庫中要取回的確定、標籤或分支。 此值為選項。

--build-context-dir, --context-dir, --bcdr, --cdr

儲存庫中包含函數原始碼的目錄。 此值為選項。

--build-git-repo-secret, --git-repo-secret, --bgrs, --grs, --repo

SSH 密鑰的名稱，其中包含用來存取專用儲存庫的認證，而該專用儲存庫包含用來建置程式碼組合映像檔的原始碼。 若要建立此 SSH 密鑰，請使用 secret create --format SSH 指令。 SSH 密鑰也用作 Git 儲存庫存取密鑰。 只有在 --build-source 選項設定為 Git 儲存庫的 URL 時，才允許使用此選項。 此值為選項。

--build-source, --source, --bsrc, --src

Git 儲存庫的 URL 或包含您原始碼的本機原始碼路徑；例如 https://github.com/IBM/CodeEngine 或 .。 此值為選項。

--build-timeout, --bto

在建置必須成功或失敗之前可以經過的時間量 (秒)。 此值為選項。 預設值為 600。

--code-bundle, --cb

用於此函數的 code-bundle 映像檔名稱。 當 build-source 被指定時，此值是由建立推送所產生的輸出影像路徑。 當 build-source 未指定時，此值為現有程式碼束影像的路徑。 格式為 REGISTRY/NAMESPACE/REPOSITORY:TAG，其中 TAG 為選項。 如果未指定 TAG，則默認為 latest。 此值為選項。

--code-bundle-secret, --cs, --cbs

用來向專用登錄進行鑑別的登錄密鑰名稱。 您可以執行 registry create 指令來新增登錄密鑰。 此值為選項。

--cpu

為函數實例設定的 CPU 數量。 如需有效值，請參閱 支援的記憶體及 CPU 組合。 此值為選項。 預設值為 1。

--env, -e

在函數中設定環境變數。 必須為 NAME=VALUE 格式。 此動作會新增環境變數或置換現有的環境變數。 為每個 --env 選項指定一個環境變數; 例如 --env envA=A --env envB=B。 此值為選項。

--env-cm, --env-from-configmap

使用下列其中一種方式，從儲存在此 configmap 中的鍵值組設定環境變數。

• 若要為名為 configmapName 的配置對映中的所有索引鍵新增環境變數，請使用值 configmapName。 您可以在參照 configmap 時指定字首來修改環境變數名稱。 若要指定字首，請使用值 PREFIX=CONFIGMAP_NAME。 每一個產生的環境變數都具有格式 <PREFIX><NAME_OF_KEY_IN_CONFIGMAP>。 例如，若要將 configmap configmapName 中金鑰的所有變數名稱的字首設為 CUSTOM_，請使用值 CUSTOM_=configmapName。 如果 configmap configmapName 包含 KEY_A，則環境變數名稱為 CUSTOM_KEY_A。
• 若要新增個別金鑰的環境變數，請使用格式 NAME:KEY_A,KEY_B。 例如，若要在名為 configmapName 的 configmap 中為單一索引鍵 key1 新增環境變數，請使用值 configmapName:key1。 若要將不同的名稱指派給參照的金鑰，請使用 NAME:NEW_NAME=KEY_A 格式。 例如，若要在名為 configmapName 的 configmap 中為單一索引鍵 key1 新增名為 myKey 的環境變數，請使用值 configmapName:myKey=key1。

此值為選項。

--env-sec, --env-from-secret

使用下列其中一種方式，從儲存在密鑰中的鍵值組設定環境變數。

• 若要在名為 secretName 的密鑰中新增所有金鑰的環境變數，請使用值 secretName。 您可以在參照密鑰時指定字首來修改環境變數名稱。 若要指定字首，請使用值 PREFIX=SECRET_NAME。 每一個產生的環境變數都具有格式 <PREFIX><NAME_OF_KEY_IN_SECRET>。 例如，若要將密鑰 secretName 中金鑰的所有變數名稱的字首設為 CUSTOM_，請使用值 CUSTOM_=secretName。 如果密鑰 secretName 包含 KEY_A，則環境變數名稱為 CUSTOM_KEY_A。
• 若要新增個別金鑰的環境變數，請使用格式 NAME:KEY_A,KEY_B。 例如，若要在名為 secretName 的密鑰中為單一金鑰 key1 新增環境變數，請使用值 secretName:key1。 若要將不同的名稱指派給參照的金鑰，請使用 NAME:NEW_NAME=KEY_A 格式。 例如，若要在名為 secretName 的密鑰中為單一金鑰 key1 新增名為 myKey 的環境變數，請使用值 secretName:myKey=key1。

此值為選項。

--force, -f

請勿驗證指定的 configmap 和密鑰參照是否存在。 此值為選項。 預設值為 false。

--inline-code

指定包含函式原始碼的檔案路徑。 程式碼與函式內嵌儲存。 此值為選項。

--main, --fn-main

在提供的原始碼中指定 main 函數的名稱。 當名稱不是 main 時，需要此選項。 此值為選項。 預設值為 main。

--maxexecutiontime, --met

此函數完成其執行的最長時間（以秒為單位）。 此值為選項。 預設值為 60。

--memory, -m

為功能設定的記憶體數量。 使用 M 表示 megabytes，使用 G 表示 gigabytes。 如需有效值，請參閱 支援的記憶體及 CPU 組合。 此值為選項。 預設值為 4G。

--no-wait, --nw

請不必等待建置執行完成。 此值為選項。 預設值為 false。

--output, -o

指定指令輸出的格式。 有效值為 json、yaml、jsonpath=JSONPATH_EXPRESSION 及 jsonpath-as-json=JSONPATH_EXPRESSION。 使用 jsonpath 來指定 JSON 輸出元素的路徑。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

--scale-down-delay, --sdd

在呼叫完成之後，實例處於作用中狀態的時間量（以秒為單位）。 此選項可以減少冷啟動時間。 如需相關資訊，請參閱 我可以讓函數實例保持作用中的時間更長嗎?。 此值為選項。 預設值為 1。

--trusted-profiles-enabled, --trusted, --tpe

啟用函數執行時裝載計算資源記號。 此值為選項。 預設值為 false。

--visibility, -v

函數的可見性。 有效值為 public, private，和 project。 只有在專案支援功能私有可見性的情況下，才能 private。 此值為選項。 預設值為 public。

--wait, -w

等待建置執行完成。 此值為選項。 預設值為 true。

--wait-timeout, --wto

等待功能就緒的時間長度，以秒為單位。 如果指定 --wait 選項，則需要此值。 如果指定 --no-wait 選項，則會忽略此值。 預設值為 600。

範例

ibmcloud ce fn create --name myfunction --build-source main.js --runtime nodejs

輸出範例

Preparing function 'myfunction' for build push...
Creating function 'myfunction'...
Packaging files to upload from source path 'main.js'...
Submitting build run 'myfunction-run-111111-12345678'...
Creating image 'private.stg.icr.io/ce--1a1a1-11c22def3rhz/function-myfunction:12345678-1111-dexla'...
Waiting for build run to complete...
Build run status: 'Running'
Build run completed successfully.
Run 'ibmcloud ce buildrun get -n myfunction-run-111111-12345678' to check the build run status.
Waiting for function 'myfunction' to become ready...
Function 'myfunction' is ready.
OK                                                
Run 'ibmcloud ce function get -n myfunction' to see more details.

https://myfunction.11c22def3rhz.us-south.codeengine.appdomain.cloud

當您執行 ibmcloud ce fn get -n 'myfunction' 檢查功能狀態時，會顯示您功能的 URL。

指令選項

--name, -n

功能的名稱。 此值為必填項目。

--force, -f

強制刪除，而不進行確認。 此值為選項。 預設值為 false。

--ignore-not-found, --inf

如果找不到，請不要失敗。 此值為選項。 預設值為 false。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

範例

ibmcloud ce fn delete --name myfunction

輸出範例

Are you sure you want to delete function 'myfunction'? [y/N]> y
Deleting function 'myfunction'...
OK

指令選項

--name, -n

功能的名稱。 此值為必填項目。

--output, -o

指定指令輸出的格式。 有效值為 json、yaml、jsonpath=JSONPATH_EXPRESSION 及 jsonpath-as-json=JSONPATH_EXPRESSION。 使用 jsonpath 來指定 JSON 輸出元素的路徑。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

--save, -s

儲存函式的原始碼到本機檔案系統。 只有使用行內程式碼建立的函數才支援此選項。 此值為選項。

範例

ibmcloud ce fn get --name myfunction

輸出範例

Getting function 'myfunction'...
OK

Name:          myfunction  
Project Name:  myproject
Project ID:    01234567-abcd-abcd-abcd-abcdabcd1111
Age:           6m8s  
Created:       2023-06-22T19:59:51Z
URL:           https://myfunction.11c22def3rhz.us-south.codeengine.appdomain.cloud  
Status:        Ready  

Resources:    
  CPU:                 0.25  
  Memory:              500M  
  Max Execution Time:  60 seconds  

Build Information:    
  Build Run Name:     myfunction-run-111111-12345678
  Build Type:         local  
  Build Strategy:     codebundle-nodejs-20  
  Timeout:            600  
  Source:             main.js  

  Build Run Summary:  Succeeded  
  Build Run Status:   Succeeded  
  Build Run Reason:   All Steps have completed executing  
  Run 'ibmcloud ce buildrun get -n myfunction-run-111111-12345678' for details.  

Function Code:    
  Runtime:        nodejs-20 (managed)  
  Bundle Secret:  ce-auto-icr-private-us-south  
  Code Bundle:    cr://icr.io/ce--1a1a1-11c22def3rhz/function-myfunction:12345678-1111-dexla
  Main:           main()

指令選項

--output, -o

指定指令輸出的格式。 有效值為 json、yaml、jsonpath=JSONPATH_EXPRESSION 及 jsonpath-as-json=JSONPATH_EXPRESSION。 使用 jsonpath 來指定 JSON 輸出元素的路徑。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

--sort-by, -s

指定清單排序的直欄。 有效值為 name 和 age。 此值為選項。 預設值為 name。

範例

ibmcloud ce fn delete --name myfunction

輸出範例

Name           Status     URL                                                                    CPU   Memory  Age  
hellofunction  Ready      https://hellofunction.4svg40kna19.us-south.codeengine.appdomain.cloud  0.25  500M    25h  
myfunction     Ready      https://myfun1.4svg40kna19.us-south.codeengine.appdomain.cloud         0.25  1G      8d   
helloworld     Ready      https://myfunction1.4svg40kna19.us-south.codeengine.appdomain.cloud    0.25  1G      16d  
myfunction1    Ready      https://myfunction111.4svg40kna19.us-south.codeengine.appdomain.cloud  0.25  500M    25h  
myfunction3    Ready      https://myfunction41.4svg40kna19.us-south.codeengine.appdomain.cloud   0.25  500M    25h  

指令選項

--all, -A

顯示所有執行時期，包括已淘汰的執行時期。 此值為選項。 預設值為 false。

--output, -o

指定指令輸出的格式。 有效值為 json、yaml、jsonpath=JSONPATH_EXPRESSION 及 jsonpath-as-json=JSONPATH_EXPRESSION。 使用 jsonpath 來指定 JSON 輸出元素的路徑。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

範例

ibmcloud ce fn runtimes

輸出範例

Name         ID           Family  Default  
Python 3.11  python-3.11  python  true  
Node.js 20   nodejs-20    nodejs  true  
Node.js 22   nodejs-22    nodejs  false  
Python 3.13  python-3.13  python  false  

指令選項

--name, -n

要取消連結的函數名稱。 此值為必填項目。

--all, -A

取消連結此函數的所有服務實例。 如果未指定 --binding，則需要此值。 預設值為 false。

--binding, -b

要解除綁定的名稱。 執行 ibmcloud ce function get -n FUNCTION_NAME 檢視綁定名稱。 如果未指定 --all，則需要此值。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

範例

ibmcloud ce fn unbind --name myfunction --all

輸出範例

Removing bindings from 'myfunction'...
OK

指令選項

--name, -n

必要。 功能的名稱。 此值為必填項目。

--build-clear, --bc

從此函數中移除建置的關聯。 只有在您的函數目前有相關聯的建置時，才容許建置清除選項。 此值為選項。 預設值為 false。

--build-commit, --commit, --bcm, --cm, --revision

來源儲存庫中要取回的確定、標籤或分支。 此值為選項。

--build-commit-clear, --commit-clear, --bcmc, --cmc

清除來源儲存庫中要取回的確定、標籤或分支。 只有在您的功能目前有相關聯的建置時，才容許確定清除選項。 此值為選項。 預設值為 false。

--build-context-dir, --context-dir, --bcdr, --cdr

儲存庫中包含函數原始碼的目錄。 只有在設定 --build-source 選項時，才容許此選項。 此值為選項。

--build-git-repo-secret, --git-repo-secret, --bgrs, --grs, --repo

SSH 密碼的名稱，其中包含存取私人資源庫的憑證，該資源庫包含建立映像的原始碼。 此值為選項。

--build-git-repo-secret-clear, --git-repo-secret-clear, --bgrsc, --grsc

清除 SSH 密鑰。 只有在您的功能目前具有相關聯的建置時，才容許此選項。 此值為選項。 預設值為 false。

--build-source, --source, --bsrc, --src

Git 儲存庫的 URL 或包含您原始碼的本機原始碼路徑；例如 https://github.com/IBM/CodeEngine 或 .。 此值為選項。

--build-timeout, --bto

在建置必須成功或失敗之前可以經過的時間量 (秒)。 此值為選項。 預設值為 600。

--code-bundle, --cb

用於此函數的 code-bundle 映像檔名稱。 當 build-source 被指定時，此值是由建立推送所產生的輸出影像路徑。 當 build-source 未指定時，此值為現有程式碼束影像的路徑。 格式為 REGISTRY/NAMESPACE/REPOSITORY:TAG，其中 TAG 為選項。 如果未指定 TAG，則默認為 latest。 此值為選項。

--code-bundle-secret, --cs, --cbs

用來向專用登錄進行鑑別的登錄密鑰名稱。 您可以執行 registry create 指令來新增登錄密鑰。 此值為選項。

--cpu

為函數實例設定的 CPU 數量。 如需有效值，請參閱 支援的記憶體及 CPU 組合。 此值為選項。 預設值為 1。

--env, -e

在函數中設定環境變數。 必須為 NAME=VALUE 格式。 此動作會新增環境變數或置換現有的環境變數。 為每個 --env 選項指定一個環境變數; 例如 --env envA=A --env envB=B。 此值為選項。

--env-cm, --env-from-configmap

使用下列其中一種方式，從儲存在此 configmap 中的鍵值組設定環境變數:

• 若要為名為 configmapName 的配置對映中的所有索引鍵新增環境變數，請使用值 configmapName。 您可以在參照 configmap 時指定字首來修改環境變數名稱。 若要指定字首，請使用值 PREFIX=CONFIGMAP_NAME。 每一個產生的環境變數都具有格式 <PREFIX><NAME_OF_KEY_IN_CONFIGMAP>。 例如，若要將 configmap configmapName 中金鑰的所有變數名稱的字首設為 CUSTOM_，請使用值 CUSTOM_=configmapName。 如果 configmap configmapName 包含 KEY_A，則環境變數名稱為 CUSTOM_KEY_A。
• 若要新增個別金鑰的環境變數，請使用格式 NAME:KEY_A,KEY_B。 例如，若要在名為 configmapName 的 configmap 中為單一索引鍵 key1 新增環境變數，請使用值 configmapName:key1。 若要將不同的名稱指派給參照的金鑰，請使用 NAME:NEW_NAME=KEY_A 格式。 例如，若要在名為 configmapName 的 configmap 中為單一索引鍵 key1 新增名為 myKey 的環境變數，請使用值 configmapName:myKey=key1。

此值為選項。

--env-from-configmap-rm, --env-cm-rm

使用 configmap 名稱來移除完整配置對映的環境變數參照。 若要移除配置對映的個別金鑰參照，請使用 --env-rm 選項。 此選項可以指定多次。 此值為選項。

--env-sec, --env-from-secret

使用下列其中一種方式，從儲存在密鑰中的鍵值組設定環境變數:

• 若要在名為 secretName 的密鑰中新增所有金鑰的環境變數，請使用值 secretName。 您可以在參照密鑰時指定字首來修改環境變數名稱。 若要指定字首，請使用值 PREFIX=SECRET_NAME。 每一個產生的環境變數都具有格式 <PREFIX><NAME_OF_KEY_IN_SECRET>。 例如，若要將密鑰 secretName 中金鑰的所有變數名稱的字首設為 CUSTOM_，請使用值 CUSTOM_=secretName。 如果密鑰 secretName 包含 KEY_A，則環境變數名稱為 CUSTOM_KEY_A。
• 若要新增個別金鑰的環境變數，請使用格式 NAME:KEY_A,KEY_B。 例如，若要在名為 secretName 的密鑰中為單一金鑰 key1 新增環境變數，請使用值 secretName:key1。 若要將不同的名稱指派給參照的金鑰，請使用 NAME:NEW_NAME=KEY_A 格式。 例如，若要在名為 secretName 的密鑰中為單一金鑰 key1 新增名為 myKey 的環境變數，請使用值 secretName:myKey=key1。

此值為選項。

--env-from-secret-rm, --env-sec-rm

使用密鑰名稱來移除完整密鑰的環境變數參照。 若要移除密鑰的個別金鑰參照，請使用 --env-rm 選項。 此選項可以指定多次。 此值為選項。

--env-rm

移除對 configmap 或密鑰中鍵值組之索引鍵的環境變數參照。 若要移除個別索引鍵參照及文字值，請指定索引鍵的名稱。 此選項可以指定多次。 此值為選項。

--force, -f

請勿驗證指定的 configmap 和密鑰參照是否存在。 Configmap 參照是使用 --env-from-configmap 或 --mount-configmap 選項來指定。 密鑰參照以 --env-from-secret、--mount-secret 或 --registry-secret 選項指定。 此值為選項。 預設值為 false。

--inline-code

指定包含函數之原始碼的檔案路徑。 程式碼與函式內嵌儲存。 此值為選項。

--main, --fn-main

在提供的原始碼中指定 main 函數的名稱。 當名稱不是 main 時，需要此選項。 此值為選項。 預設值為 main。

--maxexecutiontime, --met

此函式完成執行的最長執行時間，以秒為單位。 此值為選項。 預設值為 60。

--memory, -m

為功能設定的記憶體數量。 使用 M 表示 megabytes，使用 G 表示 gigabytes。 如需有效值，請參閱 支援的記憶體及 CPU 組合。 此值為選項。 預設值為 4G。

--no-wait, --nw

提交建置執行，且不等待此建置執行完成。 如果您指定 --no-wait 選項，則建置執行提交會開始且不等待。 使用 buildrun get 指令來檢查建置執行狀態。 此值為選項。 預設值為 false。

--output, -o

指定指令輸出的格式。 有效值為 json、yaml、jsonpath=JSONPATH_EXPRESSION 及 jsonpath-as-json=JSONPATH_EXPRESSION。 使用 jsonpath 來指定 JSON 輸出元素的路徑。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

--rebuild

從原始碼重建影像。 只有在您的函數目前有相關聯的建置時，才容許重建選項。 此值為選項。 預設值為 false。

--runtime, -r

用於函數的執行時期。 若要尋找此地區支援的執行時期，請執行 ibmcloud ce function runtimes。 請參閱 執行時期。 此值為選項。

--scale-down-delay, --sdd

在呼叫完成之後，實例處於作用中狀態的時間量（以秒為單位）。 此選項可以減少冷啟動時間。 如需相關資訊，請參閱 我可以讓函數實例保持作用中的時間更長嗎?。 此值為選項。 預設值為 1。

--trusted-profiles-enabled, --trusted, --tpe

啟用函數執行時裝載計算資源記號。 此值為選項。 預設值為 false。

--visibility, -v

函數的可見性。 有效值為 public, private，和 project。 只有在專案支援功能私有可見性的情況下，才能 private。 此值為選項。

--wait, -w

等待建置執行完成。 此值為選項。 預設值為 true。

--wait-timeout, --wto

等待功能就緒的時間長度，以秒為單位。 如果指定 --wait 選項，則需要此值。 如果指定 --no-wait 選項，則會忽略此值。 預設值為 600。

範例

ibmcloud ce fn update --name myfunction --runtime nodejs-20 --build-source main.js

輸出範例

Preparing function 'myfunction' for build push...
Updating function 'myfunction'...
Packaging files to upload from source path 'main.js'...
Submitting build run 'myfunction-run-111111-12345678'...
Creating image 'icr.io/ce--1a1a1-11c22def3rhz/function-myfunction:12345678-1111-dexla'...
Waiting for build run to complete...
Build run status: 'Running'
Build run completed successfully.
Run 'ibmcloud ce buildrun get -n myfunction-run-111111-12345678' to check the build run status.
Waiting for function 'myfunction' to become ready...
Function 'myfunction' is ready.
OK                                                
Run 'ibmcloud ce function get -n myfunction' to see more details.

https://myfunction.11c22def3rhz.us-south.codeengine.appdomain.cloud

當您執行 ibmcloud ce fn get -n 'myfunction' 檢查功能狀態時，會顯示您功能的 URL。

範例

ibmcloud ce help

輸出範例

NAME:
  code-engine, ce - Manage Code Engine components

USAGE:
  ibmcloud ce command [arguments...] [options...]

COMMANDS:
  application, app     Manage applications.
  binding              Manage bindings.
  build, bd, b         Manage configurations for generating images from source code.
  buildrun, br         Generate images from a build.
  configmap, cm        Manage configmaps.
  domainmapping, dm    Manage domain mappings.
  experimental, exp    Experimental Code Engine commands
  function, fn         Manage functions.
  help, h              Show help.
  job                  Manage jobs to configure tasks.
  jobrun, jr           Manage instances of a job.
  connectivity, conn   Manage connectivity commands
  project, proj        Manage Code Engine projects.
  reclamation, recl    Manage Code Engine project reclamations.
  registry             Manage image registry access secrets.
  repo                 Manage Git repository access secrets.
  revision, rev        Manage application revisions.
  secret               Manage secrets.
  serviceaccess        Manage service access secrets.
  subscription, sub    Manage event subscriptions.
  version, v           Display the 'code-engine' command-line interface version.

Enter 'ibmcloud ce help command' for more information about a command.

指令選項

--name, -n

要綁定的工作名稱。 此值為必填項目。

--no-wait, --nw

綁定服務實體，不要等待服務綁定就緒。 如果您指定 --no-wait 選項，則會啟動服務連結建立，且指令會結束而不等待它完成。 使用 job get 指令來檢查工作連結狀態。 此值為選項。 預設值為 false。

--prefix, -p

針對此服務連結建立之環境變數的字首。 只能包含大寫字母、數字及底線 (_)，且不能以數字開頭。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

--role, -r

為此服務綁定建立的新服務憑證的服務角色名稱。 有效值包括 Reader, Writer, Manager 或特定於服務的角色。 選項預設為 Manager，如果不支援 Manager，則為服務提供的第一個角色。 如果指定 --service-credential，則會忽略此選項。 此值為選項。

為此服務綁定建立的新服務憑證的服務角色名稱。 有效值包括 Reader, Writer, Manager 或特定於服務的角色。 選項預設為 Manager，如果不支援 Manager，則為服務提供的第一個角色。 如果指定 --service-credential，則會忽略此選項。 此值為選項。

--service-credential, --sc

要用於此服務綁定的現有服務憑證的名稱。 如果您未指定服務實例認證，則會在連結動作期間產生新認證。 此值為選項。

--service-instance, --si

要連結至工作之現有 IBM Cloud 服務實例的名稱。 此值為選項。

--service-instance-id, --siid

要連結至工作之現有 IBM Cloud 服務實例的 GUID。 此值為選項。

--wait, -w

綁定服務實體，並等待服務綁定就緒。 如果您指定 --wait 選項，則工作連結會等待 --wait-timeout 選項所設定的時間上限 (以秒為單位)，讓工作連結順利完成。 如果工作連結未順利完成或在指定的 --wait-timeout 期間內失敗，則指令會失敗。 此值為選項。 預設值為 true。

--wait-timeout, --wto

等待服務綁定就緒的時間長度 (以秒為單位)。 如果指定 --wait 選項，則需要此值。 如果指定 --no-wait 選項，則會忽略此值。 預設值為 300。

範例

在此範例中，將稱為 my-object-storage 的服務實例連結至稱為 hello 的工作。

ibmcloud ce job bind --name hello --service-instance my-object-storage

輸出範例

Binding service instance...
Waiting for service binding to become ready...
Status: Pending (Processing Resource)
Status: Pending (Processing Resource)
Status: Creating service binding
Status: Creating service binding
Status: Ready
OK

指令選項

-n, --name

工作名稱。 請使用專案內唯一的名稱。

• 名稱必須以小楷字母數字開頭和結束。
• 名稱必須是 63 個字元或更少，且可以包含小寫字母、數字及連字號 (-)。

此值為必填項目。

--argument, --arg, -a

設定工作執行的引數。 為每個 --argument 選項指定一個引數; 例如 -a argA -a argB。 此值為選項。

--array-indices, --ai

指定用於執行工作的陣列索引。 指定以連字號 (-) 或逗點 (，) 區隔的索引清單或範圍; 例如 0,3,6,9 或 1-5,7-8,10。 最大值為 999999。 只有在未指定 --array-size 選項時，才能指定此選項。 此值為選項。 預設值為 0。

--array-size, --as, --instances, --is

指定用於執行工作的實例數。 當您使用這個選項時，系統會轉換成陣列索引。 例如，如果您指定 5 的 instances，系統會轉換為 0 - 4 的 array-indices。 只有在未指定 --array-indices 選項時，才能指定此選項。 此值為選項。 預設值為 1。

--build-commit, --commit, --bcm, --cm, --revision

來源儲存庫中要取回的確定、標籤或分支。 只有在 --build-source 選項設定為 Git 倉庫的 URL 時，才允許使用 build commit 選項。 此值為選項。

--build-context-dir, --context-dir, --bcdr, --cdr

儲存庫中包含建置套件檔案或 Dockerfile 的目錄。 只有在設定 --build-source 選項時，才容許建置環境定義目錄選項。 此值為選項。

--build-dockerfile, --dockerfile, --bdf, --df

Dockerfile 的路徑。 只有在名稱不是 Dockerfile 時，才指定此選項。 只有在設定 --build-source 選項時，才容許建置 dockerfile 選項。 此值為選項。 預設值為 Dockerfile。

--build-git-repo-secret, --git-repo-secret, --bgrs, --grs, --repo

SSH 密鑰的名稱，其中包含用來存取專用儲存庫的認證，該專用儲存庫包含用來建置容器映像檔的原始碼。 若要建立此 SSH 密鑰，請使用 secret create --format SSH 指令。 SSH 密鑰也用作 Git 儲存庫存取密鑰。 只有在 --build-source 選項設定為 Git 儲存庫的 URL 時，才允許使用此選項。 此值為選項。

--build-size, --size, --bsz, --sz

建立的大小，決定使用的資源量。 有效值為 small, medium, large, xlarge，和 xxlarge。 如需詳細資料，請參閱 判斷建置的大小。 只有在設定 --build-source 選項時，才容許建置大小選項。 此值為選項。 預設值為 medium。

--build-source, --source, --bsrc, --src

Git 儲存庫的 URL 或包含您原始碼的本機原始碼路徑；例如 https://github.com/IBM/CodeEngine 或 .。 此值為選項。

--build-strategy, --strategy, --bstr, --str

用於建置映像檔的策略。 有效值為 dockerfile 和 buildpacks。 只有在設定 --build-source 選項時，才容許建置策略選項。 如果未指定，則建置策略由 Code Engine 決定 (如果指定 --build-source 且來源位於本端機器上)。 此值為選項。 預設值為 dockerfile。

--build-timeout, --bto

在建置必須成功或失敗之前可以經過的時間量 (秒)。 只有在設定 --build-source 選項時，才容許建置逾時選項。 此值為選項。 預設值為 600。

--command, --cmd, -c

設定用於執行工作的指令。 為每個 --command 選項指定一個指令; 例如 --cmd cmdA --cmd cmdB。 此值會置換儲存器映像檔內指定的預設指令。 此值為選項。

--cpu

要為工作執行設定的 CPU 數量。 如需有效值，請參閱 支援的記憶體及 CPU 組合。 此值為選項。 預設值為 1。

--env, -e

設定工作執行的環境變數。 必須為 NAME=VALUE 格式。 此動作會新增環境變數或置換現有的環境變數。 為每個 --env 選項指定一個環境變數; 例如 --env envA=A --env envB=B。 此值為選項。

--env-cm, --env-from-configmap

使用下列其中一種方式，從儲存在此 configmap 中的鍵值組設定環境變數:

• 若要為名為 configmapName 的配置對映中的所有索引鍵新增環境變數，請使用值 configmapName。 您可以在參照 configmap 時指定字首來修改環境變數名稱。 若要指定字首，請使用值 PREFIX=CONFIGMAP_NAME。 每一個產生的環境變數都具有格式 <PREFIX><NAME_OF_KEY_IN_CONFIGMAP>。 例如，若要將 configmap configmapName 中金鑰的所有變數名稱的字首設為 CUSTOM_，請使用值 CUSTOM_=configmapName。 如果 configmap configmapName 包含 KEY_A，則環境變數名稱為 CUSTOM_KEY_A。
• 若要新增個別金鑰的環境變數，請使用格式 NAME:KEY_A,KEY_B。 例如，若要在名為 configmapName 的 configmap 中為單一索引鍵 key1 新增環境變數，請使用值 configmapName:key1。 若要將不同的名稱指派給參照的金鑰，請使用 NAME:NEW_NAME=KEY_A 格式。 例如，若要在名為 configmapName 的 configmap 中為單一索引鍵 key1 新增名為 myKey 的環境變數，請使用值 configmapName:myKey=key1。

此值為選項。

--env-sec, --env-from-secret

使用下列其中一種方式，從儲存在密鑰中的鍵值組設定環境變數:

• 若要在名為 secretName 的密鑰中新增所有金鑰的環境變數，請使用值 secretName。 您可以在參照密鑰時指定字首來修改環境變數名稱。 若要指定字首，請使用值 PREFIX=SECRET_NAME。 每一個產生的環境變數都具有格式 <PREFIX><NAME_OF_KEY_IN_SECRET>。 例如，若要將密鑰 secretName 中金鑰的所有變數名稱的字首設為 CUSTOM_，請使用值 CUSTOM_=secretName。 如果密鑰 secretName 包含 KEY_A，則環境變數名稱為 CUSTOM_KEY_A。
• 若要新增個別金鑰的環境變數，請使用格式 NAME:KEY_A,KEY_B。 例如，若要在名為 secretName 的密鑰中為單一金鑰 key1 新增環境變數，請使用值 secretName:key1。 若要將不同的名稱指派給參照的金鑰，請使用 NAME:NEW_NAME=KEY_A 格式。 例如，若要在名為 secretName 的密鑰中為單一金鑰 key1 新增名為 myKey 的環境變數，請使用值 secretName:myKey=key1。

此值為選項。

--ephemeral-storage, --es

為執行工作設定的短暫存儲量。 使用 M 表示 megabytes，使用 G 表示 gigabytes。 此值為選項。 預設值為 400M。

--force, -f

請勿驗證指定的 configmap 和密鑰參照是否存在。 Configmap 參照是以 --env-from-configmap 選項指定。 密鑰參照以 --env-from-secret 或 --registry-secret 選項指定。 此值為選項。 預設值為 false。

--image, -i

用於執行工作的映像檔名稱。 格式為 REGISTRY/NAMESPACE/REPOSITORY:TAG，其中 REGISTRY 和 TAG 為選項。 如果未指定 REGISTRY，則默認為 docker.io。 如果未指定 TAG，則默認為 latest。 如果未指定 --build-source 選項，則必須使用 image 選項。 此值為選項。

--maxexecutiontime, --met

工作執行的執行時間上限（以秒為單位）。 此選項只能在 mode 為 task 時指定。 此值為選項。 預設值為 7200。

--memory, -m

為工作執行設定的記憶體數量。 使用 M 表示 megabytes，使用 G 表示 gigabytes。 如需有效值，請參閱 支援的記憶體及 CPU 組合。 此值為選項。 預設值為 4G。

--mode

工作執行的模式。 有效值為 task 和 daemon。 在 task 模式中，maxexecutiontime 和 retrylimit 選項適用。 在 daemon 模式中，由於沒有超時，且失敗的實體會無限期地重新啟動，因此不允許使用 --maxexecutiontime 和 --retrylimit 選項。 此值為選項。 預設值為 task。

--mount-configmap, --mount-cm

提供裝載目錄及 configmap 名稱 (格式為 MOUNT_DIRECTORY=CONFIGMAP_NAME)，將 configmap 的內容新增至工作執行的檔案系統。 每一個裝載的 configmap 都必須使用唯一的裝載目錄。 對於 configmap 中的每一個鍵值組，會將一個檔案新增至指定的裝載目錄，其中檔名是索引鍵，檔案內容是鍵值組的值。 為每個 --mount-configmap 選項指定一個裝載配置; 例如 --mount-configmap /etc/config-a=config-a --mount-configmap /etc/config-b=config-b。 此值為選項。

--mount-data-store, --mount-ds

裝載持續資料儲存庫。 格式為 MOUNT_DIRECTORY=STORAGE_NAME [:SUBPATH]。 SUBPATH 是可選的。 此選項可以指定多次。 此值為選項。

--mount-secret, --mount-sec

透過提供裝載目錄及密鑰名稱 (格式為 MOUNT_DIRECTORY=SECRET_NAME)，將密鑰內容新增至工作執行的檔案系統。 每一個裝載密鑰都必須使用唯一的裝載目錄。 對於密鑰中的每一個鍵值組，會將一個檔案新增至指定的裝載目錄，其中檔名是金鑰，檔案的內容是鍵值組的值。 為每個 --mount-secret 選項指定一個裝載配置; 例如 --mount-secret /etc/secret-a=secret--a --mount-secret /etc/secret-b=secret-b。 此值為選項。

--no-wait, --nw

請不必等待建置執行完成。 如果您指定 --no-wait 選項，則建置會開始執行，且不會等待。 使用 buildrun get 指令來檢查建置執行狀態。 只有在設定 --build-source 選項時，才容許 no-wait 選項。 此值為選項。 預設值為 false。

--output, -o

指定指令輸出的格式。 有效值為 json、yaml、jsonpath=JSONPATH_EXPRESSION 及 jsonpath-as-json=JSONPATH_EXPRESSION。 使用 jsonpath 來指定 JSON 輸出元素的路徑。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

--registry-secret, --rs

登錄密鑰的名稱。 當您下載容器映像檔時，會使用登錄密鑰向專用登錄進行鑑別。 此值為選項。

--retrylimit, -r

在工作標示為失敗之前，重新執行工作實例的次數。 當工作提供零以外的結束碼時，會重新執行工作的陣列索引。 此選項只能在 mode 為 task 時指定。 此值為選項。 預設值為 3。

--service-account, --sa

服務帳戶的名稱。 服務帳戶提供在實例中執行之程序的身分。 對於內建服務帳戶，您可以使用縮短的名稱 manager、none、reader 及 writer。 您也可以使用字首為 Kubernetes Config Context 的完整名稱，可以使用 project current 指令來判定。 此值為選項。

--trusted-profiles-enabled, --trusted, --tpe

啟用工作執行時裝載計算資源記號。 此值為選項。 預設值為 false。

--wait, -w

等待建置執行完成。 如果您指定 --wait 選項，建置執行會等待 --wait-timeout 選項所設定的時間上限 (以秒為單位)，建置執行才能完成。 如果建置執行未在指定的 --wait-timeout 期間內完成，則建置執行會失敗。 只有在設定 --build-source 選項時，才容許等待選項。 此值為選項。 預設值為 true。

--wait-timeout, --wto

等待建置執行完成的時間長度（以秒為單位）。 如果指定 --wait 選項，則需要此值。 如果指定 --no-wait 選項，則會忽略此值。 只有在設定 --build-source 選項時，才容許 wait-timeout 選項。 預設值為 600。

範例

下列範例使用容器映像檔 icr.io/codeengine/firstjob，並將 2G MB 作為記憶體及 1 個 CPU 指派給容器。 如需選取有效記憶體及 CPU 值的相關資訊，請參閱 支援的記憶體及 CPU 組合。

ibmcloud ce job create --image icr.io/codeengine/firstjob --name hellojob --memory 2G --cpu 1

輸出範例

Creating job 'hellojob'...
OK

指令選項

--name, -n

工作名稱。 此值為必填項目。

--force, -f

強制刪除，而不進行確認。 此值為選項。 預設值為 false。

--ignore-not-found, --inf

如果找不到，請不要失敗。 此值為選項。 預設值為 false。

--orphan-job-runs, -o

指定要保留與此工作配置相關聯的任何工作執行。 然後必須個別刪除這些孤立工作執行。 此值為選項。 預設值為 false。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

範例

ibmcloud ce job delete --name hello

輸出範例

Are you sure you want to delete job hello? [y/N]> y
Deleting job 'hello'...
OK

當您執行 ibmcloud ce job delete 指令來刪除工作時，也會刪除參照此工作的所有已提交工作執行。

指令選項

--name, -n

工作名稱。 此值為必填項目。

--output, -o

指定指令輸出的格式。 有效值為 json、yaml、jsonpath=JSONPATH_EXPRESSION 及 jsonpath-as-json=JSONPATH_EXPRESSION。 使用 jsonpath 來指定 JSON 輸出元素的路徑。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

範例

ibmcloud ce job get --name hellojob

輸出範例

Getting job 'hellojob'...
OK

Name:          hellojob
ID:            abcdabcd-abcd-abcd-abcd-abcdabcd1111
Project Name:  myproj
Project ID:    01234567-abcd-abcd-abcd-abcdabcd2222
Age:           59s
Created:       2021-03-01T15:33:30-05:00

Last Job Run:
  Name:     hellojob-jobrun-abcde
  Age:      32d
  Created:  2021-06-06T13:52:42-04:00

Image:                icr.io/codeengine/firstjob
Resource Allocation:
    CPU:     1
    Memory:  4G

Runtime:
    Mode:                  task
    Array Indices:         0
    Array Size:            1
    Max Execution Time:    7200
    Retry Limit:           3

指令選項

--output, -o

指定指令輸出的格式。 有效值為 json、yaml、jsonpath=JSONPATH_EXPRESSION 及 jsonpath-as-json=JSONPATH_EXPRESSION。 使用 jsonpath 來指定 JSON 輸出元素的路徑。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

--sort-by, -s

指定清單排序的直欄。 有效值為 name 和 age。 此值為選項。 預設值為 name。

範例

ibmcloud ce job list

輸出範例

Name           Age   Last Job Run Name      Last Job Run Age
demo           110d  demo-jobrun-hkkmx      108d
myjob-envvar   107d
hellojob       7s
myjob          60d   myjob-977v7            58d
testjob        88d   testjob-jobrun-kzxlp   72d

指令選項

--name, -n

要解除綁定的工作名稱。 此值為必填項目。

--all, -A

解除此工作的所有服務實體。 如果未指定 --binding，則需要此值。 預設值為 false。

--binding, -b

要解除綁定的名稱。 執行 ibmcloud ce job get -n JOB_NAME 檢視綁定名稱。 如果未指定 --all，則需要此值。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

範例

在此範例中，從稱為 hello 的工作中移除所有連結。

ibmcloud ce job unbind --name hello --all

輸出範例

Removing service bindings...
OK

指令選項

--name, -n

工作名稱。 此值為必填項目。

--argument, --arg, -a

設定工作執行的引數。 為每個 --argument 選項指定一個引數; 例如 -a argA -a argB。 此值為選項。

--arguments-clear, --ac

清除工作引數。 此值為選項。 預設值為 false。

--array-indices, --ai

指定用於執行工作的陣列索引。 指定以連字號 (-) 或逗點 (，) 區隔的索引清單或範圍; 例如 0,3,6,9 或 1-5,7-8,10。 最大值為 999999。 只有在未指定 --array-size 選項時，才能指定此選項。 此值為選項。

--array-size, --as, --instances, --is

指定用於執行工作的實例數。 當您使用這個選項時，系統會轉換成陣列索引。 例如，如果您指定 5 的 instances，系統會轉換為 0 - 4 的 array-indices。 只有在未指定 --array-indices 選項時，才能指定此選項。 此值為選項。 預設值為 0。

--build-clear, --bc

從此工作中移除建置的關聯。 只有在您的工作目前有相關聯的建置時，才容許建置清除選項。 此值為選項。 預設值為 false。

--build-commit, --commit, --bcm, --cm, --revision

來源儲存庫中要取回的確定、標籤或分支。 只有當 --build-source 選項在此 job update 指令上設定為 Git 儲存庫的 URL，或您的工作目前有來自 Git 儲存庫來源的關聯建立，才允許使用 build commit 選項。 此值為選項。

--build-commit-clear, --commit-clear, --bcmc, --cmc

清除來源儲存庫中要取回的確定、標籤或分支。 只有在您的工作目前具有相關聯的建置時，才容許確定清除選項。 此值為選項。 預設值為 false。

--build-context-dir, --context-dir, --bcdr, --cdr

儲存庫中包含建置套件檔案或 Dockerfile 的目錄。 只有在這個 job update 指令已設定 --build-source 選項，或您的工作目前有相關聯的建置時，才容許建置環境定義目錄選項。 此值為選項。

--build-dockerfile, --dockerfile, --bdf, --df

Dockerfile 的路徑。 只有在名稱不是 Dockerfile 時，才指定此選項。 如果在此 job update 指令上設定 --build-source 選項，或您的工作目前具有相關聯的建置，則容許建置 dockerfile 選項。 此值為選項。 預設值為 Dockerfile。

--build-git-repo-secret, --git-repo-secret, --bgrs, --grs, --repo

SSH 密鑰的名稱，其中包含用來存取專用儲存庫的認證，該專用儲存庫包含用來建置容器映像檔的原始碼。 若要建立此 SSH 密鑰，請使用 secret create --format SSH 指令。 SSH 密鑰也用作 Git 儲存庫存取密鑰。 只有當 --build-source 選項在此 job update 指令上設定為 Git 儲存庫的 URL，或您的工作目前有來自 Git 儲存庫來源的關聯建立時，才允許使用此選項。 此值為選項。

--build-git-repo-secret-clear, --git-repo-secret-clear, --bgrsc, --grsc

清除 SSH 密鑰。 如果您的工作目前具有相關聯的建置，則容許此選項。 此值為選項。 預設值為 false。

--build-size, --size, --bsz, --sz

建立的大小，決定使用的資源量。 有效值為 small, medium, large, xlarge，和 xxlarge。 如需詳細資料，請參閱 判斷建置的大小。 只有在此 job update 指令上設定 --build-source 選項，或您的工作目前具有相關聯的建置時，才容許建置大小選項。 此值為選項。 預設值為 medium。

--build-source, --source, --bsrc, --src

Git 儲存庫的 URL 或包含您原始碼的本機原始碼路徑；例如 https://github.com/IBM/CodeEngine 或 .。 此值為選項。

--build-strategy, --strategy, --bstr, --str

用於建置映像檔的策略。 有效值為 dockerfile 和 buildpacks。 只有在此 job update 指令上設定 --build-source 選項，或您的工作目前具有相關聯的建置時，才容許建置策略選項。 如果未指定，則建置策略由 Code Engine 決定 (如果指定 --build-source 且來源位於本端機器上)。 此值為選項。 預設值為 dockerfile。

--build-timeout, --bto

在建置必須成功或失敗之前可以經過的時間量 (秒)。 只有在此 job update 指令上設定 --build-source 選項，或您的工作目前具有相關聯的建置時，才容許建置逾時選項。 此值為選項。 預設值為 600。

--command, --cmd, -c

設定用於執行工作的指令。 為每個 --command 選項指定一個指令; 例如 --cmd cmdA --cmd cmdB。 此值會置換儲存器映像檔內指定的預設指令。 此值為選項。

--commands-clear, --cc

清除工作指令。 此值為選項。 預設值為 false。

--cpu

要為工作執行設定的 CPU 數量。 此值會更新工作中指派的任何 --cpu 值。 如需有效值，請參閱 支援的記憶體及 CPU 組合。 此值為選項。 預設值為 0。

--env, -e

設定工作執行的環境變數。 必須為 NAME=VALUE 格式。 此動作會新增環境變數或置換現有的環境變數。 為每個 --env 選項指定一個環境變數; 例如 --env envA=A --env envB=B。 此值為選項。

--env-cm, --env-from-configmap

使用下列其中一種方式，從儲存在此 configmap 中的鍵值組設定環境變數:

• 若要為名為 configmapName 的配置對映中的所有索引鍵新增環境變數，請使用值 configmapName。 您可以在參照 configmap 時指定字首來修改環境變數名稱。 若要指定字首，請使用值 PREFIX=CONFIGMAP_NAME。 每一個產生的環境變數都具有格式 <PREFIX><NAME_OF_KEY_IN_CONFIGMAP>。 例如，若要將 configmap configmapName 中金鑰的所有變數名稱的字首設為 CUSTOM_，請使用值 CUSTOM_=configmapName。 如果 configmap configmapName 包含 KEY_A，則環境變數名稱為 CUSTOM_KEY_A。
• 若要新增個別金鑰的環境變數，請使用格式 NAME:KEY_A,KEY_B。 例如，若要在名為 configmapName 的 configmap 中為單一索引鍵 key1 新增環境變數，請使用值 configmapName:key1。 若要將不同的名稱指派給參照的金鑰，請使用 NAME:NEW_NAME=KEY_A 格式。 例如，若要在名為 configmapName 的 configmap 中為單一索引鍵 key1 新增名為 myKey 的環境變數，請使用值 configmapName:myKey=key1。

此值為選項。

--env-from-configmap-rm, --env-cm-rm

使用 configmap 名稱來移除完整配置對映的環境變數參照。 若要移除配置對映的個別金鑰參照，請使用 --env-rm 選項。 此選項可以指定多次。 此值為選項。

--env-sec, --env-from-secret

使用下列其中一種方式，從儲存在密鑰中的鍵值組設定環境變數:

• 若要在名為 secretName 的密鑰中新增所有金鑰的環境變數，請使用值 secretName。 您可以在參照密鑰時指定字首來修改環境變數名稱。 若要指定字首，請使用值 PREFIX=SECRET_NAME。 每一個產生的環境變數都具有格式 <PREFIX><NAME_OF_KEY_IN_SECRET>。 例如，若要將密鑰 secretName 中金鑰的所有變數名稱的字首設為 CUSTOM_，請使用值 CUSTOM_=secretName。 如果密鑰 secretName 包含 KEY_A，則環境變數名稱為 CUSTOM_KEY_A。
• 若要新增個別金鑰的環境變數，請使用格式 NAME:KEY_A,KEY_B。 例如，若要在名為 secretName 的密鑰中為單一金鑰 key1 新增環境變數，請使用值 secretName:key1。 若要將不同的名稱指派給參照的金鑰，請使用 NAME:NEW_NAME=KEY_A 格式。 例如，若要在名為 secretName 的密鑰中為單一金鑰 key1 新增名為 myKey 的環境變數，請使用值 secretName:myKey=key1。

此值為選項。

--env-from-secret-rm, --env-sec-rm

使用密鑰名稱來移除完整密鑰的環境變數參照。 若要移除密鑰的個別金鑰參照，請使用 --env-rm 選項。 此選項可以指定多次。 此值為選項。

--env-rm

移除對 configmap 或密鑰中鍵值組之索引鍵的環境變數參照。 若要移除個別索引鍵參照及文字值，請指定索引鍵的名稱。 此選項可以指定多次。 此值為選項。

--ephemeral-storage, --es

為執行工作設定的短暫存儲量。 使用 M 表示 megabytes，使用 G 表示 gigabytes。 此值為選項。

--force, -f

請勿驗證指定的 configmap 和密鑰參照是否存在。 Configmap 參照是以 --env-from-configmap 選項指定。 密鑰參照以 --env-from-secret 或 --registry-secret 選項指定。 此值為選項。 預設值為 false。

--image, -i

用於執行工作的映像檔名稱。 格式為 REGISTRY/NAMESPACE/REPOSITORY:TAG，其中 REGISTRY 和 TAG 為選項。 如果未指定 REGISTRY，則默認為 docker.io。 如果未指定 TAG，則默認為 latest。 此值為選項。

--maxexecutiontime, --met

工作執行的執行時間上限（以秒為單位）。 此選項只能在 mode 為 task 時指定。 此值為選項。 預設值為 7200。

--memory, -m

為工作執行設定的記憶體數量。 使用 M 表示 megabytes，使用 G 表示 gigabytes。 如需有效值，請參閱 支援的記憶體及 CPU 組合。 此值為選項。

--mode

工作執行的模式。 有效值為 task 和 daemon。 在 task 模式中，maxexecutiontime 和 retrylimit 選項適用。 在 daemon 模式中，由於沒有超時，且失敗的實體會無限期地重新啟動，因此不允許使用 --maxexecutiontime 和 --retrylimit 選項。 此值為選項。

--mount-configmap, --mount-cm

提供裝載目錄及 configmap 名稱 (格式為 MOUNT_DIRECTORY=CONFIGMAP_NAME)，將 configmap 的內容新增至工作執行的檔案系統。 每一個裝載的 configmap 都必須使用唯一的裝載目錄。 對於 configmap 中的每一個鍵值組，會將一個檔案新增至指定的裝載目錄，其中檔名是索引鍵，檔案內容是鍵值組的值。 為每個 --mount-configmap 選項指定一個裝載配置; 例如 --mount-configmap /etc/config-a=config-a --mount-configmap /etc/config-b=config-b。 此值為選項。

--mount-data-store, --mount-ds

裝載持續資料儲存庫。 格式為 MOUNT_DIRECTORY=STORAGE_NAME [:SUBPATH]。 SUBPATH 是可選的。 此選項可以指定多次。 此值為選項。

--mount-rm

透過指定裝載 configmap 或密鑰的目錄，從工作執行的檔案系統中移除 configmap 或密鑰的內容。 為每個 --mount-rm 選項指定一個裝載目錄; 例如 --mount-rm /etc/configmap-a --mount-rm /etc/secret-b。 此值為選項。

--mount-secret, --mount-sec

透過提供裝載目錄及密鑰名稱 (格式為 MOUNT_DIRECTORY=SECRET_NAME)，將密鑰內容新增至工作執行的檔案系統。 每一個裝載密鑰都必須使用唯一的裝載目錄。 對於密鑰中的每一個鍵值組，會將一個檔案新增至指定的裝載目錄，其中檔名是金鑰，檔案的內容是鍵值組的值。 為每個 --mount-secret 選項指定一個裝載配置; 例如 --mount-secret /etc/secret-a=secret--a --mount-secret /etc/secret-b=secret-b。 此值為選項。

--no-wait, --nw

請不必等待建置執行完成。 如果您指定 --no-wait 選項，則建置會開始執行，且不會等待。 使用 buildrun get 指令來檢查建置執行狀態。 只有在此 job update 指令上設定 --build-source 選項，或您的工作目前具有相關聯的建置時，才容許不等待選項。 此值為選項。 預設值為 false。

--output, -o

指定指令輸出的格式。 有效值為 json、yaml、jsonpath=JSONPATH_EXPRESSION 及 jsonpath-as-json=JSONPATH_EXPRESSION。 使用 jsonpath 來指定 JSON 輸出元素的路徑。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

--rebuild

從來源重建映像檔。 如果您的工作目前具有相關聯的建置，則容許重建選項。 此值為選項。 預設值為 false。

--registry-secret, --rs

登錄密鑰的名稱。 當您下載容器映像檔時，會使用登錄密鑰向專用登錄進行鑑別。 此值為選項。

--registry-secret-clear, --rsc

清除登錄密鑰。 此值為選項。 預設值為 false。

--retrylimit, -r

在工作標示為失敗之前，重新執行工作實例的次數。 當工作提供零以外的結束碼時，會重新執行工作的陣列索引。 此選項只能在 mode 為 task 時指定。 此值為選項。 預設值為 3。

--service-account, --sa

服務帳戶的名稱。 服務帳戶提供在實例中執行之程序的身分。 對於內建服務帳戶，您可以使用縮短的名稱 manager、none、reader 及 writer。 您也可以使用字首為 Kubernetes Config Context 的完整名稱，可以使用 project current 指令來判定。 此值為選項。

--service-account-clear, --sac

清除服務帳戶。 此值為選項。 預設值為 false。

--trusted-profiles-enabled, --trusted, --tpe

啟用工作執行時裝載計算資源記號。 此值為選項。 預設值為 false。

--wait, -w

等待建置執行完成。 如果您指定 --wait 選項，建置執行會等待 --wait-timeout 選項所設定的時間上限 (以秒為單位)，建置執行才能完成。 如果建置執行未在指定的 --wait-timeout 期間內完成，則建置執行會失敗。 只有在此 job update 指令上設定 --build-source 選項，或您的工作目前具有相關聯的建置時，才容許等待選項。 此值為選項。 預設值為 true。

--wait-timeout, --wto

等待建置執行完成的時間長度（以秒為單位）。 如果指定 --wait 選項，則需要此值。 如果指定 --no-wait 選項，則會忽略此值。 如果在此 job update 指令上設定 --build-source 選項，或您的工作目前具有相關聯的建置，則容許等待逾時選項。 預設值為 600。

範例

ibmcloud ce job update --name hellojob --cpu 2

輸出範例

Updating job 'hellojob'...
OK

指令選項

--force, -f

強制刪除，而不進行確認。 此值為選項。 預設值為 false。

--ignore-not-found, --inf

如果找不到，請不要失敗。 此值為選項。 預設值為 false。

--job, -j

使用此選項來刪除指定工作的所有工作執行。 如果您未指定 --name 值，則需要 --job 選項。 此值為選項。

--name, -n

要刪除的工作執行的名稱。 如果您未指定 --job 值，則需要 --name 選項。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

範例

ibmcloud ce jobrun delete --name myjobrun -f

輸出範例

Deleting job run 'myjobrun'...
OK

指令選項

--instance, -i

特定工作執行實例的名稱。 使用 jobrun get 指令來尋找實例名稱。 如果未指定 --jobrun，則需要此值。

--jobrun, -j, --name, -n

顯示所指定工作執行之所有實例的事件。 如果未指定 --instance，則需要此值。

--output, -o

指定指令輸出的格式。 有效值為 json、yaml、jsonpath=JSONPATH_EXPRESSION 及 jsonpath-as-json=JSONPATH_EXPRESSION。 使用 jsonpath 來指定 JSON 輸出元素的路徑。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

範例

下列範例顯示所指定工作執行之所有實例的系統事件資訊。

ibmcloud ce jobrun events --jobrun myjobrun

輸出範例

Getting jobrun 'myjobrun'...
Getting instances of jobrun 'myjobrun'...
Getting events for all instances of job run 'myjobrun'...
OK

myjobrun-1-0:
    Type     Reason                  Age  Source                  Messages
    Normal   Scheduled               49s  default-scheduler       Successfully assigned 4svg40kna19/myjobrun-1-0 to 10.240.64.136
    [...]
    Normal   Pulling                 34s  kubelet, 10.240.64.136  Pulling image "icr.io/codeengine/testjob"

myjobrun-2-0:
    Type    Reason     Age  Source                  Messages
    Normal  Scheduled  50s  default-scheduler       Successfully assigned 4svg40kna19/myjobrun-2-0 to 10.240.64.131
    Normal  Pulling    48s  kubelet, 10.240.64.131  Pulling image "icr.io/codeengine/testjob"

指定工作執行實例的系統事件資訊範例

您也可以搭配使用 --instance 選項與 ibmcloud ce jobrun events 指令，來顯示所指定工作實例的系統事件資訊。 使用 jobrun get 指令來顯示工作執行的詳細資料，包括工作執行的執行中實例。

ibmcloud ce jobrun events --instance myjobrun-2-0

Getting events for job run instance 'myjobrun-2-0'...
OK

myjobrun-2-0:
    Type    Reason     Age    Source                  Messages
    Normal  Scheduled  3m39s  default-scheduler       Successfully assigned 4svg40kna19/myjobrun-2-0 to 10.240.64.131
    Normal  Pulling    3m37s  kubelet, 10.240.64.131  Pulling image "icr.io/codeengine/testjob"
    Normal  Pulled     2m42s  kubelet, 10.240.64.131  Successfully pulled image "icr.io/codeengine/testjob"
    Normal  Created    2m42s  kubelet, 10.240.64.131  Created container myjobrun
    Normal  Started    2m41s  kubelet, 10.240.64.131  Started container myjobrun

指令選項

--name, -n

工作執行的名稱。 此值為必填項目。

--output, -o

指定指令輸出的格式。 有效值為 json、yaml、jsonpath=JSONPATH_EXPRESSION 及 jsonpath-as-json=JSONPATH_EXPRESSION。 使用 jsonpath 來指定 JSON 輸出元素的路徑。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

範例

ibmcloud ce jobrun get --name myjobrun  

輸出範例

Getting jobrun 'myjobrun'...
Getting instances of jobrun 'myjobrun'...
Getting events of jobrun 'myjobrun'...
Run 'ibmcloud ce jobrun events -n myjobrun' to get the system events of the job run instances.
Run 'ibmcloud ce jobrun logs -f -n myjobrun' to follow the logs of the job run instances.
OK

Name:          myjobrun
[...]
Created:       2021-03-02T10:31:13-05:00

Image:                icr.io/codeengine/firstjob
Resource Allocation:
    CPU:                1
    Ephemeral Storage:  400M
    Memory:             4G

Runtime:
    Mode:                  task
    Array Indices:         1-5
    Array Size:            5
    JOP_ARRAY_SIZE Value:  5
    Max Execution Time:    7200
    Retry Limit:           3

Status:
    Completed:          2m58s
    Instance Statuses:
        Succeeded:  5
    Conditions:
        Type      Status  Last Probe  Last Transition
    Pending   True    3m55s       3m55s
    Running   True    3m51s       3m51s
    Complete  True    2m58s       2m58s

Events:
    Type     Reason         Age                     Source                Messages
    [...]
    Normal   Updated        3m38s (x23 over 3m56s)  batch-job-controller  Updated JobRun "myjobrun"
    Normal   Updated        3m38s (x22 over 3m56s)  batch-job-controller  Updated JobRun "myjobrun"

Instances:
    Name           Running  Status     Restarts  Age
    myjobrun-1-0  0/1      Succeeded  0         3m58s
    myjobrun-2-0  0/1      Succeeded  0         3m58s
    myjobrun-3-0  0/1      Succeeded  0         3m57s
    myjobrun-4-0  0/1      Succeeded  0         3m58s
    myjobrun-5-0  0/1      Succeeded  0         3m58s

指令選項

--job, -j

使用此選項僅顯示從指定工作執行的工作。 此值為選項。

--output, -o

指定指令輸出的格式。 有效值為 json、yaml、jsonpath=JSONPATH_EXPRESSION 及 jsonpath-as-json=JSONPATH_EXPRESSION。 使用 jsonpath 來指定 JSON 輸出元素的路徑。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

--sort-by, -s

指定清單排序的直欄。 有效值為 name 和 age。 此值為選項。 預設值為 name。

範例

ibmcloud ce jobrun list

輸出範例

Listing job runs...
OK

Name                         Failed  Pending  Requested  Running  Succeeded  Unknown  Age
firstjob-jobrun-shnj5        0       0        0          0        1          0        11d
myjob-jobrun-fji48           0       0        0          0        5          0        11d
myjob-jobrun-xeqc8           0       0        0          0        5          0        12d
myjobrun                     0       0        0          0        5          0        7m47s
mytestjob-jobrun-el0o8       0       0        0          0        1          0        11d
testjobrun                   0       0        0          0        5          0        11d

列出的工作執行名稱指出工作執行的名稱，以及工作執行的現行修訂。

指令選項

--follow, -f

遵循工作執行實例的日誌。 使用此選項來串流工作執行實例的日誌。 如果您指定 --follow 選項，則必須輸入 Ctrl+C 以終止此日誌指令。 此值為選項。 預設值為 false。

--instance, -i

特定工作執行實例的名稱。 使用 jobrun get 指令來尋找實例名稱。 如果未指定 --jobrun，則需要此值。

--jobrun, -j, --name, -n

顯示所指定工作執行之所有實例的日誌。 如果未指定 --instance，則需要此值。

--output, -o

指定指令輸出的格式。 有效值為 json、yaml、jsonpath=JSONPATH_EXPRESSION 及 jsonpath-as-json=JSONPATH_EXPRESSION。 使用 jsonpath 來指定 JSON 輸出元素的路徑。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

--raw, -r

顯示不含實例及容器標籤的日誌。 此值為選項。 預設值為 false。

--tail, -t

將所指定工作執行實例的日誌顯示限制為最近的行數上限。 例如，若要顯示所指定工作執行實例之日誌的最後 3 行，請指定 --tail 3。 如果未指定此選項，則會顯示所指定工作執行實例的所有日誌行。 此值為選項。 預設值為 -1。

--timestamps, --ts

在日誌輸出的每一行包含時間戳記。 此值為選項。 預設值為 false。

範例

下列範例顯示工作執行特定實例的日誌。 使用 jobrun get 指令來取得工作執行實例的名稱。

ibmcloud ce jobrun logs --instance myjobrun-3-0

輸出範例

Getting logs for job run instance 'myjobrun-3-0'...
OK

myjobrun-3-0/myjobrun:
Hi from a batch job! My index is: 3

工作執行所有實例的日誌範例

下列範例顯示工作執行所有實例的日誌。

ibmcloud ce jobrun logs --jobrun myjobrun

Getting logs for all instances of job run 'myjobrun'...
Getting jobrun 'myjobrun'...
Getting instances of jobrun 'myjobrun'...
OK

myjobrun-1-0/myjobrun:
Hi from a batch job! My index is: 1

myjobrun-2-0/myjobrun:
Hi from a batch job! My index is: 2

myjobrun-3-0/myjobrun:
Hi from a batch job! My index is: 3

myjobrun-4-0/myjobrun:
Hi from a batch job! My index is: 4

myjobrun-5-0/myjobrun:
Hi from a batch job! My index is: 5

指令選項

--instance, -i

特定工作執行實例的名稱。 使用 jobrun get 指令來尋找實例名稱。 如果未指定 --jobrun，則需要此值。

--jobrun, -j, --name, -n

重新啟動所指定工作執行的所有執行中實例。 如果未指定 --instance，則需要此值。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

範例

ibmcloud ce jobrun restart --name myjobrun   

輸出範例

Getting jobrun 'myjobrun'...
Getting instances of jobrun 'myjobrun'...
Restarting all running instances of job run 'myjobrun'...
OK

指令選項

--jobrun, -j

此工作執行所根據的前一個工作執行名稱。 此值為必填項目。

--argument, --arg, -a

設定此工作執行的引數。 為每個 --argument 選項指定一個引數; 例如 -a argA -a argB。 此值為選項。

--arguments-clear, --ac

清除工作執行引數。 此值為選項。 預設值為 false。

--array-indices, --ai

指定用於此工作執行的陣列索引。 指定以連字號 (-) 或逗點 (，) 區隔的索引清單或範圍; 例如 0,3,6,9 或 1-5,7-8,10。 最大值為 999999。 只有在未指定 --array-size 選項時，才能指定此選項。 此值為選項。

--array-size, --as, --instances, --is

指定用於此工作執行的實例數。 當您使用這個選項時，系統會轉換成陣列索引。 例如，如果您指定 5 的 instances，系統會轉換為 0 - 4 的 array-indices。 只有在未指定 --array-indices 選項時，才能指定此選項。 此值為選項。 預設值為 0。

--array-size-var-override, --array-size-variable-override, --asvo

指定 JOB_ARRAY_SIZE 環境變數的自訂值。 預設情況下，JOB_ARRAY_SIZE 環境變數會設定為 array-size 值或 array-indices 所指定的索引數。 JOB_ARRAY_SIZE 環境變數的值不會影響已配置的陣列大小。 使用此選項來施行工作重新執行實務範例的常數陣列大小值，其中只會提交或重新提交部分工作實例。 此值為選項。

--command, --cmd, -c

設定此工作執行的指令。 為每個 --command 選項指定一個指令; 例如 --cmd cmdA --cmd cmdB。 此值會置換儲存器映像檔內指定的預設指令。 此值為選項。

--commands-clear, --cc

清除工作執行指令。 此值為選項。 預設值為 false。

--cpu

針對此工作執行的每一個陣列索引所設定的 CPU 數量。 如需有效值，請參閱 支援的記憶體及 CPU 組合。 此值為選項。 預設值為 0。

--env, -e

設定此工作執行的環境變數。 必須為 NAME=VALUE 格式。 此動作會新增環境變數或置換現有的環境變數。 為每個 --env 選項指定一個環境變數; 例如 -e envA -e envB。 此值為選項。

--env-cm, --env-from-configmap

使用下列其中一種方式，從儲存在此 configmap 中的鍵值組設定環境變數:

• 若要為名為 configmapName 的配置對映中的所有索引鍵新增環境變數，請使用值 configmapName。 您可以在參照 configmap 時指定字首來修改環境變數名稱。 若要指定字首，請使用值 PREFIX=CONFIGMAP_NAME。 每一個產生的環境變數都具有格式 <PREFIX><NAME_OF_KEY_IN_CONFIGMAP>。 例如，若要將 configmap configmapName 中金鑰的所有變數名稱的字首設為 CUSTOM_，請使用值 CUSTOM_=configmapName。 如果 configmap configmapName 包含 KEY_A，則環境變數名稱為 CUSTOM_KEY_A。
• 若要新增個別金鑰的環境變數，請使用格式 NAME:KEY_A,KEY_B。 例如，若要在名為 configmapName 的 configmap 中為單一索引鍵 key1 新增環境變數，請使用值 configmapName:key1。 若要將不同的名稱指派給參照的金鑰，請使用 NAME:NEW_NAME=KEY_A 格式。 例如，若要在名為 configmapName 的 configmap 中為單一索引鍵 key1 新增名為 myKey 的環境變數，請使用值 configmapName:myKey=key1。

此值為選項。

--env-from-configmap-rm, --env-cm-rm

使用 configmap 名稱來移除完整配置對映的環境變數參照。 若要移除配置對映的個別金鑰參照，請使用 --env-rm 選項。 此值為選項。

--env-sec, --env-from-secret

使用下列其中一種方式，從儲存在密鑰中的鍵值組設定環境變數:

• 若要在名為 secretName 的密鑰中新增所有金鑰的環境變數，請使用值 secretName。 您可以在參照密鑰時指定字首來修改環境變數名稱。 若要指定字首，請使用值 PREFIX=SECRET_NAME。 每一個產生的環境變數都具有格式 <PREFIX><NAME_OF_KEY_IN_SECRET>。 例如，若要將密鑰 secretName 中金鑰的所有變數名稱的字首設為 CUSTOM_，請使用值 CUSTOM_=secretName。 如果密鑰 secretName 包含 KEY_A，則環境變數名稱為 CUSTOM_KEY_A。
• 若要新增個別金鑰的環境變數，請使用格式 NAME:KEY_A,KEY_B。 例如，若要在名為 secretName 的密鑰中為單一金鑰 key1 新增環境變數，請使用值 secretName:key1。 若要將不同的名稱指派給參照的金鑰，請使用 NAME:NEW_NAME=KEY_A 格式。 例如，若要在名為 secretName 的密鑰中為單一金鑰 key1 新增名為 myKey 的環境變數，請使用值 secretName:myKey=key1。

此值為選項。

--env-from-secret-rm, --env-sec-rm

使用密鑰名稱來移除完整密鑰的環境變數參照。 若要移除密鑰的個別金鑰參照，請使用 --env-rm 選項。 此選項可以指定多次。 此值為選項。

--env-rm

移除對 configmap 或密鑰中鍵值組之索引鍵的環境變數參照。 若要移除個別索引鍵參照及文字值，請指定索引鍵的名稱。 此選項可以指定多次。 此值為選項。

--ephemeral-storage, --es

此工作執行的暫時儲存體數量。 使用 M 表示 megabytes，使用 G 表示 gigabytes。 此值為選項。

--force, -f

請勿驗證指定的 configmap 和密鑰參照是否存在。 Configmap 參照是以 --env-from-configmap 選項指定。 密鑰參照是使用 --env-from-secret 選項來指定。 此值為選項。 預設值為 false。

--maxexecutiontime, --met

此工作執行的執行時間上限（以秒為單位）。 此選項只能在 mode 為 task 時指定。 此值為選項。 預設值為 7200。

--memory, -m

要指派給此工作執行的記憶體數量。 使用 M 表示 megabytes，使用 G 表示 gigabytes。 如需有效值，請參閱 支援的記憶體及 CPU 組合。 此值為選項。

--mode

工作執行的模式。 有效值為 task 和 daemon。 在 task 模式中，maxexecutiontime 和 retrylimit 選項適用。 在 daemon 模式中，由於沒有超時，且失敗的實體會無限期地重新啟動，因此不允許使用 maxexecutiontime 和 retrylimit 選項。 此值為選項。

--mount-configmap, --mount-cm

透過提供裝載目錄及 configmap 名稱 (格式為 MOUNT_DIRECTORY=CONFIGMAP_NAME)，將 configmap 的內容新增至此工作執行的檔案系統。 每一個裝載的 configmap 都必須使用唯一的裝載目錄。 對於 configmap 中的每一個鍵值組，會將一個檔案新增至指定的裝載目錄，其中檔名是索引鍵，檔案內容是鍵值組的值。 為每個 --mount-configmap 選項指定一個裝載配置; 例如 --mount-configmap /etc/config-a=config-a --mount-configmap /etc/config-b=config-b。 此值為選項。

--mount-data-store, --mount-ds

裝載持續資料儲存庫。 格式為 MOUNT_DIRECTORY=STORAGE_NAME [:SUBPATH]。 SUBPATH 是可選的。 此選項可以指定多次。 此值為選項。

--mount-rm

透過指定 configmap 或密鑰裝載所在的目錄，從這個工作執行的檔案系統中移除 configmap 或密鑰的內容。 為每個 --mount-rm 選項指定一個裝載目錄; 例如 --mount-rm /etc/configmap-a --mount-rm /etc/secret-b。 此值為選項。

--mount-secret, --mount-sec

透過提供裝載目錄及密鑰名稱 (格式為 MOUNT_DIRECTORY=SECRET_NAME)，將密鑰內容新增至此工作執行的檔案系統。 每一個裝載密鑰都必須使用唯一的裝載目錄。 對於密鑰中的每一個鍵值組，會將一個檔案新增至指定的裝載目錄，其中檔名是金鑰，檔案的內容是鍵值組的值。 為每個 --mount-secret 選項指定一個裝載配置; 例如 --mount-secret /etc/secret-a=secret--a --mount-secret /etc/secret-b=secret-b。 此值為選項。

-n, --name

此工作執行的名稱。 如果參照的工作沒有相關的工作配置，則需要此值。 請使用專案內唯一的名稱。

• 名稱必須以小楷字母數字開頭和結束。
• 名稱必須是 53 個字元或更少，且可以包含小寫字母、數字及連字號 (-)。

此值為選項。

--no-wait, --nw

重新提交工作執行，且不等待此工作執行的實例完成。 如果您指定 --no-wait 選項，則工作執行會開始重新提交，且不會等待。 使用 jobrun get 指令來檢查工作執行狀態。 此值為選項。 預設值為 true。

--output, -o

指定指令輸出的格式。 有效值為 json、yaml、jsonpath=JSONPATH_EXPRESSION 及 jsonpath-as-json=JSONPATH_EXPRESSION。 使用 jsonpath 來指定 JSON 輸出元素的路徑。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

--retrylimit, -r

在工作執行標示為失敗之前，重新執行此工作執行實例的次數。 當提供零以外的結束碼時，會重新執行工作執行的陣列索引。 此選項只能在 mode 為 task 時指定。 此值為選項。 預設值為 3。

--service-account, --sa

服務帳戶的名稱。 服務帳戶提供在實例中執行之程序的身分。 對於內建服務帳戶，您可以使用縮短的名稱 manager、none、reader 及 writer。 您也可以使用字首為 Kubernetes Config Context 的完整名稱，可以使用 project current 指令來判定。 此值為選項。

--service-account-clear, --sac

清除服務帳戶。 此值為選項。 預設值為 false。

--trusted-profiles-enabled, --trusted, --tpe

啟用此工作執行實例裝載計算資源記號。 此值為選項。 預設值為 false。

--wait, -w

重新提交工作執行，並等待此工作執行的實例完成。 如果您指定 --wait 選項，則工作執行重新提交會等待 --wait-timeout 選項所設定的時間上限 (以秒為單位)，讓工作執行完成。 如果工作執行未在指定的 --wait-timeout 期間內完成，則工作執行重新提交會失敗。 此值為選項。 預設值為 false。

--wait-timeout, --wto

等待此工作執行的實體完成的時間長度 (以秒為單位)。 如果指定 --wait 選項，則需要此值。 如果指定 --no-wait 選項，則會忽略此值。 預設值為 600。

範例

下列範例會重新執行實例 4-5 的 myjobrun 工作執行。 重新提交的工作執行名稱為 myjobresubmit。

ibmcloud ce jobrun resubmit --name myjobresubmit --jobrun myjobrun --array-indices 4-5

輸出範例

Getting job run 'myjobrun'...
Rerunning job run 'myjobresubmit'...
Run 'ibmcloud ce jobrun get -n myjobresubmit' to check the job run status.
OK

指令選項

--argument, --arg, -a

設定此工作執行的引數。 為每個 --argument 選項指定一個引數; 例如 -a argA -a argB。 此值為選項。

--array-indices, --ai

指定用於此工作執行的陣列索引。 指定以連字號 (-) 或逗點 (，) 區隔的索引清單或範圍; 例如 0,3,6,9 或 1-5,7-8,10。 最大值為 999999。 只有在未指定 --array-size 選項時，才能指定此選項。 此值為選項。 預設值為 0。

--array-size, --as, --instances, --is

指定用於此工作執行的實例數。 當您使用這個選項時，系統會轉換成陣列索引。 例如，如果您指定 5 的 instances，系統會轉換為 0 - 4 的 array-indices。 只有在未指定 --array-indices 選項時，才能指定此選項。 此值為選項。 預設值為 1。

--array-size-var-override, --array-size-variable-override, --asvo

指定 JOB_ARRAY_SIZE 環境變數的自訂值。 預設情況下，JOB_ARRAY_SIZE 環境變數會設定為 array-size 值或 array-indices 所指定的索引數。 JOB_ARRAY_SIZE 環境變數的值不會影響已配置的陣列大小。 使用此選項來施行工作重新執行實務範例的常數陣列大小值，其中只會提交或重新提交部分工作實例。 此值為選項。

--command, --cmd, -c

設定此工作執行的指令。 為每個 --command 選項指定一個指令; 例如 --cmd cmdA --cmd cmdB。 此值會置換儲存器映像檔內指定的預設指令。 此值為選項。

--cpu

針對此工作執行的每一個陣列索引所設定的 CPU 數量。 如需有效值，請參閱 支援的記憶體及 CPU 組合。 此值為選項。 預設值為 1。

--env, -e

設定此工作執行的環境變數。 必須為 NAME=VALUE 格式。 此動作會新增環境變數或置換現有的環境變數。 為每個 --env 選項指定一個環境變數; 例如 -e envA -e envB。 此值為選項。

--env-cm, --env-from-configmap

使用下列其中一種方式，從儲存在此 configmap 中的鍵值組設定環境變數:

• 若要為名為 configmapName 的配置對映中的所有索引鍵新增環境變數，請使用值 configmapName。 您可以在參照 configmap 時指定字首來修改環境變數名稱。 若要指定字首，請使用值 PREFIX=CONFIGMAP_NAME。 每一個產生的環境變數都具有格式 <PREFIX><NAME_OF_KEY_IN_CONFIGMAP>。 例如，若要將 configmap configmapName 中金鑰的所有變數名稱的字首設為 CUSTOM_，請使用值 CUSTOM_=configmapName。 如果 configmap configmapName 包含 KEY_A，則環境變數名稱為 CUSTOM_KEY_A。
• 若要新增個別金鑰的環境變數，請使用格式 NAME:KEY_A,KEY_B。 例如，若要在名為 configmapName 的 configmap 中為單一索引鍵 key1 新增環境變數，請使用值 configmapName:key1。 若要將不同的名稱指派給參照的金鑰，請使用 NAME:NEW_NAME=KEY_A 格式。 例如，若要在名為 configmapName 的 configmap 中為單一索引鍵 key1 新增名為 myKey 的環境變數，請使用值 configmapName:myKey=key1。

此值為選項。

--env-sec, --env-from-secret

使用下列其中一種方式，從儲存在密鑰中的鍵值組設定環境變數:

• 若要在名為 secretName 的密鑰中新增所有金鑰的環境變數，請使用值 secretName。 您可以在參照密鑰時指定字首來修改環境變數名稱。 若要指定字首，請使用值 PREFIX=SECRET_NAME。 每一個產生的環境變數都具有格式 <PREFIX><NAME_OF_KEY_IN_SECRET>。 例如，若要將密鑰 secretName 中金鑰的所有變數名稱的字首設為 CUSTOM_，請使用值 CUSTOM_=secretName。 如果密鑰 secretName 包含 KEY_A，則環境變數名稱為 CUSTOM_KEY_A。
• 若要新增個別金鑰的環境變數，請使用格式 NAME:KEY_A,KEY_B。 例如，若要在名為 secretName 的密鑰中為單一金鑰 key1 新增環境變數，請使用值 secretName:key1。 若要將不同的名稱指派給參照的金鑰，請使用 NAME:NEW_NAME=KEY_A 格式。 例如，若要在名為 secretName 的密鑰中為單一金鑰 key1 新增名為 myKey 的環境變數，請使用值 secretName:myKey=key1。

此值為選項。

--ephemeral-storage, --es

此工作執行的暫時儲存體數量。 使用 M 表示 megabytes，使用 G 表示 gigabytes。 此值為選項。 預設值為 400M。

--force, -f

請勿驗證指定的 configmap 和密鑰參照是否存在。 Configmap 參照是以 --env-from-configmap 選項指定。 密鑰參照以 --env-from-secret 或 --registry-secret 選項指定。 此值為選項。 預設值為 false。

--image, -i

用於此工作執行的映像檔名稱。 格式為 REGISTRY/NAMESPACE/REPOSITORY:TAG，其中 REGISTRY 和 TAG 為選項。 如果未指定 REGISTRY，則默認為 docker.io。 如果未指定 TAG，則默認為 latest。 如果您未指定 --job 選項，則需要 --name 和 --image 值。 此值為選項。

--job, -j

工作組態的名稱。 使用 job list 指令檢視工作配置。 如果您指定 --job 值，則可以選擇性地指定 --name 值。 如果您未指定 --job 值，則必須指定 --name 和 --image 值。 此值為選項。

--maxexecutiontime, --met

此工作執行的執行時間上限（以秒為單位）。 此選項只能在 mode 為 task 時指定。 此值為選項。 預設值為 7200。

--memory, -m

要指派給此工作執行的記憶體數量。 使用 M 表示 megabytes，使用 G 表示 gigabytes。 如需有效值，請參閱 支援的記憶體及 CPU 組合。 此值為選項。 預設值為 4G。

--mode

工作執行的模式。 有效值為 task 和 daemon。 在 task 模式中，maxexecutiontime 和 retrylimit 選項適用。 在 daemon 模式中，由於沒有超時，且失敗的實體會無限期地重新啟動，因此不允許使用 maxexecutiontime 和 retrylimit 選項。 此值為選項。 預設值為 task。

--mount-configmap, --mount-cm

透過提供裝載目錄及 configmap 名稱 (格式為 MOUNT_DIRECTORY=CONFIGMAP_NAME)，將 configmap 的內容新增至此工作執行的檔案系統。 每一個裝載的 configmap 都必須使用唯一的裝載目錄。 對於 configmap 中的每一個鍵值組，會將一個檔案新增至指定的裝載目錄，其中檔名是索引鍵，檔案內容是鍵值組的值。 為每個 --mount-configmap 選項指定一個裝載配置; 例如 --mount-configmap /etc/config-a=config-a --mount-configmap /etc/config-b=config-b。 此值為選項。

--mount-data-store, --mount-ds

裝載持續資料儲存庫。 格式為 MOUNT_DIRECTORY=STORAGE_NAME [:SUBPATH]。 SUBPATH 是可選的。 此選項可以指定多次。 此值為選項。

--mount-secret, --mount-sec

透過提供裝載目錄及密鑰名稱 (格式為 MOUNT_DIRECTORY=SECRET_NAME)，將密鑰內容新增至此工作執行的檔案系統。 每一個裝載密鑰都必須使用唯一的裝載目錄。 對於密鑰中的每一個鍵值組，會將一個檔案新增至指定的裝載目錄，其中檔名是金鑰，檔案的內容是鍵值組的值。 為每個 --mount-secret 選項指定一個裝載配置; 例如 --mount-secret /etc/secret-a=secret--a --mount-secret /etc/secret-b=secret-b。 此值為選項。

-n, --name

此工作執行的名稱。 如果您未指定 --job 值，則需要 --name 和 --image 值。 請使用專案內唯一的名稱。

• 名稱必須以小楷字母數字開頭和結束。
• 名稱必須是 53 個字元或更少，且可以包含小寫字母、數字及連字號 (-)。

此值為選項。

--no-wait, --nw

提交工作執行，且不等待此工作執行的實例完成。 如果您指定 --no-wait 選項，則工作執行提交會開始且不等待。 使用 jobrun get 指令來檢查工作執行狀態。 此值為選項。 預設值為 true。

--output, -o

指定指令輸出的格式。 有效值為 json、yaml、jsonpath=JSONPATH_EXPRESSION 及 jsonpath-as-json=JSONPATH_EXPRESSION。 使用 jsonpath 來指定 JSON 輸出元素的路徑。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

--registry-secret, --rs

登錄密鑰的名稱。 當您下載容器映像檔時，會使用登錄密鑰向專用登錄進行鑑別。 此值為選項。

--retrylimit, -r

在工作執行標示為失敗之前，重新執行此工作執行實例的次數。 當提供零以外的結束碼時，會重新執行工作執行的陣列索引。 此選項只能在 mode 為 task 時指定。 此值為選項。 預設值為 3。

--service-account, --sa

服務帳戶的名稱。 服務帳戶提供在實例中執行之程序的身分。 對於內建服務帳戶，您可以使用縮短的名稱 manager、none、reader 及 writer。 您也可以使用字首為 Kubernetes Config Context 的完整名稱，可以使用 project current 指令來判定。 此值為選項。

--trusted-profiles-enabled, --trusted, --tpe

啟用此工作執行實例裝載計算資源記號。 此值為選項。 預設值為 false。

--wait, -w

提交工作執行，並等待此工作執行的實例完成。 如果您指定 --wait 選項，則工作執行提交會等待 --wait-timeout 選項所設定的最長時間 (以秒為單位)，讓工作執行完成。 如果工作執行未在指定的 --wait-timeout 期間內完成，則工作執行提交會失敗。 此值為選項。 預設值為 false。

--wait-timeout, --wto

等待此工作執行的實體完成的時間長度 (以秒為單位)。 如果指定 --wait 選項，則需要此值。 如果指定 --no-wait 選項，則會忽略此值。 預設值為 600。

範例

ibmcloud ce jobrun submit --name myjobrun --image icr.io/codeengine/firstjob --array-indices 1-5

輸出範例

Submitting job run 'myjobrun'...
Run 'ibmcloud ce jobrun get -n myjobrun' to check the job run status.
OK

指令選項

--cos-access-secret, --cos-sec

必要。 包含存取 COS 憑證的秘密名稱。 此值為必填項目。

--cos-bucket-name, --cos-bucket

必要。 COS 桶的名稱。 此值為必填項目。

--name, -n

必要。 持久性資料儲存的名稱。 請使用專案內唯一的名稱。 此值為必填項目。

--cos-bucket-location, --cos-loc

COS 桶的位置。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

範例

ibmcloud ce persistentdatastore create --name my-pds-2 --cos-bucket-name my-test-bucket-2 --cos-access-secret my-hmac-secret-2

輸出範例

Successfully created persistent data store named 'my-pds-2'.
OK

指令選項

--name, -n

必要。 持久性資料儲存的名稱。 此值為必填項目。

--force, -f

強制刪除，而不進行確認。 此值為選項。 預設值為 false。

--ignore-not-found, --inf

如果找不到，請不要失敗。 此值為選項。 預設值為 false。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

範例

ibmcloud ce persistentdatastore delete --name my-pds-3 -f

輸出範例

Deleting persistent data store 'my-pds-3'...
OK

指令選項

--name, -n

必要。 持久性資料儲存的名稱。 此值為必填項目。

--output, -o

輸出格式。 有效值為 json、yaml、jsonpath=JSONPATH_EXPRESSION 及 jsonpath-as-json=JSONPATH_EXPRESSION。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

範例

ibmcloud ce persistentdatastore get --name my-pds-2

輸出範例

Getting persistent data store 'my-pds-2'...
OK

Name:          my-pds-2  
ID:            abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f  
Type:          object_storage  
Created:       Fri, 11 Jul 2025 13:52:30 +0200  
Age:           103s  
Project Name:  myproject  
Project ID:    01234567-abcd-abcd-abcd-abcdabcd1111  

Data:    
  COS bucket:     my-test-bucket-2  
  Access secret:  my-hmac-secret-2  
  Bucket region:  eu-de  

指令選項

--output, -o

輸出格式。 有效值為 json、yaml、jsonpath=JSONPATH_EXPRESSION 及 jsonpath-as-json=JSONPATH_EXPRESSION。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

--sort-by, -s

指定清單排序的直欄。 有效值為 name 和 age。 此值為選項。 預設值為 name。

範例

此指令會列出專案中的所有持久性資料儲存。

ibmcloud ce persistentdatastore list

輸出範例

Listing persistent data stores...
OK
Name                       COS bucket          Access secret     Bucket region  Age  
my-pds-1                   my-test-bucket-1    my-hmac-secret-1  eu-gb          36d  
my-pds-2                   my-test-bucket-2    my-hmac-secret-2  eu-de          86s  
my-pds-3                   my-test-bucket-3    my-hmac-secret-3  us-south       6m30s  

指令選項

-n, --name

專案的名稱。 請使用您所在地區的唯一名稱。 名稱必須等於或小於 128 個字元，且可以包含:

• 任何 Unicode 或英數字元。
• 僅限下列特殊字元: 空格 ()、句點 (.)、冒號 (:)、底線 (_) 及連字號 (-)。

此值為必填項目。

--endpoint, -e

專案的端點。 有效值為 public 和 private。 如果未明確指定 --endpoint 選項，則行為由系統決定。 如果 IBM Cloud CLI 已連接至 private.cloud.ibm.com，則 Code Engine 專案的行為如同 --endpoint 是 private。 如果 IBM Cloud CLI 已連接至 cloud.ibm.com，則 Code Engine 專案的行為如同 --endpoint 是 public。 此值為選項。

--no-select, --ns

在建立此專案之後，請勿選取專案作為現行環境定義。 如果您未選取此選項，則會自動選取專案。 此值為選項。 預設值為 false。

--no-wait, --nw

建立專案，且不等待建立專案。 如果您指定 no-wait 選項，專案會開始建立，且不會等待。 使用 project get 指令來檢查專案狀態。 此值為選項。 預設值為 false。

--output, -o

指定指令輸出的格式。 有效值為 json、yaml、jsonpath=JSONPATH_EXPRESSION 及 jsonpath-as-json=JSONPATH_EXPRESSION。 使用 jsonpath 來指定 JSON 輸出元素的路徑。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

--tag, -t

要指派給專案的標籤。 標籤必須是 128 個字元或更少，且可以包含字母、數字、空格 ()、句點 (.)、冒號 (:)、底線 (_) 及連字號 (-)。為每個 --tag 選項指定一個標籤; 例如 --tag tagA --tag tagB。 此值為選項。

--wait, -w

建立專案並等待建立專案。 如果您指定 --wait 選項，則專案建立會等待建立專案的時間上限 (以秒為單位，由 --wait-timeout 選項設定)。 如果未在指定的 --wait-timeout 期間內建立專案，則專案建立會失敗。 此值為選項。 預設值為 true。

--wait-timeout, --wto

等待專案建立的時間長度，以秒為單位。 如果指定 --wait 選項，則需要此值。 如果指定 --no-wait 選項，則會忽略此值。 預設值為 600。

範例

ibmcloud ce project create --name myproject  

輸出範例

Creating project 'myproject'...
OK

指令選項

--output, -o

指定指令輸出的格式。 有效值為 json、yaml、jsonpath=JSONPATH_EXPRESSION 及 jsonpath-as-json=JSONPATH_EXPRESSION。 使用 jsonpath 來指定 JSON 輸出元素的路徑。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

範例

ibmcloud ce project current  

輸出範例

Getting the current project context...
OK

Name:       myproject
ID:         01234567-abcd-abcd-abcd-abcdabcd1111
Subdomain:  aabon2dfwa0
Domain:     us-south.codeengine.appdomain.cloud
Region:     us-south
Kubectl Context:  4svg40kna19

Kubernetes Config:
Context:             aabon2dfwa0
Environment Variable: export KUBECONFIG=/user/myusername/.bluemix/plugins/code-engine/myproject-01234567-abcd-abcd-abcd-abcdabcd1111.yaml

指令選項

--force, -f

強制刪除，而不進行確認。 此值為選項。 預設值為 false。

--hard

立即刪除專案。 如果您未指定 --hard 選項，則可以使用 project restore 或 reclamation restore 指令，在 7 天內還原專案。 此值為選項。 預設值為 false。

--id, --guid

專案的 ID。 如果未指定 --name，則需要此值。

--name, -n

專案的名稱。 如果未指定 --id，則需要此值。

--no-wait, --nw

刪除專案，且不等待刪除專案。 如果您指定 no-wait 選項，則專案刪除會開始且不等待。 使用 project get 指令來檢查專案狀態。 此值為選項。 預設值為 false。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

--wait, -w

刪除專案，並等待刪除專案。 如果您指定 --wait 選項，專案刪除會等待 --wait-timeout 選項所設定的時間上限 (以秒為單位)，讓專案變成刪除。 如果在指定的 --wait-timeout 期間內未刪除專案，則專案刪除會失敗。 此值為選項。 預設值為 true。

--wait-timeout, --wto

等待專案刪除的時間長度，以秒為單位。 如果指定 --wait 選項，則需要此值。 如果指定 --no-wait 選項，則會忽略此值。 預設值為 600。

範例

ibmcloud ce project delete --name myproject -f

輸出範例

Deleting project 'myproject'...
OK

指令選項

--id, --guid

專案的 ID。 如果未指定 --name，則需要此值。

--name, -n

專案的名稱。 如果未指定 --id，則需要此值。

--output, -o

指定指令輸出的格式。 有效值為 json、yaml、jsonpath=JSONPATH_EXPRESSION 及 jsonpath-as-json=JSONPATH_EXPRESSION。 使用 jsonpath 來指定 JSON 輸出元素的路徑。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

範例

ibmcloud ce project get --name myproject

輸出範例

Getting project 'myproject'...
OK

Name:                       myproject
ID:                         abcdabcd-abcd-abcd-abcd-f1de4aab5d5d
Status:                     active
Selected:                   true
Tags:                       tag1, tag2
Region:                     us-south
Resource Group:             default
Service Binding Service ID: ServiceId-1234abcd-abcd-abcd-1111-1a2b3c4d5e6f
Age:                        52d
Created:                    Fri, 15 Jan 2021 13:32:30 -0500
Updated:                    Fri, 15 Jan 2021 13:32:45 -0500

Quotas:
    Category                                  Used      Limit
    App revisions                             1         100
    Apps                                      1         100
    Build runs                                0         100
    Builds                                    0         100
    Configmaps                                2         100
    CPU                                       1.025     64
    Ephemeral storage                         902625Ki  256G
    Instances (active)                        1         250
    Instances (total)                         2         2500
    Job runs                                  1         100
    Jobs                                      1         100
    Memory                                    4400M     256G
    Secrets                                   5         100
    Subscriptions (cron)                      0         100
    Subscriptions (IBM Cloud Object Storage)  0         100

指令選項

--all-resource-groups, --all

顯示所有資源群組中的專案。 依預設，只會從現行資源群組顯示專案。 此值為選項。 預設值為 false。

--output, -o

指定指令輸出的格式。 有效值為 json、yaml、jsonpath=JSONPATH_EXPRESSION 及 jsonpath-as-json=JSONPATH_EXPRESSION。 使用 jsonpath 來指定 JSON 輸出元素的路徑。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

--regions, -r

將專案的顯示限制為指定的區域。 提供一或多個區域的名稱; 例如 us-south,eu-de。 此值為選項。

--sort-by, -s

指定清單排序的直欄。 有效值為 name 和 age。 此值為選項。 預設值為 name。

範例

ibmcloud ce project list

輸出範例

Getting projects...
OK

Name             ID                                    Status  Selected  Tags  Region    Resource Group  Age
myproj-eude      09768af4-abcd-abcd-abcd-24674ba90db0  active  false           eu-de     default         27d
myproject        cd09cfe1-abcd-abcd-abcd-0f8a8a1d0ddf  active  true            us-south  default         52d

指令選項

--id, --guid

專案的 ID。 如果未指定 --name，則需要此值。

--name, -n

專案的名稱。 如果未指定 --id，則需要此值。

--no-wait, --nw

還原專案，且不等待還原專案。 如果您指定 no-wait 選項，則專案還原會開始且不等待。 使用 project get 指令來檢查專案狀態。 此值為選項。 預設值為 false。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

--wait, -w

還原專案並等待還原專案。 如果您指定 --wait 選項，專案還原會等待 --wait-timeout 選項所設定的時間上限 (以秒為單位)，讓專案還原。 如果在指定的 --wait-timeout 期間內未還原專案，則專案還原會失敗。 此值為選項。 預設值為 true。

--wait-timeout, --wto

等待專案還原的時間長度，以秒為單位。 如果指定 --wait 選項，則需要此值。 如果指定 --no-wait 選項，則會忽略此值。 預設值為 600。

範例

此範例會將處於 soft deleted 狀態的 myproject 專案還原為作用中狀態。 使用 project list 指令來顯示所有專案及其狀態的清單。

ibmcloud ce project restore --name myproject

輸出範例

Restoring project 'myproject'...
OK

指令選項

--endpoint, -e

專案的端點。 有效值為 public 和 private。 如果未明確指定 --endpoint 選項，則行為由系統決定。 如果 IBM Cloud CLI 已連接至 private.cloud.ibm.com，則 Code Engine 專案的行為如同 --endpoint 是 private。 如果 IBM Cloud CLI 已連接至 cloud.ibm.com，則 Code Engine 專案的行為如同 --endpoint 是 public。 此值為選項。

--id, --guid

專案的 ID。 如果未指定 --name，則需要此值。

--kubecfg, -k

將專案附加至 Kubernetes 配置檔。 您可以透過設定 KUBECONFIG 環境變數來覆寫預設的 Kubernetes 配置檔案。 此值為選項。 預設值為 false。

--name, -n

專案的名稱。 如果未指定 --id，則需要此值。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

範例

ibmcloud ce project select --name myproject

輸出範例

Selecting project 'myproject'...
OK

指令選項

--id, --guid

專案的 ID。 如果未指定 --name，則需要此值。

--name, -n

專案的名稱。 如果未指定 --id，則需要此值。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

--tag, -t

要指派給專案的標籤。 標籤必須是 128 個字元或更少，且可以包含字母、數字、空格 ()、句點 (.)、冒號 (:)、底線 (_) 及連字號 (-)。為每個 --tag 選項指定一個標籤; 例如 --tag tagA --tag tagB。 此值為選項。

--tag-rm, --trm

移除指派給專案的標籤。 為每個 --tag-rm 選項指定一個標籤; 例如 --tag-rm tagA --tag-rm tagB。 此值為選項。

範例

ibmcloud ce project tag --name myproject --tag tag1 --tag tag2

輸出範例

Getting project 'myproject'...
OK

指令選項

--binding-resource-group, --brg

用於驗證本專案服務綁定的資源群組的名稱。 會為此資源群組中的所有服務建立一個服務 ID，其中包含 Operator 和 Manager 角色。 使用 "*" 來指定此帳戶中的所有資源群組。 此值為選項。

--binding-resource-group-id, --brgid

用於鑑別此專案之服務連結的資源群組 ID。 會為此資源群組中的所有服務建立一個服務 ID，其中包含 Operator 和 Manager 角色。 此值為選項。

--binding-service-id, --bsid

服務 ID 的 ID，用於此專案服務綁定的驗證。 此服務 ID 必須具有 Operator 角色，以及一或多個服務實例、服務類型或資源群組的適當服務角色。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

範例

ibmcloud ce project update --binding-service-id ServiceId-1234abcd-abcd-abcd-1111-1a2b3c4d5e6f

輸出範例

Configuring your project for service bindings...
Creating service binding API key 'my-project-api-key' for service ID 'my-custom-service-id'...
OK

指令選項

--force, -f

強制刪除，而不進行確認。 此值為選項。 預設值為 false。

--id, --guid

專案的 ID。 如果未指定 --name，則需要此值。

--name, -n

專案的名稱。 如果未指定 --id，則需要此值。

--no-wait, --nw

刪除專案收回，且不等待刪除專案收回。 如果您指定 no-wait 選項，則專案收回刪除會開始且不等待。 使用 reclamation get 指令來檢查專案收回狀態。 此值為選項。 預設值為 false。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

--wait, -w

刪除專案收回，並等待刪除專案收回。 如果您指定 --wait 選項，專案收回刪除會等待 --wait-timeout 選項所設定的最長時間 (以秒為單位)，以便刪除專案收回。 如果未在指定的 --wait-timeout 期間內刪除專案收回，則專案收回刪除會失敗。 此值為選項。 預設值為 true。

--wait-timeout, --wto

等待專案回收刪除的時間長度，以秒為單位。 如果指定 --wait 選項，則需要此值。 如果指定 --no-wait 選項，則會忽略此值。 預設值為 600。

範例

這個範例會永久刪除處於 soft deleted 狀態的 myproject 專案。 在這個指令中使用 --force 選項，會強制刪除而不確認。 您可以使用 reclamation list 指令來顯示處於 soft deleted 狀態的所有專案清單。

ibmcloud ce reclamation delete --name myproject --f

輸出範例

Hard deleting project 'myproject'...
OK

指令選項

--id, --guid

專案的 ID。 如果未指定 --name，則需要此值。

--name, -n

專案的名稱。 如果未指定 --id，則需要此值。

--output, -o

指定指令輸出的格式。 有效值為 json、yaml、jsonpath=JSONPATH_EXPRESSION 及 jsonpath-as-json=JSONPATH_EXPRESSION。 使用 jsonpath 來指定 JSON 輸出元素的路徑。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

範例

ibmcloud ce reclamation get --name myproject

輸出範例

Getting project reclamation
OK

Name:                   myproject
Reclamation ID:         abcdabcd-abcd-abcd-abcd-f1de4aab5d5d
Status:                 soft deleted
Region:                 us-south
Resource Group:         default
Age:                    27m
Created:                Thu, 09 Sep 2021 13:24:15 -0400
Updated:                Thu, 09 Sep 2021 13:33:45 -0400
Time to Hard Deletion:  6d23h

指令選項

--all-resource-groups, --all

顯示所有資源群組中的專案收回。 依預設，只會從現行資源群組顯示專案收回。 此值為選項。 預設值為 false。

--output, -o

指定指令輸出的格式。 有效值為 json、yaml、jsonpath=JSONPATH_EXPRESSION 及 jsonpath-as-json=JSONPATH_EXPRESSION。 使用 jsonpath 來指定 JSON 輸出元素的路徑。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

--regions, -r

將專案收回的顯示限制為指定的區域。 提供一或多個區域的名稱; 例如 us-south,eu-de。 此值為選項。

--sort-by, -s

指定清單排序的直欄。 有效值為 name 和 age。 此值為選項。 預設值為 name。

範例

ibmcloud ce reclamation list

輸出範例

Getting project reclamations...
OK
Name          ID                                    Reclamation ID                        Status        Region    Resource Group  Age   Time to Hard Deletion
myproject     def218c5-abcd-abcd-abcd-97854c288d76  48e3d7a2-abcd-abcd-abcd-99db7152b8fe  soft deleted  us-south  default         40h   6d23h
myproject2    01f0bc66-abcd-abcd-abcd-3ef7e99f6f69  af2cd017-abcd-abcd-abcd-d32e2bb79136  soft deleted  jp-osa    default         8m58s 2d11h

指令選項

--id, --guid

專案的 ID。 如果未指定 --name，則需要此值。

--name, -n

專案的名稱。 如果未指定 --id，則需要此值。

--no-wait, --nw

還原專案收回，且不等待專案收回還原。 如果您指定 no-wait 選項，則專案收回還原會開始且不等待。 使用 reclamation get 指令來檢查專案收回狀態。 此值為選項。 預設值為 false。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

--wait, -w

還原專案收回，並等待還原專案收回。 如果您指定 --wait 選項，專案收回還原會等待 --wait-timeout 選項所設定的時間上限 (以秒為單位)，讓專案收回還原。 如果在指定的 --wait-timeout 期間內未還原專案收回，則專案收回還原會失敗。 此值為選項。 預設值為 true。

--wait-timeout, --wto

等待專案復原的時間長度，以秒為單位。 如果指定 --wait 選項，則需要此值。 如果指定 --no-wait 選項，則會忽略此值。 預設值為 600。

範例

此範例會將處於 soft deleted 狀態的 myproject 專案還原為作用中狀態。 使用 reclamation list 指令來顯示處於 soft deleted 狀態的所有專案清單。

ibmcloud ce reclamation restore --name myproject

輸出範例

Restoring project 'myproject'...
OK

指令選項

-n, --name

影像登錄存取秘訣的名稱。 請使用專案內唯一的名稱。

• 名稱必須以小楷字母數字開頭和結束。
• 名稱必須為 253 個字元或更少，且可以包含小寫字母、數字、句點 (.) 及連字號 (-)。

此值為必填項目。

--email, -e

存取登錄伺服器的電子郵件地址。 此值為選項。

--output, -o

指定指令輸出的格式。 有效值為 json、yaml、jsonpath=JSONPATH_EXPRESSION 及 jsonpath-as-json=JSONPATH_EXPRESSION。 使用 jsonpath 來指定 JSON 輸出元素的路徑。 此值為選項。

--password, -p

存取登錄伺服器的密碼。 如果既沒有指定 --password，也沒有指定 --password-from-file，也沒有指定 --password-from-json-file 選項，則會提示您輸入密碼。 此值為選項。

--password-from-file, --pf

包含用來存取登錄伺服器之密碼的檔案路徑。 檔案的第一行用於密碼。 如果既沒有指定 --password，也沒有指定 --password-from-file，也沒有指定 --password-from-json-file 選項，則會提示您輸入密碼。 此值為選項。

--password-from-json-file, --pfj

JSON 檔案的路徑，該檔案包含用於存取登錄伺服器的密碼。 apikey 欄位用於輸入密碼。 如果既沒有指定 --password，也沒有指定 --password-from-file，也沒有指定 --password-from-json-file 選項，則會提示您輸入密碼。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

--server, -s

登錄伺服器的 URL。 此值為選項。 預設值為 us.icr.io。

--username, -u

用來存取登錄伺服器的使用者名稱。 此值為選項。 預設值為 iamapikey。

範例

下列範例會建立名為 myregistry 的映像檔登錄存取權，該映像檔登錄存取權針對位於 us.icr.io 且使用使用者名稱 iamapikey 及 IAM API 金鑰作為密碼的 Container Registry 實例。

ibmcloud ce registry create --name myregistry --server us.icr.io --username iamapikey --password API_KEY   

輸出範例

Creating image registry access secret myregistry...

OK

指令選項

--name, -n

影像登錄存取秘訣的名稱。 此值為必填項目。

--force, -f

強制刪除，而不進行確認。 此值為選項。 預設值為 false。

--ignore-not-found, --inf

如果找不到，請不要失敗。 此值為選項。 預設值為 false。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

範例

ibmcloud ce registry delete --name myregistry -f   

輸出範例

Deleting image registry access secret myregistry...

OK

指令選項

--name, -n

影像登錄存取秘訣的名稱。 此值為必填項目。

--decode, -d

在詳細資料中顯示已解碼的 Data 輸出。 如果未指定此選項，則 Data 詳細資料為 base64-encoded。 此值為選項。 預設值為 false。

--output, -o

指定指令輸出的格式。 有效值為 json、yaml、jsonpath=JSONPATH_EXPRESSION 及 jsonpath-as-json=JSONPATH_EXPRESSION。 使用 jsonpath 來指定 JSON 輸出元素的路徑。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

範例

ibmcloud ce registry get --name myregistry   

輸出範例

Getting image registry access secret myregistry...
OK

Name:        myregistry
Project:     myproject
Project ID:  01234567-abcd-abcd-abcd-abcdabcd1111
Created:     2021-02-23T09:10:01-05:00
Data:
---
.dockerconfigjson: abcdabcdabcdabcdabcdnVzZXJuYW1lIjoiaWFtYXBpa2V5IiwicGFzc3dvcmQiOiJoQllTSTc5Uk8yQUIxSDV3RUs2UzhScV9uNzE4NkQ1eWt1M1FOUk85aFpfaCIsImVtYWlsIjoiYUBiLmMiLCabcdabcdabcdabcdabcdT21oQ1dWTkpOemxTVHpKQlFqRklOWGRGU3paVE9GSnhYMjQzTVRnMlJEVjabcdabcdabcdabcdabcdbG9XbDlvIn19fQ==

指令選項

--output, -o

指定指令輸出的格式。 有效值為 json、yaml、jsonpath=JSONPATH_EXPRESSION 及 jsonpath-as-json=JSONPATH_EXPRESSION。 使用 jsonpath 來指定 JSON 輸出元素的路徑。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

--sort-by, -s

指定清單排序的直欄。 有效值為 name 和 age。 此值為選項。 預設值為 name。

範例

ibmcloud ce registry list   

輸出範例

Listing image registry access secrets...

OK

Name        Age
myregistry  19m22s

指令選項

--name, -n

影像登錄存取秘訣的名稱。 此值為必填項目。

--email, -e

存取登錄伺服器的電子郵件地址。 此值為選項。

--output, -o

指定指令輸出的格式。 有效值為 json、yaml、jsonpath=JSONPATH_EXPRESSION 及 jsonpath-as-json=JSONPATH_EXPRESSION。 使用 jsonpath 來指定 JSON 輸出元素的路徑。 此值為選項。

--password, -p

存取登錄伺服器的密碼。 此值為選項。

--password-from-file, --pf

包含用來存取登錄伺服器之密碼的檔案路徑。 檔案的第一行用於密碼。 此值為選項。

--password-from-json-file, --pfj

JSON 檔案的路徑，該檔案包含用於存取登錄伺服器的密碼。 apikey 欄位用於輸入密碼。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

--server, -s

登錄伺服器的 URL。 此值為選項。

--username, -u

用來存取登錄伺服器的使用者名稱。 此值為選項。

範例

下列範例會更新稱為 myregistry 之映像檔登錄存取權的密碼。

ibmcloud ce registry update --name myregistry --password NEW_API_KEY  

輸出範例

Getting image registry access secret 'myregistry'...
Updating image registry access secret 'myregistry'...

OK

指令選項

--host, --ho

主機的位址; 例如 github.com。 此值為必填項目。

--key-path, --kp

未加密 SSH 私密金鑰檔的路徑。 如果您使用個人私人 SSH 金鑰，則此檔案通常位於 $HOME/.ssh/id_rsa ( Mac OS 或 Linux ) 或 %HOMEPATH%\.ssh\id_rsa (Windows)。 此值為必填項目。

-n, --name

Git 儲存庫存取秘密的名稱。 請使用專案內唯一的名稱。

• 名稱必須以小楷字母數字開頭和結束。
• 名稱必須為 253 個字元或更少，且可以包含小寫字母、數字、句點 (.) 及連字號 (-)。

此值為必填項目。

--known-hosts-path, --khp

已知 hosts 檔的路徑。 此值是安全特性，可確保私密金鑰僅用於在您先前存取的主機 (特別是 GitHub 或 GitLab 主機) 進行鑑別。 此檔案通常位於 $HOME/.ssh/known_hosts ( Mac OS 或 Linux ) 或 %HOMEPATH%\.ssh\known_hosts (Windows)。 此值為選項。

--output, -o

指定指令輸出的格式。 有效值為 json、yaml、jsonpath=JSONPATH_EXPRESSION 及 jsonpath-as-json=JSONPATH_EXPRESSION。 使用 jsonpath 來指定 JSON 輸出元素的路徑。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

範例

下列指令會為主機 github.com 建立稱為 github 的 Git 存取密鑰，並使用位於 /<filepath>/.ssh/id_rsa 的 SSH 金鑰進行鑑別，其中 <filepath> 是系統上的路徑。

ibmcloud ce repo create -n github --key-path /<filepath>/.ssh/id_rsa --host github.com  

輸出範例

Creating Git access secret github...
OK

指令選項

--name, -n

Git 儲存庫存取秘密的名稱。 此值為必填項目。

--force, -f

強制刪除，而不進行確認。 此值為選項。 預設值為 false。

--ignore-not-found, --inf

如果找不到，請不要失敗。 此值為選項。 預設值為 false。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

範例

ibmcloud ce repo delete --name github

輸出範例

Are you sure you want to delete the Git access secret github? [y/N]> y
Deleting Git access secret github...
OK

指令選項

--name, -n

Git 儲存庫存取秘密的名稱。 此值為必填項目。

--decode, -d

在詳細資料中顯示已解碼的 Data 輸出。 如果未指定此選項，則 Data 詳細資料為 base64-encoded。 此值為選項。 預設值為 false。

--output, -o

指定指令輸出的格式。 有效值為 json、yaml、jsonpath=JSONPATH_EXPRESSION 及 jsonpath-as-json=JSONPATH_EXPRESSION。 使用 jsonpath 來指定 JSON 輸出元素的路徑。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

範例

ibmcloud ce repo get -n github

輸出範例

Getting Git access secret github...
OK

Name:        github  
Project:     myproject  
Project ID:  01234567-abcd-abcd-abcd-abcdabcd1111
Age:         30s  
Created:     2021-03-14T14:05:56-05:00  
Host:        github.com

Data:          
---
ssh-privatekey:
ABCDABCDABCDABCDABCDU1NIIFBSSVZBVEUgS0VZLS0tLS0KYjABCDABCDABCDABCDhrdGRqRUFBQUFBQ21GbGN6STFOaABCDABCDABCDABCDABCDABCDE
...

指令選項

--output, -o

指定指令輸出的格式。 有效值為 json、yaml、jsonpath=JSONPATH_EXPRESSION 及 jsonpath-as-json=JSONPATH_EXPRESSION。 使用 jsonpath 來指定 JSON 輸出元素的路徑。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

--sort-by, -s

指定清單排序的直欄。 有效值為 name 和 age。 此值為選項。 預設值為 name。

範例

ibmcloud ce repo list

輸出範例

Listing Git access secrets...
OK

Name    Age  
github  13m0s  

指令選項

--name, -n

Git 儲存庫存取秘密的名稱。 此值為必填項目。

--host, --ho

主機的位址; 例如 github.com。 此值為選項。

--key-path, --kp

未加密 SSH 私密金鑰檔的路徑。 如果您使用個人私人 SSH 金鑰，則此檔案通常位於 $HOME/.ssh/id_rsa ( Mac OS 或 Linux ) 或 %HOMEPATH%\.ssh\id_rsa (Windows)。 此值為選項。

--known-hosts-path, --khp

已知 hosts 檔的路徑。 此值是安全特性，可確保私密金鑰僅用於在您先前存取的主機 (特別是 GitHub 或 GitLab 主機) 進行鑑別。 此檔案通常位於 $HOME/.ssh/known_hosts ( Mac OS 或 Linux ) 或 %HOMEPATH%\.ssh\known_hosts (Windows)。 此值為選項。

--output, -o

指定指令輸出的格式。 有效值為 json、yaml、jsonpath=JSONPATH_EXPRESSION 及 jsonpath-as-json=JSONPATH_EXPRESSION。 使用 jsonpath 來指定 JSON 輸出元素的路徑。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

範例

下列指令會更新稱為 github 的 Git 存取密鑰，以使用新的主機。

ibmcloud ce repo update  -n github --host NEW_HOST  

輸出範例

Getting Git access secret 'github'...
Updating Git access secret 'github'...
OK

指令選項

--name, -n

應用程式修訂的名稱。 此值為必填項目。

--force, -f

強制刪除，而不進行確認。 此值為選項。 預設值為 false。

--ignore-not-found, --inf

如果找不到，請不要失敗。 此值為選項。 預設值為 false。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

範例

ibmcloud ce revision delete -n newapp-mytest-00004 -f

輸出範例

Deleting application revision 'newapp-mytest-00004'...
OK

指令選項

--instance, -i

特定應用程式實例的名稱。 使用 rev get 指令來尋找實例名稱。 如果未指定 --revision，則需要此值。

--output, -o

指定指令輸出的格式。 有效值為 json、yaml、jsonpath=JSONPATH_EXPRESSION 及 jsonpath-as-json=JSONPATH_EXPRESSION。 使用 jsonpath 來指定 JSON 輸出元素的路徑。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

--revision, --rev, -r, --name, -n

顯示所指定應用程式修訂之所有實例的事件。 如果未指定 --instance，則需要此值。

範例

ibmcloud ce revision events -n myapp-00001

輸出範例

除了作用中應用程式修訂之外，Code Engine 僅保留應用程式的最新非作用中修訂。 不會保留較舊的修訂。

Getting application revision 'newapp-mytest-00002'...
Getting events for all instances of application revision 'newapp-mytest-00002'...
OK

newapp-mytest-00002-deployment-7c87cfbf66-xnwkp:
Type     Reason     Age                Source                Messages
Normal   Scheduled  65s                default-scheduler     Successfully assigned bz8i2yh012p/newapp-mytest-00002-deployment-7c87cfbf66-xnwkp to 10.243.0.60
Normal   Pulling    63s                kubelet, 10.243.0.60  Pulling image "icr.io/codeengine/codeengine@sha256:b3150372958ab68eea5356a8cab31069ca5293c45959d64f6aaabbccddeeff123"
Normal   Created    60s                kubelet, 10.243.0.60  Created container queue-proxy
Normal   Created    60s                kubelet, 10.243.0.60  Created container user-container
Normal   Started    60s                kubelet, 10.243.0.60  Started container user-container
Normal   Pulled     60s                kubelet, 10.243.0.60  Container image "icr.io/obs/codeengine/knative-serving/knative.dev/serving/cmd/queue:v0.20.0-rc11@sha256:3fedfa9d9cdd74e85d11d4167043f13902074946caf415d16ff537620f04931a" already present on machine
Normal   Pulled     60s                kubelet, 10.243.0.60  Successfully pulled image "icr.io/codeengine/codeengine@sha256:b3150372958ab68eea5356a8cab31069ca5293c45959d64f6aaabbccddeeff123" in 2.67237432s
Normal   Started    60s                kubelet, 10.243.0.60  Started container queue-proxy
Normal   Pulling    60s                kubelet, 10.243.0.60  Pulling image "icr.io/obs/codeengine/istio/proxyv2:1.9.1-rc7"
Normal   Pulled     59s                kubelet, 10.243.0.60  Successfully pulled image "icr.io/obs/codeengine/istio/proxyv2:1.9.1-rc7" in 666.211288ms
Normal   Created    59s                kubelet, 10.243.0.60  Created container istio-proxy
Normal   Started    59s                kubelet, 10.243.0.60  Started container istio-proxy

指令選項

--name, -n

應用程式修訂的名稱。 此值為必填項目。

--output, -o

指定指令輸出的格式。 有效值為 json、yaml、jsonpath=JSONPATH_EXPRESSION 及 jsonpath-as-json=JSONPATH_EXPRESSION。 使用 jsonpath 來指定 JSON 輸出元素的路徑。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

範例

ibmcloud ce revision get --name newapp-mytest-00002

輸出範例

Getting application revision 'newapp-mytest-00002'...
Getting application 'newapp-mytest'...
OK

Name:            newapp-mytest-00002
ID:              abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f
Project Name:    myproject
Project ID:      01234567-abcd-abcd-abcd-abcdabcd1111
Age:             27d
Created:         2021-05-05T11:50:00-04:00
Status Summary:  Revision is ready

Environment Variables:
    Type                      Name               Value
    ConfigMap full reference  mycolorconfigmap
    Literal                   TARGET             Sunshine
Image:                  icr.io/codeengine/codeengine
Resource Allocation:
    CPU:                1
    Ephemeral Storage:  400M
    Memory:             4G
Port:                   8080

Runtime:
    Concurrency:    100
    Maximum Scale:  10
    Minimum Scale:  0
    Timeout:        300

Conditions:
    Type                OK     Age    Reason
    Active              false  5d22h  NoTraffic : The target is not receiving traffic.
    ContainerHealthy    true   5d22h
    Ready               true   5d22h
    ResourcesAvailable  true   5d22h

指令選項

--application, --app, -a

使用此選項僅顯示來自指定應用程式的修訂。 此值為選項。

--output, -o

指定指令輸出的格式。 有效值為 json、yaml、jsonpath=JSONPATH_EXPRESSION 及 jsonpath-as-json=JSONPATH_EXPRESSION。 使用 jsonpath 來指定 JSON 輸出元素的路徑。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

--sort-by, -s

指定清單排序的直欄。 有效值為 name 和 age。 此值為選項。 預設值為 name。

範例

ibmcloud ce revision list

輸出範例

除了作用中應用程式修訂之外，Code Engine 僅保留應用程式的最新非作用中修訂。 不會保留較舊的修訂。

Listing all application revisions...
OK

Name                   Application      Status  URL  Latest  Tag  Traffic  Age    Conditions  Reason
myapp-hc3u8-2           myapp            Ready                              16d    3 OK / 4
myapp-hc3u8-3           myapp            Ready        true         100%    2d8h    3 OK / 4  
newapp-mytest-00004     newapp-mytest    Ready                              4d20h  3 OK / 4
newapp-mytest-00005     newapp-mytest    Ready        true         100%     2d20h  3 OK / 4

指令選項

--all-containers, --all

顯示所指定應用程式修訂實例之所有儲存器的日誌。 此值為選項。 預設值為 false。

--follow, -f

遵循應用程式修訂實例的日誌。 使用此選項來串流應用程式修訂實例的日誌。 如果您指定 --follow 選項，則必須輸入 Ctrl+C 以終止此日誌指令。 此值為選項。 預設值為 false。

--instance, -i

特定應用程式修訂實例的名稱。 使用 revision get 指令來尋找實例名稱。 如果未指定 --revision，則需要此值。

--output, -o

指定指令輸出的格式。 有效值為 json、yaml、jsonpath=JSONPATH_EXPRESSION 及 jsonpath-as-json=JSONPATH_EXPRESSION。 使用 jsonpath 來指定 JSON 輸出元素的路徑。 此值為選項。

--quiet, -q

指定此選項以減少指令的輸出。 此值為選項。 預設值為 false。

--revision, --rev, -r, --name, -n

顯示所指定應用程式修訂之所有實例的日誌。 如果未指定 --instance，則需要此值。

--tail, -t

將所指定應用程式修訂實例的容器日誌顯示限制為每個容器的最近行數上限。 例如，若要顯示所指定應用程式修訂實例之儲存器日誌的最後 3 行，請指定 --tail 3。 如果未指定此選項，則會顯示所指定應用程式修訂實例之儲存器的所有日誌行。 此值為選項。 預設值為 -1。

--timestamps, --ts

在日誌輸出的每一行包含時間戳記。 此值為選項。 預設值為 false。

範例

ibmcloud ce revision logs -n myapp-00001

輸出範例

除了作用中應用程式修訂之外，Code Engine 僅保留應用程式的最新非作用中修訂。 不會保留較舊的修訂。

Getting logs for all instances of application revision 'newapp-mytest-00002'...
Getting application revision 'newapp-mytest-00002'...
OK

newapp-mytest-00002-deployment-7c87cfbf66-xnwkp/user-container:
2021-07-15 20:40:56 Listening on port 8080

指令選項

--access-key-id, --akid

指定 HMAC 認證的 access_key_id。 此值為選項。

--access-key-id-prompt

提示輸入 HMAC 認證的 access_key_id。 此值為選項。 預設值為 false。

--cert-chain-file, --ccf

指定一個檔案，其中包含由您的憑證授權機構提供的 TLS 秘 密的憑證鏈。 您必須提供檔案的路徑作為值。 tls 密鑰需要此值。 此值為選項。

--email, --em

用來存取登錄密碼之登錄伺服器的電子郵件位址。 此值僅適用於 registry 密鑰。 此值為選項。

--format, --fo

密鑰的格式。 有效值為 basic_auth, generic, hmac, registry, ssh，或 tls。 此值為選項。 預設值為 generic。

--from-env-file, -e

從包含一或多行符合 KEY=VALUE 格式的檔案建立一般密鑰。 您必須提供檔案的路徑作為值。 指定檔案中的每一行都會新增為鍵值組。 指定檔案中任何空白或以 # 開頭的行都會被忽略。 如果未指定 --from-literal 或 --from-file，則需要此值。 此選項可以指定多次。 此值僅適用於 generic 密鑰。

--from-file, -f

從檔案建立一般密鑰。 您必須提供檔案的路徑作為值。 如果未指定 --from-literal 或 --from-env-file，則需要此值。 此選項可以指定多次。 此值僅適用於 generic 密鑰。

--from-json-file, --json

包含密鑰值（JSON 格式）的檔案路徑。 密文格式支援此選項 hmac 此值為選項。

--from-literal, -l

從鍵值組建立一般密鑰。 必須為 KEY=VALUE 格式。 如果未指定 --from-file 或 --from-env-file，則需要此值。 此選項可以指定多次。 此值僅適用於 generic 密鑰。

--key-path, --kp

SSH 密鑰之未加密 SSH 私密金鑰檔的路徑。 如果您使用個人私人 SSH 金鑰，則此檔案通常位於 $HOME/.ssh/id_rsa ( Mac OS 或 Linux ) 或 %HOMEPATH%\.ssh\id_rsa (Windows)。 ssh 密鑰需要此值。 此值為選項。

--known-hosts-path, --khp

SSH 密鑰之已知 hosts 檔的路徑。 此值是安全特性，可確保私密金鑰僅用於在您先前存取的主機 (特別是 GitHub 或 GitLab 主機) 進行鑑別。 此檔案通常位於 $HOME/.ssh/known_hosts ( Mac OS 或 Linux ) 或 %HOMEPATH%\.ssh\known_hosts (Windows)。 此值僅適用於 ssh 密鑰。 此值為選項。

-n, --name

密碼的名稱。 請使用專案內唯一的名稱。