Flashcat API

卡片详情

GET

https://api.flashcat.cloud/api/v2/firemap/mixed/card/detail

最后修改时间：2024-03-15 06:59:28

在单个系统内调用时， business_id 必须大于0，因为需要补齐group_id信息；在卡片池内调用时，business_id设置为0

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.flashcat.cloud/api/v2/firemap/mixed/card/detail?id=88&snapshot=&timestamp&business_id' \
--header 'X-Language: zh'

响应示例

{
    "request_id": "string",
    "data": {
        "id": 0,
        "name": "string",
        "owners": [
            "string"
        ],
        "created_at": 0,
        "updated_at": 0,
        "firemap_type": "function",
        "order": 0,
        "business_id": 0,
        "business_name": "string",
        "businesses": [
            {
                "id": 0,
                "name": "string",
                "order": 0
            }
        ],
        "group_id": 0,
        "group_name": "string",
        "groups": [
            {
                "id": 0,
                "name": "string",
                "order": 0
            }
        ],
        "data_source_type": "string",
        "data_source_ids": [
            0
        ],
        "metrics": [
            {
                "metric": "string",
                "name": "string",
                "settings": {
                    "prometheus.promql": "string"
                },
                "aggregation": "string"
            }
        ],
        "thresholds": [
            {
                "metric": "string",
                "threshold": 0,
                "operator": "string",
                "logic": "string",
                "aggregation": "string",
                "normalize": "string"
            }
        ]
    }
}

请求参数

Query 参数

string

必需

示例值:

snapshot

string

可选

true/false

timestamp

integer

可选

同步返回卡片的snapshot数据

business_id

integer

可选

补全在某个业务线内的分组信息

Header 参数

X-Language

string

可选

示例值:

返回响应

🟢200成功

application/json

Body

request_id

string

必需

data

object

必需

integer

必需

name

string

必需

owners

array[string]

必需

created_at

integer

必需

updated_at

integer

必需

firemap_type

enum<string>

必需

枚举值:

functionslomodule

order

integer

必需

business_id

integer

系统ID

可选

单个系统中

business_name

string

系统名称

可选

businesses

array [object {3}]

所属系统

可选

group_id

integer

组ID

可选

单个系统中

group_name

string

组名称

可选

groups

array [object {3}]

所属分组

可选

卡片组中

data_source_type

string

必需

data_source_ids

array[integer]

必需

metrics

array [object {4}]

必需

thresholds

array [object {6}]

必需

卡片名称冲突校验

业务线下的卡片列表