ListIpBlocks
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| cmn:ListIpBlocks |
|
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| MaxResults | integer | 否 | 返回結果的最大個數。 | 50 |
| NextToken | string | 否 | 當總結果個數大于 MaxResults 時，用于翻頁的 token。 | 50 |
| InstanceId | string | 否 | 實例 ID。 | InstanceId |
| NetType | string | 否 | 網絡類型：
| PRIVATE |
| TreeType | boolean | 否 | 是否樹狀展示地址段， | true |
| IpBlockCode | string | 否 | 地址段。 | 10.0.0.0/8 |
| Ip | string | 否 | IP 地址，單個 IP 地址查詢。 | 10.0.0.0 |
| Status | string | 否 | 地址段狀態：
| using |
| ZoneName | string | 否 | 園區名稱，NetType 為 PUBLIC 有效。 | xx園區 |
| NetBusiness | string | 否 | 公網地址類型，NetType 為 PUBLIC 有效。 | GUEST |
| Category | string | 否 | 地址類別：IPV4/IPV6。 | IPV4 |
| SubNetBusiness | string | 否 | 業務類型小類。 | static |
| TopParent | boolean | 否 | 是否只獲取頂層父類。 | false |
| ParentUid | string | 否 | 父段 UID。 | ip_block-12345aaaaabcd |
| LeafNode | boolean | 否 | 是否只獲取葉子結點。 | false |
| IpList | array | 否 | IP 地址列表，批量 IP 地址查詢。 | |
| string | 否 | IP 地址。 | 127.0.0.1 | |
| BottomNode | boolean | 否 | 是否只獲取底部結點。 | false |
| ExtAttributes | object | 否 | 自定義屬性 |
返回參數
示例
正常返回示例
JSON格式
{
"TotalCount": 100,
"RequestId": "RequestId",
"NextToken": 10,
"MaxResults": 10,
"IpBlock": [
{
"IpBlockId": "adaieaoweif_s3834",
"IpBlockCode": "10.0.0.0/8",
"ParentId": "123",
"NetType": "24",
"Status": "using",
"Ownership": "xx廠商",
"Category": "IPV4",
"Description": "Description",
"BackupDeviceName": "ASW-2",
"ZoneLayer": [
{
"Name": "小型園區",
"Value": "xx-xx"
}
],
"BusinessTypeId": "asdaasd",
"BusinessTypeName": "互聯地址",
"NetBusiness": "INC",
"Application": "員工出口IP",
"DeviceName": "ASW-1",
"ZoneName": "xx園區",
"IsLock": 0,
"IpBlocks": [
"[1.0.0.0/8]"
],
"Tasks": [
{
"Ip": "127.0.0.1/28",
"Status": "OK",
"Msg": "OK",
"IpList": [
{
"Ip": "127.0.0.1",
"Ping": "FAIL/OK",
"DevId": "device_xxx",
"DevName": "TEST",
"Origin": "DOMAIN"
}
],
"Domain": "PING-TEST",
"TaskId": "b302f0eb-c97a-44f8-8557-320e4da7a68c",
"GmtCreateTime": "2022-11-20 11:12:43",
"GmtModifiedTime": "2022-11-20 11:12:43",
"TotalIpCount": 14
}
],
"LimitZoneTypes": "zone-xxx",
"SubBusinessTypeName": "商業網",
"Abbr": "TEST-別名",
"SplitRate": 0.38,
"QueryIpList": [
"127.0.0.1"
],
"ExtAttributes": {
"test": "test",
"test2": 1
}
}
]
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | InvalidParameter%s | The specified parameter %s is invalid. | 參數無效，請檢查參數 |
| 400 | ActionNotAvailable | The action is not available. | 操作不可用 |
| 400 | Duplicate%s%s | The %s %s value is already occupied. | 資源屬性值已經被占用 |
| 400 | Missing%s | You must specify the parameter %s. | 必填參數沒有填。請檢查調用時是否填寫了此參數，并重試請求。 |
| 400 | ScriptCompileError.Line%s | A compile error occurred at line %s. | 腳本編譯錯誤 |
| 400 | InvalidMonitorItem.NotSame | The selected list contains different monitoring items. Please select the subscription items of the same monitoring item. | 列表中包含不同的監控項，請選擇相同監控項 |
| 400 | InvalidParameter.TooMuch | You cannot fill in device whitelist and blacklist at the same time. | 設備白名單和設備黑名單不能同時填寫 |
| 400 | InvalidScheme.NotEnable | The scheme is not enabled. | 方案未啟用 |
| 400 | InvalidScheme.StepNotAvailable | Some steps of the scheme are unavailable. | 方案存在不可用步驟 |
| 400 | IdempotentParameterMismatch | The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical. | 用了一個已經使用過的 ClientToken，但此次請求內容卻又與上一次使用該 Token 的 request 不一樣。 |
| 400 | InvalidTimeStamp | The timestamp value must not be earlier than the current time. | 傳入時間不得早于當前時間 |
| 400 | InvalidTimeStamp.Format | The format of specified timestamp or date value is invalid. | 時間戳格式不對。請檢查您的時間戳的格式是否正確。 |
| 400 | NoAccess.ResourceInUse | The resource % is used by resource %s. | 使用中的資源不支持該操作 |
| 400 | NoMoreResources | No more resources are available. %s | 無更多資源 |
| 400 | QuotaTooMuch | Quota exceeds limit. | 資源配額超過限制。 |
| 400 | ServiceUnOpen | Your service has not been opened. | 您的服務尚未開通 |
| 400 | SignatureDoesNotMatch | 簽名不通過 | - |
| 403 | NoAccess.BuiltIn%s | The built in configuration does not permit the operation. | 內置配置不允許操作 |
| 403 | NoPermission | 沒有權限 | - |
| 404 | Invalid%s.NotFound | The specified resource %s does not exist. | 找不到對應資源 |
| 404 | ServiceNotFound | 后端服務未找到 | - |
| 500 | InternalError | 服務器內部錯誤 | - |
| 503 | ServiceUnavailable | 服務不可用 | - |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2023-05-17 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |