DescribeWebsiteInstance-AI Guardrails(AI Guardrails)-阿里云帮助中心

Queries site detection instances.

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

yundun-greenweb:DescribeWebsiteInstance

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SourceIp	string	No	The source IP address.	183.63.***.131
Lang	string	No	The language type.	zh
TotalCount	integer	No	The total count.	10
PageSize	integer	No	The page size.	10
CurrentPage	integer	No	The current page number.	1
InstanceId	string	No	The instance ID.	cdisitecheck-cn-nif20glmz001

Response elements

Element	Type	Description	Example
	object
CurrentPage	integer	The current page number.	1
RequestId	string	The request ID.	AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE****
PageSize	integer	The page size.	10
TotalCount	integer	The total count.	1
WebsiteInstanceList	array<object>	The list of website instances.
	object
Status	string	The status of the website service. Valid values: normal: Normal. financiallocked: Financial lock.	normal
Domain	string	The website domain name.	nfnews.com
IndexPage	string	The homepage address.	xx
ExpiredTime	string	The expiration time. The value is a UNIX timestamp in milliseconds.	1716393600000
WebsiteScanInterval	integer	The website scan interval. Unit: seconds.	1
Protocol	string	The protocol type.	TCP
BuyTime	string	The purchase time. The value is in the YYYY-MM-DD HH:mm:ss format (default time zone: UTC+08:00).	2023-10-25 15:59:17 +0800
InstanceId	string	The instance ID.	cdisitecheck-cn-nif20glmz001
IndexPageScanInterval	integer	The homepage scan interval. Unit: seconds.	1

Examples

Success response

JSON format

{
  "CurrentPage": 1,
  "RequestId": "AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE****",
  "PageSize": 10,
  "TotalCount": 1,
  "WebsiteInstanceList": [
    {
      "Status": "normal",
      "Domain": "nfnews.com",
      "IndexPage": "xx",
      "ExpiredTime": "1716393600000",
      "WebsiteScanInterval": 1,
      "Protocol": "TCP",
      "BuyTime": "2023-10-25 15:59:17 +0800\n",
      "InstanceId": "cdisitecheck-cn-nif20glmz001",
      "IndexPageScanInterval": 1
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.