DNS Pool Member MX¶
Overview¶
This document describes the API to configure DNS MX pool members and their properties.
REST Endpoint: /mgmt/cm/dns/working-config/pool/mx/*/members¶
Requests¶
GET /mgmt/cm/dns/working-config/pool/mx/<id>/members/<pool-member-id>¶
Request Parameters¶
None
Query Parameters¶
None
Response¶
HTTP/1.1 200 OK
Name | Type | Description |
---|---|---|
enabled | boolean | Specifies whether the system can include the pool member in its load balancing calculations |
memberOrder | number | Specifies the order number of the pool member. The system uses this number with load balancing methods that involve prioritizing pool members, such as the Ratio load balancing method |
priority | number | Specifies the response resource record’s priority RDATA field value when this member is picked. The default is 10 |
ratio | number | Specifies the weight to the pool member for load balancing purposes |
name | string | Displays the name of the pool |
description | string | A description of the pool member |
wideIpAReference | reference | A reference of the Wide IP for the pool member to use |
name | string | Name of the resource |
link | string | URI link of the reference. |
wideIpAAAAReference | reference | A reference of the Wide IP for the pool member to use |
name | string | Name of the resource |
link | string | URI link of the reference. |
Permissions¶
Role | Allow |
---|---|
Application_Editor | Yes |
DNS_Viewer | Yes |
DNS_Deployer | Yes |
Service_Catalog_Viewer | Yes |
DNS_Editor | Yes |
Service_Catalog_Editor | Yes |
Application_Manager | Yes |
Application_Viewer | Yes |
Trust_Discovery_Import | Yes |
DNS_Manager | Yes |
POST /mgmt/cm/dns/working-config/pool/mx/<id>/members¶
Request Parameters¶
Name | Type | Required | Description |
---|---|---|---|
enabled | boolean | False | Specifies whether the system can include the pool member in its load balancing calculations |
memberOrder | number | False | Specifies the order number of the pool member. The system uses this number with load balancing methods that involve prioritizing pool members, such as the Ratio load balancing method |
priority | number | False | Specifies the response resource record’s priority RDATA field value when this member is picked. The default is 10 |
ratio | number | False | Specifies the weight to the pool member for load balancing purposes |
name | string | False | Displays the name of the pool |
description | string | False | A description of the pool member |
wideIpAReference | reference | False | A reference of the Wide IP for the pool member to use |
link | string | True | URI link of the reference. |
wideIpAAAAReference | reference | False | A reference of the Wide IP for the pool member to use |
link | string | True | URI link of the reference. |
Query Parameters¶
None
Response¶
HTTP/1.1 200 OK
Name | Type | Description |
---|---|---|
enabled | boolean | Specifies whether the system can include the pool member in its load balancing calculations |
memberOrder | number | Specifies the order number of the pool member. The system uses this number with load balancing methods that involve prioritizing pool members, such as the Ratio load balancing method |
priority | number | Specifies the response resource record’s priority RDATA field value when this member is picked. The default is 10 |
ratio | number | Specifies the weight to the pool member for load balancing purposes |
name | string | Displays the name of the pool |
description | string | A description of the pool member |
wideIpAReference | reference | A reference of the Wide IP for the pool member to use |
name | string | Name of the resource |
link | string | URI link of the reference. |
wideIpAAAAReference | reference | A reference of the Wide IP for the pool member to use |
name | string | Name of the resource |
link | string | URI link of the reference. |
Permissions¶
Role | Allow |
---|---|
Application_Editor | No |
DNS_Viewer | No |
DNS_Deployer | No |
Service_Catalog_Viewer | No |
DNS_Editor | Yes |
Service_Catalog_Editor | No |
Application_Manager | No |
Application_Viewer | No |
Trust_Discovery_Import | No |
DNS_Manager | Yes |
PATCH /mgmt/cm/dns/working-config/pool/mx/<id>/members/<pool-member-id>¶
Request Parameters¶
Name | Type | Required | Description |
---|---|---|---|
enabled | boolean | False | Specifies whether the system can include the pool member in its load balancing calculations |
memberOrder | number | False | Specifies the order number of the pool member. The system uses this number with load balancing methods that involve prioritizing pool members, such as the Ratio load balancing method |
priority | number | False | Specifies the response resource record’s priority RDATA field value when this member is picked. The default is 10 |
ratio | number | False | Specifies the weight to the pool member for load balancing purposes |
description | string | False | A description of the pool member |
wideIpAReference | reference | False | A reference of the Wide IP for the pool member to use |
link | string | True | URI link of the reference. |
wideIpAAAAReference | reference | False | A reference of the Wide IP for the pool member to use |
link | string | True | URI link of the reference. |
Query Parameters¶
None
Response¶
HTTP/1.1 200 OK
Name | Type | Description |
---|---|---|
enabled | boolean | Specifies whether the system can include the pool member in its load balancing calculations |
memberOrder | number | Specifies the order number of the pool member. The system uses this number with load balancing methods that involve prioritizing pool members, such as the Ratio load balancing method |
priority | number | Specifies the response resource record’s priority RDATA field value when this member is picked. The default is 10 |
ratio | number | Specifies the weight to the pool member for load balancing purposes |
name | string | Displays the name of the pool |
description | string | A description of the pool member |
wideIpAReference | reference | A reference of the Wide IP for the pool member to use |
name | string | Name of the resource |
link | string | URI link of the reference. |
wideIpAAAAReference | reference | A reference of the Wide IP for the pool member to use |
name | string | Name of the resource |
link | string | URI link of the reference. |
Permissions¶
Role | Allow |
---|---|
Application_Editor | No |
DNS_Viewer | No |
DNS_Deployer | No |
Service_Catalog_Viewer | No |
DNS_Editor | Yes |
Service_Catalog_Editor | No |
Application_Manager | No |
Application_Viewer | No |
Trust_Discovery_Import | No |
DNS_Manager | Yes |
DELETE /mgmt/cm/dns/working-config/pool/mx/<id>/members/<pool-member-id>¶
Request Parameters¶
None
Query Parameters¶
None
Response¶
HTTP/1.1 200 OK
Name | Type | Description |
---|---|---|
enabled | boolean | Specifies whether the system can include the pool member in its load balancing calculations |
memberOrder | number | Specifies the order number of the pool member. The system uses this number with load balancing methods that involve prioritizing pool members, such as the Ratio load balancing method |
priority | number | Specifies the response resource record’s priority RDATA field value when this member is picked. The default is 10 |
ratio | number | Specifies the weight to the pool member for load balancing purposes |
name | string | Displays the name of the pool |
description | string | A description of the pool member |
wideIpAReference | reference | A reference of the Wide IP for the pool member to use |
name | string | Name of the resource |
link | string | URI link of the reference. |
wideIpAAAAReference | reference | A reference of the Wide IP for the pool member to use |
name | string | Name of the resource |
link | string | URI link of the reference. |
Permissions¶
Role | Allow |
---|---|
Application_Editor | No |
DNS_Viewer | No |
DNS_Deployer | No |
Service_Catalog_Viewer | No |
DNS_Editor | Yes |
Service_Catalog_Editor | No |
Application_Manager | No |
Application_Viewer | No |
Trust_Discovery_Import | No |
DNS_Manager | Yes |
Examples¶
Get a pool member of a given MX pool¶
GET /mgmt/cm/dns/working-config/pool/mx/<id>/members/<pool-member-id>
Response¶
HTTP/1.1 200 OK
{
"enabled": No example value specified ,
"memberOrder": No example value specified ,
"priority": No example value specified ,
"ratio": No example value specified ,
"name": "pool_member_1" ,
"description": "example pool member" ,
"wideIpAReference": {
"name": "resourceName" ,
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"wideIpAAAAReference": {
"name": "resourceName" ,
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
}
}
Get all pool members of a given MX pool¶
GET /mgmt/cm/dns/working-config/pool/mx/<id>/members
Response¶
HTTP/1.1 200 OK
{
"enabled": No example value specified ,
"memberOrder": No example value specified ,
"priority": No example value specified ,
"ratio": No example value specified ,
"name": "pool_member_1" ,
"description": "example pool member" ,
"wideIpAReference": {
"name": "resourceName" ,
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"wideIpAAAAReference": {
"name": "resourceName" ,
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
}
}
Create a new pool member for a given MX pool¶
POST /mgmt/cm/dns/working-config/pool/mx/<id>/members
{
"enabled": No example value specified ,
"memberOrder": No example value specified ,
"priority": No example value specified ,
"ratio": No example value specified ,
"name": "pool_member_1" ,
"description": "example pool member" ,
"wideIpAReference": {
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"wideIpAAAAReference": {
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
}
}
Response¶
HTTP/1.1 200 OK
{
"enabled": No example value specified ,
"memberOrder": No example value specified ,
"priority": No example value specified ,
"ratio": No example value specified ,
"name": "pool_member_1" ,
"description": "example pool member" ,
"wideIpAReference": {
"name": "resourceName" ,
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"wideIpAAAAReference": {
"name": "resourceName" ,
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
}
}
Update pool member for a given MX pool¶
PATCH /mgmt/cm/dns/working-config/pool/mx/<id>/members/<pool-member-id>
{
"enabled": No example value specified ,
"memberOrder": No example value specified ,
"priority": No example value specified ,
"ratio": No example value specified ,
"description": "example pool member" ,
"wideIpAReference": {
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"wideIpAAAAReference": {
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
}
}
Response¶
HTTP/1.1 200 OK
{
"enabled": No example value specified ,
"memberOrder": No example value specified ,
"priority": No example value specified ,
"ratio": No example value specified ,
"name": "pool_member_1" ,
"description": "example pool member" ,
"wideIpAReference": {
"name": "resourceName" ,
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"wideIpAAAAReference": {
"name": "resourceName" ,
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
}
}
Delete MX pool member¶
DELETE /mgmt/cm/dns/working-config/pool/mx/<id>
Response¶
HTTP/1.1 200 OK
{
"enabled": No example value specified ,
"memberOrder": No example value specified ,
"priority": No example value specified ,
"ratio": No example value specified ,
"name": "pool_member_1" ,
"description": "example pool member" ,
"wideIpAReference": {
"name": "resourceName" ,
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"wideIpAAAAReference": {
"name": "resourceName" ,
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
}
}