查詢DDoS高防實(shí)例的詳情列表。
接口說明
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下:
- 操作:是指具體的權(quán)限點(diǎn)。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
yundun-ddoscoo:DescribeInstances | get |
|
| 無 |
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ResourceGroupId | string | 否 | DDoS 高防實(shí)例在資源管理服務(wù)中所屬的資源組 ID。 不設(shè)置該參數(shù)表示默認(rèn)資源組。 | rg-acfm2pz25js**** |
PageNumber | string | 是 | 分頁查詢時,設(shè)置當(dāng)前頁面的頁碼。 | 1 |
PageSize | string | 是 | 分頁查詢時,設(shè)置每頁包含實(shí)例的數(shù)量。取值范圍:1~50。 | 10 |
Ip | string | 否 | 要查詢的 DDoS 高防實(shí)例的 IP 地址。 | 203.107.XX.XX |
Remark | string | 否 | 要查詢的 DDoS 高防實(shí)例的備注。支持模糊查詢。 | doc-test |
Edition | integer | 否 | 要查詢的 DDoS 高防實(shí)例的防護(hù)套餐版本。取值:
| 9 |
Enabled | integer | 否 | 要查詢的 DDoS 高防實(shí)例的業(yè)務(wù)流量轉(zhuǎn)發(fā)狀態(tài)。取值:
| 1 |
ExpireStartTime | long | 否 | 要查詢的 DDoS 高防實(shí)例的最早到期時間(即查詢到期時間在 ExpireStartTime 之后的 DDoS 高防實(shí)例)。使用時間戳表示,單位:毫秒。 | 1640361500000 |
ExpireEndTime | long | 否 | 要查詢的 DDoS 高防實(shí)例的最晚到期時間(即查詢到期時間在 ExpireEndTime 之前的 DDoS 高防實(shí)例)。使用時間戳表示,單位:毫秒。 | 1640361700000 |
InstanceIds | array | 否 | 要查詢的 DDoS 高防實(shí)例的 ID 列表。最多可配置 200 個 DDoS 高防實(shí)例。 | |
string | 否 | 要查詢的 DDoS 高防實(shí)例的 ID。 | ddoscoo-cn-7pp2g9ed**** | |
Status | array | 否 | 要查詢的 DDoS 高防實(shí)例的狀態(tài)列表。最多可配置 2 個 DDoS 高防實(shí)例狀態(tài)。 | |
integer | 否 | 要查詢的 DDoS 高防實(shí)例的狀態(tài)。取值:
| 1 | |
Tag | array<object> | 否 | 要查詢的 DDoS 高防實(shí)例綁定的標(biāo)簽列表。 | |
object | 否 | |||
Key | string | 否 | 要查詢的 DDoS 高防實(shí)例綁定的標(biāo)簽鍵。N 的最大值:200,即最多可配置 200 個標(biāo)簽鍵。配置規(guī)則如下:
說明
標(biāo)簽鍵(Key)和標(biāo)簽值(Value)必須成對出現(xiàn)。
| test-key |
Value | string | 否 | 要查詢的 DDoS 高防實(shí)例綁定的標(biāo)簽值。N 的最大值:200,即最多可配置 200 個標(biāo)簽值。配置規(guī)則如下:
說明
標(biāo)簽鍵(Key)和標(biāo)簽值(Value)必須成對出現(xiàn)。
| test-value |
調(diào)用 API 時,除了本文中該 API 的請求參數(shù),還需加入阿里云 API 公共請求參數(shù)。公共請求參數(shù)的詳細(xì)介紹,請參見公共參數(shù)。
調(diào)用 API 的請求格式,請參見本文示例中的請求示例。
返回參數(shù)
示例
正常返回示例
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"
}
]
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2023-06-30 | OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |
2023-05-17 | OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |