命令选项

--default

获取当前帐户的缺省组。

示例

列出当前目标帐户下的所有资源组：

ibmcloud resource groups

列出当前目标账户的默认组：

ibmcloud resource groups --default

命令选项

NAME（必需）

资源组的名称

--id

仅显示标识

示例

显示资源组 example-group：

ibmcloud resource group example-group

仅显示资源组 example-group 的标识：

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 SERVICE_NAME : 服务所属名称

• --location 位置 : 按位置过滤

• --type INSTANCE_TYPE : 实例的类型。 如果未指定，那么将使用 service_instance 类型。 使用“全部”可列出所有类型的实例。

• -g RESOURCE_GROUP : 资源组名称

--all-resource-groups

查询所有资源组

--long

在输出中显示更多字段

- --limit 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 互斥

服务实例的标识

--location

按位置过滤

--id

显示服务实例的 ID

示例

显示服务实例 my-service-instance 的详细信息：

ibmcloud resource service-instance my-service-instance

命令选项

NAME（必需）

服务实例的名称

SERVICE_NAME 或 SERVICE_ID（必需）

服务的名称或标识。 要列出服务产品，请使用 ibmcloud catalog service-marketplace 命令。

SERVICE_PLAN_NAME 或 SERVICE_PLAN_ID（必需）

服务套餐的名称或标识

LOCATION（必需）

用于创建服务实例的目标位置或环境

- -d, --deployment DEPLOYMENT_NAME

部署的名称

- -p, --parameters @JSONFILE 或 JSON_STRING

用于创建服务实例的参数的 JSON 文件或 JSON 字符串

- -g RESOURCE_GROUP

资源组名称

- --service-endpoints SERVICE_ENDPOINTS_TYPE

服务端点的类型。 可能的值为“public”、“private”、“public-and-private”。 服务端点的默认值是服务在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 SERVICE_PLAN_ID

新服务套餐标识

- -p, --parameters @JSON_FILE | JSON_STRING

用于创建服务实例的参数的 JSON 文件或 JSON 字符串

- -g RESOURCE_GROUP

资源组名称

- --service-endpoints SERVICE_ENDPOINTS_TYPE

服务端点的类型。 可能的值为“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 RESOURCE_GROUP

资源组名称

-f, --force

强制锁定而不确认

示例

锁定资源服务实例 my-service-instance：

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

命令选项

名称（必需）

服务实例的名称，与 ID 互斥

ID（必需）

服务实例的 ID，与 NAME 互斥

- -g RESOURCE_GROUP

资源组名称

-f, --force

强制锁定而不确认

示例

解锁资源服务实例 my-service-instance：

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

命令选项

--instance-id

服务实例标识

--instance-name

服务实例名称

示例

列出服务实例 my-service-instance 的服务密钥：

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

命令选项

名称

密钥的名称

标识

密钥的标识

-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 SERVICE_INSTANCE_ID

服务实例标识。

- --instance-name SERVICE_INSTANCE_NAME

服务实例名称。

- --service-id SERVICE_ID

角色所属服务 ID 的名称或 UUID。 只有省略 ROLE_NAME 或设置为 None 时才能设置。

- -p, --parameters @JSON_FILE | JSON_TEXT

参数 JSON 文件或 JSON 字符串。

- -g RESOURCE_GROUP

资源组名称。

- --service-endpoint SERVICE_ENDPOINT_TYPE

服务端点的类型。 可能的值是“公共”或“私人”。

--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

为未启用 iam 的服务实例 my-service-instance 创建名为 my-service-key 且没有任何角色的服务密钥:

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

命令选项

NAME | ID

密钥的名称或标识

-n, --name NEW_NAME

密钥的新名称

-g RESOURCE_GROUP

密钥所属的资源组的标识

-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

密钥的名称或密钥的标识

-f, --force

强制删除而不确认

示例

删除服务密钥 my-service-key：

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

命令选项

-ir，--is-reclaimed

搜索已回收的帐户资源。 不过，默认情况下，搜索只返回活动资源。 您可以将 is-reclaimed 设置为任意，以搜索是否被回收的资源。 将此选项设置为 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 区域）的资源控制器资源：

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\""

搜索具有指定标识的经典基础架构虚拟访客资源（仅使用 -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。 将其用于 SoftLayer_Hardware, SoftLayer_Network_Application_Delivery_Controller, SoftLayer_Network_Subnet_IpAddress 或 SoftLayer_Network_Vlan 类型的资源。

--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 值

以逗号分隔的标签名称列表。

--resource-name 值

必须附加标签的资源名称。

--resource-id 值

应附加标签的资源的 CRN（对于经典基础设施资源，它是资源的 ID）。

--resource-type 值

标记的类型。 允许的值只有：用户、服务或访问（默认值：用户）。

--tag-type 值

标签类型。 唯一允许的值为 user 或 service。 缺省值为 user。

--account-id 值

拥有要标记的资源的账户 ID（如果标记类型设置为服务，则为必填项）。

--replace

标签名称列表会替换当前附加到资源上的标签名称列表。

--update

将更新格式为 key:value 的标记名称。 该选项对非该格式的标记名称没有影响。

-q, --quiet

禁止详细输出。

示例

• 要将用户标记 MyTag 附加到名为 MyCluster 的 Kubernetes 集群，首先要查找要标记的集群的 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 MyTag --resource-id rn:v1:bluemix:public:containers-kubernetes:us-south:a/a27a4741a57dcf5c965939adb66fe1c7:a46242e638ca47b09f10e9a3cbe5687a::
  

• 要将用户标记 MyTag 附加到名为 MyResource 的资源上：

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

• 要将用户标记 MyTag 附加到名为 MyVM 的经典基础架构虚拟客户机，首先要查找要标记的虚拟客户机的 ID：

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

  记下标识，它是类似于 48373549 的字符串。

  要附加标记，请运行以下命令：

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

• 要将先前创建的访问管理标记 project:myproject 附加到名为 Project data 的 IBM Cloud Object Storage 实例，请运行以下命令：

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

• 要将名为 MyResource 的资源上的 env 用户标记的值更新为 production，请运行以下命令:

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

• 要将名为 MyResource 的资源上的 env 访问管理标记的值更新为 production，请运行以下命令:

  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 值

以逗号分隔的标签名称列表。

--resource-name 值

应附加标签的资源名称。

--resource-id 值

应附加标签的资源的 CRN（对于经典基础设施资源，它是资源的 ID）。

--resource-type 值

应附加标签的资源类型（仅 SoftLayer_Hardware, SoftLayer_Network_Application_Delivery_Controller, SoftLayer_Network_Subnet_IpAddress 或 SoftLayer_Network_Vlan 类型的经典基础架构资源需要）。

--tag-type 值

标记的类型。 允许的值只有：用户、服务或访问（默认值：用户）。

--account-id 值

拥有要分离的资源的账户 ID（如果标记类型设置为服务，则为必填项）。

-q, --quiet

禁止详细输出。

示例

• 要从名为 MyCluster 的 Kubernetes 集群中分离用户标签 MyTag，首先要查找要分离标签的集群的 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 MyTag --resource-id rn:v1:bluemix:public:containers-kubernetes:us-south:a/a27a4741a57dcf5c965939adb66fe1c7:a46242e638ca47b09f10e9a3cbe5687a::
  

• 要将用户标记 MyTag 拆离到名为 MyResource 的资源:

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

• 要将用户标记 MyTag 与名为 MyVM 的经典基础架构虚拟客户分离，首先要查找要分离标记的虚拟客户的 ID：

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

  记下标识，它是类似于 48373549 的字符串。

• 要分离标签，请运行以下命令：

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

• 要从名为 Project data 的 IBM Cloud Object Storage 实例中分离访问管理标记 project:myproject，请运行以下命令：

  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）。 将其用于 SoftLayer_Hardware, SoftLayer_Network_Application_Delivery_Controller, SoftLayer_Network_Subnet_IpAddress 或 SoftLayer_Network_Vlan 类型的资源。

--tag-type 值

标记的类型。 允许的值只有：用户、服务或访问（默认值：用户）。

account-id 值

要删除的标记的账户 ID（如果标记类型设置为服务，则为必填项）。

--force, -f

无需确认即可删除标签。

--all, -a

删除所有未附加到任何资源的标记。

-q, --quiet

禁止详细输出。

只有当一个标签没有附加到任何资源上时，才能将其删除。

示例

• 要从帐户中删除用户标记 MyTag :

  ibmcloud resource tag-delete --tag-name "MyTag"
  

• 要从帐户中删除访问权管理标记 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

资源实例的全局唯一标识 (GUID)

示例

列出所有资源回收:

ibmcloud resource reclamations

列示特定服务实例的资源回收:

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

命令选项

RECLAMATION_ID

资源回收标识

示例

显示资源回收的详细信息：

ibmcloud resource reclamation daf12d343ef

命令选项

标识

资源回收 ID

--comment

关于操作的注释

示例

复原标识为 d9fendfwlw 的资源回收:

ibmcloud resource reclamation-restore "d9fendfwlw"

复原标识为 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

--comment

关于操作的注释

-f, --force

强制删除而不确认

示例

删除标识为 d9fendfwlw 的资源回收:

ibmcloud resource reclamation-delete "d9fendfwlw"

删除标识为 d9fendfwlw 的资源回收，并留下注释 no longer needed 而不确认:

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