调用DescribeInvocationResults查看一条或多条云助手命令的执行结果,即在ECS实例中的实际执行结果。
接口说明
- 当您执行命令后,不代表命令一定成功执行,并且一定有预期的命令效果。您需要通过本接口查看实际的具体执行结果,以实际输出结果为准。
- 您可以查询最近4周的执行信息,执行信息的保留上限为10万条。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 |
类型 |
是否必选 |
示例值 |
描述 |
Action | String | 是 | DescribeInvocationResults |
系统规定参数。取值:DescribeInvocationResults。 |
RegionId | String | 是 | cn-hangzhou |
地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。 |
ResourceGroupId | String | 否 | rg-bp67acfmxazb4p**** |
命令执行的资源组ID。传入该参数后,需要在执行命令时指定ResourceGroupId,支持筛选出对应的命令执行结果。 |
InvokeId | String | 否 | t-hz0jdfwd9f**** |
命令执行ID。您可以通过接口DescribeInvocations查询InvokeId。 |
InstanceId | String | 否 | i-bp1i7gg30r52z2em**** |
实例ID。 |
CommandId | String | 否 | c-hz0jdfwcsr**** |
命令ID。 |
InvokeRecordStatus | String | 否 | Running |
命令执行状态。取值范围:
|
IncludeHistory | Boolean | 否 | false |
是否返回命令定时执行的历史记录。取值范围:
默认值为false。 |
ContentEncoding | String | 否 | PlainText |
设置返回数据中
默认值为Base64。 |
PageNumber | Long | 否 | 1 |
当前页码。 起始值为1。 默认值为1。 |
PageSize | Long | 否 | 1 |
分页查询时设置的每页行数。 最大值为50。 默认值为10。 |
Tag.N.Key | String | 否 | TestKey |
命令执行的标签键。N的取值范围为1~20。一旦传入该值,则不允许为空字符串。 使用一个标签过滤资源,查询到该标签下的资源数量不能超过1000个;使用多个标签过滤资源,查询到同时绑定了多个标签的资源数量不能超过1000个。如果资源数量超过1000个,您需要使用ListTagResources接口进行查询。 最多支持64个字符,不能以 |
Tag.N.Value | String | 否 | TestValue |
命令执行的标签值。N的取值范围为1~20。该值可以为空字符串。 最多支持128个字符,不能包含 |
返回数据
名称 |
类型 |
示例值 |
描述 |
RequestId | String | 473469C7-AA6F-4DC5-B3DB-A3DC0DE***** |
请求ID。 |
Invocation | Object |
命令执行结果的集合。 |
|
PageSize | Long | 1 |
分页查询时设置的每页行数。 |
PageNumber | Long | 1 |
当前页码。 |
TotalCount | Long | 1 |
命令总个数。 |
InvocationResults | Array of InvocationResult |
命令执行结果集。 |
|
InvocationResult | |||
InvocationStatus | String | Success |
单台实例的命令进度状态,可能值:
|
Repeats | Integer | 0 |
命令在该实例上执行的次数。
|
CommandId | String | c-hz0jdfwcsr**** |
命令ID。 |
InstanceId | String | i-bp1i7gg30r52z2em**** |
实例ID。 |
Output | String | MTU6MzA6MDEK |
命令执行后的输出信息。
|
Dropped | Integer | 0 |
|
StopTime | String | 2020-01-19T09:15:47Z |
若调用了 |
ExitCode | Long | 0 |
命令的退出码。
|
StartTime | String | 2019-12-20T06:15:55Z |
命令在实例中开始执行的时间。 |
ErrorInfo | String | the specified instance does not exists |
命令的下发失败或执行失败原因的详情,可能值:
|
ErrorCode | String | InstanceNotExists |
命令下发失败或执行失败原因的代码,可能值:
|
FinishedTime | String | 2019-12-20T06:15:56Z |
命令执行的完成时间。如果命令执行出现超时情况,命令执行的完成时间以 |
InvokeId | String | t-hz0jdfwd9f**** |
命令执行ID。 |
InvokeRecordStatus | String | Running |
命令执行状态。可能值:
|
Username | String | test |
在ECS实例中执行命令的用户名称。 |
ContainerId | String | ab141ddfbacfe02d9dbc25966ed971536124527097398d419a6746873fea**** |
容器ID。 |
ContainerName | String | test-container |
容器名称。 |
Tags | Array of Tag |
命令执行的标签信息。 |
|
Tag | |||
TagKey | String | owner |
命令执行的标签键。 |
TagValue | String | zhangsan |
命令执行的标签值。 |
示例
请求示例
http(s)://ecs.aliyuncs.com/?Action=DescribeInvocationResults
&RegionId=cn-hangzhou
&InstanceId=i-bp1i7gg30r52z2em****
&PageNumber=1
&PageSize=1
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
473469C7-AA6F-4DC5-B3DB-A3DC0DE*****
0
Success
i-bp1i7gg30r52z2em****
0
the specified instance does not exists
2019-12-20T06:15:55Z
0
Running
2019-12-20T06:15:56Z
MTU6MzA6MDEK
c-hz0jdfwcsr****
InstanceNotExists
t-hz0jdfwd9f****
2020-01-19T09:15:47Z
test
ab141ddfbacfe02d9dbc25966ed971536124527097398d419a6746873fea****
test-container
owner
zhangsan
1
1
1
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE*****",
"Invocation" : {
"InvocationResults" : {
"InvocationResult" : [ {
"Dropped" : 0,
"InvocationStatus" : "Success",
"InstanceId" : "i-bp1i7gg30r52z2em****",
"ExitCode" : 0,
"ErrorInfo" : "the specified instance does not exists",
"StartTime" : "2019-12-20T06:15:55Z",
"Repeats" : 0,
"InvokeRecordStatus" : "Running",
"FinishedTime" : "2019-12-20T06:15:56Z",
"Output" : "MTU6MzA6MDEK",
"CommandId" : "c-hz0jdfwcsr****",
"ErrorCode" : "InstanceNotExists",
"InvokeId" : "t-hz0jdfwd9f****",
"StopTime" : "2020-01-19T09:15:47Z",
"Username" : "test",
"ContainerId" : "ab141ddfbacfe02d9dbc25966ed971536124527097398d419a6746873fea****",
"ContainerName" : "test-container",
"Tags" : [ {
"TagKey" : "owner",
"TagValue" : "zhangsan"
} ]
} ]
},
"TotalCount" : 1,
"PageSize" : 1,
"PageNumber" : 1
}
}
错误码
HttpCode |
错误码 |
错误信息 |
描述 |
400 | RegionId.ApiNotSupported | The api is not supported in this region. | 指定地域下不支持调用 API。请检查 RegionId 参数取值是否正确。 |
400 | Duplicate.TagKey | The Tag.N.Key contain duplicate key. | 标签中存在重复的键,请保持键的唯一性。 |
400 | InvalidTagKey.Malformed | The specified Tag.n.Key is not valid. | 指定的标签键参数有误。 |
400 | InvalidTagValue.Malformed | The specified Tag.n.Value is not valid. | 指定的标签值参数有误。 |
400 | MissingParameter.TagKey | You must specify Tag.N.Key. | 请指定标签键。 |
400 | InvalidParam.PageNumber | The specified parameter is invalid. | 指定的 PageNumber 参数无效。 |
400 | InvalidParam.PageSize | The specified parameter is invalid. | 指定的 PageSize 参数无效。 |
403 | Operation.Forbidden | The operation is not permitted. | 该操作是不被允许的。 |
500 | InternalError.Dispatch | An error occurred when you dispatched the request. | 发送请求时发生错误,请稍后重试。 |
500 | ServiceUnavailable | The request has failed due to a temporary failure of the server. | 请求后端超时。 |
500 | InternalError | The request processing has failed due to some unknown error. | 内部错误,请重试。 |
访问错误中心查看更多错误码。
腾讯云1折,限时活动,即将结束: 马上收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折,更有现金返利。同意关联立享优惠
转转请注明出处:https://www.yunxiaoer.com/152772.html