Updated on 2022-10-08 GMT+08:00

Stopping a Single Stream Recording Job

Function

This API is used to stop a single stream recording job.

URI

DELETE /v2/apps/{app_id}/individual-stream-jobs/{job_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

app_id

Yes

String

Application ID.

job_id

Yes

String

Job ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Content type.

X-Auth-Token

No

String

User token. This parameter is mandatory when token authentication is used. It can be obtained by calling the IAM API that is used for obtaining 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 when AK/SK-based authentication is used.

X-Sdk-Date

No

String

Time when the request is sent. This parameter is mandatory when AK/SK-based authentication is used.

X-Project-Id

No

String

Project ID. This parameter is mandatory when AK/SK-based authentication is used.

Response Parameters

Status code: 204

Table 3 Response header parameters

Parameter

Type

Description

X-request-Id

String

Request ID for task tracing.

Status code: 404

Table 4 Response header parameters

Parameter

Type

Description

X-request-Id

String

Request ID for task tracing.

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Description.

Status code: 500

Table 6 Response header parameters

Parameter

Type

Description

X-request-Id

String

Request ID for task tracing.

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Description.

Example Requests

DELETE https://rtc-api.myhuaweicloud.com/v2/apps/{app_id}/individual-stream-jobs/{job_id}

Example Responses

Status code: 404

Failed to stop the job because the application or job ID does not exist.

{
  "error_code" : "RTC.00001003",
  "error_msg" : "InvalidParameterValue"
}

Status code: 500

Failed to stop the job due to server error.

{
  "error_code" : "RTC.00002xxx",
  "error_msg" : "InternalError"
}

Status Codes

Status Code

Description

204

The job is stopped.

404

Failed to stop the job because the application or job ID does not exist.

500

Failed to stop the job due to server error.

Error Codes

See Error Codes.