文档首页/ 编译构建 CodeArts Build/ API参考/ 任务相关API接口/ 检查webhook地址参数
更新时间：2024-11-08 GMT+08:00
在线调试
CLI示例
查看PDF
分享

检查webhook地址参数

功能介绍

检查webhook地址参数

调用方法

请参见如何调用API。

URI

POST /v1/job/check/webhook-url

请求参数

表1 请求Body参数

参数

是否必选

参数类型

描述

job_id

是

String

任务ID

notice_type

是

String

通知类型

webhook_url

是

String

Webhook地址

响应参数

状态码： 200

表2 响应Body参数

参数

参数类型

描述

error

String

返回错误信息

status

String

返回状态信息

状态码： 400

表3 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 401

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 403

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 404

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

POST https://{endpoint}/v1/job/check/webhook-url

{
  "job_id" : "2f211929d0c543feb38824a665ad7fcb",
  "notice_type" : "DING_TALK",
  "webhook_url" : "https://oapi.dingtalk.com/robot/send?access_token="
}

响应示例

状态码： 200

OK

{
  "result" : null,
  "error" : null,
  "status" : "success"
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 任务相关API接口

相关文档