ListCustomDomains - Function Compute - Alibaba Cloud Documentation Center

Queries custom domain names.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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	list	All Resources ``	none	none

Request syntax

GET /2023-03-30/custom-domains HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
prefix	string	No	The domain name prefix.	foo
nextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results.	MTIzNCNhYmM=
limit	integer	No	The number of custom domain names returned.	10

Response parameters

Parameter	Type	Description	Example
	ListCustomDomainOutput	The custom domain names.

Examples

Sample success responses

JSONformat

{
  "customDomains": [
    {
      "accountId": "",
      "apiVersion": "2023-03-30",
      "authConfig": {
        "authInfo": "{}",
        "authType": "anonymous, function, jwt"
      },
      "certConfig": {
        "certName": "my-cert",
        "certificate": "PEM format",
        "privateKey": "PEM format"
      },
      "createdTime": "2023-03-30T08:02:19Z",
      "domainName": "example.com",
      "lastModifiedTime": "2023-03-30T08:02:19Z",
      "protocol": "HTTP",
      "routeConfig": {
        "routes": [
          {
            "functionName": "myFunction",
            "methods": [
              "GET"
            ],
            "path": "/api/*",
            "qualifier": "myAlias",
            "rewriteConfig": {
              "equalRules": [
                {
                  "match": "/old",
                  "replacement": "/new"
                }
              ],
              "regexRules": [
                {
                  "match": "^/api/.+?/(.*)",
                  "replacement": "/api/v2/$1"
                }
              ],
              "wildcardRules": [
                {
                  "match": "/api/*",
                  "replacement": "/$1"
                }
              ]
            }
          }
        ]
      },
      "subdomainCount": "1",
      "tlsConfig": {
        "cipherSuites": [
          "TLS_RSA_WITH_RC4_128_SHA"
        ],
        "maxVersion": "TLSv1.3",
        "minVersion": "TLSv1.0"
      },
      "wafConfig": {
        "enableWAF": true
      }
    }
  ],
  "nextToken": "next_domain_name"
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-06-14	The API operation is not deprecated.	View Change Details
2024-02-22	The internal configuration of the API is changed, but the call is not affected	View Change Details
2023-08-30	API Description Update	View Change Details
2023-08-30	API Description Update. The response structure of the API has changed	View Change Details
2023-06-28	Add Operation	View Change Details