调用UpdateArtifact更新部署物_计算巢服务(Compute Nest)-阿里云帮助中心

调用UpdateArtifact更新部署物。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
computenestsupplier:UpdateArtifact	Read	Artifact acs:computenestsupplier:{#regionId}:{#accountId}:artifact/{#ArtifactId}	无	无

请求参数

名称	类型	必填	描述	示例值
ArtifactId	string	是	部署物 ID。	artifact-eea08d1e2d3a43aexxxx
VersionName	string	是	部署物版本名称。	v1
Description	string	否	部署物描述。	Redhat8_0镜像
ArtifactProperty	object	是	部署物属性。
Url	string	否	文件部署物 URL。	https://service-info-private.oss-cn-hangzhou.aliyuncs.com/1309208528xxxxxx/template/2e1ce8fc-xxxx-481c-9e8e-789ba9db487d.json
RegionId	string	否	镜像地域。说明该参数仅部署物为镜像部署物时可设置。	cn-hangzhou
ImageId	string	否	镜像 ID。说明该参数仅部署物为镜像部署物时可设置。	m-0xij191j9cuev6ucxxxx
CommodityCode	string	否	云市场商品 code。说明该参数仅部署物为镜像部署物时可设置。	cmjj00xxxx
CommodityVersion	string	否	云市场商品版本。说明该参数仅部署物为镜像部署物时可设置。	V1.0
FileScriptMetadata	string	否	OSS 文件元数据。说明该参数仅部署物为文件部署物时可设置。	{\"WorkDir\":\"/root\",\"CommandType\":\"RunShellScript\",\"Platform\":\"Linux\",\"Script\":\"echo hello\"}
ScriptMetadata	string	否	脚本部署物脚本内容。说明该参数仅部署物为脚本部署物时可设置。	{"ScriptMetadata":"{\"CommandType\":\"RunShellScript\",\"Platform\":\"Linux\",\"Script\":\"ls\"}"}
SupportRegionIds	array	否	部署物支持的地域 ID。
	string	否	部署物支持的地域 ID。	["cn-hangzhou","cn-beijing"]

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	B1A0198B-F316-1B72-B8DD-28B6F6D6XXXX
ArtifactId	string	部署物 ID。	artifact-eea08d1e2d3a43aexxxx
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\":\"cmjj0005xxxx\",\"CommodityVersion\":\"V2022xxxx\"}
SupportRegionIds	string	部署物支持的地域 ID。	[ "cn-beijing", "cn-hangzhou", "cn-shanghai" ]

示例

正常返回示例

JSON格式

{
  "RequestId": "B1A0198B-F316-1B72-B8DD-28B6F6D6XXXX",
  "ArtifactId": "artifact-eea08d1e2d3a43aexxxx",
  "ArtifactType": "EcsImage",
  "VersionName": "v1",
  "ArtifactVersion": "2",
  "Description": "Redhat8_0镜像",
  "GmtModified": "2022-10-20T02:19:55Z",
  "Status": "Available",
  "ArtifactProperty": "{\\\"CommodityCode\\\":\\\"cmjj0005xxxx\\\",\\\"CommodityVersion\\\":\\\"V2022xxxx\\\"}",
  "SupportRegionIds": "[\n\t\t\t\"cn-beijing\",\n\t\t\t\"cn-hangzhou\",\n\t\t\t\"cn-shanghai\"\n\t\t]"
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2022-12-02	新增 OpenAPI	看变更集