Obtaining the Deletion Status of a Service-linked Agency
Function
This API is used to obtain the deletion status of a service-linked agency.
Authorization Information
Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.
| Action | Access Level | Resource Type (*: required) | Condition Key | Alias | Dependencies |
|---|---|---|---|---|---|
| iam:agencies:getServiceLinkedAgencyDeletionStatusV5 | Read | agency * | - | - | - |
URI
GET /v5/service-linked-agencies/deletion-task/{deletion_task_id}
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| deletion_task_id | Yes | String | Definition ID of a deleted task. For details about how to obtain the ID, see the API for deleting a service-linked agency. The ID is returned after the API is called. Constraints N/A Range N/A Default Value N/A |
Request Parameters
None
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| status | String | Definition Status of a deleted task. Range The value can be "succeeded", "in_progress", "failed", or "not_started". |
| reason | String | Definition Cause of the deletion failure. Range The value contains 0 to 1,000 characters. |
| agency_usage_list | Array of agency_usage_list objects | Definition: List of scenarios where the service-linked agency is being used. Range: N/A |
| Parameter | Type | Description |
|---|---|---|
| region | String | Definition Region name. Range The value contains 1 to 100 characters. |
| resources | Array of strings | Definition: Uniform resource name list. Range: N/A |
Status code: 403
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Definition: Error code. For details, see Error Code. Range: The format is PAP5.XXXX, for example, PAP5.0012. |
| error_msg | String | Definition: Error message. For details, see Error Message. Range: N/A. |
| request_id | String | Definition: Unique identifier of an API request, which is used to locate API calling exceptions. Range: N/A |
| encoded_authorization_message | String | Definition: Encrypted details returned when the authentication fails, which are used to locate authentication problems. The STS5 decryption API can be used for decryption. For details, see API link. Range: N/A. |
Status code: 404
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Definition: Error code. For details, see Error Code. Range: The format is PAP5.XXXX, for example, PAP5.0012. |
| error_msg | String | Definition: Error message. For details, see Error Message. Range: N/A. |
| request_id | String | Definition: Unique identifier of an API request, which is used to locate API calling exceptions. Range: N/A |
Example Requests
Obtaining the deletion status of a service-linked agency
GET https://{endpoint}/v5/service-linked-agencies/deletion-task/{deletion_task_id} Example Responses
Status code: 200
{
"status" : "succeeded"
} Status Codes
| Status Code | Description |
|---|---|
| 200 | Successful |
| 403 | Forbidden |
| 404 | Not found |
Error Codes
See Error Codes.
What is your overall rating for this page?
Thank 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