Updated on 2022-12-12 GMT+08:00

Querying Agency Information

Function

Query the information of an agency.

URI

GET /v2/servicerequest/agencies

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Specifies the user token.

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

Minimum length: 1

Maximum length: 5000

X-Language

No

String

Specifies the language environment. The value is a common language description character string, for example, zh-cn. It is zh-cn by default.

Some internationalization information, such as the service ticket type and name, is displayed based on the language environment.

Minimum length: 1

Maximum length: 32

X-Time-Zone

No

String

Specifies the time zone. The value is a common time zone description character string, for example, GMT+8. It is GMT+8 by default.

Time-related data is processed based on the time zone of the environment.

Minimum length: 1

Maximum length: 32

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

total_count

Integer

Specifies the total number.

Minimum value: 0

Maximum value: 65535

agency_list

Array of AgencyV2 objects

Specifies agencies.

Table 3 AgencyV2

Parameter

Type

Description

id

String

Specifies the agency ID.

Minimum length: 0

Maximum length: 64

name

String

Specifies the agency name.

Minimum length: 0

Maximum length: 64

duration

String

Specifies the validity period of an agency.

Minimum length: 0

Maximum length: 1

trust_domain_name

String

Specifies the account name of an agency.

Minimum length: 0

Maximum length: 256

trust_domain_id

String

Specifies the account ID of an agency.

Minimum length: 0

Maximum length: 64

create_time

String

Specifies the creation time.

Minimum length: 0

Maximum length: 32

expire_time

String

Specifies the expiration time.

Minimum length: 0

Maximum length: 32

Request Example

None

Response Example

Status code: 200

Response of status code 200

{
  "total_count" : 1,
  "agency_list" : [ {
    "id" : "123",
    "name" : "123",
    "duration" : "123",
    "trust_domain_name" : "123",
    "trust_domain_id" : "123",
    "create_time" : "123",
    "expire_time" : "123"
  } ]
}

Status Codes

Status Code

Description

200

Response of status code 200

Error Codes

See Error Codes.