Home PageResource Orchestration ServiceDeveloper ReferenceAPI ReferenceAPI catalogOther operationsGetFeatureDetails
Search for Help Content

GetFeatureDetails

Updated at: 2024-09-12 09:18
Product
Community

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

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

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
ParameterTypeRequiredDescriptionExample
FeaturestringYes

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.
Terraform
RegionIdstringYes

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

cn-hangzhou

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

Response parameters

ParameterTypeDescriptionExample
ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

EBF833DA-D0E2-52BE-92E2-59CA56BE834E
Terraformobject

Details of the Terraform hosting feature.

SupportedVersionsarray<object>

The Terraform versions.

object
ProviderVersionsarray<object>

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

object
ProviderNamestring

The name of the provider.

alicloud
SupportedVersionsarray

The provider versions.

string

The provider version.

1.121.2
TerraformVersionstring

The Terraform version.

1.0.11
Transformstring

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.

Aliyun::Terraform-v1.0
UpdateAllowedTransformsarray

The Terraform versions that can be updated in ROS.

string

The Terraform version that can be updated in ROS.

Aliyun::Terraform-v1.1
SupportedResourceTypesobject

The resource types that support the scenario feature.

SystemTagarray

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

string

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

alicloud_instance
CustomTagarray

The resource types that support the custom tag feature.

string

The resource types that support the custom tag feature.

alicloud_instance
EstimateCostarray

The resource types that support the price inquiry feature.

string

The resource types that support the price inquiry feature.

alicloud_instance
ResourceGrouparray

The resource types that support the resource group feature.

string

The resource types that support the resource group feature.

alicloud_instance
StackOperationRiskobject

The resource type that support the risk check feature.

DeleteStackarray

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

string

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

alicloud_instance
TemplateScratchobject

Details of the scenario feature.

SupportedResourceTypesarray<object>

The resource types that are supported by the scenario feature.

object

The resource types that support the scenario feature.

ResourceTypestring

The resource type.

ALIYUN::ECS::Disk
SourceResourcesSupportedboolean

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

  • true
  • false
true
SourceTagSupportedboolean

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

  • true
  • false
true
SourceResourceGroupSupportedboolean

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

  • true
  • false
true
SourceSupportedboolean

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

  • true
  • false
true
SupportedTemplateScratchTypesarray

The scenario types that are supported.

string

The scenario type that is supported. Valid values:

  • ArchitectureReplication: resource replication
  • ArchitectureDetection: resource detection
  • ResourceImport: resource management
  • ResourceMigration: resource migration
ArchitectureReplication
ResourceCleanerobject

Details of the resource cleaner feature.

SupportedResourceTypesarray<object>

The resource types that can be cleaned up.

object

The resource types that can be cleaned up.

ResourceTypestring

The resource type that supports the resource cleaner feature.

ECS:Instance
SupportedFiltersarray

The names of the filters that are supported by the resource type.

string

The name of the filter that is supported by the resource type. Valid values:

  • RegionId
  • ResourceId
  • ResourceName
  • Tags
  • ResourceGroupId
  • DeletionProtection
ResourceName
SideEffectsarray

The names of the side effects that may be caused by the cleanup operation performed on the resources of the specified type.

string

The name of the side effect that may be caused by the cleanup operation performed on the resources of the specified type. Only StopInstance may be returned, which indicates that instances related to the specified resource type are stopped.

StopInstance
TemplateParameterConstraintsobject

Details of the template parameter constraint feature.

SupportedResourceTypesarray<object>

The resource types that support the template parameter constraint feature.

object

The resource types that support the template parameter constraint feature.

ResourceTypestring

The resource type.

ALIYUN::ECS::Disk
Propertiesarray

The names of properties that are supported by the resource type.

string

The name of the property that is supported by the resource type.

["DiskCategory", "ZoneId"]
DriftDetectionobject

Details of the drift detection feature.

SupportedResourceTypesarray

The resource types that are supported by the drift detection feature.

string

The resource types that are supported by the drift detection feature.

ALIYUN::ECS::Disk
ResourceImportobject

Details of the resource import feature.

SupportedResourceTypesarray<object>

The resource types that are supported by the resource import feature.

object
ResourceTypestring

The resource type.

ALIYUN::ECS::Disk
ResourceIdentifiersarray

The resource identifiers.

string

The resource identifier.

DiskId

Examples

Sample success responses

JSONformat

{
  "RequestId": "EBF833DA-D0E2-52BE-92E2-59CA56BE834E",
  "Terraform": {
    "SupportedVersions": [
      {
        "ProviderVersions": [
          {
            "ProviderName": "alicloud",
            "SupportedVersions": [
              "1.121.2"
            ]
          }
        ],
        "TerraformVersion": "1.0.11",
        "Transform": "Aliyun::Terraform-v1.0",
        "UpdateAllowedTransforms": [
          "Aliyun::Terraform-v1.1"
        ]
      }
    ],
    "SupportedResourceTypes": {
      "SystemTag": [
        "alicloud_instance"
      ],
      "CustomTag": [
        "alicloud_instance"
      ],
      "EstimateCost": [
        "alicloud_instance"
      ],
      "ResourceGroup": [
        "alicloud_instance"
      ],
      "StackOperationRisk": {
        "DeleteStack": [
          "alicloud_instance"
        ]
      }
    }
  },
  "TemplateScratch": {
    "SupportedResourceTypes": [
      {
        "ResourceType": "ALIYUN::ECS::Disk",
        "SourceResourcesSupported": true,
        "SourceTagSupported": true,
        "SourceResourceGroupSupported": true,
        "SourceSupported": true,
        "SupportedTemplateScratchTypes": [
          "ArchitectureReplication"
        ]
      }
    ]
  },
  "ResourceCleaner": {
    "SupportedResourceTypes": [
      {
        "ResourceType": "ECS:Instance",
        "SupportedFilters": [
          "ResourceName"
        ],
        "SideEffects": [
          "StopInstance"
        ]
      }
    ]
  },
  "TemplateParameterConstraints": {
    "SupportedResourceTypes": [
      {
        "ResourceType": "ALIYUN::ECS::Disk",
        "Properties": [
          "[\"DiskCategory\", \"ZoneId\"]"
        ]
      }
    ]
  },
  "DriftDetection": {
    "SupportedResourceTypes": [
      "ALIYUN::ECS::Disk"
    ]
  },
  "ResourceImport": {
    "SupportedResourceTypes": [
      {
        "ResourceType": "ALIYUN::ECS::Disk",
        "ResourceIdentifiers": [
          "DiskId"
        ]
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
Change timeSummary of changesOperation
2023-08-24The response structure of the API has changedView Change Details
2023-03-30The response structure of the API has changedView Change Details
2022-01-12The response structure of the API has changedView Change Details
Previous: DescribeRegionsNext: GetServiceProvisions
  • On this page （1）
  • Operation description
  • Debugging
  • Authorization information
  • Request parameters
  • Response parameters
  • Examples
  • Error codes
  • Change history
Feedback