全局配置
更新時間 2025-07-07 18:25:42
最近更新時間: 2025-07-07 18:25:42
分享文章
配置說明
每次使用OpenApi 命令時,都需要配置ak、sk、regionId、endpoint四個參數信息
-a, --ak string access_id
-s, --sk string access_key
-e, --endpoint string endpoint
-i, --region_id string region_id推薦置配置文件,將參數信息保存到config.yaml ,簡化后續OpenApi命令使用。
-c, --config string use config.yaml ,such as: --config=huadong1以華東1資源池下創建日志項目openApi為例,下面兩個命令等同
./ctlts project createProject --project_name="test" -a=xxxxxx -s=xxxxxxx -e=//ctlts-global.ctapi.daliqc.cn -i=bb9fdb42056f11eda1610242ac110002
./ctlts project createProject --project_name="test" -c=huadong1配置文件路徑
默認路徑:
./配置文件名:
config.yaml
配置文件格式
config:
huadong1:
ak: ********************************
sk: ********************************
endpoint: //ctlts-global.ctapi.daliqc.cn
region_id: bb9fdb42056f11eda1610242ac110002
huabei2:
ak: ********************************
sk: ********************************
endpoint: //ctlts-global.ctapi.daliqc.cn
region_id: 200000001852注意
ak,sk獲取方式可參考:,endpoint全局統一公網域名://ctlts-global.ctapi.daliqc.cn,region_id 參考下面資源池-regionId 映射表。
資源池-regionId 映射
| 資源池名稱 | regionId |
|---|---|
| 華東1 | bb9fdb42056f11eda1610242ac110002 |
| 華北2 | 200000001852 |
| 西南1 | 200000002368 |
| 華南2 | 200000002530 |
| 長沙42 | 200000002401 |
| 上海36 | 200000001790 |
| 武漢41 | 200000001781 |
| 呼和浩特3 | 200000003573 |
| 南昌5 | 200000002527 |
| 青島20 | 200000001703 |
| 慶陽2 | 200000003664 |
| 沈陽8 | 200000003335 |
| 太原4 | 200000002689 |
| 烏魯木齊7 | 200000004098 |
| 西安7 | 200000001851 |
| 貴州-西南2 | 200000002927 |
| 鄭州5 | 200000002586 |
| 蕪湖4 | 200000003327 |
| 常州69 | 200000002526 |
| 重慶52 | 200000002015 |
| 杭州7 | 200000003329 |
配置創建命令
執行下面命令可以自動創建config.yaml 文件
./ctlts configure --ak=<string> --sk=<string> --endpoint=<string> --region_id=<string> --region_name=<string>
?
#CLI工具內默認配置region_id為huadong1,如果在華東1地區,可簡化為如下:
./ctlts configure --ak=<string> --sk=<string> 使用完配置創建命令后,會在配置文件路徑下,生成config.yaml 文件,里面包含配置信息。region_name 參數可自定義,比如huadong1,后續使用OpenApi命令時,只需要指定配置文件的region_name即可,例如:
./ctlts project --config=huadong1
或者
./ctlts project -c=huadong1CLI命令規范
命令格式:./ctlts <command> <subcommand> [options]
執行: ./ctlts
Usage:
ctlts [command]
?
Available Commands:
configure Configure Log credentials(ak,sk,endpoint,region_id) save to config.yaml
dataDownload Ctyun Log Service Data Download openApi
help Help about any command
instance Ctyun Log Instance openApi
log Ctyun Log Service OpenApi
logUnit Ctyun Log LogUnit openApi
project Ctyun Log projects openApi查看日志項目project 相關OpenApi列表: ./ctlts project
Usage:
ctlts project [command]
?
Available Commands:
checkProjectExist Check log project exist by project name and project code
countProject Count the number of log projects
createProject Create a new log project
deleteProject Delete log project
getCodeByName Get project code by project name
getProject Get log project details by project code
getProjectByCode Get log project information by project code
getProjectDescription Get a log project's description by project code
listProject List log project all or by project name
pageProject Search log project by page
queryProjectAliasName Query project alias names by original project names
queryProjectNameByCode Query original project names by project codes
renameProject Rename a log project by project code
updateProject Update log project description
updateProjectDescription Update a log project's description by project code
?
Flags:
-a, --ak string access_id
-c, --config string use config.yaml ,such as: --config=huadong1
-e, --endpoint string endpoint
-h, --help help for project
-i, --region_id string region_id
-s, --sk string access_key查看createProject OpenApi:./ctlts project createProject
Usage:
ctlts project createProject [flags]
?
Examples:
ctlts log createProject --project_name=<string> [--description=<string>] [--ak=<string> --sk=<string> --endpoint=<string> --region_id=<string> or --config=<string>]
?
Flags:
-d, --description string log project description
-h, --help help for createProject
-n, --project_name string name of the project to create
?
Global Flags:
-a, --ak string access_id
-c, --config string use config.yaml ,such as: --config=huadong1
-e, --endpoint string endpoint
-i, --region_id string region_id
-s, --sk string access_key執行createProject OpenApi:
./ctlts project createProject --project_name="test" -c=huadong1
?
或者
?
./ctlts project createProject -n="test" -c=huadong1命令執行結果的日志
在默認目錄下,執行CLI命令后會在命令行顯示執行截圖,同時也會自動創建request.log執行日志文件,執行日志文件里面包含openApi 的執行命令、OpenApi的url、執行結果,如下所示:
2025-02-18T16:27:27+08:00 - ctglts project listProject --config=huadong1 --project_name=lts
?
2025-02-18T16:27:27+08:00 - //ctlts-global.ctapi.daliqc.cn/v1/project/list
?
2025-02-18T16:27:27+08:00 - {"statusCode":0,"error":null,"requestId":"69e47e41-16f8060a0","message":null,"returnObj":[***]}request.log 會輪詢文件,可以在CLI源碼目錄下的utils.go 文件里面自定義信息:
const (
maxLogSize = 10 * 1024 * 1024 // 10MB
maxRotatedLogs = 2 // 最多保留 2 個輪轉文件
logFileName = "request.log" // 日志文件名
)