Updated on 2024-02-27 GMT+08:00

Querying Extension APIs

Function

This API is used to query extension APIs.

Calling Method

For details, see Calling APIs.

URI

GET /v3/{project_id}/extensions

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

The project ID.

For details about how to obtain the project ID, see Obtaining a Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

The user token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

extensions

Array of Extension objects

The list of extended APIs.

Table 4 Extension

Parameter

Type

Description

alias

String

The alias of the extension.

description

String

The description.

links

Array of Link objects

The link of the disk transfer.

name

String

The name of the disk transfer.

updated

String

The last update time.

Time format: UTC YYYY-MM-DDTHH:MM:SS.+XX.XX, in which +XX.XX is the time zone.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error

Error object

The error message returned if an error occurs.

Table 7 Error

Parameter

Type

Description

code

String

The error code returned if an error occurs.

For details about error codes and their meanings, see Error Codes.

message

String

The error message returned if an error occurs.

Example Requests

GET https://{endpoint}/v3/{project_id}/extensions

Example Responses

Status code: 200

OK

{
  "extensions" : [ {
    "updated" : "2013-04-18T00:00:00+00:00",
    "name" : "SchedulerHints",
    "links" : [ ],
    "alias" : "OS-SCH-HNT",
    "description" : "Pass arbitrary key/value pairs to the scheduler."
  }, {
    "updated" : "2011-06-29T00:00:00+00:00",
    "name" : "Hosts",
    "links" : [ ],
    "alias" : "os-hosts",
    "description" : "Admin-only host administration."
  }, {
    "updated" : "2011-11-03T00:00:00+00:00",
    "name" : "VolumeTenantAttribute",
    "links" : [ ],
    "alias" : "os-vol-tenant-attr",
    "description" : "Expose the internal project_id as an attribute of a volume."
  }, {
    "updated" : "2011-08-08T00:00:00+00:00",
    "name" : "Quotas",
    "links" : [ ],
    "alias" : "os-quota-sets",
    "description" : "Quota management support."
  }, {
    "updated" : "2011-08-24T00:00:00+00:00",
    "name" : "TypesManage",
    "links" : [ ],
    "alias" : "os-types-manage",
    "description" : "Types manage support."
  }, {
    "updated" : "2013-07-10T00:00:00+00:00",
    "name" : "VolumeEncryptionMetadata",
    "links" : [ ],
    "alias" : "os-volume-encryption-metadata",
    "description" : "Volume encryption metadata retrieval support."
  }, {
    "updated" : "2012-12-12T00:00:00+00:00",
    "name" : "Backups",
    "links" : [ ],
    "alias" : "backups",
    "description" : "Backups support."
  }, {
    "updated" : "2013-07-16T00:00:00+00:00",
    "name" : "SnapshotActions",
    "links" : [ ],
    "alias" : "os-snapshot-actions",
    "description" : "Enable snapshot manager actions."
  }, {
    "updated" : "2012-05-31T00:00:00+00:00",
    "name" : "VolumeActions",
    "links" : [ ],
    "alias" : "os-volume-actions",
    "description" : "Enable volume actions"
  }, {
    "updated" : "2013-10-03T00:00:00+00:00",
    "name" : "UsedLimits",
    "links" : [ ],
    "alias" : "os-used-limits",
    "description" : "Provide data on limited resources that are being used."
  }, {
    "updated" : "2012-05-31T00:00:00+00:00",
    "name" : "VolumeUnmanage",
    "links" : [ ],
    "alias" : "os-volume-unmanage",
    "description" : "Enable volume unmanage operation."
  }, {
    "updated" : "2011-11-03T00:00:00+00:00",
    "name" : "VolumeHostAttribute",
    "links" : [ ],
    "alias" : "os-vol-host-attr",
    "description" : "Expose host as an attribute of a volume."
  }, {
    "updated" : "2013-07-01T00:00:00+00:00",
    "name" : "VolumeTypeEncryption",
    "links" : [ ],
    "alias" : "encryption",
    "description" : "Encryption support for volume types."
  }, {
    "updated" : "2013-06-27T00:00:00+00:00",
    "name" : "AvailabilityZones",
    "links" : [ ],
    "alias" : "os-availability-zone",
    "description" : "Describe Availability Zones."
  }, {
    "updated" : "2013-08-02T00:00:00+00:00",
    "name" : "Qos_specs_manage",
    "links" : [ ],
    "alias" : "qos-specs",
    "description" : "QoS specs support."
  }, {
    "updated" : "2011-08-24T00:00:00+00:00",
    "name" : "TypesExtraSpecs",
    "links" : [ ],
    "alias" : "os-types-extra-specs",
    "description" : "Type extra specs support."
  }, {
    "updated" : "2013-08-08T00:00:00+00:00",
    "name" : "VolumeMigStatusAttribute",
    "links" : [ ],
    "alias" : "os-vol-mig-status-attr",
    "description" : "Expose migration_status as an attribute of a volume."
  }, {
    "updated" : "2012-08-13T00:00:00+00:00",
    "name" : "CreateVolumeExtension",
    "links" : [ ],
    "alias" : "os-image-create",
    "description" : "Allow creating a volume from an image in the Create Volume v1 API."
  }, {
    "updated" : "2014-01-10T00:00:00-00:00",
    "name" : "ExtendedServices",
    "links" : [ ],
    "alias" : "os-extended-services",
    "description" : "Extended services support."
  }, {
    "updated" : "2012-06-19T00:00:00+00:00",
    "name" : "ExtendedSnapshotAttributes",
    "links" : [ ],
    "alias" : "os-extended-snapshot-attributes",
    "description" : "Extended SnapshotAttributes support."
  }, {
    "updated" : "2012-12-07T00:00:00+00:00",
    "name" : "VolumeImageMetadata",
    "links" : [ ],
    "alias" : "os-vol-image-meta",
    "description" : "Show image metadata associated with the volume."
  }, {
    "updated" : "2012-03-12T00:00:00+00:00",
    "name" : "QuotaClasses",
    "links" : [ ],
    "alias" : "os-quota-class-sets",
    "description" : "Quota classes management support."
  }, {
    "updated" : "2013-05-29T00:00:00+00:00",
    "name" : "VolumeTransfer",
    "links" : [ ],
    "alias" : "os-volume-transfer",
    "description" : "Volume transfer management support."
  }, {
    "updated" : "2014-02-10T00:00:00+00:00",
    "name" : "VolumeManage",
    "links" : [ ],
    "alias" : "os-volume-manage",
    "description" : "Allows existing backend storage to be 'managed' by Cinder."
  }, {
    "updated" : "2012-08-25T00:00:00+00:00",
    "name" : "AdminActions",
    "links" : [ ],
    "alias" : "os-admin-actions",
    "description" : "Enable admin actions."
  }, {
    "updated" : "2012-10-28T00:00:00-00:00",
    "name" : "Services",
    "links" : [ ],
    "alias" : "os-services",
    "description" : "Services support."
  } ]
}

Status code: 400

Bad Request

{
  "error" : {
    "message" : "XXXX",
    "code" : "XXX"
  }
}

Status Codes

Status Code

Description

200

OK

400

Bad Request

Error Codes

See Error Codes.