1. 接口描述
接口请求域名： dnspod.tencentcloudapi.com 。
获取套餐列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeDomainVipList。 |
| Version | 是 | String | 公共参数，本接口取值：2021-03-23。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| Offset | 是 | Integer | 偏移量，默认值为0。 示例值：0 |
| Limit | 是 | Integer | 限制数量，默认值为20。 示例值：20 |
| Keyword | 否 | String | 通过关键字搜索域名关联的套餐，默认值为空，为空时不作为筛选条件。 示例值：dnspod.cn |
| ResourceIdList.N | 否 | Array of String | 使用资源ID列表查询 |
| GradeList.N | 否 | Array of String | 需要筛选的套餐版本 示例值：["DP_Plus","DP_Ultra"] |
| GetUnbindResource | 否 | Boolean | 是否只获取未绑定域名套餐 示例值：true |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 符合筛选条件的套餐总数 示例值：1 |
| PackageList | Array of PackageListItem | 套餐信息列表 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取套餐列表
获取套餐列表
输入示例
POST / HTTP/1.1
Host: dnspod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDomainVipList
<公共请求参数>
{
"Offset": 0,
"Limit": 20,
"Keyword": "test"
}输出示例
{
"Response": {
"PackageList": [
{
"Domain": "zhaodapian.com",
"DomainId": 12614766,
"Downgrade": false,
"Grade": "DP_Ultra",
"GradeLevel": 10,
"GradeTitle": "尊享版",
"IsGracePeriod": "no",
"IsSubDomain": false,
"RemainTimes": 10,
"ResourceId": "5032fe04",
"SecurityInfo": {
"IsDefendFree": "yes",
"Key": "security_almighty",
"ResourceId": "503301e0"
},
"Status": "enable",
"VipAutoRenew": "yes",
"VipEndAt": "2024-01-16 15:56:31",
"VipStartAt": "2023-01-16 15:56:31"
},
{
"Domain": null,
"DomainId": 0,
"Downgrade": false,
"Grade": "DP_Plus",
"GradeLevel": 3,
"GradeTitle": "专业版",
"IsGracePeriod": "no",
"IsSubDomain": null,
"RemainTimes": 10,
"ResourceId": "9bae4aaf",
"SecurityInfo": null,
"Status": "enable",
"VipAutoRenew": "default",
"VipEndAt": "2023-12-14 20:00:36",
"VipStartAt": "2022-12-14 20:01:48"
},
{
"Domain": "yyds3.com",
"DomainId": 12620578,
"Downgrade": true,
"Grade": "DP_Ultra",
"GradeLevel": 10,
"GradeTitle": "尊享版",
"IsGracePeriod": "no",
"IsSubDomain": false,
"RemainTimes": 7,
"ResourceId": "99a1869f",
"SecurityInfo": {
"IsDefendFree": "yes",
"Key": "security_almighty",
"ResourceId": "9ba4b170"
},
"Status": "enable",
"VipAutoRenew": "default",
"VipEndAt": "2023-12-14 17:40:40",
"VipStartAt": "2022-12-14 20:37:48"
},
{
"Domain": "aaaa.cn",
"DomainId": 12613589,
"Downgrade": false,
"Grade": "DP_Ultra",
"GradeLevel": 10,
"GradeTitle": "尊享版",
"IsGracePeriod": "no",
"IsSubDomain": false,
"RemainTimes": 0,
"ResourceId": "a0bed80e",
"SecurityInfo": {
"IsDefendFree": "yes",
"Key": "security_almighty",
"ResourceId": "a0bedda5"
},
"Status": "enable",
"VipAutoRenew": "default",
"VipEndAt": "2023-04-28 11:37:17",
"VipStartAt": "2022-12-02 15:50:50"
},
{
"Domain": null,
"DomainId": 0,
"Downgrade": true,
"Grade": "DP_Extra",
"GradeLevel": 6,
"GradeTitle": "企业基础版",
"IsGracePeriod": "yes",
"IsSubDomain": null,
"RemainTimes": 1,
"ResourceId": "5a8fb3ea",
"SecurityInfo": null,
"Status": "enable",
"VipAutoRenew": "default",
"VipEndAt": "2023-02-23 11:24:43",
"VipStartAt": "2022-12-02 15:51:17"
},
{
"Domain": "jd.com",
"DomainId": 12600783,
"Downgrade": true,
"Grade": "DP_Ultra",
"GradeLevel": 10,
"GradeTitle": "尊享版",
"IsGracePeriod": "yes",
"IsSubDomain": false,
"RemainTimes": 10,
"ResourceId": "5a160c26",
"SecurityInfo": {
"IsDefendFree": "yes",
"Key": "security_almighty",
"ResourceId": "5a79443c"
},
"Status": "enable",
"VipAutoRenew": "default",
"VipEndAt": "2023-02-23 10:52:16",
"VipStartAt": "2022-02-23 10:52:16"
}
],
"RequestId": "bbe13f12-dfeb-4e19-8668-3eb8c828cefc",
"TotalCount": 6
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| AuthFailure.UnauthorizedOperation | 操作未授权。 |
| FailedOperation | 操作失败。 |
| FailedOperation.AccountIsLocked | 抱歉，该账户已经被锁定。 |
| FailedOperation.LoginAreaNotAllowed | 账号异地登录，请求被拒绝。 |
| FailedOperation.LoginFailed | 登录失败，请检查账号和密码是否正确。 |
| FailedOperation.LoginTimeout | 登录已经超时，请重新登录。 |
| FailedOperation.NotBatchTaskOwner | 权限错误，您无法查看该任务的详情。 |
| FailedOperation.NotRealNamedUser | 未实名认证用户，请先完成实名认证再操作。 |
| FailedOperation.NotResourceOwner | 您没有权限操作此资源。 |
| FailedOperation.UnknowError | 操作未响应，请稍后重试。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.AccountIsBanned | 您的账号已被系统封禁，如果您有任何疑问请与我们联系。 |
| InvalidParameter.AcquireHashExists | 域名正在取回，请勿重复操作。 |
| InvalidParameter.ActionInvalid | 无效的操作。 |
| InvalidParameter.InvalidIp | 不是合法的IP段。 |
| InvalidParameter.InvalidSecretId | 无效密钥 ID。 |
| InvalidParameter.InvalidSignature | 无效签名。 |
| InvalidParameter.InvalidSrcDomainId | 源域名ID格式不正确。 |
| InvalidParameter.InvalidTime | 无效的时间。 |
| InvalidParameter.OperateFailed | 操作失败，请稍后再试。 |
| InvalidParameter.OperationIsTooFrequent | 当前操作过于频繁，请 1 分钟后重试。 |
| InvalidParameter.OptypeNotSupported | 不支持的操作类型。 |
| InvalidParameter.ParamInvalid | param 格式错误。 |
| InvalidParameter.ParamsIllegal | 参数不合法，请求被拒绝。 |
| InvalidParameter.ParamsMissing | 参数错误。 |
| InvalidParameter.PermissionDenied | 鉴权失败。 |
| InvalidParameter.PtrInvalidPublicIp | 无效的 IP 地址。 |
| InvalidParameter.PtrIpNotOwner | 你不是该 IP 的所有者，无法进行此操作。 |
| InvalidParameter.QcloudUinInvalid | 用户UIN无效。 |
| InvalidParameter.RequestIpLimited | 您的IP非法，请求被拒绝。 |
| InvalidParameter.ShareUserExists | 已经存在此共享记录。 |
| InvalidParameter.TimestampExpired | 时间戳已过期。 |
| InvalidParameter.ToolsDomainInvalid | 域名无效。 |
| InvalidParameter.ToolsDomainNotReged | 域名未注册。 |
| InvalidParameter.UserAlreadyLocked | 账号已经被锁定。 |
| InvalidParameter.UserNotExists | 用户不存在。 |
| InvalidParameterValue | 参数取值错误。 |
| LimitExceeded | 超过配额限制。 |
| LimitExceeded.FailedLoginLimitExceeded | 登录失败次数过多已被系统封禁。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
| OperationDenied.AccessDenied | 您没有权限执行此操作。 |
| OperationDenied.AgentSubordinateDenied | 代理名下的用户不能使用此功能。 |
| OperationDenied.DomainOwnerAllowedOnly | 仅域名所有者可进行此操作。 |
| OperationDenied.NoPermissionToOperateDomain | 当前域名无权限，请返回域名列表。 |
| OperationDenied.NotGrantedByOwner | 您还没有获取到授权，无法执行此操作。 |
| OperationDenied.PostRequestAcceptOnly | 只支持 POST 方法提交数据。 |
| RequestLimitExceeded | 请求的次数超过了频率限制。 |
| RequestLimitExceeded.CreateDomainLimit | 您的账号在短时间内添加了大量的域名，请控制添加频率。 |
| RequestLimitExceeded.RequestLimitExceeded | API请求次数超出限制。 |
| ResourceNotFound.NoDataOfDomain | 域名列表为空。 |
| UnauthorizedOperation | 未授权操作。 |
| UnknownParameter | 未知参数错误。 |
| UnsupportedOperation | 操作不支持。 |
