更新时间:2022-03-14 GMT+08:00
分享

检查心跳健康

功能介绍

SA提供心跳接口,集成产品定时(每五分钟)发送心跳报文到态势感知,用来确认集成产品与态势感知之间的通路是否健康。

调试

您可以在API Explorer中调试该接口。

URI

POST /v1/{project_id}/products/health-check

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户项目ID。

最小长度:32

最大长度:36

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

最小长度:1

最大长度:2097152

X-Language

String

最小长度:2

最大长度:6

表3 请求Body参数

参数

是否必选

参数类型

描述

domain_id

String

数据源产品所属账号的ID。

最小长度:32

最大长度:36

project_id

String

数据源产品所属项目的ID。

最小长度:32

最大长度:36

region

String

数据源产品所在区域。

最小长度:1

最大长度:512

company_name

String

数据源产品所属公司的名称。

最小长度:1

最大长度:512

product_name

String

数据源产品的名称。

最小长度:1

最大长度:512

响应参数

状态码: 400

表4 响应Body参数

参数

参数类型

描述

error_msg

String

无效数据的描述信息。

最小长度:1

最大长度:128

error_code

String

错误码。

最小长度:1

最大长度:128

状态码: 401

表5 响应Body参数

参数

参数类型

描述

error_msg

String

token认证错误。

最小长度:1

最大长度:128

error_code

String

错误码。

最小长度:1

最大长度:128

状态码: 403

表6 响应Body参数

参数

参数类型

描述

error_msg

String

权限错误。

最小长度:1

最大长度:128

error_code

String

错误码。

最小长度:1

最大长度:128

状态码: 500

表7 响应Body参数

参数

参数类型

描述

error_msg

String

系统内部错误。

最小长度:1

最大长度:128

error_code

String

错误码。

最小长度:1

最大长度:128

请求示例

POST https://{endpoint}/v1/{project_id}/products/health-check

{
  region: "cn-north-x"
  domain_id: "dfaf9864b95c448797b5dc0f0xxxxxxx"
  project_id: "2b31ed520xxxxxxebedb6e57xxxxxxxx"
  company_name: "Huawei"
  product_name: "xxx"
}

响应示例

状态码

状态码

描述

201

Succeeded

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

错误码

请参见错误码

分享:

    相关文档

    相关产品

关闭导读