All Products
Search
Document Center

ENS:DescribeNetworkAttribute

Last Updated:Mar 12, 2024

Queries the configuration of a specified network.

Operation description

  • You can call this operation up to 100 times per second.
  • You can call this operation up to 10 times per second per account.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
NetworkIdstringYes

The ID of the network.

n-****

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
EnsRegionIdstring

The ID of the edge node.

cn-beijing
NetworkIdstring

The ID of the network.

n-5***
NetworkNamestring

The name of the network.

abc
CidrBlockstring

The IPv4 CIDR block of the network.

10.0.0.0/24
Statusstring

The status of the network. Valid values:

  • Pending
  • Available
Available
Descriptionstring

The description of the network.

abc
CreatedTimestring

The time when the network was created. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.

2019-06-01T00:00:00Z
VSwitchIdsarray

The list of vSwitches in the network.

string

The list of vSwitches in the network.

{"VSwitchId": [ "vsw-bp14cagpfysr29feg****" ]}
CloudResourcesobject []

The list of resources in the network.

ResourceCountinteger

The number of resources in the network.

3
ResourceTypestring

The resource type. VSwitch.

VSwitch
RouterTableIdstring

The ID of the route table.

rtb-5***
NetworkAclIdstring

The ID of the network access control list (ACL).

nacl-a2do9e413e0sp****

Examples

Sample success responses

JSONformat

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "EnsRegionId": "cn-beijing",
  "NetworkId": "n-5***",
  "NetworkName": "abc",
  "CidrBlock": "10.0.0.0/24",
  "Status": "Available",
  "Description": "abc",
  "CreatedTime": "2019-06-01T00:00:00Z",
  "VSwitchIds": {
    "VSwitchId": [
      "{\"VSwitchId\": [ \"vsw-bp14cagpfysr29feg****\" ]}"
    ]
  },
  "CloudResources": {
    "CloudResourceSetType": [
      {
        "ResourceCount": 3,
        "ResourceType": "VSwitch"
      }
    ]
  },
  "RouterTableId": "rtb-5***",
  "NetworkAclId": "nacl-a2do9e413e0sp****"
}

Error codes

HTTP status codeError codeError message
400InvalidNetworkId.NotFoundNetwork not found
400ens.interface.errorAn error occurred while calling the API.
400NoPermissionPermission denied.
400InvalidParameter.%sThe specified field %s invalid. Please check it again.

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

Change history

Change timeSummary of changesOperation
No change history