1. API Description
Domain name for API request: ssm.intl.tencentcloudapi.com.
This API is used to query the execution result of an async task.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name |
Required |
Type |
Description |
| Action |
Yes |
String |
Common Params. The value used for this API: DescribeAsyncRequestInfo. |
| Version |
Yes |
String |
Common Params. The value used for this API: 2019-09-23. |
| Region |
No |
String |
Common Params. This parameter is not required for this API. |
| FlowID |
Yes |
Integer |
Async task ID. |
3. Output Parameters
| Parameter Name |
Type |
Description |
| TaskStatus |
Integer |
0: processing, 1: processing succeeded, 2: processing failed |
| Description |
String |
Task description. |
| RequestId |
String |
The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
4. Example
Example1 Querying the execution result of async task
https:
&FlowID=123
&<Common request parameters>
Output Example
{
"Response": {
"Description": "task is processing",
"RequestId": "2609a8fd-4584-4f89-98be-8c7ae1b81ef4",
"TaskStatus": 0
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
Command Line Interface
6. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code |
Description |
| AuthFailure |
Error with CAM signature/authentication. |
| DryRunOperation |
DryRun Operation. It means that the request would have succeeded, but the DryRun parameter was used. |
| FailedOperation |
Operation failed. |
| FailedOperation.AccessKmsError |
KMS operation failed. |
| InternalError |
An internal error occurred. |
| InvalidParameter |
Incorrect parameter. |
| InvalidParameterValue |
The parameter value is invalid. |
| InvalidParameterValue.TagKeysDuplicated |
The tag keys are duplicated. |
| InvalidParameterValue.TagsNotExisted |
The tag key or tag value does not exist. |
| LimitExceeded |
The quota limit is exceeded. |
| MissingParameter |
Missing parameter. |
| OperationDenied |
Operation denied. |
| OperationDenied.AutoRotatedResource |
It is not allowed to manually update credentials with automatic rotation enabled. |
| RequestLimitExceeded |
The number of requests exceeds the frequency limit. |
| ResourceInUse |
The resource is in use. |
| ResourceInUse.SecretExists |
The Secret name already exists. |
| ResourceInUse.VersionIdExists |
The Version ID already exists. |
| ResourceInsufficient |
Insufficient resource. |
| ResourceNotFound |
The resource does not exist. |
| ResourceUnavailable |
The resource is unavailable. |
| ResourceUnavailable.NotPurchased |
The service is not purchased. |
| ResourceUnavailable.ResourceDisabled |
The Secret is disabled. |
| ResourceUnavailable.ResourcePendingDeleted |
The Secret is in PendingDelete status. |
| ResourceUnavailable.ResourceUninitialized |
The credential has not been initialized. |
| ResourcesSoldOut |
The resources have been sold out. |
| UnauthorizedOperation |
The operation is unauthorized. |
| UnauthorizedOperation.AccessKmsError |
Failed to access KMS. |
| UnknownParameter |
Unknown parameter. |
| UnsupportedOperation |
Unsupported operation. |