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 | filte过滤条件 |
Tags.N | 否 | Array of AssetTag | 安全中心自定义标签 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Data | Array of IpAssetListVO | 列表 注意:此字段可能返回 null,表示取不到有效值。 |
Total | Integer | 总数 |
AssetLocationList | Array of FilterDataObject | 资产归属地 注意:此字段可能返回 null,表示取不到有效值。 |
IpTypeList | Array of FilterDataObject | ip列表枚举 注意:此字段可能返回 null,表示取不到有效值。 |
RegionList | Array of FilterDataObject | 地域列表枚举 注意:此字段可能返回 null,表示取不到有效值。 |
DefenseStatusList | Array of FilterDataObject | 防护枚举 注意:此字段可能返回 null,表示取不到有效值。 |
AssetTypeList | Array of FilterDataObject | 资产类型枚举 注意:此字段可能返回 null,表示取不到有效值。 |
AppIdList | Array of FilterDataObject | AppId枚举 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 资产查询
输入示例
POST / HTTP/1.1
Host: csip.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribePublicIpAssets
<公共请求参数>
{
"MemberId": [
"abc"
],
"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"
}
}
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. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。