全部产品
云市场

用户操作API

更新时间:2019-09-12 18:10:58

CCP User API.

概览

CCP User API

版本信息

版本 : 2.0.0

URI scheme

  • endpoint : {domainId}.api.alicloudccp.com
  • 基础路径 : /v2
  • 协议支持类型 : HTTP, HTTPS

请求Content-Type

  • application/json

返回Content-Type

  • application/json

路径

创建用户

  1. POST /v2/user/create

说明

该接口将会创建用户, 只有管理员可以调用

Body参数

创建用户的请求参数

名称 : body标志 : 可选类型 : CreateUserRequest

响应

HTTP代码 说明 类型
201 创建用户成功 CreateUserResponse
400 1. InvalidParameterError:请求参数不正确 2. InvalidRequestJSONFormatError 请求JSON格式错误 InvalidParameterError
403 1.ForbiddenNoPermissionError 没有drive接口权限 2.ForbiddenAccountNotFoundError 账号没找到 ForbiddenNoPermissionError
500 服务内部故障 InternalErrorError
503 服务临时不可用 ServiceUnavailableError

标签

  • user

HTTP请求示例

请求 path
  1. /v2/user/create
请求 body
  1. {
  2. "avatar" : "http://a.b.c/ccp.jpg",
  3. "description" : "ccp team user",
  4. "email" : "123@ccp.com",
  5. "nick_name" : "ccpuser",
  6. "phone" : "13700000000",
  7. "role" : "user",
  8. "status" : "enabled",
  9. "user_id" : "ccpuserid",
  10. "user_name" : "abc"
  11. }

HTTP响应示例

响应 201
  1. {
  2. "avatar" : "http://a.b.c/ccp.jpg",
  3. "created_at" : 1567407718386,
  4. "default_drive_id" : "123",
  5. "description" : "ccp team user",
  6. "domain_id" : "hz999",
  7. "email" : "123@ccp.com",
  8. "nick_name" : "abc",
  9. "phone" : "13700000000",
  10. "role" : "user",
  11. "status" : "enabled",
  12. "updated_at" : 1567407718386,
  13. "user_id" : "ccpuserid",
  14. "user_name" : "name"
  15. }
响应 400
  1. {
  2. "code" : "InvalidParameter",
  3. "message" : "The input parameter {parameter_name} is not valid."
  4. }
响应 403
  1. {
  2. "code" : "ForbiddenNoPermission",
  3. "message" : "No Permission to access resource {resource_name}."
  4. }
响应 500
  1. {
  2. "code" : "InternalError",
  3. "message" : "The request has been failed due to some unknown error."
  4. }
响应 503
  1. {
  2. "code" : "ServiceUnavailable",
  3. "message" : "The request has failed due to a temporary failure of the server."
  4. }

删除用户, 只有管理员可以调用

  1. POST /v2/user/delete

说明

该接口将会删除用户

Body参数

删除用户的请求参数

名称 : body标志 : 可选类型 : DeleteUserRequest

响应

HTTP代码 说明 类型
204 无返回内容 无内容
400 1. InvalidParameterError:请求参数不正确 2. InvalidRequestJSONFormatError 请求JSON格式错误 InvalidParameterError
403 1.ForbiddenNoPermissionError 没有drive接口权限 2.ForbiddenAccountNotFoundError 账号没找到 ForbiddenNoPermissionError
500 服务内部故障 InternalErrorError
503 服务临时不可用 ServiceUnavailableError

标签

  • user

HTTP请求示例

请求 path
  1. /v2/user/delete
请求 body
  1. {
  2. "user_id" : "ccpuserid"
  3. }

HTTP响应示例

响应 400
  1. {
  2. "code" : "InvalidParameter",
  3. "message" : "The input parameter {parameter_name} is not valid."
  4. }
响应 403
  1. {
  2. "code" : "ForbiddenNoPermission",
  3. "message" : "No Permission to access resource {resource_name}."
  4. }
响应 500
  1. {
  2. "code" : "InternalError",
  3. "message" : "The request has been failed due to some unknown error."
  4. }
响应 503
  1. {
  2. "code" : "ServiceUnavailable",
  3. "message" : "The request has failed due to a temporary failure of the server."
  4. }

查看用户详细信息,管理员可以查询任意用户的信息,普通用户只可以查自己的信息。

  1. POST /v2/user/get

说明

该接口将会查看用户详细信息

Body参数

获取用户信息的请求参数

名称 : body标志 : 可选类型 : GetUserRequest

响应

HTTP代码 说明 类型
200 获取用户信息成功 GetUserResponse
400 1. InvalidParameterError:请求参数不正确 2. InvalidRequestJSONFormatError 请求JSON格式错误 InvalidParameterError
403 1.ForbiddenNoPermissionError 没有drive接口权限 2.ForbiddenAccountNotFoundError 账号没找到 ForbiddenNoPermissionError
404 指定的用户不存在 NotFoundError
500 服务内部故障 InternalErrorError
503 服务临时不可用 ServiceUnavailableError

标签

  • user

HTTP请求示例

请求 path
  1. /v2/user/get
请求 body
  1. {
  2. "user_id" : "string"
  3. }

HTTP响应示例

响应 200
  1. {
  2. "avatar" : "http://a.b.c/ccp.jpg",
  3. "created_at" : 1567407718386,
  4. "default_drive_id" : "123",
  5. "description" : "ccp team user",
  6. "domain_id" : "hz999",
  7. "email" : "123@ccp.com",
  8. "nick_name" : "abc",
  9. "phone" : "13700000000",
  10. "role" : "user",
  11. "status" : "enabled",
  12. "updated_at" : 1567407718386,
  13. "user_id" : "ccpuserid",
  14. "user_name" : "name"
  15. }
响应 400
  1. {
  2. "code" : "InvalidParameter",
  3. "message" : "The input parameter {parameter_name} is not valid."
  4. }
响应 403
  1. {
  2. "code" : "ForbiddenNoPermission",
  3. "message" : "No Permission to access resource {resource_name}."
  4. }
响应 404
  1. {
  2. "code" : "NotFound",
  3. "message" : "The resource {resource_name} cannot be found. Please check."
  4. }
响应 500
  1. {
  2. "code" : "InternalError",
  3. "message" : "The request has been failed due to some unknown error."
  4. }
响应 503
  1. {
  2. "code" : "ServiceUnavailable",
  3. "message" : "The request has failed due to a temporary failure of the server."
  4. }

用户列表, 只有管理员可以调用

  1. POST /v2/user/list

说明

该接口将会展示用户列表

Body参数

列举用户的请求参数

名称 : body标志 : 可选类型 : ListUserRequest

响应

HTTP代码 说明 类型
200 列举用户列表成功 ListUserResponse
400 1. InvalidParameterError:请求参数不正确 2. InvalidRequestJSONFormatError 请求JSON格式错误 InvalidParameterError
403 1.ForbiddenNoPermissionError 没有drive接口权限 2.ForbiddenAccountNotFoundError 账号没找到 ForbiddenNoPermissionError
500 服务内部故障 InternalErrorError
503 服务临时不可用 ServiceUnavailableError

标签

  • user

HTTP请求示例

请求 path
  1. /v2/user/list
请求 body
  1. {
  2. "limit" : 10,
  3. "marker" : "marker"
  4. }

HTTP响应示例

响应 200
  1. {
  2. "items" : [ {
  3. "avatar" : "http://a.b.c/ccp.jpg",
  4. "created_at" : 1567407718386,
  5. "default_drive_id" : "123",
  6. "description" : "ccp team user",
  7. "domain_id" : "hz999",
  8. "email" : "123@ccp.com",
  9. "nick_name" : "abc",
  10. "phone" : "13700000000",
  11. "role" : "user",
  12. "status" : "enabled",
  13. "updated_at" : 1567407718386,
  14. "user_id" : "ccpuserid",
  15. "user_name" : "name"
  16. } ],
  17. "next_marker" : "nextmarker"
  18. }
响应 400
  1. {
  2. "code" : "InvalidParameter",
  3. "message" : "The input parameter {parameter_name} is not valid."
  4. }
响应 403
  1. {
  2. "code" : "ForbiddenNoPermission",
  3. "message" : "No Permission to access resource {resource_name}."
  4. }
响应 500
  1. {
  2. "code" : "InternalError",
  3. "message" : "The request has been failed due to some unknown error."
  4. }
响应 503
  1. {
  2. "code" : "ServiceUnavailable",
  3. "message" : "The request has failed due to a temporary failure of the server."
  4. }

查询用户, 只有管理员可以调用

  1. POST /v2/user/search

说明

该接口将会根据条件查询用户

Body参数

查询用户的请求参数

名称 : body标志 : 可选类型 : SearchUserRequest

响应

HTTP代码 说明 类型
200 查询用户成功 ListUserResponse
400 1. InvalidParameterError:请求参数不正确 2. InvalidRequestJSONFormatError 请求JSON格式错误 InvalidParameterError
403 1.ForbiddenNoPermissionError 没有drive接口权限 2.ForbiddenAccountNotFoundError 账号没找到 ForbiddenNoPermissionError
500 服务内部故障 InternalErrorError
503 服务临时不可用 ServiceUnavailableError

标签

  • user

HTTP请求示例

请求 path
  1. /v2/user/search
请求 body
  1. {
  2. "email" : "abc@ccp.com",
  3. "limit" : 10,
  4. "marker" : "marker",
  5. "nick_name" : "la",
  6. "phone" : "13700000000",
  7. "role" : "user",
  8. "status" : "enabled",
  9. "user_name" : "abc"
  10. }

HTTP响应示例

响应 200
  1. {
  2. "items" : [ {
  3. "avatar" : "http://a.b.c/ccp.jpg",
  4. "created_at" : 1567407718386,
  5. "default_drive_id" : "123",
  6. "description" : "ccp team user",
  7. "domain_id" : "hz999",
  8. "email" : "123@ccp.com",
  9. "nick_name" : "abc",
  10. "phone" : "13700000000",
  11. "role" : "user",
  12. "status" : "enabled",
  13. "updated_at" : 1567407718386,
  14. "user_id" : "ccpuserid",
  15. "user_name" : "name"
  16. } ],
  17. "next_marker" : "nextmarker"
  18. }
响应 400
  1. {
  2. "code" : "InvalidParameter",
  3. "message" : "The input parameter {parameter_name} is not valid."
  4. }
响应 403
  1. {
  2. "code" : "ForbiddenNoPermission",
  3. "message" : "No Permission to access resource {resource_name}."
  4. }
响应 500
  1. {
  2. "code" : "InternalError",
  3. "message" : "The request has been failed due to some unknown error."
  4. }
响应 503
  1. {
  2. "code" : "ServiceUnavailable",
  3. "message" : "The request has failed due to a temporary failure of the server."
  4. }

更新用户信息, User 可以修改自己的 description,nick_name,avatar, Admin增加修改status(可以修改任意用户), SuperAdmin增加修改role (可以修改任意用户)

  1. POST /v2/user/update

说明

该接口将会更新用户信息

Body参数

更新用户的请求参数

名称 : body标志 : 可选类型 : UpdateUserRequest

响应

HTTP代码 说明 类型
200 更新用户成功 UpdateUserResponse
400 1. InvalidParameterError:请求参数不正确 2. InvalidRequestJSONFormatError 请求JSON格式错误 InvalidParameterError
403 1.ForbiddenNoPermissionError 没有drive接口权限 2.ForbiddenAccountNotFoundError 账号没找到 ForbiddenNoPermissionError
404 指定的用户不存在 NotFoundError
500 服务内部故障 InternalErrorError
503 服务临时不可用 ServiceUnavailableError

标签

  • user

HTTP请求示例

请求 path
  1. /v2/user/update
请求 body
  1. {
  2. "avatar" : "http://a.b.c/ccp.jpg",
  3. "description" : "ccp team user",
  4. "email" : "123@ccp.com",
  5. "nick_name" : "ccpuser",
  6. "phone" : "13700000000",
  7. "role" : "user",
  8. "status" : "enabled",
  9. "user_id" : "ccpuserid"
  10. }

HTTP响应示例

响应 200
  1. {
  2. "avatar" : "http://a.b.c/ccp.jpg",
  3. "created_at" : 1567407718386,
  4. "default_drive_id" : "123",
  5. "description" : "ccp team user",
  6. "domain_id" : "hz999",
  7. "email" : "123@ccp.com",
  8. "nick_name" : "abc",
  9. "phone" : "13700000000",
  10. "role" : "user",
  11. "status" : "enabled",
  12. "updated_at" : 1567407718386,
  13. "user_id" : "ccpuserid",
  14. "user_name" : "name"
  15. }
响应 400
  1. {
  2. "code" : "InvalidParameter",
  3. "message" : "The input parameter {parameter_name} is not valid."
  4. }
响应 403
  1. {
  2. "code" : "ForbiddenNoPermission",
  3. "message" : "No Permission to access resource {resource_name}."
  4. }
响应 404
  1. {
  2. "code" : "NotFound",
  3. "message" : "The resource {resource_name} cannot be found. Please check."
  4. }
响应 500
  1. {
  2. "code" : "InternalError",
  3. "message" : "The request has been failed due to some unknown error."
  4. }
响应 503
  1. {
  2. "code" : "ServiceUnavailable",
  3. "message" : "The request has failed due to a temporary failure of the server."
  4. }

定义

APIError

APIError is api error common struct

名称 说明 类型
code
必填
样例 : "string" string
message
必填
样例 : "string" string

AlreadyExistError

AlreadyExistError 已经存在错误

名称 说明 类型
code
必填
样例 : "AlreadyExist" string
message
必填
样例 : "{resource} has already exists. {extra_msg}" string

BaseUserResponse

Base user response

名称 说明 类型
avatar
可选
头像
样例 : "http://a.b.c/ccp.jpg"
string
created_at
可选
用户创建时间
样例 : 1567407718386
integer (int64)
default_drive_id
可选
默认 Drive ID
样例 : "123"
string
description
可选
用户备注信息
样例 : "ccp team user"
string
domain_id
可选
Domain ID
样例 : "hz999"
string
email
可选
邮箱
样例 : "123@ccp.com"
string
nick_name
可选
昵称
样例 : "abc"
string
phone
可选
电话
样例 : "13700000000"
string
role
可选
角色
样例 : "user"
string
status
可选
用户状态
样例 : "enabled"
string
updated_at
可选
用户修改时间
样例 : 1567407718386
integer (int64)
user_id
可选
用户 ID
样例 : "ccpuserid"
string
user_name
可选
用户名称
样例 : "name"
string

CreateUserRequest

Create user request

名称 说明 类型
avatar
可选
头像
样例 : "http://a.b.c/ccp.jpg"
string
description
可选
描述信息
样例 : "ccp team user"
string
email
可选
邮箱
样例 : "123@ccp.com"
string
nick_name
可选
昵称
样例 : "ccpuser"
string
phone
可选
电话号码
样例 : "13700000000"
string
role
可选
角色
默认值 : "user"
样例 : "user"
enum (superadmin, admin, user)
status
可选
状态
默认值 : "enabled"
样例 : "enabled"
enum (enabled, disabled)
user_id
必填
用户 ID
样例 : "ccpuserid"
string
user_name
可选
用户名称
样例 : "abc"
string

CreateUserResponse

Create user response

名称 说明 类型
avatar
可选
头像
样例 : "http://a.b.c/ccp.jpg"
string
created_at
可选
用户创建时间
样例 : 1567407718386
integer (int64)
default_drive_id
可选
默认 Drive ID
样例 : "123"
string
description
可选
用户备注信息
样例 : "ccp team user"
string
domain_id
可选
Domain ID
样例 : "hz999"
string
email
可选
邮箱
样例 : "123@ccp.com"
string
nick_name
可选
昵称
样例 : "abc"
string
phone
可选
电话
样例 : "13700000000"
string
role
可选
角色
样例 : "user"
string
status
可选
用户状态
样例 : "enabled"
string
updated_at
可选
用户修改时间
样例 : 1567407718386
integer (int64)
user_id
可选
用户 ID
样例 : "ccpuserid"
string
user_name
可选
用户名称
样例 : "name"
string

DeleteUserRequest

Delete user request

名称 说明 类型
user_id
必填
用户 ID
样例 : "ccpuserid"
string

DeleteUserResponse

Delete user response

类型 : object

DriveRelativePathNestedError

DriveRelativePathNestedError 路径嵌套错误

名称 说明 类型
code
必填
样例 : "DriveRelativePathNested" string
message
必填
样例 : "the parameter relative_path nested inside of another relative_path: {path}." string

ForbiddenAccountInDebtError

ForbiddenAccountInDebtError 账号欠费错误

名称 说明 类型
code
必填
样例 : "ForbiddenAccountInDebt" string
message
必填
样例 : "The specified account is in debt." string

ForbiddenAccountNotFoundError

ForbiddenAccountNotFoundError 账号没找到错误

名称 说明 类型
code
必填
样例 : "ForbiddenAccountNotFound" string
message
必填
样例 : "The specified account does not exist." string

ForbiddenError

ForbiddenError 被禁止错误

名称 说明 类型
code
必填
样例 : "Forbidden" string
message
必填
样例 : "User not authorized to operate on the specified APIs." string

ForbiddenNoPermissionError

ForbiddenNoPermissionError 没有权限错误

名称 说明 类型
code
必填
样例 : "ForbiddenNoPermission" string
message
必填
样例 : "No Permission to access resource {resource_name}." string

ForbiddenRiskControlError

ForbiddenRiskControlError 风险控制禁止访问错误

名称 说明 类型
code
必填
样例 : "ForbiddenRiskControl" string
message
必填
样例 : "This operation is forbidden by Alibaba Cloud RiskControl system." string

ForbiddenServiceRoleError

ForbiddenServiceRoleError 服务角色禁止访问错误

名称 说明 类型
code
必填
样例 : "ForbiddenServiceRole" string
message
必填
样例 : "Cannot access specified service role." string

GetUserRequest

Get user request

名称 说明 类型
user_id
可选
用户 ID, 使用ak方式访问,该项必传, access_token访问如果不传,默认取自己的user信息
example
样例 : "string"
string

GetUserResponse

Get user response

名称 说明 类型
avatar
可选
头像
样例 : "http://a.b.c/ccp.jpg"
string
created_at
可选
用户创建时间
样例 : 1567407718386
integer (int64)
default_drive_id
可选
默认 Drive ID
样例 : "123"
string
description
可选
用户备注信息
样例 : "ccp team user"
string
domain_id
可选
Domain ID
样例 : "hz999"
string
email
可选
邮箱
样例 : "123@ccp.com"
string
nick_name
可选
昵称
样例 : "abc"
string
phone
可选
电话
样例 : "13700000000"
string
role
可选
角色
样例 : "user"
string
status
可选
用户状态
样例 : "enabled"
string
updated_at
可选
用户修改时间
样例 : 1567407718386
integer (int64)
user_id
可选
用户 ID
样例 : "ccpuserid"
string
user_name
可选
用户名称
样例 : "name"
string

HTTPMethodNotAllowedError

HTTPMethodNotAllowedError 内部错误

名称 说明 类型
code
必填
样例 : "HTTPMethodNotAllowed" string
message
必填
样例 : "The request http method is not supported for this resource." string

IncorrectStatusError

IncorrectStatusError 状态不正确错误

名称 说明 类型
code
必填
样例 : "IncorrectStatus" string
message
必填
样例 : "The current status does not support this operation." string

InternalErrorError

InternalErrorError 内部错误

名称 说明 类型
code
必填
样例 : "InternalError" string
message
必填
样例 : "The request has been failed due to some unknown error." string

InvalidHeaderError

InvalidHeaderError 请求头不合法错误

名称 说明 类型
code
必填
样例 : "InvalidHeader" string
message
必填
样例 : "Header {header_name} is not valid." string

InvalidParameterEmptyError

InvalidParameterEmptyError 参数为空错误

名称 说明 类型
code
必填
样例 : "InvalidParameterEmpty" string
message
必填
样例 : "The input parameter {parameter_name} is empty." string

InvalidParameterError

InvalidParameterError 参数非法错误

名称 说明 类型
code
必填
样例 : "InvalidParameter" string
message
必填
样例 : "The input parameter {parameter_name} is not valid." string

InvalidParameterExpiredError

InvalidParameterExpiredError 参数已经过期错误

名称 说明 类型
code
必填
样例 : "InvalidParameterExpired" string
message
必填
样例 : "The input parameter {resource} is expired. {extra_msg}" string

InvalidParameterMissingError

InvalidParameterMissingError 参数缺失

名称 说明 类型
code
必填
样例 : "InvalidParameterMissing" string
message
必填
样例 : "The input parameter {parameter_name} is missing." string

InvalidParameterNotMatchError

InvalidParameterNotMatchError 参数不匹配错误

名称 说明 类型
code
必填
样例 : "InvalidParameterNotMatch" string
message
必填
样例 : "The input parameter {parameter_name} doesn't match." string

InvalidParameterNotSupportedError

InvalidParameterNotSupportedError 参数不支持错误

名称 说明 类型
code
必填
样例 : "InvalidParameterNotSupported" string
message
必填
样例 : "The input parameter {parameter_name} is not supported." string

InvalidParameterOutOfRangeError

InvalidParameterOutOfRangeError 参数超过范围错误

名称 说明 类型
code
必填
样例 : "InvalidParameterOutOfRange" string
message
必填
样例 : "The input parameter {parameter_name} doesn't match the limitation." string

InvalidParameterWrongFormatError

InvalidParameterWrongFormatError 参数格式错误

名称 说明 类型
code
必填
样例 : "InvalidParameterWrongFormat" string
message
必填
样例 : "The input parameter {parameter_name} has invalid format." string

InvalidRequestJSONFormatError

InvalidRequestJSONFormatError 请求JSON格式错误

名称 说明 类型
code
必填
样例 : "InvalidRequestJSONFormat" string
message
必填
样例 : "{parameter_name} is invalid Json format." string

InvalidResourceError

InvalidResourceError 非法资源错误

名称 说明 类型
code
必填
样例 : "InvalidResource" string
message
必填
样例 : "The resource {resource_name} is not valid." string

InvalidResourceIsEmptyError

InvalidResourceIsEmptyError 资源为空错误

名称 说明 类型
code
必填
样例 : "InvalidResourceIsEmpty" string
message
必填
样例 : "The {resouce_name} resource %s is empty." string

InvalidResourceUnsupportedError

InvalidResourceUnsupportedError 资源不支持错误

名称 说明 类型
code
必填
样例 : "InvalidResourceUnsupported" string
message
必填
样例 : "The resource {resource_name} is not supported." string

ListUserRequest

List user request

名称 说明 类型
limit
可选
每页大小限制
默认值 : 100
最小值 : 1
最大值 : 100
样例 : 10
integer (int32)
marker
可选
翻页标记
样例 : "marker"
string

ListUserResponse

List user response

名称 说明 类型
items
可选
样例 : [ "[baseuserresponse](#baseuserresponse)" ] < BaseUserResponse > array
next_marker
可选
翻页标记
样例 : "nextmarker"
string

NotEmptyError

NotEmptyError 不为空错误

名称 说明 类型
code
必填
样例 : "NotEmpty" string
message
必填
样例 : "{resource_name} is not empty." string

NotFoundError

NotFoundError 没有找到错误

名称 说明 类型
code
必填
样例 : "NotFound" string
message
必填
样例 : "The resource {resource_name} cannot be found. Please check." string

QuotaExhaustedError

QuotaExhaustedError 超出配额错误

名称 说明 类型
code
必填
样例 : "QuotaExhausted" string
message
必填
样例 : "The resource {resource_name} has exceeded the limit." string

ReadBodyErrorError

ReadBodyErrorError 读取Body错误

名称 说明 类型
code
必填
样例 : "ReadBodyError" string
message
必填
样例 : "Read body error." string

SearchUserRequest

Search user request

名称 说明 类型
email
可选
邮箱
样例 : "abc@ccp.com"
string
limit
可选
每页大小限制
默认值 : 100
最小值 : 1
最大值 : 100
样例 : 10
integer (int32)
marker
可选
翻页标记
样例 : "marker"
string
nick_name
可选
昵称
样例 : "la"
string
phone
可选
电话号码
样例 : "13700000000"
string
role
可选
角色
默认值 : "user"
样例 : "user"
enum (superadmin, admin, user)
status
可选
状态
默认值 : "enabled"
样例 : "enabled"
enum (enabled, disabled)
user_name
可选
用户名
样例 : "abc"
string

ServiceUnavailableError

ServiceUnavailableError 服务不可用错误

名称 说明 类型
code
必填
样例 : "ServiceUnavailable" string
message
必填
样例 : "The request has failed due to a temporary failure of the server." string

Sha1ConflictError

Sha1ConflictError Sha1冲突错误

名称 说明 类型
code
必填
样例 : "Sha1Conflict" string
message
必填
样例 : "Find multiple objects of the same sha1." string

SignatureDoesNotMatchError

SignatureDoesNotMatchError 签名不匹配错误

名称 说明 类型
code
必填
样例 : "SignatureDoesNotMatch" string
message
必填
样例 : "SignatureDoesNotMatch." string

StateConflictError

StateConflictError 状态冲突错误

名称 说明 类型
code
必填
样例 : "StateConflict" string
message
必填
样例 : "User operation is not valid." string

ThrottlingError

ThrottlingError 操作被流控错误

名称 说明 类型
code
必填
样例 : "Throttling" string
message
必填
样例 : "The operation is blocked due to throttling control." string

UpdateUserRequest

Update user request

名称 说明 类型
avatar
可选
头像
样例 : "http://a.b.c/ccp.jpg"
string
description
可选
描述信息
样例 : "ccp team user"
string
email
可选
邮箱
样例 : "123@ccp.com"
string
nick_name
可选
昵称
样例 : "ccpuser"
string
phone
可选
电话号码
样例 : "13700000000"
string
role
可选
角色
默认值 : "user"
样例 : "user"
enum (superadmin, admin, user)
status
可选
状态
默认值 : "enabled"
样例 : "enabled"
enum (enabled, disabled)
user_id
必填
用户 ID
样例 : "ccpuserid"
string

UpdateUserResponse

Update user response

名称 说明 类型
avatar
可选
头像
样例 : "http://a.b.c/ccp.jpg"
string
created_at
可选
用户创建时间
样例 : 1567407718386
integer (int64)
default_drive_id
可选
默认 Drive ID
样例 : "123"
string
description
可选
用户备注信息
样例 : "ccp team user"
string
domain_id
可选
Domain ID
样例 : "hz999"
string
email
可选
邮箱
样例 : "123@ccp.com"
string
nick_name
可选
昵称
样例 : "abc"
string
phone
可选
电话
样例 : "13700000000"
string
role
可选
角色
样例 : "user"
string
status
可选
用户状态
样例 : "enabled"
string
updated_at
可选
用户修改时间
样例 : 1567407718386
integer (int64)
user_id
可选
用户 ID
样例 : "ccpuserid"
string
user_name
可选
用户名称
样例 : "name"
string