GetLogRule - 获取节点日志采集规则--边缘智能-火山引擎

文档中心

立即注册

导航

GetLogRule - 获取节点日志采集规则

最近更新时间：2025.04.22 15:34:59首次发布时间：2025.04.22 11:47:46

调用本接口获取指定节点的日志采集规则。

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	GetLogRule	要执行的操作，取值：GetLogRule。
Version	String	是	2022-01-01	API的版本，取值：2022-01-01。
project_id	String	否	p-2100001281-zf9ll	要查询的边缘智能项目ID。您可以调用ListProject接口获取所有边缘智能项目ID。
node_name	String	否	sxn012-bdvbaz	要查询的节点ID。您可以调用ListHCINew接口获取指定边缘智能项目下的所有节点ID。

返回参数

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

参数	类型	示例值	描述
rule_id	String	p-2100001281-zf9ll-sxn012-bdvbaz	规则ID。格式为：{project_id}-{node_name}。
rule_name	String	log1	规则名称。
rule_type	String	1	采集类型。该参数有以下取值： 1：主机文件路径 2：容器标准输出
file_path	Array of String	["/"]	文件路径。
pod_name	Array of String	["device-virtual-hnf84"]	作为日志采集源的工作负载名称列表。
pod_range	Integer	1	容器范围。该参数有以下取值： 1：全部容器 2：部分容器
is_running	Boolean	false	是否开启日志采集。
tls_project	String	vei	日志项目名称。
tls_topic	String	p-2100001281-zf9ll	日志主题。
tls_tag	String	sxn012-bdvbaz	日志标签。

请求示例

POST /?Action=GetLogRule&Version=2022-01-01 HTTP/1.1
Host: open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20250418T081854Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250418/cn-beijing/vei_api/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "project_id": "p-2100001281-zf9ll",
  "node_name": "sxn012-bdvbaz"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "2025041816185814215108904857EEF8",
    "Action": "GetLogRule",
    "Version": "2022-01-01",
    "Service": "vei_api",
    "Region": "cn-beijing"
  },
  "Result": {
    "rule_id": "p-2100001281-zf9ll-sxn012-bdvbaz",
    "rule_name": "log1",
    "rule_type": "1",
    "file_path": [
      "/"
    ],
    "pod_range": 1,
    "is_running": false,
    "tls_project": "vei",
    "tls_topic": "p-2100001281-zf9ll",
    "tls_tag": "sxn012-bdvbaz"
  }
}

错误码

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

状态码	错误码	错误信息	说明
400	90000015	The account is not authenticated by real name	账号未实名认证。
400	90000021	The account is not authorized to access project	越权访问其他账号下的项目。
400	90000025	The AI Gateway API Key is only allowed for verified enterprise account	仅支持企业认证账号创建边缘大模型网关密钥。
400	20000004	record not found error	未找到记录。
500	90000009	Internal service errors	服务内部错误。