文档数据库服务 DDS-华为云

文档数据库服务 DDS-查询数据库列表:响应消息

响应消息参数说明表2 响应Body参数名称参数类型描述 databases Array of objects 数据库信息列表。请参考表3。 total_count Integer 总数。表3 databases 参数参数类型描述 name String 数据库名称, config admin 库不做展示。 data_size String 数据库存储大小（以GB为单位）,保留两位小数。存储大小: 实际磁盘上占用的物理空间大小，包括数据文件、日志文件、索引文件等。 storage_size String 数据库逻辑大小（以GB为单位）,保留两位小数。逻辑大小指的是数据库中实际存储的数据大小，不包括索引大小、日志大小等。 collection_num Integer 数据库中的集合数。响应示例 { "databases" : [ { "name" : "dds-test", "data_size" : "3593", "storage_size" : "256", "collection_num" : "5" } ], "total_count" : 1 }

文档数据库服务 DDS 管理数据库和用户

文档数据库服务 DDS-查询数据库列表:URI

URI URI格式 GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/databases?offset={offset}&limit={limit} URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/659914406d2c4c76bce6a028ce8d8e0din02/databases?offset=1&limit=10

文档数据库服务 DDS 管理数据库和用户

文档数据库服务 DDS-批量数据库补丁升级:响应参数

响应参数状态码： 202 表4 响应Body参数参数参数类型描述 upgrade_results Array of objects 批量升级结果。详情请参见表5。表5 UpgradeResult 参数参数类型描述 job_id String 任务ID。仅当补丁版本升级任务提交成功时返回该字段。 instance_id String 实例ID。 error_code String 错误码。仅当补丁版本升级任务提交失败时返回该字段。 error_message String 失败原因。仅当补丁版本升级任务提交失败时返回该字段。状态码： 400 表6 响应Body参数参数参数类型描述 error_code String 错误码。 error_msg String 错误消息。状态码： 500 表7 响应Body参数参数参数类型描述 error_code String 错误码。 error_msg String 错误消息。

文档数据库服务 DDS

文档数据库服务 DDS-批量数据库补丁升级:响应示例

响应示例状态码： 202 Accepted. { "upgrade_results" : [ { "instance_id" : "046287aae57843b1a7bc61b7a8812f41in02", "job_id" : "e4616470-733d-41de-a9b0-a260709293d3" }, { "instance_id" : "3d1e04f49efa473a8c7eaf07ed7ff870in02", "error_code" : "DBS.200011", "error_message" : "The status of DB instance does not allow the operation." } ] }

文档数据库服务 DDS

文档数据库服务 DDS-批量数据库补丁升级:请求示例

请求示例批量升级数据库补丁版本。 POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/db-upgrade { "instance_ids" : [ "046287aae57843b1a7bc61b7a8812f41in02", "3d1e04f49efa473a8c7eaf07ed7ff870in02" ] }

文档数据库服务 DDS

文档数据库服务 DDS-查询实例参数的修改历史:响应参数

响应参数状态码： 200 表4 响应Body参数参数参数类型描述 histories Array of objects 实例参数的修改历史列表。详情请参见表5。表5 ConfigurationModifyHistoryInfo 参数参数类型描述 parameter_name String 参数名称。 old_value String 修改前的值。 new_value String 修改后的值。 update_result String 更新结果。 applied Boolean 是否被应用。 true: 已被应用。 false: 未被应用。 updated_at String 修改时间，格式为"yyyy-MM-ddTHH:mm:ssZ"。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 applied_at String 应用时间，格式为"yyyy-MM-ddTHH:mm:ssZ"。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。状态码： 400 表6 响应Body参数参数参数类型描述 error_code String 错误码。 error_msg String 错误消息。状态码： 500 表7 响应Body参数参数参数类型描述 error_code String 错误码。 error_msg String 错误消息。状态码： default 表8 响应Body参数参数参数类型描述 error_code String 错误码。 error_msg String 错误消息。

文档数据库服务 DDS

文档数据库服务 DDS-查询实例参数的修改历史:响应示例

响应示例 { "histories" : [ { "parameter_name" : "rateLimit.mbps", "old_value" : "500", "new_value" : "350", "update_result" : "SUC CES S", "applied" : true, "updated_at" : "2022-06-07T09:25:45+0000", "applied_at" : "2022-06-07T09:25:45+0000" } ] }

文档数据库服务 DDS

文档数据库服务 DDS-查询实例参数的修改历史:URI

URI GET /v3/{project_id}/instances/{instance_id}/configuration-histories 表1 路径参数参数是否必选参数类型描述 project_id 是 String 租户在某一region下的project ID。 instance_id 是 String 实例ID。表2 Query参数参数是否必选参数类型描述 offset 否 Integer 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询）。取值必须为数字，不能为负数。 limit 否 Integer 查询个数上限值。取值范围: 1~100。不传该参数时，默认查询前100条信息。

文档数据库服务 DDS

文档数据库服务 DDS-校验参数模板名称是否存在:响应参数

响应参数状态码： 200 表4 响应Body参数参数参数类型描述 is_existed Boolean 参数组名称是否存在。 true：参数组名称存在 false：参数组名称不存在状态码： 400 表5 响应Body参数参数参数类型描述 error_code String 错误码。 error_msg String 错误消息。状态码： 500 表6 响应Body参数参数参数类型描述 error_code String 错误码。 error_msg String 错误消息。状态码： default 表7 响应Body参数参数参数类型描述 error_code String 错误码。 error_msg String 错误消息。

文档数据库服务 DDS 参数配置

文档数据库服务 DDS-查询磁盘自动扩容策略:响应参数

响应参数状态码： 200 表3 响应Body参数参数参数类型描述 switch_option String 自动扩容开关。 on：开启磁盘自动扩容策略。 off: 关闭磁盘自动扩容策略。默认值为on。 policy Object 磁盘自动扩容策略。详情请参见表4。表4 DiskAutoExpansionPolicy 参数参数类型描述 instance_id String 实例ID。 threshold Integer 触发自动扩容阈值，只支持输入80、85和90。默认阈值为90，即当已使用存储空间达到总存储空间的90%时就会触发扩容。集群实例的自动扩容阈值指的是每个shard。 step Integer 扩容步长（s%），默认为10，支持输入10、15和20。当触发自动扩容的时候，自动扩容当前存储空间的s%（非10倍数向上取整。小数点后四舍五入，默认一次最小10G，账户余额不足时，会导致包年包月实例扩容失败）。状态码： 400 表5 响应Body参数参数参数类型描述 error_code String 错误码。 error_msg String 错误消息。状态码： 500 表6 响应Body参数参数参数类型描述 error_code String 错误码。 error_msg String 错误消息。

文档数据库服务 DDS

文档数据库服务 DDS-查询定时任务:响应示例

响应示例状态码： 200 Success { "total_count" : 1, "schedules" : [ { "job_id" : "3861199d-c196-4791-bcd0-b45fde754f50", "job_name" : "RESIZE_FLAVOR", "job_status" : "Pending", "instance_id" : "a2b33e2077ee41e397e57cd2f022b72fin02", "instance_name" : "dds-zzx-recover", "instance_status" : "normal", "create_time" : "2019-05-26T10:41:14+0000", "start_time" : "2019-05-26T10:41:14+0000", "end_time" : "2019-05-26T12:51:14+0000" } ] }

文档数据库服务 DDS

文档数据库服务 DDS-查询定时任务:URI

URI GET /v3/{project_id}/scheduled-jobs 表1 路径参数参数是否必选参数类型描述 project_id 是 String 租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。表2 Query参数参数是否必选参数类型描述 job_name 否 String 任务名称，默认为空。对应取值如下： "RESIZE_FLAVOR"：变更实例的CPU和内存规格 job_status 否 String 任务执行状态，默认为空。取值：值为"Pending"，表示任务未执行。值为"Running"，表示任务正在执行。值为"Completed"，表示任务执行成功。值为"Failed"，表示任务执行失败。值为"Canceled"，表示任务取消执行。 instance_id 否 String 实例ID，不传该值默认查所有符合条件的实例。 start_time 否 String 任务创建起始时间，格式为"yyyy-mm-ddThh:mm:ssZ"。其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100，不传默认为当前时间前七天。 end_time 否 String 任务创建结束时间，格式为"yyyy-mm-ddThh:mm:ssZ"。其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100，不传默认为当前时间。 offset 否 Integer 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0。 limit 否 Integer 查询记录数。不传该参数时，默认为10，取值范围1-100。

文档数据库服务 DDS

文档数据库服务 DDS-查询定时任务:响应参数

响应参数表4 响应Body参数参数参数类型描述 total_count Integer 记录数量。 schedules Array of objects 任务详情，请参考表5。表5 schedules 参数参数类型描述 job_id String 任务ID。 job_name String 任务名称。对应取值如下： "RESIZE_FLAVOR"：变更实例的CPU和内存规格 job_status String 任务执行状态。取值：值为"Running"，表示任务正在执行。值为"Completed"，表示任务执行成功。值为"Failed"，表示任务执行失败。值为"Pending"，表示任务未执行。 instance_id String 实例ID。 instance_name String 实例名称。 instance_status String 实例状态。取值：值为“createfail”，表示实例创建失败。值为“creating”，表示实例创建中。值为“normal”，表示实例正常。值为“abnormal”，表示实例异常。值为“deleted”，表示实例已删除。 create_time String 任务创建时间，格式为"yyyy-mm-ddThh:mm:ssZ"。其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 start_time String 任务开始时间，格式为"yyyy-mm-ddThh:mm:ssZ"。其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 end_time String 任务结束时间，格式为"yyyy-mm-ddThh:mm:ssZ"。其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。

文档数据库服务 DDS

文档数据库服务 DDS-变更实例规格:请求示例

请求示例变更集群实例下mongos节点的规格 { "resize": { "target_type": "mongos", "target_id": "a742c13a284949adad177672e8a0f01cno02", "target_spec_code": "dds.mongodb.c6.large.4.mongos" } } 变更集群实例下shard组的规格 { "resize": { "target_type": "shard", "target_id": "aeeb40a704904977ad78993d138ec942gr02", "target_spec_code": "dds.momgodb.c6.large.4.shard" } } 变更集群实例下config组的规格 { "resize": { "target_type": "config", "target_id": "10a1c330537b42c1a9b3f7a5ebcda35egr02", "target_spec_code": "dds.momgodb.c6.xlarge.2.config" } } 变更副本集或单节点实例的规格 { "resize": { "target_id": "aeeb40a704904977ad78993d138ec942in02", "target_spec_code": "dds.mongodb.c6.medium.4.repset" } }

文档数据库服务 DDS

文档数据库服务 DDS-变更实例规格:请求消息

请求消息参数说明表3 参数说明名称参数类型是否必选描述 resize Object 是目标规格信息。详情请参见表4。 is_auto_pay Boolean 否变更包年包月实例规格时可指定，表示是否自动从账户中支付，此字段不影响自动续订的支付方式。对于降低规格场景，该字段无效。对于扩大规格场景： true，表示自动从账户中支付。 false，表示手动从账户中支付，默认为该方式。表4 resize字段数据结构说明名称参数类型是否必选描述 target_type String 否对象类型。对于集群实例，该参数为必选。变更mongos节点规格时，取值为“mongos”；变更单个shard组规格、或者批量变更多个shard组规格时，取值为“shard”，变更config组规格时，取值为"config"。对于副本集实例，不传该参数。变更readonly节点规格时,取值为“readonly”。对于单节点实例，不传该参数。枚举值： mongos shard config readonly target_id String 是待变更规格的节点ID或实例ID，可以调用“查询实例列表”接口获取。如果未申请实例，可以调用“创建实例”接口创建。对于集群实例，变更mongos节点规格时，取值为mongos节点ID；变更单个shard组规格时，取值为shard组ID；批量变更多个shard组规格时，不传该参数；变更config组规格时，取值为config组的ID。对于副本集实例，取值为相应的实例ID。变更readonly节点规格时，取值为readonly节点ID。对于单节点实例，取值为相应的实例ID。 target_spec_code String 是变更至新规格的资源规格编码。获取方法请参见查询数据库规格中响应参数“flavors.spec_code”的值。

文档数据库服务 DDS

云服务器内容精选

文档数据库服务 DDS

7*24

备案

专业服务

退订

建议反馈

售前咨询热线