DescribeSite

Updated at:

Queries the site information.

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

hdr:DescribeSite

get

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

SiteId

string

Yes

The site ID.

si-000bzkmmlwh01trrecuw

Response elements

Element

Type

Description

Example

object

VpcId

string

The VPC ID.

vpc-bp1c3byhnaoj3u96sgk12

Type

string

The site type.

cloud

RequestId

string

The request ID.

B30A844D-E4CF-5382-A0D4-3DE76A8AD2AE

SiteId

string

The site ID.

si-000bzkmmlwh01trrecuw

UserSecurityGroupId

string

The user security group ID.

sg-bp1466glrmpqfsq4zpjs

Success

boolean

Indicates whether the request is successful.

True

ZoneId

string

The zone ID.

cn-shanghai-l

Code

string

The return code.

200

Message

string

The error message.

successful

Name

string

The site name.

SH

RegionId

string

The region ID of the site.

cn-shanghai

Examples

Success response

JSON format

{
  "VpcId": "vpc-bp1c3byhnaoj3u96sgk12",
  "Type": "cloud",
  "RequestId": "B30A844D-E4CF-5382-A0D4-3DE76A8AD2AE",
  "SiteId": "si-000bzkmmlwh01trrecuw",
  "UserSecurityGroupId": "sg-bp1466glrmpqfsq4zpjs",
  "Success": true,
  "ZoneId": "cn-shanghai-l",
  "Code": "200",
  "Message": "successful",
  "Name": "SH",
  "RegionId": "cn-shanghai"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.