Help Center/ CodeArts Build/ API Reference/ Task APIs/ Cancel Notification
Updated on 2023-12-06 GMT+08:00
View PDF

Cancel Notification

Function

Cancel Notification

Calling Method

For details, see Calling APIs.

URI

POST /v3/jobs/notice/{job_id}/disable

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

job_id

Yes

String

Indicates the ID of the build task. The value is a string of 32 characters consisting of digits and letters at the end of the browser URL when you edit the build task file.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

notice_type

Yes

String

Notification type, which can be message, email, or DingTalk.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. Obtain the value by calling the IAM service interface. (value of X-Subject-Token in the response header). Global tenant tokens are not supported. Use a region-level token whose scope is project.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

result

String

An error message is returned.

error

String

An error message is returned.

status

String

Returned status information.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

Description

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

Description

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

Description

Status code: 404

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

Description

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

Description

Example Requests

POST https://{endpoint}/v3/jobs/notice/48c66c6002964721be537cdc6ce0297b/disable?notice_type=message

Example Responses

Status code: 200

OK

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

Status Codes

Status Code

Description

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.

Parent topic: Task APIs