如何调用API 构造请求 认证鉴权 返回结果
API概览 文档数据库服务所提供的接口为扩展接口。通过使用文档数据库服务接口,您可以使用文档数据库服务的部分功能,具体如下表所示。 表1 接口说明 类型 描述 查询API版本 包括查询API版本信息列表、查询指定API版本信息接口。
API v3(推荐) 查询API版本 查询数据库版本信息 查询数据库规格 查询数据库磁盘类型 实例管理 连接管理 备份与恢复 参数配置 获取日志信息 标签管理 管理数据库和用户 配额管理 数据库运维 任务管理
API v3(即将下线) 查询所有实例规格信息 查询数据库慢日志 查询数据库错误日志
查询API版本 查询API版本列表 查询API版本信息 父主题: API v3(推荐)
查询API版本信息 接口说明 查询指定API版本信息。 调试 您可以在API Explorer中调试该接口。
查询API版本列表 接口说明 查询当前支持的API版本信息列表。 调试 您可以在API Explorer中调试该接口。
错误码 调用接口出错后,将不会返回结果数据。调用方可根据每个接口对应的错误码来定位错误原因。 当调用出错时,HTTP请求返回一个HTTP状态码。返回的消息体中是具体的错误编码及错误描述信息。 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。
对于获取用户Token接口,返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后,您就可以使用Token认证调用其他API。 父主题: 如何调用API
查询实例磁盘信息 获取SSL证书下载地址 查询数据库复制集名称 修改数据库复制集名称 删除实例的节点 删除实例的只读节点 查询副本集跨网段访问配置 查询LTS日志配置信息 关联LTS日志流 解除关联LTS日志流 设置磁盘自动扩容策略 查询磁盘自动扩容策略 批量数据库补丁升级 父主题: API
调试 您可以在API Explorer中调试该接口。
解绑弹性公网IP 接口说明 解绑实例下节点已经绑定的弹性公网IP。 约束说明 冻结实例不支持该操作。 没有绑定弹性公网IP的节点不支持该操作。 调试 您可以在API Explorer中调试该接口。
标签管理 查询资源实例 批量添加或删除资源标签 查询资源标签 查询项目标签 父主题: API v3(推荐)
Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。 当您使用Token认证方式完成认证鉴权时,需要获取用户Token并在调用接口时增加“X-Auth-Token”到业务接口请求消息头中。
创建参数模板 删除参数模板 获取参数模板详情 修改参数模板 应用参数模板 获取指定实例的参数信息 修改指定实例的参数 查询可应用的实例 查询参数模板应用历史 查询参数修改历史 参数模板比较 复制参数模板 重置参数模板 校验参数模板名称是否存在 查询实例参数的修改历史 父主题: API
获取日志信息 查询数据库慢日志(新版) 获取慢日志下载链接 设置慢日志明文开关 查询数据库错误日志(新版) 获取错误日志下载链接 设置审计日志策略 查询审计日志策略 获取审计日志列表 获取审计日志下载链接 查询慢日志明文开关 删除审计日志 父主题: API v3(推荐)
任务管理 获取指定ID的任务信息 查询任务列表和详情 查询定时任务 取消定时任务 父主题: API v3(推荐)
配额管理 查询配额 父主题: API v3(推荐)
备份与恢复 创建手动备份 删除手动备份 查询备份列表 查询自动备份策略 设置自动备份策略 恢复到新实例 获取备份下载链接 查询可恢复的时间段 获取可恢复的数据库列表 获取可恢复的数据库集合列表 恢复到当前实例 库表级时间点恢复 停止备份 批量删除手动备份 父主题: API v3(推荐
父主题: 如何调用API
您即将访问非华为云网站,请注意账号财产安全