云服务器
云服务器
文档指南
请输入
- 文档首页
云服务器云服务器ECSAPI参考云助手DescribeInvocations - 查询任务列表
复制全文
下载 pdfDescribeInvocations - 查询任务列表
文档反馈
问问助手调用DescribeInvocations接口，查询任务的执行列表和状态。
使用说明
您可以查询最近60天的执行信息，且执行信息的保留上限为5000条。
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
Action string 必选 示例值：DescribeInvocations
要执行的操作，取值：DescribeInvocations。
Version string 必选 示例值：2020-04-01
API的版本，取值：2020-04-01。
ProjectName string 可选 示例值：default
资源所属项目，一个资源只能归属于一个项目。
InvocationId string 可选 示例值：ivk-hz0jdfwd9f****
任务执行 ID。
InvocationName string 可选 示例值：test
任务执行名称，支持模糊搜索。
CommandId string 可选 示例值：cmd-hz0jdfwcsr****
CommandName string 可选 示例值：CommandTestName
命令名称，支持模糊搜索。
CommandType string 可选 示例值：Shell
命令类型。取值：
- Shell（默认）：表示创建一个在Linux实例中运行的Shell脚本。
- Python：表示创建一个Python脚本。
RepeatMode string 可选 示例值：Once
作业执行的方式。取值：
- Once：立即执行作业。
- Rate：周期执行作业。
- Fixed：定时执行作业。
InvocationStatus string 可选 示例值：Success
作业状态。由作业指定的所有实例，执行命令的状态决定。取值：
- Pending：命令正在等待校验和调度。存在一台实例的命令执行状态为Pending，则作业状态为Pending。
- Scheduled：表示周期执行作业（Rate）已经调度成功，等待执行。存在一台实例的命令执行状态为Scheduled，则作业状态为Scheduled。
- Running：作业正在执行。存在一台实例的命令执行状态为Running，则作业状态为Running。
- Success：所有实例的命令执行状态是Success，则作业执行状态为Success。
- Failed：所有实例上的命令执行状态均为Failed，则作业执行状态为Failed。
- Stopped：周期或定时执行的作业被手动停止。
- PartialFailed：立即执行的作业中，有部分实例执行命令失败。
- Finished ：周期执行的作业执行完成。
PageNumber integer 可选 示例值：1
当前页码。
- 起始值：1。
- 默认值：1。
PageSize integer 可选 示例值：10
分页查询时设置的每页行数。
- 取值范围：1~100。
- 默认值：10。
ContentEncoding string 可选 示例值：Base64
指定返回的命令内容编码方式。取值：
- PlainText：未进行编码处理。
- Base64：经过Base64编码处理。
TagFilters.N.Key string[] 可选 示例值：TagFilters.1.Key=k1
根据标签查询资源时指定的标签键。
- 参数 - N：表示标签键的序号，取值范围：1～10。
- 多个标签键之间用&分隔。
- 不允许重复。
TagFilters.N.Values.N string[] 可选 示例值：TagFilters.1.Values.1=v1&TagFilters.1.Values.2=v2
根据标签查询资源时指定的标签值。
- 第一个N：表示标签键的序号，取值范围：1～10。
- 第二个N：表示标签值的序号，取值范围：1～3，即同一标签键最多支持同时查询3个标签值。
- 多个标签值之间用&分隔。
说明
- 如果传入该参数，则必须先传入TagFilters.N.Key。
- 不传则表示查询同一标签键下的所有标签值。
- 传入空字符串时，表示查询标签值为空的标签。
返回参数
PageSize integer 示例值：1
每页行数。
PageNumber integer 示例值：10
查询结果的页码。
TotalCount integer 示例值：17
任务执行总个数。
Invocations object[] 示例值：--
符合条件的作业执行记录信息。
Frequency string 示例值：1d
执行频率。RepeatMode=Rate时，Rate表达式指定执行周期。
- 格式：<执行间隔数值><执行间隔单位>。
- 执行间隔单位：支持分钟（m）、小时（h）和天（d）。
RepeatMode string 示例值：Rate
命令执行的方式。
CommandProvider string 示例值：Volcengine
被调用命令的提供方。
CommandDescription string 示例值：升级命令。
被调用命令的描述。
EnableParameter boolean 示例值：true
被调用命令是否使用自定义参数。取值：
- true：已启用。
- false：未启用。
InstanceNumber integer 示例值：3
执行实例数量。
EndTime string 示例值：2022-11-10T06:50:59Z
任务结束时间。
StartTime string 示例值：2022-11-10T06:49:59Z
任务开始时间。
Timeout integer 示例值：60
创建的命令在ECS实例中执行时最大的超时时间，单位为秒。
WorkingDir string 示例值：/home
命令执行路径。
Username string 示例值：root
ECS实例中执行命令的用户名称。
InvocationStatus string 示例值：Stopped
命令执行的总执行状态，总执行状态取决于本次调用的全部实例的共同执行状态。
CommandType string 示例值：Shell
作业触发的命令类型。
CommandName string 示例值：更换Linux实例登录密码
任务触发时的命令名称。
InvocationDescription string 示例值：升级Agent
任务描述。
LaunchTime string 示例值：2022-11-11T06:49:59Z
执行时间。
- RepeatMode=Rate时，为作业首次执行时间，时间格式：RFC3339。
- RepeatMode=Fixed时，为作业开始执行时间，时间格式：RFC3339。
RecurrenceEndTime string 示例值：2022-11-21T06:49:59Z
周期结束时间，仅适用于周期任务（Rate），RFC3339 格式。
ProjectName string 示例值：default
所属项目。
ParameterDefinitions object[] 示例值：--
自定义参数定义。
Name string 示例值：Param
自定义参数名称。
Type string 示例值：String
自定义参数类型。取值：
- String：表示自定义参数类型为String（字符串）类型。
- Digit：表示自定义参数类型为Digit（数值）类型。
Required boolean 示例值：true
参数是否必填。取值：
- true：必填。
- false：非必填。
DefaultValue string 示例值：DefaultValue
自定义参数默认值。
MinLength integer 示例值：1
自定义参数值（字符串）的最小长度。
MaxLength integer 示例值：50
自定义参数值（字符串）的最大长度。
MinValue string 示例值：10
自定义参数值（数值）的最小值。
MaxValue string 示例值：100
自定义参数值（数值）的最大值。
DecimalPrecision integer 示例值：2
自定义参数值（数值）允许的小数点后位数。
Tags object[] 示例值：--
标签。
Key string 示例值：Key1
标签名称。
Value string 示例值：Value1
标签值。
InvocationName string 示例值：job-1
任务名称。
Parameters string 示例值：{\"username\":\"root\",\"password\":\"111@123\"}
命令中的自定义参数。
说明
调用InvokeCommand接口或RunCommand接口，执行命令时传入的参数。
CommandContent string 示例值：IyEvYmluL2Jhc****gdXBkYXRl
命令内容。
说明
根据请求参数中ContentEncoding参数值，返回相应编码方式的命令内容。
CommandId string 示例值：cmd-ybtvqkikdih96****
命令 ID。
InvocationId string 示例值：ivk-ycicy97x4i5pkgw****
任务执行 ID。
请求示例
GET /?Action=DescribeInvocations&Version=2020-04-01 HTTP/1.1
Host: ecs.cn-beijing.volcengineapi.com
Region: cn-beijing
Service: ecs
返回示例
{
"ResponseMetadata": {
"RequestId": "202409061635234DA7C33EBA49099*****",
"Action": "DescribeInvocations",
"Version": "2020-04-01",
"Service": "ecs",
"Region": "cn-beijing"
},
"Result": {
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 1,
"Invocations": [
{
"InvocationId": "ivk-yddq****",
"InvocationName": "test",
"InvocationDescription": "",
"CommandId": "cmd-ezvd****,
"CommandName": "test",
"CommandType": "Shell",
"RepeatMode": "Once",
"Frequency": "",
"InvocationStatus": "Success",
"CommandContent": "bHM=",
"Parameters": "{}",
"Username": "root",
"WorkingDir": "/home",
"Timeout": 66,
"StartTime": "2024-09-06T06:53:21Z",
"EndTime": "2024-09-06T06:53:55Z",
"InstanceNumber": 1,
"EnableParameter": false,
"CommandDescription": "",
"CommandProvider": "",
"ParameterDefinitions": [ ],
"LaunchTime": "",
"RecurrenceEndTime": "",
"ProjectName": "default",
"Tags": []
}
]
}
}
错误码
最近更新时间：2026.01.08 17:57:05
这个页面对您有帮助吗？
有用
有用
无用
无用