检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
绑定弹性公网IP 接口说明 为实例下的节点绑定弹性公网IP。 约束说明 冻结实例,异常实例不支持该操作。 集群实例的shard和config节点,副本集的Readonly节点以及Hidden角色节点不支持该操作。 不支持多个弹性公网IP绑定同一个节点。 调试 您可以在API Explorer中调试该接口。
重启实例 接口说明 重启实例的数据库服务。 文档数据库实例重启过程中将不可用,请谨慎操作。 约束说明 实例状态非“normal”时,不允许重启实例。 调试 您可以在API Explorer中调试该接口。 URI URI格式 POST https://{Endpoint}/v3/{
欠费后需要及时充值,详细操作请参见帐户充值。 若文档数据库服务DDS实例不再使用,您可以将他们删除,以免继续扣费。 您可以在“费用中心 > 总览”页面设置“可用额度预警”功能,当可用额度的总额度低于预警阈值时,系统自动发送短信和邮件提醒。
查询可应用的实例 接口说明 查询指定参数模板可被应用的实例。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI URI格式 GET https://{Endpoint}
获取审计日志下载链接 接口说明 获取审计日志下载链接。 调试 您可以在API Explorer中调试该接口。 URI URI格式 POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/auditlog-links
查询副本集跨网段访问配置 接口说明 查询副本集跨网段访问配置。 约束说明 只支持副本集实例。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET https://{Endpoint}/v3/{project_id}/instances/{instan
查询自动备份策略 接口说明 查询自动备份策略。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/backups/policy URI样例
快速入门 本节通过调用API创建DDS集群实例。 通过IAM服务获取到的Token有效期为24小时,需要使用同一个Token鉴权时,可以先将Token缓存,避免频繁调用。 涉及API 当您使用Token认证方式完成认证鉴权时,需要获取用户Token并在调用接口时增加“X-Auth-Token”到业务接口请求消息头中。
查询数据库列表 接口说明 查询数据库列表。 约束说明 该接口只支持DDS社区版。 实例在创建、规格变更、修改端口、冻结、重启等过程中以及状态为非“normal”时,不允许执行该操作。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET https:/
修改实例内网地址 接口说明 修改实例的内网地址。 约束说明 冻结实例,异常实例不支持该操作。 已使用的IP地址,不能作为实例的新内网地址。 修改内网地址会导致原地址链接失效,如果有绑定弹性公网IP,那么在修改内网地址的过程中,请不要操作解绑。 如果已经开启连接地址切换,不能进行该操作。
查询审计日志策略 接口说明 查询审计日志策略。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/auditlog-policy URI样例
解绑弹性公网IP 接口说明 解绑实例下节点已经绑定的弹性公网IP。 约束说明 冻结实例不支持该操作。 没有绑定弹性公网IP的节点不支持该操作。 调试 您可以在API Explorer中调试该接口。 URI URI格式 POST https://{Endpoint}/v3/{pro
修改数据库复制集名称 接口说明 修改数据库复制集名称。 文档数据库实例在修改数据库复制集名称过程中将不可用,请谨慎操作。 约束说明 仅支持副本集实例。 实例在创建、规格变更、修改端口、重启等过程中以及状态为非“normal”时,不允许执行该操作。 调试 您可以在API Explorer中调试该接口。
停止备份 接口说明 支持紧急情况下停止备份功能。 约束说明 仅支持状态为备份中或备份上传中的实例。 调试 您可以在API Explorer中调试该接口。 URI URI格式 PUT https://{Endpoint}/v3/{project_id}/backups/{backup_id}
删除数据库角色 接口说明 删除指定实例的数据库角色。 约束说明 该接口只支持DDS社区版。 系统默认角色不支持删除。 实例在创建、规格变更、修改端口、冻结、重启等过程中以及状态为非“normal”时,不允许执行该操作。 调试 您可以在API Explorer中调试该接口。 URI
000。 max_concurrency和secs_running不可同时为0。 secs_running 否 Integer 单条操作最大运行时长。 可为空,默认为0,表示不做限制。单位:s。最小值为2,最大值为86400。 secs_running和max_concurrency不可同时为0。
获取备份下载链接 接口说明 获取备份下载链接。 约束说明 备份下载链接在更新时间后15分钟内有效。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET https://{Endpoint}/v3/{project_id}/backups/download-file
创建数据库角色 接口说明 给指定实例创建数据库角色。 约束说明 该接口只支持DDS社区版。 实例在创建、规格变更、修改端口、冻结、重启等过程中以及状态为非“normal”时,不允许执行该操作。 调试 您可以在API Explorer中调试该接口。 URI URI格式 POST h
表1 参数说明 字段 类型 说明 apped boolean 可选的,如果要创建一个固定集合,该值为true,如果该值为ture,需要同时设置size字段。 autoIndexId boolean 如果指定为false,表示禁止自动在_id字段创建索引。 size number
查询资源标签 接口说明 查询指定实例的标签信息。 约束说明 一个文档数据库实例具有20个标签配额,且标签key唯一。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET https://{Endpoint}/v3/{project_id}/insta