Retrieves the list of container instance information.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
yundun-sas:DescribeContainerInstances |
get |
*All Resource
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| Criteria |
string |
No |
The search conditions for assets. This parameter is in JSON format. Note that field names are case-sensitive. The following fields are included:
Note
You can search for assets by container ID, cluster ID, cluster name, cluster type, risk level, region, and other conditions. 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 relationship between multiple search conditions. Valid values:
|
AND |
| PageSize |
integer |
No |
The maximum number of entries per page in a paging query. Default value: 20. If you leave this parameter empty, 20 entries are returned per page. Note
Do not leave PageSize empty. |
20 |
| CurrentPage |
integer |
No |
The page number of the page to return. Default value: 1. |
1 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response parameters. |
||
| RequestId |
string |
The request ID, which is a unique identifier generated by Alibaba Cloud for the request. You can use it for troubleshooting. |
79CFF74D-E967-5407-8A78-EE03B925FDAA |
| PageInfo |
object |
The pagination information. |
|
| CurrentPage |
integer |
The page number of the current page in a paging query. |
1 |
| PageSize |
integer |
The maximum number of entries per page in a paging query. |
20 |
| TotalCount |
integer |
The total number of entries returned. |
45 |
| Count |
integer |
The number of entries on the current page in a paging query. |
3 |
| ContainerInstanceList |
array<object> |
The list of container asset information. |
|
|
object |
The container asset information. |
||
| ImageRepoTag |
string |
The tag of the image. |
0.3.1.0-dfa2010-aliyun |
| AppName |
string |
The application name. |
alibaba-log-controller |
| PodIp |
string |
The pod IP address. |
172.24.XX.XX |
| VulCount |
integer |
The number of vulnerabilities in the container cluster. |
15 |
| HcStatus |
string |
The baseline risk status. Valid values:
|
YES |
| ImageId |
string |
The image ID. |
registry-vpc.cn-beijing.aliyuncs.com/acs/log-controller@sha256:5b046e2de8c490819125193ee2eb71a66f2cc16c032dcd8b69ead4be1024**** |
| ClusterId |
string |
The cluster ID. |
cfb41a869c71e4678a97021582dd8a**** |
| ImageRepoName |
string |
The name of the image repository. |
log-controller |
| HostIp |
string |
The host IP address. |
172.24.XX.XX |
| Pod |
string |
The pod name. |
alibaba-log-controller-6f847f8786-mk2mg |
| RiskStatus |
string |
Indicates whether risks exist. Valid values:
|
YES |
| VulStatus |
string |
Indicates whether vulnerabilities exist in the container asset. Valid values:
|
YES |
| AlarmStatus |
string |
Indicates whether security alerts exist for the container. Valid values:
|
YES |
| Image |
string |
The container image. |
docker.io/library/nginx:latest |
| ImageRepoNamespace |
string |
The namespace of the image repository. |
acs |
| ImageDigest |
string |
The digest value of the image. |
5b046e2de8c490819125193ee2eb71a66f2cc16c032dcd8b69ead4be1024**** |
| Namespace |
string |
The namespace. |
kube-system |
| InstanceId |
string |
The asset instance ID. |
i-2zegzjyotydfkz9**** |
| NodeInfo |
string |
The node information. |
test |
| ImageUuid |
string |
The UUID of the image. |
5f23dfbceec289a49ac94e035e2**** |
| RegionId |
string |
The region ID of the container. |
cn-hangzhou |
| UpdateMark |
string |
The update identifier of the container asset. |
79cff74d-e967-5407-8a78-ee03b9**** |
| ContainerId |
string |
The container ID. |
48a6d9a92435a13ad573372c3f3c63b7e04d106458141df9f92155709d**** |
| NodeName |
string |
The node name. |
test |
| HcCount |
integer |
The number of baseline risks. |
1 |
| ClusterName |
string |
The cluster name. |
test |
| RiskCount |
string |
The number of risks. |
1 |
| AlarmCount |
integer |
The number of alerts. |
1 |
| CreateTimestamp |
integer |
The timestamp when the cluster was created, in milliseconds. |
1670368337000 |
| Exposed |
integer |
Indicates whether the container is exposed to the Internet. Valid values:
|
1 |
| ExposedDetail |
string |
The exposure details in JSON format. |
[{\"exposedName\":\"nginx-ingress-lb\",\"exposedType\":\"LoadBalancer\",\"portDOList\":[{\"name\":\"http\",\"nodePort\":32268,\"port\":80,\"targetPort\":80},{\"name\":\"https\",\"nodePort\":32376,\"port\":443,\"targetPort\":443}]}] |
Examples
Success response
JSON format
{
"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}]}] "
}
]
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 500 | ServerError | ServerError | |
| 403 | NoPermission | caller has no permission |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.