全部产品
Search
文档中心

资源编排:GetResourceType - 查询资源类型的详细信息

更新时间:Jun 06, 2024

通过指定资源类型查询详细信息。

接口说明

本文将提供一个示例,查询资源类型ALIYUN::ROS::WaitConditionHandle的详细信息。

调试

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

授权信息

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

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

请求参数

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

资源类型。
关于 ROS 支持的资源类型,请参见资源类型索引

ALIYUN::ROS::WaitConditionHandle
VersionIdstring

版本 ID。如果要查询资源类型某个版本,请指定该参数。否则,查询资源类型。

说明 当前仅模块支持版本。
v1

关于公共请求参数的详情,请参见公共参数

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

A28FBA2E-B6B3-5822-AA45-AB875EF23641
Attributesobject

资源的返回值。

参见示例
ResourceTypestring

资源类型。

ALIYUN::ROS::WaitConditionHandle
Propertiesobject

资源的属性。

参见示例
SupportDriftDetectionboolean

该资源是否支持偏差检测。取值:

  • true:支持。

  • false:不支持。

false
SupportScratchDetectionboolean

该资源是否支持资源场景。取值:

  • true:支持。

  • false:不支持。

false
EntityTypestring

实体类型。取值:

  • Resource:普通资源类型。更多信息,请参见资源

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

  • Module:模块。

Resource
Providerstring

资源类型提供者。取值:

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

资源类型描述。

It is a demo.
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
TotalVersionCountinteger

版本总数。

说明 仅查询资源类型时返回。
10
IsDefaultVersionboolean

是否默认版本。取值:

  • true:是默认版本。
  • false:不是默认版本。
说明 仅查询资源类型版本时返回。
true
TemplateBodystring

模块的模板内容。

说明 仅查询资源类型版本时返回。
{"ROSTemplateFormatVersion":"2015-09-01"}

示例

正常返回示例

JSON格式

{
  "RequestId": "A28FBA2E-B6B3-5822-AA45-AB875EF23641",
  "Attributes": {
    "test": "test",
    "test2": 1
  },
  "ResourceType": "ALIYUN::ROS::WaitConditionHandle",
  "Properties": {
    "test": "test",
    "test2": 1
  },
  "SupportDriftDetection": false,
  "SupportScratchDetection": false,
  "EntityType": "Resource",
  "Provider": "ROS",
  "Description": "It is a demo.",
  "DefaultVersionId": "v1",
  "LatestVersionId": "v10",
  "CreateTime": "2023-02-24T08:25:21\n",
  "UpdateTime": "2023-02-24T08:25:21\n",
  "TotalVersionCount": 10,
  "IsDefaultVersion": true,
  "TemplateBody": "{\"ROSTemplateFormatVersion\":\"2015-09-01\"}"
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-05-10OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:VersionId
出参OpenAPI 返回结构发生变更
2022-01-18OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
HttpCode错误码错误信息描述
404ResourceTypeNotFoundThe Resource Type ({name}) could not be found.资源类型不存在。name 为资源类型名。