All Products
Search
Document Center

Security Center:GetAppNetwork

Last Updated:Nov 14, 2024

Queries the network topology between containerized applications.

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:DescribeAppNetworkFromSnapshotget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
StartTimelongNo

The start timestamp of the query. Unit: milliseconds.

Note The days between the start timestamp and the end timestamp cannot exceed seven days.
1649260800000
EndTimelongNo

The end timestamp of the query. Unit: milliseconds.

Note The days between the start timestamp and the end timestamp cannot exceed seven days.
1650470399999
ClusterIdstringNo

The ID of the cluster to which the container belongs.

Note You can call the DescribeGroupedContainerInstances operation to query the IDs of container clusters.
cf77xxx

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

7D46EDB0-xxx
AppNetworkobject

The information about the application network topology.

Nodearray<object>

The information about the application node.

AppNodeobject
RiskLevelstring

The risk level. Valid values:

  • 3: high
  • 2: medium
  • 1: low
  • 0: warning
  • -1: unknown
0
Idstring

The ID of the node.

1274
NamespaceIdstring

The ID of the namespace.

1
ContainerIdsarray

The list of the container IDs.

ContainerIdstring

The ID of the container.

10a6c3fbaaxxx
Typestring

The type of the node. Valid values:

  • app: an application
  • internet: a network node in another cluster
app
Namestring

The name of the node.

console
Edgearray<object>

The information about the topology edge.

BasicEdgeobject
Idstring

The ID of the edge.

3534
SrcNodeIdstring

The ID of the source node.

101
SrcNodeTypestring

The type of the source node. Valid values:

  • app: an application
  • internet: a network node in another cluster
app
DstNodeIdstring

The ID of the destination node.

102
DstNodeTypestring

The type of the destination node. Valid values:

  • app: an application
  • internet: a network node in another cluster
app
Portstring

The number of the destination port.

8080
Namespacearray<object>

The namespace.

Namespaceobject
Idstring

The ID of the namespace.

1
Namestring

The name of the custom namespace.

default

Examples

Sample success responses

JSONformat

{
  "RequestId": "7D46EDB0-xxx",
  "AppNetwork": {
    "Node": [
      {
        "RiskLevel": "0",
        "Id": "1274",
        "NamespaceId": "1",
        "ContainerIds": [
          "10a6c3fbaaxxx"
        ],
        "Type": "app",
        "Name": "console"
      }
    ],
    "Edge": [
      {
        "Id": "3534",
        "SrcNodeId": "101",
        "SrcNodeType": "app",
        "DstNodeId": "102",
        "DstNodeType": "app",
        "Port": "8080"
      }
    ],
    "Namespace": [
      {
        "Id": "1",
        "Name": "default"
      }
    ]
  }
}

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.