华为云用户手册

请求示例 修改实例秒级监控开关及频率，开启秒级监控，采集周期为1s。 PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/61a4ea66210545909d74a05c27a7179ein07/monitor-policy { "monitor_switch" : true, "period" : 1 } 修改实例秒级监控开关，关闭秒级监控。 PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/61a4ea66210545909d74a05c27a7179ein07/monitor-policy { "monitor_switch" : false }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。默认en-us。 取值范围： en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 monitor_switch 是 Boolean 实例秒级监控开关。 true：开启。 false：关闭。 period 否 Integer 采集周期，仅在monitor_switch为true时生效。默认为5s。monitor_switch为false时，不传该参数。取值： 1：采集周期为1s。 5：采集周期为5s。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 job_id String 修改秒级监控的任务流ID。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 diagnosis_info Array of DiagnosisInfo objects 诊断信息列表。 表4 DiagnosisInfo 参数 参数类型 描述 metric_name String 指标名称。 count Integer 实例数量。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

响应示例 状态码： 200 Success. { "diagnosis_info" : [ { "metric_name" : "high_pressure", "count" : 8 }, { "metric_name" : "insufficient_capacity", "count" : 0 }, { "metric_name" : "slow_sql_frequency", "count" : 0 }, { "metric_name" : "mem_overrun", "count" : 0 }, { "metric_name" : "connections_exceed", "count" : 0 } ] }

响应参数 状态码： 201 表5 响应Body参数 参数 参数类型 描述 job_id String 任务ID。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。默认en-us。 取值范围： en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 flavor_ref 是 String 数据库代理规格码，获取方法请参见查询数据库代理规格信息返回的spec_code字段。 node_num 是 Integer 数据库代理节点数，取值整数2-16。 proxy_name 否 String 数据库代理名称。用于表示实例的名称，同一租户下，同类型的实例名可重名。 取值范围：最小为4个字符，最大为64个字符且不超过64个字节（注意：一个中文字符占用3个字节），必须以字母或中文开头，区分大小写，可以包含字母、数字、中划线、下划线或中文，不能包含其他特殊字符。 proxy_mode 否 String 数据库代理类型。默认类型为readwrite。 route_mode 否 Integer 数据库代理路由模式，默认为0，权重负载模式。 取值范围: 0：表示权重负载模式。 1：表示负载均衡模式（数据库主节点不接受读请求）。 2：表示负载均衡模式（数据库主节点接受读请求）。 nodes_read_weight 否 Array of NodesWeight objects 数据库节点的读权重设置。 在proxy_mode为readonly时，只能为只读节点选择权重。 subnet_id 否 String 数据库VPC下的子网ID。 new_node_auto_add_status 否 String 是否开启新增节点自动加入该Proxy。如果需要设置是否开启新增节点自动加入该Proxy，请联系客服人员添加白名单，加入白名单后，方可输入该字段。加入白名单后，默认值为OFF。 取值范围： ON：开启。 OFF：关闭。 new_node_weight 否 Integer 新增节点的读权重，在new_node_auto_add_status参数为ON时为必选字段： 如果路由模式为0，新增节点自动加入为ON，取值为0~1000。 如果路由模式不为0或新增节点自动加入为OFF，则可不输入读权重。 表4 NodesWeight 参数 是否必选 参数类型 描述 id 否 String 数据库节点ID。 weight 否 Integer 权重: 如果路由模式为0，取值为0~1000。 如果路由模式为1，数据库主节点取值为0，只读节点取值为0或1。 如果路由模式为2，数据库主节点取值为1，只读节点取值为0或1。

请求示例 开启数据库代理，规格2U8GB，代理模式只读模式。 POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/43e4feaab48f11e89039fa163ebaa7e4br01/proxy { "flavor_ref" : "gaussdb.proxy.large.x86.2", "node_num" : 2, "proxy_name" : "gaussdb-proxy", "proxy_mode" : "readonly", "route_mode" : 0, "nodes_read_weight" : [ { "id" : "45021bf73a244312a3f2af95092feeecno07", "weight" : 50 }, { "id" : "d78a65690cea4af5ad14585e110ff89bno07", "weight" : 400 } ], "subnet_id" : "6991d82d-9166-4aff-a1fa-d2a8748b7084" }

URI POST /v3/{project_id}/instances/{instance_id}/proxy/{proxy_id}/access-control-switch 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String 实例ID，严格匹配UUID规则。 proxy_id 是 String 数据库代理ID，严格匹配UUID规则。

请求示例 开启访问控制。 POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/61a4ea66210545909d74a05c27a7179ein07/proxy/e87088f0b6a345e79db19d57c41fde15po01/access-control-switch { "open_access_control" : true } 关闭访问控制。 POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/61a4ea66210545909d74a05c27a7179ein07/proxy/e87088f0b6a345e79db19d57c41fde15po01/access-control-switch { "open_access_control" : false }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。默认en-us。 取值范围： en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 open_access_control 是 Boolean 是否开启访问控制。 取值： - true：开启。 - false：关闭。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 open_access_control Boolean 是否已开启访问控制。 取值： - true：开启。 - false：关闭。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

响应示例 状态码： 200 Success. { "enable_ip_group" : false, "type" : "black", "ip_group" : [ { "id" : "a4217ac4-12cd-4fb3-acfc-db4a4a1896ea", "name" : "PROXY-8c72c1b6985f414da0cfbc76ad7effc1po01_elbIpGroup", "ip_list" : [ { "ip" : "192.127.0.1", "description" : "proxy ipgroup" }, { "ip" : "192.127.0.2", "description" : "proxy ipgroup" } ] } ] }

URI GET /v3/{project_id}/instances/{instance_id}/proxy/{proxy_id}/ipgroup 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 instance_id 是 String 实例ID，严格匹配UUID规则。 proxy_id 是 String 数据库代理ID，严格匹配UUID规则。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 enable_ip_group Boolean 允许访问控制或者不允许 true | false。 type String 白名单或者黑名单 'white' | 'black' ip_group ProxyIpGroupDetail object 白名单或黑名单详细信息 表4 ProxyIpGroupDetail 参数 参数类型 描述 id String ipGroup的id name String ipGroup的名称 ip_list Array of IpGroupItem objects ipGroup内部的ip列表 表5 IpGroupItem 参数 参数类型 描述 ip String ip或者网段 description String ip的描述 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 Content-Type 是 String 内容类型。 取值：application/json。 X-Language 否 String 语言。 表3 请求Body参数 参数 是否必选 参数类型 描述 node_list 是 Array of SingleNodeInfo objects 节点信息列表 表4 SingleNodeInfo 参数 是否必选 参数类型 描述 node_id 是 String 节点ID。 name 是 String 节点名称。支持中文、数字、字母、连接符-和_，长度为4-128。

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 job_id String 工作流ID。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

请求示例 批量修改节点名称。 POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/61a4ea66210545909d74a05c27a7179ein07/nodes/name { "node_list" : [ { "node_id" : "799a0f2fa49d4151bf2f7063c1fbba36no07", "name" : "gauss-cdf5_node03" } ] }

响应示例 状态码： 200 Success. { "flavors" : [ { "type" : "x86", "vcpus" : "4", "ram" : "16", "id" : "de565db8-0a96-37ea-9388-61167624712c", "spec_code" : "gaussdb.sr-be.xlarge.x86.4", "version_name" : "8.0", "instance_mode" : "Cluster", "az_status" : { "cn-southwest-244d" : "normal", "cn-southwest-244c" : "normal", "cn-southwest-244b" : "normal", "cn-southwest-244a" : "unsupported" } }, { "type" : "x86", "vcpus" : "4", "ram" : "16", "id" : "afef3bfd-ac7c-32e1-ba44-c388acbb196a", "spec_code" : "gaussdb.sr-fe.xlarge.x86.4", "version_name" : "8.0", "instance_mode" : "Cluster", "az_status" : { "cn-southwest-244d" : "normal", "cn-southwest-244c" : "normal", "cn-southwest-244b" : "normal", "cn-southwest-244a" : "unsupported" } }, { "type" : "x86", "vcpus" : "8", "ram" : "32", "id" : "c50e8e15-f2fc-3b40-aca6-c98f07ce2ce0", "spec_code" : "gaussdb.sr-be.2xlarge.x86.4", "version_name" : "8.0", "instance_mode" : "Cluster", "az_status" : { "cn-southwest-244d" : "normal", "cn-southwest-244c" : "normal", "cn-southwest-244b" : "normal", "cn-southwest-244a" : "unsupported" } }, { "type" : "x86", "vcpus" : "8", "ram" : "32", "id" : "24059750-4280-3ee5-a44b-488b924633b4", "spec_code" : "gaussdb.sr-fe.2xlarge.x86.4", "version_name" : "8.0", "instance_mode" : "Cluster", "az_status" : { "cn-southwest-244d" : "normal", "cn-southwest-244c" : "normal", "cn-southwest-244b" : "normal", "cn-southwest-244a" : "unsupported" } }, { "type" : "x86", "vcpus" : "16", "ram" : "64", "id" : "a48c63dc-5563-3813-9e13-39d3301e56f4", "spec_code" : "gaussdb.sr-be.4xlarge.x86.4", "version_name" : "8.0", "instance_mode" : "Cluster", "az_status" : { "cn-southwest-244d" : "normal", "cn-southwest-244c" : "normal", "cn-southwest-244b" : "normal", "cn-southwest-244a" : "unsupported" } }, { "type" : "x86", "vcpus" : "16", "ram" : "64", "id" : "0ef44c01-f7a1-30f5-9f05-9e47094e8c1f", "spec_code" : "gaussdb.sr-fe.4xlarge.x86.4", "version_name" : "8.0", "instance_mode" : "Cluster", "az_status" : { "cn-southwest-244d" : "normal", "cn-southwest-244c" : "normal", "cn-southwest-244b" : "normal", "cn-southwest-244a" : "unsupported" } }, { "type" : "x86", "vcpus" : "32", "ram" : "128", "id" : "2bf6aa50-50da-3f27-91af-a8c873070537", "spec_code" : "gaussdb.sr-fe.8xlarge.x86.4", "version_name" : "8.0", "instance_mode" : "Cluster", "az_status" : { "cn-southwest-244d" : "normal", "cn-southwest-244c" : "normal", "cn-southwest-244b" : "normal", "cn-southwest-244a" : "normal" } }, { "type" : "x86", "vcpus" : "32", "ram" : "128", "id" : "9f52a065-aa93-371a-9975-959fedf6e24f", "spec_code" : "gaussdb.sr-be.8xlarge.x86.4", "version_name" : "8.0", "instance_mode" : "Cluster", "az_status" : { "cn-southwest-244d" : "normal", "cn-southwest-244c" : "normal", "cn-southwest-244b" : "normal", "cn-southwest-244a" : "normal" } }, { "type" : "x86", "vcpus" : "64", "ram" : "256", "id" : "709822e4-567f-3e85-b4af-cb099206c8e2", "spec_code" : "gaussdb.sr-fe.16xlarge.x86.4", "version_name" : "8.0", "instance_mode" : "Cluster", "az_status" : { "cn-southwest-244d" : "normal", "cn-southwest-244c" : "normal", "cn-southwest-244b" : "normal", "cn-southwest-244a" : "unsupported" } }, { "type" : "x86", "vcpus" : "64", "ram" : "256", "id" : "4e56e208-0226-34bb-b84d-035ab0497824", "spec_code" : "gaussdb.sr-be.16xlarge.x86.4", "version_name" : "8.0", "instance_mode" : "Cluster", "az_status" : { "cn-southwest-244d" : "normal", "cn-southwest-244c" : "normal", "cn-southwest-244b" : "normal", "cn-southwest-244a" : "unsupported" } } ] } 状态码： 400 Client error. { "error_msg" : "Invalid specification code.", "error_code" : "DBS.280434" }

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 Content-Type 是 String 内容类型。 取值：application/json。 X-Language 否 String 请求语言类型。默认en-us。 取值范围： en-us zh-cn

URI GET /v3/{project_id}/htap/flavors/{engine_name} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 engine_name 是 String HTAP引擎名。 取值范围： star-rocks click-house 表2 Query参数 参数 是否必选 参数类型 描述 availability_zone_mode 否 String 可用区模式，当前仅支持single。 spec_code 否 String 规格码，提供后仅查询指定规格码规格信息。 version_name 否 String 数据库版本号，不填默认3.1.6.0。

响应示例 状态码： 200 Success. { "resources" : [ { "id" : "1d07f7ba-f140-46a7-b002-58ba22ee6ff3", "resource_name" : "testdcc", "engine_name" : "gaussdb-mysql", "architecture" : "ARM", "status" : "NORMAL", "capacity" : { "ram" : 256, "volume" : 10000000, "vcpus" : 64 }, "availability_zone" : [ "az1xahz" ] } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 resources Array of DedicatedResource objects 专属资源池信息。 total_count Integer 专属资源池数量。 表5 DedicatedResource 参数 参数类型 描述 id String 专属资源池ID。 resource_name String 专属资源池名称。 engine_name String 数据库引擎名称。 architecture String CPU架构 status String 专属资源池状态。 取值范围： NORMAL：正常。 BUILDING：构建中。 EXTENDING：扩容中。 DELETED：已删除。 capacity DedicatedResourceCapacity object 专属资源池容量信息。 availability_zone Array of strings 专属资源池可用区信息。 表6 DedicatedResourceCapacity 参数 参数类型 描述 ram Integer 内存大小，单位GB。 volume Long 磁盘容量，单位GB。 vcpus Integer CPU核数。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

URI GET /v3/{project_id}/dedicated-resources 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 limit 否 Integer 查询记录数。默认为100，不能为负数，最小值为1，最大值为100。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 job GetJobInfoDetail object 任务信息。 表5 GetJobInfoDetail 参数 参数类型 描述 id String 参数解释： 任务ID。 取值范围： 与入参保持一致。 name String 参数解释： 任务名称。 取值范围： 不涉及。 status String 参数解释： 任务执行状态。 取值范围： Pending：表示延时任务，未执行。 Running：表示任务正在执行。 Completed：表示任务执行成功。 Failed：表示任务执行失败。 created String 参数解释： 创建时间，格式为"yyyy-mm-ddThh:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 取值范围： 不涉及。 ended String 参数解释： 结束时间，格式为"yyyy-mm-ddThh:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 取值范围： 不涉及。 process String 参数解释： 任务执行进度。 取值范围： 执行中状态才返回执行进度，例如60%，否则返回""。 instance GetJobInstanceInfoDetail object 参数解释： 指定ID任务的实例信息。 entities Object 参数解释： 根据不同的任务，显示不同的内容。 fail_reason String 参数解释： 任务执行失败时的错误信息。 取值范围： 不涉及。 表6 GetJobInstanceInfoDetail 参数 参数类型 描述 id String 参数解释： 实例ID，此参数是实例的唯一标识。 取值范围： 只能由英文字母、数字组成，后缀为in07，长度为36个字符。 name String 参数解释： 实例名称。 取值范围： 最小为4个字符，最大为64个字符且不超过64个字节（注意：一个中文字符占用3个字节），必须以字母或中文开头，区分大小写，可以包含字母、数字、中划线、下划线或中文，不能包含其他特殊字符。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

响应示例 状态码： 200 Success. { "job" : { "id" : "f9959f52-aa4d-43f7-be74-44b6fc20b239", "name" : "Create GaussDB forMySQLInstance", "status" : "Completed", "created" : "2018-08-06T10:41:14+0800", "ended" : "2018-08-06T16:41:14+0000", "process" : "", "instance" : { "id" : "a48e43ff268f4c0e879652d65e63d0fbin07", "name" : "DO-NOT-TOUCH-mgr2-mysql-single" }, "entities" : { "instance" : { "endpoint" : "192.168.1.203:3306", "type" : "Cluster", "datastore" : { "type" : "gaussdb-mysql", "version" : "8.0" } }, "resource_ids" : [ "a48e43ff268f4c0e879652d65e63d0fbin07.vm", "a48e43ff268f4c0e879652d65e63d0fbin07.volume" ] } } }

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释： 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 约束限制： 不涉及。 取值范围： 不涉及。 默认值： 不涉及。 X-Language 否 String 参数解释： 请求语言类型。 约束限制： 不涉及。 取值范围： en-us zh-cn 默认值： en-us。

URI GET /v3/{project_id}/jobs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认值： 不涉及。 表2 Query参数 参数 是否必选 参数类型 描述 id 是 String 参数解释： 任务ID。 获取方法参见获取即时任务列表和获取定时任务列表。 约束限制： 不涉及。 取值范围： 不涉及。 默认值： 不涉及。

请求示例 修改数据库备注。 PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/a23fb62bd61e4e9e9636fd2225f395bein07/databases/comment { "databases" : [ { "name" : "gaussdb_mysql_user1", "comment" : "first_database" } ] }

响应参数 状态码： 202 表5 响应Body参数 参数 参数类型 描述 job_id String 修改数据库备注的任务ID。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。