查詢DDoS高防執行個體的詳情列表。
介面說明
本介面用於分頁查詢當前阿里雲帳號擁有的 DDoS 高防執行個體的詳情,例如,執行個體的 ID、版本、到期時間、業務轉寄狀態等。
QPS 限制
本介面的單使用者 QPS 限制為 10 次/秒。超過限制,API 呼叫將會被限流,這可能影響您的業務,請合理調用。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
yundun-ddoscoo:DescribeInstances |
get |
*全部資源
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| ResourceGroupId |
string |
否 |
DDoS 高防執行個體在資源管理服務中所屬的資源群組 ID。 不設定該參數表示預設資源群組。 |
rg-acfm2pz25js**** |
| PageNumber |
string |
是 |
分頁查詢時,設定當前頁面的頁碼。 |
1 |
| PageSize |
string |
是 |
分頁查詢時,設定每頁包含執行個體的數量。取值範圍:1~50。 |
10 |
| Ip |
string |
否 |
要查詢的 DDoS 高防執行個體的 IP 位址。 |
203.107.XX.XX |
| Remark |
string |
否 |
要查詢的 DDoS 高防執行個體的備忘。支援模糊查詢。 |
doc-test |
| Edition |
integer |
否 |
要查詢的 DDoS 高防執行個體的防護套餐版本。取值:
|
9 |
| Enabled |
integer |
否 |
要查詢的 DDoS 高防執行個體的業務流量轉寄狀態。取值:
|
1 |
| ExpireStartTime |
integer |
否 |
要查詢的 DDoS 高防執行個體的最早到期時間(即查詢到期時間在 ExpireStartTime 之後的 DDoS 高防執行個體)。使用時間戳表示,單位:毫秒。 |
1640361500000 |
| ExpireEndTime |
integer |
否 |
要查詢的 DDoS 高防執行個體的最晚到期時間(即查詢到期時間在 ExpireEndTime 之前的 DDoS 高防執行個體)。使用時間戳表示,單位:毫秒。 |
1640361700000 |
| InstanceIds |
array |
否 |
要查詢的 DDoS 高防執行個體的 ID 列表。最多可配置 200 個 DDoS 高防執行個體。 |
|
|
string |
否 |
要查詢的 DDoS 高防執行個體的 ID。 |
ddoscoo-cn-7pp2g9ed**** |
|
| Status |
array |
否 |
要查詢的 DDoS 高防執行個體的狀態列表。最多可配置 2 個 DDoS 高防執行個體狀態。 |
|
|
integer |
否 |
要查詢的 DDoS 高防執行個體的狀態。取值:
|
1 |
|
| Tag |
array<object> |
否 |
要查詢的 DDoS 高防執行個體綁定的標籤列表。 |
|
|
object |
否 |
|||
| Key |
string |
否 |
要查詢的 DDoS 高防執行個體綁定的標籤鍵。N 的最大值:200,即最多可配置 200 個標籤鍵。配置規則如下:
說明
標籤鍵(Key)和標籤值(Value)必須成對出現。 |
test-key |
| Value |
string |
否 |
要查詢的 DDoS 高防執行個體綁定的標籤值。N 的最大值:200,即最多可配置 200 個標籤值。配置規則如下:
說明
標籤鍵(Key)和標籤值(Value)必須成對出現。 |
test-value |
調用 API 時,除了本文中該 API 的請求參數,還需加入阿里雲 API 公用請求參數。公用請求參數的詳細介紹,請參見公用參數。
調用 API 的請求格式,請參見本文樣本中的請求樣本。
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| TotalCount |
integer |
查詢到的 DDoS 高防執行個體的總數量。 |
1 |
| RequestId |
string |
本次調用請求的 ID,是由阿里雲為該請求產生的唯一識別碼,可用於排查和定位問題。 |
A0AF40CC-814A-5A86-AEAA-6F19E88B8A39 |
| Instances |
array<object> |
DDoS 高防執行個體的詳情列表。 |
|
|
object |
|||
| Status |
integer |
執行個體的狀態。取值:
|
1 |
| IpMode |
string |
執行個體的 IP 轉寄模式。取值:
|
fnat |
| DebtStatus |
integer |
執行個體的欠費狀態。取值固定為 0,表示不欠費,因為 DDoS 高防服務目前只支援訂用帳戶的預付費計費方式。 |
0 |
| Edition |
integer |
執行個體的防護套餐版本。取值:
|
9 |
| IpVersion |
string |
執行個體的 IP 協議版本。取值:
|
Ipv4 |
| ExpireTime |
integer |
執行個體的到期時間。使用時間戳表示,單位:毫秒。 |
1640361600000 |
| Remark |
string |
執行個體的備忘。 |
doc-test |
| CreateTime |
integer |
執行個體的建立時間。使用時間戳表示,單位:毫秒。 |
1637751953000 |
| Enabled |
integer |
執行個體的業務流量轉寄狀態。取值:
|
1 |
| InstanceId |
string |
執行個體的 ID。 |
ddoscoo-cn-7pp2g9ed**** |
| IsFirstOpenBw |
integer |
執行個體是否開啟過 95 彈性業務頻寬計費模式。取值:
|
0 |
| IsFirstOpenQps |
integer |
執行個體是否開啟過 95 彈性 QPS 計費模式。取值:
|
0 |
| Ip |
string |
DDoS 高防執行個體的 IP。 |
203.199.XX.XX |
樣本
正常返回樣本
JSON格式
{
"TotalCount": 1,
"RequestId": "A0AF40CC-814A-5A86-AEAA-6F19E88B8A39",
"Instances": [
{
"Status": 1,
"IpMode": "fnat",
"DebtStatus": 0,
"Edition": 9,
"IpVersion": "Ipv4",
"ExpireTime": 1640361600000,
"Remark": "doc-test",
"CreateTime": 1637751953000,
"Enabled": 1,
"InstanceId": "ddoscoo-cn-7pp2g9ed****",
"IsFirstOpenBw": 0,
"IsFirstOpenQps": 0,
"Ip": "203.199.XX.XX"
}
]
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。