All Products
Search

This Product

    API Gateway:UpdateDomain

    Document Center

    API Gateway:UpdateDomain

    Last Updated:Jul 04, 2026

    Updates a domain.

    Operation description

    You can only update Ingress listener configurations for Container Service sources.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    apig:UpdateDomain

    none

    *Domain

    acs:apig:{#regionId}:{#accountId}:domain/{#DomainId}

    		 None None

    Request syntax

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

    Path Parameters

    Parameter

    Type

    Required

    Description

    Example
    domainId

    string

    Yes

    The domain ID.

    d-cpqnfn5lhtgqbga95sv1

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    body

    object

    No

    The request body.

    {'key': 'value'}
    domainScope

    string

    No

    The domain scope.

    Valid values:

    • Serverless :

      Serverless

    • Dedicated :

      Dedicated

    Dedicated
    protocol

    string

    No

    The protocol supported by the domain.

    • HTTP: The domain only supports HTTP.

    • HTTPS: The domain only supports HTTPS.

    Valid values:

    • HTTPS :

      HTTPS

    • HTTP :

      HTTP

    HTTP
    forceHttps

    boolean

    No

    Specifies whether to enable forced HTTPS redirection. This parameter is required if protocol is set to HTTPS.

    false
    mTLSEnabled

    boolean

    No

    Specifies whether to enable mutual TLS (mTLS) authentication.

    certIdentifier

    string

    No

    The certificate ID.

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

    caCertIdentifier

    string

    No

    The CA certificate ID.

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

    clientCACert

    string

    No

    The client CA certificate.

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

    string

    No

    The HTTP/2 settings.

    Valid values:

    • GlobalConfig :

      GlobalConfig

    • Close :

      Close

    • Open :

      Open

    Open
    tlsMax

    string

    No

    The maximum TLS version. The highest supported version is TLS 1.3.

    TLS 1.3
    tlsMin

    string

    No

    The minimum TLS version. The lowest supported version is TLS 1.0.

    TLS 1.0
    tlsCipherSuitesConfig TlsCipherSuitesConfig

    No

    The cipher suite configuration.

    Response elements

    Element

    Type

    Description

    Example

    object

    The response body.

    requestId

    string

    The request ID.

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

    string

    The response code.

    Ok
    message

    string

    The response message.

    success
    data

    object

    The returned data.

    deployRevisionId

    string

    The deployment revision ID.

    apr-xxxxx

    Examples

    Success response

    JSON format

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

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.