All Products
Search
Document Center

Security Center:DescribeClusterNetwork

Last Updated:Nov 13, 2024

Queries information about the network topology edge by cluster.

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-sas:DescribeClusterNetworkget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
StartTimelongYes

The start timestamp of the query. Unit: milliseconds.

Note The days between the start timestamp and the end timestamp cannot exceed seven days.
1656038740435
EndTimelongYes

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 parameters

ParameterTypeDescriptionExample
object

The data returned.

RequestIdstring

The ID of the request, which is used to locate and troubleshoot issues.

C286491D-4A2F-589A-B63B-D2AD3DA9BD71
ClusterNetworkobject

Information about the network topology edge in the cluster.

Nodearray<object>

An array that consists of information about the node.

ClusterNodeobject

The node information.

Typestring

The type of the node. Valid values:

  • cluster: a cluster.
  • internet: a network node outside the cluster.
cluster
RiskLevelstring

The risk level. Valid values:

  • 3: high.
  • 2: medium.
  • 1: low.
  • 0: secure.
  • -1: unknown.
3
NetTopoSwitchstring

The status of the network topology switch. Valid values:

  • ON
  • OFF
ON
InterceptionTypeinteger

The network type. Valid values:

  • 0: classic network.
  • 1: virtual private cloud (VPC).
1
CnnfSwitchinteger

The status of the microsegmentation switch. Valid values:

  • 0: off.
  • 1: on.
1
Namestring

The name of the node.

testwww
Idstring

The ID of the node.

cfeb7a9f99ce740e98c5595d0fe37****
Edgearray<object>

An array that consists of information about the topology edge.

BasicEdgeobject

Information about the topology edge.

DstNodeIdstring

The ID of the destination node.

cfb41a869c71e4678a97021582dd8****
Portstring

The port number of the topology edge.

6164
SrcNodeIdstring

The ID of the source node.

cfb41a869c71e4678a97021582dd8****
SrcNodeTypestring

The type of the source node. Valid values:

  • cluster: a cluster.
  • internet: a network node outside the cluster
cluster
DstNodeTypestring

The type of the destination node. Valid values:

  • Set the value to cluster.
cluster
Idstring

The ID of the topology edge.

1

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

For a list of error codes, visit the Service error codes.