数字资产管理
提供a参考
最新更新:Jan-18-2024
提供API访问账号可创建并管理产品环境,用户名并用户群REST提供API使用
云端SDKsRESTAPIs打包处理认证并使用优先编程语言或框架实现这些方法参考提供SDK和REST/CURL语法并举各种端点法实例
子账户端点、参数、响应键等
概述
默认a端点使用下列格式:
https://api.www.agrosoland.com/v1_1/provisioning/accounts/:account_id/:action
例举用ID获取账户中所有产品环境16a8ff3b-736b-49a6-85c0-03b69d5a357b:
API使用基础认证HTTPS对接云语账号ID,提供密钥并提供保密用于验证 。身份证存放在云控制台设置>帐户提供API访问或从提供环境变量获取机牌板形式化CLOUDINARY_ACCOUNT_URL=account://
)和所有配置参数中,您或设置全局值或随叫随到传递值
实验返回用户列表PROVISIONING_KEY,PROVISIONING_SECRET并OCOUNTIDCURL命令中
多数动作请求参数由JSON对象传递,响应为JSON片段响应中包括关于所执行行为的信息以及任何新相关数据请求获取所有产品环境响应
下节补充提供API工作细节
SDKs提供API
除基础RESTAPI外,客户库为提供API提供易用打包程序请求构建认证自动完成 JSON响应解析并返回
avaSDK方法获取一列表带名称启动程序的产品环境
错误处理
API使用HTTP状态代码返回状态
- 二百- 好成功
- 400坏请求
- 401授权需要
- 403不允许
- 404- 未发现
- 409已经存在
- 420最大使用率超出
ACI包存云端库报告错误并发回JSON回复信息例举 :
访问键
管理访问密钥,包括API密钥和秘密配对,用于产品环境(子账户):
| 方法论 | 描述性 |
|---|---|
获取/accounts/:account_id/sub_accounts/:sub_account_id/access_keys |
获取访问密钥 |
Post应用/accounts/:account_id/sub_accounts/:sub_account_id/access_keys |
生成访问密钥 |
PUT系统/accounts/:account_id/sub_accounts/:sub_account_id/access_keys/:key |
更新访问密钥 |
PUT系统/accounts/:account_id/sub_accounts/:sub_account_id/access_keys/:key |
更新访问密钥 |
开发者/accounts/:account_id/sub_accounts/:sub_account_id/access_keys/:key |
API删除存取密钥 |
开发者/accounts/:account_id/sub_accounts/:sub_account_id/access_keys?name=
|
逐名删除存取密钥 |
获取访问密钥
返回数组特定产品环境所有访问密钥
语法
GET /accounts/:account_id/sub_accounts/:sub_account_id/access_keys
可选参数
| 参数 | 类型 | 描述性 |
|---|---|---|
| 页面大小 | 整数 | 页面上多列显示 |
| 页 | 整数 | 哪一页返回(最大页数:100)默认:所有页面都返回 |
| 逐项排序 | 字符串 | 哪个响应参数排序可能的值:api_key,创建_at,名称,开机. |
| 排序顺序 | 字符串 | 控制返回密钥顺序可能的值:德克族(默认),烟雾. |
| 选项 | 对象类 | 看吧配置参数. |
实例
取回产品环境存取密钥,按创建日期排序依次向上排序(最老密钥优先)。
样本响应
生成访问密钥
生成新访问密钥
语法
POST /accounts/:account_id/sub_accounts/:sub_account_id/access_keys
可选参数
| 参数 | 类型 | 描述性 |
|---|---|---|
| 名称 | 字符串 | 新访问密钥名 |
| 开机 | 布尔 | 新建访问密钥启动或禁用 |
| 选项 | 对象类 | 看吧配置参数. |
实例
生成子账户存取密钥aksdvnklsR1234890调用主键.
样本响应
更新访问密钥
更新现有访问密钥的名称和/或状态
语法
PUT /accounts/:account_id/sub_accounts/:sub_account_id/access_keys/:key
可选参数
| 参数 | 类型 | 描述性 |
|---|---|---|
| 名称 | 字符串 | 更新访问密钥名 |
| 开机 | 布尔 | 启动或禁用访问密钥 |
| 专用_for | 字符串 | 指定访问密钥用于特定目的,同时允许它用于其他目的替换先前指定的密钥可能的值:webhoks网路 |
| 选项 | 对象类 | 看吧配置参数. |
实例
禁用并重命名子账户存取密钥aksdvnklsR1234890,他们的API密钥41884184, to二级键.
样本响应
API删除存取密钥
从产品环境删除存取密钥并指定API密钥无法再使用删除键访问产品环境无法撤销此动作
- 唯一活动产品环境
- 专用于签名 webhook通知需要用不同的专用访问密钥替换 webhook签名更新删除前方法
语法
DELETE /accounts/:account_id/sub_accounts/:sub_account_id/access_keys/:key
实例
删除访问键API41884184:
样本响应
逐名删除存取密钥
删除从产品环境带指定名称访问密钥无法再使用删除键访问产品环境无法撤销此动作
- 唯一活动产品环境
- 专用于签名 webhook通知需要用不同的专用访问密钥替换 webhook签名更新删除前方法
语法
DELETE /accounts/:account_id/sub_accounts/:sub_account_id/access_keys?name=
实例
删除访问密钥命名二级键:
样本响应
子账户(产品环境)
管理主帐户的产品环境(子账户):
| 方法论 | 描述性 |
|---|---|
获取/accounts/:account_id/sub_accounts |
获取产品环境 |
获取/accounts/:account_id/sub_accounts/:sub_account_id |
获取产品环境 |
Post应用/accounts/:account_id/sub_accounts |
创建产品环境 |
PUT系统/accounts/:account_id/sub_accounts/:sub_account_id |
更新产品环境 |
开发者/accounts/:account_id/sub_accounts/:sub_account_id |
删除产品环境 |
获取产品环境
返回数组所有产品环境或条件说明返回相关产品环境
语法
GET /accounts/:account_id/sub_accounts
可选参数
| 参数 | 类型 | 描述性 |
|---|---|---|
| 开机 | 布尔 | 是否只返回赋能产品环境(真)或残疾产品环境(假)。默认:所有产品环境返回 |
| 标识符 | 数组字符串 | 列表(SDK打包数组)最多达100个产品环境标识提供时忽略其他参数 |
| 前缀 | 字符串 | 返回账号,名称从指定的不区分案例字符串开始 |
| 选项 | 对象类 | 看吧配置参数. |
实例
返回所有赋值产品环境
样本响应
获取产品环境
返回指定产品环境
语法
GET /accounts/:account_id/sub_accounts/:sub_account_id
所需参数
| 参数 | 类型 | 描述性 |
|---|---|---|
| 子账户i | 字符串 | 产品环境标识 |
可选参数
| 参数 | 类型 | 描述性 |
|---|---|---|
| 选项 | 对象类 | 看吧配置参数. |
实例
返回产品环境id '7f8f1f910bf1f2527aef11d27'
样本响应
创建产品环境
创建新产品环境访问所有产品环境的用户也将自动访问新产品环境
语法
POST /accounts/:account_id/sub_accounts
所需参数
| 参数 | 类型 | 描述性 |
|---|---|---|
| 名称 | 字符串 | 显示名显示云控制台 |
可选参数
| 参数 | 类型 | 描述性 |
|---|---|---|
| 云名 | 字符串 | 由2-128字母数字符和连字符组成不敏感字符串,从字母开始注意云名必须独特遍历云存错误返回,如果请求名已经存在默认单字符串自动生成 |
| base_sub_account_id | 字符串 | 另一种产品环境标识符,从中复制所有下列设置:尺寸限值、定时限值和标志参数调用基数记账中SDKs |
| custom_attributes | 对象类 | 任意定制属性都想与产品环境关联,即按键/值对映射/抓取 |
| 选项 | 对象类 | 看吧配置参数. |
实例
创建新产品环境称'demo账号'
样本响应
更新产品环境
更新产品环境指定细节
语法
PUT /accounts/:account_id/sub_accounts/:sub_account_id
所需参数
| 参数 | 类型 | 描述性 |
|---|---|---|
| 子账户i | 字符串 | 产品环境标识更新 |
可选参数
| 参数 | 类型 | 描述性 |
|---|---|---|
| 名称 | 字符串 | 显示名显示云控制台 |
| 云名 | 字符串 | 容错云名由2-128字母数字符和连字符组成,从字母开始注意云名必须独特遍历云存错误返回,如果请求名已经存在注解:只能对小于1000图象的账户修改 |
| custom_attributes | 对象类 | 任意定制属性都想与产品环境关联,即按键/值对映射/抓取 |
| 开机 | 布尔 | 产品环境是否启动默认:真实性 |
| 选项 | 对象类 | 看吧配置参数. |
实例
7f08f1f9c10bf1f2527ef11d27
样本响应
删除产品环境
删除指定的产品环境仅支持小于1000图像的账户
语法
DELETE /accounts/:account_id/sub_accounts/:sub_account_id
所需参数
| 参数 | 类型 | 描述性 |
|---|---|---|
| 子账户i | 字符串 | 产品环境标识删除 |
可选参数
| 参数 | 类型 | 描述性 |
|---|---|---|
| 选项 | 对象类 | 看吧配置参数. |
实例
删除产品环境id7f08f1f9c10bf1f27
样本响应
用户名
管理用户账号
| 方法论 | 描述性 |
|---|---|
获取/accounts/:account_id/users |
获取用户 |
获取/accounts/:account_id/users/:user_id |
获取用户 |
Post应用/accounts/:account_id/users |
创建用户 |
PUT系统/accounts/:account_id/users/:user_id |
更新用户 |
开发者/accounts/:account_id/users/:user_id |
删除用户 |
获取用户
返回帐户中所有用户数组,或如果条件指定,返回相关用户
语法
GET /accounts/:account_id/users
可选参数
| 参数 | 类型 | 描述性 |
|---|---|---|
| 等待处理 | 布尔 | 是否只返回待处理用户默认:虚伪(所有用户) |
| 标识符 | 数组字符串 | 列表(sdks打包数组)达100用户标识提供时忽略其他参数 |
| 前缀 | 字符串 | 返回用户名从指定的不区分案例字符串开始 |
| 子账户i | 字符串 | 仅返回访问指定账户的用户 |
| 选项 | 对象类 | 看吧配置参数. |
| 上龙 | 布尔 | 指定最后登录日期范围 |
| 发自 | 字符串 | 自此日期后所有最后一次登录均以yyy-m-dd格式提供 |
| 至 | 字符串 | 日期前所有最后一次登录均以yy-m-dd格式提供 |
| 联盟类型 | 字符串 | 是否返回用户谁上登录 规定日期范围内内含或那些未在范围内登陆者排除)可能的值:内含,排除默认:内含 |
实例
返回所有用户并命名为john
样本响应
获取用户
返回用户带指定的ID
语法
GET /accounts/:account_id/users/:user_id
所需参数
| 参数 | 类型 | 描述性 |
|---|---|---|
| 用户标识 | 字符串 | 用户名获取 |
可选参数
| 参数 | 类型 | 描述性 |
|---|---|---|
| 选项 | 对象类 | 看吧配置参数. |
实例
返回用户id7f08f1f910bf1
样本响应
创建用户
新建开机用户等待处理.
语法
POST /accounts/:account_id/users
所需参数
| 参数 | 类型 | 描述性 |
|---|---|---|
| 名称 | 字符串 | 用户名 |
| 邮箱 | 字符串 | 独有邮箱地址 即登录名通知地址 |
| 角色识别 | 字符串 | 角色分配可能的值:大师admin,管理员,计费,技术admin,报表整理,media_library_admin,media_library_user |
可选参数
| 参数 | 类型 | 描述性 |
|---|---|---|
| 子账户_ids | 数组字符串 | 逗号分隔列表(SDK打包成数组)产品环境标识符,用户可访问注解:如果角色指定为大师admin.默认:所有产品环境 |
| 开机 | 布尔 | 用户是否启动 。默认:真实性 |
| 选项 | 对象类 | 看吧配置参数. |
实例
新建用户名为'John',并发电子邮件地址为'john@example.com'和作用为'Technology_admin'
样本响应
更新用户
更新指定用户细节
语法
PUT /accounts/:account_id/sub_accounts/:user_id
所需参数
| 参数 | 类型 | 描述性 |
|---|---|---|
| 用户标识 | 字符串 | 用户标识更新 |
可选参数
| 参数 | 类型 | 描述性 |
|---|---|---|
| 名称 | 字符串 | 用户名 |
| 邮箱 | 字符串 | 独有邮箱地址 即登录名通知地址 |
| 角色识别 | 字符串 | 角色分配可能的值:大师admin,管理员,计费,技术admin,报表整理,media_library_admin,media_library_user |
| 子账户_ids | 字符串 | 逗号分隔列表(SDK打包成数组)产品环境标识符,用户可访问注解:如果角色指定为大师admin. |
| 开机 | 布尔 | 用户是否启动 。 |
| 选项 | 对象类 | 看吧配置参数. |
实例
更新用户作用id7f08f1f9c10bf1f25274aef11d27
样本响应
删除用户
删除带指定ID的用户
语法
DELETE /accounts/:account_id/users/:user_id
所需参数
| 参数 | 类型 | 描述性 |
|---|---|---|
| 用户标识 | 字符串 | 用户标识删除 |
可选参数
| 参数 | 类型 | 描述性 |
|---|---|---|
| 选项 | 对象类 | 看吧配置参数. |
实例
删除用户id7f08f1f910bf1
样本响应
用户群
管理分组用户账号
| 方法论 | 描述性 |
|---|---|
获取/accounts/:account_id/user_groups |
获取用户群 |
获取/accounts/:account_id/user_groups/:group_id |
获取用户群 |
获取/accounts/:account_id/user_groups/:group_id/users |
获取用户群 |
Post应用/accounts/:account_id/user_groups |
创建用户群 |
Post应用/accounts/:account_id/user_groups/:group_id/users/:user_id |
添加用户分组 |
PUT系统/accounts/:account_id/user_groups/:group_id |
更新用户群 |
开发者/accounts/:account_id/user_groups/:group_id |
删除用户群 |
开发者/accounts/:account_id/user_groups/:group_id/users/:user_id |
从组清除用户 |
获取用户群
返回账户中所有用户群数组
语法
GET /accounts/:account_id/user_groups
可选参数
| 参数 | 类型 | 描述性 |
|---|---|---|
| 选项 | 对象类 | 看吧配置参数. |
实例
返回所有用户群 :
样本响应
获取用户群
返回用户组带指定的ID
语法
GET /accounts/:account_id/user_groups/:group_id
所需参数
| 参数 | 类型 | 描述性 |
|---|---|---|
| group_id | 字符串 | 用户群标识 |
可选参数
| 参数 | 类型 | 描述性 |
|---|---|---|
| 选项 | 对象类 | 看吧配置参数. |
实例
返回用户群id7f08f1f910bf1f27
样本响应
获取用户群用户
返回组内用户并带指定的ID
语法
GET /accounts/:account_id/user_groups/:group_id/users
所需参数
| 参数 | 类型 | 描述性 |
|---|---|---|
| group_id | 字符串 | 用户群标识 |
可选参数
| 参数 | 类型 | 描述性 |
|---|---|---|
| 选项 | 对象类 | 看吧配置参数. |
实例
返回用户群id7f08f1f9c910bf1f25272aef11d27
样本响应
创建用户群
新建用户群账户
语法
POST /accounts/:account_id/user_groups
所需参数
| 参数 | 类型 | 描述性 |
|---|---|---|
| 名称 | 字符串 | 用户群名 |
可选参数
| 参数 | 类型 | 描述性 |
|---|---|---|
| 选项 | 对象类 | 看吧配置参数. |
实例
新建用户群命名为Designers
样本响应
添加用户分组
向组添加用户带指定的ID
语法
POST /accounts/:account_id/user_groups/:group_id/users/:user_id
所需参数
| 参数 | 类型 | 描述性 |
|---|---|---|
| group_id | 字符串 | 用户群标识 |
| 用户标识 | 字符串 | 用户标识符 |
可选参数
| 参数 | 类型 | 描述性 |
|---|---|---|
| 选项 | 对象类 | 看吧配置参数. |
实例
用户id '230df1d1f913bf335e74a1f41e25'添加到组id'7f08f1f1f9c910bf1f2527'
样本响应
更新用户群
更新用户群名
语法
PUT /accounts/:account_id/user_groups/:group_id
所需参数
| 参数 | 类型 | 描述性 |
|---|---|---|
| group_id | 字符串 | 用户群标识更新 |
| 名称 | 字符串 | 用户群名 |
可选参数
| 参数 | 类型 | 描述性 |
|---|---|---|
| 选项 | 对象类 | 看吧配置参数. |
实例
7f08f1f9c10bf1f25274aef11d27更新组名至设计者
样本响应
删除用户群
删除用户组带指定的ID
语法
DELETE /accounts/:account_id/user_groups/:group_id
所需参数
| 参数 | 类型 | 描述性 |
|---|---|---|
| group_id | 字符串 | 用户群标识删除 |
可选参数
| 参数 | 类型 | 描述性 |
|---|---|---|
| 选项 | 对象类 | 看吧配置参数. |
实例
删除用户群id7f08f1f9c10bf1f27
样本响应
从组清除用户
从带指定ID的组清除用户
语法
DELETE /accounts/:account_id/user_groups/:group_id/users/:user_id
所需参数
| 参数 | 类型 | 描述性 |
|---|---|---|
| group_id | 字符串 | 用户群标识 |
| 用户标识 | 字符串 | 用户标识符 |
可选参数
| 参数 | 类型 | 描述性 |
|---|---|---|
| 选项 | 对象类 | 看吧配置参数. |
实例
清除用户id '230df1d1f913bf335e74a1f41e25'组d'7f08f1f1f9c910bf1f2527'
样本响应
错误
评分本页 :