华为云用户手册

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Token获取方法详见获取用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 server_id 是 String 实例id upgrade_time 是 Long 定时升级的时间，需要比当前时间大24小时 cancel 否 Boolean 是否取消升级定时任务，已开始任务不可取消。 true：取消 false：无影响

响应参数 状态码： 400 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 请求参数错误。 状态码： 401 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 校验TOKEN失败。 状态码： 403 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 租户无权限操作。 状态码： 404 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 没有找到CBH资源。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Token获取方法详见获取用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 server_id 是 String 需要切换vpc的实例id network 是 NetworkInfoCreate object 切换 云堡垒机 实例vpc所需网络信息。 表4 NetworkInfoCreate 参数 是否必选 参数类型 描述 vpc_id 是 String 待创建云服务器所属虚拟私有云（简称VPC），需要指定已创建VPC的ID，UUID格式。 VPC的ID可以从控制台或者参考《虚拟私有云接口参考》的“查询VPC”章节获取。 例如：03211ecf-xxxx-4306-xxxx-6e939bfxxxxx subnet_id 是 String 子网ID，字母数字下划线连接符组成。 public_ip 是 PublicIp object 云 堡垒机 实例弹性公网IP信息。可填写null值 security_groups 是 Array of SecurityGroup objects 安全组信息。 private_ip 否 PrivateIp object 云堡垒机实例指定公网IP信息。 表5 PublicIp 参数 是否必选 参数类型 描述 id 否 String 弹性IP和EIP只能有一个，弹性IP或EIP的ID。 public_eip 否 String 弹性IP地址。 表6 SecurityGroup 参数 是否必选 参数类型 描述 id 是 String 云堡垒机实例安全组ID，字母数字下划线连接符组成。 表7 PrivateIp 参数 是否必选 参数类型 描述 ip 是 String 私网IP地址。 slave_ip 否 String 备机私网IP地址。 floating_ip 否 String 浮动IP地址。

响应参数 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 请求参数错误。 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 校验TOKEN失败。 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 租户无权限操作。 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 没有找到CBH资源。

响应参数 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 请求参数错误。 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 校验TOKEN失败。 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 租户无权限操作。 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 没有找到CBH资源。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 admin_url String 云堡垒机登录admin链接。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 请求参数错误。 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 校验TOKEN失败。 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 租户无权限操作。 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 没有找到CBH资源。

响应参数 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 请求参数错误。 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 校验TOKEN失败。 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 租户无权限操作。 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 没有找到CBH资源。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Token获取方法详见获取用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 publicip_id 是 String 弹性公网IP的ID,使用UUID格式。

响应参数 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 请求参数错误。 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 校验TOKEN失败。 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 租户无权限操作。 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 没有找到CBH资源。

响应参数 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 校验TOKEN失败。 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 租户无权限操作。 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 没有找到CBH资源。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Token获取方法详见获取用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 action 是 String 执行动作。 create,创建 delete,删除 tags 是 Array of ResourceTag objects 标签列表 租户权限时该字段必选，op_service权限时和sys_tags二选一。 sys_tags 否 Array of ResourceTag objects 系统标签列表 op_service权限可以访问，和tags二选一。 目前TMS调用时只包含一个resource_tag结构体 ，key固定为：_sys_enterprise_project_id value是UUID或0,value为0表示默认企业项目。 现在仅支持create操作。 表4 ResourceTag 参数 是否必选 参数类型 描述 key 是 String 键。最大长度128个字符。 key需要满足3.1 KEY字符集规范。 value 是 String 值。每个值最大长度255个字符， value需要满足3.2 VALUE字符集规范。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 login_url String 云堡垒机登录链接。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 请求参数错误。 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 校验TOKEN失败。 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 租户无权限操作。 状态码： 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 没有找到CBH资源。

响应参数 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 请求参数错误。 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 校验TOKEN失败。 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 租户无权限操作。 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 没有找到CBH资源。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Token获取方法详见获取用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 server_id 是 String 云堡垒机实例ID，使用UUID格式表示。 实例ID获取方式。 new_resource_spec_code 否 String 待变更云堡垒机规格ID，例如： cbh.basic.50 cbh.enhance.50 已上线的规格请参见《云堡垒机产品介绍》的服务版本差异章节。 attach_disk_size 否 Integer 附加磁盘大小。单位TB 说明： 说明： 附加磁盘和规格自带磁盘大小不能超过300TB。 is_auto_pay 否 Integer 是否自动支付，下单订购后，是否自动从客户的云账户中支付，而不需要客户手动去进行支付。 1：是（会自动选择折扣和优惠券进行优惠，然后自动从客户云账户中支付），自动支付失败后会生成订单成功(该订单应付金额是优惠后金额)、但订单状态为“待支付”，等待客户手动支付(手动支付时，客户还可以修改系统自动选择的折扣和优惠券) 0：否（需要客户手动去支付，客户可以选择折扣和优惠券。） 默认值为“0”

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 order_id String 订单ID。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 请求参数错误。 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 校验TOKEN失败。 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 租户无权限操作。 状态码： 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 没有找到CBH资源。

响应示例 状态码： 200 Cbh List Instance Success { "total" : 1, "instance" : [ { "name" : "CBH-e2b4", "server_id" : "760aeee4-9916-436a-8854-837a9ae94b2b", "instance_id" : 5473, "alter_permit" : false, "enterprise_project_id" : "0", "period_num" : "1,2", "start_time" : 1692245215000, "end_time" : 1694966399000, "created_time" : "2023-08-17 12:05:02.0", "update" : false, "bastion_version" : "3.3.49.0", "az_info" : { "region" : "cn-north-7", "zone" : "cn-north-7a", "availability_zone_display" : "可用区1", "slave_zone" : "cn-north-7b", "slave_zone_display" : "可用区2" }, "status_info" : { "status" : "ACTIVE", "task_status" : "NO_TASK", "create_instance_status" : "NO_TASK", "fail_reason" : "No FailReason Now", "instance_status" : "ok", "instance_description" : ",2023-08-21 15:19:07,{\"d_usage\":\"0.30\",\"m_usage\":\"43.66\",\"c_usage\":\"1.00\",\"session_count\":\"0\"" }, "resource_info" : { "specification" : "cbh.basic.5", "order_id" : " CS 2308171141G8C14", "resource_id" : "c7a07a7f-e5ee-49cf-8355-aee46c5a4fcf", "data_disk_size" : 200, "disk_resource_id" : [ ] }, "network" : { "vip" : "192.168.0.228", "web_port" : "443", "public_ip" : "100.xx.xx.1", "public_id" : "56220ed7-0f75-4d42-85c4-013d5414c81c", "private_ip" : "192.168.0.190", "vpc_id" : "03211ecf-697e-4306-a7a0-6e939bf948de", "subnet_id" : "dd08a6a9-ced7-484b-ace6-1b821854a772", "security_group_id" : "02dcf62d-b84d-4a14-aad3-c310f2ceea55" }, "ha_info" : { "ha_id" : "332", "instance_type" : "master" } } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total Integer 云堡垒机实例总数。 instance Array of InstanceDetail objects 云堡垒机实例列表信息。 表5 InstanceDetail 参数 参数类型 描述 name String 云堡垒机实例名称。 server_id String 云堡垒机服务器id。 instance_id String 云堡垒机实例id。 alter_permit Boolean 云堡垒机实例是否可以扩容。 true：是 false：否 enterprise_project_id String 项目ID。 period_num String 云堡垒机实例订购周期数。 start_time String 云堡垒机实例开始时间，使用时间戳格式表示。 end_time String 云堡垒机实例结束时间，使用时间戳格式表示。 created_time String 云堡垒机实例创建时间，使用UTC时间表示。 upgrade_time Long 云堡垒机实例升级定时时间，使用时间戳格式表示。 update String 云堡垒机实例是否可以升级。 OLD：当前已是最新版本 NEW：可以升级小版本 CROSS_OS：可以跨版本升级 ROLLBACK：可以回滚 枚举值： OLD NEW CROSS_OS ROLLBACK bastion_version String 云堡垒机实例当前版本。 az_info az_info object 可用区信息。 status_info status_info object 状态信息。 resource_info resource_info object 资源信息。 network network object 网络信息。 ha_info ha_info object 主备信息。 表6 az_info 参数 参数类型 描述 region String 云堡垒机实例所在可用区ID。 zone String 云堡垒机实例所在可用分区ID。(实例为主备模式时作为主机实例所在可用分区) availability_zone_display String 云堡垒机实例所在可用分区中文名称。(实例为主备模式时作为主机实例所在可用分区中文名称) slave_zone String 云堡垒机备机实例所在可用区。 slave_zone_display String 云堡垒机备机实例所在可用区中文名称。 表7 status_info 参数 参数类型 描述 status String 云堡垒机实例状态。 SHUTOFF：已关闭 ACTIVE：运行中 DELETING：删除中 BUILD：创建中 DELETED：已删除 ERROR：故障 HAWAIT：等待备机创建成功 FROZEN：已冻结 UPGRADING：升级中 UNPAID：待支付 RESIZE：规格变更中 DILATATION：扩容中 HA：配置HA中 task_status String 云堡垒机实例当前的任务状态。 powering-on：开启 powering-off：关闭 rebooting：重启 delete_wait：删除 frozen：冻结 NO_TASK：运行 unfrozen：解冻 alter：变更 updating：升级中 configuring-ha：配置HA data-migrating：数据迁移中 rollback：版本回滚中 traffic-switchover：流量切换中 create_instance_status String 云堡垒机实例在创建实例过程中的状态信息。 Waiting for payment：等待支付 creating-network：创建网络 creating-server：创建服务 tranfering-horizontal-network：网络打通 adding-policy-route：添加路由策略 configing-dns：配置DNS starting-cbs-service：服务运行中 setting-init-conf：初始化 buying-EIP：购买弹性公网IP instance_status String 云堡垒机实例状态。 building：创建中 deleting：删除中 deleted：删除了 unpaid：未支付 upgrading：升级中 resizing：扩容中 abnormal：异常 error：故障 ok：正常 instance_description String 云堡垒机实例信息描述。 fail_reason String 云堡垒机实例创建实例失败原因。 表8 resource_info 参数 参数类型 描述 specification String 云堡垒机实例规格。 order_id String 订单id。 resource_id String 云堡垒机实例的资源id，UUID格式显示。 data_disk_size Number 云堡垒机实例数据盘大小，单位TB。 disk_resource_id Array of strings 云堡垒机实例数据盘资源ID。 表9 network 参数 参数类型 描述 vip String 云堡垒机实例浮动ip。(实例为主备模式时返回对应的值) web_port String 云堡垒机实例WEB界面访问的端口号。 public_ip String 云堡垒机实例弹性公网IP。 public_id String 云堡垒机实例绑定公网的弹性IP的ID，UUID格式表示。 private_ip String 云堡垒机实例私有ip。 vpc_id String 云堡垒机实例所在虚拟私有云ID。 subnet_id String 云堡垒机实例所在子网ID。 security_group_id String 云堡垒机实例所属的安全组ID。 表10 ha_info 参数 参数类型 描述 ha_id String 主备ID。 instance_type String 实例类型。 master：主 slave：备 状态码： 400 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 请求参数错误。 状态码： 401 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 校验TOKEN失败。 状态码： 403 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 租户无权限操作。 状态码： 404 表14 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 没有找到CBH资源。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 order_id String 订单ID。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 请求参数错误。 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 校验TOKEN失败。 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 租户无权限操作。 状态码： 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 没有找到CBH资源。

URI PUT /v2/{project_id}/cbs/instance/type 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法详见API参考，附录获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 server_id 是 String 实例id availability_zone 否 String 可用分区名称。 可参考地区和终端节点获取 is_auto_pay 否 Integer 是否自动支付，下单订购后，是否自动从客户的云账户中支付，而不需要客户手动去进行支付。 1：是（会自动选择折扣和优惠券进行优惠，然后自动从客户云账户中支付），自动支付失败后会生成订单成功(该订单应付金额是优惠后金额)、但订单状态为“待支付”，等待客户手动支付(手动支付时，客户还可以修改系统自动选择的折扣和优惠券) 0：否（需要客户手动去支付，客户可以选择折扣和优惠券。） 默认值为“0”

响应参数 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 请求参数错误。 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 校验TOKEN失败。 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 租户无权限操作。 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 没有找到CBH资源。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Token获取方法详见获取用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 publicip_id 是 String 弹性公网IP的ID,使用UUID格式。

请求示例 { "matches" : [ { "key" : "resource_name", "value" : "resource1" } ], "not_tags" : [ { "key" : "key1", "values" : [ "*value1", "value2" ] } ], "tags" : [ { "key" : "key1", "values" : [ "*value1", "value2" ] } ], "tags_any" : [ { "key" : "key1", "values" : [ "value1", "value2" ] } ], "not_tags_any" : [ { "key" : "key1", "values" : [ "value1", "value2" ] } ], "sys_tags" : [ { "key" : "_sys_enterprise_project_id", "values" : [ "5aa119a8-d25b-45a7-8d1b-88e127885635" ] } ] }

响应示例 状态码： 200 List CBH ByTags Success { "resources" : [ { "resource_id" : "cdfs_cefs_wesas_12_dsad", "resource_name" : "resouece1", "tags" : [ { "key" : "key1", "value" : "value1" }, { "key" : "key2", "value" : "value1" } ], "sys_tags" : [ { "key" : "_sys_enterprise_project_id", "value" : "5aa119a8-xxxx-45a7-xxxx-88e12788xxxx" } ] } ], "total_count" : 1000 }

响应参数 状态码： 200 表6 响应Body参数 参数 参数类型 描述 resources Array of Resources objects 根据查询模式获取到的资源实例详情。 total_count Integer 总记录数。 表7 Resources 参数 参数类型 描述 resource_id String 实例ID。 resource_detail InstanceDetail object CBH实例详情 tags Array of ResourceTag objects tags。 sys_tags Array of ResourceTag objects sys_tags。 resource_name String 资源名称。 表8 InstanceDetail 参数 参数类型 描述 name String 云堡垒机实例名称。 server_id String 云堡垒机服务器id。 instance_id String 云堡垒机实例id。 alter_permit Boolean 云堡垒机实例是否可以扩容。 true：是 false：否 enterprise_project_id String 项目ID。 period_num String 云堡垒机实例订购周期数。 start_time String 云堡垒机实例开始时间，使用时间戳格式表示。 end_time String 云堡垒机实例结束时间，使用时间戳格式表示。 created_time String 云堡垒机实例创建时间，使用UTC时间表示。 upgrade_time Long 云堡垒机实例升级定时时间，使用时间戳格式表示。 update String 云堡垒机实例是否可以升级。 OLD：当前已是最新版本 NEW：可以升级小版本 CROSS_OS：可以跨版本升级 ROLLBACK：可以回滚 枚举值： OLD NEW CROSS_OS ROLLBACK bastion_version String 云堡垒机实例当前版本。 az_info az_info object 可用区信息。 status_info status_info object 状态信息。 resource_info resource_info object 资源信息。 network network object 网络信息。 ha_info ha_info object 主备信息。 表9 az_info 参数 参数类型 描述 region String 云堡垒机实例所在可用区ID。 zone String 云堡垒机实例所在可用分区ID。(实例为主备模式时作为主机实例所在可用分区) availability_zone_display String 云堡垒机实例所在可用分区中文名称。(实例为主备模式时作为主机实例所在可用分区中文名称) slave_zone String 云堡垒机备机实例所在可用区。 slave_zone_display String 云堡垒机备机实例所在可用区中文名称。 表10 status_info 参数 参数类型 描述 status String 云堡垒机实例状态。 SHUTOFF：已关闭 ACTIVE：运行中 DELETING：删除中 BUILD：创建中 DELETED：已删除 ERROR：故障 HAWAIT：等待备机创建成功 FROZEN：已冻结 UPGRADING：升级中 UNPAID：待支付 RESIZE：规格变更中 DILATATION：扩容中 HA：配置HA中 task_status String 云堡垒机实例当前的任务状态。 powering-on：开启 powering-off：关闭 rebooting：重启 delete_wait：删除 frozen：冻结 NO_TASK：运行 unfrozen：解冻 alter：变更 updating：升级中 configuring-ha：配置HA data-migrating：数据迁移中 rollback：版本回滚中 traffic-switchover：流量切换中 create_instance_status String 云堡垒机实例在创建实例过程中的状态信息。 Waiting for payment：等待支付 creating-network：创建网络 creating-server：创建服务 tranfering-horizontal-network：网络打通 adding-policy-route：添加路由策略 configing-dns：配置DNS starting-cbs-service：服务运行中 setting-init-conf：初始化 buying-EIP：购买弹性公网IP instance_status String 云堡垒机实例状态。 building：创建中 deleting：删除中 deleted：删除了 unpaid：未支付 upgrading：升级中 resizing：扩容中 abnormal：异常 error：故障 ok：正常 instance_description String 云堡垒机实例信息描述。 fail_reason String 云堡垒机实例创建实例失败原因。 表11 resource_info 参数 参数类型 描述 specification String 云堡垒机实例规格。 order_id String 订单id。 resource_id String 云堡垒机实例的资源id，UUID格式显示。 data_disk_size Number 云堡垒机实例数据盘大小，单位TB。 disk_resource_id Array of strings 云堡垒机实例数据盘资源ID。 表12 network 参数 参数类型 描述 vip String 云堡垒机实例浮动ip。(实例为主备模式时返回对应的值) web_port String 云堡垒机实例WEB界面访问的端口号。 public_ip String 云堡垒机实例弹性公网IP。 public_id String 云堡垒机实例绑定公网的弹性IP的ID，UUID格式表示。 private_ip String 云堡垒机实例私有ip。 vpc_id String 云堡垒机实例所在虚拟私有云ID。 subnet_id String 云堡垒机实例所在子网ID。 security_group_id String 云堡垒机实例所属的安全组ID。 表13 ha_info 参数 参数类型 描述 ha_id String 主备ID。 instance_type String 实例类型。 master：主 slave：备 表14 ResourceTag 参数 参数类型 描述 key String 键。最大长度128个字符。 key需要满足3.1 KEY字符集规范。 value String 值。每个值最大长度255个字符， value需要满足3.2 VALUE字符集规范。 状态码： 400 表15 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 请求参数错误。 状态码： 401 表16 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 校验TOKEN失败。 状态码： 403 表17 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 租户无权限操作。 状态码： 404 表18 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 没有找到CBH资源。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Token获取方法详见获取用户Token。 limit 否 String 查询记录数（action为count时无此参数）如果action为filter默认为1000，limit最多为1000,不能为负数，最小值为1。 offset 否 String 索引位置，偏移量（action为count时无此参数）从第一条数据偏移offset条数据后开始查询，如果action为filter默认为0（偏移0条数据，表示从第一条数据开始查询）,必须为数字，不能为负数。 表3 请求Body参数 参数 是否必选 参数类型 描述 without_any_tag 否 Boolean 不包含任意一个标签，该字段为true时查询所有不带标签的资源。 此时忽略 “tags”、“tags_any”、“not_tags”、“not_tags_any”字段。 tags 否 Array of Tags objects 包含标签，最多包含50个key，每个key下面的value最多10个，每个key对应的value可以为空数组但结构体不能缺失。 Key不能重复，同一个key中values不能重复。结果返回包含所有标签的资源列表，key之间是与的关系， key-value结构中value是或的关系。 无tag过滤条件时返回全量数据。 tags_any 否 Array of Tags objects 包含任意标签，最多包含50个key，每个key下面的value最多10个,每个key对应的value可以为空数组但结构体不能缺失。Key不能重复，同一个key中values不能重复。 结果返回包含标签的资源列表，key之间是或的关系，key-value结构中value是或的关系。 无过滤条件时返回全量数据。 not_tags 否 Array of Tags objects 不包含标签，最多包含50个key，每个key下面的value最多10个, 每个key对应的value可以为空数组但结构体不能缺失。Key不能重复，同一个key中values不能重复。 结果返回不包含标签的资源列表，key之间是与的关系，key-value结构中value是或的关系。 无过滤条件时返回全量数据。 not_tags_any 否 Array of Tags objects 不包含任意标签，最多包含50个key，每个key下面的value最多10个, 每个key对应的value可以为空数组但结构体不能缺失。Key不能重复，同一个key中values不能重复。 结果返回不包含标签的资源列表，key之间是或的关系，key-value结构中value是或的关系。 无过滤条件时返回全量数据。 sys_tags 否 Array of Tags objects 仅op_service权限可以使用此字段做资源实例过滤条件。 目前TMS调用时只包含一个tag结构体。 key：_sys_enterprise_project_id value：企业项目id列表 目前TMS调用时，key下面只包含一个value。0表示默认企业项目 sys_tags和租户标签过滤条件（without_any_tag 、tags、tags_any、not_tags、not_tags_any）不能同时使用 无sys_tags时按照tag接口处理，无tag过滤条件时返回全量数据。。 matches 否 Array of Match objects 搜索字段,key为要匹配的字段，如resource_name等。 value为匹配的值。key为固定字典值，不能包含重复的key或不支持的key。 根据key的值确认是否需要模糊匹配，如resource_name默认为模糊搜索（不区分大小写），如果value为空字符串精确匹配（多数服务不存在资源名称为空的情况，因此此类情况返回空列表）。 resource_id为精确匹配。第一期只做resource_name，后续再扩展。 表4 Tags 参数 是否必选 参数类型 描述 key 是 String 键。 说明： 说明： key不能为空，长度1~128个字符（中文也可以输入128个字符） 可用 UTF-8 格式表示的字母(包含中文)、数字和空格，以及以下字符： _ . : = + - @ _sys_开头属于系统标签，租户不能输入 建议正则：^((?!sys)[\p{L}\p{Z}\p{N}_.:=+\-@]*)$ values 是 Array of strings 值列表。 说明： 说明： 长度0~255个字符（中文也可以输入255个字符） 可用 UTF-8 格式表示的字母(包含中文)、数字和空格，以及以下字符： _ . : / = + - @ 建议正则：^([\p{L}\p{Z}\p{N}_.:/=+-@]*)$ 资源标签值可以为空（empty or null） 预定义标签值不可以为空 表5 Match 参数 是否必选 参数类型 描述 key 是 String 键。第一期限定为resource_name,后续扩展。 value 是 String 值。每个值最大长度255个unicode字符 。不校验字符集范。。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 status_v6 String 支持IPv6云堡垒机实例规格资源状态。 sellout：售罄 normal：正常商用 status String 云堡垒机实例规格资源状态。 sellout：售罄 normal：正常商用 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 请求参数错误。 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 校验TOKEN失败。 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 租户无权限操作。 状态码： 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 没有找到CBH资源。

URI GET /v2/{project_id}/cbs/instance/ecs-quota 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法详见API参考，附录获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 availability_zone 是 String 可用分区名称。 可参考地区和终端节点获取 resource_spec_code 是 String 待创建云堡垒机规格ID，例如： cbh.basic.10 10资产标准版 cbh.enhance.10 10资产专业版 已上线的规格详情请参见《云堡垒机常见问题》的购买，云堡垒机实例有哪些规格章节。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 authorization AgencyAuthorizeInfo object 获取云堡垒机委托授权凭据管理、密钥管理服务权限列表返回对象。 表4 AgencyAuthorizeInfo 参数 参数类型 描述 csms Boolean 凭据管理权限信息。 kms Boolean 密钥管理权限信息。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 请求参数错误。 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 校验TOKEN失败。 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 租户无权限操作。 状态码： 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 没有找到CBH资源。

响应参数 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 请求参数错误。 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 校验TOKEN失败。 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 租户无权限操作。 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 没有找到CBH资源。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Token获取方法详见获取用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 security_groups 是 Array of strings 安全组信息。