獲取容器的實例信息列表。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
yundun-sas:DescribeContainerInstances | get | *全部資源 * |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Criteria | string | 否 | 設置搜索資產的條件。該參數 JSON 格式,輸入參數時注意大小寫。包含一下字段:
說明
支持使用容器 ID、集群 ID、集群名稱、集群類型、風險等級、地域、等條件搜索資產。您可以調用 DescribeContainerCriteria 接口查詢支持的搜索條件。
| [{"name":"flag","value":"0|8","logicalExp":"AND"},{"name":"ecsType","value":"!8","logicalExp":"AND"}][{"name":"clusterType","value":"NotManagedKubernetes","logicalExp":"AND"}] |
LogicalExp | string | 否 | 設置多個搜索條件間生效的邏輯關系。取值:
| AND |
PageSize | integer | 否 | 指定分頁查詢時,每頁顯示的數據最大條數。每頁默認顯示的數據條數為 20 條,PageSize 參數值為空時,將默認返回 20 條數據。 說明
建議 PageSize 取值不要為空。
| 20 |
CurrentPage | integer | 否 | 設置從返回結果的第幾頁開始顯示查詢結果。默認值為 1,表示從第 1 頁開始顯示。 | 1 |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "79CFF74D-E967-5407-8A78-EE03B925FDAA",
"PageInfo": {
"CurrentPage": 1,
"PageSize": 20,
"TotalCount": 45,
"Count": 3
},
"ContainerInstanceList": [
{
"ImageRepoTag": "0.3.1.0-dfa2010-aliyun",
"AppName": "alibaba-log-controller",
"PodIp": "172.24.XX.XX",
"VulCount": 15,
"HcStatus": "YES",
"ImageId": "registry-vpc.cn-beijing.aliyuncs.com/acs/log-controller@sha256:5b046e2de8c490819125193ee2eb71a66f2cc16c032dcd8b69ead4be1024****",
"ClusterId": "cfb41a869c71e4678a97021582dd8a****",
"ImageRepoName": "log-controller",
"HostIp": "172.24.XX.XX",
"Pod": "alibaba-log-controller-6f847f8786-mk2mg",
"RiskStatus": "YES",
"VulStatus": "YES",
"AlarmStatus": "YES",
"Image": "docker.io/library/nginx:latest",
"ImageRepoNamespace": "acs",
"ImageDigest": "5b046e2de8c490819125193ee2eb71a66f2cc16c032dcd8b69ead4be1024****",
"Namespace": "kube-system",
"InstanceId": "i-2zegzjyotydfkz9****",
"NodeInfo": "test",
"ImageUuid": "5f23dfbceec289a49ac94e035e2****",
"RegionId": "cn-hangzhou",
"UpdateMark": "79cff74d-e967-5407-8a78-ee03b9****",
"ContainerId": "48a6d9a92435a13ad573372c3f3c63b7e04d106458141df9f92155709d****",
"NodeName": "test",
"HcCount": 1,
"ClusterName": "test",
"RiskCount": "1",
"AlarmCount": 1,
"CreateTimestamp": 1670368337000,
"Exposed": 1,
"ExposedDetail": "[{\\\"exposedName\\\":\\\"nginx-ingress-lb\\\",\\\"exposedType\\\":\\\"LoadBalancer\\\",\\\"portDOList\\\":[{\\\"name\\\":\\\"http\\\",\\\"nodePort\\\":32268,\\\"port\\\":80,\\\"targetPort\\\":80},{\\\"name\\\":\\\"https\\\",\\\"nodePort\\\":32376,\\\"port\\\":443,\\\"targetPort\\\":443}]}] "
}
]
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
403 | NoPermission | caller has no permission | 當前操作未被授權,請聯系主賬號在RAM控制臺進行授權后再執行操作。 |
500 | ServerError | ServerError | 服務故障,請稍后重試! |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2023-06-21 | OpenAPI 返回結構發生變更 | 查看變更詳情 |