Get CS Gs

Get CS Gs

This API is to be used for getting the CSGs as per the specified parameters.

Request
URI
GET
https://{api_host}/hybridity/api/ztp/v1/csgs
COPY
Query Parameters
string
sort
Optional

The key to use for sorting the resultant list of CSGs. The value is to be an attribute based sorting expression. The supported attributes for sorting are as follows: [ name, enabled, location, status, id, version, hcpId, parentDomainId, parentDomainName, createdTimestamp, lastUpdatedTimestamp ]. The supported sorting orders are: [asc,desc]

sort example 
createdTimestamp,desc
string
filter
Optional

Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV SOL 013. The supported filter types are [cont, eq]. "cont" refers to contains (substring check). It is applicable only for string type targets. "eq" refers to exact match. If target type is a string, then case is ignored. The supported attributes for "eq" filtering are: [name, enabled, location, status, id, version, hcpId, parentDomainId, parentDomainName]. The supported attributes for "cont" filtering are: [name, enabled, location, status, id, hcpId, parentDomainId, parentDomainName].

filter example 
(cont,name,cellsite);(eq,parentDomainName,cdc)
string
nextpage_opaque_marker
Optional

Marker to obtain the next page of a paged response according to clause 5.4.2.1 of ETSI GS NFV SOL 013 for this resource. The marker expression will contain page number and page size.

nextpage_opaque_marker example 
page_no=1,page_size=10
Authentication
This operation uses the following authentication methods.
Responses
200

Response includes list of CSGs as specified by the request parameters.

Returns Array of InlineZtpV1Csgs200Response of type(s) application/json 
[
    {
        "id": "string",
        "version": 0,
        "name": "string",
        "type": "string",
        "enabled": false,
        "preDeployed": {
            "preDeployed": false
        },
        "parentDomainId": "string",
        "parentDomainName": "cdc1",
        "switches": [
            {
                "name": "string",
                "uplinks": [
                    {
                        "pnic": "string",
                        "name": "string"
                    }
                ]
            }
        ],
        "networks": [
            {
                "type": "string",
                "name": "string",
                "switch": "string",
                "segmentType": "string",
                "vlan": 0,
                "mac_learning_enabled": false,
                "uplinkTeamingPolicy": {
                    "uplinkPortOrder": {
                        "active": [
                            "string"
                        ],
                        "standby": [
                            "string"
                        ],
                        "unused": [
                            "string"
                        ]
                    }
                }
            }
        ],
        "settings": {
            "dns": {
                "suffix": "string",
                "servers": [
                    "string"
                ]
            },
            "ntp": {
                "servers": [
                    "string"
                ]
            },
            "csiTagging": {
                "enableCsiZoning": false,
                "clusterCsiZoneTagNamingScheme": "string",
                "hostCsiZoneTagNamingScheme": "string"
            },
            "disableDatastoreCustomization": false
        },
        "csiTags": {
            "csiZoneTag": "string"
        },
        "csiCategories": {
            "useExisting": false,
            "zone": "string"
        },
        "hcpId": "string",
        "hcpName": "string",
        "hostCount": 0,
        "status": "string",
        "createdTimestamp": 0,
        "lastUpdatedTimestamp": 0,
        "messages": {
            "warnings": [
                {
                    "code": "string",
                    "message": "string",
                    "stack": "string"
                }
            ],
            "errors": [
                {
                    "code": "string",
                    "message": "string",
                    "stack": "string"
                }
            ]
        }
    }
]

Response Headers

integer
X-TotalPageCount

The total number of pages for CSGs present on the server with the applied flters.

integer
X-TotalRowCount

The total number of CSGs present on the server with the applied filters.

integer
X-DomainOfTypeCount

The total number of CSGs present on the server.


301

API endpoint has permanently moved.

Returns InlineZtpV1Csgs301Response of type(s) application/json 
{
    "redirectURL": "string"
}
string
redirectURL
Optional

redirectURL

Response Headers

string
Location

URI where the client will find the new endpoint.


400

Response may include details of why the request is bad.

Returns InlineZtpV1Csgs400Response of type(s) application/json 
{
    "warnings": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ],
    "errors": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ]
}
array of object
warnings
Optional

The list of warnings.

array of object
errors
Optional

The list of errors.


401

User is not authenticated to invoke this endpoint.

Operation doesn't return any data structure

403

User is not authorized to invoke this endpoint.

Operation doesn't return any data structure

422

The request parameters couldn't be processed by the server.

Returns InlineZtpV1Csgs422Response of type(s) application/json 
{
    "warnings": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ],
    "errors": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ]
}
array of object
warnings
Optional

The list of warnings.

array of object
errors
Optional

The list of errors.


500

An internal server error has occurred.

Returns InlineZtpV1Csgs500Response of type(s) application/json 
{
    "warnings": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ],
    "errors": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ]
}
array of object
warnings
Optional

The list of warnings.

array of object
errors
Optional

The list of errors.


On This Page
Cell Site Group Operations
POST
Create CS Gs
DELETE
Delete CSG
POST
Fetch CSG By Names
GET
Get CSG
GET
Get CS Gs
GET
Get Status For CSG
POST
Resync CS Gs
PUT
Update CSG
PUT
Update CS Gs