health monitor method database¶

DATABASE type

database Specification¶

Parameter Value

Type Configuration Resource

Element Name database

Element URI /axapi/v3/health/monitor/{name}/method/database

Element Attributes database_attributes

Partition Visibility shared

Schema database schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/health/monitor/{name}/method/database	database attributes
POST /axapi/v3/health/monitor/a/method/database Payload: { "database": { "db-password": 1, "database": 1, "database-name": "mssql", "db-name": "a", "db-username": "a", "db-password-str": "a", "db-send": "a", "db-receive": "a", "db-column": 1, "db-row": 1 } }
Get Object	GET	/axapi/v3/health/monitor/{name}/method/database	database attributes
GET /axapi/v3/health/monitor/a/method/database Reponse: { "database": { "database": 1, "database-name": "mssql", "db-name": "a", "db-username": "a", "db-password": 1, "db-encrypted": "Et+HusYu8mkTBiEfK4QSZYNuaB8MFszV/pJZMiisgECQHGF6uh71Sk2mw/XSXujq", "db-send": "a", "db-receive": "a", "db-row": 1, "db-column": 1, "uuid": "4f754d22-4fc8-11ee-8c93-17f0fbeb6d81", "a10-url": "/axapi/v3/health/monitor/a/method/database" } }
Modify Object	POST	/axapi/v3/health/monitor/{name}/method/database	database attributes
Replace Object	PUT	/axapi/v3/health/monitor/{name}/method/database	database attributes
Delete Object	DELETE	/axapi/v3/health/monitor/{name}/method/database	database attributes
DELETE /axapi/v3/health/monitor/a/method/database Reponse: { "response": { "http-status": 200, "status": "OK", "msg": "Success" } }

database attributes¶

database

Description DATABASE type

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

database-name

Description ‘mssql’: Specify MSSQL database; ‘mysql’: Specify MySQL database; ‘oracle’: Specify Oracle database; ‘postgresql’: Specify PostgreSQL database;

Type: string

Supported Values: mssql, mysql, oracle, postgresql

db-column

Description Specify the column number for receiving

Type: number

Range: 1-10

db-column-integer

Description Specify the column number for receiving

Type: number

Range: 1-10

db-encrypted

Description Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)

db-name

Description Specify the database name

Type: string

Format: string-rlx

Maximum Length: 31 characters

Maximum Length: 1 characters

db-password

Description Specify the user password

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

db-password-str

Description Configure password

Type: string

Format: password

Maximum Length: 31 characters

Maximum Length: 1 characters

db-receive

Description Specify the response string

Type: string

Format: string-rlx

Maximum Length: 31 characters

Maximum Length: 1 characters

Mutual Exclusion: db-receive and db-receive-integer are mutually exclusive

db-receive-integer

Description Specify the response integer

Type: number

Range: 0-2147483647

Mutual Exclusion: db-receive-integer and db-receive are mutually exclusive

db-row

Description Specify the row number for receiving

Type: number

Range: 1-10

db-row-integer

Description Specify the row number for receiving

Type: number

Range: 1-10

db-send

Description Specify the SQL query

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

db-username

Description Specify the username

Type: string

Format: string-rlx

Maximum Length: 31 characters

Maximum Length: 1 characters

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters