All Products
Search

This Product

    Resource Orchestration Service:GetResourceType

    Document Center

    Resource Orchestration Service:GetResourceType

    Last Updated:Apr 25, 2024

    This topic provides an example on how to query the details of \`ALIYUN::ROS::WaitConditionHandle\`.

    Operation description

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

    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
    ResourceTypestringYes

    The ID of the request.

    		ALIYUN::ROS::WaitConditionHandle
    VersionIdstringNo

    The version ID. If you want to query a specific version of the resource type, you must specify this parameter. If you do not specify this parameter, only the resource type is queried.

    Note This parameter is supported only for modules.
    		v1
    HttpCodeError codesError messageDescription
    404ResourceTypeNotFoundThe Resource Type ({name}) could not be found.The error message returned because the specified resource type does not exist. name indicates the name of the resource type.

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The attributes of the resource.

    		A28FBA2E-B6B3-5822-AA45-AB875EF23641
    Attributesobject

    The type of the resource.

    ResourceTypestring

    The properties of the resource.

    		ALIYUN::ROS::WaitConditionHandle
    Propertiesobject

    Indicates whether the resource supports drift detection. Default value: false. Valid values:

    • true: Drift detection is supported.
    • false: Drift detection is not supported.
    SupportDriftDetectionboolean

    Indicates whether the resource supports scratch detection. Default value: false. Valid values:

    • true: Scratch detection is supported.
    • false: Scratch detection is not supported.
    		false
    SupportScratchDetectionboolean

    The entity type. Valid values:

    • Resource: resources other than DataSource resources. For more information, see Resources .
    • DataSource: DataSource resources.
    		false
    EntityTypestring

    The entity type. Valid values:

    • Resource: regular resource. For more information, see Resources .
    • DataSource: DataSource resource. For more information, see DataSource resources.
    • module: module.
    Enumeration Value:
    • Resource: Resource.
    • Module: Module.
    • DataSource: DataSource.
    		Resource
    Providerstring

    The provider of the resource type. Valid values:

    • ROS: The resource type is provided by Resource Orchestration Service (ROS).
    • Self: The resource type is provided by you.
    		ROS
    Descriptionstring

    The description of the resource type.

    		It is a demo.
    DefaultVersionIdstring

    The default version ID.

    Note This parameter is returned only if the resource type is queried.
    		v1
    LatestVersionIdstring

    The latest version ID.

    Note This parameter is returned only if the resource type is queried.
    		v10
    CreateTimestring

    The creation time. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format. The time is displayed in UTC.

    		2023-02-24T08:25:21
    UpdateTimestring

    The update time. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format. The time is displayed in UTC.

    		2023-02-24T08:25:21
    TotalVersionCountinteger

    The total number of versions.

    Note This parameter is returned only if the resource type is queried.
    		10
    IsDefaultVersionboolean

    Indicates whether the version is the default version. Valid values:

    • true
    • false
    Note This parameter is returned only if a specific version of the resource type is queried.
    		true
    TemplateBodystring

    The template content in the module.

    Note This parameter is returned only if a specific version of the resource type is queried.
    		{"ROSTemplateFormatVersion":"2015-09-01"}

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

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "A28FBA2E-B6B3-5822-AA45-AB875EF23641",
  "Attributes": {
    "test": "test",
    "test2": 1
  },
  "ResourceType": "ALIYUN::ROS::WaitConditionHandle",
  "Properties": {
    "test": "test",
    "test2": 1
  },
  "SupportDriftDetection": false,
  "SupportScratchDetection": false,
  "EntityType": "Resource",
  "Provider": "ROS",
  "Description": "It is a demo.",
  "DefaultVersionId": "v1",
  "LatestVersionId": "v10",
  "CreateTime": "2023-02-24T08:25:21\n",
  "UpdateTime": "2023-02-24T08:25:21\n",
  "TotalVersionCount": 10,
  "IsDefaultVersion": true,
  "TemplateBody": "{\"ROSTemplateFormatVersion\":\"2015-09-01\"}"
}

    Error codes

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

    Change history

    Change timeSummary of changesOperation
    2023-05-10The request parameters of the API has changed. The response structure of the API has changedsee changesets
    Change itemChange content
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: VersionId
    Output ParametersThe response structure of the API has changed.
    2022-01-18The response structure of the API has changedsee changesets
    Change itemChange content
    Output ParametersThe response structure of the API has changed.