DocsICP FilingConsole
Documentation

CreateApsWebhook

Updated at:
Copy as MD
My Favorites

Creates a webhook for a specified database cluster and task type.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

adb:CreateApsWebhook

none

*DBClusterLakeVersion

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

 None None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example
DBClusterId

string

Yes

The cluster ID.

amv-bp11q28kvl688****
RegionId

string

Yes

The region ID of the cluster.

cn-hangzhou
JobType

string

Yes

The task type. Valid values:

ResultExport: SLS/OSS export task.

ResultExport
Webhook

array<object>

No

The webhook array.

object

No

The webhook information.

WebhookType

string

Yes

The notification method. Valid values:

  • dingtalk: DingTalk.

  • lark: Lark.

dingtalk
Url

string

Yes

The request URL.

https://example.com/webhook
Key

string

No

The signing key.

***
Name

string

No

The webhook name.

MyWebhookName

Response elements

Element

Type

Description

Example

object

Schema of Response.

RequestId

string

The request ID.

1234567890abcdef
Data

string

The returned data.

[]
HttpStatusCode

integer

The HTTP status code.

200
Message

string

The returned message.

OK
Code

string

The response code.

200
Success

boolean

Indicates whether the request was successful.

true

Examples

Success response

JSON format

{
  "RequestId": "1234567890abcdef",
  "Data": "[]",
  "HttpStatusCode": 200,
  "Message": "OK",
  "Code": "200",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.