Domain name for API request: ciam.tencentcloudapi.com.
This API is used to query the details of a task.
A maximum of 20 requests can be initiated per second for this API.
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: ListJobs. |
Version | Yes | String | Common Params. The value used for this API: 2022-03-31. |
Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
UserStoreId | Yes | String | User directory ID |
JobIds.N | No | Array of String | List of task IDs. If this parameter is empty, all tasks will be returned. |
Parameter Name | Type | Description |
---|---|---|
JobSet | Array of Job | List of tasks Note: This field may return null, indicating that no valid values can be obtained. |
RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: ciam.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListJobs
<Common request parameters>
{
"UserStoreId": "xx",
"JobIds": [
"xx"
]
}
{
"Response": {
"JobSet": [
{
"Status": "xx",
"Format": "xx",
"FailedUsers": [
{
"FailedUserIdentification": "xx",
"FailedReason": "xx"
}
],
"Location": "xx",
"Type": "xx",
"Id": "xx"
}
],
"RequestId": "xx"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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 | A CAM signature/authentication error occurred. |
DryRunOperation | DryRun Operation. It means that the request would have succeeded, but the DryRun parameter was used. |
FailedOperation | The operation failed. |
FailedOperation.DataFlowTooManyRequests | There are already two valid tasks. Wait for one of them to complete and try again. |
FailedOperation.ImportUserIsEmpty | The user is empty during user import. |
FailedOperation.InvalidTenant | The tenant is invalid. |
FailedOperation.InvalidUserStore | The user pool is invalid. |
FailedOperation.QuotaLimitExceeded | The quota is exceeded. Contact customer service. |
InternalError | An internal error occurred. |
InternalError.UnknownError | An unknown error occurred. |
InvalidParameter | The parameter is incorrect. |
InvalidParameter.ParameterIllegal | The request parameter is invalid. |
InvalidParameterValue | The parameter value is incorrect. |
LimitExceeded | The quota limit is exceeded. |
MissingParameter | The parameter is missing. |
OperationDenied | The operation was denied. |
RequestLimitExceeded | The number of requests exceeds the frequency limit. |
RequestLimitExceeded.FrequentRequest | Too many requests. Try again later. |
RequestLimitExceeded.RepeatRequest | Repeated request. Try again later. |
ResourceInUse | The resource is in use. |
ResourceInsufficient | The resource is insufficient. |
ResourceNotFound | The resource does not exist. |
ResourceUnavailable | The resource is unavailable. |
ResourcesSoldOut | The resources have been sold out. |
UnauthorizedOperation | The operation is unauthorized. |
UnauthorizedOperation.TenantNotActivated | The service is not activated. |
UnknownParameter | The parameter is unknown. |
UnsupportedOperation | The operation is not supported. |
Was this page helpful?