获取私有域列表
最近更新时间: 2026-10-11 00:12:40
1. 接口描述
接口请求域名: vpcdns.api3.fincloud.tencent.com。
获取私有域列表
默认接口请求频率限制:20次/秒。
接口更新时间:2026-02-09 14:20:39。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:DescribePrivateZoneList |
| Version | 是 | 否 | String | 公共参数,本接口取值:2019-10-25 |
| Region | 是 | 否 | String | 公共参数,地域信息本接口不需要传递此参数。 |
| SystemUin | 否 | 是 | String | 系统帐户uin,需要加白使用 示例值: 100000000328 |
| Offset | 否 | 是 | Int64 | 分页偏移量,从0开始 示例值: 1 |
| Limit | 否 | 是 | Int64 | 分页限制数目, 最大100,默认20 示例值: 10 |
| Filters | 否 | 是 | Array of Filter | 过滤参数 示例值:查看 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Int64 | 私有域数量 示例值: 10 |
| PrivateZoneSet | Array of PrivateZone | 私有域列表 示例值:查看 |
| CreatedAt | Datetime | 请求返回时间 示例值: 2014-08-03 12:00:00 |
| Info | DomainCountInfo | 域名数量信息 示例值:查看 |
| Domains | Array of DomainDetail | 域名信息 示例值:查看 |
| CreatedAtIso | Datetime_iso | 请求响应时间Iso 示例值: 2024-06-04T15:30:00Z |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | |
| InvalidParameterValue | |
| MissingParameter | |
| UnknownParameter | |
| InternalError | |
| UnauthorizedOperation | |
| UnsupportedOperation | |
| ResourceNotFound | |
| LimitExceeded | |
| ResourceUnavailable | |
| ResourceInsufficient | |
| FailedOperation | |
| ResourceInUse | |
| ResourcesSoldOut | |
| AuthFailure | |
| OperationDenied | |
| RequestLimitExceeded | |
| InternalError.UndefiendError | 错误未定义 |
| UnauthorizedOperation.UnauthorizedAccount | |
| ResourceNotFound.ServiceNotSubscribed |
5. 示例
示例1 查询私有域详情列表
输入示例
{
"Limit":"1",
"Offset":"0"
}
输出示例
{
"Response": {
"RequestId": "a92efb27-74e6-462a-9b92-c836468eb111",
"TotalCount": 22,
"PrivateZoneSet": [
{
"ZoneId": "zone-e1g2senm",
"OwnerUin": 100000123998,
"Domain": "b.ac.cn",
"CreatedOn": "2022-11-14 16:42:58",
"UpdatedOn": "2022-11-14 16:42:59",
"RecordCount": 0,
"Remark": "tag",
"VpcSet": [
{
"UniqVpcId": "vpc-39kkc543",
"Region": "ap-taipei"
}
],
"AccountVpcSet": [],
"Status": "ENABLED",
"DnsForwardStatus": "ENABLED",
"CnameSpeedupStatus": "ENABLED",
"Tags": [],
"IsCustomTld": false,
"ForwardRuleName": "",
"ForwardRuleType": "",
"ForwardAddress": "",
"EndPointName": ""
}
]
}
}