Share via


Read (GET) a CloudCapacity [SPFSDK][VMMREF]

 

Applies To: Windows Azure Pack

Get a CloudCapacity [SPFSDK][VMMREF] entity by using the HTTP GET operation.

Important

This operation is only available through the admin Service Management API endpoint.

Here is a list of examples related to this collection operation.

  • Example: Get the cloud capacities of a cloud

Request

For more information about returning multiple entities, see Common GET HTTP Info.

For more information about the placeholders used in the URI, see URL placeholders.

Method

Request URI

HTTP Version

GET

https://{server-name}:{auth-port}/{subscription-id}/services/systemcenter/vmm/CloudCapacities(CloudId=Guid'[value]',StampId=Guid'[value]')

HTTP/1.1

Request URI Parameters

URI Parameter

Description

ID

Required [Edm.Guid] The identifier of the entity.

StampId

Required [Edm.Guid] The identifier of the stamp that restricts the query.

Request Headers

This operation does not use any non-standard request headers.

For more information about the common request headers used by this operation, see Common HTTP request information.

Request Body

None

Response

Response Codes

This operation does not return any non-standard OData response codes. If successful, it will return code 200 OK.

Response Headers

This operation does not use any non-standard response headers.

For more information about the common response headers used by this operation, see Common HTTP response information.

Response Body

The response body will contain either (depending on the request headers) an XML or JSON encoded CloudCapacity [SPFSDK][VMMREF] entity or entities. Here is the response body of a single entity.

{
  "odata.metadata": "https://contoso.com:30004/services/systemcenter/SC2012R2/VMM/Microsoft.Management.Odata.svc/$metadata#CloudCapacities/@Element",
  "StampId": "d70c1a9b-c241-48f5-880a-b6c36071e653",
  "CloudId": "10f8e459-e7c3-4c40-b47c-b8f758ef4dc1",
  "CPUCount": "10",
  "UseCPUCountMaximum": true,
  "CustomQuotaCount": "10",
  "UseCustomQuotaCountMaximum": true,
  "MemoryMB": "10240",
  "UseMemoryMBMaximum": true,
  "StorageGB": "10",
  "UseStorageGBMaximum": true,
  "VMCount": "10",
  "UseVMCountMaximum": true
}

Example: Get the cloud capacities of a cloud

This example gets the cloud capacity information for a cloud.

For more information about how to get started with using the code examples provided in this programming guide, see Program in Visual Studio with the Windows Azure Pack IaaS Resource Provider [SPFSDK].

Guid stampId = new Guid("d70c1a9b-c241-48f5-880a-b6c36071e653");
Guid cloudId = new Guid("10f8e459-e7c3-4c40-b47c-b8f758ef4dc1");

var capacity = vmmService.CloudCapacities.Where(c => c.StampId == stampId && c.CloudId == cloudId).ToList();

HTTP Request

GET https://contoso.com:30004/services/systemcenter/SC2012R2/VMM/Microsoft.Management.Odata.svc/CloudCapacities(StampId=guid'd70c1a9b-c241-48f5-880a-b6c36071e653',CloudId=guid'10f8e459-e7c3-4c40-b47c-b8f758ef4dc1') HTTP/1.1
DataServiceVersion: 1.0;NetFx
MaxDataServiceVersion: 3.0;NetFx
Accept: application/json;odata=minimalmetadata
Accept-Charset: UTF-8
DataServiceUrlConventions: KeyAsSegment
User-Agent: Microsoft ADO.NET Data Services
Authorization: Bearer {ENCODED AUTHENTICATION TOKEN}
x-ms-principal-id: contoso\administrator
Host: contoso.com:30004

HTTP Response

HTTP/1.1 200 OK
Cache-Control: no-cache
Content-Length: 480
Content-Type: application/json; odata=minimalmetadata; streaming=true; charset=utf-8
Server: Microsoft-IIS/8.5
X-Content-Type-Options: nosniff
request-id: d3df681c-b278-0000-246f-e2d378b2cf01
DataServiceVersion: 3.0;
Server: Microsoft-IIS/8.5
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
X-Powered-By: ASP.NET
Date: Thu, 18 Sep 2014 20:07:33 GMT

{"odata.metadata":"https://contoso.com:30004/services/systemcenter/SC2012R2/VMM/Microsoft.Management.Odata.svc/$metadata#CloudCapacities/@Element","StampId":"d70c1a9b-c241-48f5-880a-b6c36071e653","CloudId":"10f8e459-e7c3-4c40-b47c-b8f758ef4dc1","CPUCount":"10","UseCPUCountMaximum":true,"CustomQuotaCount":"10","UseCustomQuotaCountMaximum":true,"MemoryMB":"10240","UseMemoryMBMaximum":true,"StorageGB":"10","UseStorageGBMaximum":true,"VMCount":"10","UseVMCountMaximum":true}

See Also

CloudCapacities Collection [SPFSDK][VMMREF]
CloudCapacity [SPFSDK][VMMREF]