All Products
Search
Document Center

API Gateway:GetDomain

Last Updated:Dec 17, 2025
This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Queries the information about a domain name.

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.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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.
OperationAccess levelResource typeCondition keyAssociated operation
apig:GetDomainget
*Domain
acs:apig:{#regionId}:{#accountId}:domain/{#DomainId}
    none
none

Request syntax

GET /v1/domains/{domainId} HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
domainIdstringYes

The ID of the domain name.

d-cpqnfn5lhtgqbga95sv1
withStatisticsbooleanNo

Specifies whether to return online resource information.

true

Response parameters

ParameterTypeDescriptionExample
object

The struct returned.

requestIdstring

The request ID, which is used to trace the API call link.

3ACFC7A7-45A9-58CF-B2D5-765B60254695
dataobject

The data returned.

domainIdstring

The ID of the domain name.

d-cq1m3utlhtgvgkv7sitg
namestring

The domain name.

abc.com
protocolstring

The supported protocol. Valid values:

  • HTTP: Only HTTP is supported.
  • HTTPS: Only HTTPS is supported.
HTTP
createFromstring

The creation source.

Valid values:

  • Console
  • Ingress
Console
forceHttpsboolean

Indicates whether forcible HTTPS redirection is enabled.

false
certIdentifierstring

The certificate ID.

645****-cn-hangzhou
caCertIdentifierstring

The CA certificate ID.

876****-cn-hangzhou
defaultboolean

Indicates whether the domain name is the default domain name.

false
http2Optionstring

The HTTP/2 configuration.

Valid values:

  • GlobalConfig
  • Close
  • Open
Open
tlsMaxstring

The maximum version of the TLS protocol. Up to TLS 1.3 is supported.

TLS 1.3
tlsMinstring

The minimum version of the TLS protocol. Down to TLS 1.0 is supported.

TLS 1.0
createTimestamplong

The creation timestamp.

1719386834548
updatetimestamplong

The update timestamp.

1719386834548
certNamestring

The certificate name.

test-cert
sansstring

All domain names that are bound to the certificate.

aliyun.com
notAfterTimstamplong

The expiration time of the certificate.

1719386834548
notBeforeTimestamplong

The time when the certificate started to take effect.

1719386834548
algorithmstring

The encryption algorithm.

RSA
issuerstring

The certificate issuer.

Alibaba
resourceGroupIdstring

The resource group ID.

rg-aekzvlxzgo5b4si
statisticsInfoobject

The information about online resources.

totalCountstring

The total number of resources.

1
resourceStatisticsarray

The resource statistics.

resourceStatisticResourceStatistic

The resource statistics.

tlsCipherSuitesConfigTlsCipherSuitesConfig

The cipher suite configuration.

mTLSEnabledboolean

Indicates whether mutual authentication is enabled.

Valid values:

  • false
  • true
false
clientCACertstring

The client CA certificate.

-----BEGIN CERTIFICATE----- xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/mpTQwDQYJKoZIhvcNAQEL BxSbrGeJ8i0576Gn7Qezyho9abZOUhGaPeoB AIHWWl428uUSG/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy+ZMJ8r4swA4swHwYDVR0jBBgwFoAU qroVyYKk7ylhcSn+ZMJ8r4swA4swDwYDVR0TAQH/BAUwAwEB/zANBgkqhkiG9w0B xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx= -----END CERTIFICATE-----
codestring

The status code returned.

Ok
messagestring

The response message returned.

success

Examples

Sample success responses

JSONformat

{
  "requestId": "3ACFC7A7-45A9-58CF-B2D5-765B60254695",
  "data": {
    "domainId": "d-cq1m3utlhtgvgkv7sitg",
    "name": "abc.com",
    "protocol": "HTTP",
    "createFrom": "Console",
    "forceHttps": false,
    "certIdentifier": "645****-cn-hangzhou",
    "caCertIdentifier": "876****-cn-hangzhou",
    "default": false,
    "http2Option": "Open",
    "tlsMax": "TLS 1.3",
    "tlsMin": "TLS 1.0\n",
    "createTimestamp": 1719386834548,
    "updatetimestamp": 1719386834548,
    "certName": "test-cert",
    "sans": "aliyun.com",
    "notAfterTimstamp": 1719386834548,
    "notBeforeTimestamp": 1719386834548,
    "algorithm": "RSA",
    "issuer": "Alibaba",
    "resourceGroupId": "rg-aekzvlxzgo5b4si",
    "statisticsInfo": {
      "totalCount": 1,
      "resourceStatistics": [
        {
          "resourceType": "HttpApi",
          "resourceCount": 10
        }
      ]
    },
    "tlsCipherSuitesConfig": {
      "configType": "Default",
      "tlsCipherSuite": [
        {
          "name": "ECDHE-ECDSA-AES256-GCM-SHA384",
          "supportVersions": [
            "TLS 1.2"
          ]
        }
      ]
    },
    "mTLSEnabled": false,
    "clientCACert": "-----BEGIN CERTIFICATE-----\nxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/mpTQwDQYJKoZIhvcNAQEL\nBxSbrGeJ8i0576Gn7Qezyho9abZOUhGaPeoB\nAIHWWl428uUSG/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\nyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy+ZMJ8r4swA4swHwYDVR0jBBgwFoAU\nqroVyYKk7ylhcSn+ZMJ8r4swA4swDwYDVR0TAQH/BAUwAwEB/zANBgkqhkiG9w0B\nxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx=\n-----END CERTIFICATE-----"
  },
  "code": "Ok",
  "message": "success"
}

Error codes

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

Change history

Change timeSummary of changesOperation
2025-02-27The response structure of the API has changedView Change Details
2025-01-13The response structure of the API has changedView Change Details
2024-11-28The response structure of the API has changedView Change Details
2024-11-20The response structure of the API has changedView Change Details
2024-11-01The request parameters of the API has changed. The response structure of the API has changedView Change Details