检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
应用示例 查询实例列表 修改实例名称 删除实例
解除关联LTS日志流 接口说明 将实例日志与LTS日志流解除关联,后台将取消上传实例日志到的LTS日志流里。 调试 您可以在API Explorer中调试该接口。 URI URI格式 DELETE https://{Endpoint}/v3/{project_id}/instan
扩容副本集实例的节点数量 接口说明 扩容指定副本集实例的节点数量。 约束说明 该接口既支持包年包月实例,也支持按需实例。 调试 您可以在API Explorer中调试该接口。 URI URI格式 POST https://{Endpoint}/v3/{project_id}/in
欢迎使用文档数据库服务(Document Database Service,简称DDS)。您可以使用本文档提供API对文档数据库服务进行相关操作,如创建实例、删除实例、查询实例列表等。支持的全部操作请参见API概览。 在调用文档数据库服务API之前,请确保已经充分了解文档数据库服务相关概念,详细信息请参见产品介绍。 父主题:
终端节点 终端节点(Endpoint)即调用API的请求地址,不同服务不同区域的终端节点不同,您可以从地区和终端节点中查询所有服务的终端节点。 父主题: 使用前必读
获取项目ID 操作场景 在调用接口的时候,部分URL中需要填入项目ID,所以需要获取到项目ID。有如下获取方式: 调用API获取项目ID 从控制台获取项目ID 调用API获取项目ID 项目ID可以通过调用查询指定条件下的项目列表API获取。 获取项目ID的接口为“GET https:/
附录 异常请求结果 状态码 错误码 获取项目ID 文档数据库服务监控指标说明
错误码 调用接口出错后,将不会返回结果数据。调用方可根据每个接口对应的错误码来定位错误原因。 当调用出错时,HTTP请求返回一个HTTP状态码。返回的消息体中是具体的错误编码及错误描述信息。 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 错误码说明
状态码 正常 状态码 编码 状态说明 200 OK 请求成功。 202 Accepted 异步请求成功提交。 异常 状态码 编码 状态说明 304 Not modified 请求失败。 请求参数不符合规则。 400 Bad Request 非法请求。 建议直接修改该请求,不要重试该请求。
快速入门 本节通过调用API创建DDS集群实例。 通过IAM服务获取到的Token有效期为24小时,需要使用同一个Token鉴权时,可以先将Token缓存,避免频繁调用。 涉及API 当您使用Token认证方式完成认证鉴权时,需要获取用户Token并在调用接口时增加“X-Auth-Token”到业务接口请求消息头中。
管理工作。 用户 由账号在IAM中创建的用户,是云服务的使用人员,具有身份凭证(密码和访问密钥)。 在我的凭证下,您可以查看账号ID和用户ID。通常在调用API的鉴权过程中,您需要用到账号、用户和密码等信息。 区域 指云资源所在的物理位置,同一区域内可用区间内网互通,不同区域间内
使用前必读 概述 调用说明 终端节点 约束与限制 基本概念
调用说明 文档数据库服务提供了REST(Representational State Transfer)风格API,支持您通过HTTPS请求调用,调用方法请参见如何调用API。 父主题: 使用前必读
约束与限制 您能创建的文档数据库实例的数量与配额有关系,具体请参见配额。 更详细的限制请参见具体API的说明。 父主题: 使用前必读
异常请求结果 异常响应参数说明 表1 参数说明 名称 参数类型 描述 error_code String 提交任务异常时返回的错误编码。 error_msg String 提交任务异常时返回的错误描述信息。 异常响应示例 { "error_code": "DBS.200001"
删除实例 场景描述 本章节指导用户通过删除实例接口删除DDS实例。 操作步骤 删除DDS实例。 接口相关信息 URI格式 DELETE https://{Endpoint}/v3/{project_id}/instances/{instance_id} {Endpoint}信息请从地区和终端节点获取。
权限策略和授权项 策略和授权项说明 文档数据库服务授权项说明
5个。 案例:出现数据查询缓慢,如果没有创建索引,建议对经常查询的数据字段创建适当的索引,优化查询速度。 对于包含多个键的查询,建议创建包含这些键的复合索引。复合索引的键值顺序很关键,需遵循索引最左前缀原则,查询应包含最左索引字段,以索引创建顺序为准,与查询字段顺序无关。 给索引
修改实例名称 场景描述 本章节指导用户通过调用修改实例名称接口修改实例名称。 操作步骤 修改DDS实例名称。 接口相关信息 URI格式 PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/modify-name
须具备调用该接口所需的权限,否则,API请求将调用失败。每个接口所需要的权限,与各个接口所对应的授权项相对应,只有发起请求的用户被授予授权项所对应的策略,该用户才能成功调用该接口。例如,用户要调用接口来查询文档数据库实例列表,那么这个IAM用户被授予的策略中必须包含允许“dds: