調用GetConfig接口獲取Logtail配置的詳細信息。
接口說明
- Host 由 Project 名稱和日志服務 Endpoint 構成，您需要在 Host 中指定 Project。
- 已創建并獲取 AccessKey。更多信息，請參見訪問密鑰。
阿里云賬號 AccessKey 擁有所有 API 的訪問權限，風險很高。強烈建議您創建并使用 RAM 用戶進行 API 訪問或日常運維。RAM 用戶需具備操作日志服務資源的權限。具體操作，請參見創建 RAM 用戶及授權。
-
已明確您查詢日志所屬的 Project 名稱、所屬地域等。如何查詢，請參見管理 Project。
-
已獲取 Logtail 采集配置名稱。更多信息，請參見 ListConfig 。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| log:GetConfig | get | *Project acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logtailconfig/{#LogtailConfigName} |
| 無 |
請求語法
GET /configs/{configName} HTTP/1.1
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| project | string | 是 | Project 名稱。 | ali-test-project |
| configName | string | 是 | Logtail 配置名稱。 | logtail-config-sample |
返回參數
示例
正常返回示例
JSON格式
{
"configName": "test-config",
"logSample": "2022-06-14 11:13:29.796 | DEBUG | __main__:<module>:1 - hello world",
"inputType": "file",
"inputDetail": {
"test": "test",
"test2": 1
},
"outputType": "LogService",
"outputDetail": {
"endpoint": "cn-hangzhou-intranet.log.aliyuncs.com",
"logstoreName": "test-logstore",
"region": "cn-hangzhou",
"telemetryType": "logs"
},
"createTime": 1655176807,
"lastModifyTime": 1655176807
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|
暫無變更歷史
| HttpStatusCode | ErrorCode | ErrorMessage | 錯誤碼描述 |
|---|---|---|---|
| 404 | ProjectNotExist | Project does not exist. | Project 不存在。 |
| 404 | ConfigNotExist | Config configName does not exist. | Logtail 配置不存在。 |
| 500 | InternalServerError | Specified Server Error Message. | 內部服務調用錯誤。 |
更多信息，請參見通用錯誤碼。