華為云計(jì)算 云知識(shí) 查詢彈性伸縮策略列表ListScalingPolicies
查詢彈性伸縮策略列表ListScalingPolicies

 

功能介紹

根據(jù)輸入條件過濾查詢 彈性伸縮 策略。查詢結(jié)果分頁顯示。

  • 可根據(jù)伸縮策略名稱,策略類型,伸縮策略ID,起始行號(hào),記錄數(shù)進(jìn)行條件過濾查詢。
  • 若不加過濾條件默認(rèn)查詢租戶下指定伸縮組內(nèi)最多20條伸縮策略信息。

調(diào)試

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

URI

GET /autoscaling-api/v1/{project_id}/scaling_policy/{scaling_group_id}/list

可以在URI后面用‘?’和‘&’添加不同的查詢條件組合。支持參數(shù)說明中所有非必選參數(shù)過濾,請參考請求示例。

表1 參數(shù)說明

參數(shù)

是否必選

參數(shù)類型

描述

project_id

String

項(xiàng)目ID

scaling_group_id

String

伸縮組ID

scaling_policy_name

String

伸縮策略名稱。

支持模糊匹配。

scaling_policy_type

String

策略類型:

  • 告警策略:ALARM
  • 定時(shí)策略:SCHEDULED
  • 周期策略:RECURRENCE

scaling_policy_id

String

伸縮策略ID

start_number

Integer

查詢的起始行號(hào),默認(rèn)為0。最小值為0。

limit

Integer

查詢的記錄條數(shù),默認(rèn)為20。取值范圍為:0~100。

請求參數(shù)

請求示例

查詢ID為e5d27f5c-dd76-4a61-b4bc-a67c5686719a的伸縮組內(nèi),伸縮策略名稱為as-policy-test且策略類型為定時(shí)策略的伸縮策略列表。

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

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

參數(shù)

參數(shù)類型

描述

total_number

Integer

總記錄數(shù)

start_number

Integer

查詢的起始行號(hào)

limit

Integer

查詢記錄數(shù)

scaling_policies

Array of scaling_policies objects

伸縮策略列表,詳情請見表 scaling_policies字段數(shù)據(jù)結(jié)構(gòu)說明。

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

參數(shù)

參數(shù)類型

描述

scaling_group_id

String

伸縮組ID

scaling_policy_name

String

伸縮策略名稱

scaling_policy_id

String

伸縮策略ID

policy_status

String

伸縮策略狀態(tài)

  • INSERVICE:已啟用
  • PAUSED:已停用
  • EXECUTING:執(zhí)行中

scaling_policy_type

String

伸縮策略類型:

  • ALARM:告警策略,此時(shí)alarm_id有返回,scheduled_policy不會(huì)返回。
  • SCHEDULED:定時(shí)策略,此時(shí)alarm_id不會(huì)返回,scheduled_policy有返回,并且recurrence_type、recurrence_value、start_time和end_time不會(huì)返回。
  • RECURRENCE:周期策略,此時(shí)alarm_id不會(huì)返回,scheduled_policy有返回,并且recurrence_type、recurrence_value、start_time和end_time有返回。

alarm_id

String

告警ID

scheduled_policy

scheduled_policy object

定時(shí)、周期任務(wù)策略。詳情請見表 scheduled_policy字段數(shù)據(jù)結(jié)構(gòu)說明。

scaling_policy_action

scaling_policy_action object

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

cool_down_time

Integer

冷卻時(shí)間,單位秒。

create_time

String

創(chuàng)建伸縮策略時(shí)間,遵循UTC時(shí)間。

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

參數(shù)

參數(shù)類型

描述

launch_time

String

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

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

recurrence_type

String

周期觸發(fā)類型。

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

recurrence_value

String

周期觸發(fā)任務(wù)數(shù)值:

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

start_time

String

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

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

end_time

String

周期策略重復(fù)執(zhí)行結(jié)束時(shí)間,遵循UTC時(shí)間。

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

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

名稱

參數(shù)類型

說明

operation

String

操作選項(xiàng)。

  • ADD:增加實(shí)例
  • REMOVE:減少實(shí)例
  • SET:設(shè)置實(shí)例數(shù)為

instance_number

Integer

操作實(shí)例個(gè)數(shù)。

instance_percentage

Integer

操作實(shí)例百分比。

響應(yīng)示例

{
    "limit": 20,
    "total_number": 1,
    "start_number": 0,
    "scaling_policies": [
        {
            "scaling_policy_id": "fd7d63ce-8f5c-443e-b9a0-bef9386b23b3",
            "scaling_group_id": "e5d27f5c-dd76-4a61-b4bc-a67c5686719a",
            "scaling_policy_name": "as-policy-test",
            "scaling_policy_type": "SCHEDULED",
            "scheduled_policy": {
                "launch_time": "2015-07-24T01:21Z"
            },
            "cool_down_time": 300,
            "scaling_policy_action": {
                "operation": "REMOVE",
                "instance_number": 1
            },
            "policy_status": "INSERVICE",
            "create_time": "2015-07-24T01:09:30Z"
        }
    ]
}

返回值

  • 正常

    200

  • 異常

    返回值

    說明

    400 Bad Request

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

    401 Unauthorized

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

    403 Forbidden

    對(duì)被請求的頁面訪問禁止。

    404 Not Found

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

    405 Method Not Allowed

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

    406 Not Acceptable

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

    407 Proxy Authentication Required

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

    408 Request Timeout

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

    409 Conflict

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

    500 Internal Server Error

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

    501 Not Implemented

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

    502 Bad Gateway

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

    503 Service Unavailable

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

    504 Gateway Timeout

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

錯(cuò)誤碼

請參考錯(cuò)誤碼。