1. 接口描述
接口请求域名: dnspod.tencentcloudapi.com 。
获取增值服务列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeVasList。 |
Version | 是 | String | 公共参数,本接口取值:2021-03-23。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
Offset | 否 | Integer | 偏移量,默认值为0。 示例值:0 |
Limit | 否 | Integer | 限制数量,默认值为20。 示例值:20 |
DomainId | 否 | Integer | 域名ID 示例值:12 |
ResourceIdList.N | 否 | Array of String | 使用资源 ID 列表查询 |
LimitType | 否 | String | 增值服务类型 示例值:D_URLCOUNT |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 符合筛选条件的套餐总数 示例值:1 |
VasList | Array of VasListItem | 增值服务信息列表 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取增值服务列表
获取增值服务列表
输入示例
POST / HTTP/1.1
Host: dnspod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeVasList
<公共请求参数>
{
"Offset": 0,
"Limit": 10,
"DomainId": 12
}
输出示例
{
"Response": {
"RequestId": "27c8df50-206e-42db-a031-8b7f15c0d2dc",
"VasList": [
{
"LimitNumber": 5,
"StartedAt": "2022-05-22",
"EndedAt": "2023-05-22",
"ResourceId": "9axxxc77",
"AutoRenew": "default",
"Domain": "example.com",
"BindType": "user",
"Key": "ptr",
"Name": "PTR 反解析记录",
"CanRenew": true,
"VipDomain": false
}
],
"TotalCount": 1
}
}
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 | 操作不支持。 |