创建配置文件
功能介绍
该接口用于生成配置文件,该文件定义了Logstash集群的数据迁移方案。通过此配置文件,Logstash集群能够从多个数据源中提取数据,并将其迁移到指定的目的端。单集群最多创建50个配置文件。
调用方法
请参见如何调用API。
URI
POST /v1.0/{project_id}/clusters/{cluster_id}/lgsconf/submit
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
是 |
String |
参数解释: 配置文件名称。 约束限制: 不涉及 取值范围: 4~32个字符,只能包含数字、字母、中划线和下划线,且必须以字母开头。 默认取值: 不涉及 |
conf_content |
是 |
String |
参数解释: 配置文件内容。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
setting |
是 |
setting object |
参数解释: 配置实体对象。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
sensitive_words |
否 |
Array of strings |
参数解释: 敏感字符替换,输入需要隐藏的敏感字串列表。配置隐藏字符串列表后,在返回的配置内容中,会将所有在列表中的字串隐藏为***。 约束限制: 列表最大支持20条,单个字串最大长度512字节。 取值范围: 不涉及 默认取值: 不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
workers |
否 |
Integer |
参数解释: 并行执行管道的Filters+Outputs阶段的工作线程数。 约束限制: 不涉及 取值范围: 不涉及 默认取值: CPU核数。 |
batch_size |
否 |
Integer |
参数解释: 单个工作线程在尝试执行其Filters和Outputs之前将从inputs收集的最大事件数,该值较大通常更有效,但会增加内存开销。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 125 |
batch_delay_ms |
否 |
Integer |
参数解释: 每个event被pipeline调度等待的最小时间。单位毫秒。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
queue_type |
是 |
String |
参数解释: 用于事件缓冲的内部队列模型。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
queue_check_point_writes |
否 |
Integer |
参数解释: 如果使用持久化队列,则表示强制执行检查点之前写入的最大事件数。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 1024 |
queue_max_bytes_mb |
否 |
Integer |
参数解释: 如果使用持久化队列,则表示持久化队列的总容量(以兆字节MB为单位),确保磁盘的容量大于该值。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 1024 |
响应参数
状态码:200
请求已成功。
无
请求示例
配置实体对象。
POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/lgsconf/submit { "name" : "conf1", "conf_content" : "xxxxxxxx", "setting" : { "workers" : 2, "batch_size" : 125, "batch_delay_ms" : 50, "queue_type" : "persisted", "queue_check_point_writes" : 1024, "queue_max_bytes_mb" : 1024 } }
响应示例
无
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 50 51 52 53 54 55 56 57 58 59 60 |
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 CreateCnfSolution { 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(); CreateCnfRequest request = new CreateCnfRequest(); request.withClusterId("{cluster_id}"); CreateCnfReq body = new CreateCnfReq(); Setting settingbody = new Setting(); settingbody.withWorkers(2) .withBatchSize(125) .withBatchDelayMs(50) .withQueueType("persisted") .withQueueCheckPointWrites(1024) .withQueueMaxBytesMb(1024); body.withSetting(settingbody); body.withConfContent("xxxxxxxx"); body.withName("conf1"); request.withBody(body); try { CreateCnfResponse response = client.createCnf(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 34 35 36 37 38 39 40 41 42 43 44 45 |
# 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 = CreateCnfRequest() request.cluster_id = "{cluster_id}" settingbody = Setting( workers=2, batch_size=125, batch_delay_ms=50, queue_type="persisted", queue_check_point_writes=1024, queue_max_bytes_mb=1024 ) request.body = CreateCnfReq( setting=settingbody, conf_content="xxxxxxxx", name="conf1" ) response = client.create_cnf(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 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 |
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.CreateCnfRequest{} request.ClusterId = "{cluster_id}" workersSetting:= int32(2) batchSizeSetting:= int32(125) batchDelayMsSetting:= int32(50) queueCheckPointWritesSetting:= int32(1024) queueMaxBytesMbSetting:= int32(1024) settingbody := &model.Setting{ Workers: &workersSetting, BatchSize: &batchSizeSetting, BatchDelayMs: &batchDelayMsSetting, QueueType: "persisted", QueueCheckPointWrites: &queueCheckPointWritesSetting, QueueMaxBytesMb: &queueMaxBytesMbSetting, } request.Body = &model.CreateCnfReq{ Setting: settingbody, ConfContent: "xxxxxxxx", Name: "conf1", } response, err := client.CreateCnf(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
请求已成功。 |
400 |
非法请求。 建议直接修改该请求,不要重试该请求。 |
409 |
服务器在完成请求时发生冲突。 返回该状态码,表明客户端尝试创建的资源已经存在,或者由于冲突请求的更新操作不能被完成。 |
412 |
未满足前提条件,服务器未满足请求者在请求中设置的其中一个前提条件。 |
错误码
请参见错误码。