查询DCDN实时日志主题详情 DescribeDcdnLogTopic--全站加速-火山引擎

文档中心

立即注册

全站加速

日志管理接口

查询DCDN实时日志主题详情 DescribeDcdnLogTopic

基于指定的日志主题 ID，查询全站加速（DCDN）向日志服务（TLS）投递实时日志的主题的详情。您可以调用 ListDcdnLogTopic 接口获取 DCDN 实时日志的主题列表。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=DescribeDcdnLogTopic&Version=2021-04-01

请求参数

Query

参数名称	数据类型	是否必选	参数说明
Action	String	是	接口名称。当前 API 的名称为 `DescribeDcdnLogTopic`。
Version	String	是	接口版本。当前 API 的版本为 `2021-04-01`。

Body

参数名称	数据类型	是否必选	参数说明	示例
LogTopicId	String	否	指定您需要查询的日志主题 ID。如不指定，接口会返回所有 DCDN 实时日志主题中的第一个主题。	`b32a9b49-9f5e-4e81-xxxx-xxxxxxxxxxxx`

返回参数

参数名称	数据类型	参数说明	示例
LogTopicName	String	日志主题名称。	`test-topic`
TopicName	String	日志主题名称。同 LogTopicName。	`test-topic`
Description	String	日志主题描述，默认值 `由云服务dcdn创建`。	`由云服务dcdn创建`
DeliveryStatus	String	您可以基于日志主题的投递状态筛选： `Running`：投递中 `Stop`：已暂停 `Exception`：异常	`Running`
CollectRegion	String	采集区域： `mainland`：中国大陆 `oversea`：全球(除中国大陆)	`mainland`
DeliveryTarget	String	始终返回固定值 `TLS`。	`TLS`
LogPublicIP	Boolean	是否开启记录外网 IP。更多详情，请参见记录外网 IP。	`true`
AutoSplit	Boolean	是否开启分区的自动分裂功能。DCDN 在创建日志主题时会默认启用此选项，所以返回结果应为 `true`。更多详情，请参见自动分裂分区。	`true`
MaxSplitShard	Integer	最大分区数量。	`50`
ShardCount	Integer	当前分区数量。	`10`
EnableTracking	Boolean	是否开启了 WebTracking 功能。更多详情，请参见使用 WebTracking 采集日志。	`true`
Ttl	Integer	日志在日志服务中的保存时长。单位：天。	`7`
AccountId	String	账号 ID。	`123456789012`
Domain	String[]	该日志主题所关联的域名列表。	`["www.example.com", "test.example.com"]`
LogProjectId	String	日志项目 ID。	`4925f1a2-b2bb-415e-a3a3-xxxxxxxxxxxx`
LogRegion	String	日志存储的区域。	`cn-shanghai`
LogTopicId	String	日志主题 ID。	`8624cdf5-bac3-4ecb-a053-xxxxxxxxxxxx`
LogType	String	返回固定值 `dcdn_access_log`。	`dcdn_access_log`
SamplingRate	String	日志投递的采样率。	`100%`
ResourceId	String	系统提供的资源 ID。	`tlstopictask-NufVvRxxxxxxxxxxxxxxx`
LogContent	Object[]	日志主题关联的日志字段列表。
created_at	String	日志主题创建时间戳。	`2024-09-05T12:54:30.768Z`
updated_at	String	日志主题更新时间戳。	`2025-12-24T09:45:10.953Z`

请求示例

POST https://open.volcengineapi.com?Action=DescribeDcdnLogTopic&Version=2021-04-01
{
    "LogTopicId": "b32a9b49-9f5e-4e81-xxxx-xxxxxxxxxxxx"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20251225103242F55C2F0F1BB036A9D122",
        "Action": "DescribeDcdnLogTopic",
        "Version": "2021-04-01",
        "Service": "DCDN",
        "Region": "cn-north-01"
    },
    "Result": {
        "AccountId": "2100052941",
        "AutoSplit": true,
        "CollectRegion": "mainland",
        "DeliveryStatus": "Running",
        "DeliveryTarget": "TLS",
        "Description": "由云服务dcdn创建",
        "Domain": [
            "www.example.com",
            "test.example.com"
        ],
        "EnableTracking": false,
        "LogContent": [
            {
                "Name": "client_ip",
                "Template": "${client_ip}",
                "Type": "string"
            },
            {
                "Name": "ds_req_time",
                "Template": "${ds_req_time}",
                "Type": "string"
            },
            {
                "Name": "ds_http_uri",
                "Template": "${ds_http_uri}",
                "Type": "string"
            },
            {
                "Name": "ds_http_method",
                "Template": "${ds_http_method}",
                "Type": "string"
            },
            {
                "Name": "ds_http_protocol",
                "Template": "${ds_http_protocol}",
                "Type": "string"
            },
            {
                "Name": "ds_http_status",
                "Template": "${ds_http_status}",
                "Type": "string"
            },
            {
                "Name": "ds_http_resp_size",
                "Template": "${ds_http_resp_size}",
                "Type": "string"
            },
            {
                "Name": "client_ip_province",
                "Template": "${client_ip_province}",
                "Type": "string"
            },
            {
                "Name": "client_ip_isp",
                "Template": "${client_ip_isp}",
                "Type": "string"
            },
            {
                "Name": "ds_http_referer",
                "Template": "${ds_http_referer}",
                "Type": "string"
            },
            {
                "Name": "ds_http_ua",
                "Template": "${ds_http_ua}",
                "Type": "string"
            },
            {
                "Name": "ds_http_range",
                "Template": "${ds_http_range}",
                "Type": "string"
            },
            {
                "Name": "ds_http_domain",
                "Template": "${ds_http_domain}",
                "Type": "string"
            },
            {
                "Name": "ds_http_resp_content_type",
                "Template": "${ds_http_resp_content_type}",
                "Type": "string"
            },
            {
                "Name": "ds_http_req_size",
                "Template": "${ds_http_req_size}",
                "Type": "string"
            },
            {
                "Name": "ds_http_cache_status",
                "Template": "${ds_http_cache_status}",
                "Type": "string"
            },
            {
                "Name": "ds_http_resp_content_length",
                "Template": "${ds_http_resp_content_length}",
                "Type": "string"
            }
        ],
        "LogProjectId": "4925f1a2-b2bb-415e-xxxx-xxxxxxxxxxx",
        "LogPublicIP": true,
        "LogRegion": "cn-shanghai",
        "LogTopicId": "8624cdf5-bac3-4ecb-xxxx-xxxxxxxxxxx",
        "LogTopicName": "test-log-1",
        "LogType": "dcdn_access_log",
        "MaxSplitShard": 50,
        "ProjectName": "",
        "ResourceId": "tlstopictask-NufVvR8WVsxxxxxxxxxxxx",
        "SamplingRate": "100%",
        "ShardCount": 10,
        "TopicName": "test-log-1",
        "Ttl": 7,
        "created_at": "2024-09-05T12:54:30.768Z",
        "updated_at": "2025-12-24T09:45:10.953Z"
    }
}

最近更新时间：2025.12.25 15:02:56

这个页面对您有帮助吗？

有用

无用