Updated on 2024-09-27 GMT+08:00

Mapping Domain Names

Function

This API is used to map a streaming domain name and an ingest domain name.

Calling Method

For details, see Calling APIs.

URI

PUT /v1/{project_id}/domains_mapping

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.

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.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

pull_domain

Yes

String

Streaming domain name.

push_domain

Yes

String

Ingest domain name associated with the streaming domain name.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

pull_domain

String

Streaming domain name.

push_domain

String

Ingest domain name associated with the streaming domain name.

Status code: 404

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error description

Example Requests

Creates a domain name mapping. The streaming domain name is play.example.com, and the ingest domain name is publish.example.com.

PUT https://{endpoint}/v1/{project_id}/domains_mapping

{
  "pull_domain" : "play.example.com",
  "push_domain" : "publish.example.com"
}

Example Responses

Status code: 200

Domain names mapped.

{
  "pull_domain" : "play.example.com",
  "push_domain" : "publish.example.com"
}

Status code: 404

Failed to map the domain names.

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

Status Codes

Status Code

Description

200

Domain names mapped.

404

Failed to map the domain names.

Error Codes

See Error Codes.