GetInspectionReport - 获取该巡检报告的具体内容

更新时间:
复制 MD 格式

通过巡检报告ID获取该巡检报告的具体内容。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

rdsai:GetInspectionReport

get

*全部资源

*

请求语法

POST  HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

TaskId

string

巡检报告 ID。

9d246af2-a0cd-4f69-857d-3785048f****

InstanceId

string

巡检实例,如果不传入则返回整个报告,如果传入则只返回该实例的内容部分。

rm-2zep6e5u6l2yu****

ReportType

string

返回参数

名称

类型

描述

示例值

object

Schema of Response

TaskId

string

巡检报告 ID。

9d246af2-a0cd-4f69-857d-3785048f****

MarkdownText

string

Markdown 文本。

# RDS批量巡检汇总报告\n\n> 本次批量巡检共检查 **1** 个实例;发现 **1** 个实例存在警告(共 1 项警告)……

Data

array<object>

结果详情。

array<object>

对象信息。

InstanceId

string

实例 ID。

rm-2zep6e5u6l2yu****

EngineType

string

引擎类型。

MySQL

InstanceDesc

string

实例描述。

测试实例

Region

string

地域信息。

cn-beijing

MarkdownText

string

Markdown 文本。

  • 如果入参 InstanceId 未填写:将返回该巡检报告下所有实例的报告(但 MarkdownText 字段为空 "")。

  • 如果入参 InstanceId 已填写:将返回该实例的报告,且 MarkdownText 字段会返回具体内容。

# RDS实例巡检报告\n\n**实例ID**: `rm-2zep6e5u6l2yu****`\n\n**引擎类型**: MySQL\n\n**地域**: cn-beijing\n\n**时间范围(UTC)**: 2026-02-04T03:31:00Z ~ 2026-02-05T03:31:00Z\n\n> 本次巡检共包含 **60** 项检查,其中 1项警告、57项正常、2项数据获取失败。……

StartTime

string

巡检开始时间(格式:YYYY-MM-DDTHH:mm:ssZ)。

2025-11-06T16:00:00Z

EndTime

string

巡检结束时间(格式:YYYY-MM-DDTHH:mm:ssZ)。

2026-01-31T02:05:04Z

LevelSummary

object

层级摘要。

Normal

integer

正常。

10

Warning

integer

警告。

1

Error

integer

错误。

2

Failed

integer

失败。

3

Data

array<object>

请求结果。

array<object>

对象。

Group

string

分组 ID。

instance_info

Items

array<object>

分拆项名称。

array<object>

对象信息。

Name

string

类目的名称。

instance_runningstatus

Message

string

结果信息。

实例运行状态正常

Level

string

报警级别。

Normal

Data

array<object>

请求结果。

object

对象信息。

Key

string

标签键。

DBInstanceStatus

Value

string

标签的值。

Running

RequestId

string

请求 Id。

FE9C65D7-930F-57A5-A207-8C396329****

TemplateId

string

TemplateName

string

示例

正常返回示例

JSON格式

{
  "TaskId": "9d246af2-a0cd-4f69-857d-3785048f****",
  "MarkdownText": "# RDS批量巡检汇总报告\\n\\n> 本次批量巡检共检查 **1** 个实例;发现 **1** 个实例存在警告(共 1 项警告)……",
  "Data": [
    {
      "InstanceId": "rm-2zep6e5u6l2yu****",
      "EngineType": "MySQL",
      "InstanceDesc": "测试实例",
      "Region": "cn-beijing",
      "MarkdownText": "# RDS实例巡检报告\\n\\n**实例ID**: `rm-2zep6e5u6l2yu****`\\n\\n**引擎类型**: MySQL\\n\\n**地域**: cn-beijing\\n\\n**时间范围(UTC)**: 2026-02-04T03:31:00Z ~ 2026-02-05T03:31:00Z\\n\\n> 本次巡检共包含 **60** 项检查,其中 1项警告、57项正常、2项数据获取失败。……",
      "StartTime": "2025-11-06T16:00:00Z",
      "EndTime": "2026-01-31T02:05:04Z",
      "LevelSummary": {
        "Normal": 10,
        "Warning": 1,
        "Error": 2,
        "Failed": 3
      },
      "Data": [
        {
          "Group": "instance_info",
          "Items": [
            {
              "Name": "instance_runningstatus",
              "Message": "实例运行状态正常",
              "Level": "Normal",
              "Data": [
                {
                  "Key": "DBInstanceStatus",
                  "Value": "Running"
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "RequestId": "FE9C65D7-930F-57A5-A207-8C396329****",
  "TemplateId": "",
  "TemplateName": ""
}

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidParameter Request parameter validation failed. 请求参数校验失败
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的资源不存在

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

变更历史

更多信息,参考变更详情