System Administration >
Monitoring
>
System Health
>
Container
Create container cluster status list
Request:
Method:
POST
URI Path(s):
/api/v1/systemhealth/container-cluster/ncp/status
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
ContainerClusterStatus
+
ContainerClusterStatus
(
schema
)
Name
Description
Type
Notes
cluster_id
Identifier of the container cluster
Identifier of the container cluster.
string
detail
Detail information on status
Detail information on status.
string
interval
Container cluster status check interval
Display the cluster check interval in seconds.
int
Readonly
Minimum: 60
Maximum: 600
status
Container cluster status
Display the container cluster status.
TnContainerStatusType
Example Request:
POST https: //<nsx-mgr>/api/v1/systemhealth/container-cluster/ncp/status { "cluster_id": "b8b0889f-338c-5c65-98bd-a5642ae2aa00", "status": "HEALTHY", "detail": "" }
Successful Response:
Response Code:
201 Created
Response Headers:
Content-type: application/json
Response Body:
ContainerClusterStatus
+
ContainerClusterStatus
(
schema
)
Name
Description
Type
Notes
cluster_id
Identifier of the container cluster
Identifier of the container cluster.
string
detail
Detail information on status
Detail information on status.
string
interval
Container cluster status check interval
Display the cluster check interval in seconds.
int
Readonly
Minimum: 60
Maximum: 600
status
Container cluster status
Display the container cluster status.
TnContainerStatusType
Example Response:
{ "cluster_id": "b8b0889f-338c-5c65-98bd-a5642ae2aa00", "status": "HEALTHY", "detail": "", "interval": 180 }
Required Permissions:
crud
Feature:
tools_system_health_agent
Additional Errors:
301 Moved Permanently
307 Temporary Redirect
400 Bad Request
403 Forbidden
409 Conflict
500 Internal Server Error
503 Service Unavailable