华为云用户手册

响应示例 状态码： 200 查询配额成功。 { "quotas" : { "resources" : [ { "type" : "instances", "used" : "3", "quota" : "100", "unit" : "null" }, { "type" : "core", "used" : "12", "quota" : "100", "unit" : "null" }, { "type" : "ram", "used" : "24", "quota" : "1000", "unit" : "GB" }, { "type" : "disk", "used" : "6", "quota" : "100", "unit" : "null" }, { "type" : "disk_capacity", "used" : "600", "quota" : "1000", "unit" : "GB" } ] }}

响应示例 { "disaster_recovery": [ { "id": "9956ee8a-2f5b-4d76-8c18-4115e2393433", "name": "test-dr-1026-3", "status": "stop_failed", "dr_type": "az", "primary_cluster_id": "f6dc1f82-8d66-4750-a5d2-569d3f72cf61", "primary_cluster_name": "dr_2", "standby_cluster_id": "fb34f3f3-f86a-446b-9f2f-e0581ba55e73", "standby_cluster_name": "dr_1", "primary_cluster_role": "primary", "standby_cluster_role": "standby", "primary_cluster_status": "waiting", "standby_cluster_status": "waiting", "primary_cluster_region": "cn-north-7", "standby_cluster_region": "cn-north-7", "primary_cluster_project_id": "0536cdee2200d5912f7cc00b877980f1", "standby_cluster_project_id": "0536cdee2200d5912f7cc00b877980f1", "last_disaster_time": "2022-10-28T02:34:16", "start_time": null, "create_time": "2022-10-26T12:04:10" }, { "id": "a85dee93-cd49-4c52-a44b-c50b24f6caae", "name": "test_dis", "status": "creating", "dr_type": "az", "primary_cluster_id": "3ef5daaa-d017-4354-80b3-8a69caf2e094", "primary_cluster_name": "t1031_02", "standby_cluster_id": "a07cb2f7-b17e-4d95-923b-a33d0c884d37", "standby_cluster_name": "t1028_02", "primary_cluster_role": "primary", "standby_cluster_role": "standby", "primary_cluster_status": null, "standby_cluster_status": null, "primary_cluster_region": "cn-north-7", "standby_cluster_region": "cn-north-7", "primary_cluster_project_id": "0536cdee2200d5912f7cc00b877980f1", "standby_cluster_project_id": "0536cdee2200d5912f7cc00b877980f1", "last_disaster_time": null, "start_time": null, "create_time": "2022-10-31T06:17:00" } ]}

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 disaster_recovery Array of DisasterRecovery objects 容灾列表。 表3 DisasterRecovery 参数 参数类型 描述 id String 容灾ID。 name String 容灾名称。 dr_type String 容灾类型。 status String 容灾状态。 primary_cluster_id String 主集群ID。 primary_cluster_name String 主集群名称。 standby_cluster_id String 备集群ID。 standby_cluster_name String 备集群名称。 primary_cluster_role String 主集群角色。 standby_cluster_role String 备集群角色。 primary_cluster_status String 主集群状态。 standby_cluster_status String 备集群状态。 primary_cluster_region String 主集群region。 standby_cluster_region String 备集群region。 primary_cluster_project_id String 主集群项目ID。 standby_cluster_project_id String 备集群项目ID。 last_disaster_time String 最后一次容灾同步时间。 start_time String 启动时间。 create_time String 创建时间。

响应示例 状态码： 200 容灾信息查询成功。 { "disaster_recovery": { "id": "b303b78d-438c-41dd-aaf6-c98eea1fc2a6", "name": "dws-it-02", "status": "running", "dr_type": "region", "primary_cluster": { "id": "3de21046-e65e-4fcf-86bf-583115b39c27", "name": "dws-203-primary", "cluster_az": "cn-north-7c", "role": "primary", "region": "cn-north-7", "status": "waiting", "progress": "100", "last_success_time": "2023-04-29T06:39:56", "obs_bucket_name": null }, "standby_cluster": { "id": "5d946c51-9ffa-49e3-9129-2bea4d23d3fd", "name": "dws-205-standby", "cluster_az": null, "role": "standby", "region": "cn-north-208", "status": "waiting", "progress": "100", "last_success_time": "2023-04-29T06:39:56", "obs_bucket_name": null }, "dr_sync_period": "3H", "start_time": "2023-04-28T09:23:38", "create_time": "2023-04-28T08:51:54" } }

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 disaster_recovery DisasterRecoveryQueryResp object 查询容灾信息返回体。 表3 DisasterRecoveryQueryResp 参数 参数类型 描述 id String 容灾ID。 name String 容灾名称。 dr_type String 容灾类型。 status String 容灾状态。 primary_cluster DisasterRecoveryCluster object 主集群信息。 standby_cluster DisasterRecoveryCluster object 备集群信息。 dr_sync_period String 容灾同步周期。 start_time String 容灾启动时间。 create_time String 容灾创建时间。 表4 DisasterRecoveryCluster 参数 参数类型 描述 id String 容灾集群信息ID。 name String 容灾集群名称。 cluster_az String 容灾集群所在AZ。 role String 容灾集群角色。 region String 容灾集群所在Region。 status String 容灾集群状态。 progress String 容灾进度。 last_success_time String 上一次容灾时间。 obs_bucket_name String OBS桶名称。

响应参数 表2 响应Body参数 参数 参数类型 描述 disaster_recovery_progress ClusterDisasterRecovery Object 集群容灾恢复详情。 表3 ClusterDisasterRecovery 参数 参数类型 描述 primary_cluster ClusterRecoveryProgress Object 主集群容灾进度详情。 standby_cluster ClusterRecoveryProgress Object 备集群容灾进度详情。 latest_barrier_time String 灾难发生时间。 last_recovery_spend Long 上一个备份集恢复消耗时间，单位：s。 recovery_point_object Long 数据恢复目标时间，单位：s。 recovery_time_object Long 服务恢复目标时间，单位：s。 表4 ClusterRecoveryProgress 参数 参数类型 描述 key String 本次备份恢复ID。 action_type String 动作类型。 unrestore_keys String 待恢复的备份集ID。 action_start_time String 当前动作开始时间。 action_end_time String 当前动作结束时间。

响应示例 状态码：200 查询集群容灾恢复详情成功。 { "disaster_recovery_progress":{ "primary_cluster": { "key": "20230327_201637", "action_type": "Backup", "unrestore_keys": "N/A", "action_start_time": "2023-03-27 20:16:34", "action_end_time": "2023-03-27 20:17:00" }, "standby_cluster": { "key": "20230327_201637", "action_type": "Restore", "unrestore_keys": "20230327_201637,20230327_201638,20230327_201639", "action_start_time": "2023-03-27 20:18:27", "action_end_time": "2023-03-27 20:24:40" }, "latest_barrier_time": "2023-03-28 10:24:40", "last_recovery_spend": 30, "recovery_point_object": 50886, "recovery_time_object": 600 }}

请求示例 集群容灾同步周期修改为3H，主集群为primary，备集群为standby，容灾动作设为DR_RUNNING： https://{Endpoint}/v2/0536cdee2200d5912f7cc00b877980f1/disaster-recovery/b303b78d-438c-41dd-aaf6-c98eea1fc2a6{ "disaster_recovery" : { "dr_sync_period" : "3H", "send_request" : 0, "primary_to_role" : "primary", "standby_to_role" : "standby", "reset_action" : "DR_RUNNING", "dr_status" : "running" }}

请求示例 https://{Endpoint}/v2/0536cdee2200d5912f7cc00b877980f1/disaster-recovery-clusters?primary_cluster_id=3de21046-e65e-4fcf-86bf-583115b39c27&standby_az_code=cn-north-7a&standby_region=&dr_type=&standby_project_id=

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 disaster_recovery 否 UpdateDisasterRecoveryReq object 容灾配置信息。 表3 UpdateDisasterRecoveryReq 参数 是否必选 参数类型 描述 dr_sync_period 否 String 容灾同步周期。 send_request 否 Integer 是否发送请求。 最小值：0 最大值：1 primary_to_role 否 String 主集群角色。 reset_action 否 String 设置容灾动作。 standby_to_role 否 String 备集群角色。 dr_status 否 String 容灾状态。

URI GET /v2/{project_id}/disaster-recovery-clusters 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法，请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 primary_cluster_id 是 String 主集群ID。 primary_spec_id 否 String 主集群规格ID。 primary_cluster_dn_num 否 String 主集群DN数量。 standby_region 否 String 备集群所在Region。 standby_project_id 否 String 备集群项目ID。 standby_az_code 是 String 备集群所在AZ。 dr_type 否 String 容灾类型。 datastore_type 否 String 数仓类型。 datastore_version 否 String 数仓版本。

URI GET /v2/{project_id}/disaster-recovery/check-name 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法，请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 dr_name 是 String 容灾名称。 type 否 String 容灾类型。 standby_region 否 String 备集群所在Region。 standby_project_id 否 String 备集群所在项目ID。

响应参数 表3 响应Body参数 参数 参数类型 描述 [数组元素] Array of HostOverviewResponse objects 主机概览列表。 表4 HostOverviewResponse 参数 参数类型 描述 instance_name String 实例名称 host_name String 主机名称 host_stat String 主机状态，其中包括： ONLINE：在线 OFFLINE：离线 work_ip String IP地址。 mem_free double 系统中未使用的内存(GB)。 mem_total double 总内存(GB)。 mem_usage double 内存使用率(GB)。 mem_cached double 缓存内存(GB)。 mem_buffer double 缓冲内存(MB)。 swap_free double ram暂存在swap中的大小(GB)。 swap_total double 交换空间总和(GB)。 cpu_usage double CPU使用率(%)。 cpu_usage_sys double 系统CPU占用率(%)。 cpu_usage_usr double 用户CPU占用率(%)。 cpu_idle double 空闲CPU占用率(%)。 cpu_iowait double IO等待(%)。 disk_usage_avg double 磁盘平均使用率(%)。 disk_total double 磁盘总容量(GB)。 disk_used double 磁盘使用容量(GB)。 disk_available double 磁盘可用容量(GB)。 disk_io double 磁盘IO(KB/s)。 disk_io_read double 磁盘读速率(KB/s)。 disk_io_write double 磁盘写速率(KB/s)。 tcp_resend_rate double TCP协议栈重传率(%)。 net_io double 网络IO(KB/s)。

URI GET /v1.0/{project_id}/dms/host-overview 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法，请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 cluster_id 否 String 集群ID。获取方法，请参见获取集群ID。 instance_name 否 String 实例名称。 limit 是 Integer 数据条目数。取值范围为1~2147483647。 offset 是 Integer 数据偏移量。取值范围为0~2147483646。

响应示例 状态码： 200 任务进度 { "status" : "FAIL", "progress" : "9%", "job_id" : "2c9080e88459fa44018459fbeb600001", "job_name" : "ecfClusterElbCreateJob", "begin_time" : "2022-11-09T20:25:00", "end_time" : "2022-11-09T20:30:00", "failed_code" : "CreateELBTask-fail:DWS.0114", "failed_detail" : "DWS.0114:ELB private IP is not configured."}

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 job_id String 任务ID。 job_name String 任务名称。 begin_time String 任务开始时间。 end_time String 任务结束时间。 status String 任务当前状态。 failed_code String 任务失败错误码。 failed_detail String 任务失败错误详情。 progress String 任务进度。

URI GET /v1.0/{project_id}/dms/net 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法，请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 cluster_id 否 String 集群ID。获取方法，请参见获取集群ID。 instance_name 否 String 实例名称。 limit 是 Integer 数据条目数。取值范围为1~2147483647。 offset 是 Integer 数据偏移量。取值范围为0~2147483646。

响应参数 表3 响应Body参数 参数 参数类型 描述 [数组元素] Array of NetResp objects 主机网卡列表。 表4 NetResp 参数 参数类型 描述 virtual_cluster_id Integer 虚拟集群ID。 ctime Long 查询时间。 host_id Integer 主机ID。 host_name String 主机名称。 instance_name String 实例名称。 interface_name String 网卡名称。 up Boolean 网卡状态（true代表up/false代表down）。 speed Long 网卡速度(Mbps)。 recv_packets Long 接收包数(个)。 send_packets Long 发送包数(个)。 recv_drop Long 接收丢包数(个)。 recv_rate Double 接收速率(KB/s)。 send_rate Double 发送速率(KB/s)。 io_rate Double 网络速率(KB/s)。

响应示例 [ { "virtual_cluster_id": 23, "ctime": 1668071223000, "host_id": 34, "host_name": "host-172-16-11-62", "instance_name": "d30035376-dms-test07-dws-cn-cn-1-1", "interface_name": "eth2", "up": true, "speed": -1, "recv_packets": 490595835, "send_packets": 533376765, "recv_drop": 0, "recv_rate": 16.35, "send_rate": 11.71, "io_rate": null }]

请求示例 批量添加键为key，值为value的标签： POST https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/b5c45780-1006-49e3-b2d5-b3229975bbc7/tags/batch-create{ "tags": [ { "key": "key", "value": "value" } ]}

响应示例 状态码： 200 查询资源数量成功。 { "statistics" : [ { "name" : "cluster.total", "value" : 3, "unit" : null }, { "name" : "cluster.normal", "value" : 3, "unit" : null }, { "name" : "instance.total", "value" : 9, "unit" : null }, { "name" : "instance.normal", "value" : 9, "unit" : null }, { "name" : "storage.total", "value" : 1800, "unit" : "GB" } ]}

请求示例 批量删除键为key，值为value的标签： POST https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/b5c45780-1006-49e3-b2d5-b3229975bbc7/tags/batch-delete{ "tags": [ { "key": "key", "value": "value" } ]}

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 statistics Array of Statistic objects 资源数量信息列表。 表3 Statistic 参数 参数类型 描述 name String 资源名称。 cluster.total：总集群（个）。 cluster.normal：可用集群（个）。 instance.total：总节点（个）。 instance.normal：可用节点（个）。 storage.total：总容量（GB）。 value Double 资源数量值。 unit String 资源数量单位。

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 day 是 String 日期，范围：Mon、Tue、Wed、Thu、Fri、Sat、Sun。 start_time 是 String 开始时间，UTC时间，格式为HH:mm，例如：22:00。 说明： 时间必须是整点。 开始时间和结束时间必须间隔4小时。 end_time 是 String 结束时间，UTC时间，格式为HH:mm，例如：02:00。 说明： 时间必须是整点。 开始时间和结束时间必须间隔4小时。

请求示例 设置集群可维护时间段（每周四22:00~02:00）： PUT https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/b5c45780-1006-49e3-b2d5-b3229975bbc7/maintenance-window{ "day" : "Thu", "start_time" : "22:00", "end_time" : "02:00"}

响应示例 状态码： 200 查询快照统计信息成功。 { "statistics" : [ { "name" : "storage.free", "value" : 300.0, "unit" : "GB" }, { "name" : "storage.paid", "value" : 0, "unit" : "GB" }, { "name" : "storage.used", "value" : 128.5, "unit" : "GB" } ]}

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 statistics Array of SnapshotsStatistic objects 快照统计信息。 表3 SnapshotsStatistic 参数 参数类型 描述 name String 资源统计信息名称。 storage.free：免费容量。 storage.paid：付费容量。 storage.used：已用容量。 value Number 资源统计信息值。 unit String 资源统计信息单位。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 [数组元素] Array of TrendQueryDataResponseBody objects 历史监控数据列表。 表4 TrendQueryDataResponseBody 参数 参数类型 描述 query_time Long 查询时间。 indicator_name String 监控指标名称。 object_id String 监控对象id。 unit String 单位。 sub_object_id String 次级监控id。 data_points Array of TrendQueryData objects 节点数据。 表5 TrendQueryData 参数 参数类型 描述 result String 查询结果。 timestamp Long 时间戳。

响应示例 状态码： 200 [ { "query_time" : 1671160536504, "indicator_name" : "cluster cpu_usage", "object_id" : "fe658e95-5284-4adf-b6aa-7729b563dcb7", "unit" : "percentage", "data_points" : [ { "result" : "10.20", "timestamp" : 1671058114000 }, { "result" : "10.20", "timestamp" : 1671058144000 } ]}, { "query_time" : 1671160536504, "indicator_name" : "cluster cpu_mem", "object_id" : "fe658e95-5284-4adf-b6aa-7729b563dcb7", "unit" : "percentage", "data_points" : [ { "result" : "10.20", "timestamp" : 1671058114000 }, { "result" : "10.20", "timestamp" : 1671058144000 } ]} ]

URI GET /v1.0/{project_id}/dms/metric-data 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法，请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 from 是 String 开始时间。 to 是 String 结束时间。 function 否 String 取值方法。 period 否 String 取值周期。 indicator_name 是 String 监控指标名称。 dim0 是 String 第一层级。 dim1 否 String 第二层级。