首页 边缘安全加速 边缘安全加速 ESA 开发参考 API参考 API目录 边缘计算 边缘容器 GetEdgeContainerAppVersion - 获取边缘容器应用的版本信息

GetEdgeContainerAppVersion - 获取边缘容器应用的版本信息

更新时间: 2024-12-26 17:13:40

获取边缘容器应用的版本信息,通过版本信息选择某个版本进行发布。

调试

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

授权信息

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

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

请求参数

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

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

app-88068867578379****
VersionIdstring

版本 ID,可使用 ListEdgeContainerAppVersions 接口获取版本 ID。

ver-87962637161651****

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

04F0F334-1335-436C-A1D7-6C044FE73368
Versionobject

版本信息。

LastPublishTimestring

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

2023-07-25T04:58:05Z
PublishTimestring

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

2022-11-14T02:04:03Z
Statusstring

当前版本的状态。取值:

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

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

2022-07-01T09:32:33Z
AppIdstring

应用 ID。

app-88068867578379****
VersionIdstring

返回创建的版本的 ID。

ver-87962637161651****
Namestring

版本名称。

test
UpdateTimestring

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

2021-12-03T10:52:52Z
Remarksstring

备注信息。

aaa
Containersarray<object>

该版本要部署的镜像列表。

ContainerItemobject

描述单个容器具体信息的对象。

EnvVariablesstring

环境变量

ENV=prod
Argsstring

启动参数。

-c /path/config.toml
Specstring

规格

1C2G
Storagestring

容器存储规格。

0.5G, 标识存储空间,取值范围(0.5G | 10G | 20G | 30G)
IsACRImageboolean

是否为 ACR 镜像。

false
ACRImageInfoobject

ACR 镜像信息。

Domainstring

ACR 镜像域名。

*.mooc.seewo.com
InstanceIdstring

ACR 站点实例 ID。

xcdn-9ak2thl14z5s
RegionIdstring

区域 ID。

cn-hangzhou
RepoIdstring

镜像仓库 ID。

crr-zeu0xyk28alyxozh
RepoNamestring

镜像仓库的名称。

test_1
RepoNamespacestring

镜像仓库的命名空间。

wpy1
Tagstring

标签值。

test-healthy-100-soa-1710987653
TagUrlstring

ACR 镜像标签地址。

registry-vpc.cn-shenzhen.aliyuncs.com/lihetech/easywits_server_exam:3.40.2
IsEnterpriseRegistryboolean

是否为企业级镜像。

false
Imagestring

镜像地址

nginx:1.14.0
Commandstring

容器启动命令。

sh abc.sh 1 2 3
ProbeTypestring

探针类型。

httpGet
Namestring

版本名称。

version01
PreStopstring

容器停止前执行命令。

sh prestop.sh "echo hello world"
PostStartstring

容器启动前执行命令。

sh poststart.sh "echo hello world"
ProbeContentobject

探针内容。

SuccessThresholdinteger

健康检查连续成功次数。

1
Hoststring

健康检查的域名。

test.com
HttpHeadersstring

HTTP 请求头。

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

健康检查的请求协议。

http
InitialDelaySecondsinteger

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

20
Commandstring

探针运行命令。

sh test.sh
FailureThresholdinteger

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

3
TimeoutSecondsinteger

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

5
Pathstring

容器健康检查的路径。

/health_check
Portinteger

后端服务器使用的端口。取值范围:1~65535

80
PeriodSecondsinteger

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

5

示例

正常返回示例

JSON格式

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "Version": {
    "LastPublishTime": "2023-07-25T04:58:05Z",
    "PublishTime": "2022-11-14T02:04:03Z",
    "Status": "created",
    "CreateTime": "2022-07-01T09:32:33Z",
    "AppId": "app-88068867578379****",
    "VersionId": "ver-87962637161651****",
    "Name": "test",
    "UpdateTime": "2021-12-03T10:52:52Z",
    "Remarks": "aaa",
    "Containers": [
      {
        "EnvVariables": "ENV=prod",
        "Args": "-c /path/config.toml",
        "Spec": "1C2G",
        "Storage": "0.5G, 标识存储空间,取值范围(0.5G | 10G | 20G | 30G)",
        "IsACRImage": false,
        "ACRImageInfo": {
          "Domain": "*.mooc.seewo.com",
          "InstanceId": "xcdn-9ak2thl14z5s",
          "RegionId": "cn-hangzhou",
          "RepoId": "crr-zeu0xyk28alyxozh",
          "RepoName": "test_1",
          "RepoNamespace": "wpy1",
          "Tag": "test-healthy-100-soa-1710987653",
          "TagUrl": "registry-vpc.cn-shenzhen.aliyuncs.com/lihetech/easywits_server_exam:3.40.2",
          "IsEnterpriseRegistry": false
        },
        "Image": "nginx:1.14.0",
        "Command": "sh abc.sh 1 2 3",
        "ProbeType": "httpGet",
        "Name": "version01",
        "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": 20,
          "Command": "sh test.sh",
          "FailureThreshold": 3,
          "TimeoutSeconds": 5,
          "Path": "/health_check",
          "Port": 80,
          "PeriodSeconds": 5
        }
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidParameterThe specified parameter is invalid.输入参数规范校验失败。
400InvalidParameter.appidThe format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.传入的应用ID格式不正确,可使用ListEdgeContainerApps接口获取应用ID。
400InvalidVersion.NotFoundThe version does not exist.这个版本号不存在。
400InvalidParameter.VersionIdThe specified VersionId is invalid.  Please check the VersionId parameter. You may not have entered the parameter or the parameter does not start with ver-string. Please modify it and call the interface again.VersionId参数无效。请检查VersionId参数,你有可能未输入该参数或者,参数并未以ver-字符串开头,请进行修改后,重新调用接口。
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 返回结构发生变更查看变更详情
上一篇: GetEdgeContainerDeployRegions - 获取边缘容器应用部署区域 下一篇: GetEdgeContainerAppStatus - 获取边缘容器的应用状态信息