文档

CreateArtifact - 创建部署物

更新时间:

调用CreateArtifact创建部署物。

调试

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

授权信息

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

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

请求参数

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

部署物 ID。

当您要为已有部署物创建新版本时,该参数必填。

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

artifact-eea08d1e2d3a43ae****
ArtifactTypestring

部署物类型。

取值:

  • EcsImage:ECS 镜像部署物。

  • AcrImage:容器镜像部署物。

  • File:Oss 文件部署物。

  • Script:脚本部署物。

  • HelmChart:HelmChart 部署物。

EcsImage
Namestring

部署物名称。

Redhat8_5镜像
VersionNamestring

部署物版本名称。

v1
Descriptionstring

部署物描述。

Redhat8_0镜像
ArtifactPropertyobject

部署物内容。

Urlstring

文件部署物的 URL。

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

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

文件脚本元数据。

{\"WorkDir\":\"/root\",\"CommandType\":\"RunShellScript\",\"Platform\":\"Linux\",\"Script\":\"echo hello\"}
RegionIdstring

镜像地域。

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

镜像 ID。

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

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

云市场商品 code。

您可以通过调用 DescribeProducts 获取商品 Code。

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

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

云市场商品版本。

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

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

脚本部署物的脚本内容。

说明 该参数仅部署物为脚本部署物时可设置。
{"ScriptMetadata":"{\"CommandType\":\"RunShellScript\",\"Platform\":\"Linux\",\"Script\":\"ls\"}"}
RepoNamestring

指定镜像仓库名称。

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

镜像仓库 ID。

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

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

镜像仓库对应的版本。

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

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

支持镜像分发的地域。

string

支持镜像分发的地域。

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

资源组 ID。

rg-acfm2jfvb7b****
Tagarray<object>

用户自定义标签。

object

用户自定义标签。

Keystring

标签键。

key1
Valuestring

标签值。

value1

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

E73F09DC-6C13-5CB1-A10F-7A4E125ABD2C
ArtifactIdstring

部署物 ID。

artifact-eea08d1e2d3a43ae****
ArtifactTypestring

部署物类型。

EcsImage
Namestring

部署物名称。

Redhat8_5镜像
VersionNamestring

部署物名称。

v1
ArtifactVersionstring

部署物版本。

2
Descriptionstring

部署物描述。

Redhat8_0镜像
GmtModifiedstring

修改时间。

2022-11-11T12:00:00Z
Statusstring

部署物状态。

Created
MaxVersionlong

部署物的最新版本。

1
ArtifactPropertystring

部署物内容。

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

部署物分发的地域 ID。

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

示例

正常返回示例

JSON格式

{
  "RequestId": "E73F09DC-6C13-5CB1-A10F-7A4E125ABD2C",
  "ArtifactId": "artifact-eea08d1e2d3a43ae****",
  "ArtifactType": "EcsImage",
  "Name": "Redhat8_5镜像",
  "VersionName": "v1",
  "ArtifactVersion": "2",
  "Description": "Redhat8_0镜像",
  "GmtModified": "2022-11-11T12:00:00Z",
  "Status": "Created",
  "MaxVersion": 1,
  "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]"
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-09-08OpenAPI 入参发生变更查看变更详情
2023-07-27API 内部配置变更,不影响调用查看变更详情
2022-12-02新增 OpenAPI查看变更详情