检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
修改数据库用户密码 检查数据库密码 查询集群均衡设置 设置集群均衡开关 设置集群均衡活动时间窗 删除数据库用户 删除数据库角色 查询数据库列表 父主题: API v3(推荐)
扩容副本集实例的节点数量 接口说明 扩容指定副本集实例的节点数量。 约束说明 该接口既支持包年包月实例,也支持按需实例。 调试 您可以在API Explorer中调试该接口。 URI URI格式 POST https://{Endpoint}/v3/{project_id}/in
创建数据库角色 接口说明 给指定实例创建数据库角色。 约束说明 该接口只支持DDS社区版。 实例在创建、规格变更、修改端口、冻结、重启等过程中以及状态为非“normal”时,不允许执行该操作。 调试 您可以在API Explorer中调试该接口。 URI URI格式 POST h
恢复到当前实例 接口说明 恢复到当前实例。 针对集群实例,如果当前存在只读节点,不支持恢复到当前实例,只能恢复到新实例。 调试 您可以在API Explorer中调试该接口。 URI URI格式 POST https://{Endpoint}/v3/{project_id}/instances/recovery
慢日志最多保存30天。 调试 您可以在API Explorer中调试该接口。 URI URI格式 POST https://{Endpoint}/v3.1/{project_id}/instances/{instance_id}/slow-logs URI样例 https://dds.cn-north-1
查询集群均衡设置 接口说明 查询DDS集群的数据均衡设置,包括均衡开关和均衡活动时间窗的设置。其中,均衡活动时间窗的信息仅在DDS 4.0及以上版本返回。 约束说明 冻结实例不支持该操作。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET http
切换副本集实例的主备节点 接口说明 切换副本集实例下的主备节点。 约束说明 该接口仅支持DDS副本集实例。 冻结实例,异常实例不支持该操作。 调试 您可以在API Explorer中调试该接口。 URI URI格式 POST https://{Endpoint}/v3/{proj
查询实例可迁移到的可用区 接口说明 查询实例可迁移到的可用区。 约束说明 如需使用该接口,请联系相关工作人员申请开通。 支持DDS社区版集群、副本集实例。 跨AZ实例不支持该操作。 IPV6子网创建的实例不支持该操作。 针对副本集实例,如果当前存在只读节点或未激活的备节点,不支持该操作。
查询参数模板应用历史 接口说明 查询参数模板应用历史。 约束说明 实例删除后,参数模板应用历史中相关记录也将被删除。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI URI格式
错误码 调用接口出错后,将不会返回结果数据。调用方可根据每个接口对应的错误码来定位错误原因。 当调用出错时,HTTP请求返回一个HTTP状态码。返回的消息体中是具体的错误编码及错误描述信息。 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 错误码说明
取消定时任务 功能介绍 根据任务ID取消定时任务。 调试 您可以在API Explorer中调试该接口。 URI DELETE https://{Endpoint}/v3/{project_id}/scheduled-jobs/{job_id} 表1 路径参数 参数 是否必选 参数类型
创建数据库用户 接口说明 给指定实例创建数据库用户。 约束说明 该接口只支持DDS社区版。 实例在创建、规格变更、修改端口、冻结、重启等过程中以及状态为非“normal”时,不允许执行该操作。 调试 您可以在API Explorer中调试该接口。 URI URI格式 POST h
实例ID,可以调用“查询实例列表和详情”接口获取。如果未申请实例,可以调用“创建实例”接口创建。 请求消息 参数说明 表2 参数说明 名称 参数类型 是否必选 描述 target_azs String 是 迁移到的目标单az或者多az。该值从查询实例可迁移到的可用区接口的返回体中code字段获取。
删除数据库角色 接口说明 删除指定实例的数据库角色。 约束说明 该接口只支持DDS社区版。 系统默认角色不支持删除。 实例在创建、规格变更、修改端口、冻结、重启等过程中以及状态为非“normal”时,不允许执行该操作。 调试 您可以在API Explorer中调试该接口。 URI URI格式
查询副本集跨网段访问配置 接口说明 查询副本集跨网段访问配置。 约束说明 只支持副本集实例。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET https://{Endpoint}/v3/{project_id}/instances/{instan
获取错误日志下载链接 接口说明 获取错误日志下载链接。 约束说明 错误日志下载链接在更新时间后15分钟内有效。 调试 您可以在API Explorer中调试该接口。 URI URI格式 POST https://{Endpoint}/v3/{project_id}/instanc
绑定弹性公网IP 接口说明 为实例下的节点绑定弹性公网IP。 约束说明 冻结实例,异常实例不支持该操作。 集群实例的shard和config节点,副本集的Readonly节点以及Hidden角色节点不支持该操作。 不支持多个弹性公网IP绑定同一个节点。 调试 您可以在API Explorer中调试该接口。
修改数据库复制集名称 接口说明 修改数据库复制集名称。 文档数据库实例在修改数据库复制集名称过程中将不可用,请谨慎操作。 约束说明 仅支持副本集实例。 实例在创建、规格变更、修改端口、重启等过程中以及状态为非“normal”时,不允许执行该操作。 调试 您可以在API Explorer中调试该接口。
获取可恢复的数据库列表 接口说明 获取可恢复的数据库列表。 约束说明 该接口只支持副本集实例。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET https://{Endpoint}/v3/{project_id}/instances/{insta
查询数据库列表 接口说明 查询数据库列表。 约束说明 该接口只支持DDS社区版。 实例在创建、规格变更、修改端口、冻结、重启等过程中以及状态为非“normal”时,不允许执行该操作。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET https:/