分页查询,获取元数据库命名空间(Catalog)列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
dlf:ListCatalogs | list | *全部资源 * |
| 无 |
请求语法
GET /api/metastore/catalogs/list HTTP/1.1
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
IdPattern | string | 否 | CatalogId 的匹配正则 | .* |
NextPageToken | string | 否 | 翻页 token,从返回结果返回,无则传空字符串或'' | ‘’ |
PageSize | integer | 否 | 分页大小 | 10 |
- IdPattern,待查询的 catalog 名称,支持**.***匹配,.表示匹配一个字符,*表示匹配 n 个字符
- NextPageToken:分页的开始位置,第一次填写空字符串,后续的填写上一次的 response 中返回的 NextPageToken,如果返回的 NextPageToken 为空字符串,那么说明无数据了。
- pagesize:一次返回的个数。
返回参数
Code 错误码说明
InternalError:其他类型错误,请参考 Message 提示
示例
正常返回示例
JSON
格式
{
"Catalogs": [
{
"CatalogId": "1344371",
"Description": "测试",
"LocationUri": "oss://dlf-test-oss-location/",
"Owner": "acs:ram::[accountId]:root",
"CreatedBy": "acs:ram::[accountId]:root\n",
"CreateTime": 1640662815,
"UpdateTime": 1640662815,
"Status": "CREATED",
"CatalogType": "HMS",
"DefaultCatalog": true,
"ThriftEnabled": true,
"JdbcEnabled": true,
"StorageAccessConfig": ""
}
],
"Code": "OK",
"Message": ".",
"NextPageToken": "2cb472ec1bf84f8d92f9c4baa0d21c19aa",
"RequestId": "B7F4B621-E41E-4C84-B97F-42B5380A32BB",
"Success": true
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|
暂无变更历史