华为云用户手册

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，用英文逗号分隔。

请求参数 表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位，仅支持英文大小写字母、数字以及下划线。

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规则。

响应参数 状态码： 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}/proxy/{proxy_id}/restart 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的project ID。 获取方法请参见获取项目ID instance_id 是 String 实例ID。 proxy_id 是 String 数据库代理ID。

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

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

响应参数 状态码： 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值。 X-Language 否 String 请求语言类型。默认en-us。 取值范围： en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 size_in_gb 是 Integer 磁盘容量。取值范围：50GB~32000GB。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 source_instance_id String TaurusDB实例ID。 source_node_id String TaurusDB节点ID。 database_info DataBaseInfo object TaurusDB数据库配置信息。 table_infos Array of TableConfigCheckResult objects 表配置信息。 table_repl_config TableReplConfig object 表同步配置信息。 new_table_repl_config TableReplConfig object 更新的表同步配置信息。 target_database_name String 目标数据库名。字符长度限制3~128位，仅支持英文大小写字母、数字以及下划线。 is_tables_change Boolean 同步任务表是否变化。 last_error_of_alter_table String 最近一次alter table的异常信息。 表5 DataBaseInfo 参数 参数类型 描述 database_name String 数据库名称。 db_config_check_results Array of DbConfigCheckResult objects 数据库配置检查结果。 表6 DbConfigCheckResult 参数 参数类型 描述 param_name String 参数名，字符长度限制3~128位。 value String 参数值，字符长度限制1~64位。 check_result String 校验结果。 可选范围 success fail 表7 TableConfigCheckResult 参数 参数类型 描述 table_name String 表名 table_config String 表配置项 check_result String 校验结果，success/failed 表8 TableReplConfig 参数 参数类型 描述 repl_type String 表同步类型。include_tables：白名单，exclude_tables：黑名单。 repl_scope String 表同步范围。all：全量同步，part：部分同步。 tables Array of strings 白名单或黑名单的表范围。 状态码： 400 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

响应示例 状态码： 200 Success. { "source_instance_id" : "source_instance_id", "target_database_name" : "target_database_name", "source_node_id" : "source_node_id", "database_info" : { "database_name" : "database_name", "db_config_check_results" : [ { "param_name" : "default_isolation_level", "value" : "QUERY_SNAPSHOT", "check_result" : "success" }, { "param_name" : "enable_snapshots", "value" : "true", "check_result" : "failed" } ] }, "table_infos" : [ ], "table_repl_config" : { "repl_type" : "exclude_tables", "repl_scope" : "all", "tables" : [ ] }, "new_table_repl_config" : { }, "is_tables_change" : false, "last_error_of_alter_table" : ""} 状态码： 400 Client error. { "error_code" : "DBS.200022", "error_msg" : "实例不存在"}

URI GET /v3/{project_id}/instances/{instance_id}/starrocks/databases/replication/configuration 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String StarRocks实例ID，严格匹配UUID规则。 表2 Query参数 参数 是否必选 参数类型 描述 task_name 是 String 数据同步任务名。 字符长度限制3~128位，仅支持英文大小写字母、数字以及下划线。

响应示例 状态码： 200 Success. { "slow_log_list" : [ { "node_id" : "941d21130b3c4899ad1a752a0945befdno07", "time" : "0.000143s", "rows_sent" : "10", "rows_examined" : "50", "database" : "user_center", "users" : "admin", "query_sample" : "sleep (N);", "type" : "1700755200000", "client_ip" : "10.1.1.60", "start_time" : "2023-08-28T08:22:13.591394+08:00", "line_num" : "1669344916000" } ]}

请求示例 获取内核慢日志信息。 POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/86fd60a5256a4592b957e8e6bb2d1b59in07/clickhouse/slow-logs{ "node_id" : "aeb9e81135b34197bab8636fc8a1c569no16", "start_time" : "2023-12-12T00:14:27+0100", "end_time" : "2023-12-12T02:14:27+0100", "limit" : "10", "line_num" : "1669344916000", "operate_type" : "All", "database" : "DBS_NODE"}

URI POST /v3/{project_id}/instances/{instance_id}/clickhouse/slow-logs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String ClickHouse实例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参数 参数 是否必选 参数类型 描述 node_id 是 String 实例节点ID。 start_time 是 String 开始时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 end_time 是 String 开始时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 limit 是 Integer 查询记录数。 line_num 否 String 日志单行序列号，第一次查询时不需要此参数，后续分页查询时需要使用，可从上次查询的返回信息中获取。 operate_type 否 String 慢日志操作类型。 database 否 String 数据库名。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 slow_log_list Array of slow_log_list objects 慢日志列表。 表5 slow_log_list 参数 参数类型 描述 node_id String ClickHouse实例节点ID。 time String 数据库语句执行时间。 lock_time String 数据库语句等待锁时间。 rows_sent Integer 数据库语句执行结果行数。 rows_examined Integer 数据库语句扫描行数。 database String 所属数据库名。 users String 执行语句账号。 query_sample String 数据库执行语句。 type String 数据库语句类型。 client_ip String IP地址。 start_time String 数据库语句发生时间。 line_num String 日志单行序列号，第一次查询时不需要此参数，后续分页查询时需要使用，可从上次查询的返回信息中获取。 count String 慢日志数量。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

响应示例 状态码： 200 Success. { "user_details" : [ { "user_name" : "root", "databases" : [ "*" ], "dml" : 2, "ddl" : 0 }, { "user_name" : "user_test1", "databases" : [ "*" ], "dml" : 2, "ddl" : 0 } ], "total_count" : 2}

URI GET /v3/{project_id}/instances/{instance_id}/clickhouse/users 表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条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 user_name 否 String 数据库账户。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 user_details Array of user_details objects 数据库账户信息。 total_count Integer 数据库账户数量。 表5 user_details 参数 参数类型 描述 user_name String 数据库账户名。 databases Array of strings 已授权数据库。 dml Integer DML权限。 取值范围： 1：只读权限 2：读取和设置权限 ddl Integer DDL授权。 取值范围： 0：无DDL权限 1：有DDL权限 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 id String 专属资源池ID。 resource_name String 专属资源池名称。 engine_name String 数据库引擎名称。 availability_zone_ids Array of strings 可用区。 architecture String 资源规格类型。 status String 专属资源池状态。 dedicated_compute_info DedicatedComputeInfo object 计算资源信息。 dedicated_storage_info DedicatedStorageInfo object 存储资源信息。 表4 DedicatedComputeInfo 参数 参数类型 描述 vcpus_total Integer 专属资源池中CPU总数。 vcpus_used Integer 专属资源池已使用的CPU数。 ram_total Integer 专属资源池计算内存大小, 单位GB。 ram_used Integer 专属资源池已使用的计算内存大小，单位GB。 spec_code String 专属资源池计算资源规格码。 host_num Integer 专属资源池计算主机数量。 表5 DedicatedStorageInfo 参数 参数类型 描述 spec_code String 专属资源池存储资源规格码。 host_num Integer 专属资源池存储主机数量。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

响应示例 状态码： 200 Success. { "id" : "e289fda5-a065-4324-8751-cff68be6f48e", "resource_name" : "test_dcc", "engine_name" : "gaussdb-mysql", "availability_zone_ids" : [ "az1xahz", "az2xahz" ], "architecture" : "ARM", "status" : "normal", "dedicated_compute_info" : { "vcpus_total" : 128, "vcpus_used" : 64, "ram_total" : 512, "ram_used" : 256, "spec_code" : "gaussdb.mysql.c6.host", "host_num" : 1 }, "dedicated_storage_info" : { "spec_code" : "gaussdb.mysql.dfvpool.30tb.host", "host_num" : 1 }}

URI GET /v3/{project_id}/dedicated-resource/{dedicated_resource_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 dedicated_resource_id 是 String 专属资源池ID。 获取方法参见查询专属资源信息详情。

响应示例 状态码： 200 Success. { "quota_list" : [ { "enterprise_project_id" : "0", "enterprise_project_name" : "default", "instance_quota" : 20, "vcpus_quota" : 20, "ram_quota" : 40, "availability_instance_quota" : 1, "availability_vcpus_quota" : 4, "availability_ram_quota" : 8 } ]}

请求参数 表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

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 quota_list Array of quota objects 资源列表对象。 total_count Integer 配额记录的条数。 表5 quota 参数 参数类型 描述 enterprise_project_id String 企业项目ID。 enterprise_project_name String 企业项目名称。 instance_quota Integer 实例个数配额。 vcpus_quota Integer CPU核数配额。 ram_quota Integer 内存使用配额，单位为GB。 availability_instance_quota Integer 实例剩余配额。 availability_vcpus_quota Integer CPU核数剩余配额。 availability_ram_quota Integer 内存剩余配额。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

URI GET /mysql/v3/{project_id}/quotas 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 String 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 取值范围：0 - 10000 limit 否 String 查询记录数。默认为10，不能为负数，最小值为1，最大值为100。 enterprise_project_name 否 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参数 参数 是否必选 参数类型 描述 public_ip 是 String 待绑定的弹性公网IP地址。 public_ip_id 是 String 弹性公网IP地址对应的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 错误消息。

请求示例 为实例绑定弹性公网IP地址。 PUT https://{endpoint}/v3/056538411200d4cd2f79c003c7606412/instances/096c0fc43e804757b59946b80dc27f8bin07/public-ips/bind{ "public_ip" : "10.145.51.214", "public_ip_id" : "8403e9cd-a7fa-4288-8b15-c7ceac1etest"}