DATASOURCE::REDIS::InstanceClasses类型用于查询Redis实例规格。
语法
{
"Type": "DATASOURCE::REDIS::InstanceClasses",
"Properties": {
"OrderType": String,
"ZoneId": String,
"ResourceGroupId": String,
"InstanceId": String,
"InstanceChargeType": String,
"NodeId": String,
"ProductType": String,
"AcceptLanguage": String,
"Engine": String,
"RefreshOptions": String
}
}
属性
属性名称 | 类型 | 必须 | 允许更新 | 描述 | 约束 |
OrderType | String | 否 | 是 | 订单类型。 | 取值:
|
ZoneId | String | 否 | 是 | 可用区ID。 | 您可以调用DescribeZones - 查询支持的可用区接口查询支持的可用区。 |
ResourceGroupId | String | 否 | 是 | 资源组ID。 | 无 |
InstanceId | String | 否 | 是 | 实例ID。 | 当OrderType取值为UPGRADE或RENEW时,该参数有效且必须指定。 |
InstanceChargeType | String | 否 | 是 | 付费类型。 | 取值:
|
NodeId | String | 否 | 是 | 数据节点ID。 | 您可以调用DescribeLogicInstanceTopology - 查询实例的逻辑拓扑结构接口查询数据节点ID。 说明 当您指定了InstanceId参数时,该参数有效。指定的实例需要是集群版或读写分离版。 |
ProductType | String | 否 | 是 | 产品类型。 | 取值:
|
AcceptLanguage | String | 否 | 是 | 返回值的语言。 | 取值:
|
Engine | String | 否 | 是 | 引擎类型。 | 取值:
|
RefreshOptions | String | 否 | 是 | 当资源栈更新时,数据源资源的刷新策略。 | 有效值:
|
返回数据(Fn::GetAtt)
InstanceClassIds:实例规格ID列表。
InstanceClasses:实例规格详情列表。
属性名称 | 类型 | 描述 | 约束 |
InstanceClassIds | List | 实例规格ID列表。 | 无 |
InstanceClasses | List | 实例规格详情列表。 | 无 |
ZoneId | String | 可用区ID。 | 无 |
InstanceClass | String | 实例规格。 | 无 |
SupportedNodeType | List | 节点类型。 | 取值:
|
ShardNumber | String | 分片数。 | 无 |
Architecture | String | 架构。 | 取值:
|
Version | String | 引擎版本。 | 无 |
SeriesType | String | 系列。 | 取值:
|
EditionType | String | 实例类型。 | 取值:
|
Engine | String | 引擎类型。 | 取值:
|
Capacity | Number | 内存容量。 | 单位:MB。 |
示例
{
"ROSTemplateFormatVersion": "2015-09-01",
"Parameters": {
"OrderType": {
"Type": "String",
"Description": "The order type. Valid values:\nBUY: the orders that are used to purchase instances.\nUPGRADE: the orders that are used to upgrade instances.\nDOWNGRADE: the orders that are used to downgrade instances."
},
"ZoneId": {
"Type": "String",
"Description": "The ID of the zone where PolarDB resources that you want to query reside.\nNote You can call the DescribeRegions operation to query information about zones."
},
"ResourceGroupId": {
"Type": "String",
"Description": "The ID of the instance.\n Note This parameter is required only if the OrderType parameter is set to UPGRADE or RENEW."
},
"InstanceId": {
"Type": "String",
"Description": "The ID of the resource group. You can call the ListResourceGroups operation to query the IDs of resource groups.\n Note You can also query the IDs of resource groups in the Resource Management console. For more information, see View basic information about a resource group."
},
"InstanceChargeType": {
"Type": "String",
"Description": "The billing method. Valid values:\nPrePaid: subscription\nPostPaid: pay-as-you-go\nNote Default value: PrePaid.",
"Default": "PrePaid"
},
"NodeId": {
"Type": "String",
"Description": "The ID of the data node for which you want to query available instance types. You can call the DescribeLogicInstanceTopology operation to query the ID of the data node. Remove the number sign (#) and the content that follows the number sign. For example, retain only r-bp10noxlhcoim2****-db-0.\n Note Before you set this parameter, you must set the InstanceId parameter to the ID of an instance in the cluster or read/write splitting architecture."
},
"ProductType": {
"Type": "String",
"Description": "The edition or series of instances. Valid values:\n Local: ApsaraDB for Redis Community Edition instances or performance-enhanced instances of ApsaraDB for Redis Enhanced Edition (Tair)\n Tair_scm: persistent memory-optimized instances\n Tair_essd: storage-optimized instances"
},
"AcceptLanguage": {
"Type": "String",
"Description": "The language of the return values. Valid values:\n zh-CN: Chinese. This is the default value.\n en-US: English."
},
"Engine": {
"Type": "String",
"Description": "The engine type. Valid values:\nRedis\nMemcache"
}
},
"Resources": {
"ExtensionDataSource": {
"Type": "DATASOURCE::REDIS::InstanceClasses",
"Properties": {
"OrderType": {
"Ref": "OrderType"
},
"ZoneId": {
"Ref": "ZoneId"
},
"ResourceGroupId": {
"Ref": "ResourceGroupId"
},
"InstanceId": {
"Ref": "InstanceId"
},
"InstanceChargeType": {
"Ref": "InstanceChargeType"
},
"NodeId": {
"Ref": "NodeId"
},
"ProductType": {
"Ref": "ProductType"
},
"AcceptLanguage": {
"Ref": "AcceptLanguage"
},
"Engine": {
"Ref": "Engine"
}
}
}
},
"Outputs": {
"InstanceClasses": {
"Description": "The list of instance classes.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"InstanceClasses"
]
}
},
"InstanceClassIds": {
"Description": "The list of db instance class ids.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"InstanceClassIds"
]
}
}
}
}
ROSTemplateFormatVersion: '2015-09-01'
Parameters:
AcceptLanguage:
Description: "The language of the return values. Valid values:\n zh-CN: Chinese.\
\ This is the default value.\n en-US: English."
Type: String
Engine:
Description: 'The engine type. Valid values:
Redis
Memcache'
Type: String
InstanceChargeType:
Default: PrePaid
Description: 'The billing method. Valid values:
PrePaid: subscription
PostPaid: pay-as-you-go
Note Default value: PrePaid.'
Type: String
InstanceId:
Description: "The ID of the resource group. You can call the ListResourceGroups\
\ operation to query the IDs of resource groups.\n Note You can also query the\
\ IDs of resource groups in the Resource Management console. For more information,\
\ see View basic information about a resource group."
Type: String
NodeId:
Description: "The ID of the data node for which you want to query available instance\
\ types. You can call the DescribeLogicInstanceTopology operation to query the\
\ ID of the data node. Remove the number sign (#) and the content that follows\
\ the number sign. For example, retain only r-bp10noxlhcoim2****-db-0.\n Note\
\ Before you set this parameter, you must set the InstanceId parameter to the\
\ ID of an instance in the cluster or read/write splitting architecture."
Type: String
OrderType:
Description: 'The order type. Valid values:
BUY: the orders that are used to purchase instances.
UPGRADE: the orders that are used to upgrade instances.
DOWNGRADE: the orders that are used to downgrade instances.'
Type: String
ProductType:
Description: "The edition or series of instances. Valid values:\n Local: ApsaraDB\
\ for Redis Community Edition instances or performance-enhanced instances of\
\ ApsaraDB for Redis Enhanced Edition (Tair)\n Tair_scm: persistent memory-optimized\
\ instances\n Tair_essd: storage-optimized instances"
Type: String
ResourceGroupId:
Description: "The ID of the instance.\n Note This parameter is required only if\
\ the OrderType parameter is set to UPGRADE or RENEW."
Type: String
ZoneId:
Description: 'The ID of the zone where PolarDB resources that you want to query
reside.
Note You can call the DescribeRegions operation to query information about zones.'
Type: String
Resources:
ExtensionDataSource:
Properties:
AcceptLanguage:
Ref: AcceptLanguage
Engine:
Ref: Engine
InstanceChargeType:
Ref: InstanceChargeType
InstanceId:
Ref: InstanceId
NodeId:
Ref: NodeId
OrderType:
Ref: OrderType
ProductType:
Ref: ProductType
ResourceGroupId:
Ref: ResourceGroupId
ZoneId:
Ref: ZoneId
Type: DATASOURCE::REDIS::InstanceClasses
Outputs:
InstanceClassIds:
Description: The list of db instance class ids.
Value:
Fn::GetAtt:
- ExtensionDataSource
- InstanceClassIds
InstanceClasses:
Description: The list of instance classes.
Value:
Fn::GetAtt:
- ExtensionDataSource
- InstanceClasses