调用UpdateArtifact更新部署物。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
computenestsupplier:UpdateArtifact | Read |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
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 | 否 | m-0xij191j9cuev6uc**** | |
CommodityCode | string | 否 | cmjj00**** | |
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。 说明
该参数仅部署物为 ECS 镜像部署物时可设置。
| ["cn-hangzhou","cn-beijing"] |
返回参数
示例
正常返回示例
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]"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2022-12-02 | 新增 OpenAPI | 查看变更详情 |