Queries the execution list and states of Cloud Assistant commands.
Operation description
DescribeInvocations
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| ecs:DescribeInvocations | get | Instance acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}Command acs:ecs:{#regionId}:{#accountId}:command/{#commandId} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | Yes | $.parameters[15].schema.items.properties.Value.description | cn-hangzhou |
| ResourceGroupId | string | No | $.parameters[15].schema.items.properties.Value.example | rg-bp67acfmxazb4p**** |
| InvokeId | string | No | $.parameters[15].schema.items.properties.Value.enumValueTitles | t-hz0jdfwd9f**** |
| CommandId | string | No | $.parameters[15].schema.items.description | c-hz0jdfwcsr**** |
| CommandName | string | No | $.parameters[15].schema.items.example | CommandTestName |
| CommandType | string | No | $.parameters[15].schema.items.enumValueTitles | RunShellScript |
| Timed | boolean | No | $.parameters[15].schema.description | true |
| InvokeStatus | string | No | $.parameters[15].schema.example | Finished |
| InstanceId | string | No | $.parameters[15].schema.enumValueTitles | i-bp1i7gg30r52z2em**** |
| ContentEncoding | string | No | { "PageSize": 10, "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****", "PageNumber": 1, "TotalCount": 1, "Invocations": { "Invocation": [ { "CreationTime": "2020-01-19T09:15:46Z", "Frequency": "0 /20 * * * ", "InvocationStatus": "Running", "RepeatMode": "Once", "CommandId": "c-hz0jdfwcsr**", "CommandType": "RunShellScript", "InvokeStatus": "Finished", "Parameters": "{}", "Timed": false, "CommandContent": "cnBtIC1xYSB8IGdyZXAgdnNm****", "CommandName": "CommandTestName", "CommandDescription": "testDescription", "InvokeId": "t-hz0jdfwd9f****", "Username": "root", "WorkingDir": "/home/", "Timeout": 60, "ContainerId": "ab141ddfbacfe02d9dbc25966ed971536124527097398d419a6746873fea****", "ContainerName": "test-container", "InvokeInstances": { "InvokeInstance": [ { "CreationTime": "2019-12-20T06:15:54Z", "UpdateTime": "2020-01-19T09:15:47Z", "FinishTime": "2019-12-20T06:15:56Z", "InvocationStatus": "Success", "Repeats": 0, "InstanceId": "i-bp1i7gg30r52z2em****", "Output": "OutPutTestmsg", "Dropped": 0, "StopTime": "2020-01-19T09:15:47Z", "ExitCode": 0, "StartTime": "2019-12-20T06:15:55Z", "ErrorInfo": "the specified instance does not exists", "Timed": false, "ErrorCode": "InstanceNotExists", "InstanceInvokeStatus": "Finished" } ], "Tags": [ { "TagKey": "owner", "TagValue": "zhangsan" } ] } } ] } } | PlainText |
| IncludeOutput | boolean | No | false | |
| PageNumber | long | No | acs:ecs:{#regionId}:{#accountId}:command/* | 1 |
| PageSize | long | No | Command | 10 |
| MaxResults | integer | No | acs:ecs:{#regionId}:{#accountId}:instance/* | 10 |
| NextToken | string | No | Instance | AAAAAdDWBF2 |
| RepeatMode | string | No | FEATUREecsXZ3H4M | Once |
| Tag | array<object> | No | dubbo | |
| object | No | The region ID. You can call the DescribeRegions operation to query the most recent list of regions. | ||
| Value | string | No | The ID of the resource group. After you set this parameter, command execution results in the specified resource group are queried. | TestValue |
| Key | string | No | The command task ID. | TestKey |
Response parameters
Examples
Sample success responses
JSONformat
{
"PageSize": 10,
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
"PageNumber": 1,
"TotalCount": 1,
"NextToken": "AAAAAdDWBF2",
"Invocations": {
"Invocation": [
{
"OssOutputDelivery": "oss://testBucket/testPrefix",
"InvocationStatus": "Running",
"Parameters": {},
"Timed": false,
"CommandDescription": "testDescription",
"Timeout": 60,
"InvokeInstances": {
"InvokeInstance": [
{
"Dropped": 0,
"InvocationStatus": "Success",
"InstanceId": "i-bp1i7gg30r52z2em****",
"Timed": false,
"InstanceInvokeStatus": "Finished",
"ExitCode": 0,
"ErrorInfo": "the specified instance does not exists",
"StartTime": "2019-12-20T06:15:55Z",
"Repeats": 0,
"OssOutputUri": "oss://testBucket/testPrefix/output.txt",
"OssOutputStatus": "Finished",
"FinishTime": "2019-12-20T06:15:56Z",
"Output": "OutPutTestmsg",
"CreationTime": "2019-12-20T06:15:54Z",
"UpdateTime": "2020-01-19T09:15:47Z",
"ErrorCode": "InstanceNotExists",
"StopTime": "2020-01-19T09:15:47Z"
}
]
},
"CommandContent": "cnBtIC1xYSB8IGdyZXAgdnNm****",
"WorkingDir": "/home/",
"RepeatMode": "Once",
"InvokeStatus": "Finished",
"CommandType": "RunShellScript",
"Username": "test",
"ContainerId": "ab141ddfbacfe02d9dbc25966ed971536124527097398d419a6746873fea****",
"ContainerName": "test-container",
"CreationTime": "2020-01-19T09:15:46Z",
"Frequency": "0 */20 * * * *",
"Launcher": "python3 -u {{ACS::ScriptFileName|Ext(\".py\")}}",
"CommandId": "c-hz0jdfwcsr****",
"CommandName": "CommandTestName",
"InvokeId": "t-hz0jdfwd9f****",
"TerminationMode": "ProcessTree",
"Tags": {
"Tag": [
{
"TagKey": "owner",
"TagValue": "zhangsan"
}
]
}
}
]
}
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | RegionId.ApiNotSupported | The api is not supported in this region. | The API operation cannot be called in the specified region. Check whether the specified RegionId parameter is valid. |
| 400 | NumberExceed.Tags | The Tags parameter number is exceed. | The number of tags exceeds the maximum limit. |
| 400 | Duplicate.TagKey | The Tag.N.Key contain duplicate key. | The specified tag key already exists. Tag keys must be unique. |
| 400 | InvalidTagKey.Malformed | The specified Tag.n.Key is not valid. | The specified Tag.N.Key parameter is invalid. |
| 400 | InvalidTagValue.Malformed | The specified Tag.n.Value is not valid. | The specified tag value is invalid. |
| 400 | MissingParameter.TagKey | You must specify Tag.N.Key. | The tag key is not specified. |
| 400 | InvalidParam.PageNumber | The specified parameter is invalid. | The specified PageNumber parameter is invalid. |
| 400 | InvalidParam.PageSize | The specified parameter is invalid. | The specified PageSize parameter is invalid. |
| 400 | InvalidParameter.NextToken | The specified parameter NextToken is not valid. | The specified parameter NextToken is illegal. |
| 400 | InvalidParameter.MaxResults | The specified parameter MaxResults is not valid. | The specified parameter MaxResults is illegal. |
| 403 | Operation.Forbidden | The operation is not permitted. | The operation is not supported. |
| 404 | InvalidRegionId.NotFound | The RegionId provided does not exist in our records. | The RegionId provided does not exist |
| 500 | InternalError.Dispatch | An error occurred when you dispatched the request. | An error occurred while the request is being sent. Try again later. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-12-05 | API Description Update. The Error code has changed | View Change Details |
| 2024-08-01 | The Error code has changed. The response structure of the API has changed | View Change Details |
| 2024-05-14 | The Error code has changed. The response structure of the API has changed | View Change Details |
| 2023-12-21 | The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed | View Change Details |
| 2023-05-12 | The Error code has changed | View Change Details |
| 2022-07-07 | The Error code has changed. The response structure of the API has changed | View Change Details |
| 2022-06-22 | The Error code has changed. The response structure of the API has changed | View Change Details |
| 2021-05-12 | The Error code has changed | View Change Details |