Obtaining the Dictionary List

Function

This API is used to obtain the dictionary list.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v5/{project_id}/setting/dictionaries

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range The value can contain 1 to 256 characters. Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	Yes	Integer	Definition Offset, which specifies the start position of the record to be returned. Constraints N/A Range The value range is 0 to 2,000,000. Default Value N/A
limit	Yes	Integer	Definition Number of records displayed on each page. Constraints N/A Range Value range: 10 to 200 Default Value 10
scene	No	String	Definition Application scenario. (Ignore it if there is only one scenario.) Constraints N/A Range hws: Chinese mainland website hec-hk: International website Default Value N/A
group_code	Yes	String	Definition Dictionary group. Constraints N/A Range featureSwitch: page feature switch Default Value N/A
code	No	String	Definition Dictionary item code, which is unique under group_code. Constraints N/A Range Length: 1 to 64 characters Default Value N/A

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token. Constraints N/A Range The value can contain 1 to 32,768 characters. Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total_num	Integer	Total
data_list	Array of Dictionary objects	Number of dictionary items

**Table 5** Dictionary
Parameter	Type	Description
code	String	Definition Dictionary code. Range Length: 1 to 256 characters
value	String	Definition Dictionary value (single value) Range Length: 1 to 65535 characters
values	Array of strings	Definition Dictionary values (multiple values) Range

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 1,
  "data_list" : [ {
    "code" : "cmw-zookeeper-ndr-02",
    "value" : "[{ccc}]",
    "values" : [ "47D7D20274DB309495ADFBC7A74FA8AB", "47D7D20274DB309495ADFBC7A74FA8AB" ]
  } ]
}

Status Codes

Status Code	Description
200	Request succeeded.

Error Codes

See Error Codes.

Parent Topic: Server Installation and Configuration

Previous topic: Enabling or Disabling the Automatic Agent Upgrade Function

Next topic: Querying Common Login IP Addresses

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

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.

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

Chatbot