Updated on 2026-09-21 GMT+08:00

Checking Whether a Service Agency Exists

Function

Check whether a service agency exists.

Calling Method

For details, see Calling APIs.

URI

GET /v1/csms/agencies

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

secret_type

Yes

String

Definition

Secret type

Constraints

N/A

Range

  • RDS-FG: RDS secret.

  • GaussDB-FG: GaussDB secret.

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. It can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token. This parameter is optional if AK/SK authentication is used.

Constraints

N/A

Range

Obtain the value by calling the IAM API for obtaining the user token.

Default Value

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

agency_granted

String

Definition

Whether an agency exists.

Range

N/A

Example Requests

Query the agency of RDS-FG secrets.

/v1/csms/agencies?secret_type=RDS-FG

Example Responses

Status code: 200

Request succeeded.

{
  "agency_granted" : "true"
}

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.