FindContainerNetworkConnect API reference - Security Center - Alibaba Cloud - Security Center

Retrieves information about network connectivity between two nodes.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-sas:ListContainerNetworkConnect

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
CriteriaType	string	No	The query type of the element to query. Valid values: EDGE: connection information. This parameter is required. If this parameter is not specified, the service returns error code -101.	EDGE
StartTime	integer	No	The start time of the network connectivity. Specify a UNIX timestamp in milliseconds. This parameter is required. If this parameter is not specified, the service returns error code -101.	1666886400000
EndTime	integer	No	The end time of the network connectivity. Specify a UNIX timestamp in milliseconds. This parameter is required. If this parameter is not specified, the service returns error code -101.	1649260799999
SrcNode	object	No	The source node information, which is used to filter source nodes. This parameter is required. If this parameter is not specified, the service returns error code -101.
NodeType	string	No	The node type. Valid values: app: application. The node type is application.	app
ClusterId	string	No	The ID of the container cluster to query. Note You can call the DescribeGroupedContainerInstances operation to obtain this parameter.	c56xxx1775dea0
Namespace	string	No	The namespace of the cluster.	default
AppName	string	No	The name of the container application.	arms-prometheus-ack-arms-prometheus
PodName	string	No	The name of the pod.	abc-deployment-yacs-31144-39265-1384966-7f8c8cd578-h6mhb
NodeIds	array	No	The list of node IDs.
	string	No	The node ID.	1001
DstNode	object	No	The destination node information, which is used to filter destination nodes. This parameter is required. If this parameter is not specified, the service returns error code -101.
NodeType	string	No	The node type. Valid values: app: application. The node type is application.	app
ClusterId	string	No	The ID of the container cluster to query. Note You can call the DescribeGroupedContainerInstances operation to obtain this parameter.	f5x833820xx
Namespace	string	No	The namespace of the cluster.	default
AppName	string	No	The name of the container application.	nginx-ingress-controller
PodName	string	No	The name of the pod.	abc-deployment-yacs-31144-39265-1384966-7f8c8cd578-h6mhb
NodeIds	array	No	The list of node IDs.
	string	No	The node ID.	1001
PageSize	integer	No	The maximum number of entries per page when paging is used. Default value: 20. If this parameter is left empty, 20 entries are returned. Note Do not leave PageSize empty.	20
CurrentPage	integer	No	The page number of the page to return in a paginated query. Default value: 1, which indicates the first page.	1

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The request ID, which is a unique identifier generated by Alibaba Cloud for the request. You can use this ID to troubleshoot issues.	8686CE6E-9BFA-5436-A9D9-77B984AEE7F8
Connects	array<object>	The network connectivity information.
	array<object>	The network connectivity information.
Id	integer	The network connectivity ID.	1458
FirstTime	integer	The timestamp when the connection first occurred, in milliseconds.	1636077279174
LastTime	integer	The timestamp when the connection last occurred, in milliseconds.	1636595679174
SrcIp	string	The source IP address.	35.233.62.116
SrcPort	string	The source port number.	10240
DstIp	string	The destination IP address.	172.20.62.176
DstPort	string	The destination port.	443
SrcContainer	object	The source container information. Important This feature is not supported.
ContainerId	string	The container ID.	48a6xxx5709d5a5866
DstContainer	object	The destination container information. Important This feature is not supported.
ContainerId	string	The container ID.	48a6dxxx9d5a5866
PageInfo	object	The paging information.
TotalCount	integer	The total number of connections returned.	12
Count	integer	The number of entries returned on the current page when paging is used.	10
PageSize	integer	The number of entries per page when paging is used. Default value: 20, which indicates that 20 network connectivity entries are displayed per page.	20
CurrentPage	integer	The current page number when paging is used.	1

Examples

Success response

JSON format

{
  "RequestId": "8686CE6E-9BFA-5436-A9D9-77B984AEE7F8",
  "Connects": [
    {
      "Id": 1458,
      "FirstTime": 1636077279174,
      "LastTime": 1636595679174,
      "SrcIp": "35.233.62.116",
      "SrcPort": "10240",
      "DstIp": "172.20.62.176",
      "DstPort": "443",
      "SrcContainer": {
        "ContainerId": "48a6xxx5709d5a5866"
      },
      "DstContainer": {
        "ContainerId": "48a6dxxx9d5a5866"
      }
    }
  ],
  "PageInfo": {
    "TotalCount": 12,
    "Count": 10,
    "PageSize": 20,
    "CurrentPage": 1
  }
}

Error codes

HTTP status code	Error code	Error message	Description
500	ServerError	ServerError
403	NoPermission	caller has no permission	You are not authorized to do this operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.