Cloud Service Manager >
Cloud Service Manager
Return Csm status information
Returns information about cloud service manager
Request:
Method:
GET
URI Path(s):
/api/v1/csm/csmstatus
Request Headers:
n/a
Query Parameters:
ListRequestParameters
+
ListRequestParameters
(
schema
)
Name
Description
Type
Notes
cursor
Opaque cursor to be used for getting next page of records (supplied by current result page)
string
included_fields
Comma separated list of fields that should be included in query result
string
page_size
Maximum number of results to return in this page (server may return fewer)
integer
Minimum: 0
Maximum: 1000
Default: "1000"
sort_ascending
boolean
sort_by
Field by which records are sorted
string
Request Body:
n/a
Example Request:
GET https://<nsx-csm>/api/v1/csm/csmstatus
Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
CsmStatus
+
CsmStatus
(
schema
)
Name
Description
Type
Notes
_links
References related to this resource
The server will populate this field when returing the resource. Ignored on PUT and POST.
array of
ResourceLink
Readonly
_schema
Schema for this resource
string
Readonly
_self
Link to this resource
SelfResourceLink
Readonly
display_name
Name of the Csm instance
string
Readonly
id
UUID of the Csm appliance
Identifier of the Csm appliance
string
Required
Readonly
ip_address
IP address of Csm instance
string
Readonly
managed_by_vmware
Mode of running of Csm instance
This property is used only if CSM is running in service mode
boolean
Readonly
supported_clouds
Indication of clouds supported by CSM
This property provides the list of names of supported clouds by CSM.
array of
CloudTypeInfo
Required
Readonly
version
Version of Csm
string
Required
Readonly
Example Response:
{ "id": "a180989d-48fa-4624-af84-d3c7f120d383", "display_name": "CSM Instance", "ip_address": "192.168.122.1", "version": "1.0", "managed_by_vmware": true, "supported_clouds": [ { "cloud_type": "aws" } ] }
Required Permissions:
read
Feature:
csm_node_config
Additional Errors:
301 Moved Permanently
307 Temporary Redirect
400 Bad Request
403 Forbidden
409 Conflict
500 Internal Server Error
503 Service Unavailable