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

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

调试

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

授权信息

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

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

请求参数

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

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

app-88068867578379****
PageNumberinteger

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

1
PageSizeinteger

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

10
OrderKeystring

排序字段,取值如下:

  • Name:版本名称。
  • CreateTime:版本创建时间。
  • UpdateTime:版本修改时间。
Name
OrderTypestring

排序方向。取值:

  • ASC:升序排列

  • DESC:降序排列

DESC
SearchTypestring

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

VersionId
SearchKeystring

查询参数。

ver-100568263967926****

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

F61CDR30-E83C-4FDA-BF73-9A94CDD44229
PageNumberinteger

返回数据的页码。

1
PageSizeinteger

页大小。

10
TotalCountinteger

总条数。

20
Versionsarray<object>

版本列表。

Versionobject

描述版本信息对象。

LastPublishTimestring

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

2023-02-10T02:48:36Z
PublishTimestring

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

2023-02-10T02:48:36Z
Statusstring

当前版本的状态。取值:

  • created:创建成功。
  • failed:创建失败。
  • creating:创建中。
created
CreateTimestring

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

2022-11-10T02:53:16Z
AppIdstring

应用版本归属的应用 ID。

app-88068867578379****
VersionIdstring

版本 ID。

ver-87962637161651****
Namestring

版本名称。

version01
UpdateTimestring

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

2023-04-16 10:51:00
Remarksstring

备注信息

test version
Containersarray<object>

该版本包含的容器数组。

Containerobject

该版本包含的容器数组。

EnvVariablesstring

容器环境变量。

ENV=prod
Argsstring

容器启动参数。

-c a=1
Specstring

容器规格。

1C2G
Imagestring

容器镜像地址。

nginx
Commandstring

容器启动命令。

openresty -g \"daemon off;\"
ProbeTypestring

容器探针类型。

httpGet
Namestring

容器名称。

container1
PreStopstring

容器停止前执行命令。

sh prestop.sh "echo hello world"
PostStartstring

容器启动前执行命令。

sh poststart.sh "echo hello world"
ProbeContentobject

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

SuccessThresholdinteger

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

1
Hoststring

容器健康检查的域名。

test.com
HttpHeadersstring

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

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

容器健康检查请求协议。

http
InitialDelaySecondsinteger

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

10
Commandstring

探针运行命令。

openresty -g "daemon off;
FailureThresholdinteger

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

3
TimeoutSecondsinteger

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

30
Pathstring

容器健康检查的路径。

/health_check
Portinteger

容器健康检查的端口。

80
PeriodSecondsinteger

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

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错误码错误信息描述
400InvalidParameter.OrderTypeThe 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其中一种,请进行修改后,重新调用接口。
400InvalidParameter.OrderKeyThe specified OrderKey is invalid. Please check the OrderKey parameter.OrderKey参数无效。请检查OrderKey参数,该参数不能赋值为非法字符如 @、#、% 等,请进行修改后,重新调用接口。
400InvalidParameterInvalid parameter. Check the parameter configuration.参数正确性校验失败,请检查的参数内容。
400InvalidParameter.appidThe format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.传入的应用ID格式不正确,可使用ListEdgeContainerApps接口获取应用ID。
400InvalidPageSize.ValueNotSupportedThe PageSize value is invalid. The default value is set to 20. The acceptable range is between 1 and 500.请求PageSize值非法,默认取值为20,取值区间为1-500。
404InvalidApp.NotFoundThe application does not exist. Check whether the application ID you specified is correct and try again.您传入的应用ID对应的应用不存在,请检查后重试。
500InternalErrorFailed to call the service. Try again later or contact technical support.调用服务失败,请稍后重试或联系客服咨询详情。

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

变更历史

变更时间变更内容概要操作
2024-11-12OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情