云堡垒机 CBH-华为云

云堡垒机 CBH-基本概念

基本概念账号用户注册时的账号，账号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于账号是付费主体，为了确保账号安全，建议您不要直接使用账号进行日常管理工作，而是创建用户并使用他们进行日常管理工作。用户由账号在 IAM 中创建的用户，是云服务的使用人员，具有身份凭证（密码和访问密钥）。在我的凭证下，您可以查看账号ID和用户ID。通常在调用API的鉴权过程中，您需要用到账号、用户和密码等信息。区域（Region）从地理位置和网络时延维度划分，同一个Region内共享弹性计算、块存储、对象存储、VPC网络、弹性公网IP、镜像等公共服务。Region分为通用Region和专属Region，通用Region指面向公共租户提供通用云服务的Region；专属Region指只承载同一类业务或只面向特定租户提供业务服务的专用Region。详情请参见区域和可用区。可用区（AZ，Availability Zone）一个AZ是一个或多个物理数据中心的集合，有独立的风火水电，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。项目区域默认对应一个项目，这个项目由系统预置，用来隔离物理区域间的资源（计算资源、存储资源和网络资源），以默认项目为单位进行授权，用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制，可以在区域默认的项目中创建子项目，并在子项目中创建资源，然后以子项目为单位进行授权，使得用户仅能访问特定子项目中资源，使得资源的权限控制更加精确。图1 项目隔离模型父主题：使用前必读

云堡垒机 CBH 使用前必读

云堡垒机 CBH-错误码

错误码更多服务错误码请参见API错误中心。状态码错误码错误信息描述处理措施 400 CBH.10020009 请求消息格式非法请求消息格式非法请求消息格式非法 400 CBH.10020010 Request message param error. 请求消息体参数错误！请核对您的请求参数。 400 CBH.10020011 serverId错误 serverId错误 serverId错误 401 CBH.10020100 The IAM token is invalid. 无法通过IAM校验！请核对您的token是否正确。 403 CBH.10020002 Tenant has no authority. 租户无权限！该租户无权限，请去IAM确认用户权限。 500 CBH.10020000 Unknown error！未知错误！未知错误，请联系技术人员处理。父主题：附录

云堡垒机 CBH 附录

云堡垒机 CBH-获取堡垒机实例状态信息:响应参数

响应参数状态码： 200 表3 响应Body参数参数参数类型描述 name String 云堡垒机实例名称。 status String 堡垒机实例状态。 POWERING_ON：正在开启 POWERING_OFF：正在关闭 DELETE_WAITE：等待删除 REBOOTING：重启中 RESIZE：变更中 UPGRADING：升级中 FROZEN：冻结 ACTIVE：运行 server_id String 云堡垒机实例ID，使用UUID格式表示。实例ID获取方式。状态码： 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资源。

云堡垒机 CBH

云堡垒机 CBH-获取运维链接:响应参数

响应参数状态码： 200 表4 响应Body参数参数参数类型描述 state String 链接获取状态 # SUC CES S(0): 成功；非SUCCESS状态都认为获取失败，需要展示错误代码及description # IAM_USER_CONFLICT(1016): IAM用户冲突； # HOST_NOT_MANAGE(1): 查询主机未被纳管； # HOST_ACCOUNT_NOT_EXIST(553): 主机账户不可用； # IAM_USER_NO_PERMISSION(901): IAM用户无运维该主机权限； # CUR_VERSION_NOT_SUPPORT_OPERATION(9001):当前服务版本不支持; # INS_WHITE_LIST_INITIALIZING(9002):实例白名单正在初始化，请稍后重试; # UNKNOWN_ERROR(9003):未知错误; 枚举值： SUCCESS IAM_USER_CONFLICT HOST_NOT_MANAGE HOST_ACCOUNT_NOT_EXIST IAM_USER_NO_PERMISSION CUR_VERSION_NOT_SUPPORT_OPERATION INS_WHITE_LIST_INITIALIZING UNKNOWN_ERROR description String 链接获取异常时说明提示 login_url String E CS 运维登录地址状态码： 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资源。

云堡垒机 CBH

云堡垒机 CBH-获取运维链接:URI

URI GET /v2/{project_id}/cbs/instance/get-om-url 表1 路径参数参数是否必选参数类型描述 project_id 是 String 项目ID。获取方法详见API参考，附录获取项目ID。表2 Query参数参数是否必选参数类型描述 server_id 是 String 云堡垒机服务器ID ip_address 是 String 被纳管主机IP host_account_name 是 String 被纳管主机的账户

云堡垒机 CBH

云堡垒机 CBH-获取服务可用区信息:响应示例

响应示例状态码： 200 List AvailableZone Info Success { "availability_zone" : [ { "region_id" : "cn-north-4", "id" : "cn-north-4a", "type" : "Core", "display_name" : "可用区1", "status" : "Running" }, { "region_id" : "cn-north-4", "id" : "cn-north-4b", "type" : "Core", "display_name" : "可用区2", "status" : "Running" }, { "region_id" : "cn-north-4", "id" : "cn-north-4c", "type" : "Core", "display_name" : "可用区3", "status" : "Running" } ] }

云堡垒机 CBH 可用区查询

云堡垒机 CBH-获取服务可用区信息:响应参数

响应参数状态码： 200 表3 响应Body参数参数参数类型描述 availability_zone Array of AvailabilityZones objects 可用区信息表4 AvailabilityZones 参数参数类型描述 region_id String 可用区ID。 id String 可用分区ID。 display_name String 可用分区显示名称。 status String 可用分区状态。 Running：运行中 type String 可用分区类型。 Core：核心可用区 Dedicated：专属可用区，只对内部客户开放状态码： 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资源。

云堡垒机 CBH 可用区查询

云堡垒机 CBH-重启堡垒机实例:请求参数

请求参数表2 请求Header参数参数是否必选参数类型描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Token获取方法详见获取用户Token。表3 请求Body参数参数是否必选参数类型描述 server_id 是 String 云堡垒机实例ID，使用UUID格式表示。实例ID获取方式。 reboot_type 是 String 重启方式，不区分大小写。 SOFT：普通重启，关闭虚拟机服务 HARD：强制重启，重启虚拟机

云堡垒机 CBH

云堡垒机 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资源。

云堡垒机 CBH

云堡垒机 CBH-查询云堡垒机规格信息:响应示例

响应示例状态码： 200 Search Spec Info Successs [ { "data_disk_size" : 1, "ecs_system_data_size" : 10, "cpu" : 4, "connection" : 10, "resource_spec_code" : "cbh.basic.xxx", "asset" : 10, "type" : "basic", "ram" : 8 } ]

云堡垒机 CBH 规格管理

云堡垒机 CBH-查询云堡垒机规格信息:URI

URI GET /v2/{project_id}/cbs/instance/specification 表1 路径参数参数是否必选参数类型描述 project_id 是 String 项目ID。获取方法详见API参考，附录获取项目ID。表2 Query参数参数是否必选参数类型描述 action 是 String 查询云堡垒机规格当前动作。 create：查询可创建云堡垒机规格信息 update：查询可变更云堡垒机规格信息 spec_code 否 String 云堡垒机规格信息，当action为update时此字段必填。

云堡垒机 CBH 规格管理

云堡垒机 CBH-查询云堡垒机规格信息:响应参数

响应参数状态码： 200 表4 响应Body参数参数参数类型描述 [数组元素] Array of CbsGetSpecInfo objects Search Spec Info Successs 表5 CbsGetSpecInfo 参数参数类型描述 resource_spec_code String 云堡垒机规格名称。 ecs_system_data_size Integer 云堡垒机系统盘磁盘大小，单位GB。 cpu Integer 云堡垒机CPU核心数。 ram Integer 云堡垒机内存大小，单位GB。 asset Integer 云堡垒机资产数量。 connection Integer 云堡垒机最大连接数。 type String 云堡垒机规格类型。 basic：标准版 enhance：专业版 data_disk_size Number 云堡垒机数据盘大小，单位TB。状态码： 400 表6 响应Body参数参数参数类型描述 error_code String 错误码 error_description String 请求参数错误。状态码： 401 表7 响应Body参数参数参数类型描述 error_code String 错误码 error_description String 校验TOKEN失败。状态码： 403 表8 响应Body参数参数参数类型描述 error_code String 错误码 error_description String 租户无权限操作。状态码： 404 表9 响应Body参数参数参数类型描述 error_code String 错误码 error_description String 没有找到CBH资源。

云堡垒机 CBH 规格管理

云堡垒机 CBH-统计符合标签条件的实例数量:请求参数

请求参数表2 请求Header参数参数是否必选参数类型描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Token获取方法详见获取用户Token。表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字符。不校验字符集范。。

云堡垒机 CBH

云堡垒机 CBH-统计符合标签条件的实例数量:响应参数

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

云堡垒机 CBH

云堡垒机 CBH-统计符合标签条件的实例数量:请求示例

请求示例 { "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" ] } ] }

云堡垒机 CBH

云服务器内容精选

云堡垒机 CBH

7*24

备案

专业服务

退订

建议反馈

售前咨询热线