删除人员

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

我的收藏

1. 接口描述

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

删除人员。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DeletePerson。
Version String 公共参数,本接口取值:2020-03-24。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-chengdu, ap-guangzhou, ap-nanjing, ap-shanghai 。
PersonId String 人员ID。

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 调用失败示例

输入示例

POST / HTTP/1.1
Host: bda.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeletePerson
<公共请求参数>

{
    "PersonId": "123131231"
}

输出示例

{
    "Response": {
        "Error": {
            "Code": "InvalidParameterValue.PersonIdNotExist",
            "Message": "人员ID不存在。"
        },
        "RequestId": "27304486-69f3-47fd-b8ce-b7436ec8486b"
    }
}

示例2 调用成功示例

输入示例

POST / HTTP/1.1
Host: bda.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeletePerson
<公共请求参数>

{
    "PersonId": "testG10P1"
}

输出示例

{
    "Response": {
        "RequestId": "10f9a902-184e-40d6-b09d-e85f0c2dcfba"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.InnerError 服务内部错误,请重试。
FailedOperation.RequestEntityTooLarge 整个请求体太大(通常主要是图片)。
FailedOperation.RequestTimeout 后端服务超时。
InvalidParameter.InvalidParameter 参数不合法。
InvalidParameterValue.GroupIdNotExist 人体库ID不存在。
InvalidParameterValue.PersonIdIllegal 人员ID包含非法字符。人员ID只支持英文、数字、-%@#&_。
InvalidParameterValue.PersonIdNotExist 人员ID不存在。
InvalidParameterValue.PersonIdTooLong 人员ID超出长度限制。
ResourceUnavailable.InArrears 账号已欠费。
ResourceUnavailable.NotExist 计费状态未知,请确认是否已在控制台开通服务。
UnsupportedOperation.UnknowMethod 未知方法名。