1. 接口描述
接口请求域名: tcss.tencentcloudapi.com 。
DescribePurchaseStateInfo 查询容器安全服务已购买信息
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribePurchaseStateInfo。 |
Version | 是 | String | 公共参数,本接口取值:2020-11-01。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
State | Integer | 0:可申请试用可购买;1:只可购买(含试用审核不通过和试用过期);2:试用生效中;3:专业版生效中;4:专业版过期 示例值:0 |
AllCoresCnt | Integer | 总资源核数 = 总防护核数 + 未防护核数 示例值:10 |
CoresCnt | Integer | 总防护核数 =已购核数+ 试用赠送核数 +弹性计费核数 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
UndefendCoresCnt | Integer | 未防护核数(未开启防护资源核数) 示例值:10 |
AuthorizedCoresCnt | Integer | 已购买核数 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
GivenAuthorizedCoresCnt | Integer | 试用赠送专业版核心数 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
CurrentFlexibleCoresCnt | Integer | 当前弹性计费核数数量 示例值:10 |
ImageCnt | Integer | 镜像数 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
AuthorizedImageCnt | Integer | 已授权镜像数 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
ExpirationTime | String | 过期时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2021-05-28 00:00:00 |
PurchasedAuthorizedCnt | Integer | 已购买镜像授权数 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
AutomaticRenewal | Integer | 0表示默认状态(用户未设置,即初始状态), 1表示自动续费,2表示明确不自动续费(用户设置) 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
GivenAuthorizedCnt | Integer | 试用期间赠送镜像授权数,可能会过期 注意:此字段可能返回 null,表示取不到有效值。 示例值:500 |
BeginTime | String | 起始时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2021-05-28 00:00:00 |
SubState | String | 子状态(具体意义依据State字段而定) State为4时,有效值为: ISOLATE(隔离) DESTROED(已销毁) 注意:此字段可能返回 null,表示取不到有效值。 示例值:DESTROED |
InquireKey | String | 计费key 注意:此字段可能返回 null,表示取不到有效值。 示例值:sv_yunjing_css_pem |
DefendPolicy | String | 防护策略 示例值:Part |
FlexibleCoresLimit | Integer | 弹性计费核数上限 示例值:5000 |
DefendClusterCoresCnt | Integer | 已防护集群核数 示例值:48 |
DefendHostCoresCnt | Integer | 已防护主机核数 示例值:22 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询容器安全服务已购买信息
输入示例
POST / HTTP/1.1
Host: tcss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribePurchaseStateInfo
<公共请求参数>
{}
输出示例
{
"Response": {
"AllCoresCnt": 154,
"AuthorizedCoresCnt": 147,
"AuthorizedImageCnt": 287756,
"AutomaticRenewal": 1,
"BeginTime": "2024-09-24 13:01:18",
"CoresCnt": 68,
"CurrentFlexibleCoresCnt": 0,
"DefendClusterCoresCnt": 48,
"DefendHostCoresCnt": 20,
"DefendPolicy": "Part",
"ExpirationTime": "2024-12-24 13:01:18",
"FlexibleCoresLimit": 5000,
"GivenAuthorizedCnt": 0,
"GivenAuthorizedCoresCnt": 0,
"ImageCnt": 291209,
"InquireKey": "sv_yunjing_css_pem",
"PurchasedAuthorizedCnt": 300000,
"RequestId": "e40cad09-f295-42a8-914d-ea84767fb6f1",
"State": 3,
"SubState": "",
"UndefendCoresCnt": 86
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InternalError.ErrRoleNotExist | 用户未授权。 |
InternalError.MainDBFail | 操作数据库失败。 |
InvalidParameter | 参数错误。 |