tencent cloud

APIs

DocumentaçãoAPIsCloud Security CenterBilling APIsDescribeCSPMPayInfo

DescribeCSPMPayInfo

Download
Modo Foco
Tamanho da Fonte
Última atualização: 2026-09-01 10:04:45

1. API Description

Domain name for API request: csip.intl.tencentcloudapi.com.

This API is used to obtain purchased CSPM order information.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeCSPMPayInfo.
Version Yes String Common Params. The value used for this API: 2022-11-21.
Region No String Common Params. This parameter is not required.
MemberId.N No Array of String Group Account Member ID

3. Output Parameters

Parameter Name Type Description
AppID Integer APPID
OrderStatus Integer Order status. 0: not purchased; 1: normal; 2: isolated; 3: terminated; 6: in trial; 7: expired
CSPMNum Integer Purchased CSPM scan quota
UsedCount Integer Consumed CSPM scan quota
GrantedCSPMNum Integer Complimentary CSPM scan quota
PayMode Integer Payment mode. 0: pay-as-you-go. 1: prepaid.
IsSelfBuy Integer Whether to purchase separately. 1: purchase separately; 2: shared by other accounts.
BeginTime String Order start time.
EndTime String Order expiration time
AutoRenew Integer 0: not set by the user, 1: set to auto-renew by the user, 2: set not to auto-renew by the user
TimeSpan Integer Order duration
TimeUnit String Duration unit.
ResourceId String Resource ID
BetaEndTime String Open beta end time
TimeNow String Current system time.
IsShareToOther Integer Whether to share with other accounts. 1: yes; 2: no
Uin String uin
NickName String Nickname
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Query purchased CSPM order information

Input Example

POST / HTTP/1.1
Host: csip.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCSPMPayInfo
<Common request parameters>

{
    "MemberId": [
        "mem-68b8087a611258000"
    ]
}

Output Example

{
    "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": "Sheng Sheng Oolong",
        "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
    }
}

Example2 Retrieve CSPM info for accounts not purchased

Input Example

POST / HTTP/1.1
Host: csip.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCSPMPayInfo
<Common request parameters>

{
    "MemberId": [
        "mem-6def087a65268000"
    ]
}

Output Example

{
    "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. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

Anterior: DescribeUserCSPMInfoListPróximo: DescribeUserAKInfoList

Ajuda e Suporte

Esta página foi útil?

comentários