Help Center/ Data Replication Service/ API Reference/ APIs V5.0 (in OBT)/ Configuration Management/ Clearing DDL Alarms
Updated on 2024-10-25 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Clearing DDL Alarms

Function

This API is used to clear DDL alarms.

URI

POST /v5/{project_id}/jobs/{job_id}/alarms/{alarm_id}/clean

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region.

For details about how to obtain the project ID, see Obtaining a Project ID.

job_id

Yes

String

Task ID.

alarm_id

Yes

String

DDL sequence number.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

MIME type of the request body. Use the default value application/json. For APIs used to upload objects or images, the value varies depending on the flow type.

X-Auth-Token

Yes

String

User token obtained from IAM. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. The token is the value of X-Subject-Token in the response header.

X-Language

No

String

Request language type.

Response Parameters

Status code: 400

Table 3 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Clearing DDL alarms

https://{endpoint}/v5/5237e10fe9aa4ad5b16b6a5245248314/jobs/7f486edc-6abb-4621-892b-4805221jb2h4/alarms/5043042/clean

Example Response

Status code: 200

OK

""

Status code: 400

Bad Request

{
  "error_code" : "DRS.10000001",
  "error_msg" : "Failed."
}

Status Code

Status Code

Description

200

OK

400

Bad Request

Error Code

For details, see Error Code.

Parent topic: Configuration Management