Help Center/ API Gateway/ API Reference/ Dedicated Gateway APIs (V2)/ Domain Name Management/ Modifying a Domain Name

Updated on 2024-11-11 GMT+08:00

View PDF

Modifying a Domain Name

Function

This API is used to modify the configuration of a domain name bound to an API group. For gateways with custom inbound ports, enabling or disabling client verification takes effect for different ports of the same domain name.

Calling Method

For details, see Calling APIs.

URI

PUT /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/domains/{domain_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain it, see Obtaining a Project ID.
instance_id	Yes	String	Gateway ID, which can be obtained from the gateway information on the APIG console.
group_id	Yes	String	API group ID.
domain_id	Yes	String	Domain ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It 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 a token.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
min_ssl_version	Yes	String	Minimum SSL version. TLS 1.1 and TLS 1.2 are supported. Default: TLSv1.1
is_http_redirect_to_https	No	Boolean	Whether to enable HTTP redirection to HTTPS. The value false means disable and true means enable. The default value is false. Default: false
verified_client_certificate_enabled	No	Boolean	Whether to enable client certificate verification. This parameter is available only when a certificate is bound. It is enabled by default if trusted_root_ca exists, and disabled if trusted_root_ca does not exist. Default: false
ingress_http_port	No	Integer	Inbound HTTP port bound to the domain name. -1 indicates that no port is available and the protocol is not supported. In this case, you can use the default port 80. Other valid ports must be included in the HTTP inbound ports of the gateway. The value ranges from 1024 to 49151. When creating a domain name, if this parameter is not set, the default port 80 is used. If this parameter is set, https_port must be set. If both http_port and https_port need to use the default port, leave both parameters blank. If this parameter is not specified when you modify the domain name, the port number remains unchanged. Minimum: -1 Maximum: 49151
ingress_https_port	No	Integer	Inbound HTTPS port bound to the domain name. -1 indicates that no port is available and the protocol is not supported. In this case, you can use the default port 443. Other valid ports must be included in the HTTPS inbound ports of the gateway. The value ranges from 1024 to 49151. When creating a domain name, if this parameter is not set, the default port 443 is used. If this parameter is set, http_port must be set. If both http_port and https_port need to use the default port, leave both parameters blank. If this parameter is not specified when you modify the domain name, the port number remains unchanged. Minimum: -1 Maximum: 49151

Response Parameters

Status code: 201

**Table 4** Response body parameters
Parameter	Type	Description
url_domain	String	Custom domain name.
id	String	Domain ID.
status	Integer	CNAME resolution status. 1: not resolved 2: resolving 3: resolved 4: resolution failed
min_ssl_version	String	Minimum SSL version supported.
is_http_redirect_to_https	Boolean	Whether to enable HTTP redirection to HTTPS. The value false means disable and true means enable. The default value is false. Default: false
verified_client_certificate_enabled	Boolean	Whether to enable client certificate verification. This parameter is available only when a certificate is bound. It is enabled by default if trusted_root_ca exists, and disabled if trusted_root_ca does not exist. Default: false
ingress_http_port	Integer	Inbound HTTP port bound to the domain name. -1 indicates that no port is available and the protocol is not supported. In this case, you can use the default port 80. Other valid ports must be included in the HTTP inbound ports of the gateway. The value ranges from 1024 to 49151. When creating a domain name, if this parameter is not set, the default port 80 is used. If this parameter is set, https_port must be set. If both http_port and https_port need to use the default port, leave both parameters blank. If this parameter is not specified when you modify the domain name, the port number remains unchanged. Minimum: -1 Maximum: 49151
ingress_https_port	Integer	Inbound HTTPS port bound to the domain name. -1 indicates that no port is available and the protocol is not supported. In this case, you can use the default port 443. Other valid ports must be included in the HTTPS inbound ports of the gateway. The value ranges from 1024 to 49151. When creating a domain name, if this parameter is not set, the default port 443 is used. If this parameter is set, http_port must be set. If both http_port and https_port need to use the default port, leave both parameters blank. If this parameter is not specified when you modify the domain name, the port number remains unchanged. Minimum: -1 Maximum: 49151

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 401

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 403

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 404

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Requests

Modifying a domain name

{
  "min_ssl_version" : "TLSv1.2"
}

Example Responses

Status code: 201

Created

{
  "id" : "0a515af69f4e4dcca84fbf85f68c0e27",
  "url_domain" : "www.example.com",
  "status" : 3,
  "min_ssl_version" : "TLSv1.2",
  "is_http_redirect_to_https" : false,
  "verified_client_certificate_enabled" : false
}

Status code: 400

Bad Request

{
  "error_code" : "APIG.3474",
  "error_msg" : "The API group ID in the URL does not match the API group to which the URL domain has been bound"
}

Status code: 401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

Status code: 403

Forbidden

{
  "error_code" : "APIG.1005",
  "error_msg" : "No permissions to request this method"
}

Status code: 404

Not Found

{
  "error_code" : "APIG.3020",
  "error_msg" : "The URL domain does not exist"
}

Status code: 500

Internal Server Error

{
  "error_code" : "APIG.9999",
  "error_msg" : "System error"
}

Status Codes

Status Code	Description
201	Created
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
500	Internal Server Error

Error Codes

See Error Codes.

Parent topic: Domain Name Management

Previous topic: Adding a Certificate to a Domain Name

Next topic: Unbinding a Domain Name

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot