All Products
Search
Document Center

API Gateway:UpdateDomain

Last Updated:Dec 17, 2025
This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Updates a domain name.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
apig:UpdateDomainnone
*Domain
acs:apig:{#regionId}:{#accountId}:domain/{#DomainId}
    none
none

Request syntax

PUT /v1/domains/{domainId} HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
bodyobjectNo

The request body.

protocolstringYes

The protocol type to be supported by the domain name. Valid values:

  • HTTP
  • HTTPS
HTTP
forceHttpsbooleanNo

Specifies whether to enable HTTPS redirection. If protocol is set to HTTPS, forceHttps is required.

false
mTLSEnabledbooleanNo

Specifies whether to enable mutual TLS (mTLS) authentication.

certIdentifierstringNo

The certificate ID.

1ef1da5f-38ed-69b3-****-037781890265
caCertIdentifierstringNo

The CA certificate ID.

1ef1da5f-38ed-69b3-****-037781890265
clientCACertstringNo

The client CA certificate.

-----BEGIN CERTIFICATE----- MIIFBTCCAu2gAwIBAgIUORLpYPGSFD1YOP6PMbE7Wd/mpTQwDQYJKoZIhvcNAQEL BQAwE************************************************2VwVOJ2gqX3 YuGaxvIbDy0iQJ1GMerPRyzJTeVEtdIKT29u0PdFRr4KZWom35qX7G4= -----END CERTIFICATE-----
http2OptionstringNo

The HTTP/2 configuration.

Enumerated values:

  • GlobalConfig
  • Close
  • Open
Open
tlsMaxstringNo

The maximum TLS version. Up to TLS 1.3 is supported.

TLS 1.3
tlsMinstringNo

The minimum TLS version. Down to TLS 1.0 is supported.

TLS 1.0
tlsCipherSuitesConfigTlsCipherSuitesConfigNo

The cipher suite configuration.

domainIdstringYes

The domain ID.

d-cpqnfn5lhtgqbga95sv1

Response parameters

ParameterTypeDescriptionExample
object

The response body.

requestIdstring

The request ID. You can use this value to trace the API call.

4BACB05C-3FE2-588F-9148-700C5C026B74
codestring

The status code.

Ok
messagestring

The returned message.

success
dataobject

The response parameters.

deployRevisionIdstring

The released version ID.

apr-xxx

Examples

Sample success responses

JSONformat

{
  "requestId": "4BACB05C-3FE2-588F-9148-700C5C026B74",
  "code": "Ok",
  "message": "success",
  "data": {
    "deployRevisionId": "apr-xxx"
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2025-02-27The internal configuration of the API is changed, but the call is not affectedView Change Details
2024-12-30The internal configuration of the API is changed, but the call is not affectedView Change Details
2024-11-28The internal configuration of the API is changed, but the call is not affectedView Change Details
2024-09-03The response structure of the API has changedView Change Details