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

 

功能介紹

根據(jù)輸入條件過(guò)濾查詢 彈性伸縮 組列表。查詢結(jié)果分頁(yè)顯示。

  • 可根據(jù)伸縮組名稱,伸縮配置ID,伸縮組狀態(tài),企業(yè)項(xiàng)目ID,起始行號(hào),記錄條數(shù)進(jìn)行條件過(guò)濾查詢。
  • 若不加過(guò)濾條件默認(rèn)最多查詢租戶下20條伸縮組信息。

調(diào)試

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

URI

GET /autoscaling-api/v1/{project_id}/scaling_group

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

表1 參數(shù)說(shuō)明

參數(shù)

是否必選

參數(shù)類型

描述

project_id

String

項(xiàng)目ID

scaling_group_name

String

伸縮組名稱。

支持模糊匹配。

scaling_configuration_id

String

伸縮配置ID,通過(guò)查詢彈性伸縮配置列表接口獲取,請(qǐng)參考查詢彈性伸縮配置列表。

scaling_group_status

String

伸縮組狀態(tài),取值如下:

  • INSERVICE:正常狀態(tài)
  • PAUSED:停用狀態(tài)
  • ERROR:異常狀態(tài)
  • DELETING:刪除中
  • FREEZED:已凍結(jié)

start_number

Integer

查詢的起始行號(hào),默認(rèn)為0。最小值為0,最大值沒(méi)有限制。

limit

Integer

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

enterprise_project_id

String

企業(yè)項(xiàng)目ID,當(dāng)傳入all_granted_eps時(shí)表示查詢?cè)撚脩羲惺跈?quán)的企業(yè)項(xiàng)目下的伸縮組列表,如何獲取企業(yè)項(xiàng)目ID,請(qǐng)參考查詢企業(yè)項(xiàng)目列表。

說(shuō)明:

華為云帳號(hào)和擁有全局權(quán)限的 IAM 用戶可以查詢?cè)撚脩羲猩炜s組列表。

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

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

無(wú)

請(qǐng)求示例

查詢伸縮組名稱為as-group-test且伸縮配置ID為1d281494-6085-4579-b817-c1f813be835f的伸縮組列表。

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

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

參數(shù)

參數(shù)類型

描述

total_number

Integer

總記錄數(shù)。

start_number

Integer

查詢的開(kāi)始記錄號(hào)。

limit

Integer

查詢記錄數(shù)。

scaling_groups

Array of scaling_groups objects

伸縮組列表。

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

參數(shù)

參數(shù)類型

描述

scaling_group_name

String

伸縮組名稱。

scaling_group_id

String

伸縮組ID。

scaling_group_status

String

伸縮組狀態(tài)。

scaling_configuration_id

String

伸縮配置ID。

scaling_configuration_name

String

伸縮配置名稱。

current_instance_number

Integer

伸縮組中當(dāng)前實(shí)例數(shù)。

desire_instance_number

Integer

伸縮組中期望實(shí)例數(shù)。

min_instance_number

Integer

伸縮組中最小實(shí)例數(shù)。

max_instance_number

Integer

伸縮組中最大實(shí)例數(shù)。

cool_down_time

Integer

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

lb_listener_id

String

經(jīng)典型 負(fù)載均衡 監(jiān)聽(tīng)器ID,多個(gè)負(fù)載均衡監(jiān)聽(tīng)器ID以逗號(hào)分隔。

lbaas_listeners

Array of lbaas_listeners objects

增強(qiáng)型負(fù)載均衡器信息,詳情請(qǐng)見(jiàn)表 lbaas_listeners字段數(shù)據(jù)結(jié)構(gòu)說(shuō)明。

available_zones

Array of strings

可用區(qū)信息。

networks

Array of networks objects

網(wǎng)絡(luò)信息,詳情請(qǐng)見(jiàn)表5

security_groups

Array of security_groups objects

安全組信息,詳情請(qǐng)見(jiàn)表8

create_time

String

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

vpc_id

String

伸縮組所在的VPC ID。

detail

String

伸縮組詳情。當(dāng)伸縮活動(dòng)失敗時(shí),在此處記錄錯(cuò)誤信息。

is_scaling

Boolean

伸縮組伸縮標(biāo)志。

health_periodic_audit_method

String

健康檢查方式。

health_periodic_audit_time

Integer

健康檢查的間隔時(shí)間。

health_periodic_audit_grace_period

Integer

健康狀況檢查寬限期。

instance_terminate_policy

String

移除策略。

notifications

Array of strings

通知方式:

EMAIL為發(fā)送郵件通知。

該通知方式已經(jīng)被廢除,建議給彈性伸縮組配置通知功能。請(qǐng)參考通知。

delete_publicip

Boolean

刪除 云服務(wù)器 是否刪除云服務(wù)器綁定的彈性IP。

delete_volume

Boolean

刪除云服務(wù)器是否刪除云服務(wù)器綁定的數(shù)據(jù)盤(pán)。

cloud_location_id

String

該參數(shù)為預(yù)留字段。

enterprise_project_id

String

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

activity_type

String

伸縮組活動(dòng)類型。

multi_az_priority_policy

String

伸縮組擴(kuò)縮容時(shí)目標(biāo)AZ選擇的優(yōu)先級(jí)策略。

description

String

伸縮組描述。

iam_agency_name

String

委托。

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

參數(shù)

參數(shù)類型

描述

listener_id

String

監(jiān)聽(tīng)器ID

pool_id

String

后端云服務(wù)器組ID

protocol_port

Integer

后端協(xié)議號(hào),指后端云服務(wù)器監(jiān)聽(tīng)的端口。

weight

Integer

權(quán)重,指后端云服務(wù)器經(jīng)分發(fā)得到的請(qǐng)求數(shù)量的比例。

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

參數(shù)

參數(shù)類型

描述

id

String

子網(wǎng)的網(wǎng)絡(luò)ID。

ipv6_enable

Boolean

是否啟用IPv6。取值為true時(shí),標(biāo)識(shí)此網(wǎng)卡已啟用ipv6。默認(rèn)取值為false。

ipv6_bandwidth

ipv6_bandwidth object

綁定的IPv6共享帶寬,默認(rèn)為空,表示不綁定IPv6的共享帶寬。

allowed_address_pairs

Array of allowed_address_pairs objects

是否開(kāi)啟源/目的檢查開(kāi)關(guān)。

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

參數(shù)

參數(shù)類型

描述

id

String

IPv6共享帶寬的ID。

表7 allowed_address_pairs字段數(shù)據(jù)結(jié)構(gòu)說(shuō)明

參數(shù)

參數(shù)類型

描述

ip_address

String

是否開(kāi)啟源/目的檢查開(kāi)關(guān)。

默認(rèn)是開(kāi)啟,不允許置空。

  • 關(guān)閉:1.1.1.1/0
  • 開(kāi)啟:除“1.1.1.1/0”以外的其余值均按開(kāi)啟處理
表8 security_groups字段數(shù)據(jù)結(jié)構(gòu)說(shuō)明

參數(shù)

參數(shù)類型

描述

id

String

安全組ID

響應(yīng)示例

{
    "limit": 20,
    "scaling_groups": [
        {
            "networks": [
                {
                    "id": "a8327883-6b07-4497-9c61-68d03ee193a",
                    "ipv6_enable": true,
                    "ipv6_bandwidth": 
                        {
                            "id": "076ee2ff-f23e-4338-b8ac-1bc7278532d5"
                        }
                }
            ],
            "available_zones": [
                   "XXXa",
                   "XXXb"
            ],
            "detail": null,
            "scaling_group_name": "as-group-test",
            "scaling_group_id": "77a7a397-7d2f-4e79-9da9-6a35e2709150",
            "scaling_group_status": "INSERVICE",
            "scaling_configuration_id": "1d281494-6085-4579-b817-c1f813be835f",
            "scaling_configuration_name": "healthCheck",
            "current_instance_number": 0,
            "desire_instance_number": 1,
            "min_instance_number": 0,
            "max_instance_number": 500,
            "cool_down_time": 300,
            "lb_listener_id": "f06c0112570743b51c0e8fbe1f235bab",
            "security_groups": [
                {
                    "id": "8a4b1d5b-0054-419f-84b1-5c8a59ebc829"
                }
            ],
            "create_time": "2015-07-23T02:46:29Z",
            "vpc_id": "863ccae2-ee85-4d27-bc5b-3ba2a198a9e2",
            "health_periodic_audit_method": "ELB_AUDIT",
            "health_periodic_audit_time": 5,
            "health_periodic_audit_grace_period": 600,
            "instance_terminate_policy": "OLD_CONFIG_OLD_INSTANCE",
            "is_scaling": false,
            "delete_publicip": false,
           "enterprise_project_id": "c92b1a5d-6f20-43f2-b1b7-7ce35e58e413",
            "multi_az_priority_policy": "PICK_FIRST",
            "iam_agency_name":"test"
        }
    ],
    "total_number": 1,
    "start_number": 0
}

返回值

  • 正常

    200

  • 異常

    返回值

    說(shuō)明

    400 Bad Request

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

    401 Unauthorized

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

    403 Forbidden

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

    404 Not Found

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

    405 Method Not Allowed

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

    406 Not Acceptable

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

    407 Proxy Authentication Required

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

    408 Request Timeout

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

    409 Conflict

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

    500 Internal Server Error

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

    501 Not Implemented

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

    502 Bad Gateway

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

    503 Service Unavailable

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

    504 Gateway Timeout

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

錯(cuò)誤碼

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