Help Center/ Live/ Cloud Live API Reference/ Recording Management/ Deleting a Recording Template
Updated on 2024-09-27 GMT+08:00
View PDF

Deleting a Recording Template

Function

This API is used to delete a recording template.

Calling Method

For details, see Calling APIs.

URI

DELETE /v1/{project_id}/record/rules/{id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

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

id

Yes

String

Template ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token. This parameter is mandatory when token authentication is used. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Authorization

No

String

Authentication information. This parameter is mandatory for AK/SK authentication.

X-Sdk-Date

No

String

Time when the request is sent. This parameter is mandatory for AK/SK authentication.

X-Project-Id

No

String

Project ID. This parameter is mandatory for AK/SK authentication.

Response Parameters

Status code: 204

Table 3 Response header parameters

Parameter

Type

Description

X-request-id

String

Request ID for task tracing. Format: *request_id-timestamp-hostname*. (*request_id* is the UUID generated on the server. *timestamp* indicates the current timestamp, and *hostname* is the name of the server that processes the current API.)

Status code: 400

Table 4 Response header parameters

Parameter

Type

Description

X-request-id

String

Request ID for task tracing. Format: *request_id-timestamp-hostname*. (*request_id* is the UUID generated on the server. *timestamp* indicates the current timestamp, and *hostname* is the name of the server that processes the current API.)
Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error description

Status code: 404

Table 6 Response header parameters

Parameter

Type

Description

X-request-id

String

Request ID for task tracing. Format: *request_id-timestamp-hostname*. (*request_id* is the UUID generated on the server. *timestamp* indicates the current timestamp, and *hostname* is the name of the server that processes the current API.)
Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error description

Example Requests

Deletes a recording rule.

DELETE https://{endpoint}/v1/{project_id}/record/rule/e89b76xxxxxx3425ui80af501cdxxxxxx

Example Responses

Status code: 400

Failed to delete the recording template.

{
  "error_code" : "LIVE.100011001",
  "error_msg" : "Request Illegal"
}

Status code: 404

The record does not exist.

{
  "error_code" : "LIVE.100011001",
  "error_msg" : "Request Illegal"
}

Status Codes

Status Code

Description

204

Recording template deleted.

400

Failed to delete the recording template.

404

The record does not exist.

Error Codes

See Error Codes.

Parent Topic: Recording Management