1. 接口描述
接口请求域名: csip.tencentcloudapi.com 。
获取已购CSPM订单信息
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeCSPMPayInfo。 |
| Version | 是 | String | 公共参数,本接口取值:2022-11-21。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| MemberId.N | 否 | Array of String | 集团账号的成员id 示例值:["mem-6wfo0fzks3","mem-85fo0fzks4"] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| AppID | Integer | APPID 示例值:12117826 |
| OrderStatus | Integer | 订单状态 0未购买 1正常,2隔离,3销毁,6试用中,7到期 示例值:1 |
| CSPMNum | Integer | 已购CSPM扫描配额 示例值:15000 |
| UsedCount | Integer | 已消耗CSPM扫描配额 示例值:3200 |
| GrantedCSPMNum | Integer | 赠送CSPM扫描配额 示例值:5000 |
| PayMode | Integer | 支付模式,0-后付费 1-预付费 示例值:1 |
| IsSelfBuy | Integer | 是否单独购买,1-单独购买,2-被其它账号共享 示例值:2 |
| BeginTime | String | 订单开始时间 示例值:2025-04-10 10:37:02 |
| EndTime | String | 订单到期时间 示例值:2025-05-10 10:37:02 |
| AutoRenew | Integer | 0-用户未设置,1-用户设置自动续费,2-用户设置不自动续费 示例值:1 |
| TimeSpan | Integer | 订单时长 示例值:1 |
| TimeUnit | String | 时长单位 示例值:m |
| ResourceId | String | 资源id 示例值:csip-cspm-241 |
| BetaEndTime | String | 公测结束时间 示例值:2025-05-10 10:37:02 |
| TimeNow | String | 系统当前时间 示例值:2025-05-10 10:37:02 |
| IsShareToOther | Integer | 是否分享给其它账号,1-是,2-否 示例值:1 |
| Uin | String | uin 示例值:100011132178 |
| NickName | String | 昵称 示例值:声声乌龙 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取已购CSPM订单信息
输入示例
POST / HTTP/1.1
Host: csip.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCSPMPayInfo
<公共请求参数>
{
"MemberId": [
"mem-68b8087a611258000"
]
}
输出示例
{
"Response": {
"AppID": 12117826,
"AutoRenew": 1,
"BeginTime": "2025-04-10 10:37:02",
"BetaEndTime": "2025-05-10 10:37:02",
"CSPMNum": 15000,
"EndTime": "2025-05-10 10:37:02",
"GrantedCSPMNum": 5000,
"IsSelfBuy": 2,
"IsShareToOther": 1,
"NickName": "声声乌龙",
"OrderStatus": 1,
"PayMode": 1,
"RequestId": "5b8e1c47-0671-4021-9a11-8aeb1c03e461",
"ResourceId": "csip-cspm-241",
"TimeNow": "2025-05-10 10:37:02",
"TimeSpan": 1,
"TimeUnit": "m",
"Uin": "100011132178",
"UsedCount": 3200
}
}
示例2 获取未购买账号的CSPM信息
输入示例
POST / HTTP/1.1
Host: csip.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCSPMPayInfo
<公共请求参数>
{
"MemberId": [
"mem-6def087a65268000"
]
}
输出示例
{
"Response": {
"AppID": 0,
"AutoRenew": 0,
"BeginTime": "",
"BetaEndTime": "2025-05-06 12:00:00",
"CSPMNum": 0,
"EndTime": "",
"GrantedCSPMNum": 0,
"IsSelfBuy": 0,
"IsShareToOther": 0,
"NickName": "",
"OrderStatus": 0,
"PayMode": 0,
"RequestId": "6014aa34-c145-47c7-b039-14ee95b0e737",
"ResourceId": "",
"TimeNow": "2025-05-23 10:49:55",
"TimeSpan": 0,
"TimeUnit": "",
"Uin": "",
"UsedCount": 0
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。