全部产品
Search
文档中心

资源编排:ListResourceTypes - 查询支持的资源类型列表

更新时间:Jun 06, 2024

查询支持的资源类型列表。

接口说明

本文将提供一个示例,查询 ROS 支持的普通资源类型列表。

调试

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

授权信息

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

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

请求参数

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

实体类型。取值:

  • All:所有资源类型。

  • Resource(默认值):普通资源类型。更多信息,请参见资源

  • DataSource:数据源资源类型。更多信息,请参见数据源资源

  • Module:模块。

Resource
Providerstring

资源类型提供者。取值:

  • ROS(默认值):资源编排服务。
  • Self:用户自己。
ROS
ResourceTypestring

资源类型。支持大小写字母、数字、冒号、星号。若使用星号则为模糊匹配。

MODULE::MyOrganization::MyService::MyUsecase

返回参数

名称类型描述示例值
object
ResourceTypesarray

资源类型数组。

string

资源类型数组。

["ALIYUN::ECS::Instance","ALIYUN::RDS::Instance"]
RequestIdstring

请求 ID。

EA00860C-ECAF-5253-A1F9-8198695A7157
ResourceTypeSummariesobject []

资源类型摘要列表。

Providerstring

资源类型提供者。取值:

  • ROS:资源编排服务。
  • Self:用户自己。
ROS
EntityTypestring

实体类型。取值:

  • Resource:普通资源类型。
  • DataSource:数据源资源类型。
  • Module:模块。
Module
ResourceTypestring

资源类型。

MODULE::MyOrganization::MyService::MyUsecase
DefaultVersionIdstring

默认版本 ID。

v1
LatestVersionIdstring

最新版本 ID。

v10
CreateTimestring

创建时间,按照 ISO8601 标准表示,并需要使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ss。

2023-02-24T08:25:21
UpdateTimestring

更新时间,按照 ISO8601 标准表示,并需要使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ss。

2023-02-24T08:25:21
Descriptionstring

资源类型描述。

It is a demo.
TotalVersionCountinteger

版本数量。

10

示例

正常返回示例

JSON格式

{
  "ResourceTypes": [
    "[\"ALIYUN::ECS::Instance\",\"ALIYUN::RDS::Instance\"]"
  ],
  "RequestId": "EA00860C-ECAF-5253-A1F9-8198695A7157",
  "ResourceTypeSummaries": [
    {
      "Provider": "ROS",
      "EntityType": "Module",
      "ResourceType": "MODULE::MyOrganization::MyService::MyUsecase",
      "DefaultVersionId": "v1",
      "LatestVersionId": "v10",
      "CreateTime": "2023-02-24T08:25:21",
      "UpdateTime": "2023-02-24T08:25:21",
      "Description": "It is a demo.",
      "TotalVersionCount": 10
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-05-10OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:Provider
    新增入参:ResourceType
出参OpenAPI 返回结构发生变更
2022-01-18OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:EntityType

访问公共错误码查看更多错误码。