All Products
Search
Document Center

Edge Security Acceleration:GetSite

Last Updated:Nov 07, 2025

Queries information about a website based on the website ID.

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
esa:GetSiteget
*Site
acs:esa:{#regionId}:{#accountId}:site/{#SiteId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
SiteIdlongYes

The website ID, which can be obtained by calling the ListSites operation.

1234567890123

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

9732E117-8A37-49FD-A36F-ABBB87556CA7
SiteModelobject

The queried website information.

AccessTypestring

The DNS setup option for the website. Valid values:

  • NS
  • CNAME
NS
CnameZonestring

The CNAME of the website domain. If you use CNAME setup when you add your website to ESA, the value is the CNAME that you configured then.

example.cname.com
Coveragestring

The service location. Valid values:

  • domestic: the Chinese mainland.
  • global: global.
  • overseas: outside the Chinese mainland.
domestic
CreateTimestring

The time when the WEBsite was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format and is displayed in UTC.

2023-12-24T02:01:11Z
UpdateTimestring

The time when the WEBsite was updated. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format and is displayed in UTC.

2023-12-24T02:01:11Z
InstanceIdstring

The plan ID.

cas-merge-q6h0bv
NameServerListstring

The nameservers assigned to the website domain. They are separated by commas (,).

male1-1.ialicdn.com,female1-1.ialicdn.com
PlanNamestring

The plan name.

plan-168777532****
PlanSpecNamestring

The specification of the plan associated with the website.

normal
ResourceGroupIdstring

The ID of your Alibaba Cloud resource group.

rg-aek26g6i6se****
SiteIdlong

The website ID.

1234567890123
SiteNamestring

The website name.

example.com
Statusstring

The website status. Valid values:

  • pending: The website is to be configured.
  • active: The website is active.
  • offline: The website is suspended.
  • moved: The website has been added and verified by another Alibaba Cloud account.
pending
Tagsobject

The tags of the website.

{"tag1":"value1"}
VerifyCodestring

The code that is used to verify the website domain ownership. As part of the verification TXT record, this parameter is returned for websites that use CNAME setup.

verify_d516cb3740f81f0cef77d162edd1****
VanityNSListobject

The information about custom nameservers of the website domain. The key is a custom nameserver name, and the value is the IP address of the custom nameserver. Multiple IP addresses are separated by commas (,).

string

The custom nameserver name.

ns1.example.com
VersionManagementboolean

The status of version management. If true is returned, version management is enabled for the website.

true

Examples

Sample success responses

JSONformat

{
  "RequestId": "9732E117-8A37-49FD-A36F-ABBB87556CA7",
  "SiteModel": {
    "AccessType": "NS",
    "CnameZone": "example.cname.com",
    "Coverage": "domestic",
    "CreateTime": "2023-12-24T02:01:11Z",
    "UpdateTime": "2023-12-24T02:01:11Z",
    "InstanceId": "cas-merge-q6h0bv",
    "NameServerList": "male1-1.ialicdn.com,female1-1.ialicdn.com",
    "PlanName": "plan-168777532****",
    "PlanSpecName": "normal",
    "ResourceGroupId": "rg-aek26g6i6se****",
    "SiteId": 1234567890123,
    "SiteName": "example.com",
    "Status": "pending",
    "Tags": {
      "tag1": "value1"
    },
    "VerifyCode": "\t\nverify_d516cb3740f81f0cef77d162edd1****",
    "VanityNSList": {
      "key": "ns1.example.com"
    },
    "VersionManagement": true
  }
}

Error codes

HTTP status codeError codeError messageDescription
400InternalExceptionFailed to call the service. Try again later or contact technical support.Failed to call the service. Try again later or contact technical support.

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

Change history

Change timeSummary of changesOperation
2025-02-18The Error code has changed. The response structure of the API has changedView Change Details
2024-09-18The Error code has changedView Change Details