Call ListResourceTypes to list resource types of a service - Cloud Control API - Alibaba Cloud - Cloud Control API

Lists the resource types of a service.

Operation description

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

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
provider	string	Yes	The cloud service provider. Only Aliyun is supported.	Aliyun
product	string	Yes	The code of the service.	ECS

Request parameters

Parameter	Type	Required	Description	Example
x-acs-accept-language	string	No	The language of the response. zh_CH: Chinese (default). en_US: English. Valid values: zh_CH : zh_CH en_US : en_US	zh_CH
resourceTypes	array	No	The information about the resource types.
	string	No	The resource types.	Instance
nextToken	string	No	The pagination token for the next request. If empty, the query starts from the beginning.	ECS::Disk
maxResults	integer	No	The number of entries per page.	10

Response elements

Element	Type	Description	Example
	object	The returned data.
maxResults	integer	The maximum number of entries returned.	10
nextToken	string	A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.	ECS::Disk
requestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
resourceTypes	array<object>	The information about the resource types.
	array<object>	The resource types.
createOnlyProperties	array	The properties that are specific to the create operation. You need to specify these properties when you create the resource. These properties are not returned when you query the resource.
	string	The property that is specific to the create operation.	/properties/AutoRenew
deleteOnlyProperties	array	The properties that are specific to the delete operation. You need to specify these properties when you delete the resource. These properties are not returned when you query the resource.
	string	The property that is specific to the delete operation.	/properties/ForceDelete
filterProperties	array	The properties that can be used to filter the resource when you list the resource.
	string	The property that can be used to filter the resource.	/properties/ResourceGroupId
getOnlyProperties	array	The properties that are specific to the query operation. You need to specify these properties when you query the resource. These properties are not returned in the query result.
	string	The property that is specific to the query operation.	/properties/DryRun
getResponseProperties	array	The properties that are returned when you query the resource.
	string	The property that is returned when you query the resource.	/properties/NetworkInterfaces/items/properties/IpvSets
handlers	object	The information about the operation, including the required Resource Access Management (RAM) permissions.
create	object	The information about the create operation.
permissions	array	The RAM permissions required.
	string	The RAM permission.	ecs:CreateInstance
delete	object	The information about the delete operation.
permissions	array	The RAM permissions required.
	string	The RAM permission.	ecs:DeleteInstance
get	object	The information about the query operation.
permissions	array	The RAM permissions required.
	string	The RAM permission.	ecs:DescribeInstanceAttachmentAttributes
list	object	The information about the list operation.
permissions	array	The RAM permissions required.
	string	The RAM permission.	ecs:DescribeInstances
update	object	The information about the update operation.
permissions	array	The RAM permissions required.
	string	The RAM permission.	ecs:ModifyInstanceNetworkSpec
info	object	The information about the resource type.
chargeType	string	Billing method paid free Valid values: paid : paid free : free	paid
deliveryScope	string	The deployment level of the resource. center region zone Valid values: zone : zone center : center region : region	region
description	string	The description of the resource type.	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	The name of the resource type.	Instance
listOnlyProperties	array	The properties that are specific to the list operation. You need to specify these properties when you list the resource. These properties are not returned when you query the resource.
	string	The property that is specific to the list operation.	/properties/DryRun
listResponseProperties	array	The properties that are returned when you list the resource.
	string	The property that is returned when you query the resource.	/properties/InstanceId
primaryIdentifier	string	The ID of the resource.	/properties/InstanceId
product	string	The code of the service.	ECS
properties	object	The resource properties. The key specifies the property name and the value specifies the details of the property.
publicProperties	array	The common properties of the resource. The common properties are not operation-specific.
	string	The common property.	/properties/Description
readOnlyProperties	array	The read-only properties. These properties are returned only when you list or query the resource. You do not need to specify these properties when you create or update the resource.
	string	The read-only property.	/properties/CreateTime
required	array	The properties that must be specified when you create the resource.
	string	The property that must be specified when you create the resource.	RegionId
resourceType	string	The resource type.	Instance
sensitiveInfoProperties	array	The sensitive properties, such as the password.
	string	The sensitive property.	/properties/VncPassword
updateOnlyProperties	array	The properties that are specific to the update operation. You need to specify these properties when you update the resource. These properties are not returned when you query the resource.
	string	The property that is specific to the update operation.	/properties/DryRun
updateTypeProperties	array	The properties that can be modified.
	string	The property that can be modified.	/properties/InstanceName
totalCount	integer	The total number of entries returned.	20

Examples

Success response

JSON format

{
  "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
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.