华为云用户手册

URI URI格式 GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/errorlog?start_date={start_date}&end_date={end_date} URI样例 查询数据库错误日志 https://dds.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/6ade8143870047b8999aba8f1891b48ein02/errorlog?start_date=2018-08-06T10:41:14+0800&end_date=2018-08-07T10:41:14+0800 根据指定条件查询数据库错误日志 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/6ade8143870047b8999aba8f1891b48ein02/errorlog?type=WARNING&offset=1&limit=20&node_id=a7c84462483642798cf159237343135fno06&start_date=2018-08-06T10:41:14+0800&end_date=2018-08-07T10:41:14+0800

响应消息 参数说明 表2 参数说明 名称 参数类型 说明 error_log_list Array of objects 具体信息。 详情请参见表3。 total_record Integer 总记录数。 表3 error_log_list字段数据结构说明 名称 参数类型 说明 node_name String 节点名称。 level String 日志级别。 time String 发生时间，UTC时间。 content String 日志内容。 响应示例 { "error_log_list": [ { "node_name": "Test_replica_node_2", "level": "WARNING", "time": "2020-12-15T08:53:01.868+0000", "content": "W NETWORK [LogicalSessionCacheReap] Unable to reach primary for set replica" } ], "total_record": 1 }

请求消息 参数说明 表2 参数说明 名称 参数类型 是否必选 描述 file_name_list Array of strings 否 需要下载的文件的文件名列表。 node_id_list Array of strings 否 节点ID列表，取空值，表示查询实例下所有允许查询的节点。 使用请参考《DDS API参考》的“查询实例列表”响应消息表“nodes 数据结构说明”的“id”。 允许查询的节点如下： 集群下面的shard节点。 副本集、单节点下面的所有节点。

响应消息 参数说明 表3 参数说明 名称 参数类型 说明 list List 慢日志下载链接列表。 详情请参见表4。 status String 慢日志下载链接生成状态。 FINISH，表示下载链接已经生成完成。 CREATING，表示正在生成文件，准备下载链接。 FAILED，表示存在日志文件准备失败。 count Integer 慢日志链接数量。 表4 list字段数据结构说明 名称 参数类型 说明 node_name String 节点名称。 file_name String 生成的下载文件名。 status String 当前链接的生成状态。 SUC CES S，表示下载链接已经生成完成。 EXPORTING，表示正在生成文件，准备下载链接。 FAILED，表示存在日志文件准备失败。 file_size String 文件大小，单位为 KB。 file_link String 下载链接。 说明： 下载链接在更新时间的15分钟内有效，超出时间会重新获取。 update_at Long 更新时间。 响应示例 { "list": [ { "node_name": "dds-2a78_replica_node_3", "file_name": "054bc9f81e80d2201fccc00b92ad6ec0_ca327a60b3084fa79ce072d7299b905ano02_slowlog_20201117060412", "status": "SUCCESS", "file_size": "0", "file_link": "https://rdsbucket.xxxr.obs.cn-xianhz-1.myhuaweicloud.com:443/054bc9c1f680d55c1f36c006e5a9f67b_slowlog_download_20200515080614589?AWSAccessKeyId=1BQ38TBCQHAVQXBUMUTC&Expires=1589530200&response-cache-control=no-cache%2Cno-store&Signature=Fgi4%2BLOJ9frAXyOkz5hRoW5O%2BUM%3D", "update_at": 1605593100566 } ], "status": "FINISH", "count": 1 }

URI URI格式 POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/slowlog-download URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/6ade8143870047b8999aba8f1891b48ein02/slowlog-download

请求示例 获取慢日志下载链接，按照需要下载的文件的文件名列表或节点ID列表 { "file_name_list":["0541c9f81e80d2201fccc00b92ad6ec0_052f8a12dfed43fbb27c2020e3c3c507no02_slowlog_20201117104809"], "node_id_list":["052f8a12dfed43fbb27c2020e3c3c507no02"] }

请求消息 参数说明 表2 参数说明 名称 类型 是否必选 说明 start_time String 是 开始时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始，Z指时区偏移量，例如北京时间偏移显示为+0800。 注意： 开始时间不得早于当前时间30天。 end_time String 是 结束时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 说明： 结束时间不能晚于当前时间。 limit Integer 是 表示每次查询的日志条数，最大限制100条。 line_num String 否 日志单行序列号，第一次查询时不需要此参数，下一页查询时需要使用，可从上一次查询的返回信息中获取。 说明： 当次查询从line_num的下一条日志开始查询，不包含当前line_num日志。 operate_type String 否 语句类型，取空值，表示查询所有语句类型。 取值如下： insert query update remove getmore command killcursors node_id String 否 节点ID，请参考表8的“id”。 取空值，表示查询实例下所有允许查询的节点。 允许查询的节点如下： 集群实例下面的 shard节点。 副本集、单节点实例下面的所有节点。 keywords Array of strings 否 根据多个关键字搜索日志全文，表示同时匹配所有关键字。 只支持关键字前缀模糊搜索，最多支持10个关键字。 每个关键字最大长度不超过512个字符。 database_keywords Array of strings 否 根据多个数据库关键字模糊搜索日志，表示匹配至少一个关键字。 只支持关键字前缀模糊搜索，最多支持10个关键字。 每个关键字最大长度不超过64个字符。 collection_keywords Array of strings 否 根据多个数据库表名关键字模糊搜索日志，表示匹配至少一个关键字。 只支持关键字前缀模糊搜索，最多支持10个关键字。 每个关键字最大长度不超过128个字符。 max_cost_time Integer 否 支持根据最大执行时间范围查找日志。 单位：ms。 min_cost_time Integer 否 支持根据最小执行时间范围查找日志。 单位：ms。

URI URI格式 POST https://{Endpoint}/v3.1/{project_id}/instances/{instance_id}/slow-logs URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3.1/0483b6b16e954cb88930a360d2c4e663/instances/6ade8143870047b8999aba8f1891b48ein02/slow-logs

请求示例 查询某个时间段的数据库查询类语句的慢日志，每次查询的日志条数为100条，可以通过关键字搜索日志全文，可以根据最大执行时间100ms范围查找日志，根据最小执行时间50ms范围查找日志。 { "start_time" : "2022-09-06T10:41:14+0800", "end_time" : "2022-09-16T10:41:14+0800", "limit" : 100, "line_num" : "1595659490239433658", "operate_type" : "query", "node_id" : "dbd0b65ed0c34125a0b04d4e5ba67e66no02", "keywords" : [ "response", "oplog" ], "database_keywords" : [ "testDB" ], "collection_keywords" : [ "testCollection" ], "max_cost_time" : 100, "min_cost_time" : 50 }

响应消息 参数说明 表3 参数说明 名称 参数类型 说明 slow_logs Array of objects 慢日志具体信息。 详情请参见表4。 表4 slowLogDetail字段数据结构说明 名称 参数类型 说明 node_name String 节点名称。 node_id String 节点ID。 whole_message String 执行语句。 operate_type String 语句类型。 cost_time Integer 执行时间。 单位：ms。 lock_time Integer 等待锁时间。 单位：us。 docs_returned Integer 返回的文档数。 docs_scanned Integer 扫描的文档数。 database String 日志所属的数据库库名。 collection String 日志所属的数据库表名。 log_time String 日志产生时间，UTC时间。格式为“yyyy-mm-ddThh:mm:ssZ”。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 line_num String 日志单行序列号。

URI URI格式 PUT https://{Endpoint}/v3/{project_id}/configurations/{config_id} URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/configurations/7a8d539ba30f43adaf1b16d08b1df4bdpr02

响应消息 参数说明 表2 响应Body参数 名称 参数类型 说明 id String 参数模板ID。 name String 参数模板名称。 datastore_version String 数据库版本。 datastore_name String 数据库类型。 description 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 参数对象，用户基于默认参数模板自定义的参数配置。 请参见表3。 表3 parameters字段数据结构说明 名称 参数类型 说明 name String 参数名称。 value String 参数值。 description String 参数描述。 type String 参数类型.。 取值为“integer”，“string”，“boolean”，“float”或“list”。 value_range String 参数值范围。 如integer取值0-1，boolean取值true/false等。 restart_required Boolean 参数是否需要重启。 取值为“true”，需要重启。 取值为“false”，不需要重启。 readonly Boolean 是否只读。 取值为“true”，只读参数。 取值为“false”，非只读参数。 响应示例 { "id": "07fc12a8e0e94df7a3fcf53d0b5e1605pr01", "name": "paramsGroup-test", "description": "", "datastore_name": "mongodb", "datastore_version": "4.0", "created": "2017-01-01T10:00:00", "updated": "2017-01-01T10:00:00", "parameters": [ { "name": "cursorTimeoutMillis", "type": "integer", "value": 600000, "description": "设置空闲游标的超期时间，DDS将删除空闲的游标", "value_range": "600000-1000000", "restart_required": false, "readonly": false } ] }

URI URI格式 GET https://{Endpoint}/v3/{project_id}/configurations/{config_id} URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/configurations/7a8d539ba30f43adaf1b16d08b1df4bdpr02

响应消息 参数说明 表3 响应Body参数 名称 参数类型 描述 total_count Integer 总记录数。 configurations Array of objects 参数模板列表。请参见表4。 表4 configurations字段数据结构说明 参数 参数类型 描述 id String 参数模板ID。 name String 参数模板名称。 description String 参数模板描述。 datastore_version String 数据库版本。 datastore_name String 数据库类型。 node_type String 参数模板节点类型。 mongos，表示集群mongos节点类型。 shard，表示集群shard节点类型。 config，表示集群config节点类型。 replica，表示副本集类型。 readonly，表示副本集只读节点类型。 shard_readonly，表示集群只读节点类型。 single，表示单节点类型。 created String 创建时间，格式为“yyyy-MM-ddTHH:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 updated String 更新时间，格式为“yyyy-MM-ddTHH:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 user_defined Boolean 是否是用户自定义参数模板。 取值为“false”，表示为系统默认参数模板。 取值为“true”，表示为用户自定义参数模板。 响应示例 { "total_count" : 1, "configurations" : [ { "id" : "07fc12a8e0e94df7a3fcf53d0b5e1605pr01", "name" : "test1", "description" : "", "datastore_name" : "mongos", "node_type":"shard", "datastore_version" : "4.0", "created" : "2017-01-01T10:00:00", "updated" : "2017-01-01T10:00:00", "user_defined" : true } ] }

URI URI格式 DELETE https://{Endpoint}/v3/{project_id}/configurations/{config_id} URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/056538411200d4cd2f79c003c7606412/configurations/7a8d539ba30f43adaf1b16d08b1df4bdpr02

响应消息 参数说明 表4 响应Body参数 名称 参数类型 描述 configuration ParamGroupInfoResult object 参数模板列表。 表5 configuration字段数据结构说明 名称 参数类型 说明 id String 参数模板ID。 name String 参数模板名称。 description String 参数模板描述。 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。 响应示例 { "configuration": { "id": "7b4e07852bd54016906e89461b3182cdpr02", "name": "myparameter", "description": "parameter1", "datastore_version": "3.4", "datastore_name": "mongodb", "created": "2018-09-19T02:54:21", "updated": "2018-09-19T02:54:21" } }

请求示例 创建一个参数模板，名称为myparameter，node_type为shard，version为3.4，最大连接数为10 { "name" : "myparameter", "description" : "parameter1", "datastore" : { "node_type" : "shard", "version" : "3.4" }, "parameter_values" : { "max_connections" : "10" } }

请求消息 参数说明 表2 参数说明 名称 参数类型 是否必选 描述 restore_collections Array of objects 是 数据库信息。 请参见表3。 表3 restore_collections字段数据结构说明 名称 参数类型 是否必选 描述 database String 是 数据库名称。 collections Array of objects 否 集合信息。 请参见表4。 restore_database_time String 否 数据库恢复时间点。 如果是数据库级恢复，该参数必传， UNIX时间戳格式，单位是毫秒，时区是UTC。 表4 collections字段数据结构说明 名称 参数类型 是否必选 描述 old_name String 是 恢复前表名。 new_name String 否 恢复后表名。 restore_collection_time String 是 数据库集合恢复时间点。 UNIX时间戳格式，单位是毫秒，时区是UTC。

请求示例 恢复数据库级备份，数据库名称为test { "restore_collections": [ { "database": "test", "restore_database_time": 1607762955000 } ] } 恢复集合级备份，恢复前表名为test { "restore_collections": [ { "database": "test", "collections": [ { "old_name": "test", "restore_collection_time": 1607762955000 } ] } ] }

URI URI格式 POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/restore/collections URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/056538411200d4cd2f79c003c7606412/instances/d5833c2854a4486cb7960f829269e211in02/restore/collections

请求示例 使用备份文件恢复，恢复目标实例ID为d8e6ca5a624745bcb546a227aa3ae1cfin02 { "source": { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin02", "type": "backup", "backup_id": "2f4ddb93-b901-4b08-93d8-1d2e472f30fe" }, "target": { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin02" } } 根据时间点恢复（适用于副本集实例和4.0版本的集群实例），恢复目标实例ID为d8e6ca5a624745bcb546a227aa3ae1cfin02 { "source": { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin02", "type": "timestamp", "restore_time": 1532001446987 }, "target": { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin02" } }

请求消息 参数说明 表2 参数说明 名称 参数类型 是否必选 描述 source Object 是 恢复数据源对象。 请参见表3。 target Object 是 恢复目标对象。 请参见表4。 表3 source字段数据结构说明 名称 参数类型 是否必选 描述 instance_id String 是 实例ID，可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。 type String 否 表示恢复方式，枚举值： “backup”，表示使用备份文件恢复，按照此方式恢复时，“type”字段为非必选，“backup_id”必选。 “timestamp”，表示按时间点恢复，按照此方式恢复时，“type”字段必选，“restore_time”必选。 backup_id String 否 用于恢复的备份ID。当使用备份文件恢复时需要指定该参数。 restore_time String 否 恢复数据的时间点，格式为UNIX时间戳，单位是毫秒，时区为UTC。 说明： 目前该参数只适用于副本集实例。 表4 target字段数据结构说明 名称 参数类型 是否必选 描述 instance_id String 是 恢复目标实例ID，可以调用“查询实例列表”接口获取。如果未申请实例，可以调用“创建实例”接口创建。

URI URI格式 GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/restore-collection?db_name={db_name}&restore_time={restore_time}&offset={offset}&limit={limit} URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/056538411200d4cd2f79c003c7606412/instances/d5833c2854a4486cb7960f829269e211in02/restore-collection?db_name=mydbx&restore_time=1607689584000&limit=10&offset=0

响应消息 参数说明 表2 参数说明 名称 参数类型 是否必选 描述 collections Array of objects 是 集合列表，列表中每个元素表示一个集合。 total_count Integer 是 集合总数。 表3 参数说明 名称 参数类型 是否必选 描述 name String 是 集合名称。 响应示例 { "collections": [ "dds-test" ], "total_count": 1 }

URI URI格式 GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/restore-database?restore_time={restore_time}&offset={offset}&limit={limit} URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/056538411200d4cd2f79c003c7606412/instances/d5833c2854a4486cb7960f829269e211in02/restore-database?restore_time=1607689584000&limit=10&offset=1

响应消息 参数说明 表2 参数说明 名称 参数类型 是否必选 描述 restore_time Array of objects 是 可恢复时间段列表，请参见表3。 表3 restore_time字段参数说明 名称 参数类型 是否必选 描述 start_time Long 是 可恢复时间段的起始时间点，UNIX时间戳格式，单位是毫秒，时区是UTC。 end_time Long 是 可恢复时间段的结束时间点，UNIX时间戳格式，单位是毫秒，时区是UTC。 响应示例 { "restore_time": [ { "start_time": 1607731200000, "end_time": 1607756414000 }, { "start_time": 1607756825000, "end_time": 1607761999000 }, { "start_time": 1607762943000, "end_time": 1607817599000 } ] }

请求消息 参数说明 表1 请求参数 名称 类型 IN 是否必选 描述 X-Auth-Token string header 是 从 IAM 服务获取的用户Token。请参考认证鉴权。 Content-Type string header 是 发送的实体的MIME类型。推荐用户默认使用application/json，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。 X-Language string header 否 语言。 project_id string path 是 项目ID。请参考获取项目ID章节获取项目编号。 instance_id String path 是 实例ID，可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。 date string query 是 所需查询的日期，为yyyy-mm-dd字符串格式,时区为UTC。

URI URI格式 GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/restore-time URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/056538411200d4cd2f79c003c7606412/instances/d5833c2854a4486cb7960f829269e211in02/restore-time?date=2020-12-12

操作步骤 删除DDS实例。 接口相关信息 URI格式 DELETE https://{Endpoint}/v3/{project_id}/instances/{instance_id} {Endpoint}信息请从地区和终端节点获取。 URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02 详情请参见删除实例。 请求示例 无。 响应示例 { "job_id": "252f11f1-2912-4c06-be55-1999bde659c5" }

操作步骤 修改DDS实例名称。 接口相关信息 URI格式 PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/modify-name {Endpoint}信息请从地区和终端节点获取。 URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02/modify-name 详情请参见修改实例名称。 请求示例 { "new_instance_name": "myNewName" } 响应示例 {}