使用ListApsWebhook查询数据库集群的Webhook配置信息-云原生数据仓库AnalyticDB-阿里云-云原生数据仓库AnalyticDB(AnalyticDB)-阿里云帮助中心

接口说明

通过此 API，您可以根据RegionId、DBClusterId以及可选的JobType来获取已配置的 Webhook 列表。其中，JobType参数指定了任务类型（例如 SLS/OSS 导出任务），如果提供，则返回与该任务类型相关的 Webhook；如果不提供，则返回所有类型的 Webhook。

注意：确保您提供的RegionId和DBClusterId是正确的，否则可能无法正确获取到 Webhook 信息。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

adb:ListApsWebhook

none

*DBClusterLakeVersion

acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

无

请求语法

GET  HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
DBClusterId	string	是	集群 ID。	amv-8vbuyjhrih**
RegionId	string	是	地域 ID。	cn-hangzhou
JobType	string	否	JobType 任务类型 SLS/OSS 导出任务：ResultExport。	ResultExport

返回参数

名称	类型	描述	示例值
	object	返回消息。
RequestId	string	请求 ID。	exampleRequestId
HttpStatusCode	integer	http 状态码。	200
Message	string	返回消息。	OK
Code	string	接口状态或 POP 错误码。	200
Success	boolean	是否成功。	True
Webhook	array<object>	Webhook 数组。
	object	Webhook 数组。
WebhookType	string	Webhook 类型。	dingtalk
WebhookId	string	要删除的 webhook id。	35*
Url	string	请求地址。	https://example.com/webhook
Key	string	加签密钥。	your_secret_key
Name	string	webhook 名称。	webhook_name

示例

正常返回示例

JSON格式

{
  "RequestId": "exampleRequestId",
  "HttpStatusCode": 200,
  "Message": "OK",
  "Code": "200",
  "Success": true,
  "Webhook": [
    {
      "WebhookType": "dingtalk",
      "WebhookId": "**35***",
      "Url": "https://example.com/webhook",
      "Key": "your_secret_key",
      "Name": "webhook_name"
    }
  ]
}

错误码

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

变更历史

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