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

Queries website scan results.

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:DescribeWebsiteScanResult

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SourceIp	string	No	The IP address of the access source.	140.***.11.250
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
SubServiceModule	string	Yes	The description of the submodule.	website_index_page
Label	string	No	The label.	abuse
Domain	string	No	The domain name.	nfnews.com
SiteUrl	string	No	The site URL.	nfnews.com
HandleStatus	string	No	The handling status.	xx

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.	0
WebsiteScanResultList	array<object>	The list of website scan results.
	object
ScanTime	string	The scan time in the format of YYYY-MM-DD HH:mm:ss (default time zone: UTC+08:00).	2023-10-25 15:59:17 +0800
Domain	string	The website domain name.	nfnews.com
SourceRiskCount	integer	The number of source websites.	1
ImageRiskCount	integer	The probability that images on the current page contain risky content.	1
Url	string	The access URL of the website.	https://www.xxx.com
TextRiskCount	integer	The number of text entries with a high risk level.	1
HandleStatus	integer	The handling status. Valid values: - 0: unhandled. - 1: handled.	0
InstanceId	string	The instance ID.	cdisitecheck-cn-nif20glmz001
TaskId	string	The task ID.	xx
Id	integer	The primary key ID.	1480
Labels	array	The labels.
	string	The labels.	sapm

Examples

Success response

JSON format

{
  "CurrentPage": 1,
  "RequestId": "AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE****\n",
  "PageSize": 10,
  "TotalCount": 0,
  "WebsiteScanResultList": [
    {
      "ScanTime": "2023-10-25 15:59:17 +0800\n",
      "Domain": "nfnews.com",
      "SourceRiskCount": 1,
      "ImageRiskCount": 1,
      "Url": "https://www.xxx.com",
      "TextRiskCount": 1,
      "HandleStatus": 0,
      "InstanceId": "cdisitecheck-cn-nif20glmz001",
      "TaskId": "xx",
      "Id": 1480,
      "Labels": [
        "sapm"
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.