All Products
Search
Document Center

Function Compute (2.0):CreateCustomDomain

Last Updated:Apr 18, 2024

Adds 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

There is currently no authorization information disclosed in the API.

Request syntax

POST /2021-04-06/custom-domains

Request parameters

ParameterTypeRequiredDescriptionExample
bodyobjectNo

The definition of the domain name.

domainNamestringYes

The domain name. Enter a custom domain name that has obtained an ICP filing in the Alibaba Cloud ICP Filing system, or a custom domain name whose ICP filing information includes Alibaba Cloud as a service provider.

example.com
protocolstringNo

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

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

The route table that maps the paths to functions when the functions are invoked by using the custom domain name.

certConfigCertConfigNo

The configurations of the HTTPS certificate.

tlsConfigTLSConfigNo

The Transport Layer Security (TLS) configuration.

wafConfigWAFConfigNo

The Web Application Firewall (WAF) configuration.

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.

rid281s******

Response parameters

ParameterTypeDescriptionExample
object

The data that is returned.

domainNamestring

The domain name.

example.com
accountIdstring

The ID of your Alibaba Cloud account.

1986114****4305
protocolstring

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

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

The configurations of the HTTPS certificate.

tlsConfigTLSConfig

The Transport Layer Security (TLS) configuration.

apiVersionstring

The version of the API.

2016-08-15
routeConfigRouteConfig

The route table that maps the paths to functions when the functions are invoked by using the custom domain name.

createdTimestring

The time when the domain name was added.

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

The time when the domain name was last modified.

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

The Web Application Firewall (WAF) configuration.

Examples

Sample success responses

JSONformat

{
  "domainName": "example.com\t",
  "accountId": "1986114****4305\t",
  "protocol": "HTTP",
  "certConfig": {
    "certName": "my-cert",
    "certificate": "-----BEGIN CERTIFICATE----- xxxxx -----END CERTIFICATE-----",
    "privateKey": "-----BEGIN RSA PRIVATE KEY----- xxxxx -----END RSA PRIVATE KEY-----"
  },
  "tlsConfig": {
    "minVersion": "TLSv1.0",
    "cipherSuites": [
      "TLS_RSA_WITH_RC4_128_SHA"
    ],
    "maxVersion": "TLSv1.3"
  },
  "apiVersion": "2016-08-15\t",
  "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"
            }
          ]
        }
      }
    ]
  },
  "createdTime": "2020-07-27T08:02:19Z\t",
  "lastModifiedTime": "2020-07-27T08:02:19Z",
  "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 affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.
2021-06-30The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: X-Fc-Account-Id
    Added Input Parameters: X-Fc-Code-Checksum
    Added Input Parameters: X-Fc-Log-Type
    Added Input Parameters: X-Fc-Invocation-Type
    Added Input Parameters: X-Fc-Date
    Added Input Parameters: X-Fc-Trace-Id
2021-06-30The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: X-Fc-Account-Id
2021-06-30The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    delete Input Parameters: X-Fc-Account-Id