华为云用户手册

URI GET /v3/{project_id}/instances/{instance_id}/auto-scaling/policy 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认值： 不涉及。 instance_id 是 String 参数解释： 实例ID，此参数是实例的唯一标识。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，后缀为in07，长度为36个字符。 默认取值： 不涉及。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 switch_status String 全量SQL开关状态。 取值： ON：表示开启。 OFF：表示关闭。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

请求示例 修改数据库账户密码。 PUT https://{endpoint}/v3/23a50154cf494ec9ad6883979a12db0a/instances/54e42160670e48e789af7075e1efea1fin16/starrocks/users/password { "user_name" : "user_test", "password" : "Tang_1234" }

请求参数 表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 数据库账号名。 password 是 String 账户密码。 8-32个字符 不能与用户名或倒序的用户名相同 至少包含以下字符中的三种：大写字母、小写字母、数字和特殊字符~！@#%^*-_=+?,

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

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

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

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total_count Integer 总记录数。 tags Array of ResourceTagItem objects 标签列表。 表5 ResourceTagItem 参数 参数类型 描述 key String 标签键。 value String 标签值。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 db_parameters Array of ChDatabaseParameterInfo objects 库参数信息。 表4 ChDatabaseParameterInfo 参数 参数类型 描述 param_name String 参数名称。 data_type String 参数类型。 default_value String 参数默认值。 value_range String 参数取值范围。 description String 参数描述。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

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

响应示例 状态码： 200 Success. { "db_parameters" : [ { "param_name" : "default_isolation_level", "data_type" : "String", "default_value" : "QUERY_SNAPSHOT", "value_range" : "READ_COMMITTED|READ_UNCOMMITTED|QUERY_RAW|QUERY_SNAPSHOT", "description" : "默认隔离级别，仅对MaterializeMySQL 引擎有效,可以是“read_uncommitted”，这意味着没有 MVCC 支持，“read_committed”，它保留查询（包括子查询）中的事务完整性，或“query_snapshot”，它保留事务完整性并以牺牲数据新鲜度为代价删除重复和删除的行。" }, { "param_name" : "enable_snapshots", "data_type" : "String", "default_value" : "true", "value_range" : "true|false", "description" : "创建快照以支持mvcc_isolation_level='query_snapshot'" }, { "param_name" : "enable_chunk_level", "data_type" : "String", "default_value" : "true", "value_range" : "true|false", "description" : "支持chunk级别的并行复制，复制会更快" }, { "param_name" : "max_sync_threads", "data_type" : "Integer", "default_value" : "1", "value_range" : "1-2", "description" : "全量复制最大线程数" }, { "param_name" : "treat_numeric_string_as_integer", "data_type" : "String", "default_value" : "false", "value_range" : "true|false", "description" : "允许在全量同步期间块级任务生成中将数字字符串视为整数" }, { "param_name" : "min_binlog_expire_logs_seconds", "data_type" : "Integer", "default_value" : "86400", "value_range" : "0-2592000", "description" : "允许binlog保存的最小时长，如果binlog保存的时间小于该阈值，同步会报失败。0表示不做限制。" }, { "param_name" : "max_rows_in_buffer", "data_type" : "Integer", "default_value" : "2000000", "value_range" : "1-10000000", "description" : "内存中允许缓存数据的最大行数（对于单表和无法查询的缓存数据而言）。当行数超过时，数据将被物化" }, { "param_name" : "max_rows_in_buffers", "data_type" : "Integer", "default_value" : "6000000", "value_range" : "1-10000000", "description" : "内存中允许缓存的最大行数（用于数据库和无法查询的缓存数据而言）。当行数超过时，数据将被物化" }, { "param_name" : "max_bytes_in_buffer", "data_type" : "Integer", "default_value" : "200000000", "value_range" : "1-1000000000", "description" : "数据在内存中允许缓存的最大字节数（对于单表和无法查询的缓存数据）。当字节数超过时，数据将被物化" }, { "param_name" : "max_bytes_in_buffers", "data_type" : "Integer", "default_value" : "600000000", "value_range" : "1-1000000000", "description" : "数据在内存中允许缓存的最大字节数（对于数据库和无法查询的缓存数据）。当字节数超过时，数据将被物化" }, { "param_name" : "max_flush_data_time", "data_type" : "Integer", "default_value" : "5000", "value_range" : "1-10000", "description" : "允许数据缓存在内存中的最大时长(毫秒)" } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 differences Array of ParamGroupParameterDifferences objects 老本版参数之间区别的集合。 表5 ParamGroupParameterDifferences 参数 参数类型 描述 parameter_name String 参数名称。 source_value String 源参数模板中的参数值。 target_value String 目标参数模板中的参数值。 状态码： 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。 X-Language 否 String 请求语言类型。默认en-us。 取值范围： en-us zh-cn Content-Type 是 String 内容类型。 取值：application/json。 表3 请求Body参数 参数 是否必选 参数类型 描述 source_configuration_id 是 String 需要进行比较的源参数模板ID。通过ListStarrocksInstanceInfo接口获得。

响应示例 状态码： 200 Success. { "can_enable_public_access" : true, "id" : "45a0ed37-cfa7-4403-8aeb-d720b4e831cf", "type" : "5_bgp", "port_id" : "2c02dc5b-a136-4921-b7ad-27e084548616", "public_ip_address" : "10.83.35.151", "private_ip_address" : "172.16.1.137", "status" : "ACTIVE", "tenant_id" : "23a50154cf494ec9ad6883979a12db0a", "create_time" : "2024-04-09 13:42:11", "bandwidth_id" : "2a4b2bc5-2a0a-42df-8f13-2fbe3d8bbbb2", "bandwidth_name" : "bandwidth-d3f4", "bandwidth_size" : 1, "bandwidth_share_type" : "PER", "profile" : { } }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 can_enable_public_access Boolean 是否能访问公网 id String 弹性公网ID。 type String 弹性公网IP的网络类型。 port_id String 端口ID。 public_ip_address String 弹性公网IP地址。 private_ip_address String 私网IP地址。 status String 弹性公网IP状态。 tenant_id String 租户ID。 create_time String 创建时间。 bandwidth_id String 带宽ID。 bandwidth_name String 带宽名称。 bandwidth_size String 带宽大小。 bandwidth_share_type String 带宽类型。枚举值：PER 和WHOLE。 profile Object 额外参数，包括订单id、产品id等信息。如果profile不为空，说明是包周期的弹性公网IP。 状态码： 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 语言。

响应参数 状态码： 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参数 参数 是否必选 参数类型 描述 delay 否 Boolean 实例是否延迟升级，默认false，立即升级。 取值范围： true: 延迟升级，实例将在运维时间窗内自动升级。 false: 立即升级。

响应示例 状态码： 200 Success. { "instances" : [ { "id" : "61a4ea66210545909d74a05c27a7179ein07", "status" : "ACTIVE", "name" : "gaussdb-mysql-instance01", "private_ips" : [ "192.168.0.142" ], "readonly_private_ips" : [ "192.168.0.228", "192.168.0.165" ], "proxy_ips" : [ "192.168.0.15" ], "port" : 3306, "type" : "Cluster", "db_user_name" : "root", "region" : "cn-north-4", "datastore" : { "type" : "gaussdb-mysql", "version" : "8.0", "kernel_version" : "2.0.29.1" }, "created" : "2018-08-20T02:33:49_0800", "updated" : "2018-08-20T02:33:49_0800", "volume" : { "type" : "POOL", "size" : 100 }, "vpc_id" : "3cedfc54-b105-4652-a4e0-847b11576b58", "subnet_id" : "c1cfa53c-65d3-431e-8552-326bf310c7ad", "security_group_id" : "fc577a1a-f202-424a-977f-24faec3fdd55", "flavor_ref" : "gaussdb.mysql.c3.small.4", "flavor_info" : { "vcpus" : 8, "ram" : 16 }, "backup_strategy" : { "start_time" : "19:00-20:00", "keep_days" : 7 }, "charge_info" : { "charge_mode" : "postPaid" }, "enterprise_project_id" : 0, "time_zone" : "UTC", "tags" : [ { "key" : "taurusKey1", "value" : "value1" } ]， "dedicated_resource_id" : "" } ]， "total_count" : 1 }

请求示例 查询TaurusDB实例列表，读写内网IP地址是192.168.0.142。 GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances?id=61a4ea66210545909d74a05c27a7179ein07&name=gaussdb-mysql-instance01&type=Cluster&datastore_type=gaussdb-mysql&vpc_id=3cedfc54-b105-4652-a4e0-847b11576b58&subnet_id=c1cfa53c-65d3-431e-8552-326bf310c7ad&private_ip=192.168.0.142&offset=0&limit=10&tags=taurusKey1=value1

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 instances Array of MysqlInstanceListInfo objects 实例列表信息。 total_count Integer 总记录数。 表5 MysqlInstanceListInfo 参数 参数类型 描述 id String 实例ID，严格匹配UUID规则。 name String 创建的实例名称。 status String 实例状态。 取值： BUILD：表示实例正在创建。 ACTIVE：表示实例正常。 FAILED：表示实例创建失败。 FROZEN：表示实例冻结。 MODIFYING：表示实例正在扩容。 REBOOTING：表示实例正在重启。 RESTORING：表示实例正在恢复。 SWITCHOVER：表示实例正在主备切换。 MIGRATING：表示实例正在迁移。 BACKING UP：表示实例正在进行备份。 MODIFYING DATABASE PORT：表示实例正在修改数据库端口。 STORAGE FULL：表示实例磁盘空间满。 private_ips Array of strings 实例写内网IP地址列表。弹性云服务器创建成功后该值存在，其他情况下为空字列表。 proxy_ips Array of strings 实例读写分离IP地址列表。TaurusDB实例开启代理成功后该值存在，其他情况下为空列表。 readonly_private_ips Array of strings 实例读内网IP地址列表。弹性云服务器创建成功后该值存在，其他情况下为空列表。 public_ips Array of strings 实例外网IP地址列表。 port String 数据库端口号。 type String 实例类型，取值为“Cluster”。 region String 实例所在区域。 datastore MysqlDatastoreWithKernelVersion object 数据库信息。 created String 创建时间，格式为"yyyy-mm-ddThh:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 updated String 更新时间，格式与"created"字段对应格式完全相同。 db_user_name String 默认用户名。 vpc_id String 虚拟私有云ID。 subnet_id String 子网的网络ID信息。 security_group_id String 安全组ID。 flavor_ref String 规格码。 flavor_info MysqlFlavorInfo object flavor规格信息。 volume MysqlVolumeInfo object 存储盘信息。 backup_strategy MysqlBackupStrategy object 自动备份策略。 enterprise_project_id String 企业项目ID。 time_zone String 时区。 charge_info MysqlChargeInfo object 计费类型信息，支持包年包月和按需，默认为按需。 dedicated_resource_id String 专属资源池ID，只有数据库实例属于专属资源池才会返回该参数。 tags Array of InstanceTagItem objects 标签列表。 表6 MysqlDatastoreWithKernelVersion 参数 参数类型 描述 type String 数据库引擎，现在只支持gaussdb-mysql。 version String 数据库版本。 kernel_version String 数据库内核版本。 表7 MysqlFlavorInfo 参数 参数类型 描述 vcpus String CPU核数。 ram String 内存大小，单位GB。 表8 MysqlVolumeInfo 参数 参数类型 描述 type String 磁盘类型。 size String 已使用磁盘大小，单位GB。 表9 MysqlBackupStrategy 参数 参数类型 描述 start_time String 自动备份开始时间段。自动备份将在该时间一个小时内触发。 取值范围：非空，格式必须为hh:mm-HH:MM且有效，当前时间指UTC时间。 HH取值必须比hh大1。 mm和MM取值必须相同，且取值必须为00。 keep_days String 自动备份保留天数，取值范围：1-732。 表10 MysqlChargeInfo 参数 参数类型 描述 charge_mode String 计费模式。 取值范围： prePaid：预付费，即包年/包月。 postPaid：后付费，即按需付费。 枚举值： prePaid postPaid period_type String 订购周期类型。 取值范围： month：包月。 year：包年。 说明：“charge_mode”为“prePaid”时生效，且为必选值。 枚举值： month year period_num Integer “charge_mode”为“prePaid”时生效，且为必选值，指定订购的时间。 取值范围： “period_type”为“month”时，取值为1~9。 “period_type”为“year”时，取值为1~3。 is_auto_renew String 创建包年/包月实例时可指定，表示是否自动续订，续订的周期和原周期相同，且续订时会自动支付。 true：为自动续订。 false：为不自动续订，默认该方式。 is_auto_pay String 创建包年/包月实例时可指定，表示是否自动从客户的帐户中支付，此字段不影响自动续订的支付方式。 true：为自动支付，默认该方式。 false：为手动支付。 表11 InstanceTagItem 参数 参数类型 描述 key String 标签键。 value String 标签值。 状态码： 400 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

URI GET /v3/{project_id}/instances 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 id 否 String 实例ID。“*”为系统保留字符，如果id是以“*”起始，表示按照“*”后面的值模糊匹配，否则，按照id精确匹配查询。不能只传入“*”。 name 否 String 实例名称。 “*”为系统保留字符，如果name是以“*”起始，表示按照“*”后面的值模糊匹配，否则，按照name精确匹配查询。不能只传入“*”。 type 否 String 按照实例类型查询。目前仅支持Cluster。 datastore_type 否 String 数据库类型，现在只支持gaussdb-mysql。 vpc_id 否 String 虚拟私有云ID。 subnet_id 否 String 子网的网络ID信息。 private_ip 否 String 读写内网IP地址。 readonly_private_ip 否 String 读内网IP地址。 proxy_ip 否 String 读写分离IP地址。 offset 否 Integer 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 limit 否 Integer 查询记录数。默认为100，不能为负数，最小值为1，最大值为100。 tags 否 String 根据实例标签键值对进行查询。 {key}表示标签键。 {value}表示标签值。 如果同时使用多个标签键值对进行查询，中间使用逗号分隔开，表示查询同时包含指定标签键值对的实例。key不能重复，key之间是与的关系。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。默认en-us。 取值范围： en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 delay 否 Boolean 实例节点是否延迟重启。默认false，立即重启。 true: 延迟重启，实例节点将在运维时间窗内自动重启。 false: 立即重启。

响应参数 状态码： 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}/nodes/{node_id}/restart 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String 实例ID，严格匹配UUID规则。 node_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 错误消息。

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值。 X-Language 否 String 请求语言类型。默认en-us。 取值范围： en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 ssl_option 是 Boolean SSL 数据加密 开关设置。 取值范围： true: 开启SSL数据加密。 false: 关闭SSL数据加密。

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