Querying Configurations

Updated on 2024-12-16 GMT+08:00

View PDF

This API is used to query configurations in the configuration center.

For a professional microservice engine, see Calling APIs.
For an exclusive microservice engine, perform the following steps:
1. Log in to ServiceStage and choose Cloud Service Engine > Engines.
2. Select the microservice engine of the API to be called from the Microservice Engine drop-down list in the upper part of the page.
3. In the Service Discovery and Configuration area, view or click to copy the configuration center address.
4. Access the API by referring to Calling APIs. In Request URI, replace {Endpoint} with the obtained configuration center address.

GET /v3/{project_id}/configuration/items

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
dimensionsInfo	Yes	String	Service information, which consists of the service name (mandatory), application (mandatory), and version (optional). The combination format is as follows (note that @ and # must be escaped when being added to the HTTP URL. @ is escaped to %40, and # is escaped to %23): {serviceName}@{appId}#{version} or {serviceName}@{appId} The value cannot contain spaces or the following special characters: $%^&+/\
keyFilter	No	String	key filter criteria. A regular expression is supported. If special characters are contained, escape them.
revision	No	String	Version of a configuration item. This parameter is used to determine the difference between the local cache configuration and the configuration in the configuration center. Input 0 for the first time. If the input revision value is the same as the current revision value, status code 304 is returned, but no body is returned. If they are inconsistent, both revision values are returned. If revision is required in the next request, use the value of version in revision in the returned body.

**Table 3** Request header parameter
Parameter	Mandatory	Type	Description
x-environment	No	String	Environment whose configurations need to be queried. Value: development, testing, acceptance, or production. Other values are regarded as null.
Authorization	Yes	String	This parameter is mandatory if security authentication is enabled for an exclusive microservice engine. Otherwise, this parameter is not required. The token of an exclusive microservice engine with security authentication enabled is in the following format: Authorization:Bearer {Token} For details about how to obtain the token, see Obtaining the User Token of an Exclusive Microservice Engine.

If the input revision value is the same as the current revision value, no response message is returned.

Table 4 describes the response parameters.

**Table 4** Response parameters
Parameter	Type	Description
{dimension} (The parameter name and number of parameters are not fixed.)	Map<String, String>	Configuration content.
revision	Table 5	Revision.

**Table 5** revision
Parameter	Type	Description
version	String	Version.

GET /v3/default/configuration/items?dimensionsInfo=service%40app%231.0.0

{
    "service@app": {
        "k1": "v1"
    },
    "service@app#1.0.0": {
        "k2": "v2"
    }
}

Parent topic: Historical APIs

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.