Domain name for API request: csip.tencentcloudapi.com.
This API is used to query the list of public IP assets.
A maximum of 20 requests can be initiated per second for this API.
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: DescribePublicIpAssets. |
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 | CSC tags of the asset |
Parameter Name | Type | Description |
---|---|---|
Data | Array of IpAssetListVO | Data list Note: This field may return·null, indicating that no valid values can be obtained. |
Total | Integer | Total number of results |
AssetLocationList | Array of FilterDataObject | List of asset locations Note: This field may return·null, indicating that no valid values can be obtained. |
IpTypeList | Array of FilterDataObject | List of IP types Note: This field may return·null, indicating that no valid values can be obtained. |
RegionList | Array of FilterDataObject | List of regions Note: This field may return·null, indicating that no valid values can be obtained. |
DefenseStatusList | Array of FilterDataObject | List of protection status Note: This field may return·null, indicating that no valid values can be obtained. |
AssetTypeList | Array of FilterDataObject | List of asset types Note: This field may return·null, indicating that no valid values can be obtained. |
AppIdList | Array of FilterDataObject | List of AppIds Note: This field may return·null, indicating that no valid values can be obtained. |
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. |
POST / HTTP/1.1
Host: csip.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribePublicIpAssets
<Common request parameters>
{
"Filter": {
"Limit": 0,
"Offset": 0,
"Order": "abc",
"By": "abc",
"Filters": [
{
"Name": "abc",
"Values": [
"abc"
],
"OperatorType": 0
}
],
"StartTime": "abc",
"EndTime": "abc"
},
"Tags": [
{
"TagKey": "abc",
"TagValue": "abc"
}
]
}
{
"Response": {
"Data": [
{
"AssetId": "abc",
"AssetName": "abc",
"AssetType": "abc",
"Region": "abc",
"CFWStatus": 1,
"AssetCreateTime": "abc",
"PublicIp": "abc",
"PublicIpType": 1,
"VpcId": "abc",
"VpcName": "abc",
"AppId": 1,
"Uin": "abc",
"NickName": "abc",
"IsCore": 1,
"IsCloud": 1,
"Attack": 1,
"Access": 1,
"Intercept": 1,
"InBandwidth": "abc",
"OutBandwidth": "abc",
"InFlow": "abc",
"OutFlow": "abc",
"LastScanTime": "abc",
"PortRisk": 1,
"VulnerabilityRisk": 1,
"ConfigurationRisk": 1,
"ScanTask": 1,
"WeakPassword": 1,
"WebContentRisk": 1,
"Tag": [
{
"Name": "abc",
"Value": "abc"
}
],
"AddressId": "abc",
"MemberId": "abc",
"RiskExposure": 0,
"IsNewAsset": 1,
"VerifyStatus": 0
}
],
"Total": 1,
"AssetLocationList": [
{
"Value": "abc",
"Text": "abc"
}
],
"IpTypeList": [
{
"Value": "abc",
"Text": "abc"
}
],
"RegionList": [
{
"Value": "abc",
"Text": "abc"
}
],
"AppIdList": [
{
"Value": "abc",
"Text": "abc"
}
],
"DefenseStatusList": [
{
"Value": "abc",
"Text": "abc"
}
],
"AssetTypeList": [
{
"Value": "abc",
"Text": "abc"
}
],
"RequestId": "abc"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
There is no error code related to the API business logic. For other error codes, please see Common Error Codes.
Was this page helpful?