- What's New
- Service Overview
- Getting Started
- User Guide
-
API Reference
- Before You Start
- API Overview
- Calling APIs
-
API
- Instance Management
- Access Control Attribute Management
-
Permission Set Management
- Adding a System-defined Identity Policy
- Deleting a Permission Set
- Querying Permission Set Details
- Updating a Permission Set
- Deleting a System-defined Identity Policy
- Querying Details About a Custom Identity Policy
- Adding a Custom Identity Policy
- Deleting a Custom Identity Policy
- Listing Accounts Associated with a Permission Set
- Listing System-defined Identity Policies
- Listing Pre-provisioning Statuses of Permission Sets
- Listing Permission Sets
- Creating a Permission Set
- Listing Permission Sets Provisioned to an Account
- Pre-provisioning a Permission Set
- Querying Pre-attachment Status Details of a Permission Set
- Adding a System-defined Policy
- Deleting a System-defined Policy
- Listing System-defined Policies
-
Account Assignment Management
- Removing Account Assignments
- Querying Details about the Account Assignment Creation Status
- Listing Account Assignment Creation Statuses
- Listing Account Assignment Deletion Statuses
- Listing Users or Groups Associated with an Account and a Permission Set
- Creating Account Assignments
- Querying Details about the Account Assignment Deletion Status
- Tag Management
- User Management
- Group Management
- Group Membership Management
- SCIM User Management
- SCIM Group Management
- Service Provider (SP) Management
- Client Management
- Token Management
- Device Authorization Management
- Authorization Management
- Account Management
- Agency Management
- Credentials Management
- Appendixes
- Change History
- General Reference
Copied.
Response
After sending a request, you will receive a response, including a status code, response header, and response body.
Status Code
A status code is a group of digits, ranging from 1xx to 5xx. It indicates the status of a request. For more information, see Status Codes.
For example, if status code 200 is returned for calling the API used to list instances, the request is successful.
Response Header
Similar to a request, a response also has a header, for example, Content-type.
Header |
Description |
---|---|
Content-Type |
Type of the resource content. Type: string Default value: none |
Connection |
Whether the connection to the server is a long connection or a short connection. Type: string Valid values: keep-alive | close Default value: none |
Date |
Date when the server responded to the request. Type: string Default value: none |
X-Request-Id |
Uniquely identifies the request. The value is generated by the service and can be used for troubleshooting. Type: string Default value: none |
Response Body
The body of a response is often returned in structured format as specified in the Content-Type header field. The response body transfers content except the response header.
{ "instances": [ { "identity_store_id": "d-66f****b80", "instance_id": "ins-2c1e********f3c6", "alias": null, "instance_urn": "IdentityCenter::system:instance:ins-2c1e********f3c6" } ], "page_info": { "next_marker": null, "current_count": 1 } }
If an error occurs during API calling, an error code and a message will be displayed. The following shows an error response body.
{ "error_code": "IIC.1215", "error_msg": "only organizations administrator account can operate, please log in to the administrator account!", "request_id": "e311530********************51311" }
In the response body, error_code is an error code. error_msg provides information about the error. request_id uniquely identifies the request and its value is generated by the service and can be used for troubleshooting.
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