Skip to content

Get Intelligent Inspection Information¶

GET /api/v1/self_built_checker/get

Overview¶

Retrieve the details of a user-defined inspection based on the provided identifier.

Query Request Parameters¶

Parameter Name	Type	Required	Description
ruleUUID	string	Yes	UUID of the user-defined inspection Example: rul_xxxxx Can be empty: False
refKey	string	Yes	Associated key of the user-defined inspection Example: xxx Can be empty: False

Additional Parameter Notes¶

Request Example¶

curl 'https://openapi.guance.com/api/v1/self_built_checker/get?refKey=zyAy2l9v' \
  -H 'Content-Type: application/json' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  --compressed

Response¶

{
    "code": 200,
    "content": {
        "createAt": 1662539061,
        "creator": "acnt_xxxx32",
        "crontabInfo": {},
        "deleteAt": -1,
        "extend": {},
        "id": 88,
        "jsonScript": {
            "name": "User-defined Inspection-20220907T162421bymvlx",
            "type": "selfBuiltCheck"
        },
        "monitorUUID": "monitor_xxxx32",
        "refKey": "zyAy2l9v",
        "status": 0,
        "type": "self_built_trigger",
        "updateAt": 1662539061,
        "updator": "",
        "uuid": "rul_xxxx32",
        "workspaceUUID": "wksp_xxxx32"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-E353D55D-A6FD-497E-82D2-3DA04E703A6D"
}