{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:tencent-cat/create-probe-tasks":{"post":{"operationId":"cloud_tencent_cat_create_probe_tasks","summary":"Create Probe Tasks","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["BatchTasks","TaskType","Nodes","Interval","Parameters","TaskCategory"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"BatchTasks":{"type":"array"},"TaskType":{"type":"integer"},"Nodes":{"type":"array"},"Interval":{"type":"integer"},"Parameters":{"type":"string"},"TaskCategory":{"type":"integer"},"Cron":{"type":"string"},"Tag":{"type":"array"},"ProbeType":{"type":"integer"},"PluginSource":{"type":"string"},"ClientNum":{"type":"string"},"NodeIpType":{"type":"integer"},"SubSyncFlag":{"type":"integer"},"RtxName":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:tencent-cat/delete-probe-task":{"post":{"operationId":"cloud_tencent_cat_delete_probe_task","summary":"Delete Probe Task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TaskIds"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"TaskIds":{"type":"array"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:tencent-cat/describe-detailed-single-probe-data":{"post":{"operationId":"cloud_tencent_cat_describe_detailed_single_probe_data","summary":"Describe Detailed Single Probe Data","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["BeginTime","EndTime","TaskType","SortField","Ascending","SelectedFields","Offset","Limit"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"BeginTime":{"type":"integer"},"EndTime":{"type":"integer"},"TaskType":{"type":"string"},"SortField":{"type":"string"},"Ascending":{"type":"boolean"},"SelectedFields":{"type":"array"},"Offset":{"type":"integer"},"Limit":{"type":"integer"},"TaskID":{"type":"array"},"Operators":{"type":"array"},"Districts":{"type":"array"},"ErrorTypes":{"type":"array"},"City":{"type":"array"},"ScrollID":{"type":"string"},"QueryFlag":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:tencent-cat/describe-instant-tasks":{"post":{"operationId":"cloud_tencent_cat_describe_instant_tasks","summary":"Describe Instant Tasks","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Limit","Offset"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"Limit":{"type":"integer"},"Offset":{"type":"integer"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:tencent-cat/describe-node-groups":{"post":{"operationId":"cloud_tencent_cat_describe_node_groups","summary":"Describe Node Groups","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"NodeType":{"type":"array"},"TaskCategory":{"type":"integer"},"IPType":{"type":"integer"},"Name":{"type":"string"},"RegionID":{"type":"integer"},"DistrictID":{"type":"integer"},"NetServiceID":{"type":"integer"},"NodeGroupType":{"type":"integer"},"TaskType":{"type":"integer"},"ProbeType":{"type":"integer"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:tencent-cat/describe-nodes":{"post":{"operationId":"cloud_tencent_cat_describe_nodes","summary":"Describe Nodes","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"NodeType":{"type":"integer"},"Location":{"type":"integer"},"IsIPv6":{"type":"boolean"},"NodeName":{"type":"string"},"PayMode":{"type":"integer"},"TaskType":{"type":"integer"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:tencent-cat/describe-probe-metric-data":{"post":{"operationId":"cloud_tencent_cat_describe_probe_metric_data","summary":"Describe Probe Metric Data","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"AnalyzeTaskType":{"type":"string"},"MetricType":{"type":"string"},"Field":{"type":"string"},"Filter":{"type":"string"},"GroupBy":{"type":"string"},"Filters":{"type":"array"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:tencent-cat/describe-probe-metric-tag-values":{"post":{"operationId":"cloud_tencent_cat_describe_probe_metric_tag_values","summary":"Describe Probe Metric Tag Values","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"AnalyzeTaskType":{"type":"string"},"Key":{"type":"string"},"Filter":{"type":"string"},"Filters":{"type":"array"},"TimeRange":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:tencent-cat/describe-probe-nodes":{"post":{"operationId":"cloud_tencent_cat_describe_probe_nodes","summary":"Describe Probe Nodes","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"NodeType":{"type":"integer"},"Location":{"type":"integer"},"IsIPv6":{"type":"boolean"},"NodeName":{"type":"string"},"PayMode":{"type":"integer"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:tencent-cat/describe-probe-tasks":{"post":{"operationId":"cloud_tencent_cat_describe_probe_tasks","summary":"Describe Probe Tasks","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"TaskIDs":{"type":"array"},"TaskName":{"type":"string"},"TargetAddress":{"type":"string"},"TaskStatus":{"type":"array"},"Offset":{"type":"integer"},"Limit":{"type":"integer"},"PayMode":{"type":"integer"},"OrderState":{"type":"integer"},"TaskType":{"type":"array"},"TaskCategory":{"type":"array"},"OrderBy":{"type":"string"},"Ascend":{"type":"boolean"},"TagFilters":{"type":"array"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:tencent-cat/resume-probe-task":{"post":{"operationId":"cloud_tencent_cat_resume_probe_task","summary":"Resume Probe Task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TaskIds"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"TaskIds":{"type":"array"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:tencent-cat/suspend-probe-task":{"post":{"operationId":"cloud_tencent_cat_suspend_probe_task","summary":"Suspend Probe Task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TaskIds"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"TaskIds":{"type":"array"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:tencent-cat/update-probe-task-attributes":{"post":{"operationId":"cloud_tencent_cat_update_probe_task_attributes","summary":"Update Probe Task Attributes","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TaskId"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"TaskId":{"type":"string"},"Name":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:tencent-cat/update-probe-task-configuration-list":{"post":{"operationId":"cloud_tencent_cat_update_probe_task_configuration_list","summary":"Update Probe Task Configuration List","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TaskIds","Nodes","Interval","Parameters"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"TaskIds":{"type":"array"},"Nodes":{"type":"array"},"Interval":{"type":"integer"},"Parameters":{"type":"string"},"Cron":{"type":"string"},"ResourceIDs":{"type":"array"},"NodeIpType":{"type":"integer"},"BatchTasks":{"type":"array"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}