1. 接口描述
接口请求域名： gme.tencentcloudapi.com 。
更新自定义送检用户号。
接口使用前提：目前 UpdateScanUsers 接口通过白名单开放，如需使用，需要 提交工单申请。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：UpdateScanUsers。 |
| Version | 是 | String | 公共参数，本接口取值：2018-07-11。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| BizId | 是 | Integer | 应用ID 示例值：1 |
| UserIdString | 否 | String | 需要送检的所有用户号。多个用户号之间用","分隔。示例："0001,0002,0003" 示例值："1" |
| UserIdRegex.N | 否 | Array of String | 符合此正则表达式规则的用户号将被送检。示例：["^6.*"] 表示所有以6开头的用户号将被送检 示例值：["1"] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ErrorCode | Integer | 返回结果码 示例值：0 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 更新用户自定义送检用户号
更新用户自定义送检用户号
输入示例
POST / HTTP/1.1
Host: gme.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateScanUsers
<公共请求参数>
{
"UserIdRegex": [
"^[0-9]*$"
],
"UserIdString": "0001,0002,0003",
"BizId": 1400000000
}输出示例
{
"Response": {
"ErrorCode": 0,
"RequestId": "454859b0-5e53-491d-814c-ac40faaca5f7"
}
}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. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。