Help Center/ Live/ Cloud Live API Reference/ Domain Name Management/ Modifying the HLS Configuration of a Domain Name
Updated on 2024-08-09 GMT+08:00

Modifying the HLS Configuration of a Domain Name

Function

Modifies the HLS configuration of a domain name.

Calling Method

For details, see Calling APIs.

URI

PUT /v1/{project_id}/domain/hls

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

push_domain

Yes

String

Ingest domain name

application

Yes

Array of PushDomainApplication objects

Ingest domain name app configuration

Table 4 PushDomainApplication

Parameter

Mandatory

Type

Description

name

No

String

App name. The default value is live.

hls_fragment

No

Integer

HLS segment duration, in second.

hls_ts_count

No

Integer

Number of TS segments in each M3U8 file

hls_min_frags

No

Integer

Minimum number of TS segments in each M3U8 file

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

push_domain

String

Ingest domain name

application

Array of PushDomainApplication objects

Ingest domain name app configuration

Table 6 PushDomainApplication

Parameter

Type

Description

name

String

App name. The default value is live.

hls_fragment

Integer

HLS segment duration, in second.

hls_ts_count

Integer

Number of TS segments in each M3U8 file

hls_min_frags

Integer

Minimum number of TS segments in each M3U8 file

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error description

Example Requests

Modifies the HLS configuration of a domain name.

PUT https://{endpoint}/v1/{project_id}/domain/hls

{
  "push_domain" : "push.example.com",
  "application" : [ {
    "name" : "live",
    "hls_fragment" : 2,
    "hls_ts_count" : 3,
    "hls_min_frags" : 3
  } ]
}

Example Responses

Status code: 400

Invalid parameter.

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

SDK Sample Code

The SDK sample code is as follows.

Modifies the HLS configuration of a domain name.

 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
53
54
55
56
57
58
59
60
61
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.*;

import java.util.List;
import java.util.ArrayList;

public class UpdateHlsConfigSolution {

    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();
        UpdateHlsConfigRequest request = new UpdateHlsConfigRequest();
        ModifyHlsConfig body = new ModifyHlsConfig();
        List<PushDomainApplication> listbodyApplication = new ArrayList<>();
        listbodyApplication.add(
            new PushDomainApplication()
                .withName("live")
                .withHlsFragment(2)
                .withHlsTsCount(3)
                .withHlsMinFrags(3)
        );
        body.withApplication(listbodyApplication);
        body.withPushDomain("push.example.com");
        request.withBody(body);
        try {
            UpdateHlsConfigResponse response = client.updateHlsConfig(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());
        }
    }
}

Modifies the HLS configuration of a domain name.

 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
# coding: utf-8

import os
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 = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["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 = UpdateHlsConfigRequest()
        listApplicationbody = [
            PushDomainApplication(
                name="live",
                hls_fragment=2,
                hls_ts_count=3,
                hls_min_frags=3
            )
        ]
        request.body = ModifyHlsConfig(
            application=listApplicationbody,
            push_domain="push.example.com"
        )
        response = client.update_hls_config(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Modifies the HLS configuration of a domain name.

 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
53
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.UpdateHlsConfigRequest{}
	nameApplication:= "live"
	hlsFragmentApplication:= int32(2)
	hlsTsCountApplication:= int32(3)
	hlsMinFragsApplication:= int32(3)
	var listApplicationbody = []model.PushDomainApplication{
        {
            Name: &nameApplication,
            HlsFragment: &hlsFragmentApplication,
            HlsTsCount: &hlsTsCountApplication,
            HlsMinFrags: &hlsMinFragsApplication,
        },
    }
	request.Body = &model.ModifyHlsConfig{
		Application: listApplicationbody,
		PushDomain: "push.example.com",
	}
	response, err := client.UpdateHlsConfig(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

200

HLS configuration of the domain name modified.

400

Invalid parameter.

Error Codes

See Error Codes.