All Products
Search
Document Center

Function Compute:GetCustomDomain

Last Updated:Jun 02, 2023

Queries the information about a custom domain name.

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

GET /2021-04-06/custom-domains/{domainName}

Request parameters

ParameterTypeRequiredDescriptionExample
domainNamestringYes

The domain name.

example.com
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.

r4isu4sls****

Response parameters

ParameterTypeDescriptionExample
object

The returned data.

domainNamestring

The domain name.

example.com
accountIdstring

The ID of your Alibaba Cloud account.

2016-08-15
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
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

{
  "domainName": "example.com",
  "accountId": "2016-08-15\t",
  "protocol": "HTTP",
  "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
2022-11-28The internal configurations of the API operation change but you can still call the operation.
Change itemChange content
The internal configurations of the API operation change but you can still call the operation.
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