instance_id

Yes

String

Instance ID.

Minimum: 0

Maximum: 64

project_id

Yes

String

Project ID.

Minimum: 0

Maximum: 64

offset

No

String

Offset, which is greater than or equal to 0.

Default: 0

Minimum: 0

Maximum: 64

limit

No

String

Number of items displayed on each page.

Default: 10

Minimum: 0

Maximum: 64

parent_code

No

String

Parent dictionary code. The child dictionaries are returned. If this parameter is not specified, the top-level dictionaries are queried.

Minimum: 0

Maximum: 64

code

No

String

Code of the dictionary to query. Fuzzy match by dictionary code is supported.

Minimum: 0

Maximum: 64

name

No

String

Name of the dictionary to query. Fuzzy match by dictionary name is supported.

Minimum: 0

Maximum: 64

X-Auth-Token

Yes

String

User token, which can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Minimum: 1

Maximum: 100000

total

Integer

Total number of records, which is irrelevant to pagination.

Minimum: 1

Maximum: 128

size

Integer

Number of records displayed on the current page. The value must be less than or equal to the limit specified in the request.

Minimum: 1

Maximum: 128

dictionaries

Array of Dictionary objects

Dictionaries.

id

String

Dictionary ID.

Minimum: 0

Maximum: 64

name

String

Dictionary name.

• Characters allowed: letters, digits, underscores (_), and spaces

• Constraints: The value must be unique in an instance.

remark

String

Dictionary description.

code

String

Dictionary code.

• Characters allowed: letters, digits, underscores (_), and spaces

• Constraints: The value must be unique in an instance.

order

Integer

Dictionary order. A smaller value indicates a higher order.

extend_one

String

Extended field 1.

• Characters allowed: letters, digits, underscores (_), and spaces

extend_two

String

Extended field 2.

• Characters allowed: letters, digits, underscores (_), and spaces

parent_code

String

Parent dictionary code. If the value is null, the dictionary is a top-level dictionary.

type

String

Dictionary type.

• system: built-in dictionary of the system. It can be edited but cannot be deleted.

• user: dictionary created by a user.

create_time

Number

Time when the dictionary was created.

Minimum: 1

Maximum: 128

update_time

Number

Time when the dictionary was updated.

Minimum: 1

Maximum: 128

error_code

String

Error code.

Minimum: 1

Maximum: 128

error_msg

String

Error message.

Minimum: 1

Maximum: 128

error_details

String

Error information.

Minimum: 1

Maximum: 128

request_id

String

Request ID.

Minimum: 1

Maximum: 128

200

OK

403

Forbidden