tencent cloud

请求地址

地址为实例的 IP 和 PORT，可从控制台获取到，例如10.13.20.15:9200。

请求路径和方法

• 路径：/_metric/${metric_name}，${metric_name} 为新建的 metric 的名称。
• 方法：PUT

说明：

metric 命名限制请参见 系统限制。

请求参数

无

请求内容

• time 字段的 name 默认为 timestamp，时间格式（format）完全兼容 Elasticsearch 的时间格式，如 epoch_millis（以毫秒为单位的 Unix 时间戳）、epoch_second（以秒为单位的 Unix 时间戳）、basic_date（格式如 yyyyMMdd）、basic_date_time（格式如 yyyyMMdd'T'HHmmss.SSSZ）等。
• options 选项及解释如下：
• expire_day：数据过期时间（单位：天），取值范围为非零整数，过期后数据自动清理，缺省情况下为最小值-1（代表永不过期）。
• refresh_interval：数据刷新频率，写入的数据从内存刷新到磁盘后可查询。默认为10秒。
• number_of_shards：表分片数，取值范围为正整数，小表可以忽略，大表按照一个分片至多25G设置分片数，默认为3。
• number_of_replicas：副本数，取值范围为正整数，例如一主一副为1，缺省为1。
• rolling_period：子表时长（单位：天），取值范围为非零整数，CTSDB 存储数据时，为了方便做数据过期和提高查询效率，根据特定时间间隔划分子表，缺省情况下由数据过期时间决定，下面具体说明缺省子表时长和过期时间的关系。
• max_string_length：自定义字符串 string 类型的值最大可支持的长度，取值范围为正整数，最大为32765，默认为256。
• default_date_format：自定义维度列和指标列 date类型的格式，默认为 strict_date_optional_time 或 epoch_millis。
• indexed_fields：指定指标列中需要保留索引的字段，可指定多个，以数组形式指定。
• default_type：指定新增字段的默认类型。可选项为 tag、field，系统默认值为 tag。

  过期时间	子表时长
  ≤ 7天	1天
  > 7天，≤ 20天	3天
  > 20天，≤ 49天	7天
  > 49天，≤ 3个月	15天
  ＞3个月	30天
  永不过期	30天

返回内容

需要通过 error 字段判断请求是否成功，若返回内容有 error 字段则请求失败，具体错误详情请参照 error 字段描述。

CURL 示例说明

请求：

curl -u root:le201909 -H 'Content-Type:application/json' -X PUT 172.16.345.14:9201/_metric/ctsdb_test -d'
{
    "tags":
    {
        "region":"string"
    },
    "time":
    {
        "name":"timestamp",
        "format":"epoch_second"
    },
    "fields":
    {
        "cpuUsage":"float"
    },
    "options":
    {
        "expire_day":7,
        "refresh_interval":"10s",
        "number_of_shards":5
    }
   }
'

成功的返回：

{
    "acknowledged": true,
    "message": "create ctsdb metric ctsdb_test success!"
   }

失败的返回：

  {
    "error": {
    "reason": "table ctsdb_test already exist",
    "type": "metric_exception"
    },
    "status": 201
   }