GetResourceType - 查询资源类型的详情

更新时间:
复制 MD 格式

获取资源元数据。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求语法

GET /api/v1/providers/{provider}/products/{product}/resourceTypes/* HTTP/1.1

路径参数

名称

类型

必填

描述

示例值

requestPath

string

请求路径。格式为: /api/v1/providers/{provider}/products/{product}/resourceTypes/{resourceType}

请求路径中变量说明:

provider: 云厂商,目前只支持 Aliyun。

product: 产品 Code。

resourceType: 资源类型。有父资源时,格式为{父资源类型 code}/{资源类型 code}

No parent resource: /api/v1/providers/Aliyun/products/Redis/resourceTypes/DBInstance Has parent resource: /api/v1/providers/Aliyun/products/Redis/resourceTypes/DBInstance/Account

请求参数

名称

类型

必填

描述

示例值

x-acs-accept-language

string

选择返回产品的语言。

zh_CH:中文 (默认)

en_US:英文。

枚举值:

  • zh_CH :

    zh_CH

  • en_US :

    en_US

zh_CH

返回参数

名称

类型

描述

示例值

object

返回结构。

requestId

string

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

resourceType

object

资源类型。

No parent resource: Instance Has parent resource: DBInstance/Account

createOnlyProperties

array

创建操作私有参数集合。资源查询操作中不会返回的属性,但是创建操作中需要传入的参数。

string

创建操作私有参数。

/properties/AutoRenew

deleteOnlyProperties

array

删除操作私有参数集合。资源查询操作中不会返回的属性,但是删除操作中需要传入的参数。

string

删除操作私有参数。

/properties/ForceDelete

filterProperties

array

list 操作时可以作为 filter 参数的属性集合。

string

filter 参数。

/properties/ResourceGroupId

getOnlyProperties

array

查询操作私有参数集合。资源查询操作中不会返回的属性,但是查询操作中需要传入的参数。

string

查询操作私有参数。

/properties/DryRun

getResponseProperties

array

查询返回的属性集合。

string

查询返回的属性。

/properties/NetworkInterfaces/items/properties/IpvSets

handlers

object

支持的资源操作信息(包括 RAM 权限)。

create

object

创建操作关联信息。

permissions

array

所需 RAM 权限信息集合。

string

RAM 权限。

ecs:CreateInstance

delete

object

删除操作关联信息。

permissions

array

所需 RAM 权限信息集合。

string

RAM 权限。

ecs:DeleteInstance

get

object

查询操作关联信息。

permissions

array

所需 RAM 权限信息集合。

string

RAM 权限。

ecs:DescribeInstanceAttachmentAttributes

list

object

列举操作关联信息。

permissions

array

所需 RAM 权限信息集合。

string

RAM 权限。

ecs:DescribeInstances

update

object

更新操作关联信息。

permissions

array

所需 RAM 权限信息集合。

string

RAM 权限。

ecs:ModifyInstanceNetworkSpec

info

object

资源类型基础信息。

chargeType

string

付费形式

paid(付费) free(免费)

paid

deliveryScope

string

交付级别

center(中心化部署级别)

region(地域部署级别)

zone(可用区部署级别)

region

description

string

资源类型描述。

An ECS instance is equivalent to a virtual machine, including the most basic computing components such as CPU, memory, operating system, network, and disk. You can easily customize and change the configuration of the instance. You have full control over the virtual machine.

title

string

资源类型名称。

Instance

listOnlyProperties

array

列举操作私有参数集合。资源查询操作中不会返回的属性,但是列举操作中需要传入的参数。

string

列举操作私有参数。

/properties/DryRun

listResponseProperties

array

列举返回的属性集合。

string

列举返回的属性。

/properties/InstanceId

primaryIdentifier

string

资源 ID。

/properties/InstanceId

product

string

产品 Code。

ECS

properties

object

资源属性定义,key 是属性名,value 为属性详细信息。

publicProperties

array

公共的属性集合,为资源基本属性。非操作私有参数。

string

公共属性。

/properties/Description

readOnlyProperties

array

只读参数集合,只在 list 或者 get 操作中返回,创建及变更时不作为入参。

string

只读参数。

/properties/CreateTime

required

array

资源创建必填参数集合。

string

资源创建必填参数。

RegionId

resourceType

string

资源类型。资源有父资源时,返回格式为{父资源类型 code/资源类型 code}。

无父资源: Instance 有父资源: DBInstance/Account

sensitiveInfoProperties

array

敏感属性集合,例如密码等。

string

敏感属性。

/properties/VncPassword

updateOnlyProperties

array

更新操作私有参数集合。资源查询操作中不会返回的属性,但是更新操作中需要传入的参数。

string

更新操作私有参数。

/properties/DryRun

updateTypeProperties

array

可以修改的属性集合。

string

可改属性。

/properties/InstanceName

示例

正常返回示例

JSON格式

{
  "requestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "resourceType": {
    "createOnlyProperties": [
      "/properties/AutoRenew"
    ],
    "deleteOnlyProperties": [
      "/properties/ForceDelete"
    ],
    "filterProperties": [
      "\t\n/properties/ResourceGroupId"
    ],
    "getOnlyProperties": [
      "/properties/DryRun"
    ],
    "getResponseProperties": [
      "/properties/NetworkInterfaces/items/properties/IpvSets"
    ],
    "handlers": {
      "create": {
        "permissions": [
          "ecs:CreateInstance"
        ]
      },
      "delete": {
        "permissions": [
          "ecs:DeleteInstance"
        ]
      },
      "get": {
        "permissions": [
          "ecs:DescribeInstanceAttachmentAttributes"
        ]
      },
      "list": {
        "permissions": [
          "ecs:DescribeInstances"
        ]
      },
      "update": {
        "permissions": [
          "ecs:ModifyInstanceNetworkSpec"
        ]
      }
    },
    "info": {
      "chargeType": "paid",
      "deliveryScope": "region",
      "description": "An ECS instance is equivalent to a virtual machine, including the most basic computing components such as CPU, memory, operating system, network, and disk. You can easily customize and change the configuration of the instance. You have full control over the virtual machine.",
      "title": "Instance"
    },
    "listOnlyProperties": [
      "/properties/DryRun"
    ],
    "listResponseProperties": [
      "/properties/InstanceId"
    ],
    "primaryIdentifier": "/properties/InstanceId\n",
    "product": "ECS",
    "properties": {
      "test": "test",
      "test2": 1
    },
    "publicProperties": [
      "\t\n/properties/Description"
    ],
    "readOnlyProperties": [
      "/properties/CreateTime"
    ],
    "required": [
      "RegionId"
    ],
    "resourceType": "无父资源:\nInstance\n有父资源:\nDBInstance/Account",
    "sensitiveInfoProperties": [
      "/properties/VncPassword"
    ],
    "updateOnlyProperties": [
      "/properties/DryRun"
    ],
    "updateTypeProperties": [
      "/properties/InstanceName"
    ]
  }
}

错误码

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

变更历史

更多信息,参考变更详情