GetScheduledInstances - 查询指定定时巡检配置中包含的所有实例ID列表。-云数据库 RDS(RDS)-阿里云帮助中心

查询指定定时巡检配置中包含的所有实例ID列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

rdsai:GetScheduledInstances

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
ScheduledId	string	是	定时巡检配置 ID。	847268a4-196f-416b-aa12-bfe0c115****
PageNumber	integer	否	页码，默认为 1。	1
PageSize	integer	否	每页数量，默认为 20，最大 100。	20

返回参数

名称	类型	描述	示例值
	object	Schema of Response
Success	boolean	请求结果。	true
Message	string	返回信息。	获取巡检实例ID列表成功
Instances	array<object>	实例列表。
	object
InstanceId	string	实例 ID。	rm-2zep6e5u6l2yu****
InstanceDesc	string	实例描述。	巡检测试实例。
EngineType	string	引擎类型。	MySQL
Region	string	实例所在地域。	cn-hangzhou
Status	string	实例状态。	Running
TotalCount	integer	总记录数。	20
PageNumber	integer	页码，默认为 1。	1
PageSize	integer	每页数量，默认为 20，最大 100。	10
RequestId	string	请求 ID。	FE9C65D7-930F-57A5-A207-8C396329****

示例

正常返回示例

JSON格式

{
  "Success": true,
  "Message": "获取巡检实例ID列表成功",
  "Instances": [
    {
      "InstanceId": "rm-2zep6e5u6l2yu****",
      "InstanceDesc": "巡检测试实例。",
      "EngineType": "MySQL ",
      "Region": "cn-hangzhou",
      "Status": "Running"
    }
  ],
  "TotalCount": 20,
  "PageNumber": 1,
  "PageSize": 10,
  "RequestId": "FE9C65D7-930F-57A5-A207-8C396329****"
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParameter	%s.	请求参数校验失败，具体原因见返回消息。
400	InvalidRequest.Format	The request body must be a non-empty JSON object.	请求体必须为非空 JSON 对象。
400	InvalidUserIdentity.Missing	The authenticated caller identity is missing.	缺少已认证的调用方身份信息。
400	MissingParameter	A required inspection parameter is missing.	缺少必填的巡检参数。
400	InvalidTaskParameter.Value	An inspection task identifier is invalid.	巡检任务标识参数无效。
400	InvalidPagination.Value	PageNumber or PageSize is outside the supported range.	PageNumber 或 PageSize 超出支持范围。
500	InternalError	System internal exception.	系统内部异常
403	PermissionDenied	User has no operation permission.	用户无操作权限
403	InvalidUserOrder	There is no valid order for this UID.	该UID并没有有效订单
404	TaskNotFound	The resource of the specified ld does not exist.	指定ld的资源不存在

访问错误中心查看更多错误码。

调试

授权信息

请求参数

返回参数

示例

错误码

变更历史