ListApsWebhook - AnalyticDB - Alibaba Cloud Documentation Center

Queries the Webhook configurations of a specified database cluster.

Operation description

This API allows you to obtain a list of configured webhooks based on RegionId, DBClusterId, and optional JobType. The JobType parameter specifies the task type, such as SLS/OSS export task. If the parameter is provided, webhooks related to the task type are returned. If the parameter is not provided, all types of webhooks are returned.

Note: Make sure that the RegionId and DBClusterId you provided are correct. Otherwise, the webhook information may not be obtained correctly.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
adb:ListApsWebhook	none	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The cluster ID.	amv-8vbuyjhrih**
RegionId	string	Yes	The region ID.	cn-hangzhou
JobType	string	No	JobType Job type. SLS or OSS Export Task: ResultExport.	ResultExport

Response parameters

Parameter	Type	Description	Example
	object	The returned message.
RequestId	string	The unique ID of the request.	exampleRequestId
HttpStatusCode	integer	The HTTP status code.	200
Message	string	The returned message.	OK
Code	string	API status or POP error code.	200
Success	boolean	Indicates whether the request was successful.	True
Webhook	array<object>	The array of webhooks.
webhook	object	The array of webhooks.
WebhookType	string	Webhook type.	dingtalk
WebhookId	string	The ID of the webhook that you want to delete.	35*
Url	string	The request URL.	https://example.com/webhook
Key	string	Signing key	your_secret_key
Name	string	The name of the webhook.	webhook_name

Examples

Sample success responses

JSONformat

{
  "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"
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.