全部產品
Search
文件中心

OpenSearch:DescribeElasticPlan

更新時間:Jul 20, 2026

取得彈性計畫詳情。

介面說明

  • 若已存在同名標準版應用程式,則建立新版本;

  • 在新建版本情況下,autoSwitch 和 realtimeShared 也是必填的;

  • 在新建版本情況下,quota 是自動從上一個版本繼承的;

  • 在新建版本情況下,修改 quota 是無效的。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

當前API暫無授權資訊透出。

請求文法

GET /v4/openapi/app-groups/{appGroupIdentity}/elastic-plans/{planId} HTTP/1.1

路徑參數

名稱

類型

必填

描述

樣本值

appGroupIdentity

string

否

應用程式的名稱、應用程式 ID。

my_app_group_name

planId

integer

否

監控警示計畫 ID。

3200000011

請求參數

名稱

類型

必填

描述

樣本值

dryRun

boolean

否

是否驗證輸入參數資料合法性,預設 false。

取值:

  • true:僅驗證參數合法性。

  • false:驗證參數合法性,建立歸因設定。

true

返回參數

名稱

類型

描述

樣本值

object

Schema of Response

requestId

string

Id of the request

0A6EB64B-B4C8-CF02-810F-E660812972FF

httpCode

integer

HTTP 狀態碼。

  • 1xx:資訊回應 - 請求已接收,正在處理中。

  • 2xx:成功 - 請求動作已被伺服器端成功接收、理解並接受。

  • 3xx:重新導向 - 請求被重新導向,採取進一步行動以完成請求。

  • 4xx:用戶端錯誤 - 請求包含錯誤請求參數、語法或特定請求條件無法滿足。

  • 5xx:伺服器端錯誤 - 伺服器由於其他原因無法滿足請求。

200

code

string

狀態碼。

ElasticPlan.NotFound

message

string

args

Elastic plan not found

result

object

傳回結果。

id

integer

計畫 ID。

11

appGroupId

integer

應用程式 ID。

120123456

name

string

計畫名稱。

plan name

description

string

描述。

desc

scheduleType

string

任務排程類型。

WEEK

customDates

array

星期清單。

string

星期清單。

MONDAY-SUNDAY

startHour

integer

彈性計畫開始時間。

9

endHour

integer

彈性計畫結束時間。

13

elasticLcu

integer

彈性增量 LCU。

100

enabled

boolean

計畫是否啟用。

false

created

integer

建立時間。

1590139542

updated

integer

更新時間。

1581065904

樣本

正常返回樣本

JSON格式

{
  "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
  "httpCode": 200,
  "code": "ElasticPlan.NotFound",
  "message": "Elastic plan not found",
  "result": {
    "id": 11,
    "appGroupId": 120123456,
    "name": "plan name",
    "description": "desc",
    "scheduleType": "WEEK",
    "customDates": [
      "MONDAY-SUNDAY"
    ],
    "startHour": 9,
    "endHour": 13,
    "elasticLcu": 100,
    "enabled": false,
    "created": 1590139542,
    "updated": 1581065904
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情。