CreateDNALibrary.md
3.4 KB
调用CreateDNADB创建DNA库。
接口说明
单个用户默认可以创建指纹库个数为 5 个,如需提高,请提交工单申请。无用指纹库可以调用 DeleteDNADB 接口删除。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
操作:是指具体的权限点。
访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
-
资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源表示。
条件关键字:是指云产品自身定义的条件关键字。
关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| ice:CreateDNADB | \全部资源 `` | 无 | 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| Name | string | 是 | DNA 库名称。 | example name |
| Model | string | 否 | DNA 库模型。包含: - Video:视频 - Audio:音频 - Image:图片(废弃) - Text:文本【仅上海区域支持】(废弃) | Video |
| Description | string | 否 | DNA 库描述。 | 这是一个视频DNA库。 |
返回参数
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| object | Schema of Response | ||
| RequestId | string | 请求 ID。 | 25818875-5F78-4A13-BEF6-D7393642CA58 |
| DBInfo | object | DNA 库详细信息。 | |
| Description | string | DNA 库描述。 | 这是一个视频DNA库。 |
| Name | string | DNA 库名称。 | example name |
| Status | string | DNA 库的状态。新建成功后默认为 offline 状态,待后台处理完成后会自动转换成 active 状态。 | offline |
| DBId | string | DNA 库 ID。建议您保存此 ID 便于后续调用其他相关接口时使用。 | 88c6ca184c0e47098a5b665e2a12\*\*\*\* |
| Model | string | DNA 库模型。 | Video |
示例
正常返回示例
JSON格式
{
"RequestId": "25818875-5F78-4A13-BEF6-D7393642CA58",
"DBInfo": {
"Description": "这是一个视频DNA库。",
"Name": "example name",
"Status": "offline",
"DBId": "88c6ca184c0e47098a5b665e2a12****",
"Model": "Video"
}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。
调试