query_dna_library.md 3.34 KB

调用ListDNADB查询DNA库。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 访问级别 资源类型 条件关键字 关联操作
ice:ListDNADB none \全部资源 ``

请求参数

名称 类型 必填 描述 示例值
DBIds string DNA 库 ID 列表。⼀次建议最多查 10 个,ID 之间⽤半角逗号(,)分隔。 2288c6ca184c0e47098a5b665e2a12\*\*\*\*,78dc866518b843259669df58ed30\*\*\*\*

返回参数

名称 类型 描述 示例值
object
DBList array DNA 库列表。
DBInfo object DBInfo
Status string DNA 库状态。默认值:offline(离线)。active 表示 DNA 库可用。可取值: - offline:离线。 - active:在线。 - deleted:删除。 active
Description string DNA 库描述。 这是一个视频DNA库。
Name string DNA 库名称。 example-name
Model string DNA 库模型。包含: - Video:视频 - Audio:音频 - Image:图片 - Text:文本【仅上海区域支持】 Video
DBId string DNA 库 Id。 88c6ca184c0e47098a5b665e2a12\*\*\*\*
RequestId string 请求 ID。 25818875-5F78-4A13-BEF6-D7393642CA58

示例

正常返回示例

JSON格式

{
  "DBList": [
    {
      "Status": "active",
      "Description": "这是一个视频DNA库。",
      "Name": "example-name",
      "Model": "Video",
      "DBId": "88c6ca184c0e47098a5b665e2a12****"
    }
  ],
  "RequestId": "25818875-5F78-4A13-BEF6-D7393642CA58"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间 变更内容概要 操作
2024-07-23 OpenAPI 返回结构发生变更 查看变更详情
2023-05-25 API 内部配置变更,不影响调用 查看变更详情