Documentation

Detecting a Probe

Description

This API is used to check whether AI-VAULT is running properly.

URL

GET https://ip:port/AIVAULT/v1/health

Request Header

Table 1 Request header

Parameter

Type

Description

DomainID

UInt

Key domain ID, which indicates the domain of an organization, an application, or a model. The value ranges from 1 to 500.
  1. Parameters in this request header are set by users.
  2. Domain IDs are used to differentiate applications or models. A maximum of 500 domains are supported.

Request Parameters

None

Response Description

Table 2 Responses

Level-1 Parameter

Type

Description

status

String

Error code

msg

String

Error message

data

String

Detection result

Response Example

{
    "status": "00000000",
    "msg": "ok",
    "data": "probe successfully"
}

For details about the error codes, see Error Codes.

For details about the status codes, see Status Codes.

Parent topic: API Reference