请求示例 URI样例 POST https://gaussdb-nosql.cn-north-7.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/db-upgrade 请求示例 批量升级数据库补丁版本： { "instance_ids" : [ "046287aae57843b1a7bc61b7a8812f41in13", "3d1e04f49efa473a8c7eaf07ed7ff870in13" ] }

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

响应参数 状态码： 202 表4 响应Body参数 参数 参数类型 描述 upgrade_results Array of UpgradeResult objects 批量升级结果。 表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 错误消息。

请求示例 创建DDM实例组，组类型：读写，节点数为1个。 POST https://{endpoint}/v3/{project_id}/instances/{instance_id}/groups { "name": "group-1", "type": "rw", "flavor_id": "a615922f-0ed8-3691-aad4-a595185febba", "nodes": [ { "available_zone": "az1", "subnet_id": "ead1e945-ca89-45dd-bcce-4a30b2054c22" } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务的“获取用户Token”接口来获取。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String DDM实例组名称，命名要求如下。 长度为4-64个字符。 必须以字母开头。 可以包含字母、数字、中划线、下划线、不能包含其它特殊字符。 最小长度：4 最大长度：64 type 是 String 实例组的类型。 rw：读写组 r：只读组 flavor_id 是 String 规格ID。 nodes 是 Array of 表 NodeInfo objects 节点信息列表。 最小：1 最大：32 表4 NodeInfo 参数 是否必选 参数类型 描述 available_zone 是 String 节点可用区。取值非空，请参见地区和终端节点。 subnet_id 是 String 子网ID。

请求消息 请求参数 无。 URI样例 查询所有实例列表 GET https://{endpoint}/v3/97b026aa9cc4417888c14c84a1ad9860/instances 根据指定条件查询实例列表 GET https://{endpoint}/v3/97b026aa9cc4417888c14c84a1ad9860/instances?id=ed7cc6166ec24360a5ed5c5c9c2ed726in01&name=hy&type=Ha&datastore_type=MySQL&vpc_id=19e5d45d-70fd-4a91-87e9-b27e71c9891f&subnet_id=bd51fb45-2dcb-4296-8783-8623bfe89bb7&offset=0&limit=10&tags=rds001=001,rds002=002

URI URI格式 GET /v3/{project_id}/instances?id={id}&name={name}&type={type}&datastore_type={datastore_type}&vpc_id={vpc_id}&subnet_id={subnet_id}&offset={offset}&limit={limit}&tags={key}={value} 参数说明 表1 参数说明 名称 参数类型 是否必选 说明 project_id String 是 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 id String 否 参数解释： 实例ID。 “*”为系统保留字符，如果id是以“*”起始，表示按照*后面的值模糊匹配，否则，按照id精确匹配查询。不能只传入“*”。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 name String 否 参数解释： 实例名称。 “*”为系统保留字符，如果name是以“*”起始，表示按照*后面的值模糊匹配，否则，按照name精确匹配查询。不能只传入“*”。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 type String 否 参数解释： 实例类型。 约束限制： 不涉及。 取值范围： Single：单机实例 Ha：主备实例 Replica：只读实例 Enterprise：分布式实例（企业版） 默认取值： 不涉及。 datastore_type String 否 参数解释： 数据库类型。 约束限制： 区分大小写。 取值范围： MySQL PostgreSQL SQLServer 默认取值： 不涉及。 vpc_id String 否 参数解释： 虚拟私有云ID，获取方法如下： 方法1：登录虚拟私有云服务的控制台界面，在虚拟私有云的详情页面查找VPC ID。 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询VPC列表。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 subnet_id String 否 参数解释： 子网的网络ID信息，获取方法如下： 方法1：登录虚拟私有云服务的控制台界面，单击VPC下的子网，进入子网详情页面，查找网络ID。 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询子网列表。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 offset Integer 否 参数解释： 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。 约束限制： 必须为数字，不能为负数。 取值范围： 大于等于0的整数。 默认取值： 0 limit Integer 否 参数解释： 查询记录数。 约束限制： 不涉及。 取值范围： 默认为100，不能为负数，最小值为1，最大值为100。 默认取值： 100 tags Array of objects 否 参数解释： 根据实例标签键值对进行查询。 {key}表示标签键，不可以为空或重复。 {value}表示标签值，可以为空。 如果同时使用多个标签键值对进行查询，中间使用逗号分隔开，最多包含10组。 详情请参见表2。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 表2 tags字段数据结构说明 名称 参数类型 是否必选 说明 key String 是 参数解释： 标签键。 约束限制： 不涉及。 取值范围： 长度为1-128个unicode字符。 可以包含任何语种字母、数字、空格和_.:=+-@，但首尾不能含有空格，不能以_sys_开头。 默认取值： 不涉及。 value String 否 参数解释： 标签值。 约束限制： 不涉及。 取值范围： 最大长度255个unicode字符，可以为空字符串。 可以包含任何语种字母、数字、空格和_.:=+-@。 默认取值： 不涉及。

响应消息 参数说明 表9 参数说明 名称 参数类型 是否必选 描述 id String 否 实例ID。 name String 否 实例名称，与请求参数相同。 datastore Object 否 数据库信息，与请求参数相同。详情请参见表10。 created String 否 创建时间为本地时间，格式为“yyyy-mm-dd hh:mm:ss”。 status String 否 实例状态，取值为“creating”。 region String 否 区域ID，与请求参数相同。 availability_zone String 否 可用区ID，与请求参数相同。 vpc_id String 否 虚拟私有云ID，与请求参数相同。 subnet_id String 否 子网的网络ID，与请求参数相同。 security_group_id String 否 安全组ID列表，与请求参数相同。 port Integer 否 数据库访问端口。 disk_encryption_id String 否 磁盘加密的密钥ID，与请求参数相同。 mode String 否 实例类型，与请求参数相同。 configurations Array of objects 否 参数组配置信息。 详情请参见表11。 flavor Array of objects 否 实例规格详情，与请求参数相同。详情请参见表12。 backup_strategy Object 否 高级备份策略，与请求参数相同。详情请参见表13。 enterprise_project_id String 否 企业项目ID。取值为“0”，表示为default企业项目。 ssl_option String 否 SSL开关选项，与请求参数相同。 dss_pool_id String 否 Dec用户专属存储ID，与请求参数相同。 job_id String 否 创建实例的工作流ID。 tags Array of objects 否 标签列表，与请求参数相同。 详情请参见表14。 order_id String 否 创建实例的订单ID，仅创建包年包月实例时返回该参数。 charge_info Object 否 付费方式信息，与请求参数相同。 详情请参见表15。 表10 datastore字段数据结构说明 名称 参数类型 是否必选 描述 type String 是 数据库版本类型。取值为“DDS-Community”。 version String 是 数据库版本。支持5.0、4.4、4.2、4.0、3.4版本，取值为“5.0”、“4.4”、“4.2”、“4.0”、“3.4”。 storage_engine String 是 存储引擎。支持WiredTiger/RocksDB存储引擎。 数据库版本为4.2及以上时，存储引擎为RocksDB，取值为“rocksDB”。 数据库版本为4.0和3.4时，存储引擎为WiredTiger，取值为“wiredTiger”。 表11 Configurations字段数据结构说明 参数 参数类型 是否必选 描述 type String 是 节点类型。取值： 集群实例包含mongos、shard和config节点，各节点下该参数取值分别为“mongos”、“shard”和“config”。 副本集实例下该参数取值为“replica”。 枚举值： mongos shard config replica configuration_id String 是 参数组id。获取参数值请参见表4 表12 flavor字段数据结构说明 名称 参数类型 是否必选 描述 type String 是 节点类型。 num String 是 节点数量或组数量。 storage String 否 磁盘类型。 size String 否 磁盘大小。 spec_code String 是 资源规格编码。 表13 backup_strategy字段数据结构说明 名称 参数类型 是否必选 描述 start_time String 是 备份时间段。自动备份将在该时间段内触发。 keep_days String 否 指定已生成的备份文件可以保存的天数。 表14 tags字段数据结构说明 名称 参数类型 是否必选 描述 key String 是 标签键。最大长度36个unicode字符。 key不能为空，不能为空字符串，不能重复。 字符集：A-Z，a-z ， 0-9，‘-’，‘_’，UNICODE字符（\u4E00-\u9FFF）。 value String 是 标签值。最大长度43个unicode字符。 可以为空字符串。 字符集：A-Z，a-z ， 0-9，‘.’，‘-’，‘_’，UNICODE字符（\u4E00-\u9FFF）。 表15 charge_info字段数据结构说明 参数 参数类型 是否必选 描述 charge_mode String 是 计费模式。 取值范围： prePaid：预付费，即包年/包月。 postPaid：后付费，即按需付费。 period_type String 否 订购周期类型。 “charge_mode”为“prePaid”时生效，且为必选值。 取值范围： month：包月。 year：包年。 period_num Integer 否 “charge_mode”为“prePaid”时生效，且为必选值，指定订购的时间。 取值范围： 当“period_type”为“month”时，取值为1~9。 当“period_type”为“year”时，取值为1~3 is_auto_renew Boolean 否 创建包周期实例时可指定，表示是否自动续订，续订的周期和原周期相同，且续订时会自动支付。 取值范围： true，表示自动续订。 false，表示不自动续订，默认为该方式。 is_auto_pay Boolean 否 创建包周期实例时可指定，表示是否自动从账户中支付，该字段不影响自动续订的支付方式。 取值范围： true，表示自动从账户中支付。 false，表示手动从账户中支付，默认为该支付方式。 响应示例中参数“region”和“availability_zone”的值为示例值。 响应示例 集群实例： { "id": "39b6a1a278844ac48119d86512e0000bin02", "name": "test-cluster-01", "datastore": { "type": "DDS-Community", "version": "3.4", "storage_engine": "wiredTiger" }, "created": "2019-01-16 09:34:36", "status": "creating", "region": "aaa", "availability_zone": "az1xahz", "vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce", "subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f", "security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5", "disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4", "mode": "Sharding", "configurations": [ { "type": "mongos", "configuration_id": "acb288dbd1174f26a8960b45591bd98apr02" }, { "type": "shard", "configuration_id": "5bca546f0be64b038124ef9cedd1bfa1pr02" }, { "type": "config", "configuration_id": "4d123b3ba8294921802b11bf4d8c5735pr02" } ], "flavor": [ { "type": "mongos", "num": 2, "spec_code": "dds.mongodb.c6.medium.4.mongos" }, { "type": "shard", "num": 2, "storage": "ULTRAHIGH", "spec_code": "dds.mongodb.c6.medium.4.shard", "size": 20 }, { "type": "config", "num": 1, "storage": "ULTRAHIGH", "spec_code": "dds.mongodb.c6.large.2.config", "size": 20 } ], "backup_strategy": { "start_time": "08:15-09:15", "keep_days": "8" }, "enterprise_project_id": "", "ssl_option": "1", "dss_pool_id": "f5f84ed7-6f19-4bd4-99d7-b450ad6cc4dd", "job_id": "c010abd0-48cf-4fa8-8cbc-090f093eaa2f", "tags": [ { "key": "dds001", "value": "dds001" } ] }

请求示例 创建版本为3.2，存储引擎为wiredTiger，带有虚拟私有云，子网，安全组，参数组配置，启用SSL连接，带有标签的集群实例 { "name": "test-cluster-01", "datastore": { "type": "DDS-Community", "version": "3.2", "storage_engine": "wiredTiger" }, "region": "aaa", "availability_zone": "az1xahz", "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961", "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007", "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58", "password": "******", "mode": "Sharding", "configurations": [ { "type": "mongos", "configuration_id": "acb288dbd1174f26a8960b45591bd98apr02" }, { "type": "shard", "configuration_id": "5bca546f0be64b038124ef9cedd1bfa1pr02" }, { "type": "config", "configuration_id": "4d123b3ba8294921802b11bf4d8c5735pr02" } ], "flavor": [ { "type": "mongos", "num": 2, "spec_code": "dds.mongodb.c6.medium.4.mongos" }, { "type": "shard", "num": 2, "storage": "ULTRAHIGH", "size": 20, "spec_code": "dds.mongodb.c6.medium.4.shard" }, { "type": "config", "num": 1, "storage": "ULTRAHIGH", "size": 20, "spec_code": "dds.mongodb.c6.large.2.config" } ], "backup_strategy": { "start_time": "08:15-09:15", "keep_days": 8 }, "ssl_option": 1, "dss_pool_id": "f5f84ed7-6f19-4bd4-99d7-b450ad6cc4dd", "server_group_policies": [ "anti-affinity" ], "tags": [ { "key": "dds001", "value": "dds001" } ] } 创建版本为3.4，存储引擎为wiredTiger，带有虚拟私有云，子网，安全组，参数组配置，启用SSL连接，带有标签的跨AZ集群实例 { "name": "test-cluster-01", "datastore": { "type": "DDS-Community", "version": "3.4", "storage_engine": "wiredTiger" }, "region": "aaa", "availability_zone": "aaa,bbb,ccc", "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961", "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b", "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58", "password": "******", "mode": "Sharding", "flavor": [ { "type": "mongos", "num": 2, "spec_code": "dds.mongodb.c6.medium.4.mongos" }, { "type": "shard", "num": 2, "storage": "ULTRAHIGH", "size": 20, "spec_code": "dds.mongodb.c6.medium.4.shard" }, { "type": "config", "num": 1, "storage": "ULTRAHIGH", "size": 20, "spec_code": "dds.mongodb.c6.large.2.config" } ], "backup_strategy": { "start_time": "23:00-00:00", "keep_days": "8" }, "ssl_option":"1", "tags" : [{ "key" : "dds001", "value" : "dds001" }] } 创建版本为3.2，存储引擎为wiredTiger，带有虚拟私有云，子网，安全组，参数组配置，启用SSL连接，带有标签的副本集实例 { "name": "test-replicaset", "datastore": { "type": "DDS-Community", "version": "3.2", "storage_engine": "wiredTiger" }, "region": "aaa", "availability_zone": "az1xahz", "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961", "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007", "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58", "password": "******", "mode": "ReplicaSet", "configurations": [ { "type": "replica", "configuration_id": "f17e3aad778440fbb68603c8c9032003pr02" } ], "flavor": [ { "type": "replica", "num": 1, "storage": "ULTRAHIGH", "size": 30, "spec_code": "dds.mongodb.c6.medium.4.repset" } ], "backup_strategy": { "start_time": "08:15-09:15", "keep_days": 8 }, "ssl_option": 1, "tags": [ { "key": "dds001", "value": "dds001" } ] }

URI URI格式 POST /v3/{project_id}/instances/{instance_id}/action 参数说明 表1 参数说明 名称 是否必选 参数类型 说明 project_id 是 String 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 instance_id 是 String 参数解释： 实例ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

请求示例 变更FlexusRDS数据库实例的规格为rds.mysql.m1.xlarge。 POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/action{"resize_flavor": {"spec_code": "rds.mysql.m1.xlarge", "is_auto_pay": true, "is_delay": true}}

请求消息 表2 参数说明 名称 是否必选 参数类型 说明 resize_flavor 是 Object 参数解释： 规格信息。请参见表3。 约束限制： 不涉及。 表3 resize_flavor字段数据结构说明 名称 是否必选 参数类型 说明 spec_code 是 String 参数解释： 资源规格编码。 约束限制： 不涉及。 取值范围： 例如：rds.mysql.y1.xlarge.2。其中，rds代表RDS产品，mysql代表数据库引擎，y1.xlarge代表性能规格，为轻量型规格。 默认取值： 不涉及。 is_auto_pay 否 Boolean 参数解释： 是否自动从客户的账户中支付。 约束限制： 不涉及。 取值范围： true，为自动支付。 false，为手动支付，默认该方式。 默认取值： 不涉及。 is_delay 否 Boolean 参数解释： 是否进行定时规格变更。 约束限制： 不涉及。 取值范围： true，为定时变更，将在运维时间窗内进行变更操作。 false，为即时变更，默认该方式。 默认取值： 不涉及。

请求消息 参数说明 表2 参数说明 参数 是否必选 参数类型 描述 period_type 是 String 参数解释： 周期类型。 约束限制： 不涉及。 取值范围： MONTH：月 YEAR：年 默认取值： 不涉及。 period_num 是 int 参数解释： 周期数。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 auto_pay_policy 否 String 参数解释： 是否自动支付。 约束限制： 不涉及。 取值范围： YES：自动扣费 NO：手动支付（默认） 默认取值： NO auto_renew_policy 否 String 参数解释： 是否到期自动续期。 约束限制： 不涉及。 取值范围： YES：自动续费 NO：不自动续费（默认） 默认取值： NO URI样例 POST https://rds.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/49b9dd1d6f464ba4bc91df5cbd2e52ebin03/to-period 请求示例 RDS实例按需转包周期。 { "period_type" : "MONTH", "period_num" : 6, "auto_pay_policy" : "NO", "auto_renew_policy" : "NO" }

URI URI格式 POST /v3/{project_id}/instances/{instance_id}/to-period 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 instance_id 是 参数解释： 实例ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

智能诊断 基于运行数据结合智能算法对实例进行智能诊断，并对异常项提供具体的诊断结果以及优化建议。 图2 健康智能诊断 单击异常诊断项名称，查看异常实例以及相关监控指标的数据。 例如：出现“高压力请求”异常情况时，可以单击“高压力请求”查看出现异常的实例信息、对应的CPU使用率、CPU使用率趋势，还可以单击操作列的“诊断详情”，查看详细的诊断结果。 支持的诊断项以及诊断异常的处理建议，请参见表4。 表4 智能诊断说明 诊断项 监控指标 指标说明 处理建议 相关案例 高压力请求 CPU使用率 (%) 该指标用于统计测量对象的CPU使用率。 评估业务SQL的执行计划，添加索引避免全表扫描。 扩容CPU规格，满足计算型业务需求。 TaurusDB CPU使用率高的解决方法 内存超限风险 内存使用率 (%) 该指标用于统计测量对象的内存使用率。 扩容实例规格，满足业务需求。 优化SQL，减少临时表等的使用。 会话定期重连，及时释放session级别内存。 长事务产生大量临时表导致内存超限的解决办法 慢SQL高频 慢日志个数统计 (个/分钟) 该指标展示每分钟TaurusDB产生慢日志的数量。 根据慢SQL的执行计划进行优化。 扩容CPU规格，满足业务需求。 联合索引设置不当导致慢SQL的解决办法 连接数超限 数据库总连接数 (个) 该指标用于统计连接到TaurusDB服务器的总连接数。 排查业务侧连接是否有效，优化实例连接，释放不必要的连接。 实例规格偏小，需要对数据库进行规格扩容。 TaurusDB数据库连接数满的排查思路 当前活跃连接数 (个) 该指标用于统计当前活跃的连接数。 连接数使用率（%） 该指标用于统计当前已用的TaurusDB连接数占最大连接数的百分比。