GetCatalog - 查询catalog-事件总线(EventBridge)-阿里云帮助中心

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

eventbridge:GetCatalog

get

*Catalog

acs:eventbridge:{#regionId}:{#accountId}:catalog/{#Catalog}

无

请求参数

名称	类型	必填	描述	示例值
Name	string	是	数据目录名称	my_catalog
ClientToken	string	否	幂等 Token	1e9b8f60-3a2c-4d7e-9f1b-8c3d5e7a2b4f

返回参数

名称	类型	描述	示例值
	object
Message	string	接口返回信息	Operation success
RequestId	string	请求 ID	34AD682D-5B91-5773-8132-AA38C130****
Code	string	接口返回码，200 表示成功	200
Success	boolean	操作是否成功	true
Data	Catalog	catalog 详情

示例

正常返回示例

JSON格式

{
  "Message": "Operation success",
  "RequestId": "34AD682D-5B91-5773-8132-AA38C130****",
  "Code": "200",
  "Success": true,
  "Data": {
    "Name": "my_catalog",
    "Type": "RELATIONAL",
    "Provider": "EventHouse",
    "Comment": "测试数据目录",
    "Properties": {
      "IndexPattern": "my-index-*"
    },
    "ConnectionName": "my_connection"
  }
}

错误码

HTTP status code	错误码	错误信息	描述
403	ServiceNotEnable	Service not enable

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

变更历史

更多信息，参考变更详情。