華為云計(jì)算 云知識(shí) 查詢彈性伸縮策略全量列表(V2版本)ListAllScalingV2Policies
查詢彈性伸縮策略全量列表(V2版本)ListAllScalingV2Policies

 

功能介紹

根據(jù)輸入條件過濾查詢 彈性伸縮 策略,支持查詢當(dāng)前租戶下全量伸縮策略。查詢結(jié)果分頁顯示。

  • 可根據(jù)伸縮資源ID,伸縮資源類型,伸縮策略名稱,伸縮策略ID,告警ID,企業(yè)項(xiàng)目ID,起始行號(hào),記錄數(shù),排序方式等條件進(jìn)行過濾查詢。
  • 若不加過濾添加默認(rèn)查詢?cè)撟鈶粝伦疃?0條伸縮策略信息。

已釋放EIP對(duì)應(yīng)的伸縮帶寬策略仍然會(huì)占用配額,且只能使用華為云帳號(hào)和有全局權(quán)限的 IAM 用戶進(jìn)行查詢,授予部分企業(yè)項(xiàng)目的IAM用戶查詢不到該伸縮帶寬策略。

調(diào)試

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

URI

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

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

表1 參數(shù)說明

參數(shù)

是否必選

參數(shù)類型

描述

project_id

String

項(xiàng)目ID

scaling_resource_id

String

伸縮資源ID

scaling_resource_type

String

伸縮資源類型

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

scaling_policy_name

String

伸縮策略名稱。

支持模糊匹配。

scaling_policy_id

String

伸縮策略ID

scaling_policy_type

String

策略類型

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

start_number

Integer

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

limit

Integer

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

sort_by

String

排序方法

  • POLICY_NAME:根據(jù)策略名稱排序。
  • TRIGGER_CONDITION:根據(jù)觸發(fā)條件排序,如升序排列時(shí),告警策略最先,其余根據(jù)最近一次觸發(fā)時(shí)間升序排列。
  • CREATE_TIME:根據(jù)策略的創(chuàng)建時(shí)間排序。

order

String

排序順序

  • ASC:升序
  • DESC:降序

enterprise_project_id

String

企業(yè)項(xiàng)目ID。

  • 當(dāng)scaling_resource_type指定為:SCALING_GROUP

    傳入all_granted_eps時(shí):

    • 華為云帳號(hào)和擁有全局權(quán)限的IAM用戶可以查詢?cè)撚脩羲械纳炜s組對(duì)應(yīng)的伸縮策略。
    • 授予部分企業(yè)項(xiàng)目的IAM用戶,可以查詢?cè)撚脩羲惺跈?quán)企業(yè)項(xiàng)目下的伸縮組對(duì)應(yīng)的伸縮策略。
      說明:

      如果授予部分企業(yè)項(xiàng)目的IAM用戶擁有超過100個(gè)企業(yè)項(xiàng)目,則只能返回有權(quán)限的前100個(gè)企業(yè)項(xiàng)目對(duì)應(yīng)伸縮組的伸縮策略列表。

  • 當(dāng)scaling_resource_type指定為:BANDWIDTH

    傳入all_granted_eps時(shí):

    • 華為云帳號(hào)和擁有全局權(quán)限的IAM用戶可以查詢?cè)撚脩羲袔拰?duì)應(yīng)的伸縮策略。
    • 授予部分企業(yè)項(xiàng)目的IAM用戶,可以查詢?cè)撚脩羲惺跈?quán)企業(yè)項(xiàng)目下的帶寬對(duì)應(yīng)的伸縮策略,帶寬在all_granted_eps場景下返回策略請(qǐng)參見《EIP接口參考》查詢帶寬列表
  • 不指定scaling_resource_type

    當(dāng)傳入all_granted_eps時(shí):

    • 華為云帳號(hào)和擁有全局權(quán)限的IAM用戶可以查詢?cè)撚脩羲械纳炜s組和帶寬對(duì)應(yīng)的伸縮策略。
    • 授予部分企業(yè)項(xiàng)目的IAM用戶,可以查詢?cè)撚脩羲惺跈?quán)企業(yè)項(xiàng)目下的伸縮組和帶寬對(duì)應(yīng)的伸縮策略。
      說明:

      如果授予部分企業(yè)項(xiàng)目的IAM用戶擁有超過100個(gè)企業(yè)項(xiàng)目,則只能返回有權(quán)限的前100個(gè)企業(yè)項(xiàng)目對(duì)應(yīng)伸縮組的伸縮策略列表;帶寬在all_granted_eps場景下返回策略請(qǐng)參見《EIP接口參考》查詢帶寬列表

alarm_id

String

告警ID,即告警規(guī)則的ID。

請(qǐng)求參數(shù)

請(qǐng)求示例

查詢伸縮資源ID為8ade64b5-d685-40b8-8582-4ce306ea37a6且策略類型為周期策略的所有伸縮策略。

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

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

參數(shù)

參數(shù)類型

描述

total_number

Integer

總記錄數(shù)。

start_number

Integer

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

limit

Integer

查詢記錄。

scaling_policies

Array of scaling_policies objects

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

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

參數(shù)

參數(shù)類型

描述

scaling_policy_name

String

伸縮策略名稱

scaling_policy_id

String

伸縮策略ID

scaling_resource_id

String

伸縮資源ID

scaling_resource_type

string

伸縮資源類型

  • 伸縮組:SCALING_GROUP
  • 帶寬:BANDWIDTH

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ù)策。詳情請(qǐng)見表 scheduled_policy字段數(shù)據(jù)結(jié)構(gòu)說明。

scaling_policy_action

scaling_policy_action object

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

cool_down_time

Integer

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

create_time

String

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

meta_data

meta_data object

附加信息。詳情請(qǐng)見表 meta_data字段數(shù)據(jù)結(jié)構(gòu)說明。

description

String

伸縮策略描述。

表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ù)

參數(shù)類型

描述

operation

String

操作選項(xiàng)。

  • ADD:增加
  • REDUCE:減少
  • SET:設(shè)置為

size

Integer

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

percentage

Integer

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

limits

Integer

操作限制

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

參數(shù)

參數(shù)類型

描述

metadata_bandwidth_share_type

String

伸縮帶寬策略中帶寬對(duì)應(yīng)的共享類型。

metadata_eip_id

String

伸縮帶寬策略中帶寬對(duì)應(yīng)的EIP的ID。

metadata_eip_address

String

伸縮帶寬策略中帶寬對(duì)應(yīng)的EIP地址。

響應(yīng)示例

{
    "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",
"meta_data": {
                "metadata_eip_id": "263f0886-de6a-4e21-ad83-814ca9f3844e",
                "metadata_eip_address": "255.255.255.255"
            }
        },
        {
            "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",
"meta_data": {
                "metadata_eip_id": "263f0886-de6a-4e21-ad83-814ca9f3844e",
                "metadata_eip_address": "255.255.255.255"
            }
        }
    ]
}

返回值

  • 正常

    200

  • 異常

    返回值

    說明

    400 Bad Request

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

    401 Unauthorized

    被請(qǐng)求的頁面需要用戶名和密碼。

    403 Forbidden

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

    404 Not Found

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

    405 Method Not Allowed

    請(qǐng)求中指定的方法不被允許。

    406 Not Acceptable

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

    407 Proxy Authentication Required

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

    408 Request Timeout

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

    409 Conflict

    由于沖突,請(qǐng)求無法被完成。

    500 Internal Server Error

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

    501 Not Implemented

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

    502 Bad Gateway

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

    503 Service Unavailable

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

    504 Gateway Timeout

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

錯(cuò)誤碼

請(qǐng)參考錯(cuò)誤碼。