获取私有域信息
最近更新时间: 2026-10-11 00:12:40
1. 接口描述
接口请求域名： vpcdns.api3.fincloud.tencent.com。
获取私有域信息
默认接口请求频率限制：20次/秒。
接口更新时间：2026-01-26 21:11:21。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribePrivateZone |
| Version | 是 | 否 | String | 公共参数，本接口取值：2019-10-25 |
| Region | 是 | 否 | String | 公共参数，地域信息本接口不需要传递此参数。 |
| ZoneId | 是 | 是 | String | 私有域id 示例值： zone-dm1igr1 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| PrivateZone | PrivateZone | 私有域详情 示例值：查看 |
| CreatedAt | Datetime | 请求返回时间 示例值： 2014-08-03 12:00:00 |
| 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 | |
| DryRunOperation | |
| ResourcesSoldOut | |
| AuthFailure | |
| OperationDenied | |
| RequestLimitExceeded | |
| InternalError.UndefiendError | 错误未定义 |
| InvalidParameter.ZoneNotExists | 解析域不存在 |
| UnauthorizedOperation.UnauthorizedAccount | |
| ResourceNotFound.ServiceNotSubscribed |
5. 示例
示例1 查询私有域详情
输入示例
{
"ZoneId":"zone-p0152fh2"
}
输出示例
{
"Response": {
"RequestId": "4b744f80-5061-4efa-b258-667316615200",
"PrivateZone": {
"ZoneId": "zone-p01g24h2",
"OwnerUin": 100000123998,
"Domain": "aarp",
"CreatedOn": "2022-02-16 14:54:51",
"UpdatedOn": "2022-02-16 20:12:22",
"RecordCount": 2,
"Remark": "",
"VpcSet": [
{
"UniqVpcId": "vpc-39kkc1s7",
"Region": "ap-region"
}
],
"AccountVpcSet": [],
"Status": "ENABLED",
"DnsForwardStatus": "DISABLED",
"CnameSpeedupStatus": "DISABLED",
"Tags": [],
"IsCustomTld": false,
"ForwardRuleName": "",
"ForwardRuleType": "",
"ForwardAddress": "",
"EndPointName": ""
}
}
}