Queries the information about containers.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| yundun-sas:DescribeContainerInstances | get | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| Criteria | string | No | The search conditions that are used to filter containers. The value of this parameter is in the JSON format and is case-sensitive. The value contains the following fields:
Note
You can use search conditions such as the container ID, cluster ID, cluster name, cluster type, risk level, and region. You can call the DescribeContainerCriteria operation to query the supported search conditions.
| [{"name":"flag","value":"0|8","logicalExp":"AND"},{"name":"ecsType","value":"!8","logicalExp":"AND"}][{"name":"clusterType","value":"NotManagedKubernetes","logicalExp":"AND"}] |
| LogicalExp | string | No | The logical operator that you want to use to evaluate multiple search conditions. Valid values:
| AND |
| PageSize | integer | No | The number of entries to return on each page. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page. Note
We recommend that you do not leave this parameter empty.
| 20 |
| CurrentPage | integer | No | The number of the page to return. Default value: 1. | 1 |
Response parameters
Examples
Sample success responses
JSONformat
{
"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": "[{}]"
}
]
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 403 | NoPermission | caller has no permission | You are not authorized to do this operation. |
| 500 | ServerError | ServerError | - |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2023-06-21 | The response structure of the API has changed | View Change Details |