Batch Restarting Encoding Services

Function

This API is used to restart encoding services.

URI

POST /v1/{project_id}/cloud-phone/encode-servers/batch-restart

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the project ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Specifies the user token. It can be obtained by calling an Identity and Access Management (IAM) API. The value of X-Subject-Token in the response header is the user token.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
encode_server_ids	Yes	Array of strings	Specifies the ID of the encoding service to be restarted.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
request_id	String	Specifies the request ID, which is unique.
jobs	Array of EncodeServerJob objects	Task information

**Table 5** EncodeServerJob
Parameter	Type	Description
encode_server_id	String	Specifies the unique ID of the encoding service. This parameter is contained in tasks related to the encoding service.
job_id	String	Specifies the unique ID of a task.
error_code	String	Specifies the error code.
error_msg	String	Specifies the error message.

Example Requests

Restarting encoding containers on cloud phone servers in the encode_server_ids list

POST https://{CPH Endpoint}/v1/{project_id}/cloud-phone/encode-servers/batch-restart

{
  "encode_server_ids" : [ "d5cfa92995da40168c39b38d2aa478b3", "00b00d1b35094f13b360cdfe15a9bfee" ]
}

Example Responses

Status code: 200

{
  "jobs" : [ {
    "job_id" : "e9d7b1a2572c4f2c9bf056a3d1b35e39",
    "encode_server_id" : "d5cfa92995da40168c39b38d2aa478b3"
  }, {
    "job_id" : "4d0a42447cac4c9697b97f07934b74bd",
    "encode_server_id" : "00b00d1b35094f13b360cdfe15a9bfee"
  } ],
  "request_id" : "c775bdf09bc0400a9138199b346cab62"
}