Updated on 2024-04-11 GMT+08:00

Creating a Domain Name

Function

This API is used to create a streaming domain name or ingest domain name. You can create up to 64 domain names.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/domain

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

domain

Yes

String

Domain name.

domain_type

Yes

String

Domain name type.

  • pull: Streaming domain name

  • push: Ingest domain name

region

Yes

String

Live center to which a live streaming channel belongs.

service_area

No

String

Domain name acceleration area.

  • mainland_china: Chinese mainland

  • outside_mainland_china: Outside the Chinese mainland

  • global: Global acceleration

enterprise_project_id

No

String

Enterprise project ID

Response Parameters

Status code: 201

Table 4 Response body parameters

Parameter

Type

Description

domain

String

Domain name.

domain_type

String

Domain name type.

  • pull: Streaming domain name

  • push: Ingest domain name

domain_cname

String

CNAME record of the domain name.

region

String

Live center to which a live streaming channel belongs.

status

String

Status of the domain name.

create_time

String

Time when the domain name was created. The value is in the format of yyyy-mm-ddThh:mm:ssZ (UTC time).

status_describe

String

Status description.

service_area

String

Domain name acceleration area.

  • mainland_china: Chinese mainland

  • outside_mainland_china: Outside the Chinese mainland

  • global: Global acceleration

enterprise_project_id

String

Enterprise project ID

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error description

Example Requests

Creates a streaming domain name. The domain name is play.example.com, an ingest domain name in CN North-Beijing4.

POST https://{endpoint}/v1/{project_id}/domain

{
  "domain" : "play.example.com",
  "domain_type" : "pull",
  "region" : "cn-north-4"
}

Example Responses

Status code: 201

Domain name created.

{
  "domain" : "play.example.com",
  "domain_type" : "pull",
  "domain_cname" : "play.example.com.c.cdnhwc3.com",
  "region" : "region1",
  "status" : "configuring",
  "create_time" : "2020-01-19T02:57:00Z"
}

Status code: 400

Incorrect parameter.

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

SDK Sample Code

The SDK sample code is as follows.

Creates a streaming domain name. The domain name is play.example.com, an ingest domain name in CN North-Beijing4.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.live.v1.region.LiveRegion;
import com.huaweicloud.sdk.live.v1.*;
import com.huaweicloud.sdk.live.v1.model.*;


public class CreateDomainSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        LiveClient client = LiveClient.newBuilder()
                .withCredential(auth)
                .withRegion(LiveRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateDomainRequest request = new CreateDomainRequest();
        LiveDomainCreateReq body = new LiveDomainCreateReq();
        body.withRegion("cn-north-4");
        body.withDomainType(LiveDomainCreateReq.DomainTypeEnum.fromValue("pull"));
        body.withDomain("play.example.com");
        request.withBody(body);
        try {
            CreateDomainResponse response = client.createDomain(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Creates a streaming domain name. The domain name is play.example.com, an ingest domain name in CN North-Beijing4.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
# coding: utf-8

from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdklive.v1.region.live_region import LiveRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdklive.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId) \

    client = LiveClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(LiveRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateDomainRequest()
        request.body = LiveDomainCreateReq(
            region="cn-north-4",
            domain_type="pull",
            domain="play.example.com"
        )
        response = client.create_domain(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Creates a streaming domain name. The domain name is play.example.com, an ingest domain name in CN North-Beijing4.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    live "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := live.NewLiveClient(
        live.LiveClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreateDomainRequest{}
	request.Body = &model.LiveDomainCreateReq{
		Region: "cn-north-4",
		DomainType: model.GetLiveDomainCreateReqDomainTypeEnum().PULL,
		Domain: "play.example.com",
	}
	response, err := client.CreateDomain(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

201

Domain name created.

400

Incorrect parameter.

Error Codes

See Error Codes.