配置说明

每次使用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=https://ctlts-global.ctapi.ctyun.cn -i=bb9fdb42056f11eda1610242ac110002
./ctlts project createProject --project_name="test" -c=huadong1

配置文件路径

• 默认路径：./

• 配置文件名：config.yaml

配置文件格式

config:
  huadong1:
    ak: ******************************** 
    sk: ******************************** 
    endpoint: https://ctlts-global.ctapi.ctyun.cn
    region_id: bb9fdb42056f11eda1610242ac110002
  huabei2:
    ak: ******************************** 
    sk: ******************************** 
    endpoint: https://ctlts-global.ctapi.ctyun.cn
    region_id: 200000001852

资源池-regionId 映射

配置创建命令

执行下面命令可以自动创建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=huadong1

CLI命令规范

命令格式：./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 - https://ctlts-global.ctapi.ctyun.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"    // 日志文件名
)