查詢指定可用區內可創建的實例規格。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
kvstore:DescribeAvailableResource | get | *全部資源 * |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 地域 ID,您可以調用 DescribeRegions 查詢。 | cn-hangzhou |
ZoneId | string | 否 | 可用區 ID,您可以調用 DescribeZones 查詢。 | cn-hangzhou-h |
InstanceChargeType | string | 否 | 付費類型,取值:
說明
默認值:PrePaid。
| PrePaid |
OrderType | string | 否 | 訂單類型,取值:
| BUY |
Engine | string | 否 | 引擎類型,取值:
| Redis |
ResourceGroupId | string | 否 | 資源組 ID。您可以通過調用 ListResourceGroups 接口獲取資源組 ID。 說明
您也可以通過控制臺獲取資源組 ID,相關操作,請參見查看資源組基本信息。
| rg-acfmyiu4e****** |
InstanceId | string | 否 | 實例 ID。 說明
當 OrderType 取值為 UPGRADE 或 DOWNGRADE 時,本參數才可用且必須傳入。
| r-bp1zxszhcgatnx**** |
AcceptLanguage | string | 否 | 返回值的語言,取值:
| zh-CN |
ProductType | string | 否 | 產品類型,取值:
| Local |
NodeId | string | 否 | 數據節點 ID,可調用 DescribeLogicInstanceTopology 獲取。對于獲取到的數據節點 ID,需要去除井號( 說明
傳入本參數前,您還需要傳入 InstanceId 參數,且要求實例為集群或讀寫分離架構。
| r-bp1zxszhcgatnx****-db-0 |
InstanceScene | string | 否 | 產品系列,取值如下:
| professional |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "493B7308-D9C2-55F6-B042-0313BD63****",
"AvailableZones": {
"AvailableZone": [
{
"ZoneId": "cn-hangzhou-h",
"ZoneName": "杭州 可用區H",
"RegionId": "cn-hangzhou",
"SupportedEngines": {
"SupportedEngine": [
{
"Engine": "Redis",
"SupportedEditionTypes": {
"SupportedEditionType": [
{
"EditionType": "Enterprise",
"SupportedSeriesTypes": {
"SupportedSeriesType": [
{
"SeriesType": "enhanced_performance_type",
"SupportedEngineVersions": {
"SupportedEngineVersion": [
{
"Version": "5.0",
"SupportedArchitectureTypes": {
"SupportedArchitectureType": [
{
"Architecture": "cluster",
"SupportedShardNumbers": {
"SupportedShardNumber": [
{
"ShardNumber": "8",
"SupportedNodeTypes": {
"SupportedNodeType": [
{
"SupportedNodeType": "double",
"AvailableResources": {
"AvailableResource": [
{
"InstanceClassRemark": "16G集群版(8節點)(QPS:1920000 Connections:240000)",
"Capacity": 16384,
"InstanceClass": "redis.amber.logic.sharding.2g.8db.0rodb.24proxy.multithread"
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2023-07-25 | OpenAPI 入參發生變更 | 查看變更詳情 |