華為云計算 云知識 查詢彈性伸縮策略列表(V2版本)ListScalingV2Policies
查詢彈性伸縮策略列表(V2版本)ListScalingV2Policies

 

功能介紹

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

  • 查詢彈性伸縮策略V2版本與V1版本的區(qū)別在于,V2版本響應含伸縮資源類型。
  • 可根據(jù)伸縮策略名稱,策略類型,伸縮策略ID,起始行號,記錄數(shù)進行條件過濾查詢。
  • 若不加過濾條件默認查詢該租戶下指定資源下最多20條伸縮策略信息。

調試

您可以在API Explorer中調試該接口。

URI

GET /autoscaling-api/v2/{project_id}/scaling_policy/{scaling_resource_id}/list

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

表1 參數(shù)說明

參數(shù)

是否必選

參數(shù)類型

描述

project_id

String

項目ID

scaling_resource_id

String

伸縮資源ID

scaling_policy_name

String

伸縮策略名稱。

支持模糊匹配。

scaling_policy_type

String

策略類型:

  • 告警策略:ALARM
  • 定時策略:SCHEDULED
  • 周期策略:RECURRENCE

scaling_policy_id

String

伸縮策略ID

start_number

Integer

查詢的起始行號,默認為0。最小值為0。

limit

Integer

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

請求參數(shù)

請求示例

查詢ID為8ade64b5-d685-40b8-8582-4ce306ea37a6的資源下策略類型為周期策略的伸縮策略列表信息。

響應參數(shù)

表2 響應參數(shù)

參數(shù)

參數(shù)類型

描述

total_number

Integer

總記錄數(shù)

start_number

Integer

查詢的起始行號

limit

Integer

查詢記錄數(shù)

scaling_policies

Array of scaling_policies objects

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

表3 scaling_policies字段數(shù)據(jù)結構說明

名稱

參數(shù)類型

說明

scaling_policy_name

String

伸縮策略名稱。

支持模糊匹配。

scaling_policy_id

String

伸縮策略ID

scaling_resource_id

String

伸縮資源ID

scaling_resource_type

string

伸縮資源類型

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

policy_status

String

伸縮策略狀態(tài)

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

scaling_policy_type

String

伸縮策略類型:

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

alarm_id

String

告警ID

scheduled_policy

scheduled_policy object

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

scaling_policy_action

scaling_policy_action object

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

cool_down_time

Integer

冷卻時間,單位秒。

create_time

String

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

meta_data

meta_data object

附加信息。詳情請見表 meta_data字段數(shù)據(jù)結構說明。

description

String

伸縮策略描述。

表4 scheduled_policy字段數(shù)據(jù)結構說明

參數(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ā)類型。

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

recurrence_value

String

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

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

start_time

String

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

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

end_time

String

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

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

表5 scaling_policy_action字段數(shù)據(jù)結構說明

參數(shù)

參數(shù)類型

描述

operation

String

操作選項。

  • ADD:增加
  • REDUCE:減少
  • SET:設置為

size

Integer

操作實例個數(shù)。

percentage

Integer

操作實例百分比。

limits

Integer

操作限制

表6 meta_data字段數(shù)據(jù)結構說明

參數(shù)

參數(shù)類型

描述

metadata_bandwidth_share_type

String

伸縮帶寬策略中帶寬對應的共享類型。

metadata_eip_id

String

伸縮帶寬策略中帶寬對應的EIP的ID。

metadata_eip_address

String

伸縮帶寬策略中帶寬對應的EIP地址。

響應示例

{
    "limit": 20,
    "total_number": 3,
    "start_number": 0,
    "scaling_policies": [
        {
            "scaling_policy_id": "803a35a5-38fb-4d27-a042-496c14bc1fb8",
            "scaling_policy_name": "as-policy-7a75",
            "scaling_resource_id": "8ade64b5-d685-40b8-8582-4ce306ea37a6",
            "scaling_resource_type": "SCALING_GROUP",
            "scaling_policy_type": "RECURRENCE",
            "scheduled_policy": {
                "launch_time": "03:30",
                "recurrence_type": "Daily",
                "start_time": "2017-08-28T03:08Z",
                "end_time": "2017-09-01T03:08Z"
            },
            "cool_down_time": 900,
            "scaling_policy_action": {
                "operation": "ADD",
                "size": 1
            },
            "policy_status": "INSERVICE",
            "create_time": "2017-08-31T03:02:41Z"
        },
        {
            "scaling_policy_id": "535fd67e-276b-409c-879e-52f4e09e14bb",
            "scaling_policy_name": "as-policy-7a75",
            "scaling_resource_id": "8ade64b5-d685-40b8-8582-4ce306ea37a6",
            "scaling_resource_type": "SCALING_GROUP",
            "scaling_policy_type": "RECURRENCE",
            "scheduled_policy": {
                "launch_time": "21:30",
                "recurrence_type": "Daily",
                "start_time": "2017-08-27T21:08Z",
                "end_time": "2017-08-31T21:08Z"
            },
            "cool_down_time": 900,
            "scaling_policy_action": {
                "operation": "ADD",
                "size": 1
            },
            "policy_status": "INSERVICE",
            "create_time": "2017-08-31T07:35:05Z"
        },
        {
            "scaling_policy_id": "37df92f8-73cb-469e-a420-c15f445d2ee1",
            "scaling_policy_name": "as-policy-7a75",
            "scaling_resource_id": "8ade64b5-d685-40b8-8582-4ce306ea37a6",
            "scaling_resource_type": "SCALING_GROUP",
            "scaling_policy_type": "RECURRENCE",
            "scheduled_policy": {
                "launch_time": "22:30",
                "recurrence_type": "Daily",
                "start_time": "2017-08-27T22:08Z",
                "end_time": "2017-08-31T22:08Z"
            },
            "cool_down_time": 900,
            "scaling_policy_action": {
                "operation": "ADD",
                "size": 1
            },
            "policy_status": "INSERVICE",
            "create_time": "2017-08-31T07:41:06Z"
        }
    ]
}

返回值

  • 正常

    200

  • 異常

    返回值

    說明

    400 Bad Request

    服務器未能處理請求。

    401 Unauthorized

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

    403 Forbidden

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

    404 Not Found

    服務器無法找到被請求的頁面。

    405 Method Not Allowed

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

    406 Not Acceptable

    服務器生成的響應無法被客戶端所接受。

    407 Proxy Authentication Required

    用戶必須首先使用代理服務器進行驗證,這樣請求才會被處理。

    408 Request Timeout

    請求超出了服務器的等待時間。

    409 Conflict

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

    500 Internal Server Error

    請求未完成。服務異常。

    501 Not Implemented

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

    502 Bad Gateway

    請求未完成。服務器從上游服務器收到一個無效的響應。

    503 Service Unavailable

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

    504 Gateway Timeout

    網(wǎng)關超時。

錯誤碼

請參考錯誤碼。