tencent cloud

All product documents
APIs
DocumentationAPIsCloud Security CenterRisk Center APIsDescribeRiskCenterAssetViewPortRiskList
DescribeRiskCenterAssetViewPortRiskList
Last updated: 2025-03-11 22:54:53
DescribeRiskCenterAssetViewPortRiskList
Last updated: 2025-03-11 22:54:53

1. API Description

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

This API is used to query the list of port risks by assets.

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: DescribeRiskCenterAssetViewPortRiskList.
Version Yes String Common Params. The value used for this API: 2022-11-21.
Region No String Common Params. This parameter is not required.
Filter No Filter Filter conditions
Tags.N No Array of AssetTag Asset tags

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Total number of entries
Data Array of AssetViewPortRisk List of configuration risks
StatusLists Array of FilterDataObject List of risk handling status
LevelLists Array of FilterDataObject List of risk levels
SuggestionLists Array of FilterDataObject List of fix suggestions
InstanceTypeLists Array of FilterDataObject List of asset types
FromLists Array of FilterDataObject List of check source
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 Obtaining the Port Risk List from the Asset Perspective

This example shows you how to obtain the port risk list from the asset perspective.

Input Example

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

{
    "Filter": {
        "Limit": 1
    }
}

Output Example

{
    "Response": {
        "Data": [
            {
                "AffectAsset": "1.1.1.1",
                "AppId": "abcd",
                "Component": "OpenSSH",
                "FirstTime": "2024-04-19 16:14:02",
                "From": "Cloud Security Center",
                "Id": "b6d76******",
                "Index": "1654******",
                "InstanceId": "ins-*****",
                "InstanceName": "abcd",
                "InstanceType": "CVM",
                "Level": "middle",
                "Nick": "abcd",
                "Port": 22,
                "Protocol": "tcp",
                "RecentTime": "2024-06-07 14:22:58",
                "Service": "ssh",
                "Status": 3,
                "Suggestion": 1,
                "Uin": "abcd"
            }
        ],
        "FromLists": [
            {
                "Text": "Cloud Security Center",
                "Value": "0"
            },
            {
                "Text": "Traffic awareness",
                "Value": "3"
            }
        ],
        "InstanceTypeLists": [
            {
                "Text": "CLB",
                "Value": "CLB"
            },
            {
                "Text": "CVM",
                "Value": "CVM"
            },
            {
                "Text": "EIP",
                "Value": "EIP"
            },
            {
                "Text": "VPN",
                "Value": "VPN"
            },
            {
                "Text": "NAT",
                "Value": "NAT"
            },
            {
                "Text": "OTHER",
                "Value": "OTHER"
            },
            {
                "Text": "LH",
                "Value": "LH"
            },
            {
                "Text": "HAVIP",
                "Value": "HAVIP"
            },
            {
                "Text": "NATFW",
                "Value": "NATFW"
            },
            {
                "Text": "Unknown",
                "Value": "unknown"
            },
            {
                "Text": "PROBE",
                "Value": "PROBE"
            },
            {
                "Text": "TSE",
                "Value": "TSE"
            },
            {
                "Text": "EC2",
                "Value": "EC2"
            }
        ],
        "LevelLists": [
            {
                "Text": "Critical",
                "Value": "extreme"
            },
            {
                "Text": "High-risk",
                "Value": "high"
            },
            {
                "Text": "Middle-risk",
                "Value": "middle"
            },
            {
                "Text": "Low-risk",
                "Value": "low"
            },
            {
                "Text": "Info",
                "Value": "info"
            }
        ],
        "RequestId": "c95a495b-e2cb-4449-b101-1848c421aadd",
        "StatusLists": [
            {
                "Text": "Blocked",
                "Value": "3"
            },
            {
                "Text": "Unprocessed",
                "Value": "0"
            },
            {
                "Text": "Marked as processed",
                "Value": "1"
            },
            {
                "Text": "Ignored",
                "Value": "2"
            }
        ],
        "SuggestionLists": [
            {
                "Text": "Maintain the current situation",
                "Value": "0"
            },
            {
                "Text": "Restrict access",
                "Value": "1"
            },
            {
                "Text": "Block port",
                "Value": "2"
            }
        ],
        "TotalCount": 42
    }
}

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
AuthFailure CAM signature/authentication error.
DryRunOperation The request would have succeeded, but the DryRun parameter was used.
FailedOperation Operation failed.
InternalError An internal error occurs.
InvalidFilter
InvalidParameter The parameter is incorrect.
InvalidParameter.DecryptError Decrypt error
InvalidParameterValue Invalid parameter value.
LimitExceeded The quota limit is reached.
MissingParameter Missing parameters.
OperationDenied Operation denied.
RegionError
RequestLimitExceeded Too many requests.
ResourceInUse Occupied resource
ResourceInsufficient Resources are insufficient.
ResourceNotFound The resource doesn't exist.
ResourceUnavailable The resource is unavailable
ResourcesSoldOut The resources have been sold out.
UnauthorizedOperation The operation is unauthorized.
UnauthorizedOperation.CloudAudit
UnauthorizedOperation.Cos
UnknownParameter The parameter is unknown.
UnsupportedOperation The operation is not supported.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon