弹性高性能计算E-HPC容器应用管理API有哪些?-问答-阿里云开发者社区-阿里云

开发者社区> 问答> 正文

弹性高性能计算E-HPC容器应用管理API有哪些?

小天使爱美 2020-03-23 18:13:59 89

弹性高性能计算E-HPC容器应用管理API有哪些?

API 容器
分享到
取消 提交回答
全部回答(1)
  • 小天使爱美
    2020-03-23 18:37:39

    新增容器应用。

    描述 用户可以新增容器应用。

    注意:新增容器应用操作不会进行镜像的拉取,拉取镜像请参照PullImage。

    请求参数 字段 类型 是否必须 默认值 描述 Action String 是 - 操作接口名,系统规定参数,取值:AddContainerApp RegionId String 是 - 地域ID Name String 是 - 容器名字。长度2-64字符,只允许包含中文、字母、数字、短横线(-)和下划线(_),必须以字母或中文开头。 Description String 否 - 容器描述,长度2-128字符。 Repository String 是 - 仓库名 ImageTag String 否 latest 镜像标签,默认值为latest ContainerType String 否 shifter 容器类型,默认值为shifter, 取值:shifter或docker 返回参数 除公共返回参数外返回如下结果:

    字段 类型 描述 ContainerId List 容器ID列表 示例 请求示例 https://ehpc.cn-hangzhou.aliyuncs.com/?Action=AddContainerApp&RegionId=cn-hangzhou&Repository=busybox&Name=busybox&<公共请求参数> 返回示例 XML格式 04F0F334-1335-436C-A1D7-6C044FE73368 ehpc-container-ABDUGSkjsiDij JSON格式 { "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368", "ContainerId": "ehpc-container-ABDUGSkjsiDij", } 错误码 查询E-HPC接口错误码请访问 错误码。更多错误码,请访问 API 错误中心。

    批量删除容器应用。

    描述 批量删除容器应用,在删除容器应用前,您可以:

    调用ListContainerApps查询容器应用列表 请求参数 字段 类型 是否必须 默认值 描述 Action String 是 - 操作接口名,系统规定参数,取值:DeleteContainerApps RegionId String 是 - 地域ID ContainerApp.n.Id String 是 - 第n个(n从1开始编号,可以有多条)要移除的容器应用ID 返回参数 公共参数,了解更多请参阅 公共参数。

    示例 请求示例 https://ehpc.cn-hangzhou.aliyuncs.com/?Action=DeleteContainerApps&RegionId=cn-hangzhou&ContainerApp.1.Id=ehpc-container-ABDUGSkjsiDij&<公共请求参数> 返回示例 XML格式 04F0F334-1335-436C-A1D7-6C044FE73368 JSON格式 { "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368", } 错误码 查询E-HPC接口错误码请访问 错误码。更多错误码,请访问 API 错误中心。

    删除本地镜像。

    描述 用户可以删除集群已经拉取的镜像。

    请求参数 字段 类型 是否必须 默认值 描述 Action String 是 - 操作接口名,系统规定参数,取值:DeleteImage RegionId String 是 - 地域ID ClusterId String 是 - 集群ID Repository String 是 - 仓库名 ImageTag String 否 latest 镜像标签,默认值:latest ContainerType String 否 shifter 容器应用类型,取值:shifter。默认值:shifter 返回参数 公共参数,了解更多请参阅 公共参数。

    示例 请求示例 https://ehpc.cn-hangzhou.aliyuncs.com/?Action=DeleteImage&RegionId=cn-hangzhou&ClusterId=<集群ID>&Repository=hello-world&<公共请求参数> 返回示例 XML格式 04F0F334-1335-436C-A1D7-6C044FE73368 JSON格式 { "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368" } 错误码 查询E-HPC接口错误码请访问 错误码。更多错误码,请访问 API 错误中心。

    查询单个容器应用。

    描述 用户可以通过容器应用ID查询单个容器应用信息。

    请求参数 字段 类型 是否必须 默认值 描述 Action String 是 - 操作接口名,系统规定参数,取值:DescribeContainerApp RegionId String 是 - 地域ID ContainerId String 是 - 容器应用ID 返回参数 除公共返回参数外返回如下结果:

    字段 类型 描述 ContainerAppInfo ContainerAppInfo 容器应用信息 其中,ContainerAppInfo结构包含以下字段:

    字段 类型 描述 Id String 容器应用ID Name String 容器应用名称 Description String 容器应用描述 Repository String 仓库名 ImageTag String 镜像标签 CreateTime String 创建容器应用时间 Type String 容器应用类型 示例 请求示例 https://ehpc.cn-hangzhou.aliyuncs.com/?Action=DescribeContainerApp&RegionId=cn-hangzhou&ContainerId=ehpc-container-ABDUGSkjsiDij&<公共请求参数> 返回示例 XML格式 04F0F334-1335-436C-A1D7-6C044FE73368 ehpc-container-ABDUGSkjsiDij ExampleName busybox latest 2018-07-18T17:46:47 shifter JSON格式 { "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368", "ContainerAppInfo": { "Id": "ehpc-container-ABDUGSkjsiDij", "Name": "ExampleName", "Description": "", "Repository": "busybox", "ImageTag": "latest", "CreateTime": "2018-07-18T17:46:47", "Type": "shifter", } } 错误码 查询E-HPC接口错误码请访问 错误码。更多错误码,请访问 API 错误中心。

    查询本地单个镜像信息。

    描述 用户可以查询拉取到本集群的单个镜像信息。

    请求参数 字段 类型 是否必须 默认值 描述 Action String 是 - 操作接口名,系统规定参数,取值:DescribeImage RegionId String 是 - 地域ID ClusterId String 是 - 集群ID Repository String 是 - 仓库名 ImageTag String 否 latest 镜像标签,默认值:latest ContainerType String 否 shifter 容器应用类型,取值:shifter。默认值:shifter 返回参数 除公共返回参数外返回如下结果:

    字段 类型 描述 ImageInfo ImageInfo 镜像信息 其中,ImageInfo 结构中包含如下字段:

    字段 类型 描述 System String Shifter系统 Type String 镜像类型 Status String 镜像状态 ImageId String 镜像ID UpdateDateTime String 最后一次update镜像时间 Repository String 仓库名 Tag String 标签 示例 请求示例 https://ehpc.cn-hangzhou.aliyuncs.com/?Action=DescribeImage&RegionId=cn-hangzhou&ClusterId=<集群ID>&Repository=hello-world&<公共请求参数> 返回示例 XML格式 04F0F334-1335-436C-A1D7-6C044FE73368 mycluster docker READY 3535063d99 2018-08-02T20:11:36 hello-world latest JSON格式 { "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368", "ImageInfo": { "System": "mycluster", "Type": "docker", "Status": "READY", "ImageId": "3535063d99", "UpdateDateTime": "2018-08-02T20:11:36", "Repository": "hello-world", "Tag": "latest" } } 错误码 查询E-HPC接口错误码请访问 错误码。更多错误码,请访问 API 错误中心。

    查询镜像网关配置文件。

    描述 用户可以查询镜像网关配置文件。

    注意:该API暂时只支持查询Shifter的配置文件。

    请求参数 字段 类型 是否必须 默认值 描述 Action String 是 - 操作接口名,系统规定参数,取值:DescribeImageGatewayConfig RegionId String 是 - 地域ID ClusterId String 是 - 集群ID ContainerType String 否 shifter 容器应用类型,取值:shifter。默认值:shifter 返回参数 除公共返回参数外返回如下结果:

    字段 类型 描述 Imagegw Imagegw 镜像网关配置文件信息 其中,Imagegw 结构中包含如下字段:

    字段 类型 描述 DefaultImageLocation String 默认仓库源址 PullUpdateTimeout Integer 拉取镜像时间限制 MongoDBURI String 镜像网关数据库信息 ImageExpirationTimeout String 镜像失效时间限制 Locations Array 仓库源址数组 其中,LocationInfo结构中包含如下字段:

    字段 类型 描述 Location String 仓库源址 Remotetype String 类型 Authentication String 认证 URL String 仓库源址URL 示例 请求示例 https://ehpc.cn-hangzhou.aliyuncs.com/?Action=DescribeImageGatewayConfig&RegionId=cn-hangzhou&ClusterId=<集群ID>&<公共请求参数> 返回示例 XML格式 04F0F334-1335-436C-A1D7-6C044FE73368 registry-1.docker.io 300 mongodb://localhost 90:00:00:00 registry-1.docker.io dockerv2 http registry.docker-cn.com dockerv2 https https://registry.docker-cn.com JSON格式 { "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368", "DefaultImageLocation": "registry-1.docker.io", "PullUpdateTimeout": 300, "MongoDBURI": "mongodb://localhost", "ImageExpirationTimeout": "90:00:00:00", "Locations": { "LocationInfo": [ { "Location": "registry-1.docker.io", "Remotetype": "dockerv2", "Authentication": "http" }, { "Location": "registry.docker-cn.com", "Remotetype": "dockerv2", "Authentication": "https", "URL": "https://registry.docker-cn.com" } ] } } 错误码 查询E-HPC接口错误码请访问 错误码。更多错误码,请访问 API 错误中心。

    查询本地镜像列表。

    描述 用户可以查询拉取到本集群的镜像列表。

    请求参数 字段 类型 是否必须 默认值 描述 Action String 是 - 操作接口名,系统规定参数,取值:ListContainerImages RegionId String 是 - 地域ID ClusterId String 是 - 集群ID ContainerType String 否 shifter 容器应用类型,取值:shifter。默认值:shifter PageNumber Integer 否 1 当前页码 PageSize Integer 否 10 本页条数 返回参数 除公共返回参数外返回如下结果:

    字段 类型 描述 Images Array 镜像信息数组 DBInfo String 数据库信息 TotalCount Integer 列表条目总数 PageNumber Integer 当前页码 PageSize Integer 本页条数 其中,ImagesItem 结构中包含如下字段:

    字段 类型 描述 System String Shifter系统 Type String 镜像类型 Status String 镜像状态 ImageId String 镜像ID UpdateDateTime String 最后一次update镜像时间 Repository String 仓库名 Tag String 标签 示例 请求示例 https://ehpc.cn-hangzhou.aliyuncs.com/?Action=ListContainerImages&RegionId=cn-hangzhou&ClusterId=<集群ID>&<公共请求参数> 返回示例 XML格式 04F0F334-1335-436C-A1D7-6C044FE73368 1 1 1 mongodb://localhost/ mycluster docker READY 3535063d99 2018-08-02T20:11:36 hello-world latest JSON格式 { "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368", "TotalCount": 1, "PageNumber": 1, "PageSize": 1, "DBInfo": "mongodb://localhost/", "Images": { "ImagesItem": [ { "System": "mycluster", "Type": "docker", "Status": "READY", "ImageId": "3535063d99", "UpdateDateTime": "2018-08-02T20:11:36", "Repository": "hello-world", "Tag": "latest" } ] } } 错误码 查询E-HPC接口错误码请访问 错误码。更多错误码,请访问 API 错误中心。

    修改容器应用属性。

    描述 用户可以对容器应用的属性进行修改,目前仅支持修改容器应用描述。

    请求参数 字段 类型 是否必须 默认值 描述 Action String 是 - 操作接口名,系统规定参数,取值:ModifyContainerAppAttributes RegionId String 是 - 地域ID ContainerId String 是 - 容器应用ID Description String 否 - 容器应用新描述,长度2-128字符。 返回参数 公共参数,了解更多请参阅 公共参数。

    示例 请求示例 https://ehpc.cn-hangzhou.aliyuncs.com/?Action=ModifyContainerAppAttributes&RegionId=cn-hangzhou&ContainerId=<容器应用ID>&Name=busybox&<公共请求参数> 返回示例 XML格式 04F0F334-1335-436C-A1D7-6C044FE73368 JSON格式 { "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368", } 错误码 查询E-HPC接口错误码请访问 错误码。更多错误码,请访问 API 错误中心。

    修改镜像网关配置文件。

    描述 用户可以修改镜像网关配置文件。

    注意:在设置DefaultRepoLocation前请调用DescribeImageGatewayConfig来确认仓库源址数组中有该源址,如果没有,请先调用该接口修改镜像网关配置文件进行仓库源址的增加。

    请求参数 字段 类型 是否必须 默认值 描述 Action String 是 - 操作接口名,系统规定参数,取值:ModifyImageGatewayConfig RegionId String 是 - 地域ID ClusterId String 是 - 集群ID DBType String 否 mongodb 数据库类型,默认值:mongodb DBUsername String 否 - 数据库用户名,比如:root DBPassword String 否 - 数据库用户密码 DBServerInfo String 否 - 数据库URI信息,比如:dds-uf6628e4287716b433270.mongodb.rds.aliyuncs.com:3717/admin DefaultRepoLocation String 否 registry-1.docker.io 默认仓库服务 Repo.n.Location String 否 - 第n个(n从1开始编号,可以有多条)仓库地址。 Repo.n.Auth String 否 http 仓库的authentication,取值:http、https,默认值:http Repo.n.URL String 否 - 仓库的URL,如果要增加仓库源址,必须提供URL。比如:https://registry.docker-cn.com PullUpdateTimeout Integer 否 300 拉取镜像时间限制 ImageExpirationTimeout String 否 90:00:00:00 删除镜像时间限制 注意:DBType、DBUsername、DBPassword、DBServerInfo这四个数据库信息字段必须一起填写。

    返回参数 公共参数,了解更多请参阅 公共参数。

    示例 请求示例 https://ehpc.cn-hangzhou.aliyuncs.com/?Action=ModifyImageGatewayConfig&RegionId=cn-hangzhou&ClusterId=<集群ID>&Repo.1.Location=registry.docker-cn.com&Repo.1.Auth=https&Repo.1.URL=https://registry.docker-cn.com&<公共请求参数> 返回示例 XML格式 04F0F334-1335-436C-A1D7-6C044FE73368 JSON格式 { "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368", } 错误码 查询E-HPC接口错误码请访问 错误码。更多错误码,请访问 API 错误中心。

    0 0
云原生
使用钉钉扫一扫加入圈子
+ 订阅

云原生时代,是开发者最好的时代

推荐文章
相似问题
推荐课程