ListEdgeContainerAppVersions - 获取边缘容器应用的版本列表

更新时间:
复制 MD 格式

获取边缘容器应用的版本列表,包括用户创建成功的所有应用列表信息。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

esa:ListEdgeContainerAppVersions

none

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

AppId

string

应用 ID,可使用 ListEdgeContainerApps 接口获取应用 ID。

app-88068867578379****

PageNumber

integer

页码。取值:1~65535之间的任意整数。

1

PageSize

integer

页大小。取值:1~100之间的任意整数。

10

OrderKey

string

排序字段,取值如下:

  • Name:版本名称。

  • CreateTime:版本创建时间。

  • ModifyTime:版本修改时间。

Name

OrderType

string

排序方向。取值:

  • Asc:升序排列

  • Desc:降序排列

Desc

SearchType

string

模糊查找的类型,支持 VersionId,Name。

VersionId

SearchKey

string

查询参数。

ver-100568263967926****

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

F61CDR30-E83C-4FDA-BF73-9A94CDD44229

PageNumber

integer

返回数据的页码。

1

PageSize

integer

页大小。

10

TotalCount

integer

总条数。

20

Versions

array<object>

版本列表。

array<object>

描述版本信息对象。

LastPublishTime

string

该版本上次的发布时间。日期格式按照 ISO8601 表示法,并使用 UTC 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。

2023-02-10T02:48:36Z

PublishTime

string

版本的本次发布时间。日期格式按照 ISO8601 表示法,并使用 UTC 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。

2023-02-10T02:48:36Z

Status

string

当前版本的状态。取值:

  • created:创建成功。

  • failed:创建失败。

  • creating:创建中。

created

CreateTime

string

版本创建时间。日期格式按照 ISO8601 表示法,并使用 UTC 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。

2022-11-10T02:53:16Z

AppId

string

应用版本归属的应用 ID。

app-88068867578379****

VersionId

string

版本 ID。

ver-87962637161651****

Name

string

版本名称。

version01

UpdateTime

string

版本的上次修改时间。日期格式按照 ISO8601 表示法,并使用 UTC 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。

2023-04-16 10:51:00

Remarks

string

备注信息

test version

Containers

array<object>

该版本包含的容器数组。

array<object>

该版本包含的容器数组。

EnvVariables

string

容器环境变量。

ENV=prod

Args

string

容器启动参数。

-c a=1

Spec

string

容器规格。

1C2G

Image

string

容器镜像地址。

nginx

Command

string

容器启动命令。

openresty -g \"daemon off;\"

ProbeType

string

容器探针类型。

httpGet

Name

string

容器名称。

container1

PreStop

string

容器停止前执行命令。

sh prestop.sh "echo hello world"

PostStart

string

容器启动前执行命令。

sh poststart.sh "echo hello world"

ProbeContent

object

描述容器探针的具体对象。

SuccessThreshold

integer

容器的健康检查连续成功次数。

1

Host

string

容器健康检查的域名。

test.com

HttpHeaders

string

容器健康检查携带请求头。

{\"Content-Type\":\"application/json\"}

Scheme

string

容器健康检查请求协议。

http

InitialDelaySeconds

integer

容器探针初始化延迟时间。

10

Command

string

探针运行命令。

openresty -g "daemon off;

FailureThreshold

integer

容器健康检查连续失败次数。

3

TimeoutSeconds

integer

容器健康检查的超时时间。

30

Path

string

容器健康检查的路径。

/health_check

Port

integer

容器健康检查的端口。

80

PeriodSeconds

integer

容器健康检查的间隔时间。

5

示例

正常返回示例

JSON格式

{
  "RequestId": "F61CDR30-E83C-4FDA-BF73-9A94CDD44229",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 20,
  "Versions": [
    {
      "LastPublishTime": "2023-02-10T02:48:36Z\n",
      "PublishTime": "2023-02-10T02:48:36Z",
      "Status": "created",
      "CreateTime": "2022-11-10T02:53:16Z",
      "AppId": "app-88068867578379****",
      "VersionId": "ver-87962637161651****",
      "Name": "version01",
      "UpdateTime": "2023-04-16 10:51:00",
      "Remarks": "test version",
      "Containers": [
        {
          "EnvVariables": "ENV=prod",
          "Args": "-c a=1",
          "Spec": "1C2G",
          "Image": "nginx",
          "Command": "openresty -g \\\"daemon off;\\\"",
          "ProbeType": "httpGet",
          "Name": "container1",
          "PreStop": "sh prestop.sh \"echo hello world\" ",
          "PostStart": "sh poststart.sh \"echo hello world\" ",
          "ProbeContent": {
            "SuccessThreshold": 1,
            "Host": "test.com",
            "HttpHeaders": "{\\\"Content-Type\\\":\\\"application/json\\\"}",
            "Scheme": "http",
            "InitialDelaySeconds": 10,
            "Command": "openresty -g  \"daemon off;",
            "FailureThreshold": 3,
            "TimeoutSeconds": 30,
            "Path": "/health_check",
            "Port": 80,
            "PeriodSeconds": 5
          }
        }
      ]
    }
  ]
}

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidParameter.OrderType The specified OrderType is invalid. Please check the OrderType parameter. You may not have set it to either Asc or Desc. Please make the necessary changes and call the interface again. OrderType参数无效。请检查OrderType参数,你有可能未设置为 Asc、Desc其中一种,请进行修改后,重新调用接口。
400 InvalidParameter.OrderKey The specified OrderKey is invalid. Please check the OrderKey parameter. OrderKey参数无效。请检查OrderKey参数,该参数不能赋值为非法字符如 @、#、% 等,请进行修改后,重新调用接口。
400 InvalidParameter Invalid parameter. Check the parameter configuration. 参数正确性校验失败,请检查的参数内容。
400 InvalidParameter.appid The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID. 传入的应用ID格式不正确,可使用ListEdgeContainerApps接口获取应用ID。
400 InvalidPageSize.ValueNotSupported The PageSize value is invalid. The default value is set to 20. The acceptable range is between 1 and 500. 请求PageSize值非法,默认取值为20,取值区间为1-500。
500 InternalError Failed to call the service. Try again later or contact technical support. 调用服务失败,请稍后重试或联系客服咨询详情。
404 InvalidApp.NotFound The application does not exist. Check whether the application ID you specified is correct and try again. 您传入的应用ID对应的应用不存在,请检查后重试。

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

变更历史

更多信息,参考变更详情