文档

GetCheckDetail - 获取检查项详情

更新时间:

获取云平台配置检查项详情。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-sas:GetCheckDetailget
  • 全部资源
    *

请求参数

名称类型必填描述示例值
CheckIdlong

检查项的 ID。

2
Langstring

设置请求和接收消息的语言类型,默认为 zh。取值:

  • zh:中文
  • en:英文
en
RegionIdstring

实例所在的地域的 ID。

cn-hangzhou

返回参数

名称类型描述示例值
object

GetCheckDetailResponse

Descriptionobject

检查项的描述。

Typestring

描述类型,固定值为 text。

text
Valuestring

检查项的描述的具体信息。

The MSE instance does not enable authentication by default. If public network access is enabled at the same time, the data in the configuration center may be dragged and there is a security risk.
Solutionobject

检查项风险的解决方案。

Typestring

检查项风险的解决方案类型。取值:

  • text:文本
  • link:链接
text
Valuestring

检查项风险的解决方案类型为 text 时的文本内容。

Enter the MSE product console - registration and configuration center - instance list, click the corresponding instance name to enter the instance details, find the public network whitelist setting option in the basic information, and configure the whitelist according to business needs. It is forbidden to configure 0.0.0.0 or the whitelist as null.
AssistInfoobject

检查项帮助信息。

Typestring

检查项风险的帮助信息类型。取值:

  • text:文本
  • link:链接
text
Valuestring

检查项风险的帮助信息类型为 text 时的文本内容。

Configure an IP address whitelist
RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

15A6ED6A-DBFE-5255-A248-289907809BEC
CustomConfigsarray<object>

检查项自定义配置项列表。

CustomConfigsobject
Namestring

检查项自定义配置项名称,同检查项唯一。

SessionTimeMax
TypeDefinestring

检查项自定义配置项类型 JSON 字符串。

{\"type\":\"NUMBER\",\"range\":[1,24]}
DefaultValuestring

检查项自定义配置项默认值字符串。

12
Valuestring

检查项自定义配置项用户配置值字符串。

11
ShowNamestring

检查项自定义配置项国际化名称。

Maximum session time
RepairResetdeprecatedstring

注意 该参数已废弃

true
RepairSupportTypedeprecatedinteger

注意 该参数已废弃

1
RepairSettingobject

检查项修复设置具体信息。

RepairSupportboolean

该检查项支持的是否支持修复功能:

  • true:是
  • false:否
true
RepairSupportTypeinteger

该检查项支持修复的类型:

  • 1: 支持修复并支持回滚操作
  • 2: 修复不支持回滚
  • 3: 跳转到第三方平台操作
1
RepairResetboolean

该检查项支持的修复功能修复后是否重启:

  • true:重启
  • false: 不需要重启
true
RepairConfigsarray<object>

检查项修复支持的入参配置信息。

RepairConfigsobject
Namestring

检查项自定义修复参数名称,同检查项唯一。

navicat
TypeDefinestring

检查项自定义配置项类型 JSON 字符串。

{\"type\":\"NUMBER\",\"range\":[1,24]}
DefaultValuestring

检查项修复配置参数的默认值字符串。

1
Valuestring

用户配置的检查项修复参数字符串值。

2
ShowNamestring

用户修复参数配置的展示名称。

port
FlowIdstring

修复配置流程对应的 ID。

64312d3ee19d470a9b54393dab****
CustomFlagboolean

该修复参数是否支持用户自定义配置:

  • true:支持
  • false:不支持
true
ExclusiveNamearray

与该参数不兼容的其他修复配置参数的数组。

exclusiveNamestring

与该参数不兼容的其他修复配置参数,无法同时配置。

["port"]
ConsoleParamTypestring

参数类型是否在控制台展示:

  • 0:展示回滚以及实时资产的参数值
  • 1:只展示资产的对应参数实时值
  • 2:不在控制台显示
0
DataTransformTypestring

数据是否加密:

  • 0:不需要加密
  • 1:需要加密传输
  • 2:需要加密传输,并且需要用户二次确认
1
UsageTypestring

参数的使用类型:

  • 1:修复时需要的资产参数
  • 2:修复时需要用户传输的参数
  • 3:临时用户传入的参数
1
EmptyParamSwitchstring

该参数用户是否需要填写

  • 0:参数有默认值
  • 1:参数无默认值,用户需要填写
  • 2:该参数可以为空
1
FlowSteparray<object>

修复流程说明。

flowStepobject
Stepstring

修复的流程步骤序号。

1
ShowTextstring

修复流程步骤的说明文本。

The first step is to open the calling interface.

示例

正常返回示例

JSON格式

{
  "Description": {
    "Type": "text",
    "Value": "The MSE instance does not enable authentication by default. If public network access is enabled at the same time, the data in the configuration center may be dragged and there is a security risk.",
    "Link": "https://www.alibabacloud.com/help/en/object-storage-service/latest/tutorial-implement-data-sharing-across-departments-based-on-bucket-policies"
  },
  "Solution": {
    "Type": "text",
    "Value": "Enter the MSE product console - registration and configuration center - instance list, click the corresponding instance name to enter the instance details, find the public network whitelist setting option in the basic information, and configure the whitelist according to business needs. It is forbidden to configure 0.0.0.0 or the whitelist as null.",
    "Link": "https://www.alibabacloud.com/help/en/object-storage-service/latest/tutorial-implement-data-sharing-across-departments-based-on-bucket-policies"
  },
  "AssistInfo": {
    "Type": "text",
    "Value": "Configure an IP address whitelist",
    "Link": "https://www.alibabacloud.com/help/en/resource-access-management/latest/faq-about-ram-users"
  },
  "RequestId": "15A6ED6A-DBFE-5255-A248-289907809BEC",
  "CustomConfigs": [
    {
      "Name": "SessionTimeMax",
      "TypeDefine": "{\\\"type\\\":\\\"NUMBER\\\",\\\"range\\\":[1,24]}",
      "DefaultValue": "12",
      "Value": "11",
      "ShowName": "Maximum session time\n"
    }
  ],
  "RepairReset": "true",
  "RepairSupportType": 1,
  "RepairSetting": {
    "RepairSupport": true,
    "RepairSupportType": 1,
    "RepairReset": true,
    "RepairConfigs": [
      {
        "Name": "navicat",
        "TypeDefine": "{\\\"type\\\":\\\"NUMBER\\\",\\\"range\\\":[1,24]}\n",
        "DefaultValue": "1",
        "Value": "2",
        "ShowName": "port",
        "FlowId": "64312d3ee19d470a9b54393dab****",
        "CustomFlag": true,
        "ExclusiveName": [
          "[\"port\"]"
        ],
        "ConsoleParamType": "0",
        "DataTransformType": "1",
        "UsageType": "1",
        "EmptyParamSwitch": "1"
      }
    ],
    "FlowStep": [
      {
        "Step": "1",
        "ShowText": "The first step is to open the calling interface."
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
403NoPermissioncaller has no permission当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作。
500ServerErrorServerError服务故障,请稍后重试!

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

变更历史

变更时间变更内容概要操作
2024-06-21OpenAPI 返回结构发生变更查看变更详情
2024-04-29OpenAPI 返回结构发生变更查看变更详情
2023-01-11OpenAPI 描述信息更新、OpenAPI 去除了 deprecated 标记查看变更详情
2022-07-22新增 OpenAPI查看变更详情