ListSubnets-阿里云帮助中心

You can call this operation to query the details of one or more Lingjun subnets, including the Lingjun subnet type, network address segment, and instance ID of the Lingjun CIDR block.

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

eflo:ListSubnets

get

*Subnet

acs:eflo:{#regionId}:{#accountId}:Subnet/*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the disk.	cn-wulanchabu
ZoneId	string	No	The zone ID of the disk.	cn-wulanchabu-a
SubnetId	string	No	Lingjun subnet instance ID	subnet-anhtskts
SubnetName	string	No	Lingjun subnet instance name	subnet-1
VpdId	string	No	The ID of the Lingjun CIDR block.	vpd-fuliephf
Status	string	No	The status of the CLB instance. Valid values: Available: Normal Not Available: Unavailable Executing: Executing Deleting: The node is being deleted.	Available
Type	string	No	Lingjun Subnet Usage Type; optional; optional. Valid values: If you do not set this field for a common type OOB :OOB type LB: LB type	Null
ResourceGroupId	string	No	The resource group ID. For more information about resource groups, see Resource groups.	rg-aeky5f3qx6ceapq
Tag	array<object>	No	The tag information. You can specify up to 20 tags.
	object	No	The tag.
Key	string	No	The tag key of the VPN attachment. You cannot specify an empty string as a tag key. It can be up to 64 characters in length and cannot start with aliyun or acs:. It cannot contain http:// or https://. You can specify at most 20 tag keys in each call.	rg-subnet
Value	string	No	The tag value of the VPN connection. The tag value can be empty or a string of up to 128 characters. It cannot start with aliyun or acs:, and cannot contain http:// or https://. Each key-value pair must be unique. You can specify values for at most 20 tag keys in each call.	subnet-group-1
PageNumber	integer	No	The number of the page to return. The value must be greater than 0. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Valid values: 1 to 100. Default value: 20.	20
EnablePage	boolean	No	Specifies whether to query by page. Optional values: true: Enable pagination query false: Pagination query is disabled	false

Response elements

Element	Type	Description	Example
	object	AjaxResult<PageResult>
Code	integer	The response status code.	0
Message	string	The returned message.	SUCCESS
RequestId	string	Request ID of the current request	7F9082CC-3D94-560F-A575-8E8EF6CE2CB8
Content	object	The response parameters.
Total	integer	The total number of entries returned.	10
Data	array<object>	Lingjun subnet information list
	array<object>	Lingjun subnet information
CreateTime	string	The time when the data address was created.	1678273219000
GmtModified	string	The time when the agent was last modified.	1678273219000
TenantId	string	The ID of the tenant.	1655449505171
RegionId	string	The region ID.	cn-wulanchabu
ZoneId	string	The zone ID.	cn-wulanchabu-b
Type	string	Lingjun Subnet Usage Type; optional; optional. Valid values: If you do not set this field for a common type OOB :OOB type LB: LB type	OOB
SubnetId	string	Lingjun subnet instance ID	subnet-c6wci55i
SubnetName	string	Lingjun subnet instance name	yzp-rg-test3
Cidr	string	The CIDR block of the Subnet. The network segment of the subnet must be a proper subset of the network segment of Lingjun to which it belongs, and the mask must be between 16 bits and 29 bits, which can provide 8 to 65536 addresses. For example, the CIDR block of the Lingjun CIDR block is 192.168.0.0/16, and the CIDR blocks of the subnets under the Lingjun CIDR block are 192.168.0.0/17 to 192.168.0.0/29. The first and last three IP addresses of each subnet segment are reserved by the system. For example, the CIDR blocks of the subnet are 192.168.1.0/24,192.168.1.0, 192.168.1.253, 192.168.1.254, and 192.168.1.255.	172.18.0.0/24
VpdId	string	The ID of the Lingjun CIDR block.	vpd-ze3na0wf
Status	string	The status of the cache reserve instance. Valid values: Available: Normal Not Available: Unavailable Executing: Executing Deleting: The node is being deleted.	Available
Message	string	The error message. (If the instance is in the Exception state, the exception cause is prompted.)	成功
VpdBaseInfo	object	vpd basic information
VpdId	string	Lingjun CIDR block instance ID	vpd-d3isyds4
VpdName	string	Lingjun CIDR block instance name	yzp-rg-test3
Cidr	string	The CIDR block of the VPD. We recommend that you use an RFC private endpoint as the Lingjun CIDR block, such as 10.0.0.0/8,172.16.0.0/12,192.168.0.0/16. In scenarios where the Doringjun CIDR block is connected to each other or where the Lingjun CIDR block is connected to a VPC, make sure that the addresses do not conflict with each other. You can also use a custom CIDR block other than 100.64.0.0/10, 224.0.0.0/4, 127.0.0.0/8, or 169.254.0.0/16 and their subnets as the primary IPv4 CIDR block of the VPD.	10.0.0.0/8
CreateTime	string	The time when the data address was created.	1678273219000
NcCount	integer	Number of NCs	16
NetworkInterfaceCount	integer	Number of Lingjun network interface controller	1
ResourceGroupId	string	The ID of your Alibaba Cloud resource group. For more information about resource groups, see Resource groups.	rg-aek2l4sq6l7unhi
Tags	array<object>	The tag information. You can specify up to 20 tags.
	object	The information about the image tag.
TagKey	string	The tag key. You cannot specify an empty string as a tag key. It can be up to 64 characters in length and cannot start with aliyun or acs:. It cannot contain http:// or https://. You can specify at most 20 tag keys in each call.	tag-subnet
TagValue	string	The value of the tag that is added to the resource. The tag value can be empty or a string of up to 128 characters. It cannot start with aliyun or acs:, and cannot contain http:// or https://. Each key-value pair must be unique. You can specify values for at most 20 tag keys in each call.	subnet-group-1
AccessDeniedDetail	string	The details about the access denial.	None

Examples

Success response

JSON format

{
  "Code": 0,
  "Message": "SUCCESS",
  "RequestId": "7F9082CC-3D94-560F-A575-8E8EF6CE2CB8",
  "Content": {
    "Total": 10,
    "Data": [
      {
        "CreateTime": "1678273219000",
        "GmtModified": "1678273219000",
        "TenantId": "1655449505171",
        "RegionId": "cn-wulanchabu",
        "ZoneId": "cn-wulanchabu-b",
        "Type": "OOB",
        "SubnetId": "subnet-c6wci55i",
        "SubnetName": "yzp-rg-test3",
        "Cidr": "172.18.0.0/24",
        "VpdId": "vpd-ze3na0wf",
        "Status": "Available",
        "Message": "成功",
        "VpdBaseInfo": {
          "VpdId": "vpd-d3isyds4",
          "VpdName": "yzp-rg-test3",
          "Cidr": "10.0.0.0/8",
          "CreateTime": "1678273219000"
        },
        "NcCount": 16,
        "NetworkInterfaceCount": 1,
        "ResourceGroupId": "rg-aek2l4sq6l7unhi",
        "Tags": [
          {
            "TagKey": "tag-subnet",
            "TagValue": "subnet-group-1"
          }
        ]
      }
    ]
  },
  "AccessDeniedDetail": "None"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.