Edit Application Tier

Edit 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

PUT

https://{api_host}/api/ni/groups/applications/{id}/tiers/{tier-id}

COPY

Path Parameters

string

Required

The Entity ID of object requestion information on

string

tier-id

Required

tier-id

Request Body

TierRequest of type(s) application/json

Required

{
    "name": "string",
    "entity_id": "string",
    "group_membership_criteria": [
        {
            "membership_type": "string",
            "ip_address_membership_criteria": {
                "ip_addresses": [
                    "string"
                ]
            },
            "search_membership_criteria": {
                "entity_type": "string",
                "filter": "string"
            }
        }
    ],
    "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"
            }
        ]
    },
    "source_group_entity_id": [
        "string"
    ]
}

string

name

Optional

name

string

entity_id

Optional

entity_id

array of object

group_membership_criteria

Optional

EntityType currently restricted to VirtualMachine

object

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: InlineTier0 , InlineTier1

"Tier Object"

400

Bad Request

Returns ApiError of type(s) application/json

"ApiError Object"

integer As int32 As int32

code

Optional

code

string

message

Optional

message

array of object

details

Optional

details

401

Unauthorized

Operation doesn't return any data structure

403

Forbidden

Operation doesn't return any data structure

404

Not Found

Operation doesn't return any data structure

500

Internal Error

Operation doesn't return any data structure

Code Samples

COPY

                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/api/ni/groups/applications/{id}/tiers/{tier-id}

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

201 Response Body

Errors

Applications Operations

GET

List Applications