全部產品
Search
文件中心

Simple Log Service:ListCollectionPolicies - 列出雲產品日誌採集的採集規則

更新時間:Sep 18, 2025

列出雲產品日誌採集的採集規則。

介面說明

該介面服務地址只能是華東 2(上海)、新加坡、河源專屬雲汽車合規(cn-heyuan-acdr-1)。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

當前API暫無授權資訊透出。

請求文法

GET /collectionpolicy HTTP/1.1

請求參數

名稱

類型

必填

描述

樣本值

productCode

string

產品的編碼。

oss

dataCode

string

日誌類型編碼。

access_log

policyName

string

規則名稱。

your_log_policy

size

integer

分頁查詢時,設定的每頁行數。預設值為 50,最多返回 100 個 規則資訊。

50

offset

integer

查詢開始行,預設值為 0。

0

instanceId

string

執行個體 ID。如果配置執行個體 ID,則可以根據執行個體 ID 反向查詢執行個體命中的規則,必須和 productCode、dataCode 結合使用。

your-test-bucket1

centralProject

string

中心化轉投目的 Project。如果配置中心化轉投目的 Project,則可以根據 Project 反向查詢有多少規則配置了中心化轉投到該 centralProejct 下。

your-central-project1

返回參數

名稱

類型

描述

樣本值

headers

object

Content-Type

string

Server

string

Content-Length

string

Date

string

Connection

string

x-log-requestid

string

object

返回結構體。

totalCount

integer

總資料條數。

1

currentCount

integer

當前頁資料條數。

1

data

array<object>

當前查詢條件下按照分頁配置返回的規則資料。

object

規則詳情。

productCode

string

產品編碼。

oss

dataCode

string

日誌類型編碼。

access_log

policyName

string

規則名稱。

your_log_policy

enabled

boolean

是否開啟。

true

policyConfig

object

採集規則配置。

resourceMode

string

資源採集模式。

all

regions

array

執行個體所屬的地區集合。

string

地區 ID。

cn-hangzhou

instanceIds

array

執行個體 ID 集合。

string

執行個體 ID。

your-test-bucket1

resourceTags

object

資源標籤。

{"tag1":"value1","tag2":"value2"}

centralizeEnabled

boolean

是否開啟中心化轉投。

false

centralizeConfig

object

中心化轉投配置。

destRegion

string

中心化轉投目的地區。

cn-beijing

destProject

string

中心化轉投目的專案。

your-sls-project-in-beijing

destLogstore

string

中心化轉投目的日誌庫。

your-sls-logstore-in-beijing

destTTL

integer

中心化轉投目的儲存天數。

0

resourceDirectory

object

資來源目錄配置, 如有配置,否則為空白

accountGroupType

string

在該資來源目錄下,全選模式 all 或自訂模式 custom

all,custom

members

array

當資來源目錄配置為 custom 模式時,對應的成員帳號列表

string

阿里雲帳號 Uid

165***********50

dataConfig

object

若且唯若日誌類型為全域日誌類型時支援配置,例如 productCode 為 sls 時的情境。否則為空白。

dataRegion

string

若且唯若日誌類型為全域日誌類型時支援的配置,例如 productCode 為 sls 時的情境,表示首次配置時全域日誌將被採集到對應地區。

cn-hangzhou

dataProject

string

若且唯若日誌類型為全域日誌類型時有效,例如 productCode 為 sls 時的情境,如果為空白,表示日誌被採集到該帳號在特定 dataRegion 下的預設專屬的 Project 中。

""

internalPolicy

boolean

是否是內建規則策略,內建規則不允許修改、刪除。

false

policyUid

string

規則所屬的帳號阿里雲帳號 Uid,如果該規則由資來源目錄管理員或者資來源目錄委派管理員建立,則為其阿里雲帳號 Uid。

148***********50

statistics

array<object>

當前查詢條件下返回的統計資料。

object

按照 productCode 的規則統計結果

productCode

string

產品編碼。

oss

policySourceList

array<object>

規則來源列表。

object

規則來來源物件。

policyUid

string

規則所屬的帳號阿里雲帳號 Uid,如果該規則由資來源目錄管理員或者資來源目錄委派管理員建立,則為其阿里雲帳號 Uid。

148***********50

policyName

string

規則名稱

policy_name1_from148

樣本

正常返回樣本

JSON格式

{
  "totalCount": 1,
  "currentCount": 1,
  "data": [
    {
      "productCode": "oss",
      "dataCode": "access_log",
      "policyName": "your_log_policy",
      "enabled": true,
      "policyConfig": {
        "resourceMode": "all",
        "regions": [
          "cn-hangzhou"
        ],
        "instanceIds": [
          "your-test-bucket1\n"
        ],
        "resourceTags": {
          "tag1": "value1",
          "tag2": "value2"
        }
      },
      "centralizeEnabled": false,
      "centralizeConfig": {
        "destRegion": "cn-beijing\n",
        "destProject": "your-sls-project-in-beijing\n",
        "destLogstore": "your-sls-logstore-in-beijing\n",
        "destTTL": 0
      },
      "resourceDirectory": {
        "accountGroupType": "all,custom",
        "members": [
          "165***********50"
        ]
      },
      "dataConfig": {
        "dataRegion": "cn-hangzhou",
        "dataProject": "\"\""
      },
      "internalPolicy": false,
      "policyUid": "148***********50"
    }
  ],
  "statistics": [
    {
      "productCode": "oss",
      "policySourceList": [
        {
          "policyUid": "148***********50",
          "policyName": "policy_name1_from148"
        }
      ]
    }
  ]
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情