ListCommands - 查看交互执行命令列表

调用ListCommands查看指定集群内的交互命令列表。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ehpc:ListCommandsRead
  • 全部资源
    *

请求参数

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

集群 ID。

您可以通过调用 ListClusters 获取集群 ID。

ehpc-hz-FYUr32****
CommandIdstring

命令 ID。

c-hz01v8vudql****
PageNumberinteger

当前页码。

起始值:1。

默认值:1。

1
PageSizeinteger

每页显示的行数。
取值范围:1~50。
默认值:10。

10

返回参数

名称类型描述示例值
object
PageSizeinteger

本页条数。

10
RequestIdstring

请求 ID。

04F0F334-1335-436C-A1D7-6C044FE7****
PageNumberinteger

当前页码。

1
TotalCountinteger

列表条目总数。

1
Commandsobject []

命令列表。

Timeoutstring

超时时间。单位为秒。

60
CommandIdstring

命令 ID。

c-hz01v8vudql****
WorkingDirstring

命令工作目录。

/home
CommandContentstring

命令内容。

echo "hello world"

示例

正常返回示例

JSON格式

{
  "PageSize": 10,
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE7****",
  "PageNumber": 1,
  "TotalCount": 1,
  "Commands": {
    "Command": [
      {
        "Timeout": "60",
        "CommandId": "c-hz01v8vudql****",
        "WorkingDir": "/home",
        "CommandContent": "echo \"hello world\""
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidParamsThe specified parameter %s is invalid.无效的参数:%s
400NotEnabledYou have not enabled this service您的账户还未开通此服务
400InDebtYour account has overdue payments.您的账户已欠费
403InvalidClusterStatusThe operation failed due to invalid cluster status.集群状态不允许执行本次操作。
403ConflictOptA conflicting operation is running.有冲突的操作在执行中,请您稍后再试。
404ClusterNotFoundThe specified cluster does not exist.指定的集群不存在,请您检查该参数是否正确。
404ObjectNotFoundThe specified object is not found.指定的对象未找到,请您检查该参数是否正确。
406EcsErrorAn error occurred while calling the ECS API operation.ECS API调用出错
406AgentErrorThe agent service request failed.集群侧命令运行失败
406AliyunErrorAn Alibaba Cloud product error occurred.阿里云产品错误
407NotAuthorizedYou are not authorized by RAM for this request.此请求未获得RAM授权
409PartFailurePart of the batch operation failed.批量操作部分失败
500UnknownErrorAn unknown error occurred.未知错误
503ServiceUnavailableThe request has failed due to a temporary failure of the server请求失败,服务暂时不可用

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