Help Center/ Distributed Cache Service/ API Reference/ API V2/ Parameter Management/ Querying DCS Instance Configuration Parameters
Updated on 2025-05-13 GMT+08:00

Querying DCS Instance Configuration Parameters

Function

This API is used to query the configuration parameters of a DCS instance.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/instances/{instance_id}/configs

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

instance_id

Yes

String

Parameter description:

Instance ID. It can be viewed on the instance details page on the DCS console.

Constraints:

N/A.

Value range:

N/A.

Default value:

N/A.

project_id

Yes

String

Parameter description:

Project ID. For details, see Obtaining a Project ID.

Constraints:

N/A.

Value range:

N/A.

Default value:

N/A.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

config_time

String

Parameter description:

Time when the instance was operated on. For example, 2017-03-31T12:24:46.297Z.

Value range:

N/A.

instance_id

String

Parameter description:

Instance ID.

Value range:

N/A.

redis_config

Array of QueryRedisConfig objects

Parameter description:

Array of configuration items of the instance.

Value range:

N/A.

config_status

String

Parameter description:

Instance status that is being modified or has been modified.

Value range:

  • UPDATING: The modification is in progress.

  • FAILURE: The modification failed.

  • SUCCESS: The modification succeeded.

status

String

Parameter description:

Instance status.

Value range:

  • PAYING: The order has not been paid or is being processed.

  • CREATING: The DCS instance is being created.

  • RUNNING: The DCS instance is running.

  • CLOSING: The DCS instance is stopping.

  • STARTING: The DCS instance is starting.

  • RESTARTING: The DCS instance is restarting.

  • CLOSED: The DCS instance has stopped.

  • DELETING: The DCS instance is being deleted.

  • DELETED: The DCS instance has been deleted.

  • ERROR: The DCS instance is not running properly.

  • FAILURE: The DCS instance fails to be configured.

  • SUCCESS: The DCS instance is successfully configured.

  • CREATEFAILED: The DCS instance fails to be created.

  • DELETEFAILED: The DCS instance fails to be deleted.

  • FREEZING: The instance is frozen.

  • EXTENDING: The DCS instance's capacity is being increased.

  • EXTENDEDFAILED: The instance's capacity fails to be increased.

  • MIGRATING: The DCS instance is migrating data.

  • OTHER: other status.

  • FLUSHING: The instance data is being cleared.

  • RESTORING: The backup data is being restored.

  • UPGRADING: The instance software is being upgraded.

  • IPEXCHANGING: IP switch is in progress.

  • IPROLLBACKING: IP addresses are being rolled back.

  • MS_SWAPPING: The master/standby switchover is in progress.

  • AZMigrating: The AZ is being migrated.

Table 3 QueryRedisConfig

Parameter

Type

Description

param_value

String

Parameter description:

Configuration parameter value.

Value range:

N/A.

value_type

String

Parameter description:

Type of the configuration parameter value. For example, Integer and String.

Value range:

N/A.

value_range

String

Parameter description:

Range of the configuration parameter value.

Value range:

N/A.

description

String

Parameter description:

Description of the configuration item.

Value range:

N/A.

default_value

String

Parameter description:

Default value of the configuration parameter.

Value range:

N/A.

param_name

String

Parameter description:

Configuration parameter name.

Value range:

N/A.

param_id

String

Parameter description:

Configuration parameter ID.

Value range:

N/A.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_msg

String

Parameter description:

Error message.

Value range:

N/A.

error_code

String

Parameter description:

Error code.

Value range:

For details, see Error Codes.

error_ext_msg

String

Parameter description:

Extended error information. This parameter is not used currently and is set to null.

Value range:

N/A.

Status code: 500

Table 5 Response body parameters

Parameter

Type

Description

error_msg

String

Parameter description:

Error message.

Value range:

N/A.

error_code

String

Parameter description:

Error code.

Value range:

For details, see Error Codes.

error_ext_msg

String

Parameter description:

Extended error information. This parameter is not used currently and is set to null.

Value range:

N/A.

Example Requests

GET https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/configs

Example Responses

Status code: 200

Instance configuration parameters queried successfully.

{
  "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" : "Interger",
    "default_value" : "0"
  } ],
  "status" : "RUNNING"
}

SDK Sample Code

The SDK sample code is as follows.

 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.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("<YOUR REGION>"))
                .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());
        }
    }
}
 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 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("<YOUR REGION>")) \
        .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)
 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"
    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 := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := dcs.NewDcsClient(
        dcs.DcsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListConfigurationsRequest{}
	request.InstanceId = "{instance_id}"
	response, err := client.ListConfigurations(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Instance configuration parameters queried successfully.

400

Invalid request.

500

Internal service error.

Error Codes

See Error Codes.