[{"label":"Latest (2.0.0)","version":"latest"},{"version":"1.0.0"}]
vsphere-replication-api
Get All VR Details In Pairing
DescriptionGet information about vSphere Replication servers that are paired.
Request
URLURL
https://{api_host}//pairings/{pairing_id}/vrs
Path Parameters
Path Parameters
string
pairing_id
Required
The ID of the pairing between this vSphere Replication server and the remote one.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK
Returns
VrmsInfoDrResponseList
of type application/json
Detailed information about all vSphere Replication Management Servers in a pairing.
{
"_meta": {
"errors": [
{
"code": "string",
"field": "string",
"message": "string"
}
],
"limit": 0,
"links": {
"next": {
"href": "string"
},
"previous": {
"href": "string"
},
"self": {
"href": "string"
}
},
"offset": 0,
"total": 0
},
"list": [
{
"certificate_warnings": [
{
"certificate": {
"certificate": "string",
"extended_key_usage": [
"string"
],
"issuer_alternative_names": [
"string"
],
"issuer_dn": "C=US, OU=DR Division, O=\"VMware, Inc.\", CN=\"VMware, Inc.\"",
"issuer_unique_id": [
false
],
"key_usage": [
false
],
"not_after": 0,
"not_before": 0,
"public_key": "string",
"public_key_algorithm": "RSA",
"public_key_format": "X.509",
"serial_number": "string",
"sig_alg_name": "SHA256withRSA",
"sig_alg_oid": "1.2.840.10040.4.3",
"signature": "string",
"subject_alternative_names": [
"string"
],
"subject_dn": "C=US, OU=DR Division, O=\"VMware, Inc.\", CN=\"VMware, Inc.\"",
"subject_unique_id": [
false
],
"thumbprint": "string",
"version": 3
},
"server_guid": "string",
"server_url": "string"
}
],
"certificates": [
{
"certificate": "string",
"extended_key_usage": [
"string"
],
"issuer_alternative_names": [
"string"
],
"issuer_dn": "C=US, OU=DR Division, O=\"VMware, Inc.\", CN=\"VMware, Inc.\"",
"issuer_unique_id": [
false
],
"key_usage": [
false
],
"not_after": 0,
"not_before": 0,
"public_key": "string",
"public_key_algorithm": "RSA",
"public_key_format": "X.509",
"serial_number": "string",
"sig_alg_name": "SHA256withRSA",
"sig_alg_oid": "1.2.840.10040.4.3",
"signature": "string",
"subject_alternative_names": [
"string"
],
"subject_dn": "C=US, OU=DR Division, O=\"VMware, Inc.\", CN=\"VMware, Inc.\"",
"subject_unique_id": [
false
],
"thumbprint": "string",
"version": 3
}
],
"extension_key": "string",
"id": "string",
"name": "string",
"server_status": "OK",
"url": "string",
"vc_guid": "string",
"vc_name": "string",
"version": "string"
}
]
}
array of
VrmsInfo
list
Optional
Detailed information about the vSphere Replication Management Server.
Errors
ResponseError
400
Bad request - the server could not understand the request due to invalid syntax or invalid request body content
401
Unauthorized - the client must authenticate itself to get the requested response
ResponseError
403
Forbidden - not sufficient access rights to fulfill the request
ResponseError
500
Internal server error - unexpected condition prevents fulfilling the request
Code Samples
PowerCLI Client SDK Example
Invoke-VrGetAllVrDetailsInPairing -pairingId "MypairingId"
cURL Command
curl https://{api_host}/pairings/{pairing_id}/vrs
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-dr-permissions:
permissions: HmsRemote.com.vmware.vcHms.Hms.View
x-dr-remote-site-connectivity-contract:
not-authenticated: PARTIAL_DATA
server-down: PARTIAL_DATA
[{"label":"Latest (2.0.0)","version":"latest"},{"version":"1.0.0"}]
vsphere-replication-api
On This Page
Pairing Operations
delete
get
get
post
post
