1. 接口描述
接口请求域名: ssl.tencentcloudapi.com 。
获得权益包列表
默认接口请求频率限制:10次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribePackages。 |
Version | 是 | String | 公共参数,本接口取值:2019-12-05。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
Offset | 否 | Integer | 偏移量,默认0。 示例值:0 |
Limit | 否 | Integer | 限制数目,默认20。 示例值:20 |
Status | 否 | String | 按状态筛选。状态值包括usable(可用),used(已用),expired(已过期),refund(已退款) 示例值:refund |
ExpireTime | 否 | String | 按过期时间升序或降序排列,可选值为asc(升序)和desc(降序) 示例值:asc |
PackageId | 否 | String | 按权益包ID搜索。 示例值:X22080117530008 |
Type | 否 | String | 按权益包类型搜索。类型包括:ssl_100(证书批量权益100点),ssl_500(证书批量权益500点),ssl_2000(证书批量权益2000点) 示例值:ssl_100 |
Pid | 否 | Integer | 子产品编号 示例值:10078 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Packages | Array of PackageInfo | 权益包列表。 |
TotalCount | Integer | 总条数。 示例值:10 |
TotalBalance | Integer | 权益点总余额。 示例值:10 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获得权益包列表
输入示例
POST / HTTP/1.1
Host: ssl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribePackages
<公共请求参数>
{
"Offset": 0,
"Limit": 10,
"Status": "used"
}
输出示例
{
"Response": {
"TotalCount": 1,
"Packages": [
{
"Status": "used",
"UpdateTime": "2022-09-13",
"Total": 1,
"SourceType": "transferIn",
"TransferOutInfos": [
{
"UpdateTime": "2023-09-13",
"ReceiverUin": 1,
"ReceivePackageId": "H09******88",
"TransferCount": 1,
"ReceiveTime": "2023-10-19",
"ExpireTime": "2023-12-19",
"TransferCode": "hg****jj",
"PackageId": "K234*******77",
"TransferStatus": "refund",
"CreateTime": "2023-09-18"
}
],
"SourceUin": 1,
"ExpireTime": "2023-12-18",
"PackageId": "J88*****867",
"Balance": 1,
"Type": "buy",
"CreateTime": "2023-08-26"
}
],
"RequestId": "hdg**********jdj",
"TotalBalance": 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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
LimitExceeded.RateLimitExceeded | 单位时间内接口请求频率达到限制。 |