文档

ListScripts - 查询脚本

更新时间:

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。

cn-hangzhou
ClusterIdstring

集群 ID。

c-b933c5aac8fe****
NextTokenstring

标记当前开始读取的位置。

dd6b1b2a-5837-5237-abe4-ff0c89568980
MaxResultsinteger

一次获取的最大记录数。

10
ScriptTypestring

集群脚本类型。取值范围:

  • BOOTSTRAP:引导脚本。
  • NORMAL:普通集群脚本。
BOOTSTRAP

返回参数

名称类型描述示例值
object

返回数据

Scriptsobject []

脚本列表。

Actionstring

API 名称。

ListScripts
RegionIdstring

区域 ID。

cn-hangzhou
ScriptIdstring

脚本 ID。

cs-bf25219d103043a0820613e32781****
ScriptNamestring

脚本名称。

check_env
ScriptPathstring

脚本路径。

oss://bucket1/check_evn.sh
ScriptArgsstring

脚本执行参数。

--mode=client -h -p
LastUpdateTimelong

最近一次修改时间。

1639714634819
ExecutionFailStrategystring

执行失败策略。取值范围:

  • FAILED_CONTINUE:失败后继续执行。
  • FAILED_BLOCK:失败后阻塞。
FAILED_CONTINUE
ExecutionMomentstring

执行时机。取值范围:

  • BEFORE_INSTALL:应用安装之前。
  • AFTER_STARTED: 应用启动后。
BEFORE_INSTALL
NodeSelectorNodeSelector

节点选择器。

StartTimelong

开始执行时间。只有当 ScriptType 取值为 NORMAL,才有该返回值。

1639714634000
EndTimelong

结束执行时间。只有当 ScriptType 取值为 NORMAL,才有该返回值。

1639715635819
ExecutionStatestring

脚本执行的状态,只有当ScriptType取值为NORMAL,才有该返回值 。取值范围:

  • SCRIPT_COMPLETED:脚本执行成功。
  • SCRIPT_SUBMISSION_FAILED:脚本执行失败。
  • SCRIPT_RUNNING:脚本执行中。
SCRIPT_COMPLETED
RequestIdstring

请求 ID。

DD6B1B2A-5837-5237-ABE4-FF0C8944****
NextTokenstring

返回读取到的数据位置。

dd6b1b2a-5837-5237-abe4-ff0c89568982
MaxResultsinteger

本次请求所返回的最大记录条数。

10
TotalCountinteger

本次请求条件下的数据总量。

200

示例

正常返回示例

JSON格式

{
  "Scripts": [
    {
      "Action": "ListScripts",
      "RegionId": "cn-hangzhou",
      "ScriptId": "cs-bf25219d103043a0820613e32781****",
      "ScriptName": "check_env",
      "ScriptPath": "oss://bucket1/check_evn.sh",
      "ScriptArgs": "--mode=client -h -p",
      "LastUpdateTime": 1639714634819,
      "ExecutionFailStrategy": "FAILED_CONTINUE",
      "ExecutionMoment": "BEFORE_INSTALL",
      "NodeSelector": {
        "NodeSelectType": "CLUSTER",
        "NodeNames": [
          "master-1-1"
        ],
        "NodeGroupId": "ng-869471354ecd****",
        "NodeGroupTypes": [
          "MASTER"
        ],
        "NodeGroupName": "master-1"
      },
      "StartTime": 1639714634000,
      "EndTime": 1639715635819,
      "ExecutionState": "SCRIPT_COMPLETED"
    }
  ],
  "RequestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****",
  "NextToken": "dd6b1b2a-5837-5237-abe4-ff0c89568982",
  "MaxResults": 10,
  "TotalCount": 200
}

错误码

HTTP status code错误码错误信息描述
400ConflictParametersParameters that must not be used together. %s多个参数间存在冲突。
400IncompleteSignatureThe request signature is invalid.API请求签名不合法。
400InvalidActionThe action %s requested is invalid.不合法的Action。
400InvalidParameterThe specified parameter %s is not valid.参数错误。
400InvalidParameterValueThe input parameter %s is invalid or out of range.参数值超出范围。
400MissingActionThe action %s requested is missing.缺少Action参数
400MissingParameterThe input parameter %s that is mandatory for processing this request is not supplied.参数缺失。
400NotAuthorizedYou do not have permission to perform this action. %s没有权限。
400ThrottlingExceptionThe request was denied due to request throttling. %s限流。
404ResourceNotFoundThe resource not found by %s.请求的资源未找到。
500InternalErrorThe request processing has failed due to some unknown error, exception or failure.内部错误。
503ServiceFailureThe request has failed due to a temporary failure of %s service.依赖的阿里云其他服务不可用。
503ServiceUnavailableThe request has failed due to a temporary failure of the server.请求超时或者服务不可用。

访问错误中心查看更多错误码。

  • 本页导读 (1)
文档反馈