Get All Replication Resources Allocated to Reseller on Specific Site
You can get a collection resource representation of all cloud replication resources allocated to a reseller on a site with the specified UID.
Required Privileges
To perform this task, a user must have one of the following roles assigned: Portal Administrator, Service Provider Global Administrator, Service Provider Administrator.
Request
To get a representation of all cloud replication resources allocated to a reseller on a specific site, send the GET HTTP request to the URL of the /organizations/resellers/{resellerUid}/sites/{siteUid}/replicationResources collection.
HTTP Request
GET https://<hostname>:1280/api/v3/organizations/resellers/{resellerUid}/sites/{siteUid}/replicationResources |
Request Headers
The request contains the following headers.
Header | Required/Optional | Value | Description |
Authorization | Required | Bearer <Access-Token> | Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format. |
Accept | Optional | application/json | Specifies a media type of representation that is required in the response message. If the requested type is not supported, the server will return the response in the application/json media type. |
Request parameters
A list of parameters that are applicable for this operation:
Name | In | Type | Required | Default | Description |
---|---|---|---|---|---|
resellerUid | Path | String (uuid) | Yes | — | Reseller UID |
siteUid | Path | String (uuid) | Yes | — | Site UID |
limit | Query | Integer (int32) | No | 100 | Specifies the first N resources that must be returned in the output |
offset | Query | Integer (int32) | No | 0 | Excludes the first N resources from the query output |
Response
The server returns the following response to the client.
Response Code
A successfully completed operation returns response code 200 OK.
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTP headers.
Header | Description |
Content-length | The length of the response body. |
Content-type | The media type and syntax of the request body message: application/json; charset=utf-8 |
Response Body
In the response body, Veeam Service Provider Console returns a collection resource representation based on the ResellerSiteReplicationResource schema.
Example
The following request returns a representation of a replication resource allocated to a reseller with UID 3e399fca-319b-471d-a160-e186aff0adf4 on a site with UID 890a52cd-4eaf-428e-81f8-886a6b819c16.
Request: GET https://localhost:1280/api/v3/organizations/resellers/3e399fca-319b-471d-a160-e186aff0adf4/sites/890a52cd-4eaf-428e-81f8-886a6b819c16/replicationResources
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "meta": { "pagingInfo": { "total": 2, "count": 2, "offset": 0 } }, "data": [ { "instanceUid": "43eb7d02-cef4-03a2-bb49-a12e7c5af7b8", "siteUid": "890a52cd-4eaf-428e-81f8-886a6b819c16", "resellerUid": "3e399fca-319b-471d-a160-e186aff0adf4", "hardwarePlanUid": "6d084b55-6348-4656-88ab-d8016e9475f6" }, { "instanceUid": "30829f7b-375b-d537-421b-2fe59b487086", "siteUid": "890a52cd-4eaf-428e-81f8-886a6b819c16", "resellerUid": "3e399fca-319b-471d-a160-e186aff0adf4", "hardwarePlanUid": "6d084b55-6348-4656-88ab-d8016e9475f6" } ] } |