1. 接口描述
接口请求域名: dasb.tencentcloudapi.com 。
修改用户信息
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ModifyUser。 |
Version | 是 | String | 公共参数,本接口取值:2019-10-18。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Id | 是 | Integer | 用户ID 示例值:1 |
RealName | 是 | String | 用户姓名,最大长度20个字符,不能包含空格 示例值:nick |
Phone | 否 | String | 按照"国家地区代码|手机号"的格式输入。如: "+86|xxxxxxxx" 示例值:+86|133***98 |
否 | String | 电子邮件 示例值:198***@qq.com |
|
ValidateFrom | 否 | Timestamp ISO8601 | 用户生效时间,如:"2021-09-22T00:00:00+00:00" 生效、失效时间不填则用户长期有效 示例值:2021-01-01T08:00:01+08:00 |
ValidateTo | 否 | Timestamp ISO8601 | 用户失效时间,如:"2021-09-23T00:00:00+00:00" 生效、失效时间不填则用户长期有效 示例值:2021-01-01T08:00:01+08:00 |
GroupIdSet.N | 否 | Array of Integer | 所属用户组ID集合 示例值:[1,2] |
AuthType | 否 | Integer | 认证方式,0 - 本地,1 - LDAP,2 - OAuth 不传则默认为0 示例值:0 |
ValidateTime | 否 | String | 访问时间段限制, 由0、1组成的字符串,长度168(7 × 24),代表该用户在一周中允许访问的时间段。字符串中第N个字符代表在一周中的第N个小时, 0 - 代表不允许访问,1 - 代表允许访问 示例值:0000000000000000000000000000000000000000000000000000000000000000 |
DepartmentId | 否 | String | 用户所属部门的ID,如1.2.3 示例值:1.2 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 修改用户信息
修改用户信息
输入示例
POST / HTTP/1.1
Host: dasb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyUser
<公共请求参数>
{
"Id": 1,
"ValidateTo": "2020-09-22T00:00:00+00:00",
"RealName": "zhangsan",
"GroupIdSet": [
1,
2,
3
],
"Phone": "183***98",
"ValidateFrom": "2020-09-22T00:00:00+00:00",
"Email": "test@qq.com"
}
输出示例
{
"Response": {
"RequestId": "dfac9070-8b23-499e-83b2-a50e3ca059af"
}
}
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签名/鉴权错误。 |
FailedOperation | 操作失败。 |
FailedOperation.DataNotFound | 目标数据不存在。 |
FailedOperation.DuplicateData | 重复数据。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.ResourceId | 无效的资源ID,用于资源不存在或已过期。 |
InvalidParameterValue | 参数取值错误。 |
LimitExceeded | 超过配额限制。 |
MissingParameter | 缺少参数错误。 |
OperationDenied | 操作被拒绝。 |
RequestLimitExceeded | 请求的次数超过了频率限制。 |
ResourceInUse | 资源被占用。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable | 资源不可用。 |
ResourcesSoldOut | 资源售罄。 |
UnauthorizedOperation | 未授权操作。 |
UnauthorizedOperation.NoPermission | 无操作权限。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |