You need to enable JavaScript to run this app.
文档中心
云安全中心

云安全中心

复制全文
下载 pdf
HIDS_AGENT
ListAgentProxies - 获取所有代理
复制全文
下载 pdf
ListAgentProxies - 获取所有代理

分页查询代理配置及其服务器、客户端和在线状态汇总。Name 支持包含匹配,Address 为精确匹配;Slim=true 时仅返回 Name 和 Address,false 或不传时返回完整信息。

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数
类型
是否必填
示例值
描述
Action
String
是

ListAgentProxies

要执行的操作,取值:ListAgentProxies。

Version
String
是

2024-05-08

API的版本,取值:2024-05-08。

PageNumber
Long
是

1

翻页页码,取值范围为 1 及以上

PageSize
Long
是

20

每页记录数,取值范围为 1~5000

SortBy
String
否

LastHeartbeatTime

排序字段;不传时使用接口默认排序

SortOrder
String
否

Desc

排序顺序

  • Asc 升序排列
  • Desc 降序排列
Name
String
否

proxy

代理名称,支持包含匹配;不传时不按名称筛选

Address
String
否

proxy.example.com:8080

代理连接地址,精确匹配;不传时不按地址筛选

Slim
Boolean
否

false

是否返回精简结果。true:仅返回 Name 和 Address;false 或不传:返回服务器数、客户端数和状态等完整信息

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数
类型
示例值
描述
TotalCount
Long

1

全部数据条数

PageNumber
Long

1

当前页面

PageSize
Long

20

页面大小

Data
Array of Object

--

分页业务数据,具体元素结构见各接口响应声明

请求示例

POST /?Action=ListAgentProxies&Version=2024-05-08 HTTP/1.1
Host: seccenter.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20241120T080538Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20241120/cn-beijing/seccenter/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "Address": "proxy.example.com:8080",
  "Name": "proxy",
  "PageNumber": 1,
  "PageSize": 20,
  "Slim": false,
  "SortBy": "LastHeartbeatTime",
  "SortOrder": "Desc"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20241120165538010234567890",
    "Action": "ListAgentProxies",
    "Version": "2024-05-08",
    "Service": "seccenter",
    "Region": "cn-beijing"
  },
  "Result": {
    "Data": [
      {
        "Address": "proxy.example.com:8080",
        "ClientNumber": 120,
        "Name": "proxy-001",
        "ServerNumber": 2,
        "Status": "allOnline"
      }
    ],
    "PageNumber": 1,
    "PageSize": 20,
    "TotalCount": 1
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码
错误码
错误信息
说明
400
MissingParameter

The required parameter %s is missing.

请求参数缺失,请检查参数是否已正确传入。

400
InvalidParameter

The specified parameter %s is invalid.

请求参数错误,请检查参数传递内容是否正确。

400
OperationDenied

Operation is denied because the specified resource is in use.

不允许的操作,请检查当前资源是否被占用

403
OperationDenied.TenantUnauthorized(%s)

The request has failed due to tenant not found(%s)

未授权的租户操作

500
InternalError

The request has failed due to an unknown error.

服务器内部错误,请稍后重试或联系技术支持。

500
DBOperateError

The request has failed because database return error: %s

数据库操作异常,请稍后重试或联系技术支持。

最近更新时间:2026.08.21 20:30:49
这个页面对您有帮助吗?
有用
有用
无用
无用