NSX-T Data Center REST API

Get status of tag bulk operation

Get status of tag bulk operation with details of tag operation on each virtual machine.

Request:

Method:

GET

URI Path(s):

/policy/api/v1/infra/tags/tag-operations/{operation-id}/status
/policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tags/tag-operations/{operation-id}/status

Request Headers:

n/a

Query Parameters:

RealizationListRequestParameters+

RealizationListRequestParameters (schema)

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
enforcement_point_path	String Path of the enforcement point The path of the enforcement point from which the list of members needs to be fetched. Forward slashes must be escaped using %2F.	string
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.	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

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

TagBulkOperationStatus+

TagBulkOperationStatus (schema)

Name	Description	Type	Notes
apply_to	Tag apply operation status per resource type Tag apply operation status per resource type.	array of ResourceTypeTagStatus
path	Intent path corresponding to tag operation	string	Required
remove_from	Tag remove operation status per resource type Tag remove operation status per resource type.	array of ResourceTypeTagStatus
status	Overall status	string	Required Enum: Success, Running, Error, Pending
tag	Tag	Tag	Required

Example Response:

{ "tag": { "scope": "os", "tag": "windows" }, "status": "Error", "apply_to": [ { "resource_type": "VirtualMachine", "resource_tag_status": [ { "resource_id": "e98a906-7b84-42ae-9413-d812cdb64543", "tag_status": "Success" } ] } ], "remove_from":[ { "resource_type": "VirtualMachine", "resource_tag_status": [ { "resource_id": "564d8b81-983d-b8ef-686b-161205939c58", "tag_status": "Error", "details": "VM with external id not found" } ] } ], }

Required Permissions:

crud

Feature:

policy_vm_vm_tags

Additional Errors:

• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable