华为云用户手册

请求消息 参数说明 表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 连接实例的前提是与实例节点网络通信正常，如果网络不通，可以参考对等连接进行相关配置。

请求消息 参数说明 表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”。

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

URI URI格式 POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/auditlog-links URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/2870a411522849aa901cd4351c96a3b7in02/auditlog-links

响应消息 参数说明 表3 参数说明 名称 参数类型 描述 links Array of strings 审计日志下载链接列表，有效时间5分钟。 响应示例 { "links": ["https://obs.domainname.com/ddsbucket.username.1/xxxxxx", "https://obs.domainname.com/ddsbucket.username.2/xxxxxx"] }

响应消息 参数说明 表2 参数说明 名称 参数类型 描述 audit_logs Array of objects 审计日志具体信息，请参见表3。 total_record Integer 总记录数。 表3 audit_logs字段参数说明 名称 参数类型 描述 node_id String 节点ID。 id String 审计日志ID。 name String 审计日志文件名。 size Long 审计日志大小，单位：byte。 start_time String 审计日志开始时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始，Z指时区偏移量，例如北京时间偏移显示为+0800。 end_time String 审计日志结束时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 响应示例 { "audit_logs": [ { "id": "10190012aae94b38a10269b8ad025fc1no02_1607681849871", "name": "0a84b6e97780d3271fd0c00f2db42932_audit_log_65d3fe0c50984b35bc1a36e9b7c7de98in02_10190012aae94b38a10269b8ad025fc1no02_1607681849871", "size": 24735174, "node_id": "10190012aae94b38a10269b8ad025fc1no02", "start_time": "2020-12-11T18:14:49+0800", "end_time": "2020-12-11T18:17:25+0800" } ], "total_record": 1 }

URI URI格式 GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/auditlog?start_time={start_time}&end_time={end_time}&offset={offset}&limit={limit} URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/056538411200d4cd2f79c003c7606412/instances/65d3fe0c50984b35bc1a36e9b7c7de98in02/auditlog?start_time=2020-12-06T09:00:00+0800&end_time=2020-12-10T18:00:15+0800&offset=0&limit=33

响应消息 参数说明 表2 参数说明 名称 参数类型 描述 keep_days Integer 审计日志保存天数，审计日志策略关闭时为0。 audit_scope String 审计范围。 audit_types Array of strings 审计类型。 响应示例 { "keep_days":7, "audit_scope":"all", "audit_types":["insert"] }

URI URI格式 GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/auditlog-policy URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/5cecca4c20e04146862651b8d385f26ain02/auditlog-policy

请求消息 参数说明 表1 请求参数 名称 类型 IN 是否必选 描述 X-Auth-Token string header 是 从 IAM 服务获取的用户Token。请参考认证鉴权。 project_id string path 是 租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。 instance_id string path 是 实例ID，可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。

URI URI格式 POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/auditlog-policy URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/5cecca4c20e04146862651b8d385f26ain02/auditlog-policy

请求消息 参数说明 表2 参数说明 名称 参数类型 是否必选 描述 keep_days Integer 是 审计日志保存天数，取值范围为0或7~732。 取值0，表示关闭审计日志策略。 取值7~732，表示开启审计日志策略，并设置审计日志保存天数为该值。 reserve_auditlogs String 否 仅关闭审计日志策略时有效。 true（默认），表示关闭审计日志策略的同时，保留历史审计日志。 false，表示关闭审计日志策略的同时，删除已有的历史审计日志。 audit_scope String 否 仅打开审计日志策略时有效，并且取值为空或者“all”时，默认全部。 审计范围。 请输入数据库或集合名称，多个库或集合请用英文逗号分隔。若名称中有英文逗号，请在逗号前添加“$”符号，用以区分分隔符。 输入长度范围不能超过1024位，且不能包含空格∧"[]{}():'和特殊字符，$符号只能在转义时使用。 audit_types Array of strings 否 仅打开审计日志策略时有效，并且为空时，默认全部。 审计类型。支持auth，insert，delete，update，query，command等。

响应消息 参数说明 表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": "node_1", "file_name": "054bc9c1f680d55c1f36c006e5a9f67b_errorlog_download_20200515080614589", "status": "SUCCESS", "file_size": "0", "file_link": "https://rdsbucket.opxxx.svc.rds.xxxxx.cnxianhz1.ur.obs.cn-xianhz-1.myhuaweicloud.com:443/054bc9c1f680d55c1f36c006e5a9f67b_errorlog_download_20200515080614589?AWSAccessKeyId=1BQ38TBCQHAVQXBUMUTC&Expires=1589530200&response-cache-control=no-cache%2Cno-store&Signature=Fgi4%2BLOJ9frAXyOkz5hRoW5O%2BUM%3D", "update_at": 1589529991385 } ], "status": "FINISH", "count": 1 }

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

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

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

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 }

响应消息 参数说明 表3 参数说明 名称 参数类型 说明 list List 慢日志下载链接列表。 详情请参见表4。 status String 慢日志下载链接生成状态。 FINISH，表示下载链接已经生成完成。 CREATING，表示正在生成文件，准备下载链接。 FAILED，表示存在日志文件准备失败。 count Integer 慢日志链接数量。 表4 list字段数据结构说明 名称 参数类型 说明 node_name String 节点名称。 file_name String 生成的下载文件名。 status String 当前链接的生成状态。 SUCCESS，表示下载链接已经生成完成。 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 }

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

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

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

请求示例 查询某个时间段的数据库查询类语句的慢日志，每次查询的日志条数为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 日志单行序列号。

请求消息 参数说明 表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

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

URI URI格式 GET 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 } ] }

响应消息 参数说明 表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 } ] }