新增自定义送检用户

最近更新时间:2024-03-12 01:32:18

我的收藏

1. 接口描述

接口请求域名: gme.tencentcloudapi.com 。

新增自定义送检用户。接口使用前提:目前 CreateScanUser 接口通过白名单开放,如需使用,需要 提交工单申请

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateScanUser。
Version String 公共参数,本接口取值:2018-07-11。
Region String 公共参数,此参数为可选参数。
BizId Integer 应用ID,登录控制台 - 服务管理创建应用得到的AppID
示例值:1
UserId Integer 需要新增送检的用户号。示例:1234
(若UserId不填,则UserIdString必填;两者选其一;两者都填以UserIdString为准)
示例值:1
UserIdString String 需要新增送检的用户号。示例:"1234"
(若UserIdString不填,则UserId必填;两者选其一;两者都填以UserIdString为准)
示例值:"1"
ExpirationTime Integer 当前用户送检过期时间,单位:秒。
若参数不为0,则在过期时间之后,用户不会被送检。
若参数为0,则送检配置不会自动失效。
示例值:30

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: CreateScanUser
<公共请求参数>

{
    "UserId": 1234,
    "BizId": 1400000000
}

输出示例

{
    "Response": {
        "ErrorCode": 0,
        "RequestId": "e1feec89-bf87-44d8-8456-9f0f7ffc6ad2"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
OperationDenied 操作被拒绝。