CreateApsWebhook - 创建Webhook

更新时间:
复制 MD 格式

用于为指定数据库集群和任务类型创建新的Webhook。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

adb:CreateApsWebhook

none

*DBClusterLakeVersion

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

请求语法

POST  HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

DBClusterId

string

集群 ID。

amv-bp11q28kvl688****

RegionId

string

集群所属地域 ID。

cn-hangzhou

JobType

string

任务类型。取值如下 任务类型 SLS/OSS 导出任务:ResultExport。

ResultExport

Webhook

array<object>

Webhook 数组。

object

Webhook 信息。

WebhookType

string

通知方式。取值如下: dingtalk:钉钉。 lark:飞书。

dingtalk

Url

string

请求地址。

https://example.com/webhook

Key

string

加签密钥。

***

Name

string

Webhook 名称。

MyWebhookName

返回参数

名称

类型

描述

示例值

object

Schema of Response。

RequestId

string

请求 ID。

1234567890abcdef

Data

string

返回数据。

[]

HttpStatusCode

integer

http 状态码。

200

Message

string

返回消息。

OK

Code

string

请求返回 Code。

200

Success

boolean

是否成功。

true

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

更多信息,参考变更详情