You need to enable JavaScript to run this app.
导航
云服务器
  • 文档首页
    • /
  • 云服务器

DescribeInvocations

最近更新时间：2023.11.20 19:42:51

首次发布时间：2023.09.04 15:43:19

我的收藏

调用DescribeInvocations接口，查询批量作业的执行列表和状态。

调试

API Explorer
您可以通过API Explorer在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

名称类型是否必填示例值描述
ActionString是DescribeInvocations要执行的操作，取值：DescribeInvocations。
VersionString是2020-04-01接口的版本，取值：2020-04-01。
InvocationIdString否ivk-hz0jdfwd9f****任务执行ID。
InvocationNameString否批量作业-1任务执行名称，支持模糊搜索。
CommandIdString否cmd-hz0jdfwcsr****命令ID，您可以通过接口DescribeCommands查询获取。
CommandNameString否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。

返回数据

名称类型示例值描述
PageSizeInteger1每页行数。
PageNumberInteger10查询结果的页码。
TotalCountInteger17作业总个数。
InvocationsArray of Struct-符合条件的作业执行记录信息。具体请参见下表“Invocation 结构”。

Invocation 结构

名称类型示例值描述
InvocationIdStringivk-ycicy97x4i5pkgw****作业ID。
InvocationNameString批量作业-1作业名称。
InvocationDescriptionString升级Agent作业描述。
CommandIdStringcmd-ybtvqkikdih96****命令ID。
CommandNameString更换Linux实例登录密码作业触发的命令名称。
CommandTypeStringShell作业触发的命令类型。
InvocationStatusStringStopped命令执行的总执行状态，总执行状态取决于本次调用的全部实例的共同执行状态。
CommandContentStringIyEvYmluL2Jhc****gdXBkYXRlBase64编码后的命令内容。

Parameters

String

{\"username\":\"root\",\"password\":\"111@123\"}

命令中的自定义参数。

说明

调用InvokeCommand接口或RunCommand接口，执行命令时传入的参数。

UsernameStringrootECS实例中执行命令的用户名称。
WorkingDirString/home命令执行路径。
TimeoutInteger60创建的命令在ECS实例中执行时最大的超时时间，单位为秒。
StartTimeString2022-11-10T06:49:59Z作业开始时间。
EndTimeString2022-11-10T06:50:59Z作业结束时间。
InstanceNumberInteger3执行实例数量。

EnableParameter

Boolean

true

被调用命令是否使用自定义参数。取值：

  • true：已启用。
  • false：未启用。
CommandDescriptionString升级命令。被调用命令的描述。
CommandProviderStringVolcengine被调用命令的提供方。
ParameterDefinitionsArray of Struct-被调用命令的自定义参数信息，具体请参见下表“ParameterDefinition 结构”。
RepeatModeStringRate命令执行的方式。

Frequency

String

1d

执行频率。RepeatMode=Rate时，Rate表达式指定执行周期。

  • 格式：<执行间隔数值><执行间隔单位>。
  • 执行间隔单位：支持分钟（m）、小时（h）和天（d）。

LaunchTime

String

2022-11-11T06:49:59Z

执行时间。

  • RepeatMode=Rate时，为作业首次执行时间，时间格式：RFC3339。
  • RepeatMode=Fixed时，为作业开始执行时间，时间格式：RFC3339。
RecurrenceEndTimeString2022-11-21T06:49:59Z周期结束时间，RFC3339 格式。

ParameterDefinition 结构

名称类型是否必填示例值描述
NameString是Param参数名称。

Type

String

是

String

参数类型。取值：

  • String：表示自定义参数类型为String（字符串）类型。
  • Digit：表示自定义参数类型为Digit（数值）类型。

Required

String

是

true

是否必填。取值：

  • true：必填。
  • false：非必填。
DefaultValue-否-自定义参数默认值。
MinLengthInteger否1自定义参数值（字符串）的最小长度。
MaxLengthInteger否50自定义参数值（字符串）的最大长度。
MinValueInteger否10自定义参数值（数值）的最小值。
MaxValueInteger否100自定义参数值（数值）的最大值。
DecimalPrecisionInteger否2自定义参数值（数值）允许的小数点后位数。

请求示例

GET /?Action=DescribeInvocations&Version=2020-04-01&InvocationId=ivk-2a745b412b4601b8d**** HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
Service: ecs

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202106111445100102252431000052****",
        "Action": "DescribeInvocations",
        "Version": "2020-04-01",
        "Service": "ecs",
        "Region": "cn-beijing"
    },
    "Result": {
        "pageNumber": 1,
        "pageSize": 10,
        "totalCount": 17,
        "invocations": [
          {
                "invocationId": "ivk-2a745b412b4601b8d****",
                "invocationName": "修改登录密码",
                "invocationDescription": "",
                "commandId": "cmd-ybtvqkik****",
                "commandName": "修改Linux实例密码",
                "commandType": "Shell",
                "repeatMode": "Once",
                "frequency": "",
                "invocationStatus": "Failed",
                "commandContent": "IyEvYmluL2Jh****8IGNocGFzc3dk",
                "parameters": "{\"username\":\"root\",\"password\":\"111@123\"}",
                "username": "root",
                "workingDir": "/home",
                "timeout": 60,
                "startTime": "2022-11-10T06:49:59Z",
                "endTime": "2022-11-10T06:50:59Z",
                "instanceNumber": 3,
                "enableParameter": true,
                "commandDescription": "脚本描述",
                "commandProvider": "Volcengine",
                "parameterDefinitions": [
                    {
                        "type": "String",
                        "name": "username",
                        "required": true,
                        "defaultValue": "",
                        "minLength": 1,
                        "maxLength": 100,
                        "minValue": "",
                        "maxValue": "",
                        "decimalPrecision": 0
                    },
                    {
                        "type": "String",
                        "name": "password",
                        "required": true,
                        "defaultValue": "",
                        "minLength": 1,
                        "maxLength": 100,
                        "minValue": "",
                        "maxValue": "",
                        "decimalPrecision": 0
                    }
                ],
                "launchTime": "",
                "recurrenceEndTime": ""
            }
        ]
    }
}