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 返回结构发生变更 | 查看变更详情 |