调用DescribeImagePipelines查询一个或多个镜像模板的详细信息。
接口说明
您可以设置NextToken查询凭证（Token），其取值是上一次调用DescribeImagePipelines返回的NextToken参数值，再通过MaxResults设置单页查询的最大条目数进行查询。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| ecs:DescribeImagePipelines | get | *ImagePipeline acs:ecs:{#regionId}:{#accountId}:imagepipeline/**ImagePipeline acs:ecs:{#regionId}:{#accountId}:imagepipeline/{#imagepipelineId} |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 所属的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
| ResourceGroupId | string | 否 | 企业资源组 ID。使用该参数过滤资源时，资源数量不能超过 1000 个。 说明
不支持默认资源组过滤。
| rg-bp67acfmxazb4p**** |
| Tag | array<object> | 否 | 标签列表。 | |
| object | 否 | 标签列表。 | ||
| Key | string | 否 | 标签键。N 的取值范围：1~20。 | TestKey |
| Value | string | 否 | 标签值。N 的取值范围：1~20。 | TestValue |
| Name | string | 否 | 模板名称。 | testImagePipeline |
| NextToken | string | 否 | 查询凭证（Token）。取值为上一次调用该接口返回的 | AAAAAdDWBF2**** |
| MaxResults | integer | 否 | 分页查询时每页行数。取值范围：1~500。 默认值：50。 | 50 |
| ImagePipelineId | array | 否 | 镜像模板 ID。N 取值范围：1~20。 | |
| string | 否 | 镜像模板 ID。N 取值范围：1~20。 | ip-2ze5tsl5bp6nf2b3**** |
返回参数
示例
正常返回示例
JSON格式
{
"NextToken": "AAAAAdDWBF2****",
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"TotalCount": 1,
"MaxResults": 50,
"ImagePipeline": {
"ImagePipelineSet": [
{
"CreationTime": "2020-11-24T06:00:00Z",
"DeleteInstanceOnFailure": true,
"InstanceType": "ecs.g6.large",
"InternetMaxBandwidthOut": 0,
"ImagePipelineId": "ip-2ze5tsl5bp6nf2b3****",
"VSwitchId": "vsw-bp67acfmxazb4p****",
"SystemDiskSize": 40,
"Description": "This is description.",
"BaseImage": "m-bp67acfmxazb4p****",
"ResourceGroupId": "rg-bp67acfmxazb4p****",
"ImageName": "testImageName",
"BaseImageType": "IMAGE",
"Name": "testImagePipeline",
"BuildContent": "RUN echo hello world",
"Tags": {
"Tag": [
{
"TagValue": "TestValue",
"TagKey": "TestKey"
}
]
},
"ToRegionIds": {
"ToRegionId": [
"[\"cn-hangzhou\"]"
]
},
"AddAccounts": {
"AddAccount": [
"[\"1234567890\"]"
]
},
"RepairMode": "Standard",
"TestContent": "RUN echo hello world",
"ImageFamily": "family"
}
]
}
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvalidImagePipelineIdSize.ExceededMaxNumber | %s | 指定的ImagePipelineId.N数量超过上限，即N超过了上限。N的取值范围：1~20。 |
| 400 | InvalidName.Malformed | %s | - |
| 403 | Invalid.NextToken | The specified NextToken is not valid. | - |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-10-10 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |