All Products
Search
Document Center

Function Compute:ListCustomDomains

Last Updated:Jun 02, 2023

Queries available custom domain names.

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

GET /2021-04-06/custom-domains

Request parameters

ParameterTypeRequiredDescriptionExample
prefixstringNo

The prefix that the returned domain names must contain.

prefix_text
startKeystringNo

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
nextTokenstringNo

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
limitintegerNo

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-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 returned result.

nextTokenstring

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
customDomainsobject []

The information about custom domain names.

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 configurations of the HTTPS certificate.

tlsConfigTLSConfig

The Transport Layer Security (TLS) configuration.

routeConfigRouteConfig

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

wafConfigWAFConfig

The Web Application Firewall (WAF) configuration.

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 timeSummary of changesOperation
2021-06-30The input parameters of the API operation change.
Change itemChange content
Input ParametersThe input parameters of the API operation change.
    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 input parameters of the API operation change.
Change itemChange content
Input ParametersThe input parameters of the API operation change.
    Added Input Parameters: X-Fc-Account-Id
2021-06-30The input parameters of the API operation change.
Change itemChange content
Input ParametersThe input parameters of the API operation change.
    delete Input Parameters: X-Fc-Account-Id