You need to enable JavaScript to run this app.
导航
CheckInstallAgentClient - 检测安装Agent
最近更新时间:2025.04.03 10:57:04首次发布时间:2025.04.03 10:57:04
我的收藏
有用
有用
无用
无用

检测安装Agent

调试

请求参数

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

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

CheckInstallAgentClient

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

Version
String

2024-05-08

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

AgentIDs
Array of String

["i-ycwdlfegw0qbxyxxxxxx","i-ycwdlfegw1qbxyxxxxxx"]

AgentIDs

返回参数

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

参数
类型
示例值
描述
AutoAgentIDs
Array of String

["66eac07353890101c02b3310","66eac07353890101c02b3311"]

可以自动开启的AgentID列表

AutoCount
Integer

34

可以自动开启安全防护的机器数量

CurrentQuota
Object

--

当前剩余配额(HitLimit=true时才有效)

HitLimit
Boolean

true

是否达到配额限制

ManualCount
Integer

39

需要手动开启安全防护的机器数量

RequestQuota
Object

--

当前请求的配额(HitLimit=true时才有效)

请求示例

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

{
  "AgentIDs": [
    "i-ycwdlfegw0qbxyxxxxxx","i-ycwdlfegw1qbxyxxxxxx"
  ]
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "2024121017090402322203511009EAAD",
    "Action": "CheckInstallAgentClient",
    "Version": "2024-05-08",
    "Service": "seccenter",
    "Region": "cn-beijing"
  },
  "Result": {
    "AutoAgentIDs": [
      "i-ycwdlfegw0qbxyxxxxxx","i-ycwdlfegw1qbxyxxxxxx"
    ],
    "AutoCount": 2,
    "CurrentQuota": {
      "Core": 100,
      "HostsCount": 100
    },
    "HitLimit": true,
    "ManualCount": 1,
    "RequestQuota": {
      "Core": 1,
      "HostsCount": 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.

不允许的操作

500
InternalError

The request has failed due to an unknown error.

服务器内部错误

500
DBOperateError

The request has failed because database return error: %s

数据库操作异常