CheckInstallAgentClient - 检测安装Agent--云安全中心-火山引擎

HIDS_AGENT

CheckInstallAgentClient - 检测安装Agent

检测安装Agent

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	CheckInstallAgentClient	要执行的操作，取值：CheckInstallAgentClient。
Version	String	是	2024-05-08	API的版本，取值：2024-05-08。
AgentIDs	Array of String	否	[PGpYC hAphc NOVPB]	AgentIDs

返回参数

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

参数	类型	示例值	描述
AutoAgentIDs	Array of String	["66eac07353890101c02b3310","66eac07353890101c02b3311"]	可以自动开启的AgentID列表
AutoEnableCount	Long	2	可以自动开启安全防护的机器数量
AutoCount	Long	34	可以自动开启安全防护的机器数量
AutoEnableIDs	Array of String	[djHrP VUUPF TOjId]	可以自动开启安全防护的AgentID列表
CurrentQuota	Object	--	当前剩余配额（HitLimit=true时才有效）
AutoInstallAndEnableCount	Long	62	可以自动安装并开启防护的机器数量
HitLimit	Boolean	true	是否达到配额限制
AutoInstallAndEnableIDs	Array of String	[XZpJw NDDMM owjzu]	可以自动安装并开启防护的AgentID列表
ManualCount	Long	77	需要手动开启安全防护的机器数量
RequestQuota	Object	--	当前请求的配额（HitLimit=true时才有效）

请求示例

POST /?Action=CheckInstallAgentClient&Version=2024-05-08HTTP/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

{
  "AgentIDs": [
    "OymGh",
    "VPFvV",
    "PTDIe"
  ]
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20241120165538010234567890",
    "Action": "CheckInstallAgentClient",
    "Version": "2024-05-08",
    "Service": "seccenter",
    "Region": "cn-beijing"
  },
  "Result": {
    "AutoEnableCount": 68,
    "AutoEnableIDs": [
      "NcOIv",
      "OVmLj",
      "ZgCPr"
    ],
    "AutoInstallAndEnableCount": 47,
    "AutoInstallAndEnableIDs": [
      "sXuns",
      "IGLdb",
      "IeXcA"
    ],
    "ManualCount": 70
  }
}

错误码

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

状态码	错误码	错误信息	说明
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	DBOperateError	The request has failed because database return error: %s	数据库操作异常
500	InternalError	The request has failed due to an unknown error.	服务器内部错误

最近更新时间：2026.06.01 14:39:07

这个页面对您有帮助吗？

有用

无用

云安全中心

调试 #

请求参数 #

返回参数 #

请求示例 #

返回示例 #

错误码 #

调试

请求参数

返回参数

请求示例

返回示例

错误码