华为云用户手册

前提条件 已配置DNS和安全组，配置方法参考如何配置DNS和安全组？。 已配置委托，配置方法参考如何配置委托？。 确保操作步骤中的安装目录都有读写权限，安装用户为root，并且安装成功后的Telescope进程不会被其他软件关闭。 确保已下载Agent安装脚本，获取脚本的方式如下： 表1 获取Linux镜像的Agent安装脚本 区域 regionID 下载路径 华北-北京一 cn-north-1 https://obs.cn-north-1.myhuaweicloud.com/uniagent-cn-north-1/package/agent_install.sh 华北-北京四 cn-north-4 https://obs.cn-north-4.myhuaweicloud.com/uniagent-cn-north-4/package/agent_install.sh 华北-乌兰察布一 cn-north-9 https://obs.cn-north-9.myhuaweicloud.com/uniagent-cn-north-9/package/agent_install.sh 华南-广州 cn-south-1 https://obs.cn-south-1.myhuaweicloud.com/uniagent-cn-south-1/package/agent_install.sh 华南-广州-友好用户环境 cn-south-4 https://telescope-cn-south-4.obs.cn-south-4.myhuaweicloud.com/scripts/agentInstall.sh 华南-深圳 cn-south-2 https://obs.cn-south-2.myhuaweicloud.com/uniagent-cn-south-2/package/agent_install.sh 华东-上海一 cn-east-3 https://obs.cn-east-3.myhuaweicloud.com/uniagent-cn-east-3/package/agent_install.sh 华东-上海二 cn-east-2 https://obs.cn-east-2.myhuaweicloud.com/uniagent-cn-east-2/package/agent_install.sh 西南-贵阳一 cn-southwest-2 https://obs.cn-southwest-2.myhuaweicloud.com/uniagent-cn-southwest-2/package/agent_install.sh 中国-香港 ap-southeast-1 https://obs.ap-southeast-1.myhuaweicloud.com/uniagent-ap-southeast-1/package/agent_install.sh 亚太-曼谷 ap-southeast-2 https://obs.ap-southeast-2.myhuaweicloud.com/uniagent-ap-southeast-2/package/agent_install.sh 亚太-新加坡 ap-southeast-3 https://obs.ap-southeast-3.myhuaweicloud.com/uniagent-ap-southeast-3/package/agent_install.sh 亚太-雅加达 ap-southeast-4 https://obs.ap-southeast-4.myhuaweicloud.com/uniagent-ap-southeast-4/package/agent_install.sh 非洲-约翰内斯堡 af-south-1 https://obs.af-south-1.myhuaweicloud.com/uniagent-af-south-1/package/agent_install.sh 拉美-圣地亚哥 la-south-2 https://obs.la-south-2.myhuaweicloud.com/uniagent-la-south-2/package/agent_install.sh 拉美-圣保罗一 sa-brazil-1 https://telescope-sa-brazil-1.obs.myhuaweicloud.com/scripts/agentInstall.sh 拉美-墨西哥城一 na-mexico-1 https://telescope-na-mexico-1.obs.myhuaweicloud.com/scripts/agentInstall.sh 拉美-墨西哥城二 la-north-2 https://uniagent-la-north-2.obs.la-north-2.myhuaweicloud.com/package/agent_install.sh 中东-利雅得 me-east-1 https://uniagent-me-east-1.obs.me-east-1.myhuaweicloud.com/package/agent_install.sh

按自定义时间范围查看监控指标 监控指标可快捷选择显示“近1小时”、“近3小时”、“近12小时”、“近24小时”、“近7天”的数据，如果您想要看近2小时或者某自定义时间范围的指标时可以使用拖动选择自定义时间范围功能。 按自定义时间范围查看监控指标详情：单击监控视图详情右侧的第一个图标，如图3所示。拖动选择所查看的时间范围，系统自动展示所选时间范围内的监控数据。 图3 自定义时间范围 退出自定义时间范围监控指标详情：单击监控视图详情右侧的第二个图标，如图4所示，系统会重置选择的时间范围。 图4 退出自定义时间范围

选择监控对象查看监控指标 为了对比各资源的某项监控指标，您可以将多个资源的监控指标集中到一个监控视图中。但是当资源较多时，如只想对比其中的部分资源的指标数据，那么可以使用选择监控对象功能。 选择监控对象：默认按照资源名称选择监控对象，如图5所示。也可以按照资源ID、指标名称、资源类型来选择监控对象。系统自动显示您选择的监控对象数据，其他监控数据则会隐藏起来。 图5 选择监控对象 清空监控对象：单击监控视图搜索框的“”来清空选择的监控对象。 图6 清空监控对象

应用场景 在云监控服务中，仅需登录一个账号就可以查看所在组织（Organization）下所有账号的看板。 目前只有“我的看板”提供跨账号功能，且只能查看，不能编辑。 该功能当前在华南-广州-友好用户环境、土耳其-伊斯坦布尔、西南-贵阳一、乌兰察布-汽车一、拉美-墨西哥城一、亚太-新加坡、非洲-约翰内斯堡、亚太-曼谷、中国-香港、拉美-墨西哥城二、亚太-雅加达、华南-广州、华北-北京一、华北-乌兰察布一、华北-北京四、拉美-圣地亚哥、华东-上海一、拉美-圣保罗一、中东-利雅得和华东-青岛区域开放。

操作步骤 使用具有“管理员”权限的账号（例如，administrator）登录Windows弹性云服务器。 在浏览器地址栏输入表1中的下载路径，下载并保存安装包。 创建安装包存放目录，如“D:\Agent”。 如果安装包是telescope_windows_amd64.zip，解压zip安装包后双击执行“install.bat”脚本，安装启动Agent。 如果安装包是“install_amd64.exe”，则使用powershell执行如下命令： D:\Agent\install_amd64.exe -t ${version} 将${version}替换成Agent版本特性中的版本。例如，在北京一替换后，对应的安装命令为： D:\Agent\install_amd64.exe -t 2.5.6 Agent插件配置完成后，因监控数据暂未上报，插件状态仍显示“未安装”，等待3-5分钟，刷新即可。

前提条件 已配置DNS和安全组，配置方法参考如何配置DNS和安全组？。 已配置委托，配置方法参考如何配置委托？。 使用具有administrator权限的账户安装，例如administrator用户，并且确保安装成功后的Telescope进程不会被其他软件关闭。 已获取Agent安装包，格式为exe/zip，安装包获取方式如下。 表1 获取Windows镜像的Agent安装包 区域 regionID 下载路径 华北-北京一 cn-north-1 https://obs.cn-north-1.myhuaweicloud.com/uniagent-cn-north-1/package/install_amd64.exe 华北-北京四 cn-north-4 https://obs.cn-north-4.myhuaweicloud.com/uniagent-cn-north-4/package/install_amd64.exe 华北-乌兰察布一 cn-north-9 http://obs.cn-north-9.myhuaweicloud.com/uniagent-cn-north-9/package/install_amd64.exe 西南-贵阳一 cn-southwest-2 https://obs.cn-southwest-2.myhuaweicloud.com/uniagent-cn-southwest-2/package/install_amd64.exe 华南-广州 cn-south-1 https://obs.cn-south-1.myhuaweicloud.com/uniagent-cn-south-1/package/install_amd64.exe 华南-广州-友好用户环境 cn-south-4 https://telescope-cn-south-4.obs.cn-south-4.myhuaweicloud.com/agent/telescope_windows_amd64.zip 华南-深圳 cn-south-2 https://obs.cn-south-2.myhuaweicloud.com/uniagent-cn-south-2/package/install_amd64.exe 华东-上海二 cn-east-2 https://obs.cn-east-2.myhuaweicloud.com/uniagent-cn-east-2/package/install_amd64.exe 华东-上海一 cn-east-3 https://obs.cn-east-3.myhuaweicloud.com/uniagent-cn-east-3/package/install_amd64.exe 中国-香港 ap-southeast-1 https://obs.ap-southeast-1.myhuaweicloud.com/uniagent-ap-southeast-1/package/install_amd64.exe 亚太-曼谷 ap-southeast-2 https://obs.ap-southeast-2.myhuaweicloud.com/uniagent-ap-southeast-2/package/install_amd64.exe 亚太-新加坡 ap-southeast-3 https://obs.ap-southeast-3.myhuaweicloud.com/uniagent-ap-southeast-3/package/install_amd64.exe 亚太-雅加达 ap-southeast-4 https://obs.ap-southeast-4.myhuaweicloud.com/uniagent-ap-southeast-4/package/install_amd64.exe 非洲-约翰内斯堡 af-south-1 https://obs.af-south-1.myhuaweicloud.com/uniagent-af-south-1/package/install_amd64.exe 拉美-圣地亚哥 la-south-2 https://uniagent-la-south-2.obs.la-south-2.myhuaweicloud.com/package/install_amd64.exe 拉美-圣保罗一 sa-brazil-1 https://telescope-sa-brazil-1.obs.sa-brazil-1.myhuaweicloud.com/agent/telescope_windows_amd64.zip 拉美-墨西哥城一 na-mexico-1 https://telescope-na-mexico-1.obs.myhuaweicloud.com/agent/telescope_windows_amd64.zip 拉美-墨西哥城二 la-north-2 https://uniagent-la-north-2.obs.la-north-2.myhuaweicloud.com/package/install_amd64.exe 中东-利雅得 me-east-1 https://uniagent-me-east-1.obs.me-east-1.myhuaweicloud.com/package/install_amd64.exe

管理Agent（Linux） 查看、启动、停止、更新和卸载Agent需使用root用户。 查看Agent版本 使用root账号，登录主机。 执行如下命令，确认使用Agent的版本。 if [[ -f /usr/local/uniagent/extension/install/telescope/bin/telescope ]]; then /usr/local/uniagent/extension/install/telescope/bin/telescope -v; elif [[ -f /usr/local/telescope/bin/telescope ]]; then echo "old agent"; else echo 0; fi 返回“old agent”，表示使用老版本Agent，请参考老版本操作指令。 返回版本号，表示使用新版本Agent，请参考新版本操作指令。 返回“0”，表示未安装Agent。 查看Agent状态（新版本） 以root用户登录主机，执行以下命令，查看Agent状态。 /usr/local/uniagent/extension/install/telescope/telescoped status 当系统返回以下内容，则表示Agent为正常运行状态。 "Telescope process is running well." 启动Agent（新版本） 执行以下命令，启动Agent。 /usr/local/uniagent/extension/install/telescope/telescoped start 重启Agent（新版本） 执行以下命令查看telescope的PID。 /usr/local/uniagent/extension/install/telescope/telescoped restart 图1 重启Agent 停止Agent（新版本） 登录主机，执行以下命令，停止Agent。 service uniagent stop /usr/local/uniagent/extension/install/telescope/telescoped stop 卸载Agent（新版本） 执行以下命令，即可卸载Agent。 bash /usr/local/uniagent/script/uninstall.sh 用户可手动卸载Agent插件，卸载后云监控服务将不再主动采集主机的监控数据。如需再次使用，请参考操作步骤或操作步骤重新安装。 查看Agent状态（老版本） 以root用户登录ECS或BMS，执行以下命令，查看Agent状态。 service telescoped status 当系统返回以下内容，则表示Agent为正常运行状态。 "Active（running）"或"Telescope process is running well." 启动Agent（老版本） 执行以下命令，启动Agent。 /usr/local/telescope/telescoped start 重启Agent（老版本） 执行以下命令，重启Agent。 /usr/local/telescope/telescoped restart 停止Agent（老版本） 登录ECS或BMS，执行以下命令，停止Agent。 service telescoped stop 如果Telescope安装失败，可能会导致无法正常停止Agent，可通过执行以下命令进一步尝试； /usr/local/telescope/telescoped stop 卸载Agent（老版本） 执行以下命令，即可卸载Agent。 /usr/local/telescope/uninstall.sh 用户可手动卸载Agent插件，卸载后云监控服务将不再主动采集主机的监控数据。如需再次使用，请参考操作步骤或操作步骤重新安装。

管理Agent（Windows） 老版本Agent默认安装路径为“C:\Program Files\telescope”。 查看Agent状态 在任务管理器中查名为telescope的进程状态。 启动Agent 在Agent安装包存放目录（“C:\Program Files\telescope”）下，双击执行start.bat脚本，启动Agent。 停止Agent 在Agent安装包存放目录（“C:\Program Files\telescope”）下，双击执行shutdown.bat脚本，停止Agent。 卸载Agent 在Agent安装包存放目录（“C:\Program Files\telescope”）下，双击执行uninstall.bat脚本，卸载Agent。 Agent默认安装路径为“C:\Program Files\uniagent\extension\install\telescope”. 查看Agent状态 在任务管理器中查名为telescope的进程状态。 启动Agent 在Agent安装包存放目录（“C:\Program Files\uniagent\extension\install\telescope”）下，双击执行start.bat脚本，启动Agent。 停止Agent 在Agent安装包存放目录（“C:\Program Files\uniagent\extension\install\telescope”）下，双击执行shutdown.bat脚本，停止Agent。 卸载Agent 在Agent安装包存放目录（“C:\Program Files\uniagent\extension\install\telescope”）下，双击执行uninstall.bat脚本，卸载Agent。

响应参数 状态码： 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 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" : "CS2308171141G8C14", "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 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" } ] }

响应参数 状态码： 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资源。

响应参数 状态码： 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的值）。 可参考"IAM获取IAM用户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参数 参数 参数类型 描述 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”

响应参数 状态码： 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资源。

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

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

响应参数 状态码： 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资源。

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 表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资源。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 quota Integer 云堡垒机实例最大创建数量。 quota_used Integer 当前云堡垒机实例创建个数。 状态码： 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资源。

请求示例 { "specification" : "cbh.basic.50", "instance_name" : "CBH-155f", "password" : "1xxx6xxxx", "region" : "cn-north-4", "availability_zone" : "cn-north-4a", "slave_availability_zone" : "cn-north-4a", "charging_mode" : 0, "period_type" : 2, "period_num" : 1, "is_auto_renew" : 0, "is_auto_pay" : 0, "ipv6_enable" : false, "enterprise_project_id" : "0", "attach_disk_size" : 1, "tags" : [ { "key" : "key", "value" : "value" } ], "network" : { "vpc_id" : "279e8217-xxxx-4d83-xxxx-b8f14d47170b", "subnet_id" : "a86217e6-xxxx-4803-xxxx-b57da681xxxx", "private_ip" : { "ip" : "123.xxx.41.xx", "slave_ip" : "123.xxx.41.xx", "floating_ip" : "123.xxx.41.xx" }, "public_ip" : { "id" : "cfcab481-xxxx-4e23-xxxx-d6cdd0efxxxx", "public_eip" : "123.xxx.41.xx" }, "security_groups" : [ { "id" : "1e10bc4f-xxxx-4452-xxxx-8ddb4348xxx" } ] } }

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 可参考"IAM获取IAM用户Token"获取 表3 请求Body参数 参数 是否必选 参数类型 描述 specification 是 String 待创建云堡垒机规格ID，例如： cbh.basic.50 cbh.enhance.50 可参考接口"查询云堡垒机规格信息"获取。 instance_name 是 String 云堡垒机实例名称，取值范围： 只能由中文字符、英文字母、数字及“_”、“-”组成，且长度为[1-64]个字符。 例如：CBH-6b8e password 是 String 堡垒机实例前端登录密码。 密码规则：8-32位,不能包含amdin或nidma及其大写形式,必须包含大小写数字特殊字符四种类型中的三种。 region 是 String 创建云堡垒机实例所在局点ID。 可参考接口"查询云堡垒机规格信息"获取 availability_zone 是 String 创建云堡垒机所在的可用分区，需要指定可用分区名称。(主备模式是作为主机可用区) 可参考接口"获取服务可用区"获取 slave_availability_zone 否 String 创建云堡垒机备机所在的可用分区，需要指定可用分区名称。(只创建单机时不传此字段)。 可参考接口"获取服务可用区"获取 charging_mode 是 Integer 计费模式。 0 包周期计费。 period_type 否 Integer 订购周期类型。（包周期模式必传） 2：月 3：年 period_num 否 Integer 订购周期数。（包周期模式必传） period_type=2（周期类型为月），取值范围[1，9] periodType=3（周期类型为年），取值范围[1，10] is_auto_renew 否 Integer 是否自动续订。 1，自动续订 0，不自动续订 默认值为“0” is_auto_pay 否 Integer 是否自动支付，下单订购后，是否自动从客户的华为云账户中支付，而不需要客户手动去进行支付。 1：是（会自动选择折扣和优惠券进行优惠，然后自动从客户华为云账户中支付），自动支付失败后会生成订单成功(该订单应付金额是优惠后金额)、但订单状态为“待支付”，等待客户手动支付(手动支付时，客户还可以修改系统自动选择的折扣和优惠券) 0：否（需要客户手动去支付，客户可以选择折扣和优惠券。） 默认值为“0” network 是 NetworkInfoCreate object 切换云堡垒机实例vpc所需网络信息。 ipv6_enable 否 Boolean 云堡垒机实例是否支持IPV6。 默认值为“false”。 enterprise_project_id 否 String 企业项目ID。 默认值为“0”。 attach_disk_size 否 Integer 附加磁盘大小。单位TB 说明： 说明： 附加磁盘和规格自带磁盘大小合起来不能超过300TB。 tags 否 Array of ResourceTag objects 标签信息。 表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地址。 表8 ResourceTag 参数 是否必选 参数类型 描述 key 是 String 键。最大长度128个字符。 key需要满足3.1 KEY字符集规范。 value 是 String 值。每个值最大长度255个字符， value需要满足3.2 VALUE字符集规范。

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