查询IP列表
功能介绍
查询IP列表接口用于获取IP地址。
接口约束
- 区域限制：仅支持西南-贵阳一区域。
- API流量限制：所有用户对该API的总请求次数上限，1分钟内不超过1000次。
- 用户流量限制：单个用户对该API的请求次数上限，1分钟内不超过200次。
- 限流响应：超出限流阈值时，API将返回HTTP 429状态码（Too Many Requests）。
- 重试建议：遇到限流时，建议等待60秒后重试。
URI
POST /v1/{project_id}/maas/monitoring/source-ips
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释：项目ID。关于如何获取项目ID，请参见获取项目ID和名称。 约束限制：不涉及。 取值范围：只能由小写英文字母和数字组成，长度32字符。 默认取值：不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释：用户Token。通过调用IAM服务的获取用户Token接口获取（响应消息头中X-Subject-Token的值）。获取方式请参见认证鉴权。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
service_type |
是 |
Integer |
参数解释：服务类型。 约束限制：不涉及。 取值范围：枚举类型，取值如下：
默认取值：不涉及。 |
|
limit |
是 |
Integer |
参数解释：分页条数，表示本次最多返回多少条数据。 约束条件：不涉及。 取值范围：分页条数需要大于0。 默认取值：不涉及。 |
|
offset |
否 |
Integer |
参数解释：分页偏移量，表示跳过多少条数据查询后面的数据。 约束限制：不涉及。 取值范围：大于等于0。 默认取值：不涉及。 |
|
api_keys |
否 |
Array of strings |
参数解释：API Key列表，根据传入的API Key列表筛选。 Maas的服务支持API Key调用和在线体验两种方式。请参见管理API Key和MaaS在线体验。
约束限制：不涉及。 取值范围： 传入的API Key需满足长度 1-128 字符，仅支持大小写字母、数字、下划线 (_)、短横线 (-)。 默认取值：不涉及。 |
|
ip_search |
否 |
String |
参数解释：模糊查询IP地址，传入该参数可以查询以该参数值开头IP地址。 约束限制：不涉及。 取值范围：传入IPv4 地址前缀（如 "192.168"、"10.0"等）。 默认取值：不涉及。 |
|
start_time |
是 |
Long |
参数解释：开始时间，毫秒时间戳。 约束限制：结束时间与开始时间相差不超过30天。 取值范围：数值大于0，小于等于end_time的取值。 默认取值：不涉及。 |
|
end_time |
是 |
Long |
参数解释：结束时间，毫秒时间戳。 约束限制：结束时间与开始时间相差不超过30天。 取值范围：数值大于0。 默认取值：不涉及。 |
|
service_id |
否 |
String |
参数解释：服务ID。服务ID在创建服务时即可在返回体中获取，也可通过获取服务列表接口获取当前用户拥有的服务，其中service_id字段即为服务ID。 约束限制：不涉及。 取值范围：长度 1-128 字符，仅支持大小写字母、数字、下划线 (_)、短横线 (-)。 默认取值：不涉及。 |
|
timezone |
否 |
String |
参数解释：时区。 约束限制：不涉及。 取值范围：遵循IANA时区规范（如Asia/Shanghai、UTC）。 默认取值：Asia/Shanghai（东八区）。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total |
Integer |
参数解释：查询到的数据总数。 取值范围：不涉及。 |
|
items |
Array of strings |
参数解释：IP列表。 取值范围：不涉及。 |
|
count |
Integer |
参数解释：当前返回分页最大数据条数。 取值范围：其值等于入参limit。 |
状态码：400
请求示例
模糊查询以 192 开头的，预置服务类型，东八区的IP地址数据，以10条每页从第一条数据开始展示。
/v1/{project_id}/maas/monitoring/source-ips
{
"limit" : 10,
"offset" : 0,
"start_time" : 1768406400000,
"end_time" : 1769529757467,
"timezone" : "Asia/Shanghai",
"service_type" : 2,
"ip_search" : "192"
}
响应示例
状态码：200
成功响应。
{
"total" : 2,
"items" : [ "192.168.1.148", "192.168.4.99" ],
"count" : 10
}
状态码：400
失败响应。
{
"error_code" : "ModelArts.0104",
"error_msg" : "参数无效，问题：结束时间不能早于开始时间。"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
成功响应。 |
|
400 |
失败响应。 |
错误码
请参见错误码。
