查詢一個或多個映像組件的詳細資訊。
介面說明
您可以設定NextToken查詢憑證(Token),其取值是上一次呼叫 DescribeImageComponents 返回的NextToken參數值,再透過MaxResults設定單頁查詢的最大條目數進行查詢。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
ecs:DescribeImageComponents |
get |
*ImageComponent
*ImageComponent
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| 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 |
否 |
所屬的地域 ID。您可以呼叫 DescribeRegions 查看最新的阿里雲地域列表。 |
testComponent |
| NextToken |
string |
否 |
資源群組 ID。使用該參數過濾資源時,資源數量不能超過 1000 個。 說明
不支援預設資源群組過濾。 |
AAAAAdDWBF2**** |
| MaxResults |
integer |
否 |
映像組件名稱。僅支援精確查找。 |
50 |
| Owner |
string |
否 |
查詢憑證(Token)。取值為上一次呼叫該介面返回的 |
SELF |
| ImageComponentId |
array |
否 |
分頁查詢時每頁行數。取值範圍:1~500 預設值:50。 |
ic-bp67acfmxazb4p**** |
|
string |
否 |
待查詢的映像組件 ID。N 取值範圍:1~20。 |
ic-bp67acfmxazb4p**** |
|
| ComponentType |
string |
否 |
映像組件類型。取值範圍:
|
Build |
| SystemType |
string |
否 |
待查詢的映像組件 ID。N 取值範圍:1~20。 |
Linux |
| ComponentVersion |
string |
否 |
組件類型。 取值範圍:
|
1.0.* |
|
否 |
組件支援的作業系統。 取值範圍:
|
|||
|
否 |
組件版本號,格式為 major.minor.patch,均為非負整數,也支援使用萬用字元「*」來替代其中一位進行模糊匹配版本。 說明
僅當指定 Name 時該參數生效。 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| NextToken |
string |
本次呼叫返回的查詢憑證(Token)。具體使用方式請參見介面說明。 |
AAAAAdDWBF2**** |
| RequestId |
string |
請求 ID。 |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
| TotalCount |
integer |
返回的映像組件數量。 |
1 |
| MaxResults |
integer |
分頁查詢時每頁行數。 |
50 |
| ImageComponent |
object |
||
| ImageComponentSet |
array<object> |
映像組件的詳細資訊組成的列表。 |
|
|
array<object> |
|||
| CreationTime |
string |
組件建立時間。 |
2020-11-24T06:00:00Z |
| Description |
string |
描述資訊。 |
This is description. |
| SystemType |
string |
組件支援的作業系統。 |
Linux |
| ImageComponentId |
string |
映像組件 ID。 |
ic-bp67acfmxazb4p**** |
| ComponentType |
string |
組件類型。 |
Build |
| ResourceGroupId |
string |
資源群組 ID。 |
rg-bp67acfmxazb4p**** |
| Name |
string |
組件名稱。 |
testComponent |
| Content |
string |
組件內容。 |
Tasks: - Name: HelloWorld Action: RunShellCommand Properties: commandContent: echo hello world |
| Owner |
string |
映像組件類型。可能值:
|
SELF |
| Tags |
object |
||
| Tag |
array<object> |
標籤鍵值對列表。 |
|
|
object |
|||
| TagValue |
string |
標籤值。 |
TestValue |
| TagKey |
string |
標籤鍵。 |
TestKey |
| ComponentVersion |
string |
組件版本號。 |
1.0.0 |
| Parameters |
object |
||
| Parameter |
array<object> |
映像組件包含的參數列表。 |
|
|
object |
|||
| Name |
string |
參數名稱。 |
paramName |
| Type |
string |
參數類型。 取值範圍:
|
String |
| DefaultValue |
string |
參數預設值。 |
paramDefaultValue |
樣本
正常返回樣本
JSON格式
{
"NextToken": "AAAAAdDWBF2****",
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"TotalCount": 1,
"MaxResults": 50,
"ImageComponent": {
"ImageComponentSet": [
{
"CreationTime": "2020-11-24T06:00:00Z",
"Description": "This is description.",
"SystemType": "Linux",
"ImageComponentId": "ic-bp67acfmxazb4p****",
"ComponentType": "Build",
"ResourceGroupId": "rg-bp67acfmxazb4p****",
"Name": "testComponent",
"Content": "Tasks:\n - Name: HelloWorld\n Action: RunShellCommand\n Properties:\n commandContent: echo hello world\n",
"Owner": "SELF",
"Tags": {
"Tag": [
{
"TagValue": "TestValue",
"TagKey": "TestKey"
}
]
},
"ComponentVersion": "1.0.0",
"Parameters": {
"Parameter": [
{
"Name": "paramName",
"Type": "String",
"DefaultValue": "paramDefaultValue"
}
]
}
}
]
}
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | InvalidParameter.Owner | The specified parameter \"Owner\" is not valid. | |
| 400 | InvalidImageComponentIdSize.ExceededMaxNumber | %s | |
| 400 | InvalidSystemType.NotSupportedValue | %s. | |
| 400 | InvalidComponentType.NotSupportedValue | %s. | |
| 400 | InvalidParameter.ComponentVersion | The specified ComponentVersion is invalid. | |
| 403 | Invalid.NextToken | The specified NextToken is not valid. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。