按目标库查询StarRocks数据同步配置信息
功能介绍
按目标库查询StarRocks数据同步配置信息。
调用方法
请参见如何调用API。
URI
GET /v3/{project_id}/instances/{instance_id}/starrocks/databases/replication/configuration/{database}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认值: 不涉及。 |
instance_id |
是 |
String |
参数解释: StarRocks实例ID,严格匹配UUID规则。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,后缀为in17,且长度为36个字符。 默认值: 不涉及。 |
database |
是 |
String |
参数解释: 目标数据库名。 约束限制: 不涉及。 取值范围: 字符长度限制3~128位,仅支持英文大小写字母、数字以及下划线。 默认值: 不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 约束限制: 不涉及。 取值范围: 不涉及。 默认值: 不涉及。 |
X-Language |
是 |
String |
参数解释: 请求语言类型。 约束限制: 不涉及。 取值范围: 默认值: en-us。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
source_instance_id |
String |
参数解释: TaurusDB实例ID。 取值范围: 只能由英文字母、数字组成,后缀为in07,长度为36个字符。 |
source_node_id |
String |
参数解释: TaurusDB节点ID。 取值范围: 只能由英文字母、数字组成,前面为UUID,后缀为no07,长度为36个字符。 |
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的异常信息。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
database_name |
String |
参数解释: 数据库名称。 取值范围: 不涉及。 |
db_config_check_results |
Array of DbConfigCheckResult objects |
参数解释: 数据库配置检查结果。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
param_name |
String |
参数解释: 参数名。 取值范围: 字符长度限制3~128位。 |
value |
String |
参数解释: 参数值。 取值范围: 字符长度限制1~64位。 |
check_result |
String |
参数解释: 校验结果。 取值范围: |
参数 |
参数类型 |
描述 |
---|---|---|
table_name |
String |
参数解释: 表名。 取值范围: 不涉及。 |
table_config |
String |
参数解释: 表配置项。 取值范围: 不涉及。 |
check_result |
String |
参数解释: 校验结果。 取值范围: |
参数 |
参数类型 |
描述 |
---|---|---|
repl_type |
String |
参数解释: 表同步类型。 取值范围: |
repl_scope |
String |
参数解释: 表同步范围。 取值范围: |
tables |
Array of strings |
参数解释: 白名单或黑名单的表范围。 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误消息。 |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误消息。 |
请求示例
查询目标库名为database的数据同步配置信息。
GET https://{endpoint}/v3/{project_id}/instances/{instance_id}/starrocks/databases/replication/configuration/database
响应示例
状态码: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" : "实例不存在" }
SDK代码示例
SDK代码示例如下。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.gaussdb.v3.region.GaussDBRegion; import com.huaweicloud.sdk.gaussdb.v3.*; import com.huaweicloud.sdk.gaussdb.v3.model.*; public class ListStarRocksDataReplicationConfigByDataBaseSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); GaussDBClient client = GaussDBClient.newBuilder() .withCredential(auth) .withRegion(GaussDBRegion.valueOf("<YOUR REGION>")) .build(); ListStarRocksDataReplicationConfigByDataBaseRequest request = new ListStarRocksDataReplicationConfigByDataBaseRequest(); request.withInstanceId("{instance_id}"); request.withDatabase("{database}"); try { ListStarRocksDataReplicationConfigByDataBaseResponse response = client.listStarRocksDataReplicationConfigByDataBase(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkgaussdb.v3.region.gaussdb_region import GaussDBRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkgaussdb.v3 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = GaussDBClient.new_builder() \ .with_credentials(credentials) \ .with_region(GaussDBRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListStarRocksDataReplicationConfigByDataBaseRequest() request.instance_id = "{instance_id}" request.database = "{database}" response = client.list_star_rocks_data_replication_config_by_data_base(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" gaussdb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := gaussdb.NewGaussDBClient( gaussdb.GaussDBClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListStarRocksDataReplicationConfigByDataBaseRequest{} request.InstanceId = "{instance_id}" request.Database = "{database}" response, err := client.ListStarRocksDataReplicationConfigByDataBase(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
Success. |
400 |
Client error. |
500 |
Server error. |
错误码
请参见错误码。