Querying the Automatic Recording Configuration

Function

This API is used to query the automatic recording configuration.

URI

GET /v2/apps/{app_id}/auto-record-mode

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
app_id	Yes	String	Application 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: 200

**Table 3** Response header parameters
Parameter	Type	Description
X-request-Id	String	Request ID for task tracing.

**Table 4** Response body parameters
Parameter	Type	Description
app_id	String	Application ID.
auto_record_mode	AppAutoRecordMode object	Automatic recording configuration.

**Table 5** AppAutoRecordMode
Parameter	Type	Description
mode	String	Recording mode. AUTO_RECORD_OFF: Automatic recording is disabled. AUTO_INDIVIDUAL_RECORD: Automatic recording is enabled for single streams. In this case, record_rule_id must not be left empty.
record_rule_id	String	Recording rule ID.
update_time	String	Update time, for example, 2006-01-02T15:04:05.075Z. The time zone is UTC.

Status code: 400

**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.

Status code: 404

**Table 8** Response header parameters
Parameter	Type	Description
X-request-Id	String	Request ID for task tracing.

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Description.

Status code: 500

**Table 10** Response header parameters
Parameter	Type	Description
X-request-Id	String	Request ID for task tracing.

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Description.

Example Requests

GET https://rtc-api.myhuaweicloud.com/v2/apps/{app_id}/auto-record-mode

Example Responses

Status code: 200

Details about an application.

{
  "app_id" : "123456789abcdefghijklmno",
  "auto_record_mode" : {
    "mode" : "AUTO_RECORD_OFF",
    "update_time" : "2020-07-26T07:53:05.075Z"
  }
}

Status code: 400

The request cannot be understood by the server or parameters are incorrect.

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

Status code: 404

The application ID does not exist.

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

Status code: 500

Query failed due to server error.

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

Status Codes

Status Code	Description
200	Details about an application.
400	The request cannot be understood by the server or parameters are incorrect.
404	The application ID does not exist.
500	Query failed due to server error.