1. 接口描述
接口请求域名: csip.tencentcloudapi.com 。
域名列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeDomainAssets。 |
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. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Total | Integer | 总数 示例值:10 |
Data | Array of DomainAssetVO | 域名列表 |
DefenseStatusList | Array of FilterDataObject | 防护状态列表 示例值:[ { "Text": "已防护", "Value": "1" }, { "Text": "未防护", "Value": "5" } ] |
AssetLocationList | Array of FilterDataObject | 资产归属地列表 示例值:[ { "Text": "未知", "Value": "other" } ] |
SourceTypeList | Array of FilterDataObject | 资产类型列表 示例值:[ { "Text": "未知", "Value": "unknown" } ] |
RegionList | Array of FilterDataObject | 地域列表 示例值:[ { "Text": "未知", "Value": "other" } ] |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 接口示例
接口示例
输入示例
POST / HTTP/1.1
Host: csip.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDomainAssets
<公共请求参数>
{
"Filter": {
"Filters": [
{
"Name": "WAFStatus",
"Values": [
"1"
],
"OperatorType": 7
},
{
"Name": "TimeRange",
"Values": [
"2"
],
"OperatorType": 7
}
],
"Limit": 10,
"Offset": 0,
"Order": "desc",
"By": "AssetCreateTime"
},
"MemberId": [
"mem-62522c05c913c901"
]
}
输出示例
{
"Response": {
"AssetLocationList": [
{
"Text": "其他",
"Value": "2"
}
],
"Data": [
{
"AssetId": [
"book.szzucieva.com"
],
"AssetName": [
"book.szzucieva.com"
],
"SubDomain": "book.szzucieva.com",
"SourceType": "未知",
"BotAccessCount": 0,
"BotCount": 0,
"WebAttack": 0,
"PortRisk": 0,
"VulnerabilityRisk": 0,
"WeakPassword": 0,
"WebContentRisk": 0,
"ServiceRisk": 0,
"WAFStatus": 1,
"AssetType": [
"未知"
],
"AssetCreateTime": "2024-08-31 06:01:18",
"Region": [
"other"
],
"SeverIp": [
"**************"
],
"AppId": 1302396219625,
"Uin": "100014592145978",
"NickName": "生生乌龙",
"IsCore": 2,
"IsCloud": 3,
"Attack": 0,
"Access": 0,
"Intercept": 0,
"InBandwidth": "0bps",
"OutBandwidth": "0bps",
"InFlow": "0B",
"OutFlow": "0B",
"LastScanTime": "2024-10-30 05:02:29",
"ConfigurationRisk": 0,
"ScanTask": 0,
"Tag": [
{
"Name": "name1",
"Value": "value1"
}
],
"MemberId": "mem-625c229153c9c001",
"CCAttack": 0,
"IsNewAsset": 0,
"VerifyDomain": "verify.te.foo1.***.dxoyxy.top",
"VerifyTXTRecord": "verify/cnkj1bn2k4n124n14n12",
"VerifyStatus": 0
},
{
"AssetId": [
"docker.dzoxyxy.top"
],
"AssetName": [
"docker.dzoxyxy.top"
],
"SubDomain": "docker.dzoxyxy.top",
"SourceType": "未知",
"BotAccessCount": 0,
"BotCount": 0,
"WebAttack": 0,
"PortRisk": 0,
"VulnerabilityRisk": 0,
"WeakPassword": 0,
"WebContentRisk": 0,
"ServiceRisk": 0,
"WAFStatus": 1,
"AssetType": [],
"AssetCreateTime": "2023-12-14 11:06:37",
"Region": [
"other"
],
"SeverIp": [
"43.165.126.15"
],
"AppId": 1302396219625,
"Uin": "100014592145978",
"NickName": "生生乌龙",
"IsCore": 2,
"IsCloud": 2,
"Attack": 0,
"Access": 0,
"Intercept": 0,
"InBandwidth": "0bps",
"OutBandwidth": "0bps",
"InFlow": "0B",
"OutFlow": "0B",
"LastScanTime": "2024-10-30 05:02:29",
"ConfigurationRisk": 0,
"ScanTask": 31,
"Tag": [
{
"Name": "name1",
"Value": "value1"
}
],
"MemberId": "mem-625c229153c9c001",
"CCAttack": 0,
"IsNewAsset": 0,
"VerifyDomain": "verify.te.foo3.***.dxoyxy.top",
"VerifyTXTRecord": "verify/qnwofhqocnasonr31cv3ir414j21pj4p12j41u0921u",
"VerifyStatus": 0
},
{
"AssetId": [
"example.te.dxoyxy.top"
],
"AssetName": [
"example.te.dxoyxy.top"
],
"SubDomain": "example.te.dxoyxy.top",
"SourceType": "未知",
"BotAccessCount": 0,
"BotCount": 0,
"WebAttack": 0,
"PortRisk": 0,
"VulnerabilityRisk": 0,
"WeakPassword": 0,
"WebContentRisk": 0,
"ServiceRisk": 0,
"WAFStatus": 1,
"AssetType": [],
"AssetCreateTime": "2023-12-14 11:30:07",
"Region": [
"other"
],
"SeverIp": [
"43.137.128.53"
],
"AppId": 1302396219625,
"Uin": "100014592145978",
"NickName": "生生乌龙",
"IsCore": 2,
"IsCloud": 2,
"Attack": 0,
"Access": 0,
"Intercept": 0,
"InBandwidth": "0bps",
"OutBandwidth": "0bps",
"InFlow": "0B",
"OutFlow": "0B",
"LastScanTime": "2024-10-30 05:02:29",
"ConfigurationRisk": 0,
"ScanTask": 31,
"Tag": [
{
"Name": "name1",
"Value": "value1"
}
],
"MemberId": "mem-625c229153c9c001",
"CCAttack": 0,
"IsNewAsset": 0,
"VerifyDomain": "verify.te.foo.***.dxoyxy.top",
"VerifyTXTRecord": "verify/qnwofhqoir414j21pj4p12j41u0921u",
"VerifyStatus": 0
}
],
"DefenseStatusList": [
{
"Text": "已防护",
"Value": "1"
},
{
"Text": "未防护",
"Value": "5"
}
],
"RegionList": [
{
"Text": "未知",
"Value": "other"
}
],
"RequestId": "ddca49aa-8aaf-4525-b2ff-fdd6fe7d1d20",
"SourceTypeList": [
{
"Text": "未知",
"Value": "unknown"
}
],
"Total": 3
}
}
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. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。