# 获取参数配置任务列表 - ListYmlsJob #### 功能介绍 该接口可获取Elasticsearch/OpenSearch集群参数配置的任务操作列表，可以得到参数配置列表ID、集群ID、修改参数记录等。在完成集群创建之后，可以调用此接口，检查集群参数配置信息，确保集群正常运行。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-css/css_03_0077.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-css/css_03_0096.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | css:configurations:list | List | cluster \* | - g:EnterpriseProjectId - g:ResourceTag/\ | - | - | #### URI GET /v1.0/{project_id}/clusters/{cluster_id}/ymls/joblists 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目ID。获取方法请参见[获取项目ID和名称](https://support.huaweicloud.com/api-css/css_03_0071.html)。 **约束限制**： 不涉及 **取值范围**： 账户的项目ID，长度为32个字符，由小写字母和数字组成。 **默认取值**： 不涉及 | | cluster_id | 是 | String | **参数解释**： 指定查询集群ID。获取方法请参见[获取集群ID](https://support.huaweicloud.com/api-css/css_03_0101.html)。 **约束限制**： 不涉及 **取值范围**： UUID格式，36个字符。 **默认取值**： 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | offset | 否 | Integer | **参数解释**： 指定查询起始值，默认值为1，即从第1个任务开始查询。 **约束限制**： 不涉及 **取值范围**： 大于或等于1 **默认取值**： 1 | | limit | 否 | Integer | **参数解释**： 指定查询个数，默认值为10，即一次查询10个任务信息。 **约束限制**： 不涉及 **取值范围**： 1-1000 **默认取值**： 10 | #### 请求参数 无 #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | configList | Array of [configListRsp] objects | **参数解释**： 历史修改配置列表，包含配置修改的详细信息。 **取值范围**： 不涉及 | | totalSize | Integer | **参数解释**： 配置任务数量。 **取值范围**： 不涉及 | 表4configListRsp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**： 配置列表ID。 **取值范围**： 不涉及 | | clusterId | String | **参数解释**： 集群ID。 **取值范围**： 不涉及 | | createAt | String | **参数解释**： 配置列表创建时间，格式：Unix时间戳格式，例如：1633658735000。 **取值范围**： 不涉及 | | status | String | **参数解释**： 集群任务执行状态。 **取值范围**： - success: 执行成功。 - failed: 执行失败。 - running: 执行中。 | | finishedAt | String | **参数解释**： 结束时间，当创建未结束时结束时间为null，格式：Unix时间戳格式，例如：1633658735000。 **取值范围**： 不涉及 | | modifyDeleteReset | String | **参数解释**： 参数修改、删除、重置配置记录。 **取值范围**： 不涉及 | | failedMsg | String | **参数解释**： 返回错误信息。当状态为success时该参数为null。 **取值范围**： 不涉及 | | instType | String | **参数解释**： 节点类型。 **取值范围**： 不涉及 | #### 请求示例 获取集群参数配置的任务列表。 ``` GET https://{Endpoint}/v1.0/{project_id}/clusters/{cluster_id}/ymls/joblists ``` #### 响应示例 **状态码：200** 请求成功。 ``` { "configList" : [ { "id" : "7ed7258a-60a8-46fe-8814-52819d491b80", "clusterId" : "4213d908-f5dc-4633-8401-cfd7175fca0c", "createAt" : "1755745344000", "status" : "success", "finishedAt" : "1755745355000", "modifyDeleteReset" : "{\"modify\":{\"elasticsearch.yml\":{\"thread_pool.force_merge.size\":\"1\"}}}", "failedMsg" : "", "instType" : "" } ], "totalSize" : 0 } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] ``` 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 ListYmlsJobSolution { 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("")) .build(); ListYmlsJobRequest request = new ListYmlsJobRequest(); request.withClusterId("{cluster_id}"); try { ListYmlsJobResponse response = client.listYmlsJob(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()); } } } ``` - [Python] ``` # 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("")) \ .build() try: request = ListYmlsJobRequest() request.cluster_id = "{cluster_id}" response = client.list_ymls_job(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := css.CssClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := css.NewCssClient(hcClient) request := &model.ListYmlsJobRequest{} request.ClusterId = "{cluster_id}" response, err := client.ListYmlsJob(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CSS/sdk?api=ListYmlsJob&version=v1)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求成功。 | | 400 | 非法请求。 建议直接修改该请求，不要重试该请求。 | | 409 | 服务器在完成请求时发生冲突。 返回该状态码，表明客户端尝试创建的资源已经存在，或者由于冲突请求的更新操作不能被完成。 | | 412 | 未满足前提条件，服务器未满足请求者在请求中设置的其中一个前提条件。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-css/css_03_0076.html)。