華為云計(jì)算 云知識 修改彈性伸縮策略(V2版本)UpdateScalingV2Policy
修改彈性伸縮策略(V2版本)UpdateScalingV2Policy

 

功能介紹

修改指定 彈性伸縮 策略。

修改彈性伸縮策略V2版本與V1版本的區(qū)別在于,V2版本支持修改伸縮資源類型。

調(diào)試

您可以在API Explorer中調(diào)試該接口。

URI

PUT /autoscaling-api/v2/{project_id}/scaling_policy/{scaling_policy_id}

表1 參數(shù)說明

參數(shù)

是否必選

參數(shù)類型

描述

project_id

String

項(xiàng)目ID

scaling_policy_id

String

伸縮策略ID,可參考查詢資源綁定的伸縮策略 (V2版本)獲取。

請求參數(shù)

表2 請求參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

scaling_policy_name

String

伸縮策略名稱(1-64個字符),只能包含中文、字母、數(shù)字、下劃線或中劃線。

scaling_policy_type

String

策略類型

  • 告警策略:ALARM(與alarm_id對應(yīng))
  • 定時策略:SCHEDULED(與scheduled_policy對應(yīng))
  • 周期策略:RECURRENCE(與scheduled_policy對應(yīng))

scaling_resource_id

String

伸縮資源ID,伸縮組唯一標(biāo)識或帶寬唯一標(biāo)識。

scaling_resource_type

string

伸縮資源類型

  • 伸縮組:SCALING_GROUP
  • 帶寬:BANDW IDT H

alarm_id

String

告警ID,即告警規(guī)則的ID,當(dāng)scaling_policy_type為ALARM時該項(xiàng)必選,此時scheduled_policy不生效。

修改成功后,會自動為該告警ID對應(yīng)的告警規(guī)則的alarm_actions字段增加類型為autoscaling的告警觸發(fā)動作。

告警ID通過查詢 云監(jiān)控 告警規(guī)則列表獲取,請參考《云監(jiān)控API參考》的“查詢告警規(guī)則列表”。

scheduled_policy

scheduled_policy object

定時、周期任務(wù)策略,當(dāng)scaling_policy_type為SCHEDULED或RECURRENCE時該項(xiàng)必選,此時alarm_id不生效。詳情請見表 scheduled_policy字段數(shù)據(jù)結(jié)構(gòu)說明。

scaling_policy_action

scaling_policy_action object

策略執(zhí)行具體動作。詳情請見表 scaling_policy_action字段數(shù)據(jù)結(jié)構(gòu)說明。

cool_down_time

Integer

冷卻時間,取值范圍0-86400,單位是秒。

description

String

伸縮策略描述(1-256個字符)。

表3 scheduled_policy字段數(shù)據(jù)結(jié)構(gòu)說明

參數(shù)

是否必選

參數(shù)類型

描述

launch_time

String

觸發(fā)時間,遵循UTC時間。

  • 如果scaling_policy_type為SCHEDULED,則格式為:YYYY-MM-DDThh:mmZ。
  • 如果scaling_policy_type為RECURRENCE,則格式為:hh:mm。

recurrence_type

String

周期觸發(fā)類型,scaling_policy_type為RECURRENCE時該項(xiàng)必選。

  • Daily:每天執(zhí)行一次
  • Weekly:每周指定天執(zhí)行一次。
  • Monthly:每月指定天執(zhí)行一次。

recurrence_value

String

周期觸發(fā)任務(wù)數(shù)值,scaling_policy_type為RECURRENCE時該項(xiàng)必選。

  • 類型為Daily時,該字段為null,表示每天執(zhí)行
  • 類型為Weekly時,該字段取值范圍為1-7,1表示星期日,以此類推,以“,”分割,例如:1,3,5。
  • 類型為Monthly時,該字段取值范圍為1-31,分別表示每月的日期,以“,”分割,例如:1,10,13,28。

start_time

String

周期策略重復(fù)執(zhí)行開始時間,遵循UTC時間。

格式為:YYYY-MM-DDThh:mmZ。

end_time

String

周期策略重復(fù)執(zhí)行結(jié)束時間,遵循UTC時間,scaling_policy_type為RECURRENCE時該項(xiàng)必選。

當(dāng)為周期類型策略時,不得早于當(dāng)前時間和開始時間

格式為:YYYY-MM-DDThh:mmZ。

表4 scaling_policy_action字段數(shù)據(jù)結(jié)構(gòu)說明

參數(shù)

是否必選

參數(shù)類型

描述

operation

String

操作選項(xiàng),默認(rèn)為ADD。
  • 當(dāng)scaling_resource_type為SCALING_GROUP,支持如下操作:
    • ADD:增加
    • REMOVE/REDUCE:減少
    • SET:設(shè)置為
  • 當(dāng)scaling_resource_type為BANDWIDTH,支持如下操作:
    • ADD:增加
    • REDUCE:減少
    • SET:設(shè)置為

size

Integer

操作大小,取值范圍為0到300的整數(shù),默認(rèn)為1。只有操作為SET時取值可以為0,其余操作取值均不能為0。

  • 當(dāng)scaling_resource_type為SCALING_GROUP時,size為實(shí)例個數(shù),取值范圍為0到300的整數(shù),默認(rèn)為1。
  • 當(dāng)scaling_resource_type為BANDWIDTH時,size表示帶寬大小,單位為Mbit/s,取值范圍為1到300的整數(shù),默認(rèn)為1。
  • 當(dāng)scaling_resource_type為SCALING_GROUP時,size和percentage參數(shù)只能選其中一個進(jìn)行配置。

percentage

Integer

操作百分比,操作為ADD或REMOVE/REDUCE時取值范圍為1到20000的整數(shù),操作為SET時取值范圍為0到20000的整數(shù)。

  • 當(dāng)scaling_resource_type為SCALING_GROUP時,size和percentage參數(shù)只能選其中一個進(jìn)行配置,如果size和percentage參數(shù)均無配置,則size默認(rèn)為1。
  • 當(dāng)scaling_resource_type為BANDWIDTH時,不支持配置percentage參數(shù)。

limits

Integer

操作限制

當(dāng)scaling_resource_type為BANDWIDTH,且operation不為SET時,limits參數(shù)生效,單位為Mbit/s。

  • 當(dāng)operation為ADD時,limits表示帶寬可調(diào)整的上限;
  • 當(dāng)operation為REDUCE時,limits表示帶寬可調(diào)整的下限。

請求示例

修改一個ID為0h327883-324n-4dzd-9c61-68d03ee191dd的伸縮策略,策略名稱修改為hth_aspolicy_1,告警ID修改為al1513822380493GvlJKZwA8,冷卻時間修改為900秒,策略執(zhí)行具體動作修改為增加1Mbit/s,且上限為10Mbit/s。

PUT https://{Endpoint}/autoscaling-api/v2/{project_id}/scaling_policy/0h327883-324n-4dzd-9c61-68d03ee191dd

{
    "alarm_id": "al1513822380493GvlJKZwA8",
    "cool_down_time": 900,
    "scaling_policy_action": {
           "size": 1,
           "operation": "ADD",
           "limits": 10
    },
    "scaling_policy_name": "hth_aspolicy_1",
    "scaling_policy_type": "ALARM"
}

響應(yīng)參數(shù)

表5 響應(yīng)參數(shù)

參數(shù)

參數(shù)類型

描述

scaling_policy_id

String

伸縮策略ID。

響應(yīng)示例

{ 
     "scaling_policy_id": "0h327883-324n-4dzd-9c61-68d03ee191dd"  
}

返回值

  • 正常

    200

  • 異常

    返回值

    說明

    400 Bad Request

    服務(wù)器未能處理請求。

    401 Unauthorized

    被請求的頁面需要用戶名和密碼。

    403 Forbidden

    對被請求的頁面訪問禁止。

    404 Not Found

    服務(wù)器無法找到被請求的頁面。

    405 Method Not Allowed

    請求中指定的方法不被允許。

    406 Not Acceptable

    服務(wù)器生成的響應(yīng)無法被客戶端所接受。

    407 Proxy Authentication Required

    用戶必須首先使用代理服務(wù)器進(jìn)行驗(yàn)證,這樣請求才會被處理。

    408 Request Timeout

    請求超出了服務(wù)器的等待時間。

    409 Conflict

    由于沖突,請求無法被完成。

    500 Internal Server Error

    請求未完成。服務(wù)異常。

    501 Not Implemented

    請求未完成。服務(wù)器不支持所請求的功能。

    502 Bad Gateway

    請求未完成。服務(wù)器從上游服務(wù)器收到一個無效的響應(yīng)。

    503 Service Unavailable

    請求未完成。系統(tǒng)暫時異常。

    504 Gateway Timeout

    網(wǎng)關(guān)超時。

錯誤碼

請參考錯誤碼。