Checking Whether a Service Agency Exists
Function
Check whether a service agency exists.
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
GET /v1/csms/agencies
| 
         Parameter  | 
       
         Mandatory  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|---|
| 
         secret_type  | 
       
         Yes  | 
       
         String  | 
       
         Secret type  | 
      
Request Parameters
None
Response Parameters
Status code: 200
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         agency_granted  | 
       
         String  | 
       
         Whether an agency exists.  | 
      
Status code: 400
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         error_code  | 
       
         String  | 
       
         Error codes  | 
      
| 
         error_msg  | 
       
         String  | 
       
         Error description  | 
      
Status code: 401
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         error_code  | 
       
         String  | 
       
         Error codes  | 
      
| 
         error_msg  | 
       
         String  | 
       
         Error description  | 
      
Status code: 403
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         error_code  | 
       
         String  | 
       
         Error codes  | 
      
| 
         error_msg  | 
       
         String  | 
       
         Error description  | 
      
Status code: 404
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         error_code  | 
       
         String  | 
       
         Error codes  | 
      
| 
         error_msg  | 
       
         String  | 
       
         Error description  | 
      
Status code: 500
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         error_code  | 
       
         String  | 
       
         Error codes  | 
      
| 
         error_msg  | 
       
         String  | 
       
         Error description  | 
      
Status code: 502
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         error_code  | 
       
         String  | 
       
         Error codes  | 
      
| 
         error_msg  | 
       
         String  | 
       
         Error description  | 
      
Status code: 504
| 
         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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot