Creating a Service Agency

Function

This API is used to create a service agency for CSMS and FunctionGraph.

Calling Method

For details, see Calling APIs.

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

POST /v1/csms/agencies

Request Parameters

**Table 1** 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

**Table 2** Request body 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

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
agencies	Array of Agency objects	Definition Agency details list Range N/A

**Table 4** Agency
Parameter	Type	Description
agency_name	String	Definition Agency name Range N/A
agency_id	String	Definition Agency ID Range N/A
error_msg	String	Definition Error message. When an agency fails to be created, an error is returned. Range N/A

Example Requests

Create an agency for RDS-FG secrets.

{
  "secret_type" : "RDS-FG"
}

Example Responses

Status code: 200

Request succeeded.

{
  "agencies" : [ {
    "agency_name" : "xxxx1",
    "agency_id" : "xxxxxxx"
  }, {
    "agency_name" : "xxxxx2",
    "error_msg" : "xxxxxxxx"
  } ]
}