Add a custom domain by calling the CreateCustomDomain API - Function Compute - Alibaba Cloud -

Creates a custom domain name.

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

fc:CreateCustomDomain

create

*All Resource

*

None

Request syntax

POST /2021-04-06/custom-domains HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The domain name definition.
domainName	string	Yes	The domain name. Specify a custom domain name that has been filed or has an access filing with Alibaba Cloud.	example.com
protocol	string	No	The protocol type 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
routeConfig	RouteConfig	No	The route table that maps paths to functions when the custom domain name is accessed.
certConfig	CertConfig	No	The HTTPS certificate information.
tlsConfig	TLSConfig	No	The TLS configuration information.
wafConfig	WAFConfig	No	The Web Application Firewall (WAF) configuration information.
X-Fc-Account-Id	string	No	The Alibaba Cloud account ID.	188077086902****
X-Fc-Date	string	No	The time when the API is called. The format is EEE,d MMM yyyy HH:mm:ss GMT.	Wed, 11 May 2022 09:00:00 GMT
X-Fc-Trace-Id	string	No	The custom request ID.	rid281s******

Response elements

Element	Type	Description	Example
	object	The response parameters.
domainName	string	The domain name.	example.com
accountId	string	The Alibaba Cloud account ID.	1986114****4305
protocol	string	The protocol type 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
certConfig	CertConfig	The HTTPS certificate configuration information.
tlsConfig	TLSConfig	The TLS configuration information.
apiVersion	string	The API version.	2016-08-15
routeConfig	RouteConfig	The route table that maps paths to functions when the custom domain name is accessed.
createdTime	string	The time when the domain name was bound.	2020-07-27T08:02:19Z
lastModifiedTime	string	The time when the domain name was last updated.	2020-07-27T08:02:19Z
wafConfig	WAFConfig	The Web Application Firewall (WAF) configuration information.

Examples

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.