GetScheduledInstances - ApsaraDB RDS - Alibaba Cloud Documentation Center

Queries the IDs of all instances that are included by a specified scheduled inspection configuration.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
rdsai:GetScheduledInstances	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
ScheduledId	string	Yes	The ID of the scheduled inspection configuration.	847268a4-196f-416b-aa12-bfe0c115****
PageNumber	long	No	The page number. Pages start from 1. Default value: 1.	1
PageSize	long	No	The number of records on each page. Default value: 20. Maximum value: 100.	20

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
Success	boolean	Indicates whether the request was successful.	true
Message	string	The response message.
Instances	array<object>	The list of instances included in the inspection configuration.
Instance	object
InstanceId	string	The instance ID.	rm-2zep6e5u6l2yu****
InstanceDesc	string	The instance description.
EngineType	string	The engine type.	MySQL
Region	string	The region in which the instance resides.	cn-hangzhou
Status	string	The status of the instance.	Running
TotalCount	long	The total number of records that are returned.	20
PageNumber	long	The page number. Pages start from 1. Default value: 1.	1
PageSize	long	The number of records on each page. Default value: 20. Maximum value: 100.	10
RequestId	string	The request ID.	FE9C65D7-930F-57A5-A207-8C396329****

Examples

Sample success responses

JSONformat

{
  "Success": true,
  "Message": "",
  "Instances": [
    {
      "InstanceId": "rm-2zep6e5u6l2yu****",
      "InstanceDesc": "",
      "EngineType": "MySQL ",
      "Region": "cn-hangzhou",
      "Status": "Running"
    }
  ],
  "TotalCount": 20,
  "PageNumber": 1,
  "PageSize": 10,
  "RequestId": "FE9C65D7-930F-57A5-A207-8C396329****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	Request parameter validation failed.	Request parameter verification failed
403	PermissionDenied	User has no operation permission.	User has no operation permission
403	InvalidUserOrder	There is no valid order for this UID.	There is no valid order for this UID
404	TaskNotFound	The resource of the specified ld does not exist.	The resource of the specified ld does not exist.
500	InternalError	System internal exception.	System internal exception

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2026-02-05	Add Operation	View Change Details