gslb service-matching-rules rule¶
Service-matching rule
rule Specification¶
Parameter Value Type Collection Object Key(s) seq-num Collection Name rule-list Collection URI /axapi/v3/gslb/service-matching-rules/{zone}/rule Element Name rule Element URI /axapi/v3/gslb/service-matching-rules/{zone}/rule/{seq-num} Element Attributes rule_attributes Partition Visibility shared Schema rule schema
Operations Allowed:
Operation | Method | URI | Payload | |
---|---|---|---|---|
Create Object | POST | /axapi/v3/gslb/service-matching-rules/{zone}/rule | ||
Create List | POST | /axapi/v3/gslb/service-matching-rules/{zone}/rule | ||
Get Object | GET | /axapi/v3/gslb/service-matching-rules/{zone}/rule/{seq-num} | ||
Get List | GET | /axapi/v3/gslb/service-matching-rules/{zone}/rule | ||
Modify Object | POST | /axapi/v3/gslb/service-matching-rules/{zone}/rule/{seq-num} | ||
Replace Object | PUT | /axapi/v3/gslb/service-matching-rules/{zone}/rule/{seq-num} | ||
Replace List | PUT | /axapi/v3/gslb/service-matching-rules/{zone}/rule | ||
Delete Object | DELETE | /axapi/v3/gslb/service-matching-rules/{zone}/rule/{seq-num} |
rule-list¶
rule-list is JSON List of rule attributes
rule-list : [
]
rule attributes¶
domain-match-string
Description Domain name string
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
domain-match-type
Description ‘equals’: Domain name equals to string; ‘contains’: Domain name contains string; ‘starts-with’: Domain name starts with string; ‘ends-with’: Domain name ends with string;
Type: string
Supported Values: equals, contains, starts-with, ends-with
health-state
Type: Listseq-num
Description Sequence number of rule
Type: number
Range: 1-32
service
Description Name of zone service to be redirected
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
src-ipv4
Description Client source IPv4 subnet
Type: string
Format: ipv4-cidr
Mutual Exclusion: src-ipv4 and src-ipv6 are mutually exclusive
src-ipv6
Description Client source IPv6 subnet
Type: string
Format: ipv6-address-plen
Mutual Exclusion: src-ipv6 and src-ipv4 are mutually exclusive
user-tag
Description Customized tag
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
health-state¶
Specification Value Type list Block object keys gslb-service-ip
Description Health state of GSLB service-ip (GSLB service-ip name)
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/gslb/service-ip
gslb-site
Description Health state of GSLB site (GSLB site name)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/gslb/site
service-ip-state
Description ‘Up’: Up; ‘Down’: Down;
Type: string
Supported Values: Up, Down
site-state
Description ‘AllUp’: AllUp; ‘Down’: Down; ‘AllUp-or-PartUp’: AllUp-or-PartUp; ‘Down-or-PartUp’: Down-or-PartUp;
Type: string
Supported Values: AllUp, Down, AllUp-or-PartUp, Down-or-PartUp
slb-server
Description Health state of SLB server (SLB server name)
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/slb/server
slb-svr-state
Description ‘Up’: Up; ‘Down’: Down;
Type: string
Supported Values: Up, Down