检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
修改实例名称 接口说明 修改实例的名称。 约束说明 创建中和创建失败的实例不支持修改实例名称。 调试 您可以在API Explorer中调试该接口。 URI URI格式 PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/modify-name
删除参数模板 接口说明 删除指定参数模板。 约束说明 该接口仅支持DDS社区版。 默认参数模板不允许删除。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI URI格式
查询资源标签 接口说明 查询指定实例的标签信息。 约束说明 一个文档数据库实例具有20个标签配额,且标签key唯一。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET https://{Endpoint}/v3/{project_id}/insta
快速入门 本节通过调用API创建DDS集群实例。 通过IAM服务获取到的Token有效期为24小时,需要使用同一个Token鉴权时,可以先将Token缓存,避免频繁调用。 涉及API 当您使用Token认证方式完成认证鉴权时,需要获取用户Token并在调用接口时增加“X-Auth-Token”到业务接口请求消息头中。
错误码 调用接口出错后,将不会返回结果数据。调用方可根据每个接口对应的错误码来定位错误原因。 当调用出错时,HTTP请求返回一个HTTP状态码。返回的消息体中是具体的错误编码及错误描述信息。 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 错误码说明
instance_id string path 是 实例ID,可以调用“查询实例列表和详情”接口获取。如果未申请实例,可以调用“创建实例”接口创建。 响应消息 参数说明 表2 查询集群均衡设置响应消息 名称 参数类型 是否必选 描述 is_open Boolean 是 集群均衡是否打开。
重启实例 接口说明 重启实例的数据库服务。 文档数据库实例重启过程中将不可用,请谨慎操作。 约束说明 实例状态非“normal”时,不允许重启实例。 调试 您可以在API Explorer中调试该接口。 URI URI格式 POST https://{Endpoint}/v3/{
查询审计日志策略 接口说明 查询审计日志策略。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/auditlog-policy URI样例
删除手动备份 接口说明 删除数据库实例的手动备份。 调试 您可以在API Explorer中调试该接口。 URI URI格式 DELETE https://{Endpoint}/v3/{project_id}/backups/{backup_id} URI样例 https://dds
删除审计日志 接口说明 删除审计日志。 调试 您可以在API Explorer中调试该接口。 URI URI格式 DELETE https://{Endpoint}/v3/{project_id}/instances/{instance_id}/auditlog URI样例 https://dds
复制参数模板 接口说明 复制参数模板。 约束说明 只支持复制自定义的参数模板。 参数模板名称“name”不能与默认参数模板或已有参数模板的名称重复。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
查询实例回收站策略 接口说明 查询实例回收站策略。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET https://{Endpoint}/v3/{project_id}/instances/recycle-policy URI样例 https://dds
String 实例ID,可以调用“查询实例列表和详情”接口获取。如果未申请实例,可以调用“创建实例”接口创建。 请求消息 参数说明 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token。请参考认证鉴权。 表3
获取SSL证书下载地址 接口说明 获取SSL证书下载地址。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/ssl-cert/download-link
应用参数模板 接口说明 指定实例变更参数模板。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI URI格式 PUT https://{Endpoint}/v3/{pr
解除关联LTS日志流 接口说明 将实例日志与LTS日志流解除关联,后台将取消上传实例日志到的LTS日志流里。 调试 您可以在API Explorer中调试该接口。 URI URI格式 DELETE https://{Endpoint}/v3/{project_id}/instan
用“创建实例”接口创建。 请求消息 无。 响应消息 参数说明 表2 响应Body参数 名称 参数类型 说明 status String 开启或关闭慢日志脱敏,取值为on或off。 响应示例 { "status" : "on" } SDK 单击文档数据库服务 DDS SDK
如果已经开启连接地址切换,不能进行该操作。 目前只支持修改为新的IPv4地址。 调试 您可以在API Explorer中调试该接口。 URI URI格式 POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/modify-internal-ip
参数模板比较 接口说明 比较两个参数模板之间的差异。 约束说明 只能同版本且同类型的参数模板进行比较,例如:集群4.0 mongos参数模板只能与同为集群 4.0 mongos的参数模板进行比较。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Expl
询账号下所有日志组”API接口获取。 lts_stream_id String 是 LTS日志流ID。可通过云日志服务-“查询指定日志组下的所有日志流”API接口获取。 请求示例 为实例审计日志配置LTS服务。 POST https://{endpoint}/v3/619d3e7