检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
构造请求 本节介绍REST API请求的组成,并以调用IAM服务的获取用户Token说明如何调用API,该API获取用户的Token,Token可以用于调用其他API时鉴权。 您还可以通过这个视频教程了解如何构造请求调用API:https://bbs.huaweicloud.com
认证鉴权 DDS调用接口有如下两种认证方式,您可以选择其中一种进行认证鉴权。 Token认证:通过Token认证通用请求。 AK/SK认证:通过AK(Access Key ID)/SK(Secret Access Key)加密调用请求。推荐使用AK/SK认证,其安全性比Token认证要高
返回结果 状态码 请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于获取用户Token接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头
配额管理 查询配额 父主题: API v3(推荐)
标签管理 查询资源实例 批量添加或删除资源标签 查询资源标签 查询项目标签 父主题: API v3(推荐)
获取日志信息 查询数据库慢日志(新版) 获取慢日志下载链接 设置慢日志明文开关 查询数据库错误日志(新版) 获取错误日志下载链接 设置审计日志策略 查询审计日志策略 获取审计日志列表 获取审计日志下载链接 查询慢日志明文开关 删除审计日志 父主题: API v3(推荐)
连接管理 查询实例节点会话 终结实例节点会话 查询实例节点连接数统计 父主题: API v3(推荐)
任务管理 获取指定ID的任务信息 查询任务列表和详情 查询定时任务 取消定时任务 父主题: API v3(推荐)
参数配置 获取参数模板列表 创建参数模板 删除参数模板 获取参数模板详情 修改参数模板 应用参数模板 获取指定实例的参数信息 修改指定实例的参数 查询可应用的实例 查询参数模板应用历史 查询参数修改历史 参数模板比较 复制参数模板 重置参数模板 校验参数模板名称是否存在 查询实例参数的修改历史
实例管理 创建实例 重启实例 删除实例 查询实例列表和详情 扩容实例存储容量 扩容集群实例的节点数量 变更实例规格 切换副本集实例的主备节点 切换SSL开关 修改实例名称 修改实例备注 修改数据库端口 变更实例安全组 绑定弹性公网IP 解绑弹性公网IP 修改实例内网地址 创建集群的
备份与恢复 创建手动备份 删除手动备份 查询备份列表 查询自动备份策略 设置自动备份策略 恢复到新实例 获取备份下载链接 查询可恢复的时间段 获取可恢复的数据库列表 获取可恢复的数据库集合列表 恢复到当前实例 库表级时间点恢复 停止备份 批量删除手动备份 父主题: API v3(推荐
创建实例 接口说明 创建文档数据库实例,包括集群实例和副本集实例。 约束说明 该接口既支持创建包年包月实例,也支持按需实例。 调试 您可以在API Explorer中调试该接口。 URI URI格式 POST https://{Endpoint}/v3/{project_id}/instances
切换SSL开关 接口说明 切换实例的SSL开关。 约束说明 冻结实例,异常实例不支持该操作。 切换SSL后,后台会重启实例,请谨慎操作。 调试 您可以在API Explorer中调试该接口。 URI URI格式 POST https://{Endpoint}/v3/{project_id
判断标准 您可以通过表2中的几个维度,判断所选分片键是否能够满足业务需求。 表2 合理分片键的判断依据 判断依据 说明 片键基数 片键基数是指划分数据块的能力。
重启实例 接口说明 重启实例的数据库服务。 文档数据库实例重启过程中将不可用,请谨慎操作。 约束说明 实例状态非“normal”时,不允许重启实例。 调试 您可以在API Explorer中调试该接口。 URI URI格式 POST https://{Endpoint}/v3/{project_id
查询配额 接口说明 查询单租户在DDS服务下的资源配额,包括集群实例配额、单节点实例配额和副本集实例配额。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET https://{Endpoint}/v3/{project_id}/quotas URI样例
删除实例 接口说明 删除数据库实例。 约束说明 暂不支持删除包周期实例。 调试 您可以在API Explorer中调试该接口。 URI URI格式 DELETE https://{Endpoint}/v3/{project_id}/instances/{instance_id} URI
查询项目标签 接口说明 查询指定project ID下实例的所有标签集合。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET https://{Endpoint}/v3/{project_id}/tags URI样例 https://dds.cn-north
查询数据库磁盘类型 接口说明 查询当前区域下的数据库磁盘类型。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET https://{Endpoint}/v3/{project_id}/storage-type?engine_name={engine_name
创建参数模板 接口说明 创建参数模板信息,包含参数模板名称、描述、数据库版本信息、参数值。 约束说明 该接口仅支持DDS社区版。 创建参数模板的名称“name”不能与默认参数模板或已有参数模板的名称重复,并且区分大小写。 创建参数模板的parameter_values参数必须在指定数据库版本的默认参数范围内