华为云用户手册

数据仓库服务 GaussDB(DWS)-查询容灾详情:响应参数

响应参数状态码： 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桶名称。

数据仓库服务 GaussDB(DWS)
数据仓库服务 GaussDB(DWS)-查询容灾恢复进度详情:响应参数

响应参数表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 当前动作结束时间。

数据仓库服务 GaussDB(DWS)
数据仓库服务 GaussDB(DWS)-查询容灾恢复进度详情:响应示例

响应示例状态码：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 }}

数据仓库服务 GaussDB(DWS)
数据仓库服务 GaussDB(DWS)-更新容灾配置:请求示例

请求示例集群容灾同步周期修改为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" }}

数据仓库服务 GaussDB(DWS)
数据仓库服务 GaussDB(DWS)-更新容灾配置:请求参数

请求参数表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 容灾状态。

数据仓库服务 GaussDB(DWS)
数据仓库服务 GaussDB(DWS)-查询可用容灾集群列表:请求示例

请求示例 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=

数据仓库服务 GaussDB(DWS)
数据仓库服务 GaussDB(DWS)-查询可用容灾集群列表:URI

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 数仓版本。

数据仓库服务 GaussDB(DWS)
数据仓库服务 GaussDB(DWS)-检查容灾名称:URI

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。

数据仓库服务 GaussDB(DWS)
数据仓库服务 GaussDB(DWS)-查询主机概览:URI

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。

数据仓库服务 GaussDB(DWS)
数据仓库服务 GaussDB(DWS)-查询主机概览:响应参数

响应参数表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)。

数据仓库服务 GaussDB(DWS)
数据仓库服务 GaussDB(DWS)-查询job进度:响应示例

响应示例状态码： 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."}

数据仓库服务 GaussDB(DWS)
数据仓库服务 GaussDB(DWS)-查询job进度:响应参数

响应参数状态码： 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 任务进度。

数据仓库服务 GaussDB(DWS)
数据仓库服务 GaussDB(DWS)-获取网卡状态:响应示例

响应示例 [ { "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 }]

数据仓库服务 GaussDB(DWS)
数据仓库服务 GaussDB(DWS)-获取网卡状态:URI

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。

数据仓库服务 GaussDB(DWS)
数据仓库服务 GaussDB(DWS)-获取网卡状态:响应参数

响应参数表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)。

数据仓库服务 GaussDB(DWS)
数据仓库服务 GaussDB(DWS)-批量添加标签:请求示例

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

数据仓库服务 GaussDB(DWS)
数据仓库服务 GaussDB(DWS)-查询资源统计信息列表:响应示例

响应示例状态码： 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" } ]}

数据仓库服务 GaussDB(DWS)
数据仓库服务 GaussDB(DWS)-批量删除标签:请求示例

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

数据仓库服务 GaussDB(DWS)
数据仓库服务 GaussDB(DWS)-查询资源统计信息列表:响应参数

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

数据仓库服务 GaussDB(DWS)
数据仓库服务 GaussDB(DWS)-快照统计信息:响应示例

响应示例状态码： 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" } ]}

数据仓库服务 GaussDB(DWS)
数据仓库服务 GaussDB(DWS)-修改运维时间窗:请求参数

请求参数表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小时。

数据仓库服务 GaussDB(DWS)
数据仓库服务 GaussDB(DWS)-修改运维时间窗:请求示例

请求示例设置集群可维护时间段（每周四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"}

数据仓库服务 GaussDB(DWS)
数据仓库服务 GaussDB(DWS)-快照统计信息:响应参数

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

数据仓库服务 GaussDB(DWS)
数据仓库服务 GaussDB(DWS)-查询历史监控数据:URI

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 第二层级。

数据仓库服务 GaussDB(DWS)
数据仓库服务 GaussDB(DWS)-查询历史监控数据:响应示例

响应示例状态码： 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 } ]} ]

数据仓库服务 GaussDB(DWS)
数据仓库服务 GaussDB(DWS)-查询历史监控数据:响应参数

响应参数状态码： 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 时间戳。

数据仓库服务 GaussDB(DWS)
数据仓库服务 GaussDB(DWS)-基本概念

基本概念帐号用户注册时的帐号，帐号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于帐号是付费主体，为了确保帐号安全，建议您不要直接使用帐号进行日常管理工作，而是创建用户并使用他们进行日常管理工作。用户由帐号在IAM中创建的用户，是云服务的使用人员，具有身份凭证（密码和访问密钥）。在我的凭证下，您可以查看帐号id和用户id。通常在调用API的鉴权过程中，您需要用到帐号、用户和密码等信息。区域指云资源所在的物理位置，同一区域内可用区间内网互通，不同区域间内网不互通。通过在不同地区创建云资源，可以将应用程序设计的更接近特定客户的要求，或满足不同地区的法律或其他要求。可用区一个可用区是一个或多个物理数据中心的集合，有独立的电力和网络，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。项目区域默认对应一个项目，这个项目由系统预置，用来隔离物理区域间的资源（计算资源、存储资源和网络资源），以默认项目为单位进行授权，用户可以访问您帐号中该区域的所有资源。如果您希望进行更加精细的权限控制，可以在区域默认的项目中创建子项目，并在子项目中申请资源，然后以子项目为单位进行授权，使得用户仅能访问特定子项目中资源，使得资源的权限控制更加精确。图1 项目隔离模型同样在我的凭证下，您可以查看项目ID。企业项目企业项目是项目的升级版，针对企业不同项目间资源的分组和管理，是逻辑隔离。企业项目中可以包含多个区域的资源，且项目中的资源可以迁入迁出。关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理服务用户指南》。父主题：使用前必读

数据仓库服务 GaussDB(DWS)
数据仓库服务 GaussDB(DWS)-权限策略和授权项:支持的授权项

支持的授权项策略包含系统策略和自定义策略，如果系统策略不满足授权要求，数据库系统管理员可以创建自定义策略，并通过给用户组授予自定义策略来进行精细的访问控制。策略支持的操作与API相对应，授权项列表说明如下：权限：允许或拒绝对指定资源在特定条件下进行某项操作。对应API接口：自定义策略实际调用的API接口。授权项：自定义策略中支持的Action，在自定义策略中的Action中写入授权项，可以实现授权项对应的权限功能。 IAM项目(Project)/企业项目(Enterprise Project)：自定义策略的授权范围，包括IAM项目与企业项目。授权范围如果同时支持IAM项目和企业项目，表示此授权项对应的自定义策略，可以在IAM和企业管理两个服务中给用户组授权并生效。如果仅支持IAM项目，不支持企业项目，表示仅能在IAM中给用户组授权并生效，如果在企业管理中授权，则该自定义策略不生效。关于IAM项目与企业项目的区别，详情请参见：IAM与企业管理的区别。 “√”表示支持，“x”表示暂不支持。 GaussDB(DWS) 支持的自定义策略授权项如下所示集群管理快照管理

数据仓库服务 GaussDB(DWS)
数据仓库服务 GaussDB(DWS)-权限策略和授权项:集群管理

集群管理权限对应API接口授权项 IAM项目 (Project) 企业项目 (Enterprise Project) 创建集群 POST /v1.0/{project_id}/clusters dws:openAPICluster:create √ √ 查询集群列表 GET /v1.0/{project_id}/clusters dws:openAPICluster:list √ √ 查询集群详情 GET /v1.0/{project_id}/clusters/{cluster_id} dws:openAPICluster:getDetail √ √ 查询节点类型 GET /v2/{project_id}/node-types dws:openAPIFlavors:get √ √ 删除集群 DELETE /v1.0/{project_id}/clusters/{cluster_id} dws:openAPICluster:delete √ √ 重启集群 POST /v1.0/{project_id}/clusters/{cluster_id}/restart dws:openAPICluster:restart √ √ 扩容集群大小 POST /v1.0/{project_id}/clusters/{cluster_id}/resize dws:cluster:scaleOutOrOpenAPIResize √ √ 重置集群管理员密码 POST /v1.0/{project_id}/clusters/{cluster_id}/reset-password dws:openAPICluster:resetPassword √ √

数据仓库服务 GaussDB(DWS)
数据仓库服务 GaussDB(DWS)-权限策略和授权项:快照管理

快照管理权限对应API接口授权项 IAM项目 (Project) 企业项目 (Enterprise Project) 创建快照 POST /v1.0/{project_id}/snapshots dws:openAPISnapshot:create √ √ 查询快照列表 GET /v1.0/{project_id}/snapshots dws:openAPISnapshot:list √ √ 查询快照详情 GET /v1.0/{project_id}/snapshots/{snapshot_id} dws:openAPISnapshot:detail √ √ 删除快照 DELETE /v1.0/{project_id}/snapshots/{snapshot_id} dws:openAPISnapshot:delete √ √ 恢复集群 POST /v1.0/{project_id}/snapshots/{snapshot_id}/actions dws:openAPISnapshot:restore √ √

数据仓库服务 GaussDB(DWS)

共100000条

undefined

意见反馈

0/200

提交取消

提交成功！非常感谢您的反馈，我们会继续努力做到更好反馈提交失败！请稍后重试！

华为云用户手册

7*24

备案

专业服务

退订

建议反馈

售前咨询热线