DATASOURCE::ROCKETMQ::Instance_资源编排(ROS)-阿里云帮助中心

DATASOURCE::ROCKETMQ::Instance类型用于查询单个RocketMQ实例的详情信息。

语法

{
  "Type": "DATASOURCE::ROCKETMQ::Instance",
  "Properties": {
    "InstanceId": String,
    "RefreshOptions": String
  }
}

属性

属性名称

类型

必须

允许更新

描述

约束

InstanceId

String

是

RocketMQ实例ID。

无

RefreshOptions

String

否

是

当资源栈更新时，数据源资源的刷新策略。

有效值：

Never（默认值）：更新堆栈时，从不刷新数据源资源。
Always：更新堆栈时，始终刷新数据源资源。

返回值

Fn::GetAtt

ProductInfo：实例的扩展配置。
AclInfo：访问控制信息。
ResourceGroupId：资源组ID。
InstanceId：实例ID。
NetworkInfo：网络信息。
GroupCount：消费组数量。
CreateTime：实例的创建时间。
StartTime：实例的启动时间。
TopicCount：主题数量。
InstanceQuotas：容量信息。
SubSeriesCode：实例的子系列编码。
Remark：实例的备注信息。
InstanceName：实例名称。
ServiceCode：实例所属的服务编码。
SeriesCode：实例的主系列编码。
ReleaseTime：实例的释放时间。
UserId：实例所属的用户ID。
UpdateTime：实例最后的修改时间。
CommodityCode：消息队列RocketMQ 5.x系列实例的商品代号类似于ons_rmqsub_public_cn。
PaymentType：实例的付费类型。
Software：实例软件信息。
ExpireTime：实例的到期时间。
AccountInfo：账号信息。
Tags：资源标签列表。

示例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  InstanceId:
    Type: String
    Description:
      en: The ID of the RocketMQ instance.
    Required: true
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::ROCKETMQ::Instance
    Properties:
      InstanceId:
        Ref: InstanceId
Outputs:
  ProductInfo:
    Description: The extended configurations of the instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ProductInfo
  AclInfo:
    Description: The information about access control.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - AclInfo
  ResourceGroupId:
    Description: The ID of the resource group.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ResourceGroupId
  InstanceId:
    Description: The ID of the RocketMQ instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - InstanceId
  NetworkInfo:
    Description: Instance network configuration information.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - NetworkInfo
  GroupCount:
    Description: The number of groups.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - GroupCount
  CreateTime:
    Description: The time when the instance was created.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CreateTime
  StartTime:
    Description: The time when the instance was started.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - StartTime
  TopicCount:
    Description: The number of topics.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - TopicCount
  InstanceQuotas:
    Description: The instance quotas.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - InstanceQuotas
  SubSeriesCode:
    Description: The sub-category edition of the instance. For information about the differences between sub-category edition instances.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - SubSeriesCode
  Remark:
    Description: The description of the instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Remark
  InstanceName:
    Description: The name of instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - InstanceName
  ServiceCode:
    Description: The code of the service to which the instance belongs. The service code of ApsaraMQ for RocketMQ is rmq.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ServiceCode
  SeriesCode:
    Description: The primary edition of the instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - SeriesCode
  ReleaseTime:
    Description: The time when the instance was released.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ReleaseTime
  UserId:
    Description: The ID of the user who owns the instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - UserId
  UpdateTime:
    Description: The time when the instance was last modified.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - UpdateTime
  CommodityCode:
    Description: The commodity code of the instance. The commodity code of a ApsaraMQ for RocketMQ 5.0 instance has a similar format as ons_rmqsub_public_cn.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CommodityCode
  PaymentType:
    Description: The billing method of the instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - PaymentType
  Software:
    Description: The instance software information.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Software
  ExpireTime:
    Description: The time when the instance expires.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ExpireTime
  AccountInfo:
    Description: The account information.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - AccountInfo
  Tags:
    Description: The tags of the RocketMQ instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Tags

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "InstanceId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the RocketMQ instance."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::ROCKETMQ::Instance",
      "Properties": {
        "InstanceId": {
          "Ref": "InstanceId"
        }
      }
    }
  },
  "Outputs": {
    "ProductInfo": {
      "Description": "The extended configurations of the instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ProductInfo"
        ]
      }
    },
    "AclInfo": {
      "Description": "The information about access control.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "AclInfo"
        ]
      }
    },
    "ResourceGroupId": {
      "Description": "The ID of the resource group.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ResourceGroupId"
        ]
      }
    },
    "InstanceId": {
      "Description": "The ID of the RocketMQ instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceId"
        ]
      }
    },
    "NetworkInfo": {
      "Description": "Instance network configuration information.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "NetworkInfo"
        ]
      }
    },
    "GroupCount": {
      "Description": "The number of groups.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "GroupCount"
        ]
      }
    },
    "CreateTime": {
      "Description": "The time when the instance was created.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CreateTime"
        ]
      }
    },
    "StartTime": {
      "Description": "The time when the instance was started.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "StartTime"
        ]
      }
    },
    "TopicCount": {
      "Description": "The number of topics.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "TopicCount"
        ]
      }
    },
    "InstanceQuotas": {
      "Description": "The instance quotas.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceQuotas"
        ]
      }
    },
    "SubSeriesCode": {
      "Description": "The sub-category edition of the instance. For information about the differences between sub-category edition instances.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SubSeriesCode"
        ]
      }
    },
    "Remark": {
      "Description": "The description of the instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Remark"
        ]
      }
    },
    "InstanceName": {
      "Description": "The name of instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceName"
        ]
      }
    },
    "ServiceCode": {
      "Description": "The code of the service to which the instance belongs. The service code of ApsaraMQ for RocketMQ is rmq.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ServiceCode"
        ]
      }
    },
    "SeriesCode": {
      "Description": "The primary edition of the instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SeriesCode"
        ]
      }
    },
    "ReleaseTime": {
      "Description": "The time when the instance was released.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ReleaseTime"
        ]
      }
    },
    "UserId": {
      "Description": "The ID of the user who owns the instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "UserId"
        ]
      }
    },
    "UpdateTime": {
      "Description": "The time when the instance was last modified.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "UpdateTime"
        ]
      }
    },
    "CommodityCode": {
      "Description": "The commodity code of the instance. The commodity code of a ApsaraMQ for RocketMQ 5.0 instance has a similar format as ons_rmqsub_public_cn.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CommodityCode"
        ]
      }
    },
    "PaymentType": {
      "Description": "The billing method of the instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PaymentType"
        ]
      }
    },
    "Software": {
      "Description": "The instance software information.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Software"
        ]
      }
    },
    "ExpireTime": {
      "Description": "The time when the instance expires.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ExpireTime"
        ]
      }
    },
    "AccountInfo": {
      "Description": "The account information.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "AccountInfo"
        ]
      }
    },
    "Tags": {
      "Description": "The tags of the RocketMQ instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Tags"
        ]
      }
    }
  }
}