Queries the details of features that are supported by Resource Orchestration Service (ROS).

Description

You can call this operation to query the Terraform hosting, resource cleaner, and scenario features.

This topic provides an example on how to query the details of features supported by ROS in the China (Hangzhou) region. The details include Terraform versions, provider versions, and supported resource types.

Note In the Examples section, only part of the sample code is provided.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes GetFeatureDetails

The operation that you want to perform. Set the value to GetFeatureDetails.

Feature String Yes Terraform

The one or more features that you want to query. Valid values:

  • Terraform: the Terraform hosting feature.
  • ResourceCleaner: the resource cleaner feature. You can use ALIYUN::ROS::ResourceCleaner to create a resource cleaner.
  • TemplateScratch: the scenario feature.
  • All: all features that are supported by ROS.
RegionId String Yes cn-hangzhou

The ID of the region in which the stack resides. You can call the DescribeRegions operation to query the most recent region list.

For more information about common request parameters, see Common parameters.

Response parameters

Parameter Type Example Description
RequestId String EBF833DA-D0E2-52BE-92E2-59CA56BE834E

The ID of the request.

Terraform Object

The details of the Terraform hosting feature.

SupportedVersions Array of SupportedVersion

The Terraform versions.

ProviderVersions Array of ProviderVersion

The names and versions of the providers that correspond to the Terraform versions.

ProviderName String alicloud

The name of the provider.

SupportedVersions Array of String 1.121.2

The version of the provider.

TerraformVersion String 1.0.11

The Terraform version.

Transform String Aliyun::Terraform-v1.0

The Terraform version that is supported by ROS. The parameter value is the same as the value of the Transform parameter in a Terraform template.

UpdateAllowedTransforms Array of String Aliyun::Terraform-v1.1

The versions to which Terraform can be updated.

SupportedResourceTypes Object

The resource type that is supported by the Terraform hosting feature.

SystemTag Array of String alicloud_instance

The resource types that support the system tag acs:ros:stackId.

CustomTag Array of String alicloud_instance

The resource types that support the custom tag feature.

EstimateCost Array of String alicloud_instance

The resource types that support the price inquiry feature.

ResourceGroup Array of String alicloud_instance

The resource types that support the resource group feature.

StackOperationRisk Object

The resource types that support the risk check feature.

DeleteStack Array of String alicloud_instance

The resource types that support the risk check performed to detect risks caused by a stack deletion operation.

TemplateScratch Object

The details of the scenario feature.

SupportedResourceTypes Array of SupportedResourceType

The resource types that support the scenario feature.

ResourceType String ALIYUN::ECS::Disk

The resource type.

SourceResourcesSupported Boolean true

Indicates whether the resource scope can be specified by tag, resource group, or resource. Valid values:

  • true
  • false
SourceTagSupported Boolean true

Indicates whether the resource scope can be specified by tag. Valid values:

  • true
  • false
SourceResourceGroupSupported Boolean true

Indicates whether the resource scope can be specified by resource group. Valid values:

  • true
  • false
SourceSupported Boolean true

Indicates whether the resource scope can be specified by resource. Valid values:

  • true
  • false
ResourceCleaner Object

The details of the resource cleaner feature.

SupportedResourceTypes Array of SupportedResourceType

The resource types that can be cleaned up.

ResourceType String ECS:Instance

The resource type that can be cleaned up.

SupportedFilters Array of String ResourceName

The filters that are used to filter resources. Valid values:

  • RegionId: the ID of the region.
  • ResourceId: the ID of the resource.
  • ResourceName: the name of the resource.
  • Tags: the tags of the resource.
  • ResourceGroupId: the ID of the resource group.
  • DeletionProtection: the deletion protection feature.
SideEffects Array of String StopInstance

The names of the side effects. The StopInstance value indicates that an instance that is related to the specified resource is stopped.

Examples

Sample requests

http(s)://ros.aliyuncs.com/?Action=GetFeatureDetails
&Feature=Terraform
&RegionId=cn-hangzhou
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<GetFeatureDetailsResponse>
    <TemplateScratch>
        <SupportedResourceTypes>
            <SourceTagSupported>false</SourceTagSupported>
            <SourceSupported>false</SourceSupported>
            <ResourceType>ALIYUN::ALB::BackendServerAttachment</ResourceType>
            <SourceResourcesSupported>false</SourceResourcesSupported>
            <SourceResourceGroupSupported>false</SourceResourceGroupSupported>
        </SupportedResourceTypes>
        <SupportedResourceTypes>
            <SourceTagSupported>false</SourceTagSupported>
            <SourceSupported>false</SourceSupported>
            <ResourceType>ALIYUN::ALB::Listener</ResourceType>
            <SourceResourcesSupported>false</SourceResourcesSupported>
            <SourceResourceGroupSupported>false</SourceResourceGroupSupported>
        </SupportedResourceTypes>
    </TemplateScratch>
    <RequestId>A656A2C3-5A21-5F0E-9368-427E6FED58ED</RequestId>
    <Terraform>
        <SupportedResourceTypes>
            <EstimateCost>alicloud_disk</EstimateCost>
            <EstimateCost>alicloud_ecs_disk</EstimateCost>
            <SystemTag>alicloud_disk</SystemTag>
            <SystemTag>alicloud_ecs_disk</SystemTag>
            <CustomTag>alicloud_disk</CustomTag>
            <CustomTag>alicloud_ecs_disk</CustomTag>
            <ResourceGroup>alicloud_disk</ResourceGroup>
            <ResourceGroup>alicloud_alb_acl</ResourceGroup>
            <StackOperationRisk>
                <DeleteStack>alicloud_ecs_disk</DeleteStack>
                <DeleteStack>alicloud_eip</DeleteStack>
            </StackOperationRisk>
        </SupportedResourceTypes>
        <SupportedVersions>
            <ProviderVersions>
                <ProviderName>aws</ProviderName>
                <SupportedVersions>4.21.0</SupportedVersions>
                <SupportedVersions>4.22.0</SupportedVersions>
            </ProviderVersions>
            <ProviderVersions>
                <ProviderName>alicloud</ProviderName>
                <SupportedVersions>1.174.0</SupportedVersions>
                <SupportedVersions>1.176.0</SupportedVersions>
            </ProviderVersions>
            <TerraformVersion>1.0.11</TerraformVersion>
            <Transform>Aliyun::Terraform-v1.0</Transform>
            <UpdateAllowedTransforms>Aliyun::Terraform-v1.1</UpdateAllowedTransforms>
        </SupportedVersions>
        <SupportedVersions>
            <ProviderVersions>
                <ProviderName>aws</ProviderName>
                <SupportedVersions>4.21.0</SupportedVersions>
                <SupportedVersions>4.22.0</SupportedVersions>
            </ProviderVersions>
            <ProviderVersions>
                <ProviderName>alicloud</ProviderName>
                <SupportedVersions>1.174.0</SupportedVersions>
                <SupportedVersions>1.176.0</SupportedVersions>
            </ProviderVersions>
            <TerraformVersion>1.1.9</TerraformVersion>
            <Transform>Aliyun::Terraform-v1.1</Transform>
            <UpdateAllowedTransforms>Aliyun::Terraform-v1.0</UpdateAllowedTransforms>
        </SupportedVersions>
    </Terraform>
    <ResourceCleaner>
        <SupportedResourceTypes>
            <ResourceType>ADB:DBCluster</ResourceType>
            <SupportedFilters>RegionId</SupportedFilters>
            <SupportedFilters>ResourceId</SupportedFilters>
            <SupportedFilters>ResourceName</SupportedFilters>
            <SupportedFilters>Tags</SupportedFilters>
            <SupportedFilters>ResourceGroupId</SupportedFilters>
        </SupportedResourceTypes>
        <SupportedResourceTypes>
            <ResourceType>ALB:LoadBalancer</ResourceType>
            <SupportedFilters>RegionId</SupportedFilters>
            <SupportedFilters>ResourceId</SupportedFilters>
            <SupportedFilters>ResourceName</SupportedFilters>
            <SupportedFilters>Tags</SupportedFilters>
            <SupportedFilters>ResourceGroupId</SupportedFilters>
            <SupportedFilters>DeletionProtection</SupportedFilters>
        </SupportedResourceTypes>
    </ResourceCleaner>
</GetFeatureDetailsResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TemplateScratch" : {
    "SupportedResourceTypes" : [ {
      "SourceTagSupported" : false,
      "SourceSupported" : false,
      "ResourceType" : "ALIYUN::ALB::BackendServerAttachment",
      "SourceResourcesSupported" : false,
      "SourceResourceGroupSupported" : false
    }, {
      "SourceTagSupported" : false,
      "SourceSupported" : false,
      "ResourceType" : "ALIYUN::ALB::Listener",
      "SourceResourcesSupported" : false,
      "SourceResourceGroupSupported" : false
    } ]
  },
  "RequestId" : "A656A2C3-5A21-5F0E-9368-427E6FED58ED",
  "Terraform" : {
    "SupportedResourceTypes" : {
      "EstimateCost" : [ "alicloud_disk", "alicloud_ecs_disk" ],
      "SystemTag" : [ "alicloud_disk", "alicloud_ecs_disk" ],
      "CustomTag" : [ "alicloud_disk", "alicloud_ecs_disk" ],
      "ResourceGroup" : [ "alicloud_disk", "alicloud_alb_acl" ],
      "StackOperationRisk" : {
        "DeleteStack" : [ "alicloud_ecs_disk", "alicloud_eip" ]
      }
    },
    "SupportedVersions" : [ {
      "ProviderVersions" : [ {
        "ProviderName" : "aws",
        "SupportedVersions" : [ "4.21.0", "4.22.0" ]
      }, {
        "ProviderName" : "alicloud",
        "SupportedVersions" : [ "1.174.0", "1.176.0" ]
      } ],
      "TerraformVersion" : "1.0.11",
      "Transform" : "Aliyun::Terraform-v1.0",
      "UpdateAllowedTransforms" : [ "Aliyun::Terraform-v1.1" ]
    }, {
      "ProviderVersions" : [ {
        "ProviderName" : "aws",
        "SupportedVersions" : [ "4.21.0", "4.22.0" ]
      }, {
        "ProviderName" : "alicloud",
        "SupportedVersions" : [ "1.174.0", "1.176.0" ]
      } ],
      "TerraformVersion" : "1.1.9",
      "Transform" : "Aliyun::Terraform-v1.1",
      "UpdateAllowedTransforms" : [ "Aliyun::Terraform-v1.0" ]
    } ]
  },
  "ResourceCleaner" : {
    "SupportedResourceTypes" : [ {
      "ResourceType" : "ADB:DBCluster",
      "SupportedFilters" : [ "RegionId", "ResourceId", "ResourceName", "Tags", "ResourceGroupId" ]
    }, {
      "ResourceType" : "ALB:LoadBalancer",
      "SupportedFilters" : [ "RegionId", "ResourceId", "ResourceName", "Tags", "ResourceGroupId", "DeletionProtection" ]
    } ]
  }
}

Error codes

For a list of error codes, visit the API Error Center.