华为云用户手册

响应消息 参数说明 表2 参数说明 名称 参数类型 是否必选 说明 files Array of objects 是 备份包含的文件列表。 详情请参见表3。 bucket String 是 文件所在的桶名。 表3 files字段数据结构说明 名称 参数类型 是否必选 说明 name String 是 文件名。 size Long 是 文件大小，单位：KB。 download_link String 是 文件下载链接。 link_expired_time String 是 下载链接过期时间，格式为“yyyy-mm-ddThh:mm:ssZ”。其中，T指某个时间的开始，Z指时区偏移量，例如UTC时间偏移显示为+0000。 响应示例 { "files": [ { "name": "43e4feaab48f11e89039fa163ebaa7e4br02.xxx", "size": 2803, "download_link":"https://obs.domainname.com/rdsbucket.username.1/xxxxxx", "link_expired_time":"2018-08-016T10:15:14+0000" } ], "bucket": "rdsbucket.bucketname" }

URI URI格式 GET https://{Endpoint}/v3/{project_id}/backups/download-file?instance_id={instance_id}&backup_id={backup_id} URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/97b026aa9cc4417888c14c84a1ad9860/backups/download-file?instance_id=befb1cfe1f96403780396b0c54f85d11in02&backup_id=bd062e1af2d248b3bb4cd3dbb4183888br02 backup_id可以通过查询备份列表获取。

请求消息 参数说明 表1 请求参数 名称 类型 IN 是否必选 描述 X-Auth-Token String header 是 从 IAM 服务获取的用户Token。请参考认证鉴权。 X-Language String header 否 语言。 project_id String path 是 项目ID。请参考获取项目ID章节获取项目编号。 instance_id String path 是 实例ID，可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。 backup_id String query 是 备份ID。

URI URI格式 POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/modify-internal-ip URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02/modify-internal-ip

响应消息 参数说明 表3 参数说明 名称 参数类型 是否必选 描述 job_id String 是 工作流ID。 node_id String 是 节点ID。 new_ip String 是 新的内网IP。 响应示例 { "job_id":"3711e2ad-5787-49bc-a47f-3f0b066af9f5", "node_id":"52a4c096bb1f455d8d866956a959519eno02", "new_ip":"192.168.0.133" }

响应消息 参数说明 表2 参数说明 名称 参数类型 是否必选 描述 job_id String 是 工作流ID。 node_name String 是 节点名称。 node_id String 是 节点ID。 响应示例 { "job_id": "3711e2ad-5787-49bc-a47f-3f0b066af9f5", "node_id": "52a4c096bb1f455d8d866956a959519eno02", "node_name": "mongodb-8977_mongos_node_1" }

URI URI格式 POST https://{Endpoint}/v3/{project_id}/nodes/{node_id}/unbind-eip URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/nodes/4709a6332ce348718b5675aadb5e2bccno02/unbind-eip

URI URI格式 POST https://{Endpoint}/v3/{project_id}/nodes/{node_id}/bind-eip URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/nodes/4709a6332ce348718b5675aadb5e2bccno02/bind-eip

响应消息 参数说明 表3 参数说明 名称 参数类型 是否必选 描述 job_id String 是 工作流ID。 node_name String 是 节点名称。 node_id String 是 节点ID。 public_ip_id String 是 弹性公网IP的ID。 public_ip String 是 弹性公网IP。 响应示例 { "job_id":"3711e2ad-5787-49bc-a47f-3f0b066af9f5", "node_id":"52a4c096bb1f455d8d866956a959519eno02", "node_name":"mongodb-8977_mongos_node_1", "public_ip":"10.145.51.128", "public_ip_id":"45da4782-e0c8-4aa4-a290-b8740014f710" }

URI URI格式 POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/modify-security-group URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02/modify-security-group

响应消息 参数说明 表3 参数说明 名称 参数类型 是否必选 描述 job_id String 是 工作流ID。 security_group_id String 是 新的安全组ID列表。 响应示例 { "job_id":"3711e2ad-5787-49bc-a47f-3f0b066af9f5", "security_group_id":"73bed21a-708b-4985-b697-a96d0e0d2b39" }

URI URI格式 POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/modify-port URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02/modify-port

URI URI格式 PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/modify-name URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02/modify-name

响应消息 参数说明 表3 参数说明 名称 参数类型 是否必选 描述 job_id String 是 工作流ID。 ssl_option String 是 SSL开关选项。 取值： 取“0”，表示DDS实例不启用SSL连接。 取“1”，表示DDS实例启用SSL连接。 响应示例 { "job_id": "3711e2ad-5787-49bc-a47f-3f0b066af9f5", "ssl_option": "0" }

URI URI格式 POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/switch-ssl URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02/switch-ssl

请求消息 参数说明 表1 请求参数 名称 类型 IN 是否必选 描述 X-Auth-Token string header 是 从IAM服务获取的用户Token。请参考认证鉴权。 project_id string path 是 租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。 instance_id string path 是 实例ID，可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。

URI URI格式 POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/switchover URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02/switchover

URI URI格式 GET https://{Endpoint}/v3/{project_id}/storage-type?engine_name={engine_name} URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/storage-type?engine_name=DDS-Community

请求消息 请求参数 表1 参数说明 名称 类型 IN 必选 描述 x-auth-token string header 是 从IAM服务获取的用户Token。请参考认证鉴权。 project_id string path 是 租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。 engine_name string query 否 数据库版本类型。取值为“DDS-Community”。获取方法请参见查询数据库版本信息。

文档数据库服务授权项说明 表1 实例管理 权限 对接API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 创建实例 POST /v3/{project_id}/instances dds:instance:create vpc:vpcs:list vpc:vpcs:get vpc:subnets:get vpc:securityGroups:get vpc:ports:get √ √ 查询实例列表 GET /v3/{project_id}/instances?id={id}&name={name}&mode={mode}&datastore_type={datastore_type}&vpc_id={vpc_id}&subnet_id={subnet_id}&offset={offset}&limit={limit} dds:instance:list √ √ 删除实例 DELETE /v3/{project_id}/instances/{instance_id} dds:instance:deleteInstance √ √ 重启实例 POST /v3/{project_id}/instances/{instance_id}/restart dds:instance:reboot √ √ 扩容实例存储容量 POST /v3/{project_id}/instances/{instance_id}/enlarge-volume dds:instance:extendVolume √ √ 扩容集群实例的节点数量 POST /v3/{project_id}/instances/{instance_id}/enlarge dds:instance:extendNode vpc:vpcs:list vpc:vpcs:get vpc:subnets:get vpc:securityGroups:get vpc:ports:get √ √ 变更实例规格 POST /v3/{project_id}/instances/{instance_id}/resize dds:instance:modifySpec √ √ 切换副本集实例的主备节点 POST /v3/{project_id}/instances/{instance_id}/switchover dds:instance:switchover √ √ 切换SSL开关 POST/v3/{project_id}/instances/{instance_id}/switch-ssl dds:instance:modifySSL √ √ 修改实例名称 PUT /v3/{project_id}/instances/{instance_id}/modify-name dds:instance:modify √ √ 修改数据库端口 POST /v3/{project_id}/instances/{instance_id}/modify-port dds:instance:modifyPort √ √ 变更实例安全组 POST /v3/{project_id}/instances/{instance_id}/modify-security-group dds:instance:modifySecurityGroup √ √ 绑定弹性公网IP POST /v3/{project_id}/nodes/{node_id}/bind-eip dds:instance:bindPublicIp √ √ 解绑弹性公网IP POST /v3/{project_id}/nodes/{node_id}/unbind-eip dds:instance:unbindPublicIp √ √ 修改实例内网地址 POST /v3/{project_id}/instances/{instance_id}/modify-internal-ip dds:instance:modifyVIP √ √ 打开集群的Shard/Config IP开关 POST /v3/{project_id}/instances/{instance_id}/create-ip dds:instance:createIp √ √ 查询实例可迁移到的可用区 GET /v3/{project_id}/instances/{instance_id}/migrate/az dds:instance:migrate √ √ 实例可用区迁移 POST /v3/{project_id}/instances/{instance_id}/migrate dds:instance:migrate √ √ 表2 连接管理 权限 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 查询实例节点会话 GET /v3/{project_id}/nodes/{node_id}/sessions dds:instance:session √ √ 终结实例节点会话 POST /v3/{project_id}/nodes/{node_id}/session dds:instance:session √ √ 查询实例节点连接数统计 GET /v3/{projectId}/instances/{instance_id}/conn-statistics dds:instance:list √ √ 表3 备份与恢复 权限 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 创建手动备份 POST /v3/{project_id}/backups dds:instance:createManualBackup √ √ 删除手动备份 DELETE /v3/{project_id}/backups/{backups_id} dds:backup:delete √ √ 查询备份列表 GET /v3/{project_id}/backups?instance_id={instance_id}&backup_id={backup_id}&backup_type={backup_type}&offset={offset}&limit={limit}&begin_time={begin_time}&end_time={end_time}&mode={mode} dds:backup:list √ √ 查询自动备份策略 GET /v3/{project_id}/instances/{instance_id}/backups/policy dds:instance:list √ √ 设置自动备份策略 PUT /v3/{project_id}/instances/{instance_id}/backups/policy dds:instance:modifyBackupPolicy √ √ 恢复到新实例 POST /v3/{project_id}/instances dds:instance:create vpc:vpcs:list vpc:vpcs:get vpc:subnets:get vpc:securityGroups:get vpc:ports:get √ √ 获取备份下载链接 GET /v3/{projectId}/backups/download-file dds:backup:download √ √ 查询可恢复的时间段 GET /v3/{project_id}/instances/{instance_id}/restore-time dds:instance:list √ √ 获取可恢复的数据库列表 GET /v3/{project_id}/instances/{instance_id}/restore-database dds:instance:list √ √ 获取可恢复的数据库集合列表 GET /v3/{project_id}/instances/{instance_id}/restore-collection dds:instance:list √ √ 恢复到当前实例 POST /v3/{project_id}/instances/recovery dds:backup:refreshInstanceFromBackup √ √ 库表级时间点恢复 POST /v3/{project_id}/instances/{instance_id}/restore/collections dds:backup:refreshInstanceFromBackup √ √ 表4 参数配置 权限 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 获取参数模板列表 GET /v3/{project_id}/configurations dds:param:list √ √ 创建参数模板 PUT /v3/{project_id}/configurations dds:param:create √ √ 删除参数模板 DELETE /v3/{project_id}/configurations/{config_id} dds:param:delete √ √ 获取参数模板的详情 GET /v3/{projectId}/configurations/{configId} dds:param:list √ √ 修改参数模板 PUT /v3/{project_id}/configurations/{config_id} dds:param:modify √ √ 应用参数模板 PUT /v3/{project_id}/configurations/{config_id}/apply dds:instance:modifyParameter √ √ 获取指定实例的参数信息 GET /v3/{project_id}/instances/{instance_id}/configurations dds:param:list √ √ 修改指定实例的参数 PUT /v3/{project_id}/instances/{instance_id}/configurations dds:instance:modifyParameter √ √ 表5 获取日志信息 权限 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 查询数据库慢日志 GET /v3/{project_id}/instances/{instance_id}/slowlog dds:instance:list √ √ 获取慢日志下载链接 POST /v3/{project_id}/instances/{instance_id}/slowlog-download dds:instance:list √ √ 查询数据库错误日志 GET /v3/{project_id}/instances/{instance_id}/errorlog dds:instance:list √ √ 获取错误日志下载链接 POST /v3/{project_id}/instances/{instance_id}/errorlog-download dds:instance:list √ √ 设置审计日志策略 POST /v3/{project_id}/instances/{instance_id}/auditlog-policy dds:instance:modifyAuditLogSwitch √ √ 查询审计日志策略 GET /v3/{project_id}/instances/{instance_id}/auditlog-policy dds:instance:list √ √ 查询审计日志列表 GET /v3/{project_id}/instances/{instance_id}/auditlog dds:instance:list √ √ 获取审计日志下载链接 POST /v3/{project_id}/instances/{instance_id}/auditlog-links dds:instance:downloadAuditLog √ √ 表6 标签管理 权限 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 批量添加或删除资源标签 POST /v3/{project_id}/instances/{instance_id}/tags/action dds:instance:modify √ √ 查询资源标签 GET /v3/{project_id}/instances/{instance_id}/tags dds:instance:list √ √ 表7 管理数据库和用户 权限 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 创建数据库用户 POST /v3/{project_id}/instances/{instance_id}/db-user dds:instance:createDatabaseUser √ √ 创建数据库角色 POST /v3/{project_id}/instances/{instance_id}/db-role dds:instance:createDatabaseRole √ √ 删除数据库用户 DELETE /v3/{project_id}/instances/{instance_id}/db-user dds:instance:deleteDatabaseUser √ √ 删除数据库角色 DELETE /v3/{project_id}/instances/{instance_id}/db-role dds:instance:deleteDatabaseRole √ √ 修改数据库用户密码 PUT /v3/{project_id}/instances/{instance_id}/reset-password dds:instance:resetPasswd √ √ 查询数据库用户列表 GET /v3/{project_id}/instances/{instance_id}/db-user/detail? offset ={offset}&limit={limit}&user_name={user_name }&db_name={db_name} dds:instance:get √ √ 查询数据库角色列表 GET /v3/{project_id}/instances/{instance_id}/db-roles?role_name={role_name}&db_name={db_name}&offset={offset}&limit={limit} dds:instance:get √ √ 查询和设置集群均衡器 GET /v3/{project_id}/instances/{instance_id}/balancer PUT /v3/{project_id}/instances/{instance_id}/balancer/{action} PUT /v3/{project_id}/instances/{instance_id}/balancer/active-window dds:instance:balancer √ √ “√”表示支持，“x”表示暂不支持。 父主题： 权限策略和授权项

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

响应消息 参数说明 表2 参数说明 名称 是否必选 参数类型 描述 tags 是 Array of objects 标签列表。详情请参见表3。 表3 tags字段数据结构说明 名称 是否必选 参数类型 描述 key 是 String 标签键。 key不能为空，长度1~128个半角字符。 可用 UTF-8 格式表示的字母(包含中文)、数字和空格，以及以下字符： _ . : / = + - @。 _sys_开头属于系统标签，租户不能输入。 字符集：0-9，A-Z，a-z，“_”，“-”，中文。 values 是 Array of strings 标签值列表。 可用 UTF-8 格式表示的字母(包含中文)、数字和空格，以及以下字符： _ . : / = + - @。 可以为空（empty or null），长度0~255个半角字符。 字符集：0-9，A-Z，a-z，“_”，“-”，中文。 响应示例 { "tags": [ { "key": "key1", "values": [ "value1", "value2" ] }, { "key": "key2", "values": [ "value1", "value2" ] } ] }

响应消息 参数说明 表2 参数说明 名称 是否必选 参数类型 描述 tags 是 Array of objects 实例标签列表。详情请参见表3。 表3 tags字段数据结构说明 名称 是否必选 参数类型 描述 key 是 String 标签键。 key不能为空，长度1~128个半角字符。 可用 UTF-8 格式表示的字母(包含中文)、数字和空格，以及以下字符： _ . : / = + - @。 _sys_开头属于系统标签，租户不能输入。 字符集：0-9，A-Z，a-z，“_”，“-”，中文。 value 是 String 标签值。 可用 UTF-8 格式表示的字母(包含中文)、数字和空格，以及以下字符： _ . : / = + - @。 可以为空（empty or null），长度0~255个半角字符。 字符集：0-9，A-Z，a-z，“_”，“.”，“-”，中文。 响应示例 { "tags": [ { "key": "key1", "value": "value1" }, { "key": "key2", "value": "value2" } ] }

URI URI格式 GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/tags URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/cc6345c64cec47499182467ea0dd432ain02/tags

请求消息 参数说明 表1 请求参数 名称 类型 IN 是否必选 描述 X-Auth-Token string header 是 从IAM服务获取的用户Token。请参考认证鉴权。 project_id string path 是 租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。 instance_id string path 是 实例ID，可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。

请求消息 参数说明 表2 参数说明 名称 参数类型 是否必选 描述 action String 是 操作标识。取值： create，表示添加标签。 delete，表示删除标签。 tags Array of objects 是 标签列表。详情请参见表3。 说明： 删除标签时，不对该参数做字符集校验。 表3 tags字段数据结构说明 名称 参数类型 是否必选 描述 key String 是 标签键。 key不能为空，长度1~128个半角字符。 可用 UTF-8 格式表示的字母(包含中文)、数字和空格，以及以下字符： _ . : / = + - @。 _sys_开头属于系统标签，租户不能输入。 字符集：0-9，A-Z，a-z，“_”，“-”，中文。 value String 否 标签值。 可用 UTF-8 格式表示的字母(包含中文)、数字和空格，以及以下字符： _ . : / = + - @。 可以为空（empty or null），长度0~255个半角字符。 字符集：0-9，A-Z，a-z，“_”，“.”，“-”，中文。 “action”值为“create”时，该参数必选。 “action”值为“delete”时，该参数可选。 说明： 删除标签时，如果value有值，则按照key/value匹配删除；如果value没有值，则按照key删除。

请求示例 批量添加2个标签 { "action": "create", "tags": [ { "key": "key1", "value": "value1" }, { "key": "key", "value": "value3" } ] } 批量删除2个标签 { "action": "delete", "tags": [ { "key": "key1" }, { "key": "key2", "value": "value3" } ] }

URI URI格式 POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/tags/action URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/cc6345c64cec47499182467ea0dd432ain02/tags/action

响应消息 参数说明 表5 参数说明 名称 参数类型 描述 instances Array of objects 实例列表。详情请参见表6。 total_count Integer 总记录数。 表6 instance字段数据结构说明 名称 参数类型 描述 instance_id String 实例ID，可以调用“查询实例列表”接口获取。如果未申请实例，可以调用“创建实例”接口创建。 instance_name String 实例名称。 tags Array of objects 标签列表。如果没有标签，默认为空数组。详情请参见表7。 表7 tags字段数据结构说明 名称 参数类型 描述 key String 标签键。 key不能为空，长度1~128个半角字符。 可用 UTF-8 格式表示的字母(包含中文)、数字和空格，以及以下字符： _ . : / = + - @。 _sys_开头属于系统标签，租户不能输入。 字符集：0-9，A-Z，a-z，“_”，“-”，中文。 value String 标签值。 可用 UTF-8 格式表示的字母(包含中文)、数字和空格，以及以下字符： _ . : / = + - @。 可以为空（empty or null），长度0~255个半角字符。 字符集：0-9，A-Z，a-z，“_”，“.”，“-”，中文。 响应示例 根据标签返回指定实例： { "instances": [ { "instance_id": "2acbf2223caf3bac3c33c6153423c3ccin02", "instance_name": "test-single", "tags": [ { "key": "key1", "value": "value1" }, { "key": "key2", "value": "value1" } ] } ] } 返回总记录数： { "total_count": 4 }

请求示例 根据标签，按实例名称查询1~100条指定实例信息 { "offset": "100", "limit": "100", "action": "filter", "matches": [ { "key": "instance_name", "value": "test-single" } ], "tags": [ { "key": "key1", "values": [ "value1", "value2" ] } ] } 按照实例名称或按实例ID查询总记录数 { "action": "count", "tags": [ { "key": "key1", "values": [ "value1", "value2" ] }, { "key": "key2", "values": [ "value1", "value2" ] } ], "matches": [ { "key": "instance_name", "value": "test-single" }, { "key": "instance_id", "value": "958693039f284d6ebfb177375711072ein02" } ] }