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

云安全中心

复制全文
下载 pdf
HIDS_ASSET_HOST
CreateHostTag - 新增主机标签
复制全文
下载 pdf
CreateHostTag - 新增主机标签

为指定主机或符合筛选条件的主机批量添加标签,用于资产分类管理。Tags 为必填;IDList 和 Conditions 均不传时会作用于全部主机。

调试

请求参数

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

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

CreateHostTag

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

Version
String
是

2024-05-08

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

BeforeTag
String
否

old-tag

旧标签名称,仅 UpdateHostTag 使用;其他接口不传时忽略

Conditions
Object
否

--

主机信息筛选条件;IdList 和 Conditions 均不传时不限制主机范围

IdList
Array of String
否

["agent-id-001","agent-id-002"]

指定主机 ID 列表,可通过 ListHostsAgentIDs 接口获取;不传时按 Conditions 筛选

Tags
Array of String
是

["production","web"]

标签名称列表,必填且元素不可重复;标签不能为空字符串

返回参数

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

参数
类型
示例值
描述
Status
String

success

操作状态。success:操作成功;repeat:标签已存在

请求示例

POST /?Action=CreateHostTag&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

{
  "BeforeTag": "old-tag",
  "Conditions": {
    "AgentID": "agent-id-001",
    "AgentIDList": [
      "agent-id-001",
      "agent-id-002"
    ],
    "AgentStatus": [
      "online"
    ],
    "AllHost": false,
    "CloudProviders": [
      "volcengine"
    ],
    "Hostname": "web-server-001",
    "Ip": "192.0.2.10",
    "LeafGroupIDs": [
      "group-id-101",
      "group-id-102"
    ],
    "Os": "linux",
    "Platforms": [
      "Linux"
    ],
    "ProxyName": "proxy-001",
    "ProxyServerName": "proxy-server-001",
    "Regions": [
      "cn-beijing"
    ],
    "Risk": {
      "Alarm": true,
      "Baseline": false,
      "IsRealRiskVul": false,
      "Virus": false,
      "Vuln": true
    },
    "SecurityEnhancement": true,
    "Status": [
      "Protecting"
    ],
    "Tags": [
      "production",
      "web"
    ],
    "TopGroupID": "group-id-001",
    "VirusFileAutoIsolate": false,
    "Visibility": [
      "private"
    ],
    "VpcIds": [
      "vpc-001"
    ]
  },
  "IdList": [
    "agent-id-001",
    "agent-id-002"
  ],
  "Tags": [
    "production",
    "web"
  ]
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20241120165538010234567890",
    "Action": "CreateHostTag",
    "Version": "2024-05-08",
    "Service": "seccenter",
    "Region": "cn-beijing"
  },
  "Result": {
    "Status": "success"
  }
}

错误码

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

状态码
错误码
错误信息
说明
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

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

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