文档中心

云安全中心

请输入

HIDS_TENANT

GetTLSInfo - 获取现有日志信息

获取当前账户的日志分析服务开通、授权、容量、告警阈值及各日志主题配置。ProjectID 为当前项目 ID，ProjectId、TopicId、VulnTopicId 和顶层 StorageDays 仅为旧版本兼容字段，新接入应使用 ProjectID 及各 TopicConfig 字段。

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	GetTLSInfo	要执行的操作，取值：GetTLSInfo。
Version	String	是	2024-05-08	API的版本，取值：2024-05-08。

返回参数

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

参数	类型	示例值	描述
PortChangeTopicConfig	Object	--	端口变更日志
VarmorTopicConfig	Object	--	Varmor日志
LoginTopicConfig	Object	--	登录流水日志
ProcessStartTopicConfig	Object	--	进程启动日志
QuotaTotal	Long	102400	日志容量配额，单位 MB；-1 表示后付费且容量不设上限
Threshold	Long	80	容量告警阈值；预付费单位为百分比、范围 50-100，后付费单位为 GB、范围 0-1000000，后付费取 0 表示不告警
VulnTopicId	String	tls-vuln-topic-id-001	旧版本兼容的漏洞扫描日志主题 ID；新接入请读取 VulnTopicConfig.TopicID
AlarmTopicConfig	Object	--	v1.2.0修改+新增日志主题配置安全告警日志
Authorized	Boolean	true	当前账户是否已完成日志服务授权
QuotaUsed	Long	1024	已使用日志容量，单位 MB
StorageDays	Long	30	以下字段为1.2.0升级时的兼容字段旧版本兼容的存储时长，单位天；新接入请读取各 TopicConfig.StorageDays
ProjectID	String	tls-project-id-001	当前日志项目 ID
TopicId	String	tls-topic-id-001	旧版本兼容的安全告警日志主题 ID；新接入请读取 AlarmTopicConfig.TopicID
VulnTopicConfig	Object	--	漏洞扫描日志
BashAuditTopicConfig	Object	--	bash内置命令审计日志
Open	Boolean	true	是否已开通日志分析服务

请求示例

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

{}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20241120165538010234567890",
    "Action": "GetTLSInfo",
    "Version": "2024-05-08",
    "Service": "seccenter",
    "Region": "cn-beijing"
  },
  "Result": {
    "AlarmTopicConfig": {
      "StorageDays": 30,
      "Switch": true,
      "TopicID": "tls-topic-id-001"
    },
    "Authorized": true,
    "BashAuditTopicConfig": {
      "StorageDays": 30,
      "Switch": true,
      "TopicID": "tls-topic-id-001"
    },
    "LoginTopicConfig": {
      "StorageDays": 30,
      "Switch": true,
      "TopicID": "tls-topic-id-001"
    },
    "Open": true,
    "PortChangeTopicConfig": {
      "StorageDays": 30,
      "Switch": true,
      "TopicID": "tls-topic-id-001"
    },
    "ProcessStartTopicConfig": {
      "StorageDays": 30,
      "Switch": true,
      "TopicID": "tls-topic-id-001"
    },
    "ProjectID": "tls-project-id-001",
    "ProjectId": "tls-project-id-001",
    "QuotaTotal": 102400,
    "QuotaUsed": 1024,
    "StorageDays": 30,
    "Threshold": 80,
    "TopicId": "tls-topic-id-001",
    "VarmorTopicConfig": {
      "StorageDays": 30,
      "Switch": true,
      "TopicID": "tls-topic-id-001"
    },
    "VulnTopicConfig": {
      "StorageDays": 30,
      "Switch": true,
      "TopicID": "tls-topic-id-001"
    },
    "VulnTopicId": "tls-vuln-topic-id-001"
  }
}

错误码

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

状态码	错误码	错误信息	说明
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.	服务器内部错误，请稍后重试或联系技术支持。

最近更新时间：2026.10.30 14:11:14

这个页面对您有帮助吗？

有用

无用

云安全中心

调试 #

请求参数 #

返回参数 #

请求示例 #

返回示例 #

错误码 #

调试

请求参数

返回参数

请求示例

返回示例

错误码