Updated on 2025-08-28 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

Secret type

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

agency_granted

String

Whether an agency exists.

Status code: 400

Table 3 Response body parameters

Parameter

Type

Description

error_code

String

Error codes

error_msg

String

Error description

Status code: 401

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error codes

error_msg

String

Error description

Status code: 403

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error codes

error_msg

String

Error description

Status code: 404

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error codes

error_msg

String

Error description

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error codes

error_msg

String

Error description

Status code: 502

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error codes

error_msg

String

Error description

Status code: 504

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error codes

error_msg

String

Error description

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.

400

Invalid request parameter.

401

Username and password are required for the requested page.

403

Authentication failed.

404

The resource does not exist.

500

Internal service error.

502

Request failed. The server has received an invalid response.

504

Gateway timed out.

Error Codes

See Error Codes.