华为云用户手册

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

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

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

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 job_id String 任务ID。 order_id 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值。 X-Language 否 String 请求语言类型。默认en-us。 取值范围： en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 databases 是 Array of strings 准备删除的数据库列表，列表最大长度为50。

响应参数 状态码： 202 表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参数 参数 参数类型 描述 job_id String 任务ID。 order_id String 订单号，仅包年/包月返回该参数。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

请求示例 退订指定的包年/包月实例。 DELETE https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/096c0fc43e804757b59946b80dc27f8bin07 删除指定按需实例。 DELETE https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/7f5bed98332e493a8a2d213c233ff556in07

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

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

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

请求示例 开启数据库代理，规格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"}

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 Content-Type 是 String 内容类型。 取值：application/json。 X-Language 否 String 语言。 表3 请求Body参数 参数 是否必选 参数类型 描述 log_configs 是 Array of InstanceSaveLtsConfig objects 日志配置列表。 表4 InstanceSaveLtsConfig 参数 是否必选 参数类型 描述 instance_id 是 String 实例ID。 log_type 是 String 日志类型。 lts_group_id 是 String 日志组ID。 lts_stream_id 是 String 日志流ID。

请求示例 批量创建LTS日志配置 POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/logs/lts-configs{ "log_configs" : [ { "instance_id" : "61a4ea66210545909d74a05c27a7179ein07", "log_type" : "error_log", "lts_group_id" : "c3dd5233-24a1-443c-6b40-310b3ad85382", "lts_stream_id" : "9b476e31-b745-4e76-8d78-2081168651f7" } ]}

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

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

请求示例 POST https://{localhost}/v3/{project_id}/instances/{instance_id}/starrocks/databases/replication{ "source_instance_id" : "source_instance_id", "source_node_id" : "source_node_id", "source_database" : "source_database", "target_database" : "target_database", "task_name" : "task_name"}

URI POST /v3/{project_id}/instances/{instance_id}/starrocks/databases/replication 表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参数 参数 是否必选 参数类型 描述 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权限

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

响应参数 状态码： 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/619d3e78f61b4be68bc5aa0b59edcf7b/instances/61a4ea66210545909d74a05c27a7179ein07/proxy/enlarge{ "node_num" : 2, "proxy_id" : "151c14381ac14ecfb9703a745b992677po01"}

请求参数 表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_num 是 Integer 数据库代理节点扩容操作需要扩容的节点数。 扩容的节点数的取值范围：1~14之间的整数。 限制条件：该实例的数据库代理节点的总数量小于等于16。 proxy_id 否 String 数据库代理ID。 如果实例只开启了一个代理，可不传该参数；如果实例开启了多个代理，则必须指定一个数据库代理，扩容新的代理节点。

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

错误码 当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 500 DBS.05000000 server error. 服务器错误。 请联系客服进行处理。 400 DBS.05000001 The kernel version is too early. 内核版本过低，不支持创建数据库代理。 内核版本过低，请进行内核版本升级。 400 DBS.05000006 The username and password must be different. 用户名和密码不能相同。 请使用强度更高的密码。 400 DBS.05000007 The password cannot be the username spelled backwards. 密码不能是用户名的倒序。 请使用强度更高的密码。 400 DBS.05000008 The current version is the latest. No update is available. 当前实例源版本与目标版本相同，不需要升级。 请选择比原版本更高的版本。 400 DBS.05000009 The truncate_lsn value exceeds the threshold.Change the value during off-peak hours or contact technical support. truncate_lsn超过阈值，请在业务低峰期进行变更，或者联系技术人员处理后变更。 truncate_lsn超过阈值，请在业务低峰期进行变更，或者联系技术人员处理后变更。 400 DBS.05000010 The write priority of proxy nodes must be unique. 数据库代理下的写优先级不能重复，请重新设置。 数据库代理下的写优先级不能重复，请重新设置。 400 DBS.05000011 The value must be a positive integer and less than the number of primary nodes. 写优先级取值为正整数，且小于实例的主节点数量，请重新设置。 写优先级取值为正整数，且小于实例的主节点数量，请重新设置。 400 DBS.05000012 Please contact Huawei cloud customer service to upgrade. 请联系华为云客服进行升级。 请联系客服进行升级。 400 DBS.05000014 Dedicated edition cannot be changed to general-purpose edition. 实例规格不允许从独享型变更到通用型。 实例规格不允许从独享型变更到通用型。 400 DBS.05000015 General-purpose edition is not supported. 当前租户不支持通用型规格。 当前租户不支持通用型规格。 400 DBS.05000018 Request parameter list is empty. 请求参数列表为空。 请求参数列表为空，请检查参数列表。 400 DBS.05000019 DBA Assistant is not supported. 不支持智能DBA。 不支持智能DBA，请联系客服开通。 400 DBS.05000020 No more ip addresses are available, need ${ipNumNeed} ,left ${ipNumLeft}. 子网内IP不足，需要IP${ipNumNeed}个,剩余IP${ipNumLeft}个。 请更换子网创建实例。 400 DBS.05000021 dnsName has already exist. 内网 域名 已存在。 请更换内网域名。 400 DBS.05000022 InstanceId do not match proxy. 实例与数据库代理不匹配。 请更换数据库代理。 400 DBS.05000023 The operation not supported. Contact the administrator please. 不支持该操作，请联系客服人员。 不支持该操作，请联系客服人员处理。 400 DBS.05000024 This operation cannot be performed because there are large transactions in the database. 数据库中存在大事务，不能进行操作。 数据库中存在大事务，不能进行操作。 400 DBS.05000025 Failed to lock the resource package. 资源包加锁失败。 资源包加锁失败，请联系客服人员处理。 400 DBS.05000026 Resource package already exists. 资源包已存在。 资源包已存在，请联系客服人员处理。 400 DBS.05000027 If read replicas can be automatically added or deleted during the auto scaling policy, you cannot create or delete proxy instances. 开启自动变配的增删只读功能后，不允许开关数据库代理。 开启自动变配的增删只读功能后，不允许开关数据库代理。 400 DBS.05000028 You do not have operation permissions ${agencyName}. Check account permissions on IAM. 当前用户没有操作权限 ${agencyName}，请通过IAM检查账户权限。 当前用户没有操作权限，请通过IAM检查账户权限。 400 DBS.05000029 Encrypted backup and cross-region backup cannot be both enabled. 备份加密实例不支持打开跨区域备份。 备份加密实例不支持打开跨区域备份，请先关系备份加密功能。 400 DBS.05000030 Encrypted backup and cross-region backup cannot be both enabled. 存在跨区域备份实例不支持打开备份加密。 存在跨区域备份实例不支持打开备份加密，请先关闭跨区备份功能。 400 DBS.05000031 The current KMS algorithm does not support encrypted backup. kms密钥算法不支持备份加密。 当前kms密钥算法不支持备份加密，请选择SM4或AES算法的密钥。 400 DBS.05000032 Proxy not support this port. 数据库代理不支持该端口号, 请参考官方文档填写正确的端口号。 数据库代理不支持该端口号, 请参考官方文档填写正确的端口号。 400 DBS.05000033 Proxy dns duplicate, please reset it. 数据库代理地址域名重复，请重新设置。 需要重新设置代理地址（即读写分离地址）域名。 400 DBS.05000034 The kernel version of the new instance must be later than or equal to original instance, please reset it. 新实例内核版本应该大于等于原实例内核版本，请重新设置。 请选择更高的内核版本 400 DBS.05000035 Specifying complete kernel version is not supported, please reset it. 不支持指定4位内核版本，请重新设置。 请联系客服开启对应的白名单。 400 DBS.05000036 Invalid records. Enter a valid value. 无效的查询记录数，请按照取值范围重新输入。 无效的查询记录数，请按照取值范围重新输入。 400 DBS.05000037 Invalid database charset. Enter a valid charset from [${charsets}]. 无效的数据库字符集，请按照[${charsets}]取值范围重新输入。 根据提示信息修改为正确的字符集。 400 DBS.05000038 The tag is not compliant. The tag must comply with the corresponding tag policy. 标签不合规。标签应该符合对应的标签策略。 请联系客服进行处理。 400 DBS.05000042 Invalid databases. Enter a valid value. 无效的数据库表，请重新输入。 请核对数据库表名是否正确。 400 DBS.05000043 Invalid last_table_info. Enter a valid value. 无效的最终库表，请重新输入。 请核对最终库表是否正确。 400 DBS.05000044 Param error: [${parameter}]. 参数错误: [${parameter}]。 请根据错误描述输入正确的参数。 400 DBS.05000045 Some databases name are repeated. 备份的数据库重复。 请检查备份的数据库是否重复。 400 DBS.05000046 Some tables name are repeated. 备份的数据库表重复。 请检查备份的数据库表是否重复。 400 DBS.05000047 Some databases name are not exists. 源数据库不存在。 请检查源数据库是否正确。 400 DBS.05000048 Some tables name are not exists. 源数据库表不存在。 请检查源数据库表是否正确。 400 DBS.05000049 Binlog meta data is not exist. Binlog日志元数据不存在。 请联系客服进行处理。 400 DBS.05000058 The non-extended-use specifications cannot be changed to extended-use specifications or the other way around. 实例规格不允许增程型与非增程型互相变更。 请选择正确的规格进行变更。 400 DBS.05000062 Kernel parameter [${parameter}] must be [${paraValue}]. 内核参数[${parameter}]必须为[${paraValue}]。 请根据错误描述修改参数值。 400 DBS.05000068 Not support open TDE function. 不支持打开TDE。 请联系客服打开对应的白名单。 400 DBS.05000069 The current kernel version does not support the TDE function. 当前内核版本不支持打开TDE。 请选择支持打开TDE的内核版本。 400 DBS.05000070 Invalid TDE encryption type. Only SM4 or AES256 is supported. TDE加密类型无效，仅支持SM4或AES256。 请选择支持的TDE加密类型。 400 DBS.05000071 Failed to update the TDE information. 更新TDE信息失败。 请联系客服进行处理。 400 DBS.05000072 The current user is in the blacklist. They have no permissions to create DB instances. 当前用户在黑名单中，无权限创建实例。 请联系客服进行处理。 400 DBS.05000073 The TDE instance cannot change to a kernel version that does not support TDE. TDE实例无法变更到不支持TDE的内核版本。 请选择支持TDE的内核版本。 400 DBS.05000074 You cannot specify AZs for read replicas. 不支持指定可用区创建只读节点。 请联系客服打开对应的白名单。 400 DBS.05000076 Invalid proxy name. 无效的Proxy名称。 请选择有效的代理名称。 400 DBS.05000077 Node deletion failed. Delete residual data on the node first. 操作节点存在数据库尚未清理，不允许删除。 请清理数据库后再删除对应的节点。 400 DBS.05000078 New node weight is null. Please input it. 新增节点权重为空，请输入。 新增节点时，请输入对应的权重。 400 DBS.05000079 Failed to verify the database synchronization configuration. Please check: [${parameter}]. 库同步配置校验失败，请检查： [${parameter}]。 请根据错误描述，检查报错参数。 400 DBS.05000080 Failed to verify the table synchronization configuration. Please check: [${parameter}]. 表同步配置校验失败，请检查： [${parameter}]。 请根据错误描述，检查报错参数。 400 DBS.05000081 Too many nodes. 节点个数超过最大配额。 请选择低于最大配额的节点个数。 400 DBS.05000084 Read replicas are being created. 创建只读节点过程中不允许关闭自动变配策略。 等只读节点创建完毕，再关闭自动变配策略。 400 DBS.05000085 The availability zone mode is not supported: [${parameter}]. 不支持该可用区类型： [${parameter}]。 请根据错误描述，检查报错参数。 400 DBS.05000086 Invalid AZ: [${parameter}]. 可用区取值非法： [${parameter}]。 请根据错误描述，检查报错参数。 400 DBS.05000087 Invalid dedicated resource id: [${parameter}]. 专属资源ID非法： [${parameter}]。 请根据错误描述，检查报错参数。 400 DBS.05000088 Invalid backup time: [${parameter}]. 备份时间非法： [${parameter}]。 请根据错误描述，检查报错参数。 400 DBS.05000089 Invalid node quantity: [${parameter}]. 节点数量非法： [${parameter}]。 请根据错误描述，检查报错参数。 400 DBS.05000090 Invalid security group: [${parameter}]. 安全组非法： [${parameter}]。 请根据错误描述，检查报错参数。 400 DBS.05000091 Unsupported operation: [${parameter}]. 不支持该操作： [${parameter}]。 请根据错误描述，检查报错参数。 400 DBS.05000092 General volume is not supported. 当前租户不支持通用存储规格。 请联系客服打开对应的白名单。 400 DBS.05000093 Readonly proxy with balance route not support route to master. 只读模式数据库代理开启负载均衡时不支持路由到主。 请联系客服进行处理。 400 DBS.05000094 The cv_lsn value exceeds the threshold.Change the value during off-peak hours or contact technical support. cv_lsn超过阈值，请在业务低峰期进行变更，或者联系技术人员处理后变更。 请联系客服进行处理。 400 DBS.05000095 This operation cannot be performed because there are long transactions in the database. 数据库中存在长事务，不能进行操作。 请联系客服进行处理。 400 DBS.05000096 CPU usage is too high or tables number exceeds the upper limit not support re-diagnose. CPU过高或者表数量超过限制值时不支持下发重新诊断。 请联系客服进行处理。 409 DBS.05000097 The same account name and host IP already exist. 已存在相同的账号名称和主机IP。 请选择不同的账号名称或者主机IP。 400 DBS.05000098 The current kernel version does not support level-1 backups. 当前内核版本不支持打开一级备份。 请选择合适的内核版本。 400 DBS.05000099 The flavor of arm standard don't support to resize. 标准版规格不支持规格变更。 请选择正确的规格码进行规格变更。 400 DBS.05000100 The failover priority cannot be set to 1 because the specifications of this node are different from those of the primary node. 该节点与主节点规格不一致，不允许设定故障倒换优先级为1。 请设置为其他故障倒换优先级。 400 DBS.05000101 A manual switchover can be performed only for nodes with the failover priority set to 1. 仅可手动倒换到优先级为1的节点。 手动倒换时只支持倒换到优先级为1的节点。 400 DBS.05000102 A node with failover priority set to 1 is required. 必须存在一个倒换优先级为1的节点。 修改故障倒换优先级需要确保至少存在一个倒换优先级为1的节点。 400 DBS.05000103 Specifications of yearly/monthly instances cannot be upgraded and downgraded at the same time. 不支持包周期资源同时升配和降配。 请联系客服进行处理。 400 DBS.200001 Parameter error. 参数错误。 检查传入的参数或URL是否全部正确。 400 DBS.200004 Parameter error. 参数错误。 检查传入的参数或URL是否全部正确。 400 DBS.200006 The request is null. Enter a request parameter. 请求为空，请输入请求参数。 检查是否有必选请求参数为空。 400 DBS.200021 Invalid DB instance name. 实例名非法。 检查实例名称是否正确。 400 DBS.200023 Storage space is out of range. 卷大小超出允许范围。 检查磁盘大小是否超出允许范围。 400 DBS.200024 Invalid region. Region非法。 检查可用区名称是否正确，可用区是否在可用范围内。 400 DBS.200025 Invalid AZ. 可用区取值非法。 检查可用区名称是否正确，可用区是否在可用范围内。 400 DBS.200026 Invalid storage type. 卷类型非法。 检查磁盘类型是否正确。 400 DBS.200027 Storage space must be a multiple of 10. 卷大小不是10的整数倍。 检查磁盘大小是否是10的整数倍。 400 DBS.200040 The DB engine or version is not supported. 不支持的数据库类型或版本。 检查是否数据库类型和版本是否匹配，数据库类型和版本是否符合要求。 400 DBS.200041 Invalid database version. 数据库版本非法。 检查数据库的版本号是否支持。 400 DBS.200042 The DB engine does not exist. 引擎版本不存在。 检查数据库引擎是否为云数据库 GaussDB 支持的引擎。 400 DBS.200043 Invalid synchronize model. HA同步模式非法。 检查HA同步模式是否符合要求。 400 DBS.200048 Invalid VPC ID. VPC id非法。 检查VPC ID、名称是否正确，是否符合要求。 400 DBS.200049 Invalid subnet ID. 子网的网络id非法。 检查子网ID、名称是否正确，是否符合要求。 400 DBS.200051 Invalid HA mode. 不合法的ha模式。 检查HA模式是否符合要求。 400 DBS.200052 Invalid database root password. 数据库root密码非法。 检查用户名和密码是否匹配，密码是否符合密码要求。 400 DBS.200053 The selected specifications do not exist. 所选规格不存在。 检查规格是否正确，当前可用区是否支持该规格。 400 DBS.200054 Invalid specifications. 所选规格非法。 检查规格是否正确，当前可用区是否支持该规格。 400 DBS.200056 The maximum number of nodes has been reached. 节点个数达到最大值。 检查实例节点个数是否达到最大值。 400 DBS.200063 Invalid cluster mode. 集群模式非法。 检查传入的mode参数是否非法。 400 DBS.200086 This operation is not allowed by the DB instance status. 实例状态不允许做该操作。 检查实例的状态或实例正在进行的操作是否与请求冲突。 400 DBS.200087 The number of tags added for the DB instance has reached the quota. 单个实例标签数量达到最大配额。 检查实例的标签是否超过最大限制 400 DBS.200098 The tag already exists. 该资源标签已存在。 检查标签是否已经存在。 400 DBS.200302 Storage space must be a multiple of 10. 磁盘大小不是10的整数倍。 检查磁盘大小是否是10的倍数。 400 DBS.200306 The new storage space must be greater than or equal to the original storage space. 扩容参数不合法。 检查设置的磁盘大小是否已经超过上限。 400 DBS.200461 The parameter value is out of range. 参数值超出范围。 检查传入的port参数是否非法 400 DBS.200504 Invalid database version. 数据库版本非法。 检查传入的数据库版本号是否非法 400 DBS.200543 The job does not exist. 任务不存在 检查传入的任务Id是否非法 400 DBS.200823 The database does not exist. 数据库不存在。 检查传入的数据库是否不存在 400 DBS.200824 The database account does not exist. 数据库帐号不存在。 检查传入的用户是否存在 400 DBS.201014 This operation is not allowed by the DB instance status. 实例状态不允许做该操作。 检查实例的状态或实例正在进行的操作是否与请求冲突。 400 DBS.201101 Invalid backup cycle. 备份周期非法。 检查备份周期是否符合要求。 400 DBS.201103 Invalid backup start time. 备份开始时间非法。 检查备份开始时间是否符合要求。 400 DBS.201106 Invalid retention days. 备份保留天数非法。 检查备份保留天数是否符合要求。 400 DBS.201203 The backup file does not exist. 备份文件不存在。 检查该备份是否存在，备份是否匹配实例。 400 DBS.201207 The DB engine or version is not supported. 不支持该数据库引擎或版本。 检查数据库引擎是否为云数据库 GaussDB支持的引擎。 400 DBS.201208 The operation is not allowed by the backup status. 备份状态不允许。 请检查备份状态是否为"备份完成"。 400 DBS.212002 Incorrect parameter group quota. 参数组配额错误。 参数组配额超过限制，请删除无用的参数模板再重新创建。 400 DBS.212003 Operation not allowed. 不支持此操作。 默认参数模板不允许重置和删除。 400 DBS.212004 Parameter group update error. 参数组更新错误。 请检查要修改的参数值是否合法。 400 DBS.212005 The node does not belong to the group. 节点不属于组。 该节点不属于该实例，请检查实例id或节点Id是否正确。 400 DBS.212007 The DB engine does not exist. 引擎不存在。 检查数据库引擎是否存在。 400 DBS.212008 The DB engine is not supported. 不支持的引擎。 检查数据库引擎是否为云数据库 GaussDB支持的引擎。 400 DBS.212009 Task processing failed. 任务处理失败。 任务处理失败，请联系客服解决。 400 DBS.212010 The parameter group is being applied. 绑定正在执行。 正在应用参数模板，待完成后再进行其他操作。 400 DBS.212011 Application failed. 绑定失败。 应用参数模板失败，请联系客服解决。 400 DBS.212012 The parameter does not exist. 参数不存在。 请检查要修改的参数名是否正确。 400 DBS.212014 The node does not have a default parameter group. 节点没有默认参数组。 请检查节点ID或参数组ID是否正确。 400 DBS.212015 Partial success. 部分成功。 请检查要修改的参数名是否正确。 400 DBS.212016 Parameter update failed. 参数更新失败。 修改参数失败，请联系客服解决。 400 DBS.212017 Invalid parameter. 参数错误。 请检查参数名是否合法。 400 DBS.212025 Update failed. 更新失败。 修改参数失败，请联系客服解决 400 DBS.212030 Parameter error 参数错误。 参数模板名已经存在。 400 DBS.212032 The parameter template has been applied. 参数模板已被应用。 参数模板已经被应用，不能删除该模板。 400 DBS.212037 Parameters are incorrectly set. 参数设置不正确。 检查参数是否合法或参数是否在合法范围内。 400 DBS.270024 Proxy instance does not exist. Proxy实例不存在。 检查租户是否拥有该proxy实例，传入的proxy实例id是否正确，代理实例是否存在。 400 DBS.270025 Invalid weight. 权重非法。 检查传入的权重格式和范围是否正确。 400 DBS.270026 Invalid proxy mode. 数据库代理类型非法。 检查传入的数据库代理类型是否正确。 400 DBS.270027 Select a proxy instance. 未指定数据库代理。 检查参数数据库代理id是否为空。 400 DBS.280001 Parameter error. 参数错误。 检查传入的参数或URL是否全部正确，是否符合要求。 400 DBS.280127 Invalid backup description. 备份描述非法。 检查备份描述是否正确，是否符合要求。 400 DBS.280128 The database name does not exist. 数据库名不存在。 检查租户是否拥有该实例，实例名或实例ID是否正确，实例是否存在。 400 DBS.280203 This is a weak password. Please enter a strong password. 这是一个弱密码，请输入一个强度大一些的密码. 检查密码是否过于简单，请更改为较复杂的密码。 400 DBS.280204 Invalid parameter. 输入参数不合法。 检查参数是否合法或参数是否在合法范围内。 400 DBS.280214 The backup does not exist. 备份不存在。 检查备份保留天数是否正确。 400 DBS.280216 Invalid backup start time. 备份开始时间非法。 检查备份开始时间是否符合要求，备份开始时间和备份结束时间的关系是否正确。 400 DBS.280235 Invalid database type. 数据库类型非法 检查数据库引擎名称是否正确。 400 DBS.280237 Datastore not specified. Datastore为空。 检查数据库引擎是否为云数据库 GaussDB支持的引擎。 400 DBS.280238 The DB engine or version is not supported. 不支持的数据库类型或版本。 检查是否数据库类型和版本是否匹配，数据库类型和版本是否符合要求。 400 DBS.280239 Invalid specifications. 所选规格非法。 检查规格码是否正确，规格在当前可用区是否存在，规格是否支持。 400 DBS.280241 Invalid storage type. 卷类型非法。 检查磁盘的类型是否正确，是否符合要求。 400 DBS.280242 Storage space is out of range. 卷大小超出允许范围。 检查磁盘大小的值是否正确。 400 DBS.280246 Invalid database root password 数据库root密码非法。 检查用户名和密码是否匹配，密码是否符合密码要求。 400 DBS.280250 Invalid backup retention days. 备份保留期非法。 检查输入备份数据的保留时间是否合法或是否在合法范围内。 400 DBS.280251 Invalid backup cycle. 备份周期不合法。 检查输入备份周期是否合法或是否在合法范围内。 400 DBS.280253 Invalid backup start time. 备份开始时间非法。 检查备份开始时间是否符合要求，备份开始时间和备份结束时间的关系是否正确。 400 DBS.280260 Invalid available zone mode. 无效的可用区模式。 检查可用区的模式是否有效。 400 DBS.280270 The parameter does not exist. 参数不存在。 请检查要修改的参数名是否正确。 400 DBS.280271 The parameter value is out of range. 参数值超出范围。 检查参数值是否在有效范围内。 400 DBS.280272 The tag key must be unique. 新增tag存在重复的key。 检查新增tag是否已存在。 400 DBS.280277 Invalid backup name. 备份名称非法。 检查备份名称是否正确，是否符合要求。 400 DBS.280285 Invalid AZ. 可用区取值非法。 检查可用区名称是否正确，可用区是否在可用范围内。 400 DBS.280288 Invalid FlavorRef. 规格非法。 检查规格ID是否为null或空串。 400 DBS.280311 Invalid storage space size. 存储空间大小非法。 检查磁盘大小的值是否正确，是否符合要求。 400 DBS.280325 Invalid storage information. 硬盘信息不合法。 检查磁盘大小或磁盘类型是否合法。 400 DBS.280342 Invalid cluster mode. 集群模式非法。 检查实例模式是否正确，是否符合要求，实例模式与实例ID是否匹配。 400 DBS.280364 Invalid database port. 数据库端口号无效。 检查数据库设置的端口是否可用。 400 DBS.280402 Invalid HA mode. Ha模式非法。 检查输入的Ha模式是否符合要求。 400 DBS.280404 Invalid DB instance ID or node ID format. 实例ID非法。 检查实例ID是否符合规则。 400 DBS.280434 Invalid specification code. 所选规格码非法。 检查规格码是否符合规则，规格是否存在，规格是否可用。 400 DBS.280439 Invalid records. Enter a positive integer less than 100. 无效的查询记录数，请输入小于100的正整数。 检查查询记录数是否在有效范围内。 400 DBS.280448 The storage type is sold out. 当前卷类型已售罄。 检查当前卷类型是否存在可用。 400 DBS.280449 Operation not allowed on frozen objects. 不能对冻结的对象执行该操作。 检查实例是否冻结，当前操作是否支持在实例冻结期间进行。 400 DBS.280450 The DB instance specifications are sold out. 当前规格已售罄。 规格已售罄，请更换可用区或联系客服。 400 DBS.280500 ELB must be enabled. 需开启ELB。 需开启ELB。 400 DBS.280505 CBC error: There are unprocessed orders. CBC错误：存在未处理的订单，不能进行当前操作。 检查当前订单是否已处理完成。 400 DBS.290000 Parameter error. 参数错误。 检查传入的参数或URL是否全部正确，是否符合要求。 400 DBS.290001 Invalid parameter letter case. 参数大小写错误。 检查传入的参数大小写是否正确，是否符合要求。 403 DBS.200010 The DB instance ID or user ID may be null, or the operation is not authorized. 实例ID和用户ID可能为空，或者操作越权。 检查入参是否正确，实例是否存在，检查租户是否操作越权。 403 DBS.200044 Resource not found or permission denied. 访问资源不存在，或者无访问权限。 检查入参是否正确，访问资源是否存在，检查租户是否有访问权限。 403 DBS.200604 The DB instance ID or user ID may be null, or the operation is not authorized. 实例ID和用户ID可能为空，或者操作越权。 检查入参是否正确，实例是否存在，检查租户是否操作越权。 403 DBS.200810 You are not allowed to create databases on read replicas. 不能在只读实例创建数据库。 只读实例不允许创建数据库，请更换读写实例创建数据库。 403 DBS.200819 You are not allowed to delete database users on read replicas. 不能在只读实例执行删除数据库用户。 只读实例不允许删除数据库用户。 403 DBS.201003 Resource not found or permission denied. 访问资源不存在，或者无访问权限。 检查入参是否正确，访问资源是否存在，检查租户是否有访问权限。 403 DBS.280015 Resource not found or permission denied. 访问资源不存在，或者无访问权限。 检查入参是否正确，访问资源是否存在，检查租户是否有访问权限。 403 DBS.280056 Invalid token. Token非法。 检查实例是否属于租户，token是否已经重新获取。 404 DBS.200002 The DB instance does not exist. 实例不存在。 检查实例ID、实例是否正确，实例是否存在。 404 DBS.200008 The E CS information of the DB instance cannot be found. 请检查数据库，确认实例的虚拟机信息，找不到该实例的虚拟机信息。 检查入参是否正确，实例状态是否正常。 404 DBS.200013 The original DB instance does not exist. 源实例不存在。 检查实例ID、实例是否正确，实例是否存在。 404 DBS.200045 The DB instance does not exist. 实例不存在。 检查实例ID、实例是否正确，实例是否存在。 404 DBS.200050 The security group does not exist or does not belong to the VPC. 安全组不存在，或不属于该VPC。 检查输入安全组ID是否合法，安全组是否存在，节点的读内网地址是否属于该安全组。 404 DBS.200408 The DB instance does not exist. 实例不存在或已删除。 检查实例ID、实例是否正确，实例是否存在。 404 DBS.200470 The region or AZ does not exist. Region或可用区不存在。 检查可用区是否正确。 404 DBS.200501 The subnet does not exist or does not belong to the VPC. 子网不存在，或不属于该VPC。 检查子网ID、名称是否存在，是否匹配VPC。 404 DBS.200503 The VPC does not exist or does not belong to the user. VPC不存在，或不属于该用户。 检查租户是否拥有该VPC。 404 DBS.200602 The DB instance does not exist. 该实例不存在。 检查实例ID、实例是否正确，实例是否存在。 404 DBS.201010 The backup information does not exist. 备份信息不存在。 检查该备份是否存在，备份是否匹配实例。 404 DBS.201028 The DB instance does not exist. 实例不存在或已删除。 检查实例ID、实例是否正确，实例是否存在。 404 DBS.212001 The parameter group does not exist. 参数组不存在。 检查参数组是否存在。 404 DBS.290002 The selected specifications do not exist. 所选规格不存在。 检查规格是否正确，当前可用区是否支持该规格。 404 DBS.290005 The DB instance does not exist. 该实例不存在。 检查实例ID、实例是否正确，实例是否存在。 404 DBS.290011 The DB instance does not exist. 实例不存在。 检查实例ID、实例是否正确，实例是否存在。 404 DBS.290013 Resource not found. 未找到资源。 检查入参是否正确，实例是否存在。 409 DBS.200011 Another operation is being performed on the DB instance or the DB instance is faulty. 该实例正在进行其它操作或该实例故障，无法执行该操作，请稍后重试。 检查实例状态或实例正在进行的操作是否和请求冲突。 409 DBS.200019 Another operation is being performed on the DB instance or the DB instance is faulty. 该实例正在进行其他操作或该实例故障，无法执行该操作，请稍后重试。 检查实例状态或实例正在进行的操作是否和请求冲突。 409 DBS.200022 The DB instance name already exists. 实例名称已存在。 检查实例名称是否已经存在。 409 DBS.200047 Another operation is being performed on the DB instance or the DB instance is faulty. 该实例正在进行其它操作或该实例故障，无法执行该操作，请稍后重试。 检查实例状态或实例正在进行的操作是否和请求冲突。 409 DBS.200316 This operation cannot be performed because the DB instance status is Storage full. 当前实例状态为存储空间满，不能进行该操作。 实例存储空间已满，请调整存储空间大小。 409 DBS.200826 The database name already exists. 数据库名称已存在。 检查数据库名称是否合法。 409 DBS.200827 The database user already exists. 账号名称已存在。 检查数据库用户是否合法。 409 DBS.200828 You are not allowed to create a database built-in account. 数据库内置账号，用户不可创建。 检查数据库用户是否合法。 409 DBS.201202 Another operation is being performed on the DB instance or the DB instance is faulty. 该实例正在进行其它操作或该实例故障，无法执行该操作，请稍后重试。 检查实例状态或实例正在进行的操作是否和请求冲突。 409 DBS.201205 Backup is in progress, please wait. 正在备份中，请稍等。 实例正在备份中，等待备份完成后重试操作。 409 DBS.212006 Another operation is being performed on the DB instance or the DB instance is faulty. 该实例正在进行其它操作或该实例故障，无法执行该操作，请稍后重试。 检查实例状态或实例正在进行的操作是否和请求冲突。 409 DBS.280406 Operation not allowed by the DB instance type or status. 实例类型或状态受限，操作不允许。 操作不允许，可能是实例类型错误或实例状态不允许，请检查实例类型和实例状态。 413 DBS.200046 The number of DB instances has reached the quota. 实例数量达到配额。 实例数量配额达到限制，请联系管理员调整配额。 413 DBS.290003 The number of DB instances has reached the quota. 实例数量达到配额。 实例数量配额达到限制，请联系管理员调整配额。 422 DBS.212019 The parameter cannot be processed. 请求中的参数或对象不能被正确识别。 请求参数错误，请检查参数合法性。 500 DBS.108000 Server failure. 服务器错误。 服务内部错误，请联系客服。 500 DBS.108002 Server failure. 服务器错误。 服务内部错误，请联系客服。 500 DBS.108005 Server failure. 服务器错误。 服务内部错误，请联系客服。 500 DBS.200005 Server failure. 服务器错误。 服务内部错误，请联系客服。 500 DBS.200208 Server failure. 服务器错误。 服务内部错误，请联系客服。 500 DBS.200811 Failed to create the database. 创建数据库失败。 检查失败原因，可能是资源不足，请联系客服。 500 DBS.200821 Failed to modify database user permissions. 修改数据库用户权限失败。 可能是操作状态校验拦截，请重试。 500 DBS.213002 Failed to process the request. 请求处理失败。 服务内部错误，请联系客服。 500 DBS.213004 Failed to process the request. 请求处理失败。 服务内部错误，请联系客服。 500 DBS.290006 Failed to process the request. 请求处理失败。 服务内部错误，请联系客服。 500 DBS.290015 Failed to process the request. 请求处理失败。 服务内部错误，请联系客服。 父主题： 附录

响应参数 状态码： 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条数据，表示从第一条数据开始查询），必须为数字，不能为负数。

响应示例 状态码： 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参数 参数 参数类型 描述 databases Array of strings 数据库列表。 total_count Integer 数据库总数。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。