tencent cloud

APIs

DescribeSecurityScoreOverview

Download
聚焦模式
字号
最后更新时间: 2026-09-01 10:34:22

1. API Description

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

This API is used to obtain the security score overview and real-time compute point deductions in each dimension and sub-item.

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: DescribeSecurityScoreOverview.
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
Score Integer

Security score
Value range: [0, 100]

Level String

Security level
Enumeration values:
safe: safe (90-100 points)
good: good (70-89 points)
medium: general (40-69 points)
danger: dangerous (0-39 points)

ScoreStatus String

Score status
Enumeration values:
success: All data sources are normal
partial_error: Some data sources used cache
stale: Used the last complete snapshot
error: Unable to calculate

InitialScore Integer

Initial score
Default value: 100

RiskCategoryCount Integer

Number of categories with risks (it is advisable to process category X risks as soon as possible)

DeductScore Integer

Total point deduction.

CalculatedAt String

Calculation time
Parameter format: YYYY-MM-DDTHH:mm:ss+08:00

Dimensions Array of DimensionItem

Dimension details, including sub-item point deductions and to-do items

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 Get Security Score Overview

Input Example

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

{
    "MemberId": [
        "mem-*********************429"
    ]
}

Output Example

{
    "Response": {
        "Score": 85,
        "Level": "good",
        "ScoreStatus": "success",
        "InitialScore": 100,
        "RiskCategoryCount": 3,
        "DeductScore": 15,
        "CalculatedAt": "2026-07-18T10:30:00+08:00",
        "Dimensions": [],
        "RequestId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    }
}

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

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InternalError Internal error.
InvalidParameter Parameter error.

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈