华为云用户手册

  • 文档数据库服务 DDS-创建集群的Shard/Config IP:URI
    URI URI格式 POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/create-ip URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02/create-ip
    文档数据库服务 DDS
  • 文档数据库服务 DDS-创建集群的Shard/Config IP:请求消息
    请求消息 参数说明 表2 参数说明 名称 参数类型 是否必选 描述 type String 是 集群实例类型。 扩容Shard组时，取值为“shard”。 扩容Config组时，取值为“config”。 target_id String 否 Shard组ID 。 注意： 第一次添加Shard/Config IP时，该参数不传。 对于已经添加过Shard IP的实例，需要传入该参数为新扩容的Shard组添加IP。 password String 是 打开集群开关设置的密码。 取值范围：长度为8~32位，必须是大写字母（A~Z）、小写字母（a~z）、数字（0~9）、特殊字符~!@#%^*-_=+?的组合。 建议您输入高强度密码，以提高安全性，防止出现密码被暴力破解等安全风险。 注意： 该密码暂不支持修改，请谨慎操作。
    文档数据库服务 DDS
  • 文档数据库服务 DDS-获取指定ID的任务信息:响应消息
    响应消息 正常响应参数说明 表2 参数说明 名称 参数类型 是否必选 说明 job Object 是 任务信息，请参见表3。 表3 job字段数据结构说明 名称 参数类型 是否必选 说明 id String 是 任务ID。 name String 是 任务名称。 status String 是 任务执行状态。 取值： 值为“Running”，表示任务正在执行。 值为“Completed”，表示任务执行成功。 值为“Failed”，表示任务执行失败。 created String 是 创建时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 ended String 是 结束时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 progress String 是 任务执行进度。 说明： 执行中状态才返回执行进度，例如“60%”，表示任务执行进度为60%，否则返回“”。 instance Object 是 执行任务的实例信息。 请参见表4。 fail_reason String 是 任务执行失败时的错误信息。 表4 instance字段数据结构说明 名称 参数类型 是否必选 说明 id String 是 实例ID。 name String 是 实例名称。 响应示例中取任务中心部分任务作为示例。
    文档数据库服务 DDS 任务管理
  • 文档数据库服务 DDS-获取指定ID的任务信息:约束说明
    约束说明 目前只支持查询DDS社区版任务中心一个月内的异步任务。 job生成后，通常需要数秒之后才能查询到job ID。 目前支持查询的主要异步任务：创建实例（单节点/副本集/集群）、存储扩容、规格变更、节点扩容、重启、主备切换、修改内网地址、修改安全组、修改数据库端口、绑定/解绑弹性IP、切换SSL、迁移可用区、显示shard/config IP、创建物理备份/快照备份、备份恢复新实例、备份恢复到指定时间点、库表级时间点恢复、添加只读节点。
    文档数据库服务 DDS 任务管理
  • 文档数据库服务 DDS-查询配额:响应消息
    响应消息 参数说明 表2 响应Body参数 参数 参数类型 是否必选 描述 quotas Object 是 配额信息。 详情请参见表3。 表3 ShowResourcesListResponseBody 参数 参数类型 是否必选 描述 resources Objects 是 资源列表对象。 详情请参见表4。 表4 ShowResourcesDetailResponseBody 参数 参数类型 是否必选 描述 type String 是 配额资源类型，当前配额类型仅支持实例类型（instance）。 mode String 是 实例类型： 若值为“Single”，则表示单节点实例配额信息。 若值为“ReplicaSet”，则表示副本集实例配额信息。 若值为“Sharding”，则表示集群实例配额信息。 quota Integer 是 当前配额值。 used Integer 是 已使用的配额数。 响应示例 { "quotas" : { "resources" : [ { "type" : "instance", "mode" : "Sharding", "quota" : 80, "used" : 6 }, { "type" : "instance", "mode" : "ReplicaSet", "quota" : 80, "used" : 9 }, { "type" : "instance", "mode" : "Single", "quota" : 1000, "used" : 5 } ] } }
    文档数据库服务 DDS 配额管理
  • 文档数据库服务 DDS-删除数据库角色:URI
    URI URI格式 DELETE https://{Endpoint}/v3/{project_id}/instances/{instance_id}/db-role URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/659914406d2c4c76bce6a028ce8d8e0din02/db-role
    文档数据库服务 DDS
  • 文档数据库服务 DDS-删除数据库角色:请求消息
    请求消息 参数说明 表2 参数说明 名称 参数类型 是否必选 描述 role_name String 是 角色名称。系统自带的数据库用户不可删除。 取值范围：长度为1~64位，可以包含大写字母（A~Z）、小写字母（a~z）、数字（0~9）、中划线、下划线和点。 db_name String 是 角色所在的数据库名称。 取值范围：长度为1~64位，可以包含大写字母（A~Z）、小写字母（a~z）、数字（0~9）、下划线。 请求示例 { "role_name": "testRole", "db_name":"testDb" }
    文档数据库服务 DDS
  • 文档数据库服务 DDS-删除数据库用户:URI
    URI URI格式 DELETE https://{Endpoint}/v3/{project_id}/instances/{instance_id}/db-user URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/f032c0db12d147ef87317efdfacbbe15in02/db-user
    文档数据库服务 DDS
  • 文档数据库服务 DDS-删除数据库用户:请求消息
    请求消息 参数说明 表2 参数说明 名称 参数类型 是否必选 描述 user_name String 是 数据库用户名称，系统自带的数据库用户不可删除。 取值范围：长度为1~64位，可以包含大写字母（A~Z）、小写字母（a~z）、数字（0~9）、中划线、下划线和点。 db_name String 是 用户所在的数据库。 取值范围：长度为1~64位，可以包含大写字母（A~Z）、小写字母（a~z）、数字（0~9）、下划线。 请求示例 { "user_name":"test" , "db_name":"test_db" }
    文档数据库服务 DDS
  • 文档数据库服务 DDS-设置集群均衡活动时间窗:URI
    URI URI格式 PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/balancer/active-window URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/cc6345c64cec47499182467ea0dd432ain02/balancer/active-window
    文档数据库服务 DDS
  • 文档数据库服务 DDS-设置集群均衡活动时间窗:请求消息
    请求消息 参数说明 表2 参数说明 名称 参数类型 是否必选 描述 start_time String 否 均衡时间窗的开始时间，设置格式为“HH:MM”。 如果设置了start_time，则必须设置stop_time。如果两者都不设置，表示取消均衡时间窗设置。 stop_time String 否 均衡时间窗的结束时间，设置格式为“HH:MM”。 如果设置了stop_time，则必须设置start_time。如果两者都不设置，表示取消均衡时间窗设置。
    文档数据库服务 DDS
  • 文档数据库服务 DDS-设置集群均衡开关:URI
    URI URI格式 PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/balancer/{action} URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/cc6345c64cec47499182467ea0dd432ain02/balancer/start
    文档数据库服务 DDS
  • 文档数据库服务 DDS-设置集群均衡开关:请求消息
    请求消息 参数说明 表1 请求参数 名称 类型 IN 必选 描述 X-Auth-Token string header 是 从 IAM 服务获取的用户Token。请参考认证鉴权。 project_id string path 是 租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。 instance_id string path 是 实例ID，可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。 action string path 是 开启或关闭集群均衡。
    文档数据库服务 DDS
  • 文档数据库服务 DDS-查询集群均衡设置:请求消息
    请求消息 参数说明 表1 请求参数 名称 类型 IN 是否必选 描述 X-Auth-Token string header 是 从IAM服务获取的用户Token。请参考认证鉴权。 project_id string path 是 租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。 instance_id string path 是 实例ID，可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。
    文档数据库服务 DDS
  • 文档数据库服务 DDS-查询集群均衡设置:URI
    URI URI格式 GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/balancer URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/cc6345c64cec47499182467ea0dd432ain02/balancer
    文档数据库服务 DDS
  • 文档数据库服务 DDS-修改指定实例的参数:URI
    URI URI格式 PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/configurations URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in02/configurations
    文档数据库服务 DDS
  • 文档数据库服务 DDS-修改指定实例的参数:响应消息
    响应消息 参数说明 表3 响应Body参数 参数 参数类型 描述 job_id String 修改实例参数的异步任务ID。 restart_required Boolean 参数修改涉及范围（实例，组，节点）否需要重启。 取值为false，不需要重启。 取值为true，需要重启。 响应示例 { "job_id" : "bf26cf3c-d046-4080-bb45-f114be7afa5f", "restart_required" : false }
    文档数据库服务 DDS
  • 文档数据库服务 DDS-获取指定实例的参数信息:请求消息
    请求消息 参数说明 表1 请求参数参数 参数 类型 IN 是否必选 描述 X-Auth-Token string header 是 从IAM服务获取的用户Token。请参考认证鉴权。 Content-Type string header 是 发送的实体的MIME类型。推荐用户默认使用application/json，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。 project_id string path 是 租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。 instance_id string path 是 实例ID，可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。 表2 Query参数 参数 参数类型 是否必选 描述 entity_id String 是 实例ID或组ID或节点ID。可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。 当获取的实例类型是集群，如果获取的是shard组或者config组的参数模板，传值为组ID。如果获取的是mongos节点的参数模板，传值为节点ID。 当获取的实例类型是副本集或单节点，传值为实例ID。
    文档数据库服务 DDS
  • 文档数据库服务 DDS-获取指定实例的参数信息:响应消息
    响应消息 参数说明 表3 响应Body参数 名称 参数类型 说明 datastore_version String 数据库版本。 datastore_name String 数据库类型。 created String 创建时间，格式为“yyyy-MM-ddTHH:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 updated String 更新时间，格式为“yyyy-MM-ddTHH:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 parameters Array of objects 参数对象，用户基于默认参数模板自定义的参数配置。 详情请参见表4。 表4 parameters字段数据结构说明 名称 参数类型 说明 name String 参数名称。 value String 参数值。 value_range String 参数值范围。 示例：Integer类型取值范围为0~1、Boolean类型取值为“true”或“false”。 restart_required Boolean 参数是否需要重启。 取值为“true”，需要重启。 取值为“false”，不需要重启。 readonly Boolean 是否只读。 取值为“false”，非只读参数。 取值为“true”，只读参数。 type String 参数类型，取值为“integer”，“string”，“boolean”，“float”或“list”。 description String 参数描述。
    文档数据库服务 DDS
  • 文档数据库服务 DDS-获取指定实例的参数信息:URI
    URI URI格式 GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/configurations URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/f0ba99dd8a8249838a6007042d76b07ain02/configurations?entity_id=827697ee2f6040bd9fcf65586e3f7218gr02
    文档数据库服务 DDS
  • 文档数据库服务 DDS-应用参数模板:请求消息
    请求消息 参数说明 表2 请求Body参数 名称 是否必选 参数类型 说明 entity_ids 是 Array of strings 实例ID或组ID或节点ID的列表对象。可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。 当变更的实例类型是集群，如果变更的是shard组或者config组的参数模板，传值为组ID。如果变更的是mongos节点的参数模板，传值为节点ID。 当变更的实例类型是副本集或单节点，传值为实例ID。
    文档数据库服务 DDS
  • 文档数据库服务 DDS-应用参数模板:URI
    URI URI格式 PUT https://{Endpoint}/v3/{project_id}/configurations/{config_id}/apply URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/configurations/7a8d539ba30f43adaf1b16d08b1df4bdpr02/apply
    文档数据库服务 DDS
  • 文档数据库服务 DDS-实例可用区迁移:URI
    URI URI格式 POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/migrate URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02/migrate
    文档数据库服务 DDS
  • 文档数据库服务 DDS-查询实例可迁移到的可用区:响应消息
    响应消息 参数说明 表2 参数说明 名称 参数类型 是否必选 描述 az_list Array of objects 是 可用区具体信息。详情请参见表3。 表3 az_list 字段数据结构说明 名称 参数类型 是否必选 描述 code String 是 可用区ID。 description String 是 可用区描述。 status String 是 当前可用区的的状态。 ENABLED，表示该可用区（组合）可用。 DISABLED，表示该可用区（组合）不可用。 响应示例 { "az_list": [ { "code": "az3xahz", "description": "可用区3", "status": "DISABLED" } { "code": "az1xahz,az2xahz,az3xahz", "description": "可用区1,可用区2,可用区3", "status": "ENABLED" } ] }
    文档数据库服务 DDS
  • 文档数据库服务 DDS-查询实例可迁移到的可用区:URI
    URI URI格式 GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/migrate/az URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02/migrate/az
    文档数据库服务 DDS
  • 文档数据库服务 DDS-查询实例可迁移到的可用区:请求消息
    请求消息 参数说明 表1 请求参数 名称 类型 IN 是否必选 描述 X-Auth-Token string header 是 从IAM服务获取的用户Token。请参考认证鉴权。 project_id string path 是 租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。 instance_id string path 是 实例ID，可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。
    文档数据库服务 DDS
  • 文档数据库服务 DDS-副本集跨网段访问配置:URI
    URI URI格式 POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/client-network URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02/client-network
    文档数据库服务 DDS
  • 文档数据库服务 DDS-副本集跨网段访问配置:请求消息
    请求消息 参数说明 表2 参数说明 名称 参数类型 是否必选 描述 client_network_ranges Array of strings 是 客户端所在网段。 说明： 跨网段访问配置只有在客户端与副本集实例部署在不同网段的情况下才需要配置，例如访问副本集的客户端所在网段为192.168.0.0/16，副本集所在的网段为172.16.0.0/24，则需要添加跨网段配置192.168.0.0/16才能正常访问。只有副本集有该功能。 例如配置的源端网段为192.168.0.0/xx，则xx的输入值必须在8到32之间。 源端E CS 连接实例的前提是与实例节点网络通信正常，如果网络不通，可以参考对等连接进行相关配置。
    文档数据库服务 DDS
  • 文档数据库服务 DDS-检查数据库密码:请求消息
    请求消息 参数说明 表2 参数说明 名称 参数类型 是否必选 描述 user_name String 否 数据库用户名称，默认为“rwuser”。 取值范围：长度为1~64位，可以包含大写字母（A~Z）、小写字母（a~z）、数字（0~9）、中划线、下划线和点。 user_pwd String 是 数据库密码。 取值范围：长度为8~32位，必须是大写字母（A~Z）、小写字母（a~z）、数字（0~9）、特殊字符~!@#%^*-_=+?的组合。 db_name String 否 数据库名称，默认为“admin”。
    文档数据库服务 DDS
  • 文档数据库服务 DDS-检查数据库密码:URI
    URI URI格式 POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/check-password URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/cc6345c64cec47499182467ea0dd432ain02/check-password
    文档数据库服务 DDS
共100000条
undefined

搜索反馈

您找到想要的内容了吗?

是的 没有

意见反馈

0/200

提交 取消

提交成功！非常感谢您的反馈，我们会继续努力做到更好 反馈提交失败！请稍后重试！
推荐文章