All Products
Search
Document Center

Function Compute:UpdateCustomDomain

Last Updated:Sep 23, 2024

Modifies a custom domain name.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:
    • The required resource types are displayed in bold characters.
    • 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
fc:UpdateCustomDomainupdate
  • All Resources
    *
    none
none

Request syntax

PUT /2021-04-06/custom-domains/{domainName} HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
domainNamestringYes

The domain name.

example.com
bodyobjectNo

The request body.

protocolstringNo

The protocol types supported by the domain name. Valid values:

  • HTTP: Only HTTP is supported.
  • HTTPS: Only HTTPS is supported.
  • HTTP,HTTPS: Both HTTP and HTTPS are supported.
HTTP
routeConfigRouteConfigNo

The configuration of the route table. The route table maps paths to functions when the functions are invoked by using custom domain names.

certConfigCertConfigNo

The configuration of the HTTPS certificate.

tlsConfigTLSConfigNo

The TLS configurations.

wafConfigWAFConfigNo

Web Application Firewall (WAF) configurations.

X-Fc-Account-IdstringNo

The ID of your Alibaba Cloud account.

188077086902****
X-Fc-DatestringNo

The time when the operation is called. The format is: EEE,d MMM yyyy HH:mm:ss GMT.

Wed, 11 May 2022 09:00:00 GMT
X-Fc-Trace-IdstringNo

The custom request ID.

asdf*****

Response parameters

ParameterTypeDescriptionExample
object

The information about the modified domain name.

domainNamestring

The domain name.

example.com
accountIdstring

The ID of your Alibaba Cloud account.

1986114****4305
protocolstring

The protocol type that is supported by the custom domain name.

  • HTTP: Only HTTP is supported.
  • HTTPS: Only HTTPS is supported.
  • HTTP,HTTPS: HTTP and HTTPS are supported.
HTTP
apiVersionstring

The version of the API.

2016-08-15
createdTimestring

The time when the custom domain name was created.

2020-07-27T08:02:19Z
lastModifiedTimestring

The time when the domain name was last modified.

2020-07-27T08:02:19Z
certConfigCertConfig

The configuration of the HTTPS certificate.

routeConfigRouteConfig

The configuration of the route table. The route table maps paths to functions when the functions are invoked by using custom domain names.

tlsConfigTLSConfig

The TLS configurations.

wafConfigWAFConfig

Web Application Firewall (WAF) configurations.

Examples

Sample success responses

JSONformat

{
  "domainName": "example.com\t",
  "accountId": "1986114****4305\t",
  "protocol": "HTTP",
  "apiVersion": "2016-08-15\t",
  "createdTime": "2020-07-27T08:02:19Z\t",
  "lastModifiedTime": "2020-07-27T08:02:19Z",
  "certConfig": {
    "certName": "my-cert",
    "certificate": "-----BEGIN CERTIFICATE----- xxxxx -----END CERTIFICATE-----",
    "privateKey": "-----BEGIN RSA PRIVATE KEY----- xxxxx -----END RSA PRIVATE KEY-----"
  },
  "routeConfig": {
    "routes": [
      {
        "functionName": "f1",
        "methods": [
          "GET"
        ],
        "path": "/login",
        "qualifier": "prod",
        "serviceName": "s1",
        "rewriteConfig": {
          "equalRules": [
            {
              "match": "/old",
              "replacement": "/new"
            }
          ],
          "wildcardRules": [
            {
              "match": "/api/*",
              "replacement": "/$1"
            }
          ],
          "regexRules": [
            {
              "match": "^/js/(.*?)$",
              "replacement": "/public/javascripts/$1"
            }
          ]
        }
      }
    ]
  },
  "tlsConfig": {
    "minVersion": "TLSv1.0",
    "cipherSuites": [
      "TLS_RSA_WITH_RC4_128_SHA"
    ],
    "maxVersion": "TLSv1.3"
  },
  "wafConfig": {
    "enableWAF": true
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
2024-02-19The internal configuration of the API is changed, but the call is not affectedView Change Details
2022-11-28The internal configuration of the API is changed, but the call is not affectedView Change Details
2021-06-30The request parameters of the API has changedView Change Details
2021-06-30The request parameters of the API has changedView Change Details
2021-06-30The request parameters of the API has changedView Change Details