指令選項

--default

取得現行帳戶的預設群組。

範例

列出目前設為目標的帳戶下的所有資源群組：

ibmcloud resource groups

列出目前目標帳戶的預設群組：

ibmcloud resource groups --default

指令選項

NAME（必要）

資源群組的名稱

--id

僅顯示 ID

範例

顯示資源群組 example-group：

ibmcloud resource group example-group

僅顯示資源群組 example-group 的 ID：

ibmcloud resource group example-group --id

指令選項

NAME（必要）

資源群組的名稱

範例

建立資源群組 example-group：

ibmcloud resource group-create example-group

指令選項

NAME（必要）

目標資源群組的名稱

-n, --name

資源群組的新名稱

-f, --force

強制更新，而不進行確認

範例

將資源群組 example-group 重新命名為 trial-group：

ibmcloud resource group-update example-group -n trial-group

指令選項

NAME（必要）

目標資源群組的名稱

-f, --force

強制刪除，而不進行確認

範例

刪除資源群組 example-group：

ibmcloud resource group-delete example-group -f

範例

列出所有配額定義：

ibmcloud resource quotas

指令選項

NAME（必要）

配額名稱

範例

顯示配額 free 的詳細資料：

ibmcloud resource quota free

指令選項

--service-name 服務名稱

屬於服務的名稱

--location 地點

依位置過濾

--type INSTANCE_TYPE

實例類型。 如果未指定，則會使用 service_instance 類型。 使用 all 來列出所有類型的實例。

-g 資源組織

資源群組名稱

--all-resource-groups

查詢所有資源群組

--long

在輸出中顯示更多欄位

--limit 限制

返回的資源數量

--offset 偏移

開始的資源位置號碼

--output FORMAT

指定輸出格式。 現在只支援 JSON。

-q, --quiet

暫停詳細輸出。

範例

列出服務 test-service 的服務實例：

ibmcloud resource service-instances --service-name test-service

列出下一頁的服務實例，每頁有 10 個記錄。

ibmcloud resource service-instances --offset 1 --limit 10

指令選項

NAME（必要），與 ID 不能同時使用

服務實例的名稱

ID（必要），與 NAME 不能同時使用

服務實例的 ID

--location

依位置過濾

--id

顯示服務實例的 ID

範例

顯示服務實例 my-service-instance 的詳細資料：

ibmcloud resource service-instance my-service-instance

指令選項

NAME（必要）

服務實例的名稱

SERVICE_NAME 或 SERVICE_ID（必要）

服務的名稱或 ID。 若要列出服務供應項目，請使用 ibmcloud catalog service-marketplace 指令。

SERVICE_PLAN_NAME 或 SERVICE_PLAN_ID（必要）

服務方案的名稱或 ID

LOCATION（必要）

用於建立服務實例的目標位置或環境

-d, --deployment 部署名稱

部署的名稱

-p, --parameters @JSONFILE 或 JSON_STRING

要建立服務實例之參數的 JSON 檔案或 JSON 字串

-g 資源組織

資源群組名稱

--service-endpoints 服務端點類型

服務定義允許的服務端點類型。 典型值為「公共」、「私人」、「公共與私人」。 服務端點的預設值是由服務在IBM Cloud®中配置的型別。

--allow-cleanup

在處理地區刪除呼叫期間，是否應該刪除（清除）服務實例

--lock

是否以鎖定狀態建立服務實例

--subscription

與此服務和計劃關聯的訂閱 ID

範例

建立一個服務實例，命名為 my-service-instance，使用位置 eu-gb 上 test-service 服務的服務計劃 test-service-plan：

ibmcloud resource service-instance-create my-service-instance test-service test-service-plan eu-gb

指令選項

名稱（必要）

服務實例的名稱，與 ID 不能同時使用

ID（必要）

服務實例的 ID，與 NAME 不能同時使用

-n, --name NEW_NAME

新服務實例名稱

--service-plan-id 服務計劃

新的服務方案 ID

-p, --parameters @json_file | json_string

要建立服務實例之參數的 JSON 檔案或 JSON 字串

-g 資源組織

資源群組名稱

--service-endpoints 服務端點類型

服務端點的類型。 可能的值為 'public'、'private'、'public-and-private'。

-f, --force

強制更新，而不進行確認

範例

更新服務實例 my-service-instance，並將其名稱變更為 new-service-instance：

ibmcloud resource service-instance-update my-service-instance -n new-service-instance

指令選項

名稱（必要）

服務實例的名稱，與 ID 不能同時使用

ID（必要）

服務實例的 ID，與 NAME 不能同時使用

-f, --force

強制刪除，而不進行確認

--recursive

刪除所有隸屬資源

範例

刪除資源服務實例 my-service-instance：

ibmcloud resource service-instance-delete my-service-instance

指令選項

名稱（必要）

服務實例的名稱，與 ID 不能同時使用

ID（必要）

服務實例的 ID，與 NAME 不能同時使用

-g 資源組織

資源群組名稱

-f, --force

強制鎖定而不確認

範例

鎖定資源服務實體 my-service-instance：

ibmcloud resource service-instance-lock my-service-instance

指令選項

名稱（必要）

服務實例的名稱，與 ID 不能同時使用

ID（必要）

服務實例的 ID，與 NAME 不能同時使用

-g 資源組織

資源群組名稱

-f, --force

強制鎖定而不確認

範例

解除鎖定資源服務實體 my-service-instance：

ibmcloud resource service-instance-unlock my-service-instance

指令選項

--instance-id

服務實例 ID

--instance-name

服務實例名稱

範例

列出服務實例 my-service-instance 的服務金鑰：

ibmcloud resource service-keys --instance-name my-service-instance

指令選項

名稱

金鑰的名稱

ID

金鑰的 ID

-g

資源群組名稱

--id

顯示服務金鑰的 ID。 此選項與 '--output' 不能同時使用。

-g RESOURCE_GROUP

資源群組名稱

範例

顯示服務金鑰 my-service-key 的詳細資料：

ibmcloud resource service-key my-service-key

顯示 ID 為 crn:v1:bluemix:public:cloudantnosqldb:us-south:a/537860630a5ba7115be954e8d5aa5689:cc2a6d6c-8f5e-4038-b975-b09b51d1d8dc:resource-key:9057f12e-fbf5-421d-8865-764422217a79 的服務金鑰的詳細資訊：

ibmcloud resource service-key crn:v1:bluemix:public:cloudantnosqldb:us-south:a/537860630a5ba7115be954e8d5aa5689:cc2a6d6c-8f5e-4038-b975-b09b51d1d8dc:resource-key:9057f12e-fbf5-421d-8865-764422217a79

指令選項

NAME（必要）

金鑰的名稱。

ROLE_NAME (選用)

IAM 服務角色的名稱。 指定的角色不能是其中一個預設平台角色。 您可以透過執行 ibmcloud iam roles --service <your-service> 並檢查 serviceRole 是否出現在角色的 CRN 中來驗證任何角色使用此選項的資格。

--instance-id 服務類型

服務實例 ID。

--instance-name 服務類型名稱

Service instance name.

--service-id SERVICE_ID

角色所屬服務 ID 的名稱或 UUID。 僅當省略 ROLE_NAME 或設定為 None 時才能設定。

-p, --parameters @json_file | json_text

參數 JSON 檔案或 JSON 字串。

-g 資源組織

資源群組名稱。

--service-endpoint 服務端點類型

服務端點的類型。 可能的值為 'public「或」private'。

--output FORMAT（選用）

指定輸出格式。 只支援 JSON。

-f, --force

強制建立，而不進行確認

-q, --quite

暫停詳細輸出。

範例

以 my-service-key 角色，為服務實例 Administrator 建立名為 my-service-instance 的服務金鑰：

ibmcloud resource service-key-create my-service-key Administrator --instance-name my-service-instance

建立名為 my-service-key 但不含非啟用 iam 之服務實例的任何角色 my-service-instance 的服務金鑰:

ibmcloud resource service-key-create my-service-key --instance-name my-service-instance

指令選項

NAME | ID

金鑰的名稱或 ID

-n, --name NEW_NAME

金鑰的新名稱

-g RESOURCE_GROUP

金鑰所屬資源群組的 ID

-f, --force

強制更新，而不進行確認

範例

更新名為 my-service-key 的服務金鑰，提供它新名稱 my-service-key-2：

ibmcloud resource service-key-update my-service-key -n my-service-key-2

指令選項

KEY_NAME | KEY_ID

金鑰的名稱或金鑰的 ID

-f, --force

強制刪除，而不進行確認

範例

刪除服務金鑰 my-service-key：

ibmcloud resource service-key-delete my-service-key

指令選項

-ir，--is-reclaimed

搜尋已收回的帳戶資源。 但是，預設情況下，搜尋僅會傳回活動資源。 您可以將 is-reclaimed 設定為 any 來搜尋資源，無論資源是否已回收。 將此選項設為 true，只會將搜尋準則套用至收回的資源。 將此選項設為 false，以僅搜尋作用中資源。false 是預設行為。

-o, -offset

開始的資源位置號碼

-l, -limit

要傳回的資源數目，上限為 10000。

-s, --sort-by

排序依據的內容。 接受的值為 name, family, region, type, crn。

-p, --provider

顯示標準基礎架構資源。 唯一支援的值是 classic-infrastructure。

可搜尋的屬性

您可以搜尋許多屬性來確定搜尋範圍。 一些例子是：

名稱

資源的使用者定義名稱。

區域

佈建資源的地理位置。 例如：us-south、us-east、au-syd、eu-gb、eu-de 及 jp-tok。

service_name

服務出現在 'ibmcloud catalog service-marketplace' 輸出 Name 直欄中時，所顯示的名稱。

creation_date

資源的建立日期。

modification_date

資源的前次修改日期。

有關可以搜尋的屬性的完整列表，請參閱 搜尋資源。

範例

搜尋指定位置 (即 us-south 區域) 的 Resource Controller 資源：

ibmcloud resource search "region:us-south AND family:resource_controller"

搜尋名稱為 default 的資源群組：

ibmcloud resource search "name:default AND type:resource-group"

搜尋具有指定「雲端資源名稱 (CRN)」的資源：

ibmcloud resource search "crn:\"crn:v1:bluemix:public:cloudantnosqldb:us-south:s/4948af7e-cc78-4321-998a-e549dd5e9210:41a031cd-e9e5-4c46-975d-9e4a6391322e:cf-service-instance:\""

搜尋具有指定標籤的資源：

ibmcloud resource search "tags:\"mykey:myvalue\""

搜尋具有所指定 ID 的「標準基礎架構虛擬訪客」資源（僅具有 -p classic-infrastructure）：

ibmcloud resource search "id:12345678 _objectType:SoftLayer_Virtual_Guest"

搜尋具有所指定標籤名稱的「標準基礎架構硬體」資源（僅具有 -p classic-infrastructure）：

ibmcloud resource search "tagReferences.tag.name:name _objectType:SoftLayer_Hardware"

指令選項

SUBSCRIPTION_ID（必填）

訂閱的 SUBSCRIPTION_ID 字段

範例

顯示訂閱詳情 my-subscription-id:

ibmcloud resource subscription my-subscription-id

指令選項

--output 價值

指定輸出格式。 現在只支援 JSON。

指令選項

--offset 值，-o 值

起始資源位置編號（預設值：0）。

--limit VALUE、-l VALUE

要傳回的資源數量 (最多 1000) (預設值：100)。

--provider 值，-p 值

顯示與 Classic Infrastructure 資源相關的標籤。 唯一允許的值是：classic-infrastructure。 使用此指令可取得在 Classic Infrastructure 中定義的標籤。

--details價值，-d價值

顯示每個標籤的附加屬性，唯一允許的值為 true。

--attached價值，-a價值

只顯示附加到資源的篩選標籤，唯一允許的值是 true。

--tag-type價值

標籤的類型。 僅允許值為：使用者、服務或存取 (預設值：使用者)。

--account-id價值

擁有您要列出的標籤的帳戶 ID（若標籤類型設為服務，則必須輸入）。

--output 價值

指定輸出格式。 現在只支援 JSON。

-q, --quiet

暫停詳細輸出。

指令選項

--tag-names價值

以逗號分隔的標籤名稱清單。

-q, --quiet

暫停詳細輸出。

此指令僅對存取管理標籤有效。 例如：

• 執行下列指令，以建立存取權管理標籤 project:myproject:

  ibmcloud resource tag-create —tag-names “project:myproject”
  

指令選項

--tag-names價值

以逗號分隔的標籤名稱清單。

--resources-query 價值

全域搜尋查詢字串用於擷取應附加標籤的資源

--resource-name價值

必須附加標籤的資源名稱。

--resource-id價值

應附加標籤的資源的 CRN（對於經典基礎架構資源，它是資源的 ID）。

--resource-type價值

必須套用標籤的資源類型。 只有下列類型的 Classic Infrastructure 資源才需要：SoftLayer_Hardware_Server, SoftLayer_Hardware, SoftLayer_Virtual_Guest, SoftLayer_Network_Vlan_Firewall, SoftLayer_Network_Application_Delivery_Controller, SoftLayer_Network_Vlan, SoftLayer_Virtual_DedicatedHost, SoftLayer_Network_Component_Firewall, 和 SoftLayer_Network_Firewall_Module_Context。

--tag-type價值

標籤的類型。 唯一容許的值是 user 或 service。 預設值為 user。

--account-id價值

擁有要標記的資源的帳戶 ID（若標記類型設為服務，則必須輸入）。

--replace

標記名稱清單將取代附加到資源的目前標記名稱清單。

--update

將更新格式為 key:value 的標籤名稱。 此選項不會影響不是該格式的標籤名稱。

-q, --quiet

暫停詳細輸出。

範例

• 若要將 my-tag 使用者標籤附加到 Kubernetes 名為 MyCluster 的群集，請先確認該群集的 CRN：

  ibmcloud resource search 'type:k8\-cluster AND name:MyCluster'
  

  請記下 CRN，這是類似於下列範例的字串：

  crn:v1:bluemix:public:containers-kubernetes:us-south:a/a27a4741a57dcf5c965939adb66fe1c7:a46242e638ca47b09f10e9a3cbe5687a::
  

  若要連接標籤，請執行下列指令：

  ibmcloud resource tag-attach --tag-names my-tag --resource-id rn:v1:bluemix:public:containers-kubernetes:us-south:a/a27a4741a57dcf5c965939adb66fe1c7:a46242e638ca47b09f10e9a3cbe5687a::
  

• 要將 my-tag 使用者標籤附加到名為 MyResource 的資源：

  ibmcloud resource tag-attach --tag-name my-tag --resource-name  'MyResource'
  

• 若要將 my-tag-1 和 my-tag-2 使用者標籤附加到部署在 us-south 的所有 Kubernetes 群集，請執行下列指令：

  ibmcloud resource tag-attach --tag-names my-tag-1,my-tag-2 --resources-query 'service_name:containers-kubernetes AND region:us-south'
  

  此指令會先擷取 us-south 中所有您可以檢視的 Kubernetes 叢集，然後將兩個指定的標籤附加到每個叢集。 然後，它會顯示每個 Kubernetes 集群的作業結果。

• 若要將 my-tag 使用者標籤附加到名為 MyVM 的經典基礎架構虛擬客座，請識別虛擬客座的 ID：

  ibmcloud resource search 'fullyQualifiedDomainName:MyVM  _objectType:SoftLayer_Virtual_Guest' -p classic-infrastructure
  

  記下 ID，它是類似於 48373549 的字串。

  若要連接標籤，請執行下列指令：

  ibmcloud resource tag-attach --tag-names my-tag --resource-id 48373549 --resource-type SoftLayer_Virtual_Guest
  

• 附加存取管理標籤 project:myproject，您之前建立的實例IBM Cloud Object Storage被稱為 Project data，執行以下命令：

  ibmcloud resource tag-attach --tag-names "project:myproject" --resource-name Project data -—tag-type access
  

• 若要在名為 MyResource 的資源上更新至 production env 使用者標籤的值，請執行下列指令:

  ibmcloud resource tag-attach --tag-names 'env:production' --resource-name 'MyResource' --update
  

• 若要在名為 MyResource 的資源上更新至 production env 存取權管理標籤的值，請執行下列指令:

  ibmcloud resource tag-attach --tag-names 'env:production' --resource-name 'MyResource' --update --tag-type access
  

• 若要將 MyResource 的所有使用者標籤取代為一組新的標籤 tag1、tag2 及 tag3，請執行下列指令:

  ibmcloud resource tag-attach --tag-names 'tag1,tag2,tag3' --resource-name 'MyResource' --replace
  

• 若要將 MyResource 的所有存取管理標籤取代為 compliance:hipaa 標籤，請執行下列指令:

  ibmcloud resource tag-attach --tag-names 'compliance:hipaa' --resource-name 'MyResource' --replace --tag-type access
  

指令選項

--tag-names價值

以逗號分隔的標籤名稱清單。

--resources-query 價值

全域搜尋查詢字串，用以擷取標籤應被分離的資源

--resource-name價值

應附加標籤的資源名稱。

--resource-id價值

應附加標籤的資源的 CRN（對於經典基礎架構資源，它是資源的 ID）。

--resource-type價值

必須移除標籤的資源類型。 只有下列類型的 Classic Infrastructure 資源才需要：SoftLayer_Hardware_Server, SoftLayer_Hardware, SoftLayer_Virtual_Guest, SoftLayer_Network_Vlan_Firewall, SoftLayer_Network_Application_Delivery_Controller, SoftLayer_Network_Vlan, SoftLayer_Virtual_DedicatedHost, SoftLayer_Network_Component_Firewall, 和 SoftLayer_Network_Firewall_Module_Context。

--tag-type價值

標籤的類型。 僅允許值為：使用者、服務或存取 (預設值：使用者)。

--account-id價值

擁有要分離的資源的帳戶 ID（若標籤類型設為服務，則必須輸入）。

-q, --quiet

暫停詳細輸出。

範例

• 若要將 my-tag 使用者標籤從 Kubernetes 名為 MyCluster 的群集中刪除，請先辨識群集的 CRN：

  ibmcloud resource search 'type:k8\-cluster AND name:MyCluster'
  

  請記下 CRN，這是類似於下列範例的字串：

  crn:v1:bluemix:public:containers-kubernetes:us-south:a/a27a4741a57dcf5c965939adb66fe1c7:a46242e638ca47b09f10e9a3cbe5687a::
  

  若要取下標籤，請執行下列指令：

  ibmcloud resource tag-detach --tag-names my-tag --resource-id crn:v1:bluemix:public:containers-kubernetes:us-south:a/a27a4741a57dcf5c965939adb66fe1c7:a46242e638ca47b09f10e9a3cbe5687a::
  

• 要從名為 MyResource 的資源中刪除 my-tag 使用者標籤：

  ibmcloud resource tag-detach --tag-name my-tag --resource-name 'MyResource'
  

• 若要將用戶標籤 my-tag-1 和 my-tag-2 從部署在 us-south 的所有 Kubernetes 叢集中刪除，請執行下列指令：

  ibmcloud resource tag-detach --tag-names my-tag-1,my-tag-2 --resources-query 'service_name:containers-kubernetes AND region:us-south'
  

  該指令會先擷取 us-south 中所有您可以檢視的 Kubernetes 叢集，然後從每個叢集中刪除兩個指定的標籤。 然後，它會顯示每個 Kubernetes 集群的作業結果。

• 若要從名為 MyVM 的經典基礎架構虛擬客座分離 my-tag 使用者標籤，請先尋找您要分離標籤的虛擬客座的 ID：

  ibmcloud resource search 'fullyQualifiedDomainName:MyVM  _objectType:SoftLayer_Virtual_Guest' -p classic-infrastructure
  

  記下 ID，它是類似於 48373549 的字串。

  若要取下標籤，請執行下列指令：

  ibmcloud resource tag-detach --tag-names my-tag --resource-id 48373549 --resource-type SoftLayer_Virtual_Guest
  

• 分離存取管理標籤 project:myproject 從一個實例IBM Cloud Object Storage被稱為 Project data，執行以下命令：

  ibmcloud resource tag-detach --tag-names "project:myproject" --resource-name Project data -—tag-type access
  

• 若要從 MyResource 分離 env:value 標籤，不論其值為何，請執行下列指令:

  ibmcloud resource tag-detach --tag-names 'env:*' —resource-name 'MyResource'
  

• 若要從 MyResource 分離所有標籤，請執行下列指令:

  ibmcloud resource tag-detach --tag-names '*' —resource-name 'MyResource'
  

指令選項

--tag-name價值

要刪除的標籤名稱。

--provider 值，-p 值

刪除與指定提供者相關的標籤。 唯一允許的值是：classic-infrastructure。 使用指令刪除 Classic Infrastructure 標籤。

--tag-type價值

標籤的類型。 僅允許值為：使用者、服務或存取 (預設值：使用者)。

account-id 值

擁有要刪除標記的帳戶 ID（若標記類型設為服務，則必須輸入）。

--force, -f

刪除標籤，無須確認。

--all, -a

刪除所有未附加到任何資源的標籤。

-q, --quiet

暫停詳細輸出。

標籤只有在沒有附加到任何資源時才能刪除。

範例

• 若要從帳戶中刪除使用者標籤 my-tag，請執行下列動作:

  ibmcloud resource tag-delete --tag-name "my-tag"
  

• 若要從帳戶刪除存取權管理標籤 project:myproject，請執行下列動作:

  ibmcloud resource tag-delete --tag-name "project:myproject" --tag-type access
  

• 如果要從帳戶刪除所有未用的使用者標籤，請執行下列動作:

  ibmcloud resource tag-delete -a
  

• 如果要從帳戶中刪除所有未用的存取權管理標籤，請執行下列動作:

  ibmcloud resource tag-delete -a --tag-type access
  

指令選項

--resource-instance-id

資源實例的廣域唯一 ID (GUID)

範例

列出所有資源收回:

ibmcloud resource reclamations

列出特定服務實例的資源收回:

ibmcloud resource reclamations --resource-instance-id abcd1234-ef56-486e-b293-22d6c7eb6699

指令選項

RECLAMATION_ID

資源收回 ID

範例

顯示資源回收的詳細資訊：

ibmcloud resource reclamation daf12d343ef

指令選項

ID

資源回收的 ID

--comment

動作的相關註解

範例

還原 ID 為 d9fendfwlw 的資源收回:

ibmcloud resource reclamation-restore "d9fendfwlw"

還原 ID 為 d9fendfwlw 的資源收回，留下 need to use for another 3 months 註解，並顯示 JSON 輸出:

ibmcloud resource reclamation-restore "d9fendfwlw" --comment "need to use for another 3 months" --output JSON

指令選項

ID

資源回收的 ID

--comment

動作的相關註解

-f, --force

強制刪除，而不進行確認

範例

刪除 ID 為 d9fendfwlw 的資源收回:

ibmcloud resource reclamation-delete "d9fendfwlw"

刪除 ID 為 d9fendfwlw 的資源收回，並留下 no longer needed 註解，而不確認:

ibmcloud resource reclamation-delete "d9fendfwlw" --comment "no longer needed" -f