ListResourceTypes - 列举资源类型

列举产品的资源类型。

接口说明

GET /api/v1/providers/{provider}/products/{product}/resourceTypes。

调试

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

授权信息

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

请求语法

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

请求参数

名称类型必填描述示例值
x-acs-accept-languagestring

选择返回产品的语言。

zh_CH:中文 (默认)

en_US:英文。

zh_CH
providerstring

云厂商,目前只支持 Aliyun。

Aliyun
productstring

产品 Code。

ECS
resourceTypesarray

资源类型列表。

string

资源类型。

Instance
nextTokenstring

用来标记当前开始读取的位置,置空表示从头开始。

ECS::Disk
maxResultsinteger

分页查询时每页行数。

10

返回参数

名称类型描述示例值
object

返回结构。

maxResultsinteger

本次请求所返回的最大记录条数。

10
nextTokenstring

表示当前调用返回读取到的位置,空代表数据已经读取完毕

ECS::Disk
requestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
resourceTypesarray<object>

资源类型列表。

resourceTypeobject

资源类型。

createOnlyPropertiesarray

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

createOnlyPropertystring

创建操作私有参数。

/properties/AutoRenew
deleteOnlyPropertiesarray

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

deleteOnlyPropertystring

删除操作私有参数。

/properties/ForceDelete
filterPropertiesarray

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

filterPropertystring

filter 参数。

/properties/ResourceGroupId
getOnlyPropertiesarray

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

getOnlyPropertystring

查询操作私有参数。

/properties/DryRun
getResponsePropertiesarray

查询返回的属性集合。

getResponsePropertystring

查询返回的属性。

/properties/NetworkInterfaces/items/properties/IpvSets
handlersobject

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

createobject

创建操作关联信息。

permissionsarray

所需 RAM 权限信息集合。

permissionstring

RAM 权限。

ecs:CreateInstance
deleteobject

删除操作关联信息。

permissionsarray

所需 RAM 权限信息集合。

permissionstring

RAM 权限。

ecs:DeleteInstance
getobject

查询操作关联信息。

permissionsarray

所需 RAM 权限信息集合。

permissionstring

RAM 权限。

ecs:DescribeInstanceAttachmentAttributes
listobject

列举操作关联信息。

permissionsarray

所需 RAM 权限信息集合。

permissionstring

RAM 权限。

ecs:DescribeInstances
updateobject

更新操作关联信息。

permissionsarray

所需 RAM 权限信息集合。

permissionstring

RAM 权限。

ecs:ModifyInstanceNetworkSpec
infoobject

资源类型基础信息。

chargeTypestring

付费形式
paid(付费) free(免费)

paid
deliveryScopestring

交付级别

center(中心化部署级别)

region(地域部署级别)

zone(可用区部署级别)

region
descriptionstring

资源类型描述。

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.
titlestring

资源类型名称。

Instance
listOnlyPropertiesarray

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

listOnlyPropertystring

列举操作私有参数。

/properties/DryRun
listResponsePropertiesarray

列举返回的属性集合。

listResponsePropertystring

列举返回的属性。

/properties/InstanceId
primaryIdentifierstring

资源 ID

/properties/InstanceId
productstring

产品 Code。

ECS
propertiesobject

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

publicPropertiesarray

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

publicPropertystring

公共属性。

/properties/Description
readOnlyPropertiesarray

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

readOnlyPropertystring

只读参数

/properties/CreateTime
requiredarray

资源创建必填参数集合。

requiredstring

资源创建必填参数。

RegionId
resourceTypestring

资源类型。

Instance
sensitiveInfoPropertiesarray

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

sensitiveInfoPropertystring

敏感属性。

/properties/VncPassword
updateOnlyPropertiesarray

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

updateOnlyPropertystring

更新操作私有参数。

/properties/DryRun
updateTypePropertiesarray

可以修改的属性集合。

updateTypePropertystring

可改属性。

/properties/InstanceName
totalCountinteger

本次请求条件下的数据总量。

20

示例

正常返回示例

JSON格式

{
  "maxResults": 10,
  "nextToken": "ECS::Disk",
  "requestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "resourceTypes": [
    {
      "createOnlyProperties": [
        "/properties/AutoRenew"
      ],
      "deleteOnlyProperties": [
        "/properties/ForceDelete"
      ],
      "filterProperties": [
        "/properties/ResourceGroupId"
      ],
      "getOnlyProperties": [
        "/properties/DryRun\n"
      ],
      "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",
      "product": "ECS",
      "properties": {
        "test": "test",
        "test2": 1
      },
      "publicProperties": [
        "/properties/Description"
      ],
      "readOnlyProperties": [
        "/properties/CreateTime"
      ],
      "required": [
        "RegionId"
      ],
      "resourceType": "Instance",
      "sensitiveInfoProperties": [
        "/properties/VncPassword"
      ],
      "updateOnlyProperties": [
        "/properties/DryRun"
      ],
      "updateTypeProperties": [
        "/properties/InstanceName"
      ]
    }
  ],
  "totalCount": 20
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史