GetSite - Query site information | ESA API - Edge Security Acceleration

Retrieves the details of a site by its ID.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

esa:GetSite

get

*Site

acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

None

Request parameters

Parameter	Type	Required	Description	Example
SiteId	integer	Yes	The site ID. Call ListSites to obtain this value.	1234567890123

Response elements

Element	Type	Description	Example
	object	The response body.
RequestId	string	The request ID.	9732E117-8A37-49FD-A36F-ABBB87556CA7
SiteModel	object	The site details.
AccessType	string	The site access type. Valid values: NS: NS access. CNAME: CNAME access.	NS
CnameZone	string	The CNAME suffix for CNAME-access sites. Use this to configure the CNAME record.	example.cname.com
Coverage	string	The acceleration region. Valid values: domestic: Chinese mainland only global: Global overseas: Global (excluding the Chinese mainland)	domestic
CreateTime	string	The site creation time in UTC, in ISO 8601 format (`yyyy-MM-ddTHH:mm:ssZ`).	2023-12-24T02:01:11Z
UpdateTime	string	The last update time in UTC, in ISO 8601 format (`yyyy-MM-ddTHH:mm:ssZ`).	2023-12-24T02:01:11Z
InstanceId	string	The plan instance ID.	cas-merge-q6h0bv
NameServerList	string	Comma-separated name servers assigned to the site.	male1-1.ialicdn.com,female1-1.ialicdn.com
PlanName	string	The plan name.	plan-168777532****
PlanSpecName	string	The plan specification name.	normal
ResourceGroupId	string	The resource group ID.	rg-aek26g6i6se****
SiteId	integer	The site ID.	1234567890123
SiteName	string	The site name.	example.com
Status	string	The site status. Valid values: pending: Pending configuration. active: Active. offline: Offline. moved: Superseded.	pending
Tags	object	The site tags.	{"tag1":"value1"}
VerifyCode	string	The verification code. For CNAME-access sites, add this as a TXT record.	verify_d516cb3740f81f0cef77d162edd1****
VanityNSList	object	A map of custom name servers to their comma-separated IP addresses.
	string	The custom name server name.	ns1.example.com
VersionManagement	boolean	Whether version management is enabled.	true
OfflineReason	string	The offline reason. Returned only when `Status` is `offline`. Valid values: expiration_arrears: Plan expired or overdue payments. internally_disabled: Disabled by the system. missing_icp: Missing ICP license. content_violation: Content policy violation. proactively_disabled: Disabled by you or a configured usage limit.	expiration_ arrears

Examples

Success response

JSON format

{
  "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": "verify_d516cb3740f81f0cef77d162edd1****",
    "VanityNSList": {
      "key": "ns1.example.com"
    },
    "VersionManagement": true,
    "OfflineReason": "expiration_ arrears"
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InternalException	Failed to call the service. Try again later or contact technical support.	Failed to call the service. Try again later or contact technical support.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.