1. 接口描述
接口请求域名: csip.tencentcloudapi.com 。
ip公网列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribePublicIpAssets。 |
Version | 是 | String | 公共参数,本接口取值:2022-11-21。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
MemberId.N | 否 | Array of String | 集团账号的成员id 示例值:["mem-6wfo0fzks3","mem-85fo0fzks4"] |
Filter | 否 | Filter | 过滤器参数 |
Tags.N | 否 | Array of AssetTag | 安全中心自定义标签 示例值:[ {"TagKey":"key1","TagValue":"value1"} ] |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Data | Array of IpAssetListVO | 列表 |
Total | Integer | 总数 示例值:10 |
AssetLocationList | Array of FilterDataObject | 资产归属地 示例值:[ { "Text": "腾讯云", "Value": "1" }, { "Text": "其他", "Value": "2" } ] |
IpTypeList | Array of FilterDataObject | ip列表枚举 示例值:[ { "Text": "公网IP", "Value": "1" }, { "Text": "弹性IP", "Value": "2" }, { "Text": "未知", "Value": "0" } ] |
RegionList | Array of FilterDataObject | 地域列表枚举 |
DefenseStatusList | Array of FilterDataObject | 防护枚举 示例值:[ { "Text": "未防护", "Value": "1" } ] |
AssetTypeList | Array of FilterDataObject | 资产类型枚举 |
AppIdList | Array of FilterDataObject | AppId枚举 示例值:[ { "Text": "1302396212401", "Value": "1302396212401" } ] |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 资产查询
输入示例
POST / HTTP/1.1
Host: csip.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribePublicIpAssets
<公共请求参数>
{
"Filter": {
"Filters": [
{
"Name": "CFWStatus",
"Values": [
"1"
],
"OperatorType": 7
},
{
"Name": "TimeRange",
"Values": [
"2"
],
"OperatorType": 7
}
],
"Limit": 10,
"Offset": 20,
"Order": "desc",
"By": "AssetCreateTime"
},
"MemberId": [
"mem-62509c52c13c9201"
]
}
输出示例
{
"Response": {
"AppIdList": [
{
"Text": "1302396212401",
"Value": "1302396212401"
}
],
"AssetLocationList": [
{
"Text": "腾讯云",
"Value": "1"
},
{
"Text": "其他",
"Value": "2"
}
],
"AssetTypeList": [
{
"Text": "非腾讯云主机",
"Value": "OTHER"
},
{
"Text": "CVM",
"Value": "CVM"
},
{
"Text": "HAVIP",
"Value": "HAVIP"
},
{
"Text": "CLB",
"Value": "CLB"
},
{
"Text": "未知",
"Value": "unknown"
}
],
"Data": [
{
"AssetId": "ins-mlyxc7ds",
"AssetName": "cluster-node-10.26",
"PublicIp": "106.52.96.220",
"PublicIpType": 1,
"Region": "ap-guangzhou",
"AssetType": "CVM",
"InBandwidth": "0bps",
"OutBandwidth": "0bps",
"InFlow": "0B",
"OutFlow": "0B",
"Access": 0,
"Attack": 0,
"PortRisk": 0,
"VulnerabilityRisk": 2,
"WeakPassword": 0,
"WebContentRisk": 0,
"RiskExposure": 0,
"CFWStatus": 1,
"AssetCreateTime": "2023-10-26 15:56:48",
"VpcId": "vpc-ommo5hlv",
"VpcName": "Default-VPC",
"AppId": 1302396212401,
"Uin": "10001459211278",
"NickName": "生生乌龙",
"IsCore": 2,
"IsCloud": 1,
"Intercept": 0,
"LastScanTime": "2024-10-30 05:02:29",
"ConfigurationRisk": 3,
"ScanTask": 31,
"Tag": [
{
"Name": "name1",
"Value": "value1"
}
],
"AddressId": "eip-26c8hjt6",
"MemberId": "mem-625c522c0913c901",
"IsNewAsset": 0,
"VerifyStatus": 0
},
{
"AssetId": "asset-k2vqoh1",
"AssetName": "asset-k2vqoh1",
"PublicIp": "43.138.240.106",
"PublicIpType": 0,
"Region": "other",
"AssetType": "未知",
"InBandwidth": "0bps",
"OutBandwidth": "0bps",
"InFlow": "0B",
"OutFlow": "0B",
"Access": 0,
"Attack": 0,
"PortRisk": 0,
"VulnerabilityRisk": 0,
"WeakPassword": 0,
"WebContentRisk": 0,
"RiskExposure": 0,
"CFWStatus": 1,
"AssetCreateTime": "2023-10-11 17:23:31",
"VpcId": "asset-k2vqoh1",
"VpcName": "asset-k2vqoh1",
"AppId": 1302396212401,
"Uin": "10001459211278",
"NickName": "生生乌龙",
"IsCore": 2,
"IsCloud": 2,
"Intercept": 0,
"LastScanTime": "2024-10-30 05:02:29",
"ConfigurationRisk": 0,
"ScanTask": 31,
"Tag": [
{
"Name": "name1",
"Value": "value1"
}
],
"AddressId": "asset-k2vqoh1",
"MemberId": "mem-625c522c0913c901",
"IsNewAsset": 0,
"VerifyStatus": 0
},
{
"AssetId": "asset-k2vqoh1",
"AssetName": "asset-k2vqoh1",
"PublicIp": "39.108.14.10",
"PublicIpType": 0,
"Region": "other",
"AssetType": "未知",
"InBandwidth": "0bps",
"OutBandwidth": "0bps",
"InFlow": "0B",
"OutFlow": "0B",
"Access": 0,
"Attack": 0,
"PortRisk": 0,
"VulnerabilityRisk": 0,
"WeakPassword": 0,
"WebContentRisk": 0,
"RiskExposure": 0,
"CFWStatus": 1,
"AssetCreateTime": "2023-09-06 11:03:28",
"VpcId": "asset-k2vqoh1",
"VpcName": "asset-k2vqoh1",
"AppId": 1302396212401,
"Uin": "10001459211278",
"NickName": "生生乌龙",
"IsCore": 2,
"IsCloud": 3,
"Intercept": 0,
"LastScanTime": "2024-10-30 05:02:29",
"ConfigurationRisk": 0,
"ScanTask": 0,
"Tag": [
{
"Name": "name1",
"Value": "value1"
}
],
"AddressId": "asset-k2vqoh1",
"MemberId": "mem-625c522c0913c901",
"IsNewAsset": 0,
"VerifyStatus": 0
},
{
"AssetId": "havip-8h56wnzs",
"AssetName": "NAT安全网关HaVip_请勿删改",
"PublicIp": "114.132.124.142",
"PublicIpType": 2,
"Region": "ap-guangzhou",
"AssetType": "HAVIP",
"InBandwidth": "0bps",
"OutBandwidth": "0bps",
"InFlow": "0B",
"OutFlow": "0B",
"Access": 0,
"Attack": 0,
"PortRisk": 0,
"VulnerabilityRisk": 0,
"WeakPassword": 0,
"WebContentRisk": 0,
"RiskExposure": 0,
"CFWStatus": 1,
"AssetCreateTime": "2023-06-02 10:16:33",
"VpcId": "asset-k2vqoh1",
"VpcName": "asset-k2vqoh1",
"AppId": 1302396212401,
"Uin": "10001459211278",
"NickName": "生生乌龙",
"IsCore": 1,
"IsCloud": 1,
"Intercept": 0,
"LastScanTime": "2024-10-30 05:02:29",
"ConfigurationRisk": 0,
"ScanTask": 35,
"Tag": [
{
"Name": "name1",
"Value": "value1"
}
],
"AddressId": "eip-egkkeona",
"MemberId": "mem-625c522c0913c901",
"IsNewAsset": 0,
"VerifyStatus": 0
}
],
"DefenseStatusList": [
{
"Text": "未防护",
"Value": "1"
}
],
"IpTypeList": [
{
"Text": "公网IP",
"Value": "1"
},
{
"Text": "弹性IP",
"Value": "2"
},
{
"Text": "未知",
"Value": "0"
}
],
"RegionList": [
{
"Text": "广州",
"Value": "ap-guangzhou"
},
{
"Text": "成都",
"Value": "ap-chengdu"
},
{
"Text": "上海",
"Value": "ap-shanghai"
},
{
"Text": "未知",
"Value": "other"
},
{
"Text": "硅谷",
"Value": "na-siliconvalley"
}
],
"RequestId": "27eb54eb-f654-4bae-bcce-278568d140bb",
"Total": 4
}
}
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: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub, Gitee
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。