Help Center/ Edge Security/ API Reference/ API/ Protected Domain Name Management/ Creating a Domain Name
Updated on 2024-11-18 GMT+08:00
View PDF
Share

Creating a Domain Name

Function

This API is used to create a protected domain name.

URI

POST /v1/edgesec/configuration/domains

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Tenant token
Table 2 Request body parameters

Parameter

Mandatory

Type

Description

domain_name

Yes

String

Protected domain name (port allowed).

enterprise_project_id

Yes

String

Obtain the enterprise project ID by calling the ListEnterpriseProject API of Enterprise Project Management Service (EPS). The default value is 0.

policy_id

No

String

ID of the policy associated with the protected domain name.

description

No

String

Domain name description.

Response Parameters

Status code: 400

Table 3 Response body parameters

Parameter

Type

Description

error_code

String

Standard error code: service name.8-digit code

error_msg

String

Detailed error information.

encoded_authorization_message

String

If the service is integrated with IAM5.0, an IAM response must be returned when access is denied.

Status code: 401

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Standard error code: service name.8-digit code

error_msg

String

Detailed error information.

encoded_authorization_message

String

If the service is integrated with IAM5.0, an IAM response must be returned when access is denied.

Status code: 500

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Standard error code: service name.8-digit code

error_msg

String

Detailed error information.

encoded_authorization_message

String

If the service is integrated with IAM5.0, an IAM response must be returned when access is denied.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Response returned normally.

400

Request failed.

401

The token does not have required permissions.

500

Internal server error.

Error Codes

See Error Codes.