ListBotInstances - Edge Security Acceleration - Alibaba Cloud Documentation Center

Queries the list of Bot security 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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

GET  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
SortBy	string	No	The field by which to sort the results. By default, the results are sorted by purchase time. Valid values: CreateTime: purchase time. ExpireTime: expiration time.	CreateTime
SortOrder	string	No	The sort order. Default value: desc. Valid values: asc: ascending order. desc: descending order.	desc
PageNumber	integer	No	The page number for the paged query. Settings this parameter for paging. Default value: 1. Valid values: 1 to 100000.	1
PageSize	integer	No	The number of entries per page for the paged query. This parameter is used for paging. Valid values: 1 to 500.	20
Status	string	No	The instance status. Valid values: online: The instance is running normally. offline: The instance has expired but has not exceeded the retention period and is unavailable. disable: The instance has been released. overdue: The instance has an overdue payment.	online
InstanceId	string	No	The instance ID. You can call the ListSites operation to obtain the ID.	sp-xcdn-96wblslz****

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	509FD5AF-AB5B-55A9-9568-38D98668E3AB
InstanceInfo	array<object>	The instances that match the specified conditions under the current account.
	object	The instance details.
InstanceId	string	The instance ID.	sp-xcdn-96wblslz****
CreateTime	string	The time when the instance was purchased. The time is in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2024-04-12T05:41:51Z
Status	string	The instance status. Valid values: online: The instance is running normally. offline: The instance has expired but has not exceeded the retention period and is unavailable. disable: The instance has been released. overdue: The instance has been stopped due to an overdue payment.	online
BotInstanceLevel	string	The Bot protection instance level. If this parameter is empty, the plan does not include a Bot protection instance. If a value is returned, the plan includes a Bot protection instance. Valid values: enterprise_bot: web edition. enterprise_bot_with_app: app edition.	enterprise_bot
SiteInstanceId	string	The ID of the associated site plan instance.	esa-site-b0s6kmx0r0n4
ReserveReleaseTime	string	The scheduled release time. The time is in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2026-03-25T16:00:00Z
PageNumber	integer	The current page number, which is the same as the PageNumber request parameter.	1
PageSize	integer	The number of entries per page.	20
TotalCount	integer	The total number of entries.	0
TotalPage	integer	The total number of pages.	0

Examples

Success response

JSON format

{
  "RequestId": "509FD5AF-AB5B-55A9-9568-38D98668E3AB",
  "InstanceInfo": [
    {
      "InstanceId": "sp-xcdn-96wblslz****",
      "CreateTime": "2024-04-12T05:41:51Z",
      "Status": "online",
      "BotInstanceLevel": "enterprise_bot",
      "SiteInstanceId": "esa-site-b0s6kmx0r0n4",
      "ReserveReleaseTime": "2026-03-25T16:00:00Z"
    }
  ],
  "PageNumber": 1,
  "PageSize": 20,
  "TotalCount": 0,
  "TotalPage": 0
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The specified parameter is invalid.	The specified parameter is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.