Sign In to the Console
AWS OpsWorks
API Reference (API Version 2013-02-18)

AWS Documentation » OpsWorks » API Reference » Actions » DescribeRaidArrays
The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

DescribeRaidArrays

Describe an instance's RAID arrays.

Note

This call accepts only one resource-identifying parameter.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

Request Syntax

{
   "InstanceId": "string",
   "RaidArrayIds": [ "string" ],
   "StackId": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

InstanceId

The instance ID. If you use this parameter, DescribeRaidArrays returns descriptions of the RAID arrays associated with the specified instance.

Type: String

Required: No

RaidArrayIds

An array of RAID array IDs. If you use this parameter, DescribeRaidArrays returns descriptions of the specified arrays. Otherwise, it returns a description of every array.

Type: Array of strings

Required: No

StackId

The stack ID.

Type: String

Required: No

Response Syntax

{
   "RaidArrays": [ 
      { 
         "AvailabilityZone": "string",
         "CreatedAt": "string",
         "Device": "string",
         "InstanceId": "string",
         "Iops": number,
         "MountPoint": "string",
         "Name": "string",
         "NumberOfDisks": number,
         "RaidArrayId": "string",
         "RaidLevel": number,
         "Size": number,
         "StackId": "string",
         "VolumeType": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

RaidArrays

A RaidArrays object that describes the specified RAID arrays.

Type: Array of RaidArray objects

Errors

For information about the errors that are common to all actions, see Common Errors.

ResourceNotFoundException

Indicates that a resource was not found.

HTTP Status Code: 400

ValidationException

Indicates that a request was not valid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: