华为云用户手册

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 type 是 String 对象类型。 is_grant 是 Boolean 是否授权操作。 grant_list 否 Array of Grant objects 授权列表。 revoke_list 否 Array of Revoke objects 撤销权限列表。 role_list 是 Array of strings 被授权角色列表。 object_list 是 Array of strings 权限所属对象列表。 cascade 否 Boolean 撤销权限是否级联撤销，默认为true。 database 是 String 数据库名称。 schema 否 String 模式名称。 table 否 String 表名。 表3 Grant 参数 是否必选 参数类型 描述 permission 是 String 权限名称，权限名称必须是大写。 grant_with 是 Boolean 是否包含授权选项。 表4 Revoke 参数 是否必选 参数类型 描述 permission 是 String 权限名称，权限名称必须是大写。 revoke_with 是 Boolean 是否仅移除授权选项。

请求示例 修改集群ID为“a89aea88-7ea2-40bd-8ac8-8b93e169e5d6”的数据库对象权限，即对gaussdb数据库下表table1和table2进行“SELECT”授权，授权角色为user1和user2，模式为public： POST https://{Endpoint}/v1/0536cdee2200d5912f7cc00b877980f1/clusters/a89aea88-7ea2-40bd-8ac8-8b93e169e5d6/db-manager/authority{ "type" : "table", "is_grant" : true, "grant_list" : [ { "permission" : "SELECT", "grant_with" : true } ], "role_list" : [ "user1", "user2" ], "object_list" : [ "table1", "table2" ], "database" : "gaussdb", "schema" : "public"}

响应示例 状态码： 200 用户详细信息 { "login" : true, "createrole" : true, "createdb" : true, "systemadmin" : false, "auditadmin" : false, "inherit" : false, "useft" : true, "conn_limit" : -1, "replication" : false, "valid_begin" : 1681971166000, "valid_until" : 1681971166000, "lock" : false}

响应示例 状态码： 200 openapi获取监控指标成功 [ { "indicator_name" : "cluster.cpu_usage", "plugin_name" : "CpuStat", "default_collect_rate" : "30", "support_datastore_version" : "8.0.0"}, { "indicator_name" : "cluster.sql_probe_single", "plugin_name" : "SqlProbeTask", "default_collect_rate" : "30", "support_datastore_version" : "8.0.0"} ]

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 login Boolean 是否可以登录。 createrole Boolean 创建角色权限。 createdb Boolean 创建数据库权限。 systemadmin Boolean 系统管理员。 auditadmin Boolean 审计管理员。 inherit Boolean 继承所在组权限。 useft Boolean 访问外表权限。 conn_limit Integer 连接数限制。 replication Boolean 是否允许流复制。 valid_begin Long 角色生效时间。 valid_until Long 角色过期时间。 lock Boolean 是否锁定。

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 [数组元素] Array of IndicatorInfo objects 监控指标列表。 表3 IndicatorInfo 参数 参数类型 描述 indicator_name String 监控指标名称。 plugin_name String 采集模块名称。 default_collect_rate String 默认采集频率 。 support_datastore_version String 支持的集群版本 。

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 workload_queue 是 WorkloadQueue object 资源池对象。 表3 WorkloadQueue 参数 是否必选 参数类型 描述 workload_queue_name 是 String 资源池名称。以小写字母开头，只包含小写字母、数字、下划线(_)，长度3-28个字符。 logical_cluster_name 否 String 逻辑集群名称。 workload_resource_item_list 是 Array of WorkloadResource objects 资源配置队列。 表4 WorkloadResource 参数 是否必选 参数类型 描述 resource_name 是 String 资源名称。 memory：内存资源（%） tablespace：存储资源（MB） activestatements：查询并发 cpu_limit：专属限额 cpu_share：共享配额 说明： 添加资源池时，所有的资源类型都要填写。其中cpu_limit 仅限在8.1.3以上集群支持。 resource_value 是 Integer 资源属性值。 memory 取值0 ~ 100，其中0表示不管控。 tablespace 取值-1 ~ 2147483647，其中-1表示不限制，注：该值取值应参考实际存储资源。 activestatements 取值-1 ~ 2147483647 其中-1/0表示不限制。 cpu_limit 取值0~99。与cpu_share 互斥，如cpu_limit 大于0则cpu_share 需填0。 cpu_share 取值0~99。与cpu_limit 互斥，如cpu_share 大于0则cpu_limit 需填0。

请求示例 添加资源池test11，选择共享配额设为12%，内存资源设为0（不限制），存储资源设为-1（不限制），查询并发设为10： PUT https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/clusters/e59d6b86-9072-46eb-a996-13f8b44994c1/workload/queues{ "workload_queue": { "workload_queue_name": "test11", "workload_resource_item_list": [ { "resource_name": "memory", "resource_value": "0" }, { "resource_name": "tablespace", "resource_value": "-1" }, { "resource_name": "activestatements", "resource_value": "10" }, { "resource_name": "cpu_limit", "resource_value": 0 }, { "resource_name": "cpu_share", "resource_value": 12 } ], "logical_cluster_name": "" }}

调用API获取项目ID 项目ID可以通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects/”，其中{Endpoint}为IAM的终端节点，可以从地区和终端节点获取。接口的认证鉴权请参见认证鉴权。 响应示例如下，其中projects下的“id”即为项目ID。 { "projects": [ { "domain_id": "65382450e8f64ac0870cd180d14e684b", "is_domain": false, "parent_id": "65382450e8f64ac0870cd180d14e684b", "name": "cn-north-4b", "description": "", "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99" }, "id": "a4a5d4098fb4474fa22cd05f897d6b99", "enabled": true } ], "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects" }}

操作步骤 配置环境。 下载Postman调用创建快照服务，Postman建议使用7.24.0版本。 调用服务。 获取Token，进行认证。 在Postman界面上新建Post请求，选中Body的配置项，填写用户名、用户密码、帐号名及项目ID。在我的凭证下，您可以查看帐号的用户名、用户密码和帐号名等信息。项目ID获取方法请参见获取项目ID。 获取token的华为云服务所在区域需要和调用的服务所在区域需一致，否则会导致调用失败。 单击右上角“Send”，发送“POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens”。获取返回结果中的Token值（Token有效期为24小时）。 调用创建快照服务。 在Postman界面上新建Post请求，选中“Headers”配置项，添加对应的KEY、VALUE，复制Token值到“X-Auth-Token”。请求中划红横线部分为项目ID，获取方法请参见获取项目ID。请求URL中的所在区域需要与调用的服务所在区域保持一致，您可以从地区和终端节点获取。 单击“Body”， 添加请求参数值到请求中。不同服务的参数各不相同，详情请参考API说明。 单击右上角“Send”按钮发送请求“POST https://dws.cn-north-4.myhuaweicloud.com/v1.0/{project_id}/snapshots”，查看创建结果。 { "snapshot": { "id": "809bcf6e-4022-496d-9320-bbc700695692" }}

请求示例 创建DWS集群，可用区为az1.dc1，节点规格为dws.m1.xlarge.ultrahigh，3节点，数据库端口8000，带公网IP，安全组ID，子网ID，虚拟私有云ID： POST https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters{ "cluster" : { "node_type" : "dws.m1.xlarge.ultrahigh", "number_of_node" : 3, "subnet_id" : "374eca02-cfc4-4de7-8ab5-dbebf7d9a720", "security_group_id" : "dc3ec145-9029-4b39-b5a3-ace5a01f772b", "vpc_id" : "85b20d7e-9eb7-4b2a-98f3-3c8843ea3574", "availability_zone" : "az1.dc1", "port" : 8000, "name" : "dws-1", "user_name" : "dbadmin", "user_pwd" : "Passw0rd!", "public_ip" : { "public_bind_type" : "auto_assign", "eip_id" : "" }, "enterprise_project_id" : "aca4e50a-266f-4786-827c-f8d6cc3fbada" }}

响应示例 状态码： 200 查询快照列表成功。 { "snapshots" : [ { "id" : "2a4d0f86-67cd-408a-8b66-017454fb7793", "name" : "snapshot-1", "description" : "", "started" : "2016-08-23T03:59:23Z", "finished" : "2016-08-23T04:01:40Z", "size" : 500, "status" : "AVAILABLE", "type" : "MANUAL", "cluster_id" : "4f87d3c4-9e33-482f-b962-e23b30d1a18c" }, { "id" : "4af11460-06ec-48a4-b3ad-0e3bbdcd8ab1", "name" : "snapshot-2", "description" : "", "started" : "2016-08-23T18:20:00Z", "finished" : "2016-08-23T18:22:12Z", "size" : "500,", "status" : "AVAILABLE", "type" : "MANUAL", "cluster_id" : "4f87d3c4-9e33-482f-b962-e23b30d1a18c" } ], "count" : 2}

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 snapshots Array of Snapshots objects 快照对象列表。 count Integer 快照对象列表总数。 表3 Snapshots 参数 参数类型 描述 id String 快照ID。 name String 快照名称。 description String 快照描述。 started String 快照创建的日期时间，格式为 ISO8601：YYYY-MM-DDThh:mm:ssZ。 finished String 快照完成的日期时间，格式为 ISO8601：YYYY-MM-DDThh:mm:ssZ。 size Double 快照大小，单位 GB。 status String 快照状态： CREATING：创建中。 AVAILABLE：可用。 UNAVAILABLE：不可用。 type String 快照创建类型。 MANUAL：手动快照。 AUTOMATED：自动快照。 cluster_id String 快照对应的集群ID。

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 node_types Array of NodeTypes objects 节点类型对象列表。 count Integer 节点类型总数。 表3 NodeTypes 参数 参数类型 描述 spec_name String 节点类型名称。 detail Array of Detail objects 节点类型详细。 id String 节点类型ID。 datastore_type String 产品类型 dws：标准数仓。 hybrid：实时数仓。 stream：IoT数仓。 available_zones Array of NodeTypeAvailableZones objects 支持的可用区及状态信息。 ram Integer 内存大小。 vcpus Integer CPU数量。 datastores Array of NodeTypeDatastores objects 内核版本信息。 volume VolumeResp object 如果规格为固定存储容量规格，则该属性为规格典配的存储容量信息，如果为弹性存储规格，则该属性为null。 elastic_volume_specs Array of NodeTypeElasticVolumeSpecs objects 如果规格为弹性容量规格，则该属性为规格典配的弹性容量信息，包括存储类型、最小容量、最大容量以及步长信息，如果为固定存储规格，则该属性为null。 表4 Detail 参数 参数类型 描述 type String 属性类型。 value String 属性值。 unit String 属性单位。 表5 NodeTypeAvailableZones 参数 参数类型 描述 code String 可用区ID。 status String 节点类型可用状态。 normal：可用 sellout：售罄 abandon：不可用 表6 NodeTypeDatastores 参数 参数类型 描述 version String 内核版本号。 attachments Attachments object 内核版本附加信息。 表7 attachments 参数 参数类型 描述 min_cn String 内核版本支持的最小CN。 max_cn String 内核版本支持的最大CN。 表8 VolumeResp 参数 参数类型 描述 type String 磁盘类型，仅支持SSD。 size Integer 磁盘可用容量。 表9 NodeTypeElasticVolumeSpecs 参数 参数类型 描述 type String 云盘存储类型。 step String 云盘容量调整步长。 min_size Integer 云盘支持的最小容量。 max_size Integer 云盘支持的最大容量。

响应示例 状态码： 200 查询节点类型成功。 { "node_types" : [ { "spec_name" : "dws.d2.xlarge", "id" : "ebe532d6-665f-40e6-a4d4-3c51545b6a67", "datastore_type" : "dws", "available_zones" : [ { "code" : "az1", "status" : "normal" } ], "ram" : 32, "vcpus" : 4, "datastores" : [ { "version" : "8.1.3.200", "attachments" : { "min_cn" : 2, "max_cn" : 20 } } ], "volume" : { "type" : "SSD", "size" : 160 }, "elastic_volume_specs" : [ { "type" : "SSD", "step" : 100, "min_size" : 100, "max_size" : 32000 } ], "detail" : [ { "type" : "vCPU", "value" : "4" }, { "value" : "1675", "type" : "LOCAL_DISK", "unit" : "GB" }, { "type" : "mem", "value" : "32", "unit" : "GB" } ] } ], "count" : 1}

请求示例 为ID为"44b277eb-39be-4921-be31-3d61b43651d7"的集群创建名为snapshot-3的手动快照： POST https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/snapshots{ "snapshot" : { "name" : "snapshot-3", "cluster_id" : "44b277eb-39be-4921-be31-3d61b43651d7", "description" : "Snapshot-3 description" }}

响应示例 状态码： 200 查询快照详情成功。 { "snapshot" : { "id" : "2a4d0f86-67cd-408a-8b66-017454fb7793", "name" : "snapshot-1", "description" : "snapshot description", "started" : "2016-08-23T03:59:23Z", "finished" : "2016-08-23T04:01:40Z", "size" : 500, "status" : "AVAILABLE", "type" : "MANUAL", "cluster_id" : "4f87d3c4-9e33-482f-b962-e23b30d1a18c" }}

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 snapshot SnapshotDetail object 快照详情对象。 表3 SnapshotDetail 参数 参数类型 描述 id String 快照ID。 name String 快照名称。 description String 快照描述。 started String 快照创建的日期时间，格式为 ISO8601： YYYY-MM-DDThh:mm:ssZ。 finished String 快照完成的日期时间，格式为 ISO8601：YYYY-MM-DDThh:mm:ssZ。 size Double 快照大小，单位GB。 status String 快照状态： CREATING：创建中。 AVAILABLE：可用。 UNAVAILABLE：不可用。 type String 快照创建类型。 MANUAL：手动快照。 AUTOMATED：自动快照。 cluster_id String 快照对应的集群ID。 cluster_name String 快照对应的集群名称。 backup_key String 备份产生的Key。 prior_backup_key String 增量快照使用前一个快照的BakupKey。当取值为FULL时表示这是一个全量快照。 base_backup_key String 对应全量快照的BackupKey。 backup_device String 备份介质。 total_backup_size Long 快照累计大小，表示从全量开始到当前增量的累计大小。单位KB base_backup_name String 对应全量快照名称。 support_inplace_restore Boolean 是否支持恢复至原集群。 fine_grained_backup Boolean 是否是细粒度备份。 fine_grained_backup_detail FineGrainedSnapshotDetail object 细粒度备份信息。 guest_agent_version String 集群guestAgent版本号。 cluster_status String 集群状态 AVAILABLE：可用 UNAVAILABLE：不可用 FROZEN：已冻结 bak_expected_start_time String 预计快照开始时间。 bak_keep_day Integer 备份保留天数。 bak_period String 集群策略。 db_user String 备份用户。 datastore DataStore object 数据库版本 progress String 备份进度。 backup_level String 备份级别 cluster schema 表4 FineGrainedSnapshotDetail 参数 参数类型 描述 database String 备份数据库。 schema_list Array of String 备份模式集合。 table_list Array of String 备份表集合。 表5 DataStore 参数 参数类型 描述 type String 数据库类型。 version String 数据库版本。

请求示例 恢复快照到新集群dws-1，新集群在az1.dc1可用区下，数据库端口为8000，带子网ID，安全组ID，虚拟私有云ID，公网IP，企业ID等： POST https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/snapshots/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/actions{ "restore" : { "name" : "dws-1", "subnet_id" : "374eca02-cfc4-4de7-8ab5-dbebf7d9a720", "security_group_id" : "dc3ec145-9029-4b39-b5a3-ace5a01f772b", "vpc_id" : "85b20d7e-9eb7-4b2a-98f3-3c8843ea3574", "availability_zone" : "az1.dc1", "port" : 8000, "public_ip" : { "public_bind_type" : "auto_assign", "eip_id" : "" }, "enterprise_project_id" : "aca4e50a-266f-4786-827c-f8d6cc3fbada" }}

概述 欢迎使用数据仓库服务GaussDB(DWS)。数据仓库服务是完全托管的企业级云上数据仓库服务，具备免运维、在线扩展、高效的多源数据加载能力，兼容PostgreSQL生态。助力企业经济高效地对海量数据进行在线分析，实现数据快速变现。 您可以使用本文档提供的API对数据仓库服务的集群、快照进行相关操作，如创建、查询、删除等。支持的全部操作请参见API概述。 在调用数据仓库服务API之前，请确保已经充分了解实数据仓库服务相关概念，详细信息请参见产品介绍。 父主题： 使用前必读

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 restore 是 Restore object 恢复对象。 表3 Restore 参数 是否必选 参数类型 描述 name 是 String 集群名称，要求唯一性，必须以字母开头并只包含字母、数字、中划线，下划线，长度为4~64个字符。 subnet_id 否 String 指定子网ID，用于集群网络配置。默认值与原集群相同。 security_group_id 否 String 指定安全组ID，用于集群网络配置。默认值与原集群相同。 vpc_id 否 String 指定虚拟私有云ID，用于集群网络配置。默认值与原集群相同。 availability_zone 否 String 指定集群可用区。默认值与原集群相同。 port 否 Integer 指定集群服务端口，取值范围8000~30000，默认端口为8000。 最小值：8000 最大值：30000 public_ip 否 PublicIp object 公网IP地址，如果未指定，则默认不使用公网连接。 enterprise_project_id 否 String 企业项目ID，对集群指定企业项目，如果未指定，则使用默认企业项目“default”的ID，即0。 表4 PublicIp 参数 是否必选 参数类型 描述 public_bind_type 是 String 弹性IP绑定类型，取值如下： auto_assign：自动绑定 not_use：暂未使用 bind_existing ：使用已有 eip_id 否 String 弹性IP的ID。

API概述 数据仓库服务所提供的接口为自研接口。通过配合使用数据仓库服务自研接口，您可以使用数据仓库服务的如下功能。 类型 API 说明 集群管理接口 创建集群前检查 创建集群前预检查。 创建集群 创建集群。 查询集群列表 查询并显示集群列表。 查询集群详情 查询集群详情。 查询节点类型 查询GaussDB(DWS) 服务支持的所有节点类型。 删除集群 删除集群。 重启集群 重启集群。 扩容集群 扩容集群大小。 重置密码 重置集群管理员密码。 查询专属分布式存储池列表 查询租户可使用的专属分布式存储池。 查询集群参数组 查询集群所关联的参数组。 解除只读 当集群进入只读状态时，无法进行数据库相关操作，用户可以在管理控制台解除集群的只读状态。 查询集群CN节点 查询指定集群的CN节点信息。 批量增加CN节点 为指定集群批量增加CN节点。 批量删除CN节点 为指定集群删除CN节点。 集群缩容 该接口用于缩容集群。 快照管理接口 创建快照 为指定集群创建快照。 查询快照列表 查询快照列表。 查询快照详情 使用快照id查询快照详情。 删除手动快照 删除一个指定快照。 删除快照策略 删除一个快照策略。 恢复集群 使用快照恢复集群。 复制快照 复制一个自动快照。 添加快照策略 设置快照策略。 事件管理 查询事件列表 查询事件列表。 查询事件配置 查询事件配置。 查询订阅事件 查询订阅的事件。 创建订阅事件 添加订阅的事件。 更新订阅事件 更新订阅事件。 删除订阅事件 删除订阅的事件。 数据源 查询数据源 该接口用于查询数据源。 更新数据源 该接口用于更新一个数据源。 审计日志 查询日志记录 查询审计日志记录。 资源管理 查询资源管理状态 查询资源管理状态。 添加资源管理计划 添加资源管理计划。 查询资源池列表 查询资源池。 删除资源池 删除资源池。 设置资源管理开关 设置资源管理。 告警管理 查询告警配置 查询告警配置。 查询告警详情列表 查询告警详情列表。 查询告警统计列表 查询告警统计。 查询告警订阅列表 查询订阅告警。 创建告警订阅 创建告警订阅。 更新告警订阅 更新订阅的告警。 删除告警订阅 删除订阅的告警。 可用区 查询可用区列表 查询租户创建集群时可使用的可用区列表。 连接管理 申请域名 为指定集群申请域名 修改集群域名 为指定集群修改域名。 删除集群域名 删除指定集群域名。 获取集群可绑定的ELB列表 查询集群可以关联的ELB列表。 集群绑定ELB 集群绑定ELB。 集群解绑ELB 集群解绑ELB。 集群绑定EIP 集群绑定ELP。 集群解绑EIP 集群解绑EIP。 标签管理 查询项目标签 查询项目标签列表。 查询集群标签 查询指定集群的标签信息。 批量添加标签 为指定集群批量添加标签。 批量删除标签 为指定集群批量删除标签。 配额管理 查询配额 查询单租户在GaussDB(DWS)服务下的配额信息。 容灾管理 查询容灾列表 查询容灾列表。

请求示例 重置ID为“4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90”的集群密码为“NewPassw0rd!”： 12345 POST https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/reset-password{ "new_password" : "NewPassw0rd!"}

状态码 状态码如表1所示 表1 状态码 状态码 编码 状态说明 100 Continue 继续请求。 这个临时响应用来通知客户端，它的部分请求已经被服务器接收，且仍未被拒绝。 101 Switching Protocols 切换协议。只能切换到更高级的协议。 例如，切换到HTTP的新版本协议。 201 Created 创建类的请求完全成功。 202 Accepted 已经接受请求，但未处理完成。 203 Non-Authoritative Information 非授权信息，请求成功。 204 NoContent 请求完全成功，同时HTTP响应不包含响应体。 在响应OPTIONS方法的HTTP请求时返回此状态码。 205 Reset Content 重置内容，服务器处理成功。 206 Partial Content 服务器成功处理了部分GET请求。 300 Multiple Choices 多种选择。请求的资源可包括多个位置，相应可返回一个资源特征与地址的列表用于用户终端（例如：浏览器）选择。 301 Moved Permanently 永久移动，请求的资源已被永久的移动到新的URI，返回信息会包括新的URI。 302 Found 资源被临时移动。 303 See Other 查看其它地址。 使用GET和POST请求查看。 304 Not Modified 所请求的资源未修改，服务器返回此状态码时，不会返回任何资源。 305 Use Proxy 所请求的资源必须通过代理访问。 306 Unused 已经被废弃的HTTP状态码。 400 BadRequest 非法请求。 建议直接修改该请求，不要重试该请求。 401 Unauthorized 在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。 402 Payment Required 保留请求。 403 Forbidden 请求被拒绝访问。 返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。 404 NotFound 所请求的资源不存在。 建议直接修改该请求，不要重试该请求。 405 MethodNotAllowed 请求中带有该资源不支持的方法。 建议直接修改该请求，不要重试该请求。 406 Not Acceptable 服务器无法根据客户端请求的内容特性完成请求。 407 Proxy Authentication Required 请求要求代理的身份认证，与401类似，但请求者应当使用代理进行授权。 408 Request Time-out 服务器等候请求时发生超时。 客户端可以随时再次提交该请求而无需进行任何更改。 409 Conflict 服务器在完成请求时发生冲突。 返回该状态码，表明客户端尝试创建的资源已经存在，或者由于冲突请求的更新操作不能被完成。 410 Gone 客户端请求的资源已经不存在。 返回该状态码，表明请求的资源已被永久删除。 411 Length Required 服务器无法处理客户端发送的不带Content-Length的请求信息。 412 Precondition Failed 未满足前提条件，服务器未满足请求者在请求中设置的其中一个前提条件。 413 Request Entity Too Large 由于请求的实体过大，服务器无法处理，因此拒绝请求。为防止客户端的连续请求，服务器可能会关闭连接。如果只是服务器暂时无法处理，则会包含一个Retry-After的响应信息。 414 Request-URI Too Large 请求的URI过长（URI通常为网址），服务器无法处理。 415 Unsupported Media type 服务器无法处理请求附带的媒体格式。 416 Requested range not satisfiable 客户端请求的范围无效。 417 Expectation Failed 服务器无法满足Expect的请求头信息。 422 UnprocessableEntity 请求格式正确，但是由于含有语义错误，无法响应。 429 TooManyRequests 表明请求超出了客户端访问频率的限制或者服务端接收到多于它能处理的请求。建议客户端读取相应的Retry-After首部，然后等待该首部指出的时间后再重试。 500 InternalServerError 表明服务端能被请求访问到，但是不能理解用户的请求。 501 Not Implemented 服务器不支持请求的功能，无法完成请求。 502 Bad Gateway 充当网关或代理的服务器，从远端服务器接收到了一个无效的请求。 503 ServiceUnavailable 被请求的服务无效。 建议直接修改该请求，不要重试该请求。 504 ServerTimeout 请求在给定的时间内无法完成。客户端仅在为请求指定超时（Timeout）参数时会得到该响应。 505 HTTP Version not supported 服务器不支持请求的HTTP协议的版本，无法完成处理。 父主题： 附录

请求示例 创建多AZ DWS集群，集群版本为8.2.1，可用区是az1和az2，节点规格为dws.m1.xlarge.ultrahigh，3节点，SSD磁盘，容量为100GB，数据库端口为8000，带公网IP，安全组ID，子网ID，虚拟私有云ID： POST https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/clusters{ "cluster" : { "flavor" : "dws.m1.xlarge.ultrahigh", "num_node" : 3, "subnet_id" : "374eca02-cfc4-4de7-8ab5-dbebf7d9a720", "security_group_id" : "dc3ec145-9029-4b39-b5a3-ace5a01f772b", "vpc_id" : "85b20d7e-9eb7-4b2a-98f3-3c8843ea3574", "db_port" : 8000, "datastore_version" : "8.2.1", "availability_zones" : [ "az1", "az2" ], "name" : "dws-1", "num_cn": 3, "db_name" : "dbadmin", "db_password" : "Passw0rd!", "public_ip" : { "public_bind_type" : "auto_assign", "eip_id" : "" }, "volume":{ "volume":"SSD", "capacity":100 }, "enterprise_project_id" : "aca4e50a-266f-4786-827c-f8d6cc3fbada" }}

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 quotas QuotasResources object 配额列表对象。 表3 QuotasResources 参数 参数类型 描述 resources Array of QuotasResource objects 资源列表对象。 表4 QuotasResource 参数 参数类型 描述 type String 项目资源类型。 used String 已使用的资源数量。 quota Integer 项目资源配额。 unit Integer 资源计量单位。

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