华为云用户手册

8.3.0集群版本数据库接口删除表 表1 日落系统函数和视图 类型 名称 说明 函数 pg_sync_cstore_delta(text) 列存merge delta表数据至主表，已废弃。由VACUUM DELTAMERGE xxx语法替代。 pg_sync_cstore_delta 列存merge delta表数据至主表，已废弃。由VACUUM DELTAMERGE xxx语法替代。 pgxc_pool_check 检查连接池中缓存的连接数据是否与pgxc_node一致，已废弃。 pg_delete_audit 删除审计日志函数，已废弃。不允许手动删除审计日志。 pg_log_comm_status 当前节点SCTP通信层内部结构的日志记录状态，已废弃。 pgxc_log_comm_status 所有节点SCTP通信层内部结构的日志记录状态，已废弃 signal_backend 已废弃。 pg_stat_get_realtime_info_internal 获取query级别的实时topsql信息，已废弃。由PGXC_WLM_SESSION_STATIS TICS 视图代替。 pg_stat_get_wlm_session_info_internal 获取query级别的topsql信息，已废弃。由pg_stat_get_wlm_realtime_session_info函数代替。 pg_stat_get_wlm_session_info 获取session信息，已废弃。由PGXC_WLM_SESSION_INFO视图代替。 pg_stat_get_wlm_statistics 获取session信息，已废弃。由PGXC_WLM_SESSION_INFO视图代替。 pg_user_iostat 获取用户的io信息，已废弃。由PGXC_TOTAL_USER_RESOURCE_INFO视图代替。 pg_stat_get_wlm_session_iostat_info 获取query的io信息，已废弃。由PGXC_WLM_SESSION_STATISTI CS 视图或PGXC_WLM_SESSION_INFO视图替代。 系统视图 gs_wlm_session_info_all 获取session信息，已废弃。由PGXC_WLM_SESSION_INFO代替。 pg_wlm_statistics 显示作业结束后或已被处理异常后的负载管理相关信息，已废弃。由PGXC_WLM_SESSION_INFO视图替代。 pg_session_iostat 获取session的io信息，已废弃。由PGXC_WLM_SESSION_STATISTICS视图替代。

9.1.0集群版本数据库接口删除表 表2 日落数据库接口 类型 名称 说明 扩展 file_fdw 本地文件访问，已废弃。 外部服务器 gsmpp_errorinfo_server 读取导入错误表数据，已废弃。访问导入错误表已不再需要gsmpp_errorinfo_server。 逻辑复制 pg_create_logical_replication_slot 创建逻辑复制槽，9.1.0.200已废弃。逻辑复制特性已废弃。 逻辑复制 pg_logical_slot_peek_changes 解码并不推进流复制槽，9.1.0.200已废弃。逻辑复制特性已废弃。 逻辑复制 pg_logical_slot_get_changes 解码并推进流复制槽，9.1.0.200已废弃。逻辑复制特性已废弃。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 instanceId String DDM实例ID。 jobId String 任务ID。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 errCode String 业务错误码。 externalMessage String 错误信息。 状态码： 500 表5 响应Body参数 参数 参数类型 描述 errCode String 业务错误码。 externalMessage String 错误信息。

响应示例 状态码： 200 OK { "instanceId" : "1f5c9fd6cd984056ba89c8c87cc03278in09", "jobId" : "6f1334ca-faa6-479e-837f-f3219192675e"} 状态码： 400 bad request { "externalMessage" : "Parameter error.", "errCode" : "DBS.280001"} 状态码： 500 server error { "externalMessage" : "Server failure.", "errCode" : "DBS.200412"}

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务的“获取用户Token”接口来获取。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String DDM实例组名称，命名要求如下。 长度为4-64个字符。 必须以字母开头。 可以包含字母、数字、中划线、下划线、不能包含其它特殊字符。 最小长度：4 最大长度：64 type 是 String 实例组的类型。 rw：读写组 r：只读组 flavor_id 是 String 规格ID。 nodes 是 Array of 表 NodeInfo objects 节点信息列表。 最小：1 最大：32 表4 NodeInfo 参数 是否必选 参数类型 描述 available_zone 是 String 节点可用区。取值非空，请参见地区和终端节点。 subnet_id 是 String 子网ID。

响应消息 正常响应参数说明 表5 响应Body参数 参数 参数类型 描述 job_id String 创建组的任务ID。 仅创建按需实例时会返回该参数。 order_id String 订单号，创建包年包月时返回该参数。 group_id String 组ID。 仅创建按需实例时会返回该参数。 正常响应示例 按需： { "job_id": "3ae783f3-844e-4051-abd5-b9cc65899785", "group_id": "b4153b807b1a4f83870bf868fcc4f4ea****" } 包周期： { "order_id" : "CS1810251738L8VVD"} 异常响应 请参见异常请求结果。

请求示例 创建DDM实例组，组类型：读写，节点数为1个。 POST https://{endpoint}/v3/{project_id}/instances/{instance_id}/groups{ "name": "group-1", "type": "rw", "flavor_id": "a615922f-0ed8-3691-aad4-a595185febba", "nodes": [ { "available_zone": "az1", "subnet_id": "ead1e945-ca89-45dd-bcce-4a30b2054c22" } ]}

URI URL格式 GET /v3/{project_id}/instances/{instance_id}/physical-processes?offset={offset}&limit={limit} 参数说明 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String 关联RDS实例ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 索引位置，偏移量。 从第一条数据偏移offset条数据后开始查询，默认为0。 取值必须为数字，且不能为负数。 limit 否 Integer 查询个数上限值。 取值范围：1~128。 不传该参数时，默认值为10。 keyword 否 String 会话结果筛选关键字，支持返回结果全字段模糊匹配，长度最大255。

响应消息 正常响应参数说明 表3 响应Body参数 参数 参数类型 描述 total_count Integer 总条数。 physical_processes Array of 表4 objects 实例的物理会话列表。 表4 PhysicalProcessInfo 参数 参数类型 描述 id Long 物理会话ID。 user String 当前连接的用户。 host String 所属的IP和端口。 db String 数据库名。 command String 连接状态，一般是休眠或空闲（sleep），查询（query），连接（connect）。 time Long 连接状态持续的时间，单位是秒（s）。 state String 当前SQL语句的状态。 info String 当前所执行的SQL语句。 trx_executed_time Long 事务持续时间，单位是秒（s）。 正常响应示例 { "physical_processes": [ { "id": 1973, "user": "DDMRW1613058863", "host": "172.16.241.84:58908", "db": "ddm_db_test_0001", "state": "", "command": "Sleep", "info": null, "time": 13977, "trx_executed_time": 0 } ], "total_count": 1} 异常响应 请参见异常请求结果。

URI URL格式 POST /v3/{project_id}/instances/{instance_id}/database-version/rollback-version 参数说明 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String DDM实例ID。

响应消息 正常响应参数说明 表3 响应Body参数 参数 参数类型 描述 instance_id String DDM实例ID。 job_id String 回滚内核版本的任务ID。 正常响应示例 { "instance_id" : "28e8841d0b9c4f6a9a30742ee60e1055****", "job_id" : "1eb697c0-1842-43a3-8671-f562d038****"} 异常响应 请参见异常请求结果。

URI GET /v1/{project_id}/instances/{instance_id}/databases/{ddm_dbname} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参见获取项目ID。 instance_id 是 String DDM实例ID。 ddm_dbname 是 String 需要查询的逻辑库名称，不区分大小写。

响应示例 状态码： 200 OK { "database" : { "name" : "db_7567", "created" : "1604631243234", "status" : "RUNNING", "updated" : "1604631243234", "databases" : [ { "id" : "e70a82534a364492b795c5080e3a1591in01", "name" : "db_7567_0000", "idName" : "db_7567_0000", "dbslot" : 0, "status" : "RUNNING", "created" : 1604631243234, "updated" : 1604631243234 }, { "id" : "e70a82534a364492b795c5080e3a1591in01", "name" : "db_7567_0001", "idName" : "db_7567_0001", "dbslot" : 1, "status" : "RUNNING", "created" : 1604631243234, "updated" : 1604631243234 }, { "id" : "e70a82534a364492b795c5080e3a1591in01", "name" : "db_7567_0002", "idName" : "db_7567_0002", "dbslot" : 2, "status" : "RUNNING", "created" : 1604631243234, "updated" : 1604631243234 }, { "id" : "e70a82534a364492b795c5080e3a1591in01", "name" : "db_7567_0003", "idName" : "db_7567_0003", "dbslot" : 3, "status" : "RUNNING", "created" : 1604631243234, "updated" : 1604631243234 }, { "id" : "e70a82534a364492b795c5080e3a1591in01", "name" : "db_7567_0004", "idName" : "db_7567_0004", "dbslot" : 4, "status" : "RUNNING", "created" : 1604631243234, "updated" : 1604631243234 }, { "id" : "e70a82534a364492b795c5080e3a1591in01", "name" : "db_7567_0005", "idName" : "db_7567_0005", "dbslot" : 5, "status" : "RUNNING", "created" : 1604631243234, "updated" : 1604631243234 }, { "id" : "e70a82534a364492b795c5080e3a1591in01", "name" : "db_7567_0006", "idName" : "db_7567_0006", "dbslot" : 6, "status" : "RUNNING", "created" : 1604631243234, "updated" : 1604631243234 }, { "id" : "e70a82534a364492b795c5080e3a1591in01", "name" : "db_7567_0007", "idName" : "db_7567_0007", "dbslot" : 7, "status" : "RUNNING", "created" : 1604631243234, "updated" : 1604631243234 } ], "shard_mode" : "cluster", "shard_number" : 8, "shard_unit" : 8, "dataVips" : [ "192.168.185.97:5066" ], "used_rds" : [ { "id" : "e70a82534a364492b795c5080e3a1591in01", "name" : "rds-5338", "status" : "normal" } ] }} 状态码： 400 bad request { "externalMessage" : "Parameter error.", "errCode" : "DBS.280001"} 状态码： 500 server error { "externalMessage" : "Server failure.", "errCode" : "DBS.200412"}

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 database GetDatabaseResponseBean object 逻辑库信息。 表4 GetDatabaseResponseBean 参数 参数类型 描述 name String 逻辑库名称。 created Long 逻辑库的创建时间。 status String 状态。 updated Long 逻辑库最后更新时间。 databases Array of GetDatabases objects 逻辑库分片的详细信息。 shard_mode String 逻辑库的工作模式。 cluster表示逻辑库是拆分模式。 single表示逻辑库是非拆分模式。 shard_number Integer 同一种工作模式下逻辑库分片的数量。 shard_unit Integer 单个RDS上的逻辑库分片数。 dataVips Array of strings 连接逻辑库使用的IP:端口。 used_rds Array of GetDatabaseUsedRds objects 关联RDS。 表5 GetDatabases 参数 参数类型 描述 dbslot Integer 分片数。 name String 分片名称。 status String 逻辑库状态。 created Long 创建时间。 updated Long 最近更新时间。 id String 所在RDS的ID。 idName String 物理库的名称。 表6 GetDatabaseUsedRds 参数 参数类型 描述 id String 关联RDS节点ID。 name String 关联RDS名称。 status String 关联RDS状态。 error_msg String 响应信息，若无异常信息则不返回该参数。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 errCode String 业务错误码。 externalMessage String 错误信息。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 errCode String 业务错误码。 externalMessage String 错误信息。

DDM实例管理 表1 DDM实例管理 权限 对应API接口 授权项 IAM项目（Project） 企业项目 （Enterprise Rroject） 购买DDM 实例（按需） 购买DDM 实例（包周期） POST /v1/{project_id}/instances ddm:instance:create 购买实例操作依赖以下权限，即要配置购买实例权限，必须配置以下依赖的权限，否则购买失败。 ecs:*:get* ecs:*:list* vpc:vpcs:list vpc:securityGroups:get vpc:subnets:get ecs:cloudServerNics:update ecs:serverInterfaces:use 全局/区域级指定vpc:ports:* BSS Finance、BSS Operator系统策略 只有购买实例（包周期）操作才依赖这个权限，购买实例（按需）不需要。 √ √ 查询DDM实例列表 GET /v1/{project_id}/instances?offset={offset}&limit={limit} ddm:instance:list √ √ 查询DDM实例详细信息 GET /v1/{project_id}/instances/{instance_id} ddm:instance:get vpc:*:get* vpc:*:list* √ √ 修改DDM实例 PUT /v1/{project_id}/instances/{instance_id} ddm:instance:modify 修改安全组操作依赖以下权限，即要修改安全组权限，必须配置以上依赖的权限，否则修改失败。 vpc:*:get* vpc:*:list* vpc:ports:update vpc:securityGroups:get √ √ 重启DDM实例 POST /v1/{project_id}/instances/{instance_id}/action ddm:instance:reboot √ √ 删除DDM实例 DELETE /v1/{project_id}/instances/{instance_id}?delete_rds_data=true ddm:instance:delete vpc:ports:delete √ √ “√”表示支持，“×”表示暂不支持。 父主题： 授权策略及授权项

响应示例 状态码： 200 ok { } 状态码： 400 bad request { "externalMessage" : "Parameter error.", "errCode" : "DBS.280001"} 状态码： 500 server error { "externalMessage" : "Server failure.", "errCode" : "DBS.200412"}

规格列表 DDM实例规格，详见如下列表，具体规格请以实际环境为准。 表1 实例规格列表 规格码 CPU 内存 架构 ddm.c6.2xlarge.2 8 16 X86 ddm.c6.4xlarge.2 16 32 X86 ddm.c6.8xlarge.2 32 64 X86 ddm.kc1.2xlarge.2 8 16 ARM ddm.kc1.4xlarge.2 16 32 ARM ddm.kc1.8xlarge.2 32 64 ARM 父主题： 附录

DDM账号管理 表1 DDM账号管理 权限 对应API接口 授权项 IAM项目（Project） 企业项目 （Enterprise Rroject） 创建DDM账号 POST /v1/{project_id}/instances/{instance_id}/users ddm:user:create √ √ 查询DDM账号列表 GET /v1/{project_id}/instances/{instance_id}/users?offset={offset}&limit={limit} ddm:user:list √ √ 修改DDM账号 PUT /v1/{project_id}/instances/{instance_id}/users/{username} ddm:user:modify √ √ 删除DDM账号 DELETE /v1/{project_id}/instances/{instance_id}/users/{username} ddm:user:delete √ √ 父主题： 授权策略及授权项

操作步骤 指定limit与offset查询DDM实例列表。 接口相关信息 URI格式： GET /v1/{project_id}/instances 详情请参见查询DDM实例列表。 请求示例 GET: https://{endpoint}/v1/743b4c0428d945316666666666666666/instances?offset=0&limit=1 {endpoint}信息请从地区和终端节点获取。 limit值可根据DDM实例数据调整。 响应示例 {"instance_num":10,"instances":[{"id":"cab932b426ed4215a8d76b9d71322661in09","status":"RUNNING","name":"ddm-20-single-2u4g-1-202010231552401522260","created":"2020-10-23T07:52:46+0000","updated":"2020-10-23T07:59:56+0000","available_zone":"az1xahz","vpc_id":"9cf0f8f5-9748-4ebb-9905-bbe429182bd6","subnet_id":"b35a4be7-65a5-4176-bec9-7a437493c498","security_group_id":"9d10da6d-38cc-4cf0-8f96-c34940a3fd15","node_count":1,"access_ip":"192.168.60.13","access_port":"5066","core_count":"2","ram_capacity":"4","node_status":"RUNNING","enterprise_project_id":"0","project_id":"070c071d8e80d58c2f42c0121b10cf9f","engine_version":"2.5.10.10222119"}],"page_no":1,"page_size":1,"total_record":10,"total_page":10} 汇总查询结果。 参考1持续调用，如果查询的DDM实例列表为空，或者返回的body体中不存在instances字段，表明所有DDM实例查询完成。 汇总所有查询到的DDM实例即当前查询条件下的所有DDM实例。

URI DELETE /v1/{project_id}/instances/{instance_id}/databases/{ddm_dbname}?delete_rds_data={delete_rds_data} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参见获取项目ID。 instance_id 是 String DDM实例ID。 ddm_dbname 是 String 需要查询的逻辑库名称，不区分大小写。 表2 Query参数 参数 是否必选 参数类型 描述 delete_rds_data 否 String 是否同时删除关联后端数据库实例上存储的数据。 取值为“true”：删除。 取值为空或“false”：不删除。 默认值为空。 枚举值： true false

响应示例 状态码： 200 OK { } 状态码： 400 bad request { "externalMessage" : "Parameter error.", "errCode" : "DBS.280001"} 状态码： 500 server error { "externalMessage" : "Server failure.", "errCode" : "DBS.200412"}

请求示例 删除DDM逻辑库(删除关联后端数据库实例上存储的数据)。 DELETE https://{endpoint}/v1/{project_id}/instances/{instance_id}/databases/{ddm_dbname}?delete_rds_data=true 删除DDM逻辑库(保留关联后端数据库实例上存储的数据)。 DELETE https://{endpoint}/v1/{project_id}/instances/{instance_id}/databases/{ddm_dbname}?delete_rds_data=false

响应示例 状态码： 200 ok { "instanceId" : "28e8841d0b9c4f6a9a30742ee60e1068in09", "instanceName" : "BUG-ddm-fb88-test", "jobId" : "1eb697c0-1842-43a3-8671-f562d0385cb9"} 状态码： 400 bad request { "externalMessage" : "Parameter error.", "errCode" : "DBS.280001"} 状态码： 500 server error { "externalMessage" : "Server failure.", "errCode" : "DBS.200412"}

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务的“获取用户Token”接口来获取。 表3 请求Body参数 参数 是否必选 参数类型 描述 node_number 是 Integer 需要缩容的节点数量，最大值为实例节点数减1。 group_id 否 String 组ID，指定当前进行节点扩容的组。当实例的组大于1时，必填。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 instanceId String DDM实例ID。 instanceName String DDM实例名称。 jobId String 任务ID，仅按需实例时会返回该参数。 orderId String 订单号，仅包年包月实例时返回该参数。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 errCode String 业务错误码。 externalMessage String 错误信息。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 errCode String 业务错误码。 externalMessage String 错误信息。

请求示例 缩容实例节点，需要缩容的节点数量为2。 POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/action/reduce{ "node_number" : 2} 缩容实例节点，实例有多个组，需要缩容的节点数量为1。 POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/action/reduce{ "group_id" : "f080abf2010d45118068c28c8958f5fcgr09", "node_number" : 1}

响应示例 状态码： 200 OK { "security_group_id" : "035b70ed-319b-4086-9fd7-62a2e8548b2e"} 状态码： 400 bad request { "externalMessage" : "Parameter error.", "errCode" : "DBS.280001"} 状态码： 500 server error { "externalMessage" : "Server failure.", "errCode" : "DBS.200412"}

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 security_group_id String 安全组ID。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 errCode String 业务错误码。 externalMessage String 错误信息。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 errCode String 业务错误码。 externalMessage String 错误信息。

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 instanceId String DDM实例ID。 instanceName String DDM实例名称。 jobId String 任务ID。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 errCode String 业务错误码。 externalMessage String 错误信息。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 errCode String 业务错误码。 externalMessage String 错误信息。

响应示例 状态码： 200 ok { "instanceId" : "28e8841d0b9c4f6a9a30742ee60e1068in09", "instanceName" : "ddm-fb88-test", "jobId" : "1eb697c0-1842-43a3-8671-f562d0385cb9"} 状态码： 400 bad request { "externalMessage" : "Parameter error.", "errCode" : "DBS.280001"} 状态码： 500 server error { "externalMessage" : "Server failure.", "errCode" : "DBS.200412"}