ListCustomDomains - Function Compute - Alibaba Cloud Documentation Center

Queries available custom domain names.

Debugging

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

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
fc:ListCustomDomains	get	All Resources *	none	none

Request syntax

GET /2021-04-06/custom-domains

Request parameters

Parameter	Type	Required	Description	Example
prefix	string	No	The prefix that the returned domain names must contain.	prefix_text
startKey	string	No	The returned resources are sorted in alphabetical order, and the resources that include and follow the resource specified by the startKey parameter are returned.	next_service
nextToken	string	No	The pagination token to use to request the next page of results. If the number of resources exceeds the limit, the nextToken parameter is returned. You can include the parameter in subsequent calls to obtain more results. You do not need to provide this parameter in the first call.	fc-thinkphp-demo.functioncompute.com
limit	integer	No	The maximum number of resources to return. Valid values: [0,100]. Default value: 20. The number of returned results is less than or equal to the specified number.	20
X-Fc-Account-Id	string	No	The ID of your Alibaba Cloud account.	188077086902****
X-Fc-Date	string	No	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-Id	string	No	The custom request ID.	asdf*****

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
nextToken	string	The pagination token to use to request the next page of results. If the number of resources exceeds the limit, the nextToken parameter is returned. You can include the parameter in subsequent calls to obtain more results. You do not need to provide this parameter in the first call.	example.com
customDomains	array<object>	The list of domain names.
	object	The information about the accelerated domain name.
domainName	string	The domain name.	example.com
accountId	string	The ID of your Alibaba Cloud account.	1986114****4305
protocol	string	The protocol type that is supported by the custom domain name. Valid values: HTTP: Only HTTP is supported. HTTPS: Only HTTPS is supported. HTTP,HTTPS: Both HTTP and HTTPS are supported.	HTTP
apiVersion	string	The version of the API.	2016-08-15
createdTime	string	The time when the custom domain name was created.	2020-07-27T08:02:19Z
lastModifiedTime	string	The last time when the domain name was updated.	2020-07-27T08:02:19Z
certConfig	CertConfig	The configuration of the HTTPS certificate.
tlsConfig	TLSConfig	The TLS configurations.
routeConfig	RouteConfig	The configuration of the route table. The route table maps paths to functions when the functions are invoked by using custom domain names.
wafConfig	WAFConfig	The Web Application Firewall (WAF) configurations.

Examples

Sample success responses

JSONformat

{
  "nextToken": "example.com",
  "customDomains": [
    {
      "domainName": "example.com\t",
      "accountId": "1986114****4305\t",
      "protocol": "HTTP\t",
      "apiVersion": "2016-08-15\t",
      "createdTime": "2020-07-27T08:02:19Z\t",
      "lastModifiedTime": "2020-07-27T08:02:19Z\t",
      "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"
      },
      "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"
                }
              ]
            }
          }
        ]
      },
      "wafConfig": {
        "enableWAF": true
      }
    }
  ]
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-02-19	The internal configuration of the API is changed, but the call is not affected	View Change Details
2021-06-30	The request parameters of the API has changed	View Change Details
2021-06-30	The request parameters of the API has changed	View Change Details
2021-06-30	The request parameters of the API has changed	View Change Details