This operation returns the ID for a Kubernetes cluster client.
Request
Syntax
GET webservice/GetId?clientname=clientName HTTP/1.1
Host: host name
Accept: application/xml or application/json
Authtoken: authentication tokenwhere <webservice> is the root path used to route the API requests to the Web Server.
For more information, see Available Web Services for REST API.
Request Parameters
|
Name |
Description |
Required |
|---|---|---|
|
clientName |
The name of the Kubernetes cluster to get the ID for. |
Yes, for request by client name. |
Request Headers
|
Name |
Description |
|---|---|
|
Host |
The host name of the Web Server or Command Center used in the API request. |
|
Accept |
The format of the response. Valid values are application/xml and application/json. |
|
Authtoken |
The authentication token received after successfully logging on. For information about receiving an authentication token, see Authentication. |
Response
Response Parameters
|
Parameter |
Description |
Element |
|---|---|---|
|
clientName |
The name of the Kubernetes cluster. |
|
|
clientId |
The ID of the Kubernetes cluster client. |
|
|
type |
The type of CommCell object. Valid value is CLIENT_ENTITY, or 3. |
Examples
Sample Request
GET webservice/GetId?clientname=Client001Sample Response
This is the response when the request is successful.
-
XML
<CvEntities_GenericEntity clientId="224" clientName="Client001" _type_="3" /> -
JSON
{ "clientId": 224, "clientName": "Client001", "_type_": 3 }
This is a sample response when the request is not successful.
-
XML
<CvEntities_GenericEntity clientId="-32000" clientName="aaa" _type_="3"> <processinginstructioninfo> <attributes name="ENTITY_ERROR_MESSAGE" value="Invalid clientId for clientName Client001." /> </processinginstructioninfo> </CvEntities_GenericEntity> -
JSON
{ "processinginstructioninfo": { "attributes": [ { "name": "ENTITY_ERROR_MESSAGE", "value": "Invalid clientId for clientName aaa." } }, "clientId": -32000, "clientName": "aaa", "_type_": 3 }