检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
是否必选 描述 X-Auth-Token string header 是 从IAM服务获取的用户Token。请参考认证鉴权。 project_id string path 是 租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。 instance_id string
修改参数模板 接口说明 修改指定参数模板的参数信息,包括名称、描述、指定参数的值。 约束说明 该接口仅支持DDS社区版。 默认参数模板不允许修改。 修改参数模板名称“name”不能与默认参数模板或已有参数模板的名称重复。 修改的参数必须在指定数据库版本的默认参数范围内。 调试 您可以在API
实例ID或组ID或节点ID的列表对象。可以调用“查询实例列表和详情”接口获取。如果未申请实例,可以调用“创建实例”接口创建。 当变更的实例类型是集群,如果变更的是shard组或者config组的参数模板,传值为组ID。如果变更的是mongos节点的参数模板,传值为节点ID。 当变更的实例类型是副本集或单节点,传值为实例ID。
查询实例可迁移到的可用区 接口说明 查询实例可迁移到的可用区。 约束说明 如需使用该接口,请联系相关工作人员申请开通。 支持DDS社区版集群、副本集实例。 跨AZ实例不支持该操作。 IPV6子网创建的实例不支持该操作。 针对副本集实例,如果当前存在只读节点或未激活的备节点,不支持该操作。
65c916c36edbr02" } SDK 单击文档数据库服务 DDS SDK,下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。 状态码 详情请参见状态码。 错误码 详情请参见错误码。 父主题: 备份与恢复
获取可恢复的数据库集合列表 接口说明 获取可恢复的数据库集合列表。 约束说明 该接口只支持副本集实例。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET https://{Endpoint}/v3/{project_id}/instances/{i
设置集群均衡活动时间窗 接口说明 设置DDS集群的数据均衡活动时间窗。 设置的是utc时间,需要根据自身时区做时间换算。 约束说明 冻结实例不支持该操作。 4.0以下版本的DDS实例不支持该操作。 调试 您可以在API Explorer中调试该接口。 URI URI格式 PUT
参数模板比较 接口说明 比较两个参数模板之间的差异。 约束说明 只能同版本且同类型的参数模板进行比较,例如:集群4.0 mongos参数模板只能与同为集群 4.0 mongos的参数模板进行比较。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Ex
修改实例内网地址 接口说明 修改实例的内网地址。 约束说明 冻结实例,异常实例不支持该操作。 已使用的IP地址,不能作为实例的新内网地址。 修改内网地址会导致原地址链接失效,如果有绑定弹性公网IP,那么在修改内网地址的过程中,请不要操作解绑。 如果已经开启连接地址切换,不能进行该操作。
变更实例安全组 接口说明 变更实例关联的安全组。 约束说明 异常实例不支持该操作。 请确认修改后的安全组策略。该策略可能会影响当前的实例连接,导致连接中断。 调试 您可以在API Explorer中调试该接口。 URI URI格式 POST https://{Endpoint}/
将实例日志与LTS日志流关联,后台将自动上传实例日志到关联的LTS日志流里。 关联成功后,会产生一定费用,具体计费可参考云日志服务(LTS)的定价详情。系统会为当前选择的日志流创建对应日志类型的结构化配置。 约束说明 创建中、已删除、冻结状态的实例不支持该操作。 最大支持100条数据。 调试
从IAM服务获取的用户Token。请参考认证鉴权。 表3 请求Body参数 参数 是否必选 参数类型 描述 upgrade_mode 否 String 升级模式。取值为“minimized_interrupt_time”为中断时间最短优先模式:升级过程对业务影响相对较小的升级方式取值
is_auto_pay 否 Boolean 扩容包年包月实例的节点数量时可指定,表示是否自动从账户中支付,此字段不影响自动续订的支付方式。 true,表示自动从账户中支付。 false,表示手动从账户中支付,默认为该方式。 请求示例 扩容指定副本集实例的节点,数量为2 POST https://dds
实际磁盘上占用的物理空间大小,包括数据文件、日志文件、索引文件等。 storage_size String 数据库逻辑大小(以GB为单位),保留两位小数。逻辑大小指的是数据库中实际存储的数据大小,不包括索引大小、日志大小等。 collection_num Integer 数据库中的集合数。
批量添加或删除指定实例的标签。 约束说明 一个文档数据库实例具有20个标签配额,且标签key唯一。 添加标签时,如果请求体中存在重复key,调用该接口将会报错。 添加标签时,如果请求体中的key与指定实例已有的key重复,将会覆盖已有key对应的value的值。 如果待删除的标签不存在,调
名称 参数类型 是否必选 说明 X-Auth-Token String 是 从IAM服务获取的用户Token。请参考认证鉴权。 project_id String 是 租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。 config_id String 是 参数模板ID。
绑定弹性公网IP 接口说明 为实例下的节点绑定弹性公网IP。 约束说明 冻结实例,异常实例不支持该操作。 集群实例的shard和config节点,副本集的Readonly节点以及Hidden角色节点不支持该操作。 不支持多个弹性公网IP绑定同一个节点。 调试 您可以在API Explorer中调试该接口。
表2 参数说明 名称 参数类型 是否必选 说明 files Array of objects 是 备份包含的文件列表。 详情请参见表3。 bucket String 是 文件所在的桶名。 表3 files字段数据结构说明 名称 参数类型 是否必选 说明 name String 是 文件名。
X-Auth-Token 是 String 从IAM服务获取的用户Token。请参考认证鉴权。 请求参数 参数说明 表3 请求Body参数 参数 是否必选 参数类型 描述 spec_code 是 String 资源规格编码。获取方法请参见查询数据库规格中参数的值。示例:dds.mongodb.c6.large
是否必选 描述 X-Auth-Token string header 是 从IAM服务获取的用户Token。请参考认证鉴权。 project_id string path 是 租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。 instance_id string