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
| 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
| 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. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| pull_domain | Yes | String | Definition Streaming domain name. Constraints N/A Range Length: 1 to 255 characters Default Value N/A |
| push_domain | Yes | String | Definition Ingest domain name associated with the streaming domain name. Constraints N/A Range Length: 1 to 255 characters Default Value N/A |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| pull_domain | String | Definition Streaming domain name. Constraints N/A Range Length: 1 to 255 characters Default Value N/A |
| push_domain | String | Definition Ingest domain name associated with the streaming domain name. Constraints N/A Range Length: 1 to 255 characters Default Value N/A |
Status code: 404
| 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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.