Get Service Deployment Status
Returns current status of the deployment of partner service. Available only for EPP Services. By default this API would return cached status. Caching happens every 3 minutes. For realtime status, query parameter "source=realtime" needs to be passed.
Request
URI
GET
https://nsxmanager.your.domain/api/v1/serviceinsertion/services/{service-id}/service-deployments/{service-deployment-id}/status
COPY
Path Parameters
string
service-id
Required
service-id
string
service-deployment-id
Required
service-deployment-id
Query Parameters
string
source
Optional
Data source type.
Possible values are :
realtime,
cached,
Responses
200
OK
Returns
ServiceDeploymentStatus
of type(s)
application/json
{
"deployment_issues": [
{
"issue_description": "string",
"issue_timestamp": "string",
"issue_type": "string"
}
],
"deployment_status": "string",
"last_update_timestamp": 0,
"service_deployment_id": "string",
"sva_current_version": "string",
"sva_max_available_version": "string"
}
array of
object
deployment_issues
Optional
List of issue and detailed description of the issue in case of deployment failure.
string
deployment_status
Optional
Deployment status of NXGI Partner Service-VM on a compute collection. It shows the latest status during the process of deployment, redeploy, upgrade, and un-deployment on a compute collection such as VC cluster.
Possible values are :
UPGRADE_IN_PROGRESS,
UPGRADE_FAILED,
DEPLOYMENT_QUEUED,
DEPLOYMENT_IN_PROGRESS,
DEPLOYMENT_FAILED,
DEPLOYMENT_SUCCESSFUL,
UNDEPLOYMENT_QUEUED,
UNDEPLOYMENT_IN_PROGRESS,
UNDEPLOYMENT_FAILED,
UNDEPLOYMENT_SUCCESSFUL,
UPGRADE_QUEUED,
integer As int64
As int64
last_update_timestamp
Optional
Timestamp when the data was last updated; unset if data source has never updated the data.
string
service_deployment_id
Optional
Id of service deployment.
string
sva_current_version
Optional
Currently deployed Service Virtual Appliance version.
string
sva_max_available_version
Optional
Max available SVA version for upgrade
404
Not Found
Operation doesn't return any data structure
412
Returns
PreconditionFailed
of type(s)
application/json
Operation doesn't return any data structure
500
Returns
InternalServerError
of type(s)
application/json
Operation doesn't return any data structure
503
Returns
ServiceUnavailable
of type(s)
application/json
Operation doesn't return any data structure
Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/api/v1/serviceinsertion/services/{service-id}/service-deployments/{service-deployment-id}/status
On This Page
Management Plane Api Operations
GET
Get Exclude List
Deprecated
PUT
Update Exclude List
Deprecated
POST
Add Member
Deprecated
POST
Check Member If Exists
Deprecated
POST
Remove Member
Deprecated
GET
List Firewall Profiles
Deprecated
POST
Create Firewall Profile
Deprecated
DELETE
Delete Firewall Profile
Deprecated
GET
Get Firewall Profile
Deprecated
PUT
Update Firewall Profile
Deprecated
GET
Read Firewall Rule
Deprecated
GET
Get Rule State
Deprecated
GET
List Sections
Deprecated
POST
Add Section
Deprecated
GET
Get Sections Summary
Deprecated
DELETE
Delete Section
Deprecated
GET
Get Section
Deprecated
PUT
Update Section
Deprecated
GET
Get Rules
Deprecated
POST
Add Rule In Section
Deprecated
GET
Get Firewall Section Stats
Deprecated
DELETE
Delete Rule
Deprecated
GET
Get Rule
Deprecated
PUT
Update Rule
Deprecated
GET
Get Firewall Stats
Deprecated
POST
Revise Rule
Deprecated
POST
Add Rules In Section
Deprecated
GET
Get Section State
Deprecated
POST
Get Section With Rules
Deprecated
POST
Lock Section
Deprecated
POST
Revise Section
Deprecated
POST
Revise Section With Rules
Deprecated
POST
Unlock Section
Deprecated
POST
Update Section With Rules
Deprecated
POST
Add Section With Rules
Deprecated
POST
Reset Firewall Rule Stats
Deprecated
GET
List Firewall Status
Deprecated
GET
Get Firewall Status
Deprecated
PUT
Update Firewall Status
Deprecated
GET
Get Firewall Status On Target Resource
Deprecated
POST
Disable Firewall On Target Resource
Deprecated
POST
Enable Firewall On Target Resource
Deprecated
GET
List Compute Collection Statuses
Deprecated
GET
List Transport Node Statuses By Compute Collection Id
Deprecated
GET
Get Compute Collection Status By Id
Deprecated
GET
List Enabled Compute Collections
Deprecated
DELETE
Delete Enabled Compute Collection
Deprecated
GET
Get Enabled Compute Collection
Deprecated
PUT
Update Enabled Compute Collection
Deprecated
GET
Get Master Switch Setting
Deprecated
PUT
Update Master Switch Setting
Deprecated
GET
Get Nsgroup Vm Details
Deprecated
GET
Get Standalone Hosts Switch Setting
Deprecated
PUT
Update Standalone Hosts Switch Setting
Deprecated
GET
Get System Stats
Deprecated
GET
List Virtual Machine Statuses By Transport Node Id
Deprecated
GET
List User Sessions
Deprecated
GET
Get User Stats
Deprecated
GET
Get Vm Stats
Deprecated
GET
Get Mps Compute Collection Status
DELETE
Delete Mps Service Deployment
GET
Get Mps Service Deployment
POST
Deploy Mps Service
POST
Mps Change Appliance
GET
Get Mps Deployment Spec
GET
Malware Prevention Teaser List Regions
POST
Create Malware Prevention Teaser Registration Url
GET
Malware Prevention Teaser Check Status
GET
Get Mps Transport Node Status
GET
List Service Configs
Deprecated
POST
Create Service Config
Deprecated
POST
Service Config Batch Operation
Deprecated
GET
Effective Profiles
Deprecated
DELETE
Delete Service Config
Deprecated
GET
Read Service Config
Deprecated
PUT
Update Service Config
Deprecated
GET
List Service Attachments
Deprecated
POST
Add Service Attachment
Deprecated
DELETE
Delete Service Attachment
Deprecated
GET
Get Service Attachment
Deprecated
PUT
Update Service Attachment
Deprecated
GET
List Service Chains
Deprecated
POST
Add Service Chain
Deprecated
DELETE
Delete Service Chain
Deprecated
GET
Get Service Chain
Deprecated
GET
List Service Paths
Deprecated
GET
List Service Instances
GET
List Service Managers
POST
Register Service Manager
DELETE
Delete Service Manager
GET
Get Service Manager
PUT
Update Service Manager
GET
List Service Insertion Services
POST
Add Service Insertion Service
DELETE
Delete Service Insertion Service
GET
Get Service Insertion Service
PUT
Update Service Insertion Service
GET
Get Service Deployments
POST
Deploy Service
DELETE
Delete Service Deployment
GET
Get Service Deployment
PUT
Update Service Deployment
Deprecated
GET
Get Service Deployment State
GET
Get Service Deployment Status
POST
Upgrade Service Deployment
GET
List Service Instances For Service
POST
Add Service Instance
DELETE
Delete Service Instance
Deprecated
GET
Get Service Instance
PUT
Update Service Instance
Deprecated
GET
Get Service Instance NS Groups
GET
List Instance Endpoints
POST
Add Instance Endpoint
Deprecated
DELETE
Delete Instance Endpoint
Deprecated
GET
Get Instance Endpoint
Deprecated
GET
List Instance Runtimes
POST
Update Service Vm State
GET
Get Runtime Interface Statistics
Deprecated
GET
Get Runtime Interface Operational Status
POST
Delete Service V Ms
Deprecated
POST
Deploy Service V Ms
Deprecated
POST
Upgrade Service V Ms
Deprecated
GET
Get Service Instance State
GET
Get Service Instance Status
GET
List SI Service Profiles
Deprecated
POST
Add SI Service Profile
Deprecated
DELETE
Delete SI Service Profile
Deprecated
GET
Get SI Service Profile
Deprecated
GET
Get Service Profile NS Groups
Deprecated
GET
List Service Chain Mappings
Deprecated
GET
List Solution Configs
POST
Create Solution Config
DELETE
Delete Solution Config
GET
Get Solution Config
PUT
Update Solution Config
DELETE
Delete Extended Solution Config
GET
Get Extended Solution Config
POST
Create Extended Solution Config
PUT
Update Extended Solution Config
GET
List Vendor Templates
POST
Add Vendor Template
DELETE
Delete Vendor Template
GET
Get Vendor Template
GET
Resolve Source Entities