Help Center/ Live/ Cloud Live API Reference/ Domain Name Management/ Querying Origin Pull Settings
Updated on 2024-09-27 GMT+08:00
View PDF

Querying Origin Pull Settings

Function

Queries origin pull settings. Only RTMP and FLV domain names are supported.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/domain/pull-sources

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.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

play_domain

Yes

String

Streaming domain name.

Request Parameters

Table 3 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.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

play_domain

String

Streaming domain name.

source_type

String

Origin pull method.

  • domain: Origin pull from the customer's origin server. The origin server address is in the domain name format. Multiple domain names for origin pull can be configured. If origin pull fails, domain names are polled based on the configured sequence until origin pull succeeds.

  • ipaddr: Origin pull from the customer's origin server. The origin server address is in the IP address format. Multiple IP addresses for origin pull can be configured. If origin pull fails, IP addresses are polled based on the configured sequence until origin pull succeeds. A maximum of one domain name for origin pull can be configured. During origin pull, set the header of httpflv HOST and the RTMP tcurl field to the configured domain name, respectively. Otherwise, the current IP address is used as the HOST.

  • huawei: Origin pull from the Huawei origin server. The default value after the domain name is created is used.

sources

Array of strings

Domain names for origin pull. A maximum of 10 domain names are allowed.

  • This parameter is mandatory when the value is domain. If multiple domain names are configured and origin pull fails, domain names are polled based on the configured sequence until origin pull succeeds.

  • A maximum of one domain name for origin pull can be configured when the value is ipaddr. During origin pull, set the header of httpflv HOST and the RTMP tcurl field to the configured domain name, respectively. Otherwise, the current IP address is used as the HOST.

sources_ip

Array of strings

IP addresses for origin pull. A maximum of 10 IP addresses are allowed. This parameter is mandatory when the value is ipaddr. If multiple IP addresses are configured and origin pull fails, IP addresses are polled based on the configured sequence until origin pull succeeds.

source_port

Integer

Origin pull port.

scheme

String

Origin pull protocol. This parameter is mandatory when the origin pull method is not huawei.

additional_args

Map<String,String>

Parameter carried in the URL for origin pull from the customer's origin server.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error description

Example Requests

Queries origin pull settings. Only RTMP and FLV domain names are supported.

GET https://{endpoint}/v1/{project_id}/domain/pull-sources?play_domain=pull.example.test.com

Example Responses

Status code: 200

Origin pull settings queried.

{
  "play_domain" : "pull.example.test.com",
  "source_type" : "domain",
  "sources" : [ "example1.test.com", "example2.test.com" ],
  "scheme" : "http",
  "additional_args" : {
    "key1" : "value1",
    "key2" : "value2"
  }
}

Status code: 400

Invalid parameter.

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

Status Codes

Status Code

Description

200

Origin pull settings queried.

400

Invalid parameter.

Error Codes

See Error Codes.

Parent Topic: Domain Name Management