查询配置文件内容
功能介绍
该接口用于查询集群配置文件内容,可以获得配置文件名称、状态、内容以及具体配置对象情况等,用于检查集群通过配置文件定义迁移方案,从不同数据源迁移到不同目的端的正确性。
调用方法
请参见如何调用API。
URI
GET /v1.0/{project_id}/clusters/{cluster_id}/lgsconf/confdetail
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID。获取方法请参见获取项目ID和名称。 约束限制: 不涉及 取值范围: 账户的项目ID。 默认取值: 不涉及 |
cluster_id |
是 |
String |
参数解释: 指定查询集群ID。获取方法请参见获取集群ID。 约束限制: 不涉及 取值范围: 集群ID。 默认取值: 不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
是 |
String |
参数解释: 配置文件名称。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
无
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
参数解释: 配置文件名称。 取值范围: 不涉及 |
status |
String |
参数解释: 配置文件状态。 取值范围: 不涉及 |
confContent |
String |
参数解释: 配置文件内容。 取值范围: 不涉及 |
setting |
setting object |
参数解释: 具体的配置内容对象。 取值范围: 不涉及 |
updateAt |
String |
参数解释: 更新时间。 取值范围: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
workers |
Integer |
参数解释: 并行执行管道的Filters+Outputs阶段的工作线程数。 约束限制: 不涉及 取值范围: 不涉及 默认取值: CPU核数。 |
batch_size |
Integer |
参数解释: 单个工作线程在尝试执行其Filters和Outputs之前将从inputs收集的最大事件数,该值较大通常更有效,但会增加内存开销。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 125 |
batch_delay_ms |
Integer |
参数解释: 每个event被pipeline调度等待的最小时间。单位毫秒。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
queue_type |
String |
参数解释: 用于事件缓冲的内部队列模型。 约束限制: 不涉及 取值范围: memory为基于内存的传统队列,persisted为基于磁盘的ACKed持久化队列。 默认取值: memory |
queue_check_point_writes |
Integer |
参数解释: 如果使用持久化队列,则表示强制执行检查点之前写入的最大事件数。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 1024 |
queue_max_bytes_mb |
Integer |
参数解释: 如果使用持久化队列,则表示持久化队列的总容量(以兆字节MB为单位),确保磁盘的容量大于该值。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 1024 |
请求示例
查询配置文件内容。
GET https://{Endpoint}/v1.0/{project_id}/clusters/5c77b71c-5b35-4f50-8984-76387e42451a/lgsconf/confdetail?name=conf1
响应示例
状态码:200
请求已成功。
{
"name" : "conf1",
"status" : "available",
"confContent" : "xxxxxxxx",
"setting" : {
"workers" : 2,
"batchSize" : 125,
"batchDelayMs" : 50,
"queueType" : "persisted",
"queueCheckPointWrites" : 1024,
"queueMaxBytesMb" : 1024
},
"updateAt" : "2021-09-29T02:44:44"
}
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 |
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.css.v1.region.CssRegion;
import com.huaweicloud.sdk.css.v1.*;
import com.huaweicloud.sdk.css.v1.model.*;
public class ShowGetConfDetailSolution {
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);
CssClient client = CssClient.newBuilder()
.withCredential(auth)
.withRegion(CssRegion.valueOf("<YOUR REGION>"))
.build();
ShowGetConfDetailRequest request = new ShowGetConfDetailRequest();
request.withClusterId("{cluster_id}");
try {
ShowGetConfDetailResponse response = client.showGetConfDetail(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 |
# coding: utf-8
import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcss.v1.region.css_region import CssRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcss.v1 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 = CssClient.new_builder() \
.with_credentials(credentials) \
.with_region(CssRegion.value_of("<YOUR REGION>")) \
.build()
try:
request = ShowGetConfDetailRequest()
request.cluster_id = "{cluster_id}"
response = client.show_get_conf_detail(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 |
package main
import (
"fmt"
"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
css "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/css/v1"
"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/css/v1/model"
region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/css/v1/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 := css.NewCssClient(
css.CssClientBuilder().
WithRegion(region.ValueOf("<YOUR REGION>")).
WithCredential(auth).
Build())
request := &model.ShowGetConfDetailRequest{}
request.ClusterId = "{cluster_id}"
response, err := client.ShowGetConfDetail(request)
if err == nil {
fmt.Printf("%+v\n", response)
} else {
fmt.Println(err)
}
}
|
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的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 |
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.css.v1.region.CssRegion;
import com.huaweicloud.sdk.css.v1.*;
import com.huaweicloud.sdk.css.v1.model.*;
public class ShowGetConfDetailSolution {
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);
CssClient client = CssClient.newBuilder()
.withCredential(auth)
.withRegion(CssRegion.valueOf("<YOUR REGION>"))
.build();
ShowGetConfDetailRequest request = new ShowGetConfDetailRequest();
request.withClusterId("{cluster_id}");
try {
ShowGetConfDetailResponse response = client.showGetConfDetail(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 |
# coding: utf-8
import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcss.v1.region.css_region import CssRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcss.v1 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 = CssClient.new_builder() \
.with_credentials(credentials) \
.with_region(CssRegion.value_of("<YOUR REGION>")) \
.build()
try:
request = ShowGetConfDetailRequest()
request.cluster_id = "{cluster_id}"
response = client.show_get_conf_detail(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 |
package main
import (
"fmt"
"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
css "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/css/v1"
"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/css/v1/model"
region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/css/v1/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 := css.NewCssClient(
css.CssClientBuilder().
WithRegion(region.ValueOf("<YOUR REGION>")).
WithCredential(auth).
Build())
request := &model.ShowGetConfDetailRequest{}
request.ClusterId = "{cluster_id}"
response, err := client.ShowGetConfDetail(request)
if err == nil {
fmt.Printf("%+v\n", response)
} else {
fmt.Println(err)
}
}
|
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
请求已成功。 |
400 |
非法请求。 建议直接修改该请求,不要重试该请求。 |
409 |
服务器在完成请求时发生冲突。 返回该状态码,表明客户端尝试创建的资源已经存在,或者由于冲突请求的更新操作不能被完成。 |
412 |
未满足前提条件,服务器未满足请求者在请求中设置的其中一个前提条件。 |
错误码
请参见错误码。