文档

ListArtifacts - 查询部署物列表

更新时间:

调用ListArtifacts查询部署物列表。

调试

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

授权信息

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

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

请求参数

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

分页查询时每页行数。其中最大值为 100 行,默认值为 20 行。

20
NextTokenstring

查询凭证(Token),取值为上一次 API 调用返回的 NextToken 参数值。

AAAAAc3HCuYhJi/wvpk4xOr0VLbfVwapgMwCN1wYzPVzLbItEdB0uWSY7AGnM3qCgm/YnjuEfwSnMwiMkcUoI0hRQzE=
Filterobject []

过滤器。

Namestring

过滤器名称。可选择一个或多个名称进行查询。取值范围:

  • Name:按部署物名称进行模糊查询。

  • ArtifactId:部署物 ID。

  • ArtifactType:部署物类型。

ArtifactType
Valuesarray

过滤器值列表。

string

过滤器值列表。N 取值范围为:1~10。

value1
ResourceGroupIdstring

资源组 ID。

rg-aek25yfxxxxxxxx
Tagobject []

标签。

Keystring

标签键。

key1
Valuestring

标签值。

value1

返回参数

名称类型描述示例值
object

响应数据结构。

RequestIdstring

请求的 ID。

46577928-3162-15A6-9084-69820EB9xxxx
NextTokenstring

查询凭证(Token),取值为上一次 API 调用返回的 NextToken 参数值。

AAAAAc3HCuYhJi/wvpk4xOr0VLbfVwapgMwCN1wYzPVzLbItEdB0uWSY7AGnM3qCgm/YnjuEfwSnMwiMkcUoI0hRQzE=
MaxResultsinteger

分页查询时每页行数。其中最大值为 100 行,默认值为 20 行。

20
TotalCountinteger

符合条件的记录总数。

2
Artifactsobject []

部署物列表信息。

ArtifactIdstring

部署物 ID。

artifact-eea08d1e2d3a43aexxxx
ArtifactTypestring

部署物类型。

EcsImage
Namestring

部署物名称。

Redhat8_5镜像
MaxVersionstring

最新版本。

2
Descriptionstring

部署物描述。

Redhat8_0镜像
GmtModifiedstring

修改时间。

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

部署物的状态。可能的值:

  • Created:已创建。

  • Scanning:扫描中。

  • ScanFailed:扫描失败。

  • Delivering:分发中。

  • Available:可使用。

  • Deleted:已删除。

Created
ResourceGroupIdstring

资源组 ID。

rg-aek25rexxxxxxxx
Tagsobject []

标签值。

Keystring

标签键。

key1
Valuestring

标签值。

value1

示例

正常返回示例

JSON格式

{
  "RequestId": "46577928-3162-15A6-9084-69820EB9xxxx",
  "NextToken": "AAAAAc3HCuYhJi/wvpk4xOr0VLbfVwapgMwCN1wYzPVzLbItEdB0uWSY7AGnM3qCgm/YnjuEfwSnMwiMkcUoI0hRQzE=",
  "MaxResults": 20,
  "TotalCount": 2,
  "Artifacts": [
    {
      "ArtifactId": "artifact-eea08d1e2d3a43aexxxx",
      "ArtifactType": "EcsImage",
      "Name": "Redhat8_5镜像",
      "MaxVersion": "2",
      "Description": "Redhat8_0镜像",
      "GmtModified": "2022-10-20T02:19:55Z",
      "Status": "Created",
      "ResourceGroupId": "rg-aek25rexxxxxxxx",
      "Tags": [
        {
          "Key": "key1",
          "Value": "value1"
        }
      ]
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-09-08OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:ResourceGroupId
    新增入参:Tag
出参OpenAPI 返回结构发生变更
2023-08-08OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2022-12-02新增 OpenAPI看变更集
  • 本页导读 (0)
文档反馈