华为云用户手册

响应示例 状态码： 200 Success. { "instances" : [ { "id" : "11684a0e59e94bceba7880d58cfb07b5in07", "name" : "gaussdb-mysql-instance01", "alias" : "", "status" : "normal", "project_id" : "3cedfc54-b105-4652-a4e0-847b11576628", "enterprise_project_id" : 0, "type" : "Cluster", "charge_info" : { "charge_mode" : "postPaid", "order_id" : "" }, "node_count" : 2, "datastore" : { "type" : "gaussdb-mysql", "version" : "8.0", "kernel_version" : "2.0.29.1" }, "created" : "2022-07-14T16:26:58+0800", "updated" : "2022-07-18T14:20:33+0800", "public_ips" : "10.154.219.187", "private_write_ips" : [ "192.168.0.142" ], "private_dns_names" : [ "11684a0e59e94bceba7880d58cfb07b5in07.internal.cn-xianhz-1.gaussdbformysql.myhuaweicloud.com" ], "db_user_name" : "root", "port" : 3306, "vpc_id" : "3cedfc54-b105-4652-a4e0-847b11576b58", "subnet_id" : "c1cfa53c-65d3-431e-8552-326bf310c7ad", "security_group_id" : "fc577a1a-f202-424a-977f-24faec3fdd55", "backup_strategy" : { "start_time" : "19:00-20:00", "keep_days" : 7 }, "nodes" : [ { "id" : "799a0f2fa49a4151bf9f7063c1fbba36no07", "name" : "gauss-d616-lb07_node01", "type" : "master", "status" : "normal", "port" : 3306, "private_read_ips" : [ "192.168.0.163" ], "volume" : { "type" : "POOL", "used" : 0.07 }, "az_code" : "az1xahz", "region_code" : "cn-xianhz-1", "flavor_id" : "3169caaf-6c2f-41d5-aadd-c8fc3d83597e", "flavor_ref" : "gaussdb.mysql.xlarge.arm.4", "max_connections" : 1500, "vcpus" : 1, "ram" : 4, "need_restart" : false, "priority" : 1, "created" : "2022-07-14T16:26:58+0800", "updated" : "2022-07-18T09:24:18+0800" }, { "id" : "799a0f2fa49a4151bf9f7063c1fbba35no07", "name" : "gauss-d616-lb07_node02", "type" : "slave", "status" : "normal", "port" : 3306, "private_read_ips" : [ "192.168.0.162" ], "volume" : { "type" : "POOL", "used" : 0.07 }, "az_code" : "az1xahz", "region_code" : "cn-xianhz-1", "flavor_id" : "3169caaf-6c2f-41d5-aadd-c8fc3d83597e", "flavor_ref" : "gaussdb.mysql.xlarge.arm.4", "max_connections" : 1500, "vcpus" : 1, "ram" : 4, "need_restart" : false, "priority" : 1, "created" : "2022-07-14T16:26:58+0800", "updated" : "2022-07-18T09:36:18+0800" } ], "time_zone" : "UTC+08:00", "backup_used_space" : 0.24, "az_mode" : "single", "master_az_code" : "az1", "maintenance_window" : "18:00-22:00", "tags" : [ ], "configuration_id" : "53570e0de54e40c5a15f331aa5sd2176pr07", "dedicated_resource_id" : "", "proxies" : [ { "pool_id" : "dab1cfc5150c4d1ca0e8c6596bfc0d8cpo01", "address" : "192.168.10.76", "name" : "proxy-name" } ] } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 instances Array of MysqlInstanceInfoDetailUnifyStatus objects 实例详情。 表5 MysqlInstanceInfoDetailUnifyStatus 参数 参数类型 描述 id String 实例ID，严格匹配UUID规则。 name String 创建的实例名称。 project_id String 租户在某一Region下的project ID。 status String 实例状态。 取值： 值为“creating”，表示实例正在创建。 值为“normal”，表示实例正常。 值为“abnormal”，表示实例异常。 值为“createfail”，表示实例创建失败。 port String 数据库端口号。 alias String 实例备注 type String 实例类型，取值为“Cluster”。 charge_info MysqlInstanceChargeInfo object 计费类型信息，支持包年包月和按需，默认为按需。 node_count Integer 节点个数。 datastore MysqlDatastoreWithKernelVersion object 数据库信息。 backup_used_space Double 备份空间使用大小，单位为GB。 created String 创建时间，格式为"yyyy-mm-ddThh:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 updated String 更新时间，格式与"created"字段对应格式完全相同。 private_write_ips Array of strings 实例的写内网IP地址。 private_dns_names Array of strings 实例内网 域名 列表。实例创建成功后，需要手动申请内网域名，否则查询内网域名为空。 public_ips String 实例的公网IP地址。 db_user_name String 默认用户名。 vpc_id String 虚拟私有云ID。 subnet_id String 子网的网络ID信息。 security_group_id String 安全组ID。 configuration_id String 实例创建的模板ID，或者应用到实例的最新参数组模板ID。 backup_strategy MysqlBackupStrategy object 自动备份策略。 nodes Array of MysqlInstanceNodeInfo objects 节点信息。 enterprise_project_id String 企业项目ID。 time_zone String 时区。 az_mode String 可用区模式。 取值范围： single：单可用区。 multi：多可用区。 master_az_code String 主可用区。 maintenance_window String 可维护时间窗，为UTC时间。 tags Array of MysqlTags objects 实例标签。 dedicated_resource_id String 专属资源池ID，只有数据库实例属于专属资源池才会返回该参数。 proxies Array of MysqlProxyInfo objects 代理信息。 tde_info MysqlTdeInfo object 透明 数据加密 配置信息，支持AES256、SM4加密算法。 透明加密功能目前处于公测阶段，如需使用，请提交工单联系客服人员申请权限。 表6 MysqlInstanceChargeInfo 参数 参数类型 描述 charge_mode String 计费模式。 order_id String 订单号。仅包年包月返回。 表7 MysqlDatastoreWithKernelVersion 参数 参数类型 描述 type String 数据库引擎，现在只支持gaussdb-mysql。 version String 数据库版本。 kernel_version String 数据库内核版本。 表8 MysqlBackupStrategy 参数 参数类型 描述 start_time String 自动备份开始时间段。自动备份将在该时间一个小时内触发。 取值范围：非空，格式必须为hh:mm-HH:MM且有效，当前时间指UTC时间。 HH取值必须比hh大1。 mm和MM取值必须相同，且取值必须为00。 keep_days String 自动备份保留天数，取值范围：1-732。 表9 MysqlInstanceNodeInfo 参数 参数类型 描述 id String 实例ID，严格匹配UUID规则。 name String 节点名称。 type String 节点类型。 取值范围： master：主节点。 slave：只读节点。 status String 节点状态。 port Integer 数据库端口号。 private_read_ips Array of strings 节点的读内网地址。 volume MysqlInstanceNodeVolumeInfo object 存储盘信息。 az_code String 可用区。 region_code String 实例所在的区域。 created String 创建时间，格式为"yyyy-mm-ddThh:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 updated String 更新时间，格式与"created"字段对应格式完全相同。 flavor_id String 规格ID。 flavor_ref String 规格码。 max_connections String 允许的最大连接数。 vcpus String CPU核数。 ram String 内存大小，单位为GB。 need_restart Boolean 是否需要重启使修改的参数生效。 priority Integer 主备倒换优先级。 表10 MysqlInstanceNodeVolumeInfo 参数 参数类型 描述 type String 磁盘类型。 used String 已使用磁盘大小，单位GB。 size Long 包年/包月实例购买的存储空间大小，单位GB。 表11 MysqlTags 参数 参数类型 描述 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）。 表12 MysqlProxyInfo 参数 参数类型 描述 pool_id String 数据库代理ID。 name String 数据库代理名称。 address String Proxy读写分离地址。 表13 MysqlTdeInfo 参数 参数类型 描述 enable_tde Boolean 是否打开透明加密功能。 encryption_type String 透明加密算法，支持AES256、SM4加密算法。 状态码： 400 表14 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表15 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

URI GET /v3.1/{project_id}/instances/details 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 instance_ids 是 String 实例ID，严格匹配UUID规则。最多同时输入20个实例ID，用英文逗号分隔。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 configuration_id String 参数模板ID。 configuration_name String 参数模板名称。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表5 响应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参数 参数 是否必选 参数类型 描述 min_vcpus 是 Integer 单节点VCPUs伸缩下限，取值范围可根据查询数据库规格接口获取。 max_vcpus 是 Integer 单节点VCPUs伸缩上限，取值范围可根据查询数据库规格接口获取。

URI PUT /v3/{project_id}/instances/{instance_id}/nodes/{node_id}/priority 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的project ID。 获取方法请参见获取项目ID instance_id 是 String 实例ID。 node_id 是 String 节点ID。

请求示例 修改节点故障倒换优先级为2。 PUT https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/61a4ea66210545909d74a05c27a7179ein07//nodes/ss62c18799854a919bab633874c159dfno01/priority { "priority" : 2 }

响应参数 状态码： 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 错误消息。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 Content-Type 是 String 内容类型。 取值：application/json。 X-Language 否 String 语言。 表3 请求Body参数 参数 是否必选 参数类型 描述 priority 是 String 故障倒换优先级。 故障倒换优先级的取值范围为1~16以及-1。取正数时数字越小，优先级越大，即故障倒换时，主节点会优先倒换到优先级高的只读节点上，优先级相同的只读节点选为主节点的概率相同。取-1时表示节点不参与故障倒换，当单可用区实例超过两个只读节点，或者多可用区实例修改后的可用区多于1个时可以设置成-1。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。默认en-us。 取值范围： en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 encryption_status 是 String 开启或关闭加密。不区分大小写。 取值范围： on：开启。 off：关闭。 type 否 String 加密类型。当前只支持kms。 开启加密时必传，关闭加密时不传。 不区分大小写。 kms_key_id 否 String kms加密ID。加密时必传，关闭加密时候不传。 通过调用数据加密服务的创建密钥接口获取（响应参数的key_id即为加密ID）。

请求示例 开启备份加密 POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/7033e7c3cf93438797d44ad7ae0a7d95in07/backups/encryption { "type" : "kms", "kms_key_id" : "b82fa43f-f6e8-4ec4-9c31-231bc547c526", "encryption_status" : "on" } 关闭备份加密 POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/7033e7c3cf93438797d44ad7ae0a7d95in07/backups/encryption { "encryption_status" : "off" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 encryption_status String 备份加密状态。 取值范围： on：开启状态。 off：关闭状态。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表6 响应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 规格ID。可通过“HTAP查询规格信息”接口获取。 仅允许使用对应实例的规格ID。 delay 是 Boolean 是否延迟变更。默认false。 instance_id 否 String 实例ID，严格匹配UUID规则。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 result String 请求结果。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

请求示例 ClickHouse实例规格变更。 POST https://{endpoint}/v3/23a50154cf494ec9ad6883979a12db0a/instances/fb632d1d531a4107804f0f082581810fin07/clickhouse/resize-flavor { "flavor_ref" : "6ebc6add-7462-3c27-b92b-3d79ae37a309", "delay" : false, "instance_id" : "59c6b263cd884178b7395e1ee8d93fbdin16" }

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

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 result String 请求结果。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

请求示例 创建数据库账号。 POST https://{endpoint}/v3/23a50154cf494ec9ad6883979a12db0a/instances/54e42160670e48e789af7075e1efea1fin16/starrocks/users { "user_name" : "user_test", "dml" : 2, "ddl" : 0, "password" : "Rds_1234", "databases" : [ "INFORMATION_SCHEMA", "default" ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。默认en-us。 取值范围： en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 user_name 是 String 数据库账户名。 长度为2-32个字符，必须以小写字母开头，小写字母或数字结尾，可以包含小写字母、数字以及下划线，不能包含其它特殊字符。 password 是 String 账户密码。 8-32个字符 不能与用户名或倒序的用户名相同 至少包含以下字符中的三种：大写字母、小写字母、数字和特殊字符~！@#%^*-_=+?, databases 是 Array of strings 数据库列表。 dml 否 Integer DML权限，默认2。 取值范围： 0：读写权限 1：只读权限 2：只读和设置权限 3：读写和设置权限 ddl 否 Integer DDL权限，默认0。 取值范围： 0：无DDL权限 1：有DDL权限

响应参数 状态码： 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 错误描述。

URI POST /v3/{project_id}/instances/{instance_id}/starrocks/databases/replication/resume 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String StarRocks实例ID，严格匹配UUID规则。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 是 String 请求语言类型。默认en-us。 取值范围： - en-us - zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 task_name 是 String 同步任务名。字符长度限制3~128位，仅支持英文大小写字母、数字以及下划线。

请求示例 POST https://{endpoint}/v3/23a50154cf494ec9ad6883979a12db0a/instances/40dc4c5729f14aad893e2dcd5baf6a15in07/starrocks/resize-flavor { "fe_flavor_id" : "c44cfde6-d250-313c-8d7a-cd216f071658", "be_flavor_id" : "c44cfde6-d250-313c-8d7a-cd216f071670" }

请求参数 表2 请求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 表3 请求Body参数 参数 是否必选 参数类型 描述 fe_flavor_id 否 String FE节点CPU、内存规格ID。填空或者不填视为规格ID与原规格ID保持一致。 be_flavor_id 否 String BE节点CPU、内存规格ID。填空或者不填视为规格ID与原规格ID保持一致。

响应参数 状态码： 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 错误消息。

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

响应示例 状态码： 200 Success. { "total_count" : 3, "replications" : [ { "source_database" : "test", "target_database" : "test", "status" : "abnormal", "stage" : "Full", "percentage" : 0, "catchup_stage" : null }, { "target_database" : "blackwhite_0018_61474479", "status" : "normal", "stage" : "Incremental", "percentage" : 100, "catchup_stage" : null }, { "target_database" : "blackwhite_0017_22525694", "status" : "normal", "stage" : "Wait", "percentage" : 0, "catchup_stage" : null } ], "ext_text" : null }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total_count Integer 查询数据同步任务数。 replications Array of ChDatabaseReplicationInfo objects 数据同步任务信息。 ext_text String taurus操作表示，重启、规格变更、倒换等。 表5 ChDatabaseReplicationInfo 参数 参数类型 描述 source_database String 源数据库。 target_database String 目标数据库。 status String 当前状态。 取值范围： normal：正常 abnormal：异常 stage String 同步阶段。 取值范围： wait：等待同步 failed：同步失败 incremental：增量同步 full：全量同步 other：其他 percentage String 进度百分比。 catchup_stage String 追赶阶段。 取值范围： wait：等待同步 failed：同步失败 incremental：增量同步 full：全量同步 other：其他 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

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

请求示例 设置实例的主节点权重是100。 PUT https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/e73893ef73754465a8bd2e0857bbf13ein07/proxy/e87088f0b6a345e79db19d57c41fde15po01/weight { "master_weight" : 100 }