账号操作API
概览
Account API
版本信息
版本 : 2.0.0
URI scheme
域名 : {domainId}.auth.alicloudccp.com基础路径 : /v2协议 : HTTP, HTTPS
请求Content-Type
application/json
返回Content-Type
application/json
API
取消绑定关系
POST /v2/account/cancel_link
说明
取消绑定关系,生成新用户,返回访问令牌
Body参数
取消绑定关系
名称 : 取消绑定关系请求标志 : 必填类型 : CancelLinkRequest
响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 | 成功 | AccountAccessTokenResponse |
400 | 参数错误 1.InvalidParameterMissingError.TemporaryToken:临时token缺失 |
InvalidParameterMissingError |
403 | 无权限 | ForbiddenError |
500 | 内部错误 | InternalErrorError |
标签
- account
HTTP请求示例
请求 path
/v2/account/cancel_link
请求 body
{
"temporary_token" : "ey***s="
}
HTTP响应示例
响应 200
{
"access_token" : "cnskjajkahwdhwialsnd",
"avatar" : "cherry",
"default_drive_id" : "100",
"exist_link" : [ ],
"expire_time" : "2019-09-01T06:57:48.813Z",
"expires_in" : 3600,
"need_link" : false,
"nick_name" : "cherry",
"refresh_token" : "cnskjajkahwdhwialsnd",
"role" : "user",
"state" : "klafhjas-asdasd-asd-as-d-asd-asd-asdasd",
"token_type" : "Bearer",
"user_data" : "{ is_student: true }",
"user_id" : "DING-xxxxx",
"user_name" : "cherry"
}
响应 400
{
"code" : "InvalidParameterMissing",
"message" : "The input parameter {parameter_name} is missing."
}
响应 403
{
"code" : "Forbidden",
"message" : "User not authorized to operate on the specified APIs."
}
响应 500
{
"code" : "InternalError",
"message" : "The request has been failed due to some unknown error."
}
确定绑定关系
POST /v2/account/confirm_link
说明
确认绑定关系, 成功后返回访问令牌
Body参数
确认绑定关系
名称 : 确定绑定关系请求标志 : 必填类型 : ConfirmLinkRequest
响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 | 成功 | AccountAccessTokenResponse |
400 | 参数错误 1.InvalidParameterMissingError.TemporaryToken:临时token缺失 2.InvalidParameterError.TemporaryToken:临时token无效 |
InvalidParameterMissingError |
403 | 无权限 | ForbiddenNoPermissionError |
404 | 资源未找到错误 1.NotFoundError.User:用户不存在 |
NotFoundError |
500 | 内部错误 | InternalErrorError |
标签
- account
HTTP请求示例
请求 path
/v2/account/confirm_link
请求 body
{
"temporary_token" : "ey***s="
}
HTTP响应示例
响应 200
{
"access_token" : "cnskjajkahwdhwialsnd",
"avatar" : "cherry",
"default_drive_id" : "100",
"exist_link" : [ ],
"expire_time" : "2019-09-01T06:57:48.813Z",
"expires_in" : 3600,
"need_link" : false,
"nick_name" : "cherry",
"refresh_token" : "cnskjajkahwdhwialsnd",
"role" : "user",
"state" : "klafhjas-asdasd-asd-as-d-asd-asd-asdasd",
"token_type" : "Bearer",
"user_data" : "{ is_student: true }",
"user_id" : "DING-xxxxx",
"user_name" : "cherry"
}
响应 400
{
"code" : "InvalidParameterMissing",
"message" : "The input parameter {parameter_name} is missing."
}
响应 403
{
"code" : "ForbiddenNoPermission",
"message" : "No Permission to access resource {resource_name}."
}
响应 404
{
"code" : "NotFound",
"message" : "The resource {resource_name} cannot be found. Please check."
}
响应 500
{
"code" : "InternalError",
"message" : "The request has been failed due to some unknown error."
}
修改登录密码
POST /v2/account/default/change_password
说明
修改手机登录密码,密码必须包含数字、大小写字母和特殊字符,长度10-32个字符
Body参数
修改登录密码
名称 : 修改登录密码标志 : 必填类型 : DefaultChangePasswordRequest
响应
HTTP代码 | 说明 | 类型 |
---|---|---|
204 | 成功 | 无内容 |
400 | 参数错误 1.InvalidParameterMissingError.AppId:app_id缺失 2.InvalidParameterMissingError.PhoneNumber:phone_number缺失 3.InvalidParameterMissingError.SmsCodeId:sms_code_id缺失 4.InvalidParameterMissingError.SmsCode:sms_code缺失 5.InvalidParameterError.SmsCode:sms_code无效 6.PasswordTooSimpleError:密码太简单 |
InvalidParameterMissingError |
403 | 无权限 | ForbiddenError |
500 | 内部错误 | InternalErrorError |
标签
- account
HTTP请求示例
请求 path
/v2/account/default/change_password
请求 body
{
"app_id" : "csaklidwasdhjwid",
"new_password" : "123456,Abc",
"phone_number" : "152*****341",
"sms_code" : "1234",
"sms_code_id" : "csjanwia"
}
HTTP响应示例
响应 400
{
"code" : "InvalidParameterMissing",
"message" : "The input parameter {parameter_name} is missing."
}
响应 403
{
"code" : "Forbidden",
"message" : "User not authorized to operate on the specified APIs."
}
响应 500
{
"code" : "InternalError",
"message" : "The request has been failed due to some unknown error."
}
设置登录密码
POST /v2/account/default/set_password
说明
设置手机登录密码,密码必须包含数字、大小写字母和特殊字符,长度10-32个字符
Body参数
设置登录密码
名称 : 设置登录密码标志 : 必填类型 : DefaultSetPasswordRequest
响应
HTTP代码 | 说明 | 类型 |
---|---|---|
204 | 成功 | 无内容 |
400 | 参数错误 1.InvalidParameterMissingError.AppId:app_id缺失 2.InvalidParameterMissingError.State:state缺失 3.InvalidParameterMissingError.NewPassword:new_password缺失 4.InvalidParameterError.State:state无效 5.PasswordTooSimpleError:密码太简单 |
InvalidParameterMissingError |
403 | 无权限 | ForbiddenError |
500 | 内部错误 | InternalErrorError |
标签
- account
HTTP请求示例
请求 path
/v2/account/default/set_password
请求 body
{
"app_id" : "csaklidwasdhjwid",
"new_password" : "123456,Abc",
"state" : "abc"
}
HTTP响应示例
响应 400
{
"code" : "InvalidParameterMissing",
"message" : "The input parameter {parameter_name} is missing."
}
响应 403
{
"code" : "Forbidden",
"message" : "User not authorized to operate on the specified APIs."
}
响应 500
{
"code" : "InternalError",
"message" : "The request has been failed due to some unknown error."
}
通过账号获取访问令牌
POST /v2/account/get_access_token_by_link_info
说明
管理员通过账号信息直接获取用户的访问令牌
Body参数
获取令牌信息
名称 : 获取访问令牌请求标志 : 必填类型 : GetAccessTokenByLinkInfoRequest
响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 | 成功 | AccountAccessTokenResponse |
400 | 参数错误 1.InvalidParameterError.Type:账号类型错误 2.InvalidParameterMissingError.Identity:identity缺失 |
InvalidParameterError |
403 | 无权限 | ForbiddenError |
404 | 资源未找到错误 1.NotFoundError.Account:账号不存在 2.NotFoundError.User:用户不存在 |
NotFoundError |
500 | 内部错误 | InternalErrorError |
标签
- account
HTTP请求示例
请求 path
/v2/account/get_access_token_by_link_info
请求 body
{
"identity" : "15208333333",
"type" : "mobile"
}
HTTP响应示例
响应 200
{
"access_token" : "cnskjajkahwdhwialsnd",
"avatar" : "cherry",
"default_drive_id" : "100",
"exist_link" : [ ],
"expire_time" : "2019-09-01T06:57:48.813Z",
"expires_in" : 3600,
"need_link" : false,
"nick_name" : "cherry",
"refresh_token" : "cnskjajkahwdhwialsnd",
"role" : "user",
"state" : "klafhjas-asdasd-asd-as-d-asd-asd-asdasd",
"token_type" : "Bearer",
"user_data" : "{ is_student: true }",
"user_id" : "DING-xxxxx",
"user_name" : "cherry"
}
响应 400
{
"code" : "InvalidParameter",
"message" : "The input parameter {parameter_name} is not valid."
}
响应 403
{
"code" : "Forbidden",
"message" : "User not authorized to operate on the specified APIs."
}
响应 404
{
"code" : "NotFound",
"message" : "The resource {resource_name} cannot be found. Please check."
}
响应 500
{
"code" : "InternalError",
"message" : "The request has been failed due to some unknown error."
}
获取图片验证码
POST /v2/account/get_captcha
说明
获取图片验证码,用于人机校验,默认不需要
Body参数
获取图片验证码
名称 : 获取图片验证码标志 : 必填类型 : GetCaptchaRequest
响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 | 成功 | Captcha |
400 | 参数错误 1.InvalidParameterMissingError.AppId:app_id缺失 |
InvalidParameterMissingError |
403 | 无权限 | ForbiddenError |
500 | 内部错误 | InternalErrorError |
标签
- account
HTTP请求示例
请求 path
/v2/account/get_captcha
请求 body
{
"app_id" : "csaklidwasdhjwid"
}
HTTP响应示例
响应 200
{
"captcha" : "iVBORw0KGgoAAAANSUhEUgAAAFAAAAAaCAIAAACvsEzwAAABRElEQVR42t3YsQ4CIQwA0CZ+i36Bg5uTo1/gqquDTvf1JwkJqRR7vZYCJ2HClOMBVw5h/i7P9yvU+X8LFFsju728wRNhcQR+gyj27G2GtQGHxy5USaN6PV1n2Qt8Ou6ZKllPJ/MQ4PN0CzXrs9i4jS2dIelKMuBse18vd1zdweHZdnC2V3kwDsm0OnYHMDVLtnQICbZ0XuIpqAamaaMjmGbvOAV0Fmqew7XAmXlV0kqButcYhDs5PqYiGA9dDm6atCK7bpbGx5Jknxszlj5pYR5t8QMX8b5gLMSVCZGfw4svdtHsDqZmPooHJxte5NTCnx3twKvKIhgLcaXrSbP0iGBhIK/99aXlnrQst1/7BajDt7Txxl/rrqvuBOaGJY3Szt4GOBuoka2LhQYw/ic1eyww/5eV95x229IDmqHlS1vdrOjkA5iK2BYUhM2zAAAAAElFTkSuQmCC",
"captcha_format" : "png",
"captcha_id" : "f4690fc255e2fb24c10ede079d3802b4cClRimRh67Q"
}
响应 400
{
"code" : "InvalidParameterMissing",
"message" : "The input parameter {parameter_name} is missing."
}
响应 403
{
"code" : "Forbidden",
"message" : "User not authorized to operate on the specified APIs."
}
响应 500
{
"code" : "InternalError",
"message" : "The request has been failed due to some unknown error."
}
获取用户认证方式详情
POST /v2/account/get_link_info
说明
获取用户认证方式详情
Body参数
获取用户认证方式详情
名称 : 获取用户认证方式详情请求标志 : 必填类型 : GetByLinkInfoRequest
响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 | 成功 | LinkInfoResponse |
400 | 参数错误 1.InvalidParameterError.Type:账号类型错误 2.InvalidParameterMissingError.Identity:identity缺失 |
InvalidParameterError |
403 | 无权限 | ForbiddenError |
404 | 资源未找到错误 1.NotFoundError.Account:账号不存在 |
NotFoundError |
500 | 内部错误 | InternalErrorError |
标签
- account
HTTP请求示例
请求 path
/v2/account/get_link_info
请求 body
{
"identity" : "15208333333",
"type" : "mobile"
}
HTTP响应示例
响应 200
{
"authentication_type" : "mobile",
"created_at" : 1556163159820,
"domain_id" : "5000",
"identity" : "15208345000",
"last_login_time" : 1556163159820,
"status" : "normal",
"user_id" : "00016a587b62b50003deea299a4f5b50"
}
响应 400
{
"code" : "InvalidParameter",
"message" : "The input parameter {parameter_name} is not valid."
}
响应 403
{
"code" : "Forbidden",
"message" : "User not authorized to operate on the specified APIs."
}
响应 404
{
"code" : "NotFound",
"message" : "The resource {resource_name} cannot be found. Please check."
}
响应 500
{
"code" : "InternalError",
"message" : "The request has been failed due to some unknown error."
}
获取用户绑定信息
POST /v2/account/get_link_info_by_user_id
说明
获取用户的所有绑定信息
Body参数
获取用户的所有绑定信息
名称 : 获取用户绑定信息请求标志 : 必填类型 : GetLinkInfoByUserIDRequest
响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 | 成功 | LinkInfoListResponse |
400 | 参数错误 1.InvalidParameterMissingError.UserId:user_id缺失 |
InvalidParameterMissingError |
403 | 无权限 | ForbiddenError |
500 | 内部错误 | InternalErrorError |
标签
- account
HTTP请求示例
请求 path
/v2/account/get_link_info_by_user_id
请求 body
{
"user_id" : "123987123617823"
}
HTTP响应示例
响应 200
{
"items" : [ ]
}
响应 400
{
"code" : "InvalidParameterMissing",
"message" : "The input parameter {parameter_name} is missing."
}
响应 403
{
"code" : "Forbidden",
"message" : "User not authorized to operate on the specified APIs."
}
响应 500
{
"code" : "InternalError",
"message" : "The request has been failed due to some unknown error."
}
绑定用户认证方式
POST /v2/account/link
说明
绑定用户认证方式
Body参数
绑定用户认证方式
名称 : 绑定用户认证方式标志 : 必填类型 : AccountLinkRequest
响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 | 成功 | AccountAccessTokenResponse |
400 | 参数错误 1.InvalidParameterError.Type:账号类型错误 2.InvalidParameterError.Status:状态错误 3.InvalidParameterMissingError.Identity:identity缺失 4.UserAtLeastOneNormalAccountExist:用户至少存在一个正常状态的认证方式 |
InvalidParameterError |
403 | 无权限 | ForbiddenError |
404 | 资源未找到错误 1.NotFoundError.User:用户不存在 |
NotFoundError |
409 | 已经存在错误 1.AlreadyExistError.Account:当前认证方式已存在 |
AlreadyExistError |
500 | 内部错误 | InternalErrorError |
标签
- account
HTTP请求示例
请求 path
/v2/account/link
请求 body
{
"detail" : "{name:jack,age:20}",
"identity" : "15208333333",
"status" : "normal",
"type" : "mobile",
"user_id" : "123987123617823"
}
HTTP响应示例
响应 200
{
"access_token" : "cnskjajkahwdhwialsnd",
"avatar" : "cherry",
"default_drive_id" : "100",
"exist_link" : [ ],
"expire_time" : "2019-09-01T06:57:48.813Z",
"expires_in" : 3600,
"need_link" : false,
"nick_name" : "cherry",
"refresh_token" : "cnskjajkahwdhwialsnd",
"role" : "user",
"state" : "klafhjas-asdasd-asd-as-d-asd-asd-asdasd",
"token_type" : "Bearer",
"user_data" : "{ is_student: true }",
"user_id" : "DING-xxxxx",
"user_name" : "cherry"
}
响应 400
{
"code" : "InvalidParameter",
"message" : "The input parameter {parameter_name} is not valid."
}
响应 403
{
"code" : "Forbidden",
"message" : "User not authorized to operate on the specified APIs."
}
响应 404
{
"code" : "NotFound",
"message" : "The resource {resource_name} cannot be found. Please check."
}
响应 409
{
"code" : "AlreadyExist",
"message" : "{resource} has already exists. {extra_msg}"
}
响应 500
{
"code" : "InternalError",
"message" : "The request has been failed due to some unknown error."
}
查询手机号是否存在
POST /v2/account/mobile/check_exist
说明
查询手机号是否已被注册
Body参数
查询手机号是否存在
名称 : 查询手机号是否存在请求标志 : 必填类型 : MobileCheckExistRequest
响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 | 成功 | MobileCheckExistResponse |
400 | 参数错误 1.InvalidParameterMissingError.AppId:app_id缺失 2.InvalidParameterMissingError.PhoneNumber:phone_number缺失 |
InvalidParameterMissingError |
403 | 无权限 | ForbiddenError |
404 | 资源未找到错误 1.NotFoundError.User:用户不存在 |
NotFoundError |
500 | 内部错误 | InternalErrorError |
标签
- account
HTTP请求示例
请求 path
/v2/account/mobile/check_exist
请求 body
{
"app_id" : "csaklidwasdhjwid",
"phone_number" : "152*****341"
}
HTTP响应示例
响应 200
{
"is_exist" : true,
"phone_number" : "152*****341"
}
响应 400
{
"code" : "InvalidParameterMissing",
"message" : "The input parameter {parameter_name} is missing."
}
响应 403
{
"code" : "Forbidden",
"message" : "User not authorized to operate on the specified APIs."
}
响应 404
{
"code" : "NotFound",
"message" : "The resource {resource_name} cannot be found. Please check."
}
响应 500
{
"code" : "InternalError",
"message" : "The request has been failed due to some unknown error."
}
手机号登录
POST /v2/account/mobile/login
说明
通过手机号+短信或密码登录,返回刷新令牌和访问令牌
Body参数
手机号登录
名称 : 手机号登陆请求标志 : 必填类型 : MobileLoginRequest
响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 | 成功 | AccountAccessTokenResponse |
400 | 参数错误 1.InvalidParameterMissingError.AppId:app_id缺失 2.InvalidParameterMissingError.PhoneNumber:phone_number缺失 3.InvalidParameterMissingError.SmsCodeId:sms_code_id缺失 4.InvalidParameterMissingError.SmsCode:sms_code缺失 5.InvalidParameterError.SmsCode:sms_code无效 6.InvalidPasswordError:用户名或密码错误 |
InvalidParameterMissingError |
403 | 无权限 | ForbiddenError |
404 | 资源未找到错误 1.NotFoundError.User:用户不存在 |
NotFoundError |
500 | 内部错误 | InternalErrorError |
标签
- account
HTTP请求示例
请求 path
/v2/account/mobile/login
请求 body
{
"app_id" : "csaklidwasdhjwid",
"auto_register" : false,
"captcha_id" : "abc",
"captcha_text" : "abc",
"password" : "123456",
"phone_number" : "152*****341",
"sms_code" : "1234",
"sms_code_id" : "csjanwia"
}
HTTP响应示例
响应 200
{
"access_token" : "cnskjajkahwdhwialsnd",
"avatar" : "cherry",
"default_drive_id" : "100",
"exist_link" : [ ],
"expire_time" : "2019-09-01T06:57:48.813Z",
"expires_in" : 3600,
"need_link" : false,
"nick_name" : "cherry",
"refresh_token" : "cnskjajkahwdhwialsnd",
"role" : "user",
"state" : "klafhjas-asdasd-asd-as-d-asd-asd-asdasd",
"token_type" : "Bearer",
"user_data" : "{ is_student: true }",
"user_id" : "DING-xxxxx",
"user_name" : "cherry"
}
响应 400
{
"code" : "InvalidParameterMissing",
"message" : "The input parameter {parameter_name} is missing."
}
响应 403
{
"code" : "Forbidden",
"message" : "User not authorized to operate on the specified APIs."
}
响应 404
{
"code" : "NotFound",
"message" : "The resource {resource_name} cannot be found. Please check."
}
响应 500
{
"code" : "InternalError",
"message" : "The request has been failed due to some unknown error."
}
手机号注册
POST /v2/account/mobile/register
说明
通过手机号+短信验证码注册账号
Body参数
手机号注册
名称 : 手机号注册请求标志 : 必填类型 : MobileRegisterRequest
响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 | 成功 | AccountAccessTokenResponse |
400 | 参数错误 1.InvalidParameterMissingError.AppId:app_id缺失 2.InvalidParameterMissingError.PhoneNumber:phone_number缺失 3.InvalidParameterMissingError.SmsCodeId:sms_code_id缺失 4.InvalidParameterMissingError.SmsCode:sms_code缺失 5.InvalidParameterError.SmsCode:sms_code无效 6.IncorrectStatusError.Account:当前状态无法注册 |
InvalidParameterMissingError |
403 | 无权限 | ForbiddenError |
409 | 已经存在错误 1.AlreadyExistError.PhoneNumber:当前手机号已存在 |
AlreadyExistError |
500 | 内部错误 | InternalErrorError |
标签
- account
HTTP请求示例
请求 path
/v2/account/mobile/register
请求 body
{
"app_id" : "csaklidwasdhjwid",
"phone_number" : "152*****341",
"sms_code" : "1234",
"sms_code_id" : "csjanwia"
}
HTTP响应示例
响应 200
{
"access_token" : "cnskjajkahwdhwialsnd",
"avatar" : "cherry",
"default_drive_id" : "100",
"exist_link" : [ ],
"expire_time" : "2019-09-01T06:57:48.813Z",
"expires_in" : 3600,
"need_link" : false,
"nick_name" : "cherry",
"refresh_token" : "cnskjajkahwdhwialsnd",
"role" : "user",
"state" : "klafhjas-asdasd-asd-as-d-asd-asd-asdasd",
"token_type" : "Bearer",
"user_data" : "{ is_student: true }",
"user_id" : "DING-xxxxx",
"user_name" : "cherry"
}
响应 400
{
"code" : "InvalidParameterMissing",
"message" : "The input parameter {parameter_name} is missing."
}
响应 403
{
"code" : "Forbidden",
"message" : "User not authorized to operate on the specified APIs."
}
响应 409
{
"code" : "AlreadyExist",
"message" : "{resource} has already exists. {extra_msg}"
}
响应 500
{
"code" : "InternalError",
"message" : "The request has been failed due to some unknown error."
}
发送短信验证码
POST /v2/account/mobile/send_sms_code
说明
发送短信验证码,用于登录、注册、修改密码、绑定等
Body参数
发送短信验证码
名称 : 发送短信验证码请求标志 : 必填类型 : MobileSendSmsCodeRequest
响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 | 成功 | MobileSendSmsCodeResponse |
400 | 参数错误 1.InvalidParameterMissingError.AppId:app_id缺失 2.InvalidParameterMissingError.PhoneNumber:phone_number缺失 3.InvalidParameterError.Type:type无效 |
InvalidParameterMissingError |
403 | 无权限 | ForbiddenError |
500 | 内部错误 | InternalErrorError |
标签
- account
HTTP请求示例
请求 path
/v2/account/mobile/send_sms_code
请求 body
{
"app_id" : "csaklidwasdhjwid",
"captcha_id" : "abc",
"captcha_text" : "abc",
"phone_number" : "152*****341",
"type" : "login"
}
HTTP响应示例
响应 200
{
"sms_code_id" : "csjanwia"
}
响应 400
{
"code" : "InvalidParameterMissing",
"message" : "The input parameter {parameter_name} is missing."
}
响应 403
{
"code" : "Forbidden",
"message" : "User not authorized to operate on the specified APIs."
}
响应 500
{
"code" : "InternalError",
"message" : "The request has been failed due to some unknown error."
}
通过刷新令牌获取访问令牌
POST /v2/account/token
说明
用户通过刷新令牌(refresh_token)获取访问令牌(access_token)
Body参数
获取访问令牌
名称 : 获取访问令牌请求标志 : 必填类型 : TokenRequest
响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 | 成功 | AccountAccessTokenResponse |
400 | 参数错误 1.InvalidParameterMissingError.AppId:app_id缺失 2.InvalidParameterMissingError.RefreshToken:refresh_token缺失 3.InvalidParameterError.GrantType:grant_type无效 4.InvalidParameterError.RefreshToken:refresh_token无效 5.IncorrectUserStatusError:用户当前状态不支持此操作 |
InvalidParameterMissingError |
403 | 无权限 | ForbiddenError |
500 | 内部错误 | InternalErrorError |
标签
- account
HTTP请求示例
请求 path
/v2/account/token
请求 body
{
"app_id" : "csaklidwasdhjwid",
"grant_type" : "refresh_token",
"refresh_token" : "ybb3WJy2CwXHoM6hBcydGlvzMoJkFpkk"
}
HTTP响应示例
响应 200
{
"access_token" : "cnskjajkahwdhwialsnd",
"avatar" : "cherry",
"default_drive_id" : "100",
"exist_link" : [ ],
"expire_time" : "2019-09-01T06:57:48.813Z",
"expires_in" : 3600,
"need_link" : false,
"nick_name" : "cherry",
"refresh_token" : "cnskjajkahwdhwialsnd",
"role" : "user",
"state" : "klafhjas-asdasd-asd-as-d-asd-asd-asdasd",
"token_type" : "Bearer",
"user_data" : "{ is_student: true }",
"user_id" : "DING-xxxxx",
"user_name" : "cherry"
}
响应 400
{
"code" : "InvalidParameterMissing",
"message" : "The input parameter {parameter_name} is missing."
}
响应 403
{
"code" : "Forbidden",
"message" : "User not authorized to operate on the specified APIs."
}
响应 500
{
"code" : "InternalError",
"message" : "The request has been failed due to some unknown error."
}
定义
APIError
APIError is api error common struct
名称 | 说明 | 类型 |
---|---|---|
code 必填 |
样例 : "string" |
string |
message 必填 |
样例 : "string" |
string |
AccountAccessTokenResponse
名称 | 说明 | 类型 |
---|---|---|
access_token 必填 |
用于调用业务接口的accessToken 样例 : "cnskjajkahwdhwialsnd" |
string |
avatar 可选 |
当前用户头像 样例 : "cherry" |
string |
default_drive_id 可选 |
Default Drive ID 样例 : "100" |
string |
exist_link 可选 |
当前用户已存在的登录方式 样例 : [ ] |
< LinkInfo > array |
expire_time 可选 |
accessToken过期时间,ISO时间 样例 : "2019-09-01T06:57:48.813Z" |
string |
expires_in 可选 |
accessToken过期时间,单位秒 样例 : 3600 |
integer (int64) |
need_link 必填 |
是否需要绑定 样例 : false |
boolean |
nick_name 可选 |
当前用户昵称 样例 : "cherry" |
string |
refresh_token 可选 |
用于刷新accessToken 样例 : "cnskjajkahwdhwialsnd" |
string |
role 可选 |
当前用户角色 样例 : "user" |
string |
state 可选 |
临时权限,用于登录成功后设置密码 样例 : "klafhjas-asdasd-asd-as-d-asd-asd-asdasd" |
string |
token_type 可选 |
accessToken类型,Bearer 样例 : "Bearer" |
string |
user_data 可选 |
用户自定义数据,格式为json,可用于配置项、少量临时数据等存储,不超过1K 样例 : "{ is_student: true }" |
< string, object > map |
user_id 可选 |
当前用户ID 样例 : "DING-xxxxx" |
string |
user_name 可选 |
当前用户名 样例 : "cherry" |
string |
AccountLinkRequest
名称 | 说明 | 类型 |
---|---|---|
detail 可选 |
账号信息 样例 : "{name:jack,age:20}" |
string |
identity 必填 |
唯一身份标识 样例 : "15208333333" |
string |
status 可选 |
状态 样例 : "normal" |
string |
type 必填 |
认证类型 样例 : "mobile" |
string |
user_id 必填 |
绑定的user_id 样例 : "123987123617823" |
string |
AddStoreRequest
名称 | 说明 | 类型 |
---|---|---|
base_path 可选 |
存储公共前缀 样例 : "ccp-data" |
string |
bucket 可选 |
bucket名称 样例 : "data-sz-bucket" |
string |
domain_id 必填 |
domain ID 样例 : "sz100" |
string |
endpoint 必填 |
存储访问地址 样例 : "https://oss-cn-shenzhen.aliyuncs.com/" |
string |
ownership 可选 |
存储归属,system表示系统提供,custom表示使用自己的存储 默认值 : "system" 样例 : "system" |
enum (system, custom) |
role_arn 可选 |
访问Bucket的角色ARN 样例 : "acs:oss:*:*:*" |
string |
type 必填 |
存储类型,当前只支持oss 样例 : "oss" |
enum (oss) |
AlreadyExistError
AlreadyExistError 已经存在错误
名称 | 说明 | 类型 |
---|---|---|
code 必填 |
样例 : "AlreadyExist" |
string |
message 必填 |
样例 : "{resource} has already exists. {extra_msg}" |
string |
AppAccessStrategy
名称 | 说明 | 类型 |
---|---|---|
effect 可选 |
样例 : "string" |
string |
except_app_id_list 可选 |
样例 : [ "string" ] |
< string > array |
AuthConfig
名称 | 说明 | 类型 |
---|---|---|
app_id 可选 |
样例 : "string" |
string |
app_secret 可选 |
样例 : "string" |
string |
enable 可选 |
样例 : true |
boolean |
endpoint 可选 |
样例 : "string" |
string |
enterprise_id 可选 |
样例 : "string" |
string |
BaseCCPFileResponse
Base file response
名称 | 说明 | 类型 |
---|---|---|
category 可选 |
category 样例 : "doc" |
enum (doc, image, audio, video) |
content_hash 可选 |
Content Hash 样例 : "EA4942AA8761213890A5C386F88E6464D2C31CA3" |
string |
content_hash_name 可选 |
content_hash_name 样例 : "sha1" |
enum (sha1) |
content_type 可选 |
content_type 样例 : "application/json" |
string |
crc64_hash 可选 |
crc64_hash 样例 : "string" |
string |
created_at 可选 |
created_at 样例 : "2019-08-20T06:51:27.292Z" |
string |
description 可选 |
description 样例 : "file description" |
string |
domain_id 可选 |
DomainID 模式 : "[a-z0-9A-Z]+" 样例 : "test001" |
string |
download_url 可选 |
download_url 样例 : "https://ccp.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx" |
string |
drive_id 可选 |
drive_id 模式 : "[0-9]+" 样例 : "1" |
string |
file_extension 可选 |
file_extension 样例 : "jpg" |
string |
file_id 可选 |
file_id 长度 : 40 - 50 模式 : "[a-z0-9]{1, 50}" 样例 : "5d5b846942cf94fa72324c14a4bda34e81da635d" |
string |
hidden 可选 |
Hidden type: boolean 样例 : false |
boolean |
image_media_metadata 可选 |
样例 : "[imagemediaresponse](#imagemediaresponse)" |
ImageMediaResponse |
labels 可选 |
labels 样例 : [ "label1:1", "label2:2" ] |
< string > array |
meta 可选 |
meta 样例 : "file meta" |
string |
name 必填 |
name 模式 : "[a-zA-Z0-9.-]{1,1024}" 样例 : "ccp.jpg" |
string |
parent_file_id 可选 |
parent_file_id 长度 : 40 - 50 模式 : "[a-z0-9]{1, 50}" 样例 : "root" |
string |
size 可选 |
Size 最小值 : 0 最大值 : 53687091200 样例 : 1024 |
integer (int64) |
starred 可选 |
starred type: boolean 样例 : false |
boolean |
status 可选 |
status 样例 : "available" |
enum (uploading, available) |
thumbnail 可选 |
thumbnail 样例 : "https://ccp.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx" |
string |
trashed_at 可选 |
trashed_at 样例 : "string" |
string (date-time) |
type 可选 |
type 样例 : "file" |
enum (file, folder) |
updated_at 可选 |
updated_at 样例 : "string" |
string (date-time) |
upload_id 可选 |
upload_id 样例 : "C9DCFE5A82644AC7A02DB74C30C934A6" |
string |
url 可选 |
url 样例 : "https://ccp.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx" |
string |
BaseDriveResponse
Base drive response
名称 | 说明 | 类型 |
---|---|---|
creator 可选 |
Drive 创建者 样例 : "ccp" |
string |
description 可选 |
Drive 备注信息 样例 : "ccp team drive" |
string |
domain_id 可选 |
Domain ID 样例 : "hz999" |
string |
drive_id 可选 |
Drive ID 样例 : "123" |
string |
drive_name 可选 |
Drive 名称 样例 : "ccpdrive" |
string |
drive_type 可选 |
Drive 类型 样例 : "normal" |
string |
owner 可选 |
Drive 所有者 样例 : "ccp" |
string |
relative_path 可选 |
Drive存储基于store的相对路径,domain的PathType为OSSPath时返回 样例 : "/a/b/e/" |
string |
status 可选 |
Drive 状态 样例 : "enabled" |
string |
store_id 可选 |
存储 ID, domain的PathType为OSSPath时返回 样例 : "123" |
string |
total_size 可选 |
Drive 空间总量 样例 : 102400 |
integer (int64) |
used_size 可选 |
Drive 空间已使用量 样例 : 1024 |
integer (int64) |
BaseOSSFileResponse
Base file response
名称 | 说明 | 类型 |
---|---|---|
content_hash 可选 |
Content Hash 样例 : "EA4942AA8761213890A5C386F88E6464D2C31CA3" |
string |
content_hash_name 可选 |
content_hash_name 样例 : "sha1" |
enum (sha1) |
content_type 可选 |
content_type 样例 : "application/json" |
string |
crc64_hash 可选 |
crc64_hash 样例 : "string" |
string |
created_at 可选 |
created_at 样例 : "2019-08-20T06:51:27.292Z" |
string |
description 可选 |
description 样例 : "file description" |
string |
domain_id 可选 |
domain_id 模式 : "[a-z0-9A-Z]+" 样例 : "test001" |
string |
download_url 可选 |
download_url 样例 : "https://ccp.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx" |
string |
drive_id 可选 |
drive_id 模式 : "[0-9]+" 样例 : "1" |
string |
file_extension 可选 |
file_extension 样例 : "jpg" |
string |
file_path 可选 |
file_path 样例 : "/a.jpg" |
string |
name 必填 |
name 模式 : "[a-zA-Z0-9.-]{1,1024}" 样例 : "ccp.jpg" |
string |
parent_file_path 可选 |
parent_file_id 长度 : 40 - 50 模式 : "[a-z0-9]{1, 50}" 样例 : "/" |
string |
share_id 可选 |
share_id 模式 : "[0-9]+" 样例 : "5d5b846942cf94fa72324c14a4bda34e81da635d" |
string |
size 可选 |
Size 最小值 : 0 最大值 : 53687091200 样例 : 1024 |
integer (int64) |
status 可选 |
status 样例 : "available" |
enum (uploading, available) |
thumbnail 可选 |
thumbnail 样例 : "https://ccp.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx" |
string |
trashed_at 可选 |
trashed_at 样例 : "string" |
string (date-time) |
type 可选 |
type 样例 : "file" |
enum (file, folder) |
updated_at 可选 |
updated_at 样例 : "string" |
string (date-time) |
upload_id 可选 |
upload_id 样例 : "C9DCFE5A82644AC7A02DB74C30C934A6" |
string |
url 可选 |
url 样例 : "https://ccp.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx" |
string |
BaseShareResponse
List share response
名称 | 说明 | 类型 |
---|---|---|
created_at 可选 |
created_at 样例 : "2006-01-02T15:04:05.999Z" |
string |
creator 可选 |
creator 样例 : "xxx" |
string |
description 可选 |
description 样例 : "share description" |
string |
domain_id 可选 |
domain_id 样例 : "domain-1" |
string |
drive_id 可选 |
drive_id 样例 : "1" |
string |
expiration 可选 |
expiration 样例 : "2006-01-02T15:04:05.999Z" |
string |
expired 可选 |
expired 样例 : false |
boolean |
owner 可选 |
owner 样例 : "xxx" |
string |
permissions 可选 |
permissions 样例 : [ ] |
< string > array |
share_file_path 可选 |
share_path 样例 : "/a/b/c/" |
string |
share_id 可选 |
share_id 样例 : "3d336314-63c8-4d96-bce0-17aefb6833b6" |
string |
share_name 可选 |
share_name 样例 : "new_share" |
string |
status 可选 |
status 样例 : "enabled" |
string |
updated_at 可选 |
updated_at 样例 : "2006-01-02T15:04:05.999Z" |
string |
BatchSubResponse
名称 | 说明 | 类型 |
---|---|---|
body 可选 |
body 子请求的返回结果,可参考对于子请求文档 json 字符串 样例 : {<br> "drive_id" : "101",<br> "file_id" : "xxxxxx"<br>} |
< string, object > map |
id 可选 |
id 请求带过来的id, 可以跟 request 进行关联 样例 : "\"1\"" |
string |
status 可选 |
status 子请求的返回状态码,可参考对于子请求文档 样例 : 200 |
integer (int64) |
CCPBatchResponse
batch operation response
名称 | 说明 | 类型 |
---|---|---|
responses 可选 |
responses 返回结果合集 样例 : [ "[batchsubresponse](#batchsubresponse)" ] |
< BatchSubResponse > array |
CCPCompleteFileResponse
complete file response
多态性 : 成分
名称 | 说明 | 类型 |
---|---|---|
category 可选 |
category 样例 : "doc" |
enum (doc, image, audio, video) |
content_hash 可选 |
Content Hash 样例 : "EA4942AA8761213890A5C386F88E6464D2C31CA3" |
string |
content_hash_name 可选 |
content_hash_name 样例 : "sha1" |
enum (sha1) |
content_type 可选 |
content_type 样例 : "application/json" |
string |
crc 可选 |
crc 样例 : "string" |
string |
crc64_hash 可选 |
crc64_hash 样例 : "string" |
string |
created_at 可选 |
created_at 样例 : "2019-08-20T06:51:27.292Z" |
string |
description 可选 |
description 样例 : "file description" |
string |
domain_id 可选 |
DomainID 模式 : "[a-z0-9A-Z]+" 样例 : "test001" |
string |
download_url 可选 |
download_url 样例 : "https://ccp.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx" |
string |
drive_id 可选 |
drive_id 模式 : "[0-9]+" 样例 : "1" |
string |
file_extension 可选 |
file_extension 样例 : "jpg" |
string |
file_id 可选 |
file_id 长度 : 40 - 50 模式 : "[a-z0-9]{1, 50}" 样例 : "5d5b846942cf94fa72324c14a4bda34e81da635d" |
string |
hidden 可选 |
Hidden type: boolean 样例 : false |
boolean |
image_media_metadata 可选 |
样例 : "[imagemediaresponse](#imagemediaresponse)" |
ImageMediaResponse |
labels 可选 |
labels 样例 : [ "label1:1", "label2:2" ] |
< string > array |
meta 可选 |
meta 样例 : "file meta" |
string |
name 必填 |
name 模式 : "[a-zA-Z0-9.-]{1,1024}" 样例 : "ccp.jpg" |
string |
parent_file_id 可选 |
parent_file_id 长度 : 40 - 50 模式 : "[a-z0-9]{1, 50}" 样例 : "root" |
string |
size 可选 |
Size 最小值 : 0 最大值 : 53687091200 样例 : 1024 |
integer (int64) |
starred 可选 |
starred type: boolean 样例 : false |
boolean |
status 可选 |
status 样例 : "available" |
enum (uploading, available) |
thumbnail 可选 |
thumbnail 样例 : "https://ccp.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx" |
string |
trashed_at 可选 |
trashed_at 样例 : "string" |
string (date-time) |
type 可选 |
type 样例 : "file" |
enum (file, folder) |
updated_at 可选 |
updated_at 样例 : "string" |
string (date-time) |
upload_id 可选 |
upload_id 样例 : "C9DCFE5A82644AC7A02DB74C30C934A6" |
string |
url 可选 |
url 样例 : "https://ccp.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx" |
string |
CCPCopyFileResponse
文件拷贝 response
名称 | 说明 | 类型 |
---|---|---|
async_task_id 可选 |
async_task_id 样例 : "000e89fb-cf8f-11e9-8ab4-b6e980803a3b" |
string |
domain_id 可选 |
DomainID 模式 : "[a-z0-9A-Z]+" 样例 : "test001" |
string |
drive_id 可选 |
drive_id 模式 : "[0-9]+" 样例 : "1" |
string |
file_id 可选 |
file_id 长度 : 40 - 50 模式 : "[a-z0-9]{1, 50}" 样例 : "5d5b846942cf94fa72324c14a4bda34e81da635d" |
string |
CCPCreateFileResponse
Create file response
名称 | 说明 | 类型 |
---|---|---|
domain_id 可选 |
domain_id 长度 : 40 - 50 模式 : "[a-z0-9]{1, 50}" 样例 : "domain" |
string |
drive_id 可选 |
drive_id 模式 : "[0-9]+" 样例 : "1" |
string |
file_id 可选 |
file_id 长度 : 40 - 50 模式 : "[a-z0-9]{1, 50}" 样例 : "5d79206586bb5dd69fb34c349282718146c55da7" |
string |
parent_file_id 可选 |
parent_file_id 长度 : 40 - 50 模式 : "[a-z0-9]{1, 50}" 样例 : "root" |
string |
part_info_list 可选 |
part_info_list 样例 : "[" |
< UploadPartInfo > array |
rapid_upload 可选 |
rapid_upload type: boolean 样例 : false |
boolean |
type 可选 |
type 样例 : "file" |
enum (file, folder) |
upload_id 可选 |
upload_id 样例 : "C9DCFE5A82644AC7A02DB74C30C934A6" |
string |
CCPDeleteFileResponse
删除文件 response
名称 | 说明 | 类型 |
---|---|---|
async_task_id 可选 |
async_task_id 样例 : "000e89fb-cf8f-11e9-8ab4-b6e980803a3b" |
string |
domain_id 可选 |
domain_id 模式 : "[a-z0-9A-Z]+" 样例 : "test001" |
string |
drive_id 可选 |
drive_id 模式 : "[0-9]+" 样例 : "1" |
string |
file_id 可选 |
file_id 长度 : 40 - 50 模式 : "[a-z0-9]{1, 50}" 样例 : "5d5b846942cf94fa72324c14a4bda34e81da635d" |
string |
CCPDeleteFilesResponse
批量删除文件 response
名称 | 说明 | 类型 |
---|---|---|
deleted_file_id_list 可选 |
deleted_file_id_list 样例 : [ ] |
< string > array |
domain_id 可选 |
domain_id 模式 : "[a-z0-9A-Z]+" 样例 : "test001" |
string |
drive_id 可选 |
drive_id 模式 : "[0-9]+" 样例 : "1" |
string |
CCPGetAsyncTaskResponse
Get AsyncTask Response
名称 | 说明 | 类型 |
---|---|---|
async_task_id 可选 |
async_task_id type:string 样例 : "000e89fb-cf8f-11e9-8ab4-b6e980803a3b" |
string |
message 可选 |
message 样例 : "task is running" |
string |
state 可选 |
state 样例 : "success" |
enum (Running, Failed, Succeed) |
CCPGetDownloadUrlResponse
获取download url response
名称 | 说明 | 类型 |
---|---|---|
expiration 可选 |
expiration 样例 : "2006-01-02T15:04:05.999Z07:00" |
string |
method 可选 |
method 样例 : "GET" |
string |
url 可选 |
url 样例 : "https://ccp.data.aliyuncs.com/hz22%2F5d79219b0aa9a7c995a94a96993ba3205cd91c5a%2F5d79219bf3261a5d38744da0834ed489b677a27a?Expires=xxxOSSAccessKeyId=xxx&Signature=xxx&response-content-disposition=attachment%3Bfilename%3DtBiZAoJPC2c8b13450eda4292b7f5f8010618e078.txt" |
string |
CCPGetFileResponse
获取文件元数据response
多态性 : 成分
名称 | 说明 | 类型 |
---|---|---|
category 可选 |
category 样例 : "doc" |
enum (doc, image, audio, video) |
content_hash 可选 |
Content Hash 样例 : "EA4942AA8761213890A5C386F88E6464D2C31CA3" |
string |
content_hash_name 可选 |
content_hash_name 样例 : "sha1" |
enum (sha1) |
content_type 可选 |
content_type 样例 : "application/json" |
string |
crc64_hash 可选 |
crc64_hash 样例 : "string" |
string |
created_at 可选 |
created_at 样例 : "2019-08-20T06:51:27.292Z" |
string |
description 可选 |
description 样例 : "file description" |
string |
domain_id 可选 |
DomainID 模式 : "[a-z0-9A-Z]+" 样例 : "test001" |
string |
download_url 可选 |
download_url 样例 : "https://ccp.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx" |
string |
drive_id 可选 |
drive_id 模式 : "[0-9]+" 样例 : "1" |
string |
file_extension 可选 |
file_extension 样例 : "jpg" |
string |
file_id 可选 |
file_id 长度 : 40 - 50 模式 : "[a-z0-9]{1, 50}" 样例 : "5d5b846942cf94fa72324c14a4bda34e81da635d" |
string |
hidden 可选 |
Hidden type: boolean 样例 : false |
boolean |
image_media_metadata 可选 |
样例 : "[imagemediaresponse](#imagemediaresponse)" |
ImageMediaResponse |
labels 可选 |
labels 样例 : [ "label1:1", "label2:2" ] |
< string > array |
meta 可选 |
meta 样例 : "file meta" |
string |
name 必填 |
name 模式 : "[a-zA-Z0-9.-]{1,1024}" 样例 : "ccp.jpg" |
string |
parent_file_id 可选 |
parent_file_id 长度 : 40 - 50 模式 : "[a-z0-9]{1, 50}" 样例 : "root" |
string |
size 可选 |
Size 最小值 : 0 最大值 : 53687091200 样例 : 1024 |
integer (int64) |
starred 可选 |
starred type: boolean 样例 : false |
boolean |
status 可选 |
status 样例 : "available" |
enum (uploading, available) |
thumbnail 可选 |
thumbnail 样例 : "https://ccp.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx" |
string |
trashed_at 可选 |
trashed_at 样例 : "string" |
string (date-time) |
type 可选 |
type 样例 : "file" |
enum (file, folder) |
updated_at 可选 |
updated_at 样例 : "string" |
string (date-time) |
upload_id 可选 |
upload_id 样例 : "C9DCFE5A82644AC7A02DB74C30C934A6" |
string |
url 可选 |
url 样例 : "https://ccp.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx" |
string |
CCPGetUploadUrlResponse
Get UploadUrl Response
名称 | 说明 | 类型 |
---|---|---|
create_at 可选 |
created_at 样例 : "2019-09-11T16:34:36.977Z" |
string |
domain_id 可选 |
domain_id 模式 : "[a-z0-9A-Z]+" 样例 : "test001" |
string |
drive_id 可选 |
drive_id 模式 : "[0-9]+" 样例 : "1" |
string |
file_id 可选 |
file_id 长度 : 40 - 50 模式 : "[a-z0-9]{1, 50}" 样例 : "5d5b846942cf94fa72324c14a4bda34e81da635d" |
string |
part_info_list 可选 |
part_info_list 样例 : [ ] |
< UploadPartInfo > array |
upload_id 可选 |
upload_id 样例 : "F3C25CDFA5C74ECB8DE32672F6211FD4" |
string |
CCPListFileResponse
List file response
名称 | 说明 | 类型 |
---|---|---|
items 可选 |
items 样例 : [ ] |
< BaseCCPFileResponse > array |
next_marker 可选 |
next_marker 样例 : "NWQ1YmI4MjA0ZGU1ZWNjYzAzODM0ZDVkODlkMWJiMzcyNzM1NTU4OA" |
string |
CCPListUploadedPartResponse
获取签名 response
名称 | 说明 | 类型 |
---|---|---|
file_id 可选 |
file_id 长度 : 40 - 50 模式 : "[a-z0-9]{1, 50}" 样例 : "5d5b846942cf94fa72324c14a4bda34e81da635d" |
string |
next_part_number_marker 可选 |
next_part_number_marker 样例 : "4" |
string |
upload_id 可选 |
upload_id 样例 : "F3C25CDFA5C74ECB8DE32672F6211FD4" |
string |
uploaded_parts 可选 |
uploaded_parts 样例 : [ ] |
< UploadPartInfo > array |
CCPMoveFileResponse
文件移动 response
名称 | 说明 | 类型 |
---|---|---|
async_task_id 可选 |
async_task_id 样例 : "000e89fb-cf8f-11e9-8ab4-b6e980803a3b" |
string |
domain_id 可选 |
DomainID 模式 : "[a-z0-9A-Z]+" 样例 : "test001" |
string |
drive_id 可选 |
drive_id 模式 : "[0-9]+" 样例 : "1" |
string |
file_id 可选 |
file_id 长度 : 40 - 50 模式 : "[a-z0-9]{1, 50}" 样例 : "5d5b846942cf94fa72324c14a4bda34e81da635d" |
string |
CCPSearchFileResponse
search file response
名称 | 说明 | 类型 |
---|---|---|
items 可选 |
items 样例 : [ ] |
< BaseCCPFileResponse > array |
next_marker 可选 |
next_marker 样例 : "NWQ1YmI4MjA0ZGU1ZWNjYzAzODM0ZDVkODlkMWJiMzcyNzM1NTU4OA" |
string |
CCPUpdateFileMetaResponse
更新文件元数据 response
多态性 : 成分
名称 | 说明 | 类型 |
---|---|---|
category 可选 |
category 样例 : "doc" |
enum (doc, image, audio, video) |
content_hash 可选 |
Content Hash 样例 : "EA4942AA8761213890A5C386F88E6464D2C31CA3" |
string |
content_hash_name 可选 |
content_hash_name 样例 : "sha1" |
enum (sha1) |
content_type 可选 |
content_type 样例 : "application/json" |
string |
crc64_hash 可选 |
crc64_hash 样例 : "string" |
string |
created_at 可选 |
created_at 样例 : "2019-08-20T06:51:27.292Z" |
string |
description 可选 |
description 样例 : "file description" |
string |
domain_id 可选 |
DomainID 模式 : "[a-z0-9A-Z]+" 样例 : "test001" |
string |
download_url 可选 |
download_url 样例 : "https://ccp.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx" |
string |
drive_id 可选 |
drive_id 模式 : "[0-9]+" 样例 : "1" |
string |
file_extension 可选 |
file_extension 样例 : "jpg" |
string |
file_id 可选 |
file_id 长度 : 40 - 50 模式 : "[a-z0-9]{1, 50}" 样例 : "5d5b846942cf94fa72324c14a4bda34e81da635d" |
string |
hidden 可选 |
Hidden type: boolean 样例 : false |
boolean |
image_media_metadata 可选 |
样例 : "[imagemediaresponse](#imagemediaresponse)" |
ImageMediaResponse |
labels 可选 |
labels 样例 : [ "label1:1", "label2:2" ] |
< string > array |
meta 可选 |
meta 样例 : "file meta" |
string |
name 必填 |
name 模式 : "[a-zA-Z0-9.-]{1,1024}" 样例 : "ccp.jpg" |
string |
parent_file_id 可选 |
parent_file_id 长度 : 40 - 50 模式 : "[a-z0-9]{1, 50}" 样例 : "root" |
string |
size 可选 |
Size 最小值 : 0 最大值 : 53687091200 样例 : 1024 |
integer (int64) |
starred 可选 |
starred type: boolean 样例 : false |
boolean |
status 可选 |
status 样例 : "available" |
enum (uploading, available) |
thumbnail 可选 |
thumbnail 样例 : "https://ccp.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx" |
string |
trashed_at 可选 |
trashed_at 样例 : "string" |
string (date-time) |
type 可选 |
type 样例 : "file" |
enum (file, folder) |
updated_at 可选 |
updated_at 样例 : "string" |
string (date-time) |
upload_id 可选 |
upload_id 样例 : "C9DCFE5A82644AC7A02DB74C30C934A6" |
string |
url 可选 |
url 样例 : "https://ccp.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx" |
string |
CancelLinkRequest
名称 | 说明 | 类型 |
---|---|---|
temporary_token 必填 |
待绑定的临时token,此token只能访问绑定、取消绑定接口 样例 : "ey***s=" |
string |
Captcha
名称 | 说明 | 类型 |
---|---|---|
captcha 必填 |
图片验证码,base64格式 样例 : "iVBORw0KGgoAAAANSUhEUgAAAFAAAAAaCAIAAACvsEzwAAABRElEQVR42t3YsQ4CIQwA0CZ+i36Bg5uTo1/gqquDTvf1JwkJqRR7vZYCJ2HClOMBVw5h/i7P9yvU+X8LFFsju728wRNhcQR+gyj27G2GtQGHxy5USaN6PV1n2Qt8Ou6ZKllPJ/MQ4PN0CzXrs9i4jS2dIelKMuBse18vd1zdweHZdnC2V3kwDsm0OnYHMDVLtnQICbZ0XuIpqAamaaMjmGbvOAV0Fmqew7XAmXlV0kqButcYhDs5PqYiGA9dDm6atCK7bpbGx5Jknxszlj5pYR5t8QMX8b5gLMSVCZGfw4svdtHsDqZmPooHJxte5NTCnx3twKvKIhgLcaXrSbP0iGBhIK/99aXlnrQst1/7BajDt7Txxl/rrqvuBOaGJY3Szt4GOBuoka2LhQYw/ic1eyww/5eV95x229IDmqHlS1vdrOjkA5iK2BYUhM2zAAAAAElFTkSuQmCC" |
string |
captcha_format 必填 |
图片格式 样例 : "png" |
string |
captcha_id 必填 |
图片验证码ID 样例 : "f4690fc255e2fb24c10ede079d3802b4cClRimRh67Q" |
string |
ConfirmLinkRequest
名称 | 说明 | 类型 |
---|---|---|
temporary_token 必填 |
待绑定的临时token,此token只能访问绑定、取消绑定接口 样例 : "ey***s=" |
string |
CorsRule
名称 | 说明 | 类型 |
---|---|---|
allowed_header 可选 |
AllowedHeader 样例 : [ "h*" ] |
< string > array |
allowed_method 可选 |
AllowedMethod 样例 : [ "PUT", "GET" ] |
< string > array |
allowed_origin 可选 |
AllowedOrigin 样例 : [ "*" ] |
< string > array |
expose_header 可选 |
ExposeHeader 样例 : [ "ETag" ] |
< string > array |
max_age_seconds 可选 |
MaxAgeSeconds 样例 : 0 |
integer (int64) |
CreateAppRequest
名称 | 说明 | 类型 |
---|---|---|
app_name 必填 |
App名称 长度 : 1 - 128 样例 : "图片分享应用" |
string |
description 可选 |
App描述 长度 : 0 - 128 样例 : "测试专用" |
string |
is_third_party 可选 |
是否是domain私有App 默认值 : false 样例 : false |
boolean |
logo 必填 |
App图标 样例 : "https://app.com/logo.jpg" |
string |
redirect_uri 可选 |
App回调地址 样例 : "https://app.com/callback" |
string |
scope 必填 |
App权限列表 样例 : [ "string" ] |
< string > array |
type 必填 |
App类型 默认值 : "WebServer" 样例 : "WebServer" |
enum (WebServer, WebBrowser, Native) |
CreateDomainRequest
create domain request
名称 | 说明 | 类型 |
---|---|---|
auth_alipay_app_id 可选 |
支付宝 App Id 样例 : "abc" |
string |
auth_alipay_enbale 可选 |
启用支付宝认证 样例 : true |
boolean |
auth_alipay_private_key 可选 |
支付宝 App Secret 样例 : "abc" |
string |
auth_config 可选 |
登录相关信息 样例 : { } |
< string, AuthConfig > map |
auth_dingding_app_id 可选 |
钉钉 App Id 样例 : "abc" |
string |
auth_dingding_app_secret 可选 |
钉钉 App Secret 样例 : "abc" |
string |
auth_dingding_enable 可选 |
启用钉钉认证 样例 : true |
boolean |
auth_endpoint_enable 可选 |
样例 : true |
boolean |
auth_ram_app_id 可选 |
RAM App Id 样例 : "abc" |
string |
auth_ram_app_secret 可选 |
RAM App Secret 样例 : "abc" |
string |
auth_ram_enable 可选 |
启用 RAM 认证 样例 : true |
boolean |
data_hash_name 可选 |
数据 Hash 算法 样例 : "sha1" |
string |
description 可选 |
Domain 描述 样例 : "my test domain" |
string |
domain_name 必填 |
Domain 名称 样例 : "test_domain" |
string |
event_filename_matches 可选 |
事件通知 MNS 匹配文件名 样例 : "abc" |
string |
event_mns_endpoint 可选 |
事件通知 MNS Endpoint 样例 : "http://abc.mns.cn-shenzhen.aliyuncs.com" |
string |
event_mns_topic 可选 |
事件通知 MNS Topic 样例 : "abc" |
string |
event_names 可选 |
事件名列表 样例 : [ "abc" ] |
< string > array |
event_role_arn 可选 |
事件通知 Role Arn 样例 : "string" |
string |
init_drive_enable 可选 |
开启自动初始化 Drive 样例 : true |
boolean |
init_drive_size 可选 |
自动初始化 Drive 大小 样例 : 1024 |
integer (int64) |
path_type 必填 |
Domain 类型 样例 : "CCPPath" |
string |
published_app_access_strategy 可选 |
样例 : "[appaccessstrategy](#appaccessstrategy)" |
AppAccessStrategy |
sharable 可选 |
开启分享 样例 : true |
boolean |
store_level 可选 |
存储级别 样例 : "Standard" |
string |
store_region_list 必填 |
存储 Region 列表 样例 : [ "cn-hangzhou" ] |
< string > array |
CreateDriveResponse
Create drive response
名称 | 说明 | 类型 |
---|---|---|
domain_id 可选 |
Domain ID 样例 : "hz999" |
string |
drive_id 可选 |
Drive ID 样例 : "123" |
string |
CreateShareResponse
Create share response
名称 | 说明 | 类型 |
---|---|---|
domain_id 可选 |
domain_id 样例 : "domain-1" |
string |
share_id 可选 |
share_id 样例 : "3d336314-63c8-4d96-bce0-17aefb6833b6" |
string |
DefaultChangePasswordRequest
名称 | 说明 | 类型 |
---|---|---|
app_id 必填 |
App ID, 当前访问的App 样例 : "csaklidwasdhjwid" |
string |
new_password 必填 |
新密码,必须包含数字、大小写字母和特殊字符,长度10-32个字符 样例 : "123456,Abc" |
string |
phone_number 必填 |
手机号 样例 : "152*****341" |
string |
sms_code 必填 |
短信验证码内容 样例 : "1234" |
string |
sms_code_id 必填 |
短信验证码ID 样例 : "csjanwia" |
string |
DefaultSetPasswordRequest
名称 | 说明 | 类型 |
---|---|---|
app_id 必填 |
App ID, 当前访问的App 样例 : "csaklidwasdhjwid" |
string |
new_password 必填 |
新密码,必须包含数字、大小写字母和特殊字符,长度10-32个字符 样例 : "123456,Abc" |
string |
state 必填 |
临时操作权限码 样例 : "abc" |
string |
DeleteAppRequest
名称 | 说明 | 类型 |
---|---|---|
app_id 必填 |
App ID 样例 : "CNMrhxwPJHAReExa" |
string |
DeleteDomainRequest
delete domain request
名称 | 说明 | 类型 |
---|---|---|
domain_id 必填 |
Domain ID 样例 : "sz111" |
string |
DeleteDriveResponse
delete drive 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 |
GetAccessTokenByLinkInfoRequest
名称 | 说明 | 类型 |
---|---|---|
identity 必填 |
唯一身份标识 样例 : "15208333333" |
string |
type 必填 |
认证类型 样例 : "mobile" |
string |
GetAppRequest
名称 | 说明 | 类型 |
---|---|---|
app_id 必填 |
App ID 样例 : "CNMrhxwPJHAReExa" |
string |
GetByLinkInfoRequest
名称 | 说明 | 类型 |
---|---|---|
identity 必填 |
唯一身份标识 样例 : "15208333333" |
string |
type 必填 |
认证类型 样例 : "mobile" |
string |
GetCaptchaRequest
名称 | 说明 | 类型 |
---|---|---|
app_id 必填 |
App ID, 当前访问的App 样例 : "csaklidwasdhjwid" |
string |
GetDomainRequest
get domain request
名称 | 说明 | 类型 |
---|---|---|
domain_id 必填 |
Domain ID 样例 : "sz111" |
string |
GetDriveResponse
Get drive response
名称 | 说明 | 类型 |
---|---|---|
creator 可选 |
Drive 创建者 样例 : "ccp" |
string |
description 可选 |
Drive 备注信息 样例 : "ccp team drive" |
string |
domain_id 可选 |
Domain ID 样例 : "hz999" |
string |
drive_id 可选 |
Drive ID 样例 : "123" |
string |
drive_name 可选 |
Drive 名称 样例 : "ccpdrive" |
string |
drive_type 可选 |
Drive 类型 样例 : "normal" |
string |
owner 可选 |
Drive 所有者 样例 : "ccp" |
string |
relative_path 可选 |
Drive存储基于store的相对路径,domain的PathType为OSSPath时返回 样例 : "/a/b/e/" |
string |
status 可选 |
Drive 状态 样例 : "enabled" |
string |
store_id 可选 |
存储 ID, domain的PathType为OSSPath时返回 样例 : "123" |
string |
total_size 可选 |
Drive 空间总量 样例 : 102400 |
integer (int64) |
used_size 可选 |
Drive 空间已使用量 样例 : 1024 |
integer (int64) |
GetLinkInfoByUserIDRequest
名称 | 说明 | 类型 |
---|---|---|
user_id 必填 |
user ID 样例 : "123987123617823" |
string |
GetShareResponse
Get share response
名称 | 说明 | 类型 |
---|---|---|
created_at 可选 |
created_at 样例 : "2006-01-02T15:04:05.999Z" |
string |
creator 可选 |
creator 样例 : "xxx" |
string |
description 可选 |
description 样例 : "share description" |
string |
domain_id 可选 |
domain_id 样例 : "domain-1" |
string |
drive_id 可选 |
drive_id 样例 : "1" |
string |
expiration 可选 |
expiration 样例 : "2006-01-02T15:04:05.999Z" |
string |
expired 可选 |
expired 样例 : false |
boolean |
owner 可选 |
owner 样例 : "xxx" |
string |
permissions 可选 |
permissions 样例 : [ ] |
< string > array |
share_file_path 可选 |
share_path 样例 : "/a/b/c/" |
string |
share_id 可选 |
share_id 样例 : "3d336314-63c8-4d96-bce0-17aefb6833b6" |
string |
share_name 可选 |
share_name 样例 : "new_share" |
string |
status 可选 |
status 样例 : "enabled" |
string |
updated_at 可选 |
updated_at 样例 : "2006-01-02T15:04:05.999Z" |
string |
HTTPMethodNotAllowedError
HTTPMethodNotAllowedError 内部错误
名称 | 说明 | 类型 |
---|---|---|
code 必填 |
样例 : "HTTPMethodNotAllowed" |
string |
message 必填 |
样例 : "The request http method is not supported for this resource." |
string |
ImageMediaResponse
名称 | 说明 | 类型 |
---|---|---|
height 可选 |
height 默认值 : 0 样例 : 720 |
integer (int64) |
time 可选 |
time 样例 : "string" |
string (date-time) |
width 可选 |
width 默认值 : 0 样例 : 1024 |
integer (int64) |
IncorrectStatusError
IncorrectStatusError 状态不正确错误
名称 | 说明 | 类型 |
---|---|---|
code 必填 |
样例 : "IncorrectStatus" |
string |
message 必填 |
样例 : "The current status does not support this operation." |
string |
IncorrectUserStatusError
IncorrectUserStatusError 状态不正确错误
名称 | 说明 | 类型 |
---|---|---|
code 必填 |
样例 : "IncorrectUserStatus" |
string |
message 必填 |
样例 : "The current status of user 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 |
InvalidPasswordError
InvalidPasswordError 用户名或密码错误
名称 | 说明 | 类型 |
---|---|---|
code 必填 |
样例 : "InvalidPassword" |
string |
message 必填 |
样例 : "Username or Password is invalid." |
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 |
LinkInfo
名称 | 说明 | 类型 |
---|---|---|
identity 可选 |
当前用户已存在的登录标识 样例 : "15208345000" |
string |
type 可选 |
当前用户已存在的登录方式 样例 : "mobile" |
string |
LinkInfoListResponse
名称 | 说明 | 类型 |
---|---|---|
items 必填 |
items 样例 : [ ] |
< LinkInfoResponse > array |
LinkInfoResponse
名称 | 说明 | 类型 |
---|---|---|
authentication_type 必填 |
认证类型 样例 : "mobile" |
string |
created_at 必填 |
创建时间 样例 : 1556163159820 |
integer (int64) |
domain_id 必填 |
Domain ID 样例 : "5000" |
string |
identity 必填 |
唯一身份标识 样例 : "15208345000" |
string |
last_login_time 必填 |
最后登录时间 样例 : 1556163159820 |
integer (int64) |
status 必填 |
状态 样例 : "normal" |
string |
user_id 必填 |
用户ID 样例 : "00016a587b62b50003deea299a4f5b50" |
string |
ListAppsRequest
名称 | 说明 | 类型 |
---|---|---|
limit 可选 |
返回结果数据 默认值 : 50 最小值 : 1 最大值 : 100 样例 : 100 |
integer (int32) |
marker 可选 |
下次查询游标 样例 : "ncsajnsalsa=" |
string |
ListDomainsRequest
list domain request
名称 | 说明 | 类型 |
---|---|---|
limit 可选 |
分页大小 最小值 : 1 最大值 : 100 样例 : 100 |
integer (int32) |
marker 可选 |
查询游标 样例 : "abcd" |
string |
ListDriveResponse
list drive response
名称 | 说明 | 类型 |
---|---|---|
items 可选 |
Drive 列表 样例 : [ "[basedriveresponse](#basedriveresponse)" ] |
< BaseDriveResponse > array |
next_marker 可选 |
翻页标记 样例 : "marker" |
string |
ListShareResponse
List share response
名称 | 说明 | 类型 |
---|---|---|
items 可选 |
items 样例 : [ ] |
< BaseShareResponse > array |
next_marker 可选 |
next_marker 样例 : "string" |
string |
ListStoreFileResponse
List storage file
名称 | 说明 | 类型 |
---|---|---|
items 可选 |
items file list 样例 : [ ] |
< StoreFile > array |
next_marker 可选 |
样例 : "string" |
string |
ListStoreResponse
List storage
名称 | 说明 | 类型 |
---|---|---|
items 可选 |
items 样例 : [ ] |
< StoreItemResponse > array |
ListStoresRequest
名称 | 说明 | 类型 |
---|---|---|
domain_id 必填 |
domain ID 样例 : "sz100" |
string |
LoginByCodeRequest
名称 | 说明 | 类型 |
---|---|---|
access_token 可选 |
鉴权后返回的accessToken,淘宝登录需要此字段 样例 : "csaklidwasdhjwid" |
string |
app_id 必填 |
App ID, 当前访问的App 样例 : "csaklidwasdhjwid" |
string |
auth_code 可选 |
鉴权后返回的AuthCode,支付宝登录需要此字段 样例 : "csaklidwasdhjwid" |
string |
type 必填 |
鉴权类型,淘宝、支付宝 样例 : "taobao" |
enum (taobao, alipay) |
MobileCheckExistRequest
名称 | 说明 | 类型 |
---|---|---|
app_id 必填 |
App ID, 当前访问的App 样例 : "csaklidwasdhjwid" |
string |
phone_number 必填 |
待查询的手机号 样例 : "152*****341" |
string |
MobileCheckExistResponse
名称 | 说明 | 类型 |
---|---|---|
is_exist 必填 |
当前手机号是否存在 样例 : true |
boolean |
phone_number 必填 |
待查询的手机号 样例 : "152*****341" |
string |
MobileLoginRequest
名称 | 说明 | 类型 |
---|---|---|
app_id 必填 |
App ID, 当前访问的App 样例 : "csaklidwasdhjwid" |
string |
auto_register 可选 |
是否自动注册用户,使用密码登录此参数不生效 默认值 : false 样例 : false |
boolean |
captcha_id 可选 |
图片验证码ID, 密码登录需要此参数 样例 : "abc" |
string |
captcha_text 可选 |
用户输入的验证码值, 密码登录需要此参数 样例 : "abc" |
string |
password 可选 |
登录密码, 传入此参数则忽略短信验证码,不传此参数则默认使用短信登录。 样例 : "123456" |
string |
phone_number 必填 |
待查询的手机号 样例 : "152*****341" |
string |
sms_code 可选 |
短信验证码内容,使用密码登录此参数不生效 样例 : "1234" |
string |
sms_code_id 可选 |
短信验证码ID,使用密码登录此参数不生效 样例 : "csjanwia" |
string |
MobileRegisterRequest
名称 | 说明 | 类型 |
---|---|---|
app_id 必填 |
App ID, 当前访问的App 样例 : "csaklidwasdhjwid" |
string |
phone_number 必填 |
待查询的手机号 样例 : "152*****341" |
string |
sms_code 必填 |
短信验证码内容 样例 : "1234" |
string |
sms_code_id 必填 |
短信验证码ID 样例 : "csjanwia" |
string |
MobileSendSmsCodeRequest
名称 | 说明 | 类型 |
---|---|---|
app_id 必填 |
App ID, 当前访问的App 样例 : "csaklidwasdhjwid" |
string |
captcha_id 可选 |
图片验证码ID 样例 : "abc" |
string |
captcha_text 可选 |
用户输入的验证码值 样例 : "abc" |
string |
phone_number 必填 |
待发送验证短信的手机号 样例 : "152*****341" |
string |
type 必填 |
验证码用途, 可下发: login、register、change_password 样例 : "login" |
string |
MobileSendSmsCodeResponse
名称 | 说明 | 类型 |
---|---|---|
sms_code_id 必填 |
短信验证码ID 样例 : "csjanwia" |
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 |
OSSCompleteFileResponse
complete file response
多态性 : 成分
名称 | 说明 | 类型 |
---|---|---|
content_hash 可选 |
Content Hash 样例 : "EA4942AA8761213890A5C386F88E6464D2C31CA3" |
string |
content_hash_name 可选 |
content_hash_name 样例 : "sha1" |
enum (sha1) |
content_type 可选 |
content_type 样例 : "application/json" |
string |
crc 可选 |
crc 样例 : "string" |
string |
crc64_hash 可选 |
crc64_hash 样例 : "string" |
string |
created_at 可选 |
created_at 样例 : "2019-08-20T06:51:27.292Z" |
string |
description 可选 |
description 样例 : "file description" |
string |
domain_id 可选 |
domain_id 模式 : "[a-z0-9A-Z]+" 样例 : "test001" |
string |
download_url 可选 |
download_url 样例 : "https://ccp.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx" |
string |
drive_id 可选 |
drive_id 模式 : "[0-9]+" 样例 : "1" |
string |
file_extension 可选 |
file_extension 样例 : "jpg" |
string |
file_path 可选 |
file_path 样例 : "/a.jpg" |
string |
name 必填 |
name 模式 : "[a-zA-Z0-9.-]{1,1024}" 样例 : "ccp.jpg" |
string |
parent_file_path 可选 |
parent_file_id 长度 : 40 - 50 模式 : "[a-z0-9]{1, 50}" 样例 : "/" |
string |
share_id 可选 |
share_id 模式 : "[0-9]+" 样例 : "5d5b846942cf94fa72324c14a4bda34e81da635d" |
string |
size 可选 |
Size 最小值 : 0 最大值 : 53687091200 样例 : 1024 |
integer (int64) |
status 可选 |
status 样例 : "available" |
enum (uploading, available) |
thumbnail 可选 |
thumbnail 样例 : "https://ccp.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx" |
string |
trashed_at 可选 |
trashed_at 样例 : "string" |
string (date-time) |
type 可选 |
type 样例 : "file" |
enum (file, folder) |
updated_at 可选 |
updated_at 样例 : "string" |
string (date-time) |
upload_id 可选 |
upload_id 样例 : "C9DCFE5A82644AC7A02DB74C30C934A6" |
string |
url 可选 |
url 样例 : "https://ccp.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx" |
string |
OSSCopyFileResponse
文件拷贝 response
名称 | 说明 | 类型 |
---|---|---|
async_task_id 可选 |
async_task_id 样例 : "000e89fb-cf8f-11e9-8ab4-b6e980803a3b" |
string |
domain_id 可选 |
domain_id 模式 : "[a-z0-9A-Z-]+" 样例 : "test001" |
string |
drive_id 可选 |
drive_id 模式 : "[0-9]+" 样例 : "1" |
string |
file_path 可选 |
file_path 样例 : "/a/b/c.jpg" |
string |
share_id 可选 |
drive_id 模式 : "[a-z0-9A-Z]+" 样例 : "test001" |
string |
OSSCreateFileResponse
Create file response
名称 | 说明 | 类型 |
---|---|---|
domain_id 可选 |
domain_id 长度 : 40 - 50 模式 : "[a-z0-9]{1, 50}" 样例 : "domain" |
string |
drive_id 可选 |
drive_id 模式 : "[0-9]+" 样例 : "1" |
string |
file_path 可选 |
file_path 样例 : "/a/b/c.jpg" |
string |
part_info_list 可选 |
part_info_list 样例 : "[" |
< UploadPartInfo > array |
share_id 可选 |
share_id 模式 : "[0-9]+" 样例 : "1" |
string |
type 可选 |
type 样例 : "file" |
enum (file, folder) |
upload_id 可选 |
upload_id 样例 : "C9DCFE5A82644AC7A02DB74C30C934A6" |
string |
OSSDeleteFileResponse
删除文件 response
名称 | 说明 | 类型 |
---|---|---|
async_task_id 可选 |
async_task_id 样例 : "000e89fb-cf8f-11e9-8ab4-b6e980803a3b" |
string |
domain_id 可选 |
domain_id 模式 : "[a-z0-9A-Z]+" 样例 : "test001" |
string |
drive_id 可选 |
drive_id 模式 : "[0-9]+" 样例 : "1" |
string |
file_path 可选 |
file_path 样例 : "/a/b/c.jpg" |
string |
share_id 可选 |
share_id 模式 : "[a-z0-9A-Z]+" 样例 : "5d5b846942cf94fa72324c14a4bda34e81da635d" |
string |
OSSDeleteFilesResponse
批量删除文件 response
名称 | 说明 | 类型 |
---|---|---|
deleted_file_id_list 可选 |
deleted_file_id_list 样例 : [ ] |
< string > array |
domain_id 可选 |
domain_id 模式 : "[a-z0-9A-Z]+" 样例 : "test001" |
string |
drive_id 可选 |
drive_id 模式 : "[0-9]+" 样例 : "1" |
string |
share_id 可选 |
share_id 模式 : "[0-9]+" 样例 : "1" |
string |
OSSGetDownloadUrlResponse
获取download url response
名称 | 说明 | 类型 |
---|---|---|
expiration 可选 |
expiration 样例 : "2006-01-02T15:04:05.999Z07:00" |
string |
method 可选 |
method 样例 : "GET" |
string |
url 可选 |
url 样例 : "https://ccp.data.aliyuncs.com/hz22%2F5d79219b0aa9a7c995a94a96993ba3205cd91c5a%2F5d79219bf3261a5d38744da0834ed489b677a27a?Expires=xxxOSSAccessKeyId=xxx&Signature=xxx&response-content-disposition=attachment%3Bfilename%3DtBiZAoJPC2c8b13450eda4292b7f5f8010618e078.txt" |
string |
OSSGetFileResponse
获取文件元数据response
多态性 : 成分
名称 | 说明 | 类型 |
---|---|---|
content_hash 可选 |
Content Hash 样例 : "EA4942AA8761213890A5C386F88E6464D2C31CA3" |
string |
content_hash_name 可选 |
content_hash_name 样例 : "sha1" |
enum (sha1) |
content_type 可选 |
content_type 样例 : "application/json" |
string |
crc64_hash 可选 |
crc64_hash 样例 : "string" |
string |
created_at 可选 |
created_at 样例 : "2019-08-20T06:51:27.292Z" |
string |
description 可选 |
description 样例 : "file description" |
string |
domain_id 可选 |
domain_id 模式 : "[a-z0-9A-Z]+" 样例 : "test001" |
string |
download_url 可选 |
download_url 样例 : "https://ccp.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx" |
string |
drive_id 可选 |
drive_id 模式 : "[0-9]+" 样例 : "1" |
string |
file_extension 可选 |
file_extension 样例 : "jpg" |
string |
file_path 可选 |
file_path 样例 : "/a.jpg" |
string |
name 必填 |
name 模式 : "[a-zA-Z0-9.-]{1,1024}" 样例 : "ccp.jpg" |
string |
parent_file_path 可选 |
parent_file_id 长度 : 40 - 50 模式 : "[a-z0-9]{1, 50}" 样例 : "/" |
string |
share_id 可选 |
share_id 模式 : "[0-9]+" 样例 : "5d5b846942cf94fa72324c14a4bda34e81da635d" |
string |
size 可选 |
Size 最小值 : 0 最大值 : 53687091200 样例 : 1024 |
integer (int64) |
status 可选 |
status 样例 : "available" |
enum (uploading, available) |
thumbnail 可选 |
thumbnail 样例 : "https://ccp.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx" |
string |
trashed_at 可选 |
trashed_at 样例 : "string" |
string (date-time) |
type 可选 |
type 样例 : "file" |
enum (file, folder) |
updated_at 可选 |
updated_at 样例 : "string" |
string (date-time) |
upload_id 可选 |
upload_id 样例 : "C9DCFE5A82644AC7A02DB74C30C934A6" |
string |
url 可选 |
url 样例 : "https://ccp.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx" |
string |
OSSGetUploadUrlResponse
Get UploadUrl Response
名称 | 说明 | 类型 |
---|---|---|
create_at 可选 |
created_at 样例 : "2019-09-11T16:34:36.977Z" |
string |
domain_id 可选 |
domain_id 模式 : "[a-z0-9A-Z]+" 样例 : "test001" |
string |
drive_id 可选 |
drive_id 模式 : "[0-9]+" 样例 : "1" |
string |
file_path 可选 |
file_path 样例 : "/a/b/c.jpg" |
string |
part_info_list 可选 |
part_info_list 样例 : [ ] |
< UploadPartInfo > array |
upload_id 可选 |
upload_id 样例 : "F3C25CDFA5C74ECB8DE32672F6211FD4" |
string |
OSSListFileResponse
List file response
名称 | 说明 | 类型 |
---|---|---|
items 可选 |
items 样例 : [ ] |
< BaseOSSFileResponse > array |
next_marker 可选 |
next_marker 样例 : "NWQ1YmI4MjA0ZGU1ZWNjYzAzODM0ZDVkODlkMWJiMzcyNzM1NTU4OA" |
string |
OSSListUploadedPartResponse
获取签名 response
名称 | 说明 | 类型 |
---|---|---|
file_path 可选 |
file_path 样例 : "/a/b/c.jpg" |
string |
next_part_number_marker 可选 |
next_part_number_marker 样例 : "4" |
string |
upload_id 可选 |
upload_id 样例 : "F3C25CDFA5C74ECB8DE32672F6211FD4" |
string |
uploaded_parts 可选 |
uploaded_parts 样例 : [ ] |
< UploadPartInfo > array |
OSSMoveFileResponse
文件移动 response
名称 | 说明 | 类型 |
---|---|---|
async_task_id 可选 |
async_task_id 样例 : "000e89fb-cf8f-11e9-8ab4-b6e980803a3b" |
string |
domain_id 可选 |
domain_id 模式 : "[a-z0-9A-Z-]+" 样例 : "test001" |
string |
drive_id 可选 |
drive_id 模式 : "[0-9]+" 样例 : "1" |
string |
file_path 可选 |
file_path 样例 : "/a/b/c.jpg" |
string |
share_id 可选 |
drive_id 模式 : "[a-z0-9A-Z]+" 样例 : "test001" |
string |
OSSSearchFileResponse
search file response
名称 | 说明 | 类型 |
---|---|---|
items 可选 |
items 样例 : [ ] |
< BaseOSSFileResponse > array |
next_marker 可选 |
next_marker 样例 : "NWQ1YmI4MjA0ZGU1ZWNjYzAzODM0ZDVkODlkMWJiMzcyNzM1NTU4OA" |
string |
OSSUpdateFileMetaResponse
更新文件元数据 response
多态性 : 成分
名称 | 说明 | 类型 |
---|---|---|
content_hash 可选 |
Content Hash 样例 : "EA4942AA8761213890A5C386F88E6464D2C31CA3" |
string |
content_hash_name 可选 |
content_hash_name 样例 : "sha1" |
enum (sha1) |
content_type 可选 |
content_type 样例 : "application/json" |
string |
crc64_hash 可选 |
crc64_hash 样例 : "string" |
string |
created_at 可选 |
created_at 样例 : "2019-08-20T06:51:27.292Z" |
string |
description 可选 |
description 样例 : "file description" |
string |
domain_id 可选 |
domain_id 模式 : "[a-z0-9A-Z]+" 样例 : "test001" |
string |
download_url 可选 |
download_url 样例 : "https://ccp.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx" |
string |
drive_id 可选 |
drive_id 模式 : "[0-9]+" 样例 : "1" |
string |
file_extension 可选 |
file_extension 样例 : "jpg" |
string |
file_path 可选 |
file_path 样例 : "/a.jpg" |
string |
name 必填 |
name 模式 : "[a-zA-Z0-9.-]{1,1024}" 样例 : "ccp.jpg" |
string |
parent_file_path 可选 |
parent_file_id 长度 : 40 - 50 模式 : "[a-z0-9]{1, 50}" 样例 : "/" |
string |
share_id 可选 |
share_id 模式 : "[0-9]+" 样例 : "5d5b846942cf94fa72324c14a4bda34e81da635d" |
string |
size 可选 |
Size 最小值 : 0 最大值 : 53687091200 样例 : 1024 |
integer (int64) |
status 可选 |
status 样例 : "available" |
enum (uploading, available) |
thumbnail 可选 |
thumbnail 样例 : "https://ccp.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx" |
string |
trashed_at 可选 |
trashed_at 样例 : "string" |
string (date-time) |
type 可选 |
type 样例 : "file" |
enum (file, folder) |
updated_at 可选 |
updated_at 样例 : "string" |
string (date-time) |
upload_id 可选 |
upload_id 样例 : "C9DCFE5A82644AC7A02DB74C30C934A6" |
string |
url 可选 |
url 样例 : "https://ccp.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx" |
string |
PasswordTooSimpleError
PasswordTooSimpleError 密码太简单
名称 | 说明 | 类型 |
---|---|---|
code 必填 |
样例 : "PasswordTooSimple" |
string |
message 必填 |
样例 : "Password is too simple." |
string |
PreHashCheckSuccessResponse
Pre hash check Response
名称 | 说明 | 类型 |
---|---|---|
code 可选 |
code 样例 : "string" |
string |
file_name 可选 |
file_name 样例 : "string" |
string |
message 可选 |
message 样例 : "string" |
string |
parent_file_id 必填 |
parent_file_id 长度 : 40 - 50 模式 : "[a-z0-9]{1, 50}" 样例 : "5d5b846942cf94fa72324c14a4bda34e81da635d" |
string |
pre_hash 可选 |
pre_hash 样例 : "string" |
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 |
RemoveStoreRequest
名称 | 说明 | 类型 |
---|---|---|
domain_id 必填 |
domain ID 样例 : "sz100" |
string |
store_id 必填 |
store ID 样例 : "cdjaksbwuiqbxuiassd" |
string |
ServiceUnavailableError
ServiceUnavailableError 服务不可用错误
名称 | 说明 | 类型 |
---|---|---|
code 必填 |
样例 : "ServiceUnavailable" |
string |
message 必填 |
样例 : "The request has failed due to a temporary failure of the server." |
string |
SetStoreCorsRequest
名称 | 说明 | 类型 |
---|---|---|
cors_rule 必填 |
样例 : "[corsrule](#corsrule)" |
CorsRule |
domain_id 必填 |
domain ID 样例 : "sz100" |
string |
store_id 必填 |
store ID 样例 : "cdjaksbwuiqbxuiassd" |
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 |
StoreFile
名称 | 说明 | 类型 |
---|---|---|
domain_id 可选 |
样例 : "string" |
string |
name 可选 |
样例 : "string" |
string |
parent_file_path 可选 |
样例 : "string" |
string |
store_id 可选 |
样例 : "string" |
string |
type 可选 |
样例 : "string" |
string |
StoreItemResponse
名称 | 说明 | 类型 |
---|---|---|
accelerate_endpoint 可选 |
全球加速域名 样例 : "https://oss-cn-shenzhen.aliyuncs.com/" |
string |
base_path 可选 |
存储公共前缀 样例 : "ccp-data" |
string |
bucket 必填 |
bucket名称 样例 : "data-sz-bucket" |
string |
customized_endpoint 可选 |
用户自定义绑定存储地址 样例 : "https://oss-cn-shenzhen.aliyuncs.com/" |
string |
domain_id 可选 |
样例 : "string" |
string |
endpoint 必填 |
存储访问地址 样例 : "https://oss-cn-shenzhen.aliyuncs.com/" |
string |
internal_endpoint 可选 |
内网存储地址 样例 : "https://oss-cn-shenzhen.aliyuncs.com/" |
string |
ownership 必填 |
存储归属,system表示系统提供,custom表示使用自己的存储 样例 : "system" |
enum (system, custom) |
policy 必填 |
Policy授权,system类型store会将bucket权限授予当前云账号 样例 : "string" |
string |
role_arn 可选 |
访问Bucket的角色ARN 样例 : "acs:oss:*:*:*" |
string |
store_id 必填 |
store ID 样例 : "cdjaksbwuiqbxuiassd" |
string |
type 必填 |
存储类型,当前只支持oss 样例 : "oss" |
enum (oss) |
ThrottlingError
ThrottlingError 操作被流控错误
名称 | 说明 | 类型 |
---|---|---|
code 必填 |
样例 : "Throttling" |
string |
message 必填 |
样例 : "The operation is blocked due to throttling control." |
string |
TokenRequest
名称 | 说明 | 类型 |
---|---|---|
app_id 必填 |
App ID, 当前访问的App 样例 : "csaklidwasdhjwid" |
string |
grant_type 必填 |
只能填refresh_token 样例 : "refresh_token" |
string |
refresh_token 必填 |
refresh token, 登录时返回的 样例 : "ybb3WJy2CwXHoM6hBcydGlvzMoJkFpkk" |
string |
UpdateAppRequest
名称 | 说明 | 类型 |
---|---|---|
app_id 必填 |
App ID 样例 : "CNMrhxwPJHAReExa" |
string |
app_name 必填 |
App名称 长度 : 1 - 128 模式 : "[0-9a-zA-Z]+" 样例 : "图片分享应用" |
string |
description 可选 |
App描述 长度 : 0 - 128 样例 : "测试专用" |
string |
is_third_party 必填 |
是否是domain私有App 样例 : false |
boolean |
logo 必填 |
App图标 样例 : "https://app.com/logo.jpg" |
string |
redirect_uri 必填 |
App回调地址 样例 : "https://app.com/callback" |
string |
scope 必填 |
App权限列表 样例 : [ "string" ] |
< string > array |
type 必填 |
App类型 默认值 : "WebServer" 样例 : "WebServer" |
enum (WebServer, WebBrowser, Native) |
UpdateDomainRequest
update domain request
名称 | 说明 | 类型 |
---|---|---|
auth_alipay_app_id 可选 |
支付宝 App Id 样例 : "abc" |
string |
auth_alipay_enbale 可选 |
启用支付宝认证 样例 : true |
boolean |
auth_alipay_private_key 可选 |
支付宝 App Secret 样例 : "abc" |
string |
auth_config 可选 |
样例 : {<br> "string" : "[authconfig](#authconfig)"<br>} |
< string, AuthConfig > map |
auth_dingding_app_id 可选 |
钉钉 App Id 样例 : "abc" |
string |
auth_dingding_app_secret 可选 |
钉钉 App Secret 样例 : "abc" |
string |
auth_dingding_enable 可选 |
启用钉钉认证 样例 : true |
boolean |
auth_endpoint_enable 可选 |
样例 : true |
boolean |
auth_ram_app_id 可选 |
RAM App Id 样例 : "abc" |
string |
auth_ram_app_secret 可选 |
RAM App Secret 样例 : "abc" |
string |
auth_ram_enable 可选 |
启用 RAM 认证 样例 : true |
boolean |
data_hash_name 可选 |
数据 Hash 算法 样例 : "sha1" |
string |
description 可选 |
Domain 描述 样例 : "my test domain" |
string |
domain_id 必填 |
Domain ID 样例 : "sz111" |
string |
domain_name 可选 |
Domain 名称 样例 : "test_domain" |
string |
event_filename_matches 可选 |
事件通知 MNS 匹配文件名 样例 : "abc" |
string |
event_mns_endpoint 可选 |
事件通知 MNS Endpoint 样例 : "http://abc.mns.cn-shenzhen.aliyuncs.com" |
string |
event_mns_topic 可选 |
事件通知 MNS Topic 样例 : "abc" |
string |
event_names 可选 |
事件名列表 样例 : [ "abc" ] |
< string > array |
event_role_arn 可选 |
事件通知 Role Arn 样例 : "string" |
string |
init_drive_enable 可选 |
开启自动初始化 Drive 样例 : true |
boolean |
init_drive_size 可选 |
自动初始化 Drive 大小 样例 : 1024 |
integer (int64) |
init_drive_store_id 可选 |
自动初始化 Drive 使用 Store ID 样例 : "1" |
string |
published_app_access_strategy 可选 |
样例 : "[appaccessstrategy](#appaccessstrategy)" |
AppAccessStrategy |
sharable 可选 |
开启分享 样例 : true |
boolean |
UpdateDriveResponse
Update drive response
名称 | 说明 | 类型 |
---|---|---|
creator 可选 |
Drive 创建者 样例 : "ccp" |
string |
description 可选 |
Drive 备注信息 样例 : "ccp team drive" |
string |
domain_id 可选 |
Domain ID 样例 : "hz999" |
string |
drive_id 可选 |
Drive ID 样例 : "123" |
string |
drive_name 可选 |
Drive 名称 样例 : "ccpdrive" |
string |
drive_type 可选 |
Drive 类型 样例 : "normal" |
string |
owner 可选 |
Drive 所有者 样例 : "ccp" |
string |
relative_path 可选 |
Drive存储基于store的相对路径,domain的PathType为OSSPath时返回 样例 : "/a/b/e/" |
string |
status 可选 |
Drive 状态 样例 : "enabled" |
string |
store_id 可选 |
存储 ID, domain的PathType为OSSPath时返回 样例 : "123" |
string |
total_size 可选 |
Drive 空间总量 样例 : 102400 |
integer (int64) |
used_size 可选 |
Drive 空间已使用量 样例 : 1024 |
integer (int64) |
UpdateShareResponse
Update share response
名称 | 说明 | 类型 |
---|---|---|
created_at 可选 |
created_at 样例 : "2006-01-02T15:04:05.999Z" |
string |
creator 可选 |
creator 样例 : "xxx" |
string |
description 可选 |
description 样例 : "share description" |
string |
domain_id 可选 |
domain_id 样例 : "domain-1" |
string |
drive_id 可选 |
drive_id 样例 : "1" |
string |
expiration 可选 |
expiration 样例 : "2006-01-02T15:04:05.999Z" |
string |
expired 可选 |
expired 样例 : false |
boolean |
owner 可选 |
owner 样例 : "xxx" |
string |
permissions 可选 |
permissions 样例 : [ ] |
< string > array |
share_file_path 可选 |
share_path 样例 : "/a/b/c/" |
string |
share_id 可选 |
share_id 样例 : "3d336314-63c8-4d96-bce0-17aefb6833b6" |
string |
share_name 可选 |
share_name 样例 : "new_share" |
string |
status 可选 |
status 样例 : "enabled" |
string |
updated_at 可选 |
updated_at 样例 : "2006-01-02T15:04:05.999Z" |
string |
UploadPartInfo
名称 | 说明 | 类型 |
---|---|---|
etag 可选 |
etag 样例 : "0CC175B9C0F1B6A831C399E269772661" |
string |
part_number 可选 |
PartNumber 最小值 : 10000 最大值 : 1 样例 : 1 |
integer (int64) |
part_size 可选 |
PartSize: 最小值 : 102400 最大值 : 5368709120 样例 : 1024 |
integer (int64) |
upload_url 可选 |
upload_url 样例 : "https://ccp.data.aliyuncs.com/xxx/xxx?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx&partNumber=1&uploadId=0CC175B9C0F1B6A831C399E269772661" |
string |
UserAuthentication
名称 | 说明 | 类型 |
---|---|---|
AuthenticationType 必填 |
认证类型 样例 : "mobile" |
string |
CreatedAt 必填 |
创建时间 样例 : 1556163159820 |
integer (int64) |
Detail 必填 |
详情 样例 : "{name:abc}" |
string |
DomainID 必填 |
Domain ID 样例 : "5000" |
string |
Identity 必填 |
唯一身份标识 样例 : "15208345000" |
string |
LastLoginTime 必填 |
最后登录时间 样例 : 1556163159820 |
integer (int64) |
Status 必填 |
状态 样例 : "normal" |
string |
UserID 必填 |
用户ID 样例 : "00016a587b62b50003deea299a4f5b50" |
string |
版权声明
本文仅代表作者观点,不代表本站立场。
本文系作者授权发表,未经许可,不得转载。
评论