Add Tier | vRealize Network Insight API

Add Tier

Create a tier of an application with specified membership criteria or members list. The membership criteria is defined in terms of virtual machines or IP addresses/subnet. Please refer to API Guide on how to construct membership criteria.

Request

URI

POST

https://vrni.example.com/api/ni/groups/applications/{id}/tiers

COPY

Path Parameters

string

Required

The Entity ID of object requestion information on

Request Body

TierRequest of type(s) application/json

Optional

{
    "name": "tier-1",
    "source_group_entity_id": [
        "18230:566:264351372"
    ],
    "group_membership_criteria": [
        {
            "membership_type": "SearchMembershipCriteria",
            "search_membership_criteria": {
                "entity_type": "VirtualMachine",
                "filter": "security_groups.entity_id = '18230:82:604573173'"
            }
        },
        {
            "membership_type": "IPAddressMembershipCriteria",
            "ip_address_membership_criteria": {
                "ip_addresses": [
                    "10.0.0.1",
                    "10.0.0.1/24",
                    "10.0.0.1-10.0.0.200"
                ]
            }
        }
    ],
    "member_list": {
        "vms": [
            {
                "key": {
                    "entity_id": "18230:1:1158969162",
                    "entity_type": "VIRTUALMACHINE"
                },
                "name": "VM1"
            },
            {
                "key": {
                    "entity_id": "18230:601:863301375",
                    "entity_type": "EC2INSTANCE"
                },
                "name": "EC2-VM1"
            },
            {
                "key": {
                    "entity_id": "18230:1702:264351372",
                    "entity_type": "AZUREVM"
                },
                "name": "Azure-VM1"
            }
        ],
        "physical_ips": [
            {
                "key": {
                    "entity_id": "18230:541:365252372",
                    "entity_type": "IPENDPOINT"
                },
                "name": "52.35.41.245"
            }
        ],
        "kubernetes_services": [
            {
                "key": {
                    "entity_id": "18230:1504:263252172",
                    "entity_type": "KUBERNETESSERVICE"
                },
                "name": "KS"
            }
        ]
    }
}

string

name

Optional

name

string

entity_id

Optional

entity_id

array of GroupMembershipCriteria

group_membership_criteria

Optional

group_membership_criteria

MemberList

member_list

Optional

member_list

array of string

source_group_entity_id

Optional

Entity ID of corresponding tier application.

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

201

Created

Returns Tier of type(s) application/json

This response body class contains all of the following: BaseEntity

{
    "entity_id": "1000:104:12213212",
    "name": "My Name",
    "entity_type": "VirtualMachine",
    "group_membership_criteria": [
        {
            "membership_type": "string",
            "ip_address_membership_criteria": {
                "ip_addresses": [
                    "string"
                ]
            },
            "search_membership_criteria": {
                "entity_type": "string",
                "filter": "string"
            }
        }
    ],
    "application": {
        "entity_id": "string",
        "entity_type": "VirtualMachine"
    },
    "member_list": {
        "vms": [
            {
                "key": {
                    "entity_id": "18230:1:1158969162",
                    "entity_type": "VIRTUALMACHINE"
                },
                "name": "VM1"
            },
            {
                "key": {
                    "entity_id": "18230:601:863301375",
                    "entity_type": "EC2INSTANCE"
                },
                "name": "EC2-VM1"
            },
            {
                "key": {
                    "entity_id": "18230:1702:264351372",
                    "entity_type": "AZUREVM"
                },
                "name": "Azure-VM1"
            }
        ],
        "physical_ips": [
            {
                "key": {
                    "entity_id": "18230:541:365252372",
                    "entity_type": "IPENDPOINT"
                },
                "name": "52.35.41.245"
            }
        ],
        "kubernetes_services": [
            {
                "key": {
                    "entity_id": "18230:1504:263252172",
                    "entity_type": "KUBERNETESSERVICE"
                },
                "name": "KS"
            }
        ]
    }
}

400

Bad Request

Returns ApiError of type(s) application/json

{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}

integer As int32 As int32

code

Optional

code

string

message

Optional

message

array of ErrorDetail

details

Optional

details