1. 接口描述
接口请求域名: ctem.tencentcloudapi.com 。
获取邮箱泄露数据
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeLeakageEmails。 |
Version | 是 | String | 公共参数,本接口取值:2023-11-28。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
CustomerIdList.N | 否 | Array of Integer | 企业ID列表,可多选 示例值:[1,2] |
IsAggregation | 否 | Boolean | 是否聚合数据 示例值:false |
IsNew | 否 | Boolean | 是否新增数据 示例值:false |
CustomerId | 否 | Integer | 企业ID 示例值:1 |
Limit | 否 | Integer | 分页大小 示例值:0 |
Offset | 否 | Integer | 分页偏移 示例值:0 |
EnterpriseUidList.N | 否 | Array of String | 子公司ID列表 示例值:["7286dcdf1c6f6ec1e99a2317b2c960e0"] |
Format | 否 | String | 数据输出格式:json、file,默认不填为json 示例值:json |
CreateAtStart | 否 | String | 创建时间-开始 示例值:2024-01-01 00:00:00 |
CreateAtEnd | 否 | String | 创建时间-结束 示例值:2024-01-01 00:00:00 |
UpdateAtStart | 否 | String | 更新时间-开始 示例值:2024-01-01 00:00:00 |
UpdateAtEnd | 否 | String | 更新时间-结束 示例值:2024-01-01 00:00:00 |
Filters.N | 否 | Array of Filter | 查询数组 |
Ignored | 否 | Boolean | 是否显示被忽略的数据 示例值:true |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Total | Integer | 总数 示例值:1 |
List | Array of DisplayLeakageEmail | 数组 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取邮箱泄露数据
输入示例
POST / HTTP/1.1
Host: ctem.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeLeakageEmails
<公共请求参数>
{
"CreateAtEnd": "2023-02-01 12:00:00",
"CreateAtStart": "2023-01-01 12:00:00",
"CustomerId": 1,
"EnterpriseUidList": [
"string"
],
"Filters": [
{
"Name": "string",
"Values": [
"string"
]
}
],
"Format": "json",
"Ignored": false,
"IsNew": false,
"Limit": 10,
"Offset": 0,
"UpdateAtEnd": "2023-02-01 12:00:00",
"UpdateAtStart": "2023-01-01 12:00:00"
}
输出示例
{
"Response": {
"List": [
{
"Id": 0,
"Email": "string"
}
],
"Total": 0,
"RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
DryRunOperation | DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。 |
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InvalidFilter | 无效的过滤器 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
LimitExceeded | 超过配额限制。 |
MissingParameter | 缺少参数错误。 |
OperationDenied | 操作被拒绝。 |
RegionError | 地域错误 |
RequestLimitExceeded | 请求的次数超过了频率限制。 |
ResourceInUse | 资源被占用。 |
ResourceInsufficient | 资源不足。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable | 资源不可用。 |
ResourcesSoldOut | 资源售罄。 |
UnauthorizedOperation | 未授权操作。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |