調用GetCollectionPolicy擷取指定的雲產品日誌採集規則-Log Service-阿里雲 - Simple Log Service

呼叫GetCollectionPolicy取得對應的規則。

介面說明

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

調試

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

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

log:GetCollectionPolicy

get

*CollectionPolicy

acs:log::{#accountId}:collectionpolicy/{#policyName}

log:TLSVersion

無

請求文法

GET /collectionpolicy/{policyName} HTTP/1.1

路徑參數

名稱	類型	必填	描述	樣本值
policyName	string	是	規則名稱。	your_log_policy

請求參數

名稱	類型	必填	描述	樣本值
productCode	string	否	產品編碼。	oss
dataCode	string	否	日誌類型編碼。	access_log

返回參數

名稱	類型	描述	樣本值
	object	傳回結構體。
collectionPolicy	object	傳回規則。
centralizeConfig	object	中心化轉投設定。
destLogstore	string	中心化轉投目的日誌庫。	your-sls-logstore-in-beijing
destProject	string	中心化轉投目的專案。	your-sls-project-in-beijing
destRegion	string	中心化轉投目的地域。	cn-beijing
destTTL	integer	中心化轉投目的天數。	0
centralizeEnabled	boolean	是否開啟中心化儲存。	false
dataCode	string	日誌類型編碼。	access_log
dataConfig	object	當且僅當日誌類型為全域日誌類型時支援的設定，例如 productCode 為 sls 時的場景。否則為空。
dataProject	string	當且僅當日誌類型為全域日誌類型時有效，例如 productCode 為 sls 時的場景，如果為空，表示日誌被採集到該帳號在特定 dataRegion 下的預設專屬的 Project 中。	""
dataRegion	string	當且僅當日誌類型為全域日誌類型時支援的設定，例如 productCode 為 sls 時的場景，表示首次設定時全域日誌將被採集到對應地域。	cn-beijing
enabled	boolean	是否開啟。	true
internalPolicy	boolean	是否為內建規則策略，內建規則不允許修改、刪除。	false
policyConfig	object	採集規則設定。
instanceIds	array	執行個體 ID 集合。
	string	執行個體 ID。	your-test-bucket1
regions	array	執行個體所屬的地域集合，支援萬用字元。
	string	地域 ID。	cn-hangzhou
resourceMode	string	資源採集模式。	all
resourceTags	object	資源標籤。	{"tag1":"value1","tag2":"value2"}
policyName	string	規則名稱。	your_log_policy
policyUid	string	規則所屬的帳號阿里雲帳號 Uid，如果該規則由資源目錄管理員或者資源目錄委派管理員建立，則為其阿里雲帳號 Uid。	148***********50
productCode	string	產品編碼。	oss
resourceDirectory	object	資源目錄設定，如有設定，否則為空。
accountGroupType	string	在該資源目錄下，全選模式 all 或自訂模式 custom。	all,custom
members	array	當資源目錄設定為 custom 模式時，對應的成員帳號清單。
	string	阿里雲帳號 Uid。	165***********50

樣本

正常返回樣本

JSON格式

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

錯誤碼

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

變更歷史

更多資訊，參考變更詳情。