Help Center/ Live/ Cloud Live API Reference/ Domain Name Management/ Modifying a Domain Name
Updated on 2024-09-27 GMT+08:00
View PDF

Modifying a Domain Name

Function

This API is used to modify details about a streaming domain name or an ingest domain name.

Calling Method

For details, see Calling APIs.

URI

PUT /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, which cannot be changed.

status

No

String

Status of the domain name. You can modify this parameter to enable or disable the domain name. You cannot enable or disable a domain name that is being configured.

enterprise_project_id

No

String

Enterprise project ID

Response Parameters

Status code: 200

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

Region where the origin server is

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

Changes the status of a domain name to Disabled.

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

{
  "domain" : "play.example.com",
  "status" : "off"
}

Example Responses

Status code: 200

Domain name modified.

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

Status code: 400

Incorrect parameter.

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

Status Codes

Status Code

Description

200

Domain name modified.

400

Incorrect parameter.

Error Codes

See Error Codes.

Parent Topic: Domain Name Management