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

Submitting a Recording Command

Function

This API is used to control the recording of a single stream in real time.

Constraints

Requests are valid only when the recording rule type is set to COMMAND_RECORD.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/record/control

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.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

action

Yes

String

Operation.

(After the command for stopping recording is delivered, the interval for delivering the command for starting recording for the same stream must be greater than 10 seconds.)

Possible options:

  • START: Starts recording a pushed stream. If stream interruption occurs and the interruption duration exceeds the threshold, the recording is stopped and will not be automatically started after stream push resumes.

  • STOP: Stops recording a specific stream.

Request Parameters

Table 3 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.
Table 4 Request body parameters

Parameter

Mandatory

Type

Description

publish_domain

Yes

String

Ingest domain name.

app

Yes

String

Application name.

stream

Yes

String

Name of the stream whose recording is to be started or stopped.

Response Parameters

Status code: 200

Table 5 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* is the current timestamp, and *hostname* is the name of the server that processes the current request.)

Status code: 400

Table 6 Response header parameters

Parameter

Type

Description

X-request-id

String

Request ID for task tracing. The format is *request_id-timestamp-hostname*. (*request_id* is the UUID generated on the server. *timestamp* is the current timestamp. *hostname* is the name of the server that processes the current request.)
Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error description

Status code: 404

Table 8 Response header parameters

Parameter

Type

Description

X-request-id

String

Request ID for task tracing. The format is *request_id-timestamp-hostname*. (*request_id* is the UUID generated on the server. *timestamp* is the current timestamp. *hostname* is the name of the server that processes the current request.)
Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error description

Example Requests

Creates a recording control command.

POST https://{endpoint}/v1/{project_id}/record/control?action=START

{
  "publish_domain" : "publish.example.com",
  "app" : "live",
  "stream" : "mystream"
}

Example Responses

Status code: 400

Operation failed.

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

Status code: 404

The record does not exist.

{
  "error_code" : "LIVE.100011001",
  "error_msg" : "The resource to access is not exists"
}

Status Codes

Status Code

Description

200

Operation succeeded.

400

Operation failed.

404

The record does not exist.

Error Codes

See Error Codes.

Parent Topic: Recording Management