正在生成
详细信息:
检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 文档数据库服务所提供的接口为扩展接口。通过使用文档数据库服务接口,您可以使用文档数据库服务的部分功能,具体如下表所示。 表1 接口说明 类型 描述 查询API版本 包括查询API版本信息列表、查询指定API版本信息接口。 查询数据库版本信息 查询指定实例类型的数据库版本信息。
API v3(推荐) 查询API版本 查询数据库版本信息 查询数据库规格 查询数据库磁盘类型 实例管理 连接管理 备份与恢复 参数配置 获取日志信息 标签管理 管理数据库和用户 配额管理 数据库运维 任务管理
查询API版本 查询API版本列表 查询API版本信息 父主题: API v3(推荐)
如何调用API 构造请求 认证鉴权 返回结果
查询API版本信息 接口说明 查询指定API版本信息。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET https://{Endpoint}/{version} URI样例 https://dds.cn-north-1.myhuaweicloud
查询API版本列表 接口说明 查询当前支持的API版本信息列表。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET https://{Endpoint}/ URI样例 https://dds.cn-north-1.myhuaweicloud.com/
API v3(即将下线) 查询所有实例规格信息 查询数据库慢日志 查询数据库错误日志
连接管理 查询实例节点会话 终结实例节点会话 查询实例节点连接数统计 父主题: API v3(推荐)
文档数据库服务授权项说明 表1 实例管理 权限 对接API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 创建实例 POST /v3/{project_id}/instances dds:instance:create
删除审计日志 接口说明 删除审计日志。 调试 您可以在API Explorer中调试该接口。 URI URI格式 DELETE https://{Endpoint}/v3/{project_id}/instances/{instance_id}/auditlog URI样例 https://dds
完整的状态码列表请参见状态码。 对于获取用户Token接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头,响应同样也有消息头,如“Content-type”。 对于获取用户Token接口,返回如图1所示的消息头,其中“x-subject-tok
文字符必须为UTF-8编码。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于获取用户Token接口,您可以从接口的请求部分看到所需的请求参数及参数说
就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。 当您使用Token认证方式完成认证鉴权时,需要获取用户Token并在调用接口时增加“X-Auth-Token”到业务接口请求消息头中。 Token可通过调用获取用户Token接口获取,调用
删除实例 接口说明 删除数据库实例。 约束说明 暂不支持删除包周期实例。 调试 您可以在API Explorer中调试该接口。 URI URI格式 DELETE https://{Endpoint}/v3/{project_id}/instances/{instance_id} URI样例
删除参数模板 接口说明 删除指定参数模板。 约束说明 该接口仅支持DDS社区版。 默认参数模板不允许删除。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI URI格式
重启实例 接口说明 重启实例的数据库服务。 文档数据库实例重启过程中将不可用,请谨慎操作。 约束说明 实例状态非“normal”时,不允许重启实例。 调试 您可以在API Explorer中调试该接口。 URI URI格式 POST https://{Endpoint}/v3/{
查询配额 接口说明 查询单租户在DDS服务下的资源配额,包括集群实例配额、单节点实例配额和副本集实例配额。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET https://{Endpoint}/v3/{project_id}/quotas URI样例
获取参数模板详情 接口说明 获取指定参数模板的参数信息。 约束说明 该接口仅支持DDS社区版。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI URI格式 GET h
创建实例 接口说明 创建文档数据库实例,包括集群实例和副本集实例。 约束说明 该接口既支持创建包年包月实例,也支持按需实例。 调试 您可以在API Explorer中调试该接口。 URI URI格式 POST https://{Endpoint}/v3/{project_id}/instances
获取指定实例的参数信息 修改指定实例的参数 查询可应用的实例 查询参数模板应用历史 查询参数修改历史 参数模板比较 复制参数模板 重置参数模板 父主题: API v3(推荐)