AI 助理
备案控制台
文档
输入文档关键字查找
首页 计算巢服务 开发参考 服务商侧API参考 API目录 部署物 UpdateArtifact - 更新部署物

UpdateArtifact - 更新部署物

更新时间：
产品详情
我的收藏

调用UpdateArtifact更新部署物。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
ArtifactIdstring是

部署物 ID。

您可以通过调用ListArtifacts - 查询部署物列表获取部署物 ID。

artifact-eea08d1e2d3a43ae****
VersionNamestring是

部署物版本名称。

v1
Descriptionstring否

部署物描述。

Redhat8_0镜像
ArtifactPropertyobject是

部署物内容。

Urlstring否

文件部署物 URL。

您可以通过对象存储控制台上传并获取文件 URL.

https://service-info-private.oss-cn-hangzhou.aliyuncs.com/130920852865****/template/2e1ce8fc-****-481c-9e8e-789ba9db487d.json
RegionIdstring否

镜像地域。

说明 该参数仅部署物为镜像部署物时可设置。
cn-hangzhou
ImageIdstring否

镜像 ID。

当您选定 RegionId 时，您可以调用DescribeImages - 查询可以使用的镜像资源查看指定地域下可用的镜像 ID。

说明 该参数仅部署物为镜像部署物时可设置。
m-0xij191j9cuev6uc****
CommodityCodestring否

云市场商品 code。

您可以通过云市场控制台获取商品 Code。

说明 该参数仅部署物为镜像部署物时可设置。
cmjj00****
CommodityVersionstring否

云市场商品版本。

您可以通过云市场页面查看云市场商品版本。

说明 该参数仅部署物为镜像部署物时可设置。
V1.0
RepoNamestring否

指定镜像仓库名称。

说明 该参数仅部署物为容器镜像部署物和 HelmChart 部署物时可设置。
wordpress
RepoIdstring否

镜像仓库 ID。

您可以通过调用ListAcrImageRepositories - 查看已上传至 ACR 的镜像列表获取镜像仓库 ID。

说明 该参数仅部署物为容器镜像部署物和 HelmChart 部署物时可设置。
crr-d8o1nponyc2t****
Tagstring否

镜像仓库对应的版本。

您可以通过调用ListAcrImageTags - 查看镜像仓库中已上传的镜像版本获取镜像仓库对应的版本。

说明 该参数仅部署物为容器镜像部署物和 HelmChart 部署物时可设置。
v1
RepoTypestring否

仓库权限类型，取值：

  • Public：公开仓库

  • Private：私有仓库

说明 该参数仅部署物为容器镜像部署物和 HelmChart 部署物时可设置。
Public
SupportRegionIdsarray否

支持镜像分发的地域 ID。

string否

支持镜像分发的地域 ID。

说明 该参数仅部署物为 ECS 镜像部署物时可设置。
["cn-hangzhou","cn-beijing"]
ArtifactBuildPropertyobject否

部署物构建内容，用于托管构建部署物

CommandTypestring否

命令类型。取值范围：

  • RunBatScript：命令为在 Windows 实例中运行的 Bat 脚本。
  • RunPowerShellScript：命令为在 Windows 实例中运行的 PowerShell 脚本。
  • RunShellScript：命令为在 Linux 实例中运行的 Shell 脚本。
说明 该参数仅部署物为 ECS 镜像部署物时可设置。
RunShellScript
CommandContentstring否

命令内容。

说明 该参数仅部署物为 ECS 镜像部署物时可设置。
echo "start run command"
SourceImageIdstring否

源镜像 ID。支持两种类型：

  • 镜像 ID：直接传入 Ecs 镜像的镜像 ID。
  • oos 公共参数名称：支持通过 oos 公共参数名称自动获取该参数对应的镜像 ID。
说明 该参数仅部署物为 ECS 镜像部署物时可设置。
镜像ID：m-t4nhenrdc38pe4***** ubuntu_22_04_x64_20G_alibase_20240926.vhd oos公共参数名称：aliyun/services/computenest/images/aliyun_3_2104_python_3_11
RegionIdstring否

源镜像所在的地域 ID

说明 该参数仅部署物为 ECS 镜像部署物时可设置。
cn-hangzhou
CodeRepoobject否

代码仓库地址。

说明 该参数仅 ArtifactBuildType 为 Dockerfile 或 Buildpacks 时可设置。
Platformstring否

代码仓库所在平台。取值范围：

  • github
  • gitee
github
RepoNamestring否

仓库名称。

aliyun-computenest/quickstart-Lobexxx
Ownerstring否

代码仓库的拥有者。

说明 该参数仅代码仓库为私有仓库时需填写。
aliyun-computenest
Branchstring否

代码仓库分支名称。

main
DockerfilePathstring否

Dockerfile 文件在代码仓库中的相对地址。

默认值：Dockerfile

说明 该参数仅 ArtifactBuildType 为 Dockerfile 时可设置。
./file/Dockerfile
BuildArgsarray<object>否

构建参数。

说明 该参数仅 ArtifactBuildType 为 Dockerfile 时可设置。
object否

用于 docker build --build-arg

ArgumentNamestring否

构建参数的 name。

ENV
ArgumentValuestring否

构建参数的 value。

nginx:latest
SourceContainerImagestring否

源容器镜像的拉取地址。

用于 docker pull ${SourceContainerImage}

说明 该参数仅 ArtifactBuildType 为 ContainerImage 时可设置。
pytorch/pytorch:2.5.1-cuda12.4-cudnn9-devel
ClientTokenstring否

保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符，且不能超过 64 个字符。

10CM943JP0EN9D51H

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

9F350409-2ACC-5B61-ACD9-3C8995792F8F
ArtifactIdstring

部署物 ID。

artifact-eea08d1e2d3a43ae****
ArtifactTypestring

部署物类型。

EcsImage
VersionNamestring

部署物名称。

v1
ArtifactVersionstring

部署物版本。

2
Descriptionstring

部署物描述。

Redhat8_0镜像
GmtModifiedstring

修改时间。

2022-10-20T02:19:55Z
Statusstring

部署物的状态。

取值：

  • Created：已创建。

  • Scanning：扫描中。

  • ScanFailed：扫描失败。

  • Delivering：分发中。

  • Available：可使用。

  • Deleted：已删除。

Available
ArtifactPropertystring

部署物内容。

{\"CommodityCode\":\"cmjj0005****\",\"CommodityVersion\":\"V2022****\"}
SupportRegionIdsstring

部署物支持分发的地域 ID。

[ "cn-beijing", "cn-hangzhou", "cn-shanghai" ]
ArtifactBuildPropertystring

部署物构建内容，用于托管构建部署物。

"{\"RegionId\":\"xxx\", \"SourceImageId\":\"xxx\", \"\":\"xxx\", \"CommandType\":\"xxx\", \"CommandContent\":\"xxx\"}"
StatusDetailstring

部署物的状态描述。

"/usr/local/share/aliyun-assist/work/script/t-hz04zm90y6og0sg.sh: line 1: pip: command not found"
ArtifactBuildTypestring

部署物构建内容，用于托管构建部署物。

"{\"RegionId\":\"xxx\", \"SourceImageId\":\"xxx\", \"\":\"xxx\", \"CommandType\":\"xxx\", \"CommandContent\":\"xxx\"}"

示例

正常返回示例

JSON格式

{
  "RequestId": "9F350409-2ACC-5B61-ACD9-3C8995792F8F",
  "ArtifactId": "artifact-eea08d1e2d3a43ae****",
  "ArtifactType": "EcsImage",
  "VersionName": "v1",
  "ArtifactVersion": "2",
  "Description": "Redhat8_0镜像",
  "GmtModified": "2022-10-20T02:19:55Z",
  "Status": "Available",
  "ArtifactProperty": "{\\\"CommodityCode\\\":\\\"cmjj0005****\\\",\\\"CommodityVersion\\\":\\\"V2022****\\\"}",
  "SupportRegionIds": "[\n\t\t\t\"cn-beijing\",\n\t\t\t\"cn-hangzhou\",\n\t\t\t\"cn-shanghai\"\n\t\t]",
  "ArtifactBuildProperty": "\"{\\\"RegionId\\\":\\\"xxx\\\", \\\"SourceImageId\\\":\\\"xxx\\\", \\\"\\\":\\\"xxx\\\", \\\"CommandType\\\":\\\"xxx\\\", \\\"CommandContent\\\":\\\"xxx\\\"}\"",
  "StatusDetail": "\"/usr/local/share/aliyun-assist/work/script/t-hz04zm90y6og0sg.sh: line 1: pip: command not found\"\n",
  "ArtifactBuildType": "\"{\\\"RegionId\\\":\\\"xxx\\\", \\\"SourceImageId\\\":\\\"xxx\\\", \\\"\\\":\\\"xxx\\\", \\\"CommandType\\\":\\\"xxx\\\", \\\"CommandContent\\\":\\\"xxx\\\"}\"\n"
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-12-02OpenAPI 返回结构发生变更查看变更详情
2024-11-06OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情
2024-11-06API 内部配置变更，不影响调用查看变更详情
2022-12-02新增 OpenAPI查看变更详情
上一篇：DeleteArtifact - 删除部署物下一篇：GetArtifact - 查询部署物详情
文档推荐