ListInstanceCatalog - 云平台配置检查资产和子资产列表

更新时间:
复制 MD 格式

云平台配置检查资产和子资产列表查询接口。

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

yundun-sas:ListInstanceCatalog

get

*全部资源

*

无 无

请求参数

名称

类型

必填

描述

示例值

Lang

string

否

请求和接收消息的语言类型。取值:

  • zh:中文

  • en:英文

枚举值:

  • en :

    en

  • zh :

    zh

zh

RegionId

string

否

要查询的实例所在地域的 ID。取值:

  • cn-hangzhou:中心

  • ap-southeast-1:新加坡

cn-hangzhou

Types

array

否

检查标准所属类型列表。

string

否

检查标准所属类型。取值:

  • RISK: 阿里云最佳安全实践

  • COMPLIANCE:CIS 合规

  • IDENTITY_PERMISSION:身份权限管理

RISK

StandardIds

array

否

标准 ID 列表。

integer

否

标准 ID 列表。

说明

您可调用 ListCheckStandard 接口获取标准 ID。

2

RequirementIds

array

否

条例 ID 列表。

integer

否

条例 ID 列表。

说明

您可调用 ListCheckStandard 接口获取条例 ID。

27

OnlyCustom

boolean

否

过滤支持自定义检查的资产。取值:

  • true:过滤支持自定义检查的资产。

  • false:所有检查资产,默认值。

true

TaskSources

array

否

任务来源列表。

string

否

任务来源。取值:

  • YAO_CHI:瑶池控制台。

YAO_CHI

返回参数

名称

类型

描述

示例值

object

GetCheckConfigResponse

RequestId

string

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

0D42A83F-CE33-5F54-A5AE-05DA39F59E1B

Vendors

array<object>

根据厂商分类的资产分类列表。

array<object>

根据厂商分类的资产分类。

Name

string

厂商类型名称。

ALIYUN

InstanceTypes

array<object>

资产类型列表。

array<object>

资产类型。

Name

string

资产类型名称。

ECS

InstanceSubTypes

array<object>

资产子类型列表。

object

资产子类型。

Name

string

资产子类型名称。

SECURITY_GROUP

Value

integer

资产子类型 ID。

1

Value

integer

资产类型 ID。取值:

  • 0:云服务器 ECS

  • 1:负载均衡

  • 3:云数据库 RDS

  • 4:云数据库 MongoDB 版

  • 5:云数据库 Tair(兼容 Redis)

  • 6:容器镜像服务

  • 8:容器服务 Kubernetes 版

  • 9:专有网络 VPC

  • 11:操作审计

  • 12:CDN

  • 13:数字证书管理服务(原 SSL 证书)

  • 14:云效

  • 15:访问控制

  • 16:DDoS 防护

  • 17:Web 应用防火墙

  • 18:对象存储

  • 19:云原生关系型数据库 PolarDB

  • 20:云数据库 PostgreSQL 版

  • 21:微服务引擎

  • 22:文件存储 NAS

  • 23:数据安全中心

  • 24:弹性公网 IP

  • 25:云身份服务-EIAM

  • 26:PolarDB-X

  • 27:Elasticsearch

15

Value

integer

厂商类型 ID。取值:

  • 0:阿里云资产

  • 1:云外资产

  • 2:IDC 资产

  • 3、4、5、7:其它云资产

  • 8:轻量级资产

0

示例

正常返回示例

JSON格式

{
  "RequestId": "0D42A83F-CE33-5F54-A5AE-05DA39F59E1B",
  "Vendors": [
    {
      "Name": "ALIYUN",
      "InstanceTypes": [
        {
          "Name": "ECS",
          "InstanceSubTypes": [
            {
              "Name": "SECURITY_GROUP",
              "Value": 1
            }
          ],
          "Value": 15
        }
      ],
      "Value": 0
    }
  ]
}

错误码

HTTP status code

错误码

错误信息

描述

500 ServerError ServerError 服务故障,请稍后重试!
403 NoPermission caller has no permission 当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作。

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

变更历史

更多信息,参考变更详情。