acos-cloud-integration ecosystem consul¶

Configure the consul ecosystem for integration

consul Specification¶

Parameter Value

Type Configuration Resource

Element Name consul

Element URI /axapi/v3/acos-cloud-integration/ecosystem/consul

Element Attributes consul_attributes

Partition Visibility shared

Schema consul schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/acos-cloud-integration/ecosystem/consul	consul attributes
POST /axapi/v3/acos-cloud-integration/ecosystem/consul Payload: { "consul": { "ipv4-address": "3.3.3.3" } }
Get Object	GET	/axapi/v3/acos-cloud-integration/ecosystem/consul	consul attributes
GET /axapi/v3/acos-cloud-integration/ecosystem/consul Reponse: { "consul": { "ipv4-address": "3.3.3.3", "action": "disable", "uuid": "db25ac9a-6612-11d9-9a27-692335d4f00d", "a10-url": "/axapi/v3/acos-cloud-integration/ecosystem/consul" } }
Modify Object	POST	/axapi/v3/acos-cloud-integration/ecosystem/consul	consul attributes
Replace Object	PUT	/axapi/v3/acos-cloud-integration/ecosystem/consul	consul attributes
PUT /axapi/v3/acos-cloud-integration/ecosystem/consul Payload: { "consul": { "ipv4-address": "3.3.3.4" } }
Delete Object	DELETE	/axapi/v3/acos-cloud-integration/ecosystem/consul	consul attributes
DELETE /axapi/v3/acos-cloud-integration/ecosystem/consul Reponse: { "response": { "http-status": 200, "status": "OK", "msg": "Success" } }

consul attributes¶

action

Description ‘enable’: Enable Configuration; ‘disable’: Disable Configuration;

Type: string

Supported Values: enable, disable

Default: disable

health-check-interval

Description ‘5’: 5 seconds; ‘10’: 10 seconds; ‘15’: 15 seconds; ‘20’: 20 seconds;

Type: string

Supported Values: 5, 10, 15, 20

host-name

Description Configure the host name for bootstrap server(e.g www.a10networks.com)

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

Mutual Exclusion: host-name, ipv4-address, and ipv6-address are mutually exclusive

ipv4-address

Description Configure the bootstrap server’s IPv4 address (the host IPv4 address)

Type: string

Format: ipv4-address

Mutual Exclusion: ipv4-address, ipv6-address, and host-name are mutually exclusive

ipv6-address

Description Configure the bootstrap server’s IPv6 address (the host IPv6 address)

Type: string

Format: ipv6-address

Mutual Exclusion: ipv6-address, ipv4-address, and host-name are mutually exclusive

port

Description Configure the http port to use (port 8500)

Type: number

Range: 1-65535

service-label

Type: List

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

service-label¶

Specification Value

Type list

Block object keys

service-label-name

Description Name service group to be monitored

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/slb/service-group