通过UpdateArtifact API更新部署物-计算巢服务-阿里云

调用UpdateArtifact更新部署物

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

computenestsupplier:UpdateArtifact

update

*Artifact

acs:computenestsupplier:{#regionId}:{#accountId}:artifact/{#ArtifactId}

无

请求参数

名称	类型	必填	描述	示例值
ArtifactId	string	是	部署物 ID。您可以通过调用ListArtifacts - 查询部署物列表获取部署物 ID。	artifact-eea08d1e2d3a43ae****
VersionName	string	否	部署物版本名称。	v1
Description	string	否	部署物描述。	Redhat8_0镜像
ArtifactProperty	object	否	部署物内容。
Url	string	否	文件部署物 URL。您可以通过对象存储控制台上传并获取文件 URL.	https://service-info-private.oss-cn-hangzhou.aliyuncs.com/130920852865**/template/2e1ce8fc-**-481c-9e8e-789ba9db487d.json
RegionId	string	否	镜像地域。说明该参数仅部署物为镜像部署物时可设置。	cn-hangzhou
ImageId	string	否	镜像 ID。当您选定 RegionId 时，您可以调用DescribeImages - 查询可以使用的镜像资源查看指定地域下可用的镜像 ID。说明该参数仅部署物为镜像部署物时可设置。	m-0xij191j9cuev6uc****
CommodityCode	string	否	云市场商品 code。您可以通过云市场控制台获取商品 Code。说明该参数仅部署物为镜像部署物时可设置。	cmjj00****
CommodityVersion	string	否	云市场商品版本。您可以通过云市场页面查看云市场商品版本。说明该参数仅部署物为镜像部署物时可设置。	V1.0
RepoName	string	否	指定镜像仓库名称。说明该参数仅部署物为容器镜像部署物和 HelmChart 部署物时可设置。	wordpress
RepoId	string	否	镜像仓库 ID。您可以通过调用ListAcrImageRepositories - 查看已上传至 ACR 的镜像列表获取镜像仓库 ID。说明该参数仅部署物为容器镜像部署物和 HelmChart 部署物时可设置。	crr-d8o1nponyc2t****
Tag	string	否	镜像仓库对应的版本。您可以通过调用ListAcrImageTags - 查看镜像仓库中已上传的镜像版本获取镜像仓库对应的版本。说明该参数仅部署物为容器镜像部署物和 HelmChart 部署物时可设置。	v1
RepoType	string	否	仓库权限类型，取值： `Public`：公开仓库 `Private`：私有仓库说明该参数仅部署物为容器镜像部署物和 HelmChart 部署物时可设置。	Public
SupportRegionIds	array	否	支持镜像分发的地域 ID。
	string	否	支持镜像分发的地域 ID。说明该参数仅部署物为 ECS 镜像部署物时可设置。	["cn-hangzhou","cn-beijing"]
ArtifactBuildProperty	object	否	部署物构建内容，用于托管构建部署物
CommandType	string	否	命令类型。取值范围： RunBatScript：命令为在 Windows 实例中运行的 Bat 脚本。 RunPowerShellScript：命令为在 Windows 实例中运行的 PowerShell 脚本。 RunShellScript：命令为在 Linux 实例中运行的 Shell 脚本。说明该参数仅部署物为 ECS 镜像部署物时可设置。	RunShellScript
CommandContent	string	否	命令内容。说明该参数仅部署物为 ECS 镜像部署物时可设置。	echo "start run command"
SourceImageId	string	否	源镜像 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
RegionId	string	否	源镜像所在的地域 ID 说明该参数仅部署物为 ECS 镜像部署物时可设置。	cn-hangzhou
CodeRepo	object	否	代码仓库地址。说明该参数仅 ArtifactBuildType 为 Dockerfile 或 Buildpacks 时可设置。
Platform	string	否	代码仓库所在平台。取值范围： github gitee gitlab codeup	github
RepoName	string	否	仓库名称。	aliyun-computenest/quickstart-Lobexxx
Owner	string	否	代码仓库的拥有者。说明该参数仅代码仓库为私有仓库时需填写。	aliyun-computenest
Branch	string	否	代码仓库分支名称。	main
Endpoint	string	否	终端节点。gitlab 私有部署时需要传入。	http://121.40.25.0
OrgId	string	否	组织 ID。	455231
RepoId	integer	否	仓库 ID。	103
DockerfilePath	string	否	Dockerfile 文件在代码仓库中的相对地址。默认值：Dockerfile 说明该参数仅 ArtifactBuildType 为 Dockerfile 时可设置。	./file/Dockerfile
BuildArgs	array<object>	否	构建参数。说明该参数仅 ArtifactBuildType 为 Dockerfile 时可设置。
	object	否	用于 docker build --build-arg
ArgumentName	string	否	构建参数的 name。	ENV
ArgumentValue	string	否	构建参数的 value。	nginx:latest
SourceContainerImage	string	否	源容器镜像的拉取地址。用于 docker pull ${SourceContainerImage} 说明该参数仅 ArtifactBuildType 为 ContainerImage 时可设置。	pytorch/pytorch:2.5.1-cuda12.4-cudnn9-devel
SystemDiskSize	integer	否	系统盘大小。单位：GiB。	40
EnableGpu	boolean	否	是否需求 Gpu。默认使用 Cpu 实例	false
ClientToken	string	否	保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符，且不能超过 64 个字符。	10CM943JP0EN9D51H
PermissionType	string	否	权限字段，针对容器镜像部署物、HelmChart 部署物有效。仅能从 Automatic 变为 Public。可选值： Public Automatic	Public

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	9F350409-2ACC-5B61-ACD9-3C8995792F8F
ArtifactId	string	部署物 ID。	artifact-eea08d1e2d3a43ae****
ArtifactType	string	部署物类型。	EcsImage
VersionName	string	部署物名称。	v1
ArtifactVersion	string	部署物版本。	2
Description	string	部署物描述。	Redhat8_0镜像
GmtModified	string	修改时间。	2022-10-20T02:19:55Z
Status	string	部署物的状态。取值： Created：已创建。 Scanning：扫描中。 ScanFailed：扫描失败。 Delivering：分发中。 Available：可使用。 Deleted：已删除。	Available
ArtifactProperty	string	部署物内容。	{\"CommodityCode\":\"cmjj0005**\",\"CommodityVersion\":\"V2022**\"}
SupportRegionIds	string	部署物支持分发的地域 ID。	[ "cn-beijing", "cn-hangzhou", "cn-shanghai" ]
ArtifactBuildProperty	string	部署物构建内容，用于托管构建部署物。	"{\"RegionId\":\"xxx\", \"SourceImageId\":\"xxx\", \"\":\"xxx\", \"CommandType\":\"xxx\", \"CommandContent\":\"xxx\"}"
StatusDetail	string	部署物的状态描述。	"/usr/local/share/aliyun-assist/work/script/t-hz04zm90y6og0sg.sh: line 1: pip: command not found"
ArtifactBuildType	string	部署物构建内容，用于托管构建部署物。	"{\"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"
}

错误码

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

变更历史

更多信息，参考变更详情。