根據分組類型查詢對應的容器列表信息。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
yundun-sas:DescribeGroupedContainerInstances | get | *全部資源 * |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Criteria | string | 否 | 設置搜索資產的條件。該參數為 JSON 格式,多個條件之間使用半角逗號(,)分隔。例如: 說明
支持使用實例 ID、實例名稱、所屬 VPC ID、地域、公網 IP 地址等條件搜索資產。您可以調用 DescribeCriteria 查詢支持的搜索條件。
| [{"name":"riskStatus","value":"YES"},{"name":"riskLevel","value":"2"}] |
LogicalExp | string | 否 | 設置多個搜索條件間生效的邏輯關系。取值:
| OR |
GroupField | string | 是 | 要查詢的分組類型。取值:
| pod |
FieldValue | string | 否 | 設置不同分組類型的搜索條件。根據 GroupField 選擇的類型您需要設置以下搜索條件:
說明
以上搜索條件均支持模糊搜索。
| cas-adad-qeqwe |
PageSize | integer | 否 | 設置分頁查詢時,每頁顯示的容器資產的數量。默認值為 20,表示每頁顯示 20 條容器資產信息。 說明
建議 PageSize 取值不要為空。
| 20 |
CurrentPage | integer | 否 | 設置從返回結果的第幾頁開始顯示查詢結果。默認值為 1,表示從第 1 頁開始顯示。 | 1 |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "4E5BFDCF-B9DD-430D-9DA4-151BCB581C9D",
"PageInfo": {
"CurrentPage": 1,
"PageSize": 20,
"TotalCount": 25,
"Count": 20
},
"GroupedContainerInstanceList": [
{
"RiskLevel": "low",
"HostIp": "172.114.XX.XX",
"Pod": "csi-plugin-2n****",
"RiskStatus": "NO",
"CreateTime": 1600076893000,
"Namespace": "kube-system",
"CusterState": "running",
"InstanceId": "i-8vb9ul5xec4tua4q****",
"RegionId": "cn-hangzhou",
"AppName": "oss-liveness-probe",
"InstanceCount": 9,
"ClusterType": "ManagedKubernetes",
"ClusterName": "test",
"PodIp": "172.114.XX.XX",
"VulCount": 1,
"AlarmCount": 1,
"RiskInstanceCount": 1,
"ClusterId": "cf3824769c85441b4bf3****",
"Image": "registry-vpc.ap-southeast-5.aliyuncs.com/log-service-release/sls-connector:1.1.77",
"ImageRepoNamespace": "name001",
"ImageRepoName": "test-003",
"ImageRepoTag": "dev-20220512-2",
"ImageDigest": "58e58c013f70bbfde140c8a55c1078074b3483479428d4069aa946827fd566cf",
"ImageUuid": "e4bdec1d9ba7e0967111a7ea467c****",
"HcCount": 20,
"SyncOpen": 1,
"SyncStatus": 1
}
]
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | IllegalParam | Illegal param | 無效參數 |
403 | NoPermission | caller has no permission | 當前操作未被授權,請聯系主賬號在RAM控制臺進行授權后再執行操作。 |
500 | ServerError | ServerError | 服務故障,請稍后重試! |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-01-11 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
2021-12-21 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |