# 查询实例配置参数 - ListConfigurations #### 功能介绍 查询指定实例的配置参数信息。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-dcs/api-call-process.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dcs/api-grant-policy.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | dcs:instance:getConfiguration | Read | instance \* | - g:EnterpriseProjectId - g:ResourceTag/\ | - | - | #### URI GET /v2/{project_id}/instances/{instance_id}/configs 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | instance_id | 是 | String | **参数解释**： 实例ID。可通过DCS控制台进入实例详情界面查看。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | project_id | 是 | String | **参数解释**： 项目ID。获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-dcs/dcs-api-0312045.html)。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | #### 请求参数 无 #### 响应参数 **状态码：200** 表2响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | config_time | String | **参数解释**： 实例操作时间。格式为：2017-03-31T12:24:46.297Z **取值范围**： 不涉及。 | | instance_id | String | **参数解释**： 实例ID。 **取值范围**： 不涉及。 | | redis_config | Array of [QueryRedisConfig] objects | **参数解释**： 实例配置项数组。 **取值范围**： 不涉及。 | | config_status | String | **参数解释**： 实例修改状态。 **取值范围**： - UPDATING：更新中。 - FAILURE：修改失败。 - SUCCESS：修改成功。 | | status | String | **参数解释**： 实例运行状态。 **取值范围**： - PAYING：订单未支付或处理中。 - CREATING：缓存实例开始创建。 - RUNNING：缓存实例运行中。 - CLOSING：缓存实例关闭中。 - STARTING：缓存实例启动中。 - RESTARTING：缓存实例重启中。 - CLOSED：缓存实例已经关闭。 - DELETING：缓存实例删除中。 - DELETED：缓存实例已删除。 - ERROR：缓存实例运行异常。 - FAILURE：缓存实例配置失败。 - SUCCESS：缓存实例配置成功。 - CREATEFAILED：缓存实例创建异常。 - DELETEFAILED：缓存实例删除异常。 - FREEZING：实例冻结。 - EXTENDING：缓存实例扩容中。 - EXTENDEDFAILED：实例扩容失败。 - MIGRATING：缓存实例迁移中。 - OTHER：其他状态。 - FLUSHING：实例清空数据中。 - RESTORING：备份数据恢复中。 - UPGRADING：实例软件升级中。 - IPEXCHANGING：IP交换中。 - IPROLLBACKING：IP回滚中。 - MS_SWAPPING：主备切换中。 - AZMigrating：AZ迁移中。 | 表3QueryRedisConfig | 参数 | 参数类型 | 描述 | |:---|:---|:---| | param_value | String | **参数解释**： 配置参数值。 **取值范围**： 不涉及。 | | value_type | String | **参数解释**： 配置参数的值类型，例如：Integer，String。 **取值范围**： - Integer：整数 - String：字符串 - Enum：枚举 - regular：正则 | | value_range | String | **参数解释**： 配置参数的取值范围。 **取值范围**： 不涉及。 | | description | String | **参数解释**： 配置项的描述。 **取值范围**： 不涉及。 | | default_value | String | **参数解释**： 配置参数的默认值。 **取值范围**： 不涉及。 | | param_name | String | **参数解释**： 配置参数名称。 **取值范围**： 不涉及。 | | param_id | String | **参数解释**： 配置参数ID。 **取值范围**： 不涉及。 | **状态码：400** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_msg | String | **参数解释**： 错误信息。 **取值范围**： 不涉及。 | | error_code | String | **参数解释**： 错误码。 **取值范围**： 请参见[错误码](https://support.huaweicloud.com/api-dcs/ErrorCode.html)。 | | error_ext_msg | String | **参数解释**： 扩展错误信息（暂未使用，赋值为null）。 **取值范围**： 不涉及。 | **状态码：500** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_msg | String | **参数解释**： 错误信息。 **取值范围**： 不涉及。 | | error_code | String | **参数解释**： 错误码。 **取值范围**： 请参见[错误码](https://support.huaweicloud.com/api-dcs/ErrorCode.html)。 | | error_ext_msg | String | **参数解释**： 扩展错误信息（暂未使用，赋值为null）。 **取值范围**： 不涉及。 | #### 请求示例 ``` GET https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/configs ``` #### 响应示例 **状态码：200** 查询实例配置参数成功。 ``` { "instance_id" : "50829e5a-a4fc-4c01-8651-80be8a491602", "config_status" : "SUCCESS", "config_time" : "2020-07-06T07:04:31.464Z", "redis_config" : [ { "param_id" : "1", "param_name" : "timeout", "description" : "Close the connection after a client is idle for N seconds (0 to disable)", "param_value" : "101", "value_range" : "0-7200", "value_type" : "Integer", "default_value" : "0" } ], "status" : "RUNNING" } ``` #### 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.dcs.v2.region.DcsRegion; import com.huaweicloud.sdk.dcs.v2.*; import com.huaweicloud.sdk.dcs.v2.model.*; public class ListConfigurationsSolution { 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); DcsClient client = DcsClient.newBuilder() .withCredential(auth) .withRegion(DcsRegion.valueOf("")) .build(); ListConfigurationsRequest request = new ListConfigurationsRequest(); request.withInstanceId("{instance_id}"); try { ListConfigurationsResponse response = client.listConfigurations(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 huaweicloudsdkdcs.v2.region.dcs_region import DcsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdcs.v2 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 = DcsClient.new_builder() \ .with_credentials(credentials) \ .with_region(DcsRegion.value_of("")) \ .build() try: request = ListConfigurationsRequest() request.instance_id = "{instance_id}" response = client.list_configurations(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" dcs "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2/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 := dcs.DcsClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := dcs.NewDcsClient(hcClient) request := &model.ListConfigurationsRequest{} request.InstanceId = "{instance_id}" response, err := client.ListConfigurations(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/DCS/sdk?api=ListConfigurations&version=v2)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询实例配置参数成功。 | | 400 | 非法请求。 | | 500 | 内部服务错误。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-dcs/ErrorCode.html)。