Help Center/ Live/ Cloud Live API Reference/ Domain Name Management/ Modifying the HLS Configuration of a Domain Name
Updated on 2026-04-22 GMT+08:00
View PDF

Modifying the HLS Configuration of a Domain Name

Function

This API is used to modify 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

Definition

Ingest domain name.

Constraints

N/A

Range

Length: 1 to 255 characters

Default Value

N/A

application

Yes

Array of PushDomainApplication objects

Definition

Application configuration for the ingest domain name.

Constraints

N/A
Table 4 PushDomainApplication

Parameter

Mandatory

Type

Description

name

No

String

Definition

Application name.

Constraints

N/A

Range

Length: 0 to 128 characters

Default value:

live

hls_fragment

No

Integer

Definition

HLS segment duration, in seconds.

Constraints

N/A

Value range:

1~10

Default value:

2

hls_ts_count

No

Integer

Definition

Number of TS segments in each M3U8 file.

Constraints

N/A

Value range:

3~10

Default value:

6

hls_min_frags

No

Integer

Definition

Minimum number of TS segments in each M3U8 file.

Constraints

N/A

Value range:

2~10

Default value:

2

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

push_domain

String

Definition

Ingest domain name.

Range

Length: 1 to 255 characters

application

Array of PushDomainApplication objects

Definition

Application configuration for the ingest domain name.
Table 6 PushDomainApplication

Parameter

Type

Description

name

String

Definition

Application name.

Constraints

N/A

Range

Length: 0 to 128 characters

Default value:

live

hls_fragment

Integer

Definition

HLS segment duration, in seconds.

Constraints

N/A

Value range:

1~10

Default value:

2

hls_ts_count

Integer

Definition

Number of TS segments in each M3U8 file.

Constraints

N/A

Value range:

3~10

Default value:

6

hls_min_frags

Integer

Definition

Minimum number of TS segments in each M3U8 file.

Constraints

N/A

Value range:

2~10

Default value:

2

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"
}

Status Codes

Status Code

Description

200

HLS configuration of the domain name modified.

400

Invalid parameter.

Error Codes

See Error Codes.

Parent Topic: Domain Name Management