TrafficRoute DNS Suite
TrafficRoute DNS Suite
Document
- Documentation
TrafficRoute DNS SuiteVolcanoEngine PrivateZoneAPI ReferenceCross-account resource sharingListZonesByVPC - Listing the Private Zones associated with a VPC
Copy page
Download PDFCross-account resource sharing
ListZonesByVPC - Listing the Private Zones associated with a VPC
Copy pageDownload PDFListZonesByVPC - Listing the Private Zones associated with a VPC
Queries the list of private domain names that are associated with a specified Virtual Private Cloud (VPC).
This API is called by the account that owns the VPC. It returns all private domain names currently associated with the VPC, including:
- private domain names created and associated with the VPC by the calling account.
- private domain names from other accounts that have been associated with the VPC through cross-account authorization.
Instructions
Request frequency: Up to 10 calls per second.
Request description
- Method: GET
- URL: https://private-zone.volcengineapi.com/?Action=ListZonesByVPC&Version=2022-06-01
Request parameters
The following only details request parameters specific to this API and key common parameters. For more information, see Common parameters.
Action string required Example: ListZonesByVPC
The action to perform. Value: ListZonesByVPC.
Version string required Example: 2022-06-01
The API version. Value: 2022-06-01.
VpcRegion string required Example: cn-beijing
The region where the VPC is located.
VpcID string requiredExample: vpc-3reow**hxad79k
The ID of the VPC instance.
PageNumber integer optional Example: 1
The page number. The API returns the private domain names displayed on this page number. Default: 1.
PageSize integer optional Example: 10
The number of private domain names per page. The system paginates the retrieved private domain names. The total number of pages is determined by the total number of private domain names and the PageSize value. Default: 10. Maximum: 500.
Response parameters
Only the response parameters specific to this API are listed below. For more information, see Response structure.
PageNumber integer Example: 1
The current page number.
PageSize integer Example: 10
The number of private domain names to return on each page.
Total integer Example: 25
The total number of private domain names that meet the conditions.
BindZones object[] Example: [ { "ZID": 1013, "AccountID": "210000xxxx" } ]
The list of private domain names that are associated with the VPC.
ZID long Example: 1013
The unique ID of the private domain name.
AccountID string Example: 2100xxxxx
The ID of the account to which the private domain name belongs.
Request examples
GET /?Action=ListZonesByVPC&Version=2022-06-01&VpcRegion=cn-beijing&VpcID=vpc-3reow**hxad79k&PageNumber=1&PageSize=10 HTTP/1.1
Host: private-zone.volcengineapi.com
X-Date: 20260309T100552Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20260309/cn-beijing/private_zone/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f
Response examples
{
"ResponseMetadata": {
"RequestId": "20260309180556140100248052946768",
"Action": "ListZonesByVPC",
"Version": "2022-06-01",
"Service": "private_zone",
"Region": "cn-beijing"
},
"Result": {
"PageNumber": 1,
"PageSize": 10,
"Total": 25,
"BindZones": [
{
"ZID": 1013,
"AccountID": "2100xxxxx"
}
]
}
}
Error codes
The following table lists the error codes related to the business logic for this API. For details, see Common error codes.
Status code | Error codes | Error message | Description |
400 | ErrParamInvalid | validation fail: params:[%s] , value:[%v] | Parameter validation failed |
400 | ErrParsingParams | parsing params error | Failed to parse the request. |
500 | ErrInternalServer | server internal error | Internal service error |
Last updated: 2026.03.13 15:51:53
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
