DescribeContainerInstances - Security Center - Alibaba Cloud Documentation Center

Queries the information about containers.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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 Resources is 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	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: name: the search condition. name: the value of the search condition. logicalExp: the logical relationship among multiple search conditions. Valid values: OR: Search conditions are evaluated by using a logical OR. AND: Search conditions are evaluated by using a logical AND. 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: OR: Search conditions are evaluated by using a logical OR. AND: Search conditions are evaluated by using a logical AND.	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

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	79CFF74D-E967-5407-8A78-EE03B925FDAA
PageInfo	object	The pagination information.
CurrentPage	integer	The page number of the returned page.	1
PageSize	integer	The number of entries returned per page.	20
TotalCount	integer	The total number of entries returned.	45
Count	integer	The number of entries returned on the current page.	3
ContainerInstanceList	array<object>	The details of the container asset.
ContainerInstance	object	The information about the container.
ImageRepoTag	string	The tag that is added to the image.	0.3.1.0-dfa2010-aliyun
AppName	string	The name of the application.	alibaba-log-controller
PodIp	string	The IP address of the pod.	172.24.XX.XX
VulCount	integer	The number of vulnerabilities that are detected in the container cluster.	15
HcStatus	string	Indicates whether baseline risks are detected. Valid values: NO YES	YES
ImageId	string	The image ID.	registry-vpc.cn-beijing.aliyuncs.com/acs/log-controller@sha256:5b046e2de8c490819125193ee2eb71a66f2cc16c032dcd8b69ead4be1024****
ClusterId	string	The ID of the cluster.	cfb41a869c71e4678a97021582dd8a****
ImageRepoName	string	The name of the image repository.	log-controller
HostIp	string	The IP address of the host.	172.24.XX.XX
Pod	string	The pod.	alibaba-log-controller-6f847f8786-mk2mg
RiskStatus	string	Indicates whether risks exist. Valid values: NO YES	YES
VulStatus	string	Indicates whether vulnerabilities are detected in the container. Valid values: YES NO	YES
AlarmStatus	string	Indicates whether alerts are generated for the container. Valid values: YES NO	YES
Image	string	The image of the container.	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 instance ID of the asset.	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.	79cff74d-e967-5407-8a78-ee03b9****
ContainerId	string	The ID of the container.	48a6d9a92435a13ad573372c3f3c63b7e04d106458141df9f92155709d****
NodeName	string	The name of the node.	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	long	The timestamp when the cluster was created. Unit: milliseconds.	1670368337000
Exposed	integer	Indicates whether the asset is exposed to the Internet. 1: exposed 0: not exposed	1
ExposedDetail	string	The exposure details. The value is a JSON string.	[{}]

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