Query cluster network topology with DescribeClusterNetwork - Security Center

Retrieves information about the network topology edge by cluster.

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:DescribeClusterNetwork

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
StartTime	integer	Yes	The start timestamp of the query. Unit: milliseconds. Note The days between the start timestamp and the end timestamp cannot exceed seven days.	1656038740435
EndTime	integer	Yes	The end timestamp of the query. Unit: milliseconds. Note The days between the start timestamp and the end timestamp cannot exceed seven days.	1656038940435

Response elements

Element	Type	Description	Example
	object	The data returned.
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	C286491D-4A2F-589A-B63B-D2AD3DA9BD71
ClusterNetwork	object	Information about the network topology edge in the cluster.
Node	array<object>	An array that consists of information about the node.
	object	The node information.
Type	string	The type of the node. Valid values: cluster: a cluster. internet: a network node outside the cluster.	cluster
RiskLevel	string	The risk level. Valid values: 3: high. 2: medium. 1: low. 0: secure. -1: unknown.	3
NetTopoSwitch	string	The status of the network topology switch. Valid values: ON OFF	ON
InterceptionType	integer	The network type. Valid values: 0: classic network. 1: virtual private cloud (VPC).	1
CnnfSwitch	integer	The status of the microsegmentation switch. Valid values: 0: off. 1: on.	1
Name	string	The name of the node.	testwww
Id	string	The ID of the node.	cfeb7a9f99ce740e98c5595d0fe37****
Edge	array<object>	An array that consists of information about the topology edge.
	object	Information about the topology edge.
DstNodeId	string	The ID of the destination node.	cfb41a869c71e4678a97021582dd8****
Port	string	The port number of the topology edge.	6164
SrcNodeId	string	The ID of the source node.	cfb41a869c71e4678a97021582dd8****
SrcNodeType	string	The type of the source node. Valid values: cluster: a cluster. internet: a network node outside the cluster	cluster
DstNodeType	string	The type of the destination node. Valid values: Set the value to cluster.	cluster
Id	string	The ID of the topology edge.	1

Examples

Success response

JSON format

{
  "RequestId": "C286491D-4A2F-589A-B63B-D2AD3DA9BD71",
  "ClusterNetwork": {
    "Node": [
      {
        "Type": "cluster",
        "RiskLevel": "3",
        "NetTopoSwitch": "ON",
        "InterceptionType": 1,
        "CnnfSwitch": 1,
        "Name": "testwww",
        "Id": "cfeb7a9f99ce740e98c5595d0fe37****\n"
      }
    ],
    "Edge": [
      {
        "DstNodeId": "cfb41a869c71e4678a97021582dd8****",
        "Port": "6164",
        "SrcNodeId": "cfb41a869c71e4678a97021582dd8****",
        "SrcNodeType": "cluster",
        "DstNodeType": "cluster",
        "Id": "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.