Public cloud Application Programming Interfaces (APIs) comply with the RESTful API design principles. REST-based Web services are organized into resources. Each resource is identified by one or more Uniform Resource Identifiers (URIs). An application accesses a resource based on the resource's Uniform Resource Locator (URL). A URL is usually in the following format: https://Endpoint/uri. In the URL, uri indicates the resource path, that is, the API access path.
-Public cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted by using JSON messages, with media type represented by Application/json.
-For details about how to use APIs, see API Usage Guidelines.
+Public cloud Application Programming Interfaces (APIs) comply with the RESTful API design principles. REST-based Web services are organized into resources. Each resource is identified by one or more Uniform Resource Identifiers (URIs). An application accesses a resource based on the resource's Uniform Resource Locator (URL). A URL is usually in the following format: https://Endpoint/uri. In the URL, uri indicates the resource path, that is, the API access path.
+Public cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted by using JSON messages, with media type represented by Application/json.
+For details about how to use APIs, see API Usage Guidelines.
Query the metadata of an EVS disk (OpenStack Cinder API).
GET /v2/{project_id}/volumes/{volume_id}/metadata/{key}
+GET /v2/{project_id}/volumes/{volume_id}/metadata
evs:volumes:get
The value of parameter offset must be an integer.
Set the value of parameter offset to an integer.
+Set the value of parameter offset to an integer.
400
@@ -1358,9 +1358,9 @@limit param must be an integer.
The value of parameter limit must be set to an integer.
+The value of parameter limit must be set to an integer.
Set the value of parameter limit to an integer.
+Set the value of parameter limit to an integer.
400
@@ -1369,7 +1369,7 @@limit param must be positive.
The value of parameter limit must be a positive number.
+The value of parameter limit must be a positive number.
Ensure that the limit value is an integer ranging from 1 to 1000. The default value is 1000.
Query the metadata of an EVS disk (OpenStack Cinder API).
GET /v2/{project_id}/volumes/{volume_id}/metadata/{key}
+GET /v2/{project_id}/volumes/{volume_id}/metadata
evs:volumes:get
2024-04-19
+2025-01-03
Updated the following content:
-Deleted the content related to Ultra-high I/O (Latency optimized) and High I/O (Performance optimized I) EVS disks.
+Added the following content:
+- Added the API described in Changing the EVS Disk Type.
2024-04-19
+Deleted the following content:
+- Deleted the content related to the Ultra-high I/O (Latency optimized) and High I/O (Performance optimized I) types of EVS disks.
2024-02-18
Added the following content:
-Creating EVS Disks, Querying Details About All Disks, Updating an EVS Disk, Querying Details About All Disks (Deprecated), Querying Details About a Disk, Creating EVS Disks, Updating an EVS Disk, Querying Details About All Disks, and Querying Details About a Disk
+Updated the following sections:
+2023-12-13
Added the following content:
-Added support for the General Purpose SSD disk type in sections Creating EVS Disks, Querying Details About All Disks, Updating an EVS Disk, Querying Details About All Disks (Deprecated), Querying Details About a Disk, Creating EVS Disks, Updating an EVS Disk, Querying Details About All Disks, and Querying Details About a Disk.
+Updated the following content:
+- Added support for the General Purpose SSD disk type in sections Creating EVS Disks, Querying Details About All Disks, Updating an EVS Disk, Querying Details About All Disks (Deprecated), Querying Details About a Disk, Creating EVS Disks, Updating an EVS Disk, Querying Details About All Disks, and Querying Details About a Disk.
2023-01-30
@@ -59,14 +65,14 @@2018-11-30
Modified the following content:
-- Changes relate to the Queens upgrade are listed as follows:
- Modified descriptions of the request filter parameters, such as name and with_count in Querying EVS Disks.
- Modified descriptions of the request filter parameters, such as name and with_count in Querying Details About All Disks.
- Modified descriptions of the request filter parameters, such as name and with_count in Querying EVS Snapshots.
- Modified descriptions of the request filter parameters, such as name and with_count in Querying Details About EVS Snapshots.
- Changes relate to the Queens upgrade are listed as follows:
- Modified descriptions of the request filter parameters, such as name and with_count in Querying EVS Disks.
- Modified descriptions of the request filter parameters, such as name and with_count in Querying Details About All Disks.
- Modified descriptions of the request filter parameters, such as name and with_count in Querying EVS Snapshots.
- Modified descriptions of the request filter parameters, such as name and with_count in Querying Details About EVS Snapshots.
2018-09-30
Added the following content:
-- Changes relate to the Queens upgrade are listed as follows:
- Added seven parameters, such as bootable and with_count, in the request filter parameters and added response parameter count in Querying EVS Disks.
- Added eight parameters, such as glance_metadata and with_count, in the request filter parameters and added response parameter count in Querying Details About All Disks.
- Added five parameters, such as name~ and with_count, in the request filter parameters and added response parameter count in Querying EVS Snapshots.
- Added six parameters, such as metadata and with_count, in the request filter parameters and added response parameters user_id and count in Querying Details About EVS Snapshots.
- Changes relate to the Queens upgrade are listed as follows:
- Added seven parameters, such as bootable and with_count, in the request filter parameters and added response parameter count in Querying EVS Disks.
- Added eight parameters, such as glance_metadata and with_count, in the request filter parameters and added response parameter count in Querying Details About All Disks.
- Added five parameters, such as name~ and with_count, in the request filter parameters and added response parameter count in Querying EVS Snapshots.
- Added six parameters, such as metadata and with_count, in the request filter parameters and added response parameters user_id and count in Querying Details About EVS Snapshots.
2018-03-30
Added the following content:
-- Added support for v3 APIs.
- Added sections Querying EVS Disk Details by Service and Querying Details About a Single EVS Disk.
- Added sections Querying the Number of EVS Disks by Tag and Querying Details of EVS Disks by Tag.
- Added support for v3 APIs.
- Added sections Querying EVS Disk Details by Service and Querying Details About a Single EVS Disk.
- Added sections Querying the Number of EVS Disks by Tag and Querying Details of EVS Disks by Tag.
- Modified the constraints of tag keys and tag values.
2018-01-31
Added the following content:
-- Added section Exporting EVS Disk Data as an Image.
- Added section Exporting EVS Disk Data as an Image.
Modified the following content:
- Modified the reviewed EVS replication issues.
- Modified the reviewed EVS disk transfer issues.
2018-01-19
Added the following content:
-- Added chapter EVS Disk Transfer.
- Added chapter EVS Disk Transfer.
2017-12-01
@@ -146,13 +152,13 @@2017-10-19
Modified the following content:
-- Deprecated the APIs in sections Attaching an EVS Disk (Native OpenStack API) and Detaching an EVS Disk (Native OpenStack API).
- Deprecated the APIs in sections Attaching an EVS Disk (Native OpenStack API) and Detaching an EVS Disk (Native OpenStack API).
2017-09-30
Added the following content:
-- Added constraints on the expansion of In-use EVS disks.
- Added constraints on the expansion of In-use EVS disks.
2017-08-18
@@ -208,7 +214,7 @@2017-03-30
Added the following content:
-- Added chapter EVS Snapshot.
- Added sections EVS Disk Status and EVS Snapshot Status.
- Added the shared disk feature and added the parameter description for the multiattach parameter.
- Added the SCSI feature and added the parameter description for the hw:passthrough parameter.
- Added chapter EVS Snapshot.
- Added sections EVS Disk Status and EVS Snapshot Status.
- Added the shared disk feature and added the parameter description for the multiattach parameter.
- Added the SCSI feature and added the parameter description for the hw:passthrough parameter.
2017-02-22
@@ -226,7 +232,7 @@2016-08-25
Modified the following content:
-- Modified the parameter description in section Updating EVS Information.
- Modified the parameter description in section Querying Details About All EVS Disks.
- Modified the parameter description in section Querying Details About a Single EVS Disk.
- Modified the parameter description in section Querying Task Information.
- Modified the parameter description in section Updating EVS Information.
- Modified the parameter description in section Querying Details About All EVS Disks.
- Modified the parameter description in section Querying Details About a Single EVS Disk.
- Modified the parameter description in section Querying Task Information.
2016-07-30
@@ -244,7 +250,7 @@2016-06-16
Modified the following content:
-- Modified the parameter description in section Updating EVS Information.
- Modified the parameter description in section Querying Details About All EVS Disks.
- Modified the parameter description in section Querying Details About a Single EVS Disk.
- Modified the parameter description in section Updating EVS Information.
- Modified the parameter description in section Querying Details About All EVS Disks.
- Modified the parameter description in section Querying Details About a Single EVS Disk.
2016-06-02
diff --git a/docs/evs/api-ref/evs_04_0052.html b/docs/evs/api-ref/evs_04_0052.html index 1569e1805..7b25884c4 100644 --- a/docs/evs/api-ref/evs_04_0052.html +++ b/docs/evs/api-ref/evs_04_0052.html @@ -410,6 +410,7 @@ } } +Yes
Specifies the project ID.
+The project ID.
job_id
Yes
Specifies the task ID.
+The task ID.
String
Specifies the task status.
-- SUCCESS: The task is successfully executed.
- RUNNING: The task is in progress.
- FAIL: The task fails.
- INIT: The task is being initialized.
The task status.
+- SUCCESS: The task is successfully executed.
- RUNNING: The task is in progress.
- FAIL: The task fails.
- INIT: The task is being initialized.
entities
Object
Specifies the response to the task. For details, see •Parameters in the entities field.
+The task response. For details, see •Parameters in the entities field.
The content for each type of task is different.
String
Specifies the task ID.
+The task ID.
job_type
String
Specifies the task type.
+The task type.
- createVolume: creates a disk.
- batchCreateVolume: batch creates disks.
- deleteVolume: deletes a disk.
- extendVolume: expands the disk capacity.
- bulkDeleteVolume: batch deletes disks.
- deleteSingleVolume: deletes disks one by one during a batch deletion.
String
Specifies the time when the task was started.
+The time when the task was started.
Time format: YYYY-MM-DDTHH:MM:SS.SSS'Z'
String
Specifies the time when the task finished.
+The time when the task finished.
Time format: YYYY-MM-DDTHH:MM:SS.SSS'Z'
String
Specifies the returned error code when the task execution fails.
+The error code returned if the task execution fails.
fail_reason
String
Specifies the cause of the task execution failure.
+The cause of the task execution failure.
error
Object
Specifies the error message returned when an error occurs. For details, see Parameters in the error field.
+The error message returned if an error occurs. For details, see Parameters in the error field.
String
Specifies the EVS disk name.
+The disk name.
size
Integer
Specifies the disk size, in GB.
+The disk size, in GB.
sub_jobs
Array of Objects
Specifies the information about a sub-job. For details, see •Parameters in the sub_jobs field.
+The information of a subtask. For details, see •Parameters in the sub_jobs field.
volume_id
String
Specifies the disk ID.
+The disk ID.
volume_type
String
Specifies the disk type.
+The disk type.
String
Specifies the task status.
-- SUCCESS: The task is successfully executed.
- RUNNING: The task is in progress.
- FAIL: The task fails.
- INIT: The task is being initialized.
The task status.
+- SUCCESS: The task is successfully executed.
- RUNNING: The task is in progress.
- FAIL: The task fails.
- INIT: The task is being initialized.
entities
Object
Specifies the response to the task. For details, see •Parameters in the entities field.
+The task response. For details, see •Parameters in the entities field.
The content for each type of task is different.
String
Specifies the task ID.
+The task ID.
job_type
String
Specifies the task type.
-- createVolume: creates a disk.
- batchCreateVolume: batch creates disks.
- deleteVolume: deletes a disk.
- extendVolume: expands the disk capacity.
- bulkDeleteVolume: batch deletes disks.
- deleteSingleVolume: deletes disks one by one during a batch deletion.
The task type.
+- createVolume: creates a disk.
- batchCreateVolume: batch creates disks.
- deleteVolume: deletes a disk.
- extendVolume: expands the disk capacity.
- bulkDeleteVolume: batch deletes disks.
- deleteSingleVolume: deletes disks one by one during a batch deletion.
begin_time
String
Specifies the time when the task was started.
+The time when the task was started.
Time format: YYYY-MM-DDTHH:MM:SS.SSS'Z'
String
Specifies the time when the task finished.
+The time when the task finished.
Time format: YYYY-MM-DDTHH:MM:SS.SSS'Z'
String
Specifies the returned error code when the task execution fails.
+The error code returned if the task execution fails.
fail_reason
String
Specifies the cause of the task execution failure.
+The cause of the task execution failure.
String
Specifies the EVS disk name.
+The disk name.
size
Integer
Specifies the disk size, in GB.
+The disk size, in GB.
volume_id
String
Specifies the disk ID.
+The disk ID.
volume_type
String
Specifies the disk type.
+The disk type.
+
Parameter |
Type diff --git a/docs/evs/api-ref/evs_04_2011.html b/docs/evs/api-ref/evs_04_2011.html index 9a9a79636..22e828698 100644 --- a/docs/evs/api-ref/evs_04_2011.html +++ b/docs/evs/api-ref/evs_04_2011.html @@ -361,7 +361,7 @@ |
|---|
Parameter |
Type diff --git a/docs/evs/api-ref/evs_04_2014.html b/docs/evs/api-ref/evs_04_2014.html index 1bc321dfb..86b49cde7 100644 --- a/docs/evs/api-ref/evs_04_2014.html +++ b/docs/evs/api-ref/evs_04_2014.html @@ -3,7 +3,7 @@Expanding Capacity of an EVS DiskFunctionThis API is used to expand the capacity of an EVS disk.
| |||
|---|---|---|---|---|
volume_id |
Yes |
-Specifies the disk ID. + | The disk ID. |
Yes |
-Specifies the tag list. For details, see Parameters in the resource_tag field. + | The tag list. For details, see Parameters in the resource_tag field. |
action @@ -61,14 +61,14 @@ |
Yes |
-Specifies the operation to perform. The value can be create or delete. + | The operation to perform. The value can be create or delete. create: specifies to add tags. |
Parameter |
Type @@ -85,7 +85,7 @@ | Yes |
-Specifies the tag key.
The tag key.
| Yes |
-Specifies the tag value.
|
diff --git a/docs/evs/api-ref/evs_04_2031.html b/docs/evs/api-ref/evs_04_2031.html
index 9ba5fe96b..c97304fad 100644
--- a/docs/evs/api-ref/evs_04_2031.html
+++ b/docs/evs/api-ref/evs_04_2031.html
@@ -19,14 +19,14 @@
The tag value.
|
Yes |
-Specifies the project ID. + | The project ID. |
|---|---|---|---|---|
volume_id |
Yes |
-Specifies the disk ID. + | The disk ID. |
List<resource_tag> |
-Specifies the tag list. For details, see Parameters in the tags field. + | The tag list. For details, see Parameters in the resource_tag field. |
Parameter |
Type @@ -68,14 +68,14 @@ | String |
-Specifies the tag key. + | The tag key. |
|---|---|---|---|---|
value |
String |
-Specifies the tag value. + | The tag value. |
Yes |
-Specifies the project ID. + | The project ID. |
@@ -44,7 +44,7 @@
No |
-Specifies the key-value pairs of the tag. For details, see Parameters in the tags field. + | The key-value pairs of tags. For details, see Parameters in the resource_tag field. The tags field cannot be left empty. One tag list can contain a maximum of 10 keys. Tag keys in a tag list must be unique. @@ -59,7 +59,7 @@ |
Yes |
-Specifies the operation identifier. + | The operation identifier. Specifying count queries the number of disks by tag. |
@@ -69,7 +69,7 @@
No |
-Specifies the query criteria that the resource supports. For details, see Parameters in the match field. + | The query criteria that the resource supports. For details, see Parameters in the match field. The matches field cannot be left empty. Tag keys in the list must be unique. |
@@ -94,7 +94,7 @@
Yes |
-Specifies the tag key.
|
@@ -104,7 +104,7 @@
The tag key.
|
Yes |
-Specifies the tag value.
The tag value.
One value list can contain a maximum of 10 values. Tag values in a value list must be unique. @@ -132,7 +132,7 @@ |
-Yes Specifies the tag key. The value is of the enumerated type. + |
@@ -143,7 +143,7 @@
The tag key. The value is of the enumerated type. The value can be as follows:
|
Yes |
-Specifies the tag value. + | The tag value.
|
@@ -188,14 +188,14 @@
Integer |
-Specifies the total number of disks that meet the query criteria. + | The total number of disks that meet the query criteria. |
error |
Object |
-Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + | The error message returned when an error occurs. For details, see Parameters in the error field. |
Parameter |
Type diff --git a/docs/evs/api-ref/evs_04_2036.html b/docs/evs/api-ref/evs_04_2036.html index 43189f74b..572fd506f 100644 --- a/docs/evs/api-ref/evs_04_2036.html +++ b/docs/evs/api-ref/evs_04_2036.html @@ -25,21 +25,21 @@ | Yes |
-Specifies the project ID. + | The project ID. |
|---|---|---|---|---|
resource_type |
Yes |
-Specifies the resource type. The value can be volumes, snapshots, or backups. + | The resource type. The value can be volumes, snapshots, or backups. |
|
resource_id |
Yes |
-Specifies the resource ID. + | The resource ID. |
Yes |
-Specifies the key-value pair of the tag. + | The key-value pair of the tag. |
@@ -87,7 +87,7 @@
Yes |
-Specifies the type. The value can be application/json. + | The type. The value can be application/json. |
@@ -117,7 +117,7 @@
Object |
-Specifies the key-value pair of the tag. + | The key-value pair of the tag. |
diff --git a/docs/evs/api-ref/evs_04_2037.html b/docs/evs/api-ref/evs_04_2037.html
index a4b9f8e3d..34963b385 100644
--- a/docs/evs/api-ref/evs_04_2037.html
+++ b/docs/evs/api-ref/evs_04_2037.html
@@ -21,21 +21,21 @@
Yes |
-Specifies the project ID. + | The project ID. |
resource_type |
Yes |
-Specifies the resource type. The value can be volumes, snapshots, or backups. + | The resource type. The value can be volumes, snapshots, or backups. |
|
resource_id |
Yes |
-Specifies the resource ID. + | The resource ID. |
Yes |
-Specifies the key-value pair of the tag. + | The key-value pair of the tag. |
@@ -83,7 +83,7 @@
Yes |
-Specifies the type. The value can be application/json. + | The type. The value can be application/json. |
diff --git a/docs/evs/api-ref/evs_04_2038.html b/docs/evs/api-ref/evs_04_2038.html
index f7a6cac7f..ba0af6039 100644
--- a/docs/evs/api-ref/evs_04_2038.html
+++ b/docs/evs/api-ref/evs_04_2038.html
@@ -21,21 +21,21 @@
Yes |
-Specifies the project ID. + | The project ID. |
resource_type |
Yes |
-Specifies the resource type. The value can be volumes, snapshots, or backups. + | The resource type. The value can be volumes, snapshots, or backups. |
|
resource_id |
Yes |
-Specifies the resource ID. + | The resource ID. |
Object |
-Specifies the key-value pair of the tag. + | The key-value pair of the tag. |
diff --git a/docs/evs/api-ref/evs_04_2039.html b/docs/evs/api-ref/evs_04_2039.html
index ea70cc532..9e095bc5b 100644
--- a/docs/evs/api-ref/evs_04_2039.html
+++ b/docs/evs/api-ref/evs_04_2039.html
@@ -21,28 +21,28 @@
Yes |
-Specifies the project ID. + | The project ID. |
resource_type |
Yes |
-Specifies the resource type. The value can be volumes, snapshots, or backups. + | The resource type. The value can be volumes, snapshots, or backups. |
|
resource_id |
Yes |
-Specifies the resource ID. + | The resource ID. |
|
key |
Yes |
-Specifies the key of the tag. + | The key of the tag. |
Object |
-Specifies the key-value pair of the tag. + | The key-value pair of a tag. |
diff --git a/docs/evs/api-ref/evs_04_2040.html b/docs/evs/api-ref/evs_04_2040.html
index 5f1142ab2..1dd5f9995 100644
--- a/docs/evs/api-ref/evs_04_2040.html
+++ b/docs/evs/api-ref/evs_04_2040.html
@@ -25,21 +25,21 @@
Yes |
-Specifies the project ID. + | The project ID. |
resource_type |
Yes |
-Specifies the resource type. The value can be volumes, snapshots, or backups. + | The resource type. The value can be volumes, snapshots, or backups. |
|
resource_id |
Yes |
-Specifies the resource ID. + | The resource ID. |
Yes |
-Specifies the key-value pair of the tag. + | The key-value pair of the tag. |
@@ -87,7 +87,7 @@
Yes |
-Specifies the type. The value can be application/json. + | The type. The value can be application/json. |
@@ -114,7 +114,7 @@
Object |
-Specifies the key-value pair of the tag. + | The key-value pair of the tag. |
diff --git a/docs/evs/api-ref/evs_04_2041.html b/docs/evs/api-ref/evs_04_2041.html
index 3a29bc160..3cd1a963d 100644
--- a/docs/evs/api-ref/evs_04_2041.html
+++ b/docs/evs/api-ref/evs_04_2041.html
@@ -25,28 +25,28 @@
Yes |
-Specifies the project ID. + | The project ID. |
resource_type |
Yes |
-Specifies the resource type. The value can be volumes, snapshots, or backups. + | The resource type. The value can be volumes, snapshots, or backups. |
|
resource_id |
Yes |
-Specifies the resource ID. + | The resource ID. |
|
key |
Yes |
-Specifies the key of the tag. + | The key of the tag. |
Yes |
-Specifies the key-value pair of the tag. + | The key-value pair of the tag. |
@@ -94,7 +94,7 @@
Yes |
-Specifies the type. The value can be application/json. + | The type. The value can be application/json. |
@@ -121,7 +121,7 @@
Object |
-Specifies the key-value pair of the tag. + | The key-value pair of the tag. |
diff --git a/docs/evs/api-ref/evs_04_2042.html b/docs/evs/api-ref/evs_04_2042.html
index 81bebf5fa..814a5c9ae 100644
--- a/docs/evs/api-ref/evs_04_2042.html
+++ b/docs/evs/api-ref/evs_04_2042.html
@@ -23,14 +23,14 @@
Yes |
-Specifies the project ID. + | The project ID. |
resource_type |
Yes |
-Specifies the resource type. The value can be volumes, snapshots, or backups. + | The resource type. The value can be volumes, snapshots, or backups. |
No |
Specifies to query EVS resources owing one of the tags in the filtering tag. -For example, if the filtering tag is tags_any={'a':['b', 'c'], 'd':['e']}, EVS resources owning tags (key is a and value is b or c) or tags (key is d and value is e) are queried. +For example, if the filtering tag is tags_any={'a':['b', 'c'], 'd':['e']}, EVS resources owning tags (key is a and value is b or c) or tags (key is d and value is e) are queried. |
not_tags @@ -74,7 +74,7 @@ | No |
Specifies to query EVS resources not owning the tags in the filtering tag. -For example, if the filtering tag is not_tags={'a':['b', 'c'], 'd':['e']}, EVS resources not owning tags (key is a and value is b or c) and tags (key is d and value is e) are queried. +For example, if the filtering tag is not_tags={'a':['b', 'c'], 'd':['e']}, EVS resources not owning tags (key is a and value is b or c) and tags (key is d and value is e) are queried. |
||
not_tags_any @@ -84,7 +84,7 @@ | No |
Specifies to query EVS resources not owning one of the tags in the filtering tag. -For example, if the filtering tag is not_tags={'a':['b', 'c'], 'd':['e']}, EVS resources not owning tags (key is a and value is b or c) or tags (key is d and value is e) are queried. +For example, if the filtering tag is not_tags={'a':['b', 'c'], 'd':['e']}, EVS resources not owning tags (key is a and value is b or c) or tags (key is d and value is e) are queried. |
Integer |
-Specifies the number of EVS resources. + | The disk quantity. |
resources |
list |
-Specifies the EVS resource lists. + | The disk list. |
No |
-Also the disk description. You can specify either parameter description or display_description. If both parameters are specified, the description value is used. The value can contain a maximum of 255 bytes. + | Also the disk description. You can specify either parameter description or display_description. If both parameters are specified, the description value is used. The value can contain a maximum of 255 bytes. |
diff --git a/docs/evs/api-ref/evs_04_2069.html b/docs/evs/api-ref/evs_04_2069.html
index e05cc68ea..2c6cd89ff 100644
--- a/docs/evs/api-ref/evs_04_2069.html
+++ b/docs/evs/api-ref/evs_04_2069.html
@@ -594,6 +594,8 @@
}
}
Yes |
-Specifies the project ID. + | The project ID. |
type_id |
Yes |
-Specifies the disk type ID. + | The disk type ID. |
Object |
-Specifies the details of queried disk types. For details, see Parameters in the volume_type field. + | The details of queried disk types. For details, see Parameters in the volume_type field. |
error |
Object |
-Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + | The error message returned if an error occurs. For details, see Parameters in the error field. |
Object |
-Specifies the disk type specifications. For details, see Parameters in the extra_specs field. + | The disk type specifications. For details, see Parameters in the extra_specs field. |
name |
String |
-Specifies the name of the disk type. + | The disk type name. |
|
id |
String |
-Specifies the ID of the disk type. + | The disk type ID. |
|
description |
String |
-Specifies the description of the disk type. + | The disk type description. |
|
qos_specs_id diff --git a/docs/evs/api-ref/evs_04_2075.html b/docs/evs/api-ref/evs_04_2075.html index 6fd5efc4f..2ba508a53 100644 --- a/docs/evs/api-ref/evs_04_2075.html +++ b/docs/evs/api-ref/evs_04_2075.html @@ -17,14 +17,14 @@ |
Yes |
-Specifies the project ID. + | The project ID. |
|
volume_id |
Yes |
-Specifies the disk ID. + | The disk ID. |
Object |
-Specifies the disk metadata, which is made up of key-value pairs. + | The disk metadata, which is made up of key-value pairs. |
error |
Object |
-Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + | The error message returned if an error occurs. For details, see Parameters in the error field. |
Yes |
-Specifies the project ID. + | The project ID. |
volume_id |
Yes |
-Specifies the disk ID. + | The disk ID. |
|
key |
Yes |
-Specifies the key of the piece of metadata to be queried. + | The key of the piece of metadata to be queried. |
Object |
-Specifies a piece of the disk metadata, which is made up of a key-value pair. + | The piece of the disk metadata, which is made up of a key-value pair. |
error |
Object |
-Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + | The error message returned if an error occurs. For details, see Parameters in the error field. |
Yes |
-Specifies the project ID. + | The project ID. |
volume_id |
Yes |
-Specifies the disk ID. + | The disk ID. |
|
key |
Yes |
-Specifies the key of the piece of metadata to be updated. + | The key of the piece of metadata to be updated. |
Yes |
-Specifies the disk metadata to be updated. For details, see Parameter in the meta field. + | The disk metadata to be updated. For details, see Parameter in the meta field. |
@@ -79,7 +79,7 @@
No |
-Specifies a piece of metadata, which is made up of a key-value pair. + | A piece of metadata, which is made up of a key-value pair. |
@@ -105,14 +105,14 @@
Object |
-Specifies a piece of the disk metadata, which is made up of a key-value pair. + | The piece of the disk metadata, which is made up of a key-value pair. |
error |
Object |
-Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + | The error message returned if an error occurs. For details, see Parameters in the error field. |
Yes |
-Specifies the project ID. + | The project ID. |
volume_id |
Yes |
-Specifies the disk ID. + | The disk ID. |
|
key |
Yes |
-Specifies the key of the piece of metadata to be deleted. + | The key of the piece of metadata to be deleted. |
Object |
-Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + | The error message returned if an error occurs. For details, see Parameters in the error field. |
diff --git a/docs/evs/api-ref/evs_04_2080.html b/docs/evs/api-ref/evs_04_2080.html
index a8426354a..e54e1141f 100644
--- a/docs/evs/api-ref/evs_04_2080.html
+++ b/docs/evs/api-ref/evs_04_2080.html
@@ -17,7 +17,7 @@
Yes |
-Specifies the project ID. + | The project ID. |
@@ -41,14 +41,14 @@
list |
-Specifies the extension APIs. For details, see Parameters in the extensions field. + | The extension APIs. For details, see Parameters in the extensions field. |
error |
Object |
-Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + | The error message returned if an error occurs. For details, see Parameters in the error field. |
String |
-Specifies the last update time. + | The last update time. Time format: UTC YYYY-MM-DDTHH:MM:SS.+XX.XX |
@@ -75,7 +75,7 @@
String |
-Specifies the description. + | The description. |
links @@ -89,14 +89,14 @@ |
String |
-Specifies the extension parameter alias. + | The extension parameter alias. |
|
name |
String |
-Specifies the extension parameter name. + | The extension parameter name. |
Yes |
-Specifies the project ID. + | The project ID. |
volume_id |
Yes |
-Specifies the disk ID. + | The disk ID. |
Yes |
-Specifies the disk bootable marker. For details, see Parameter in the os-set_bootable field. + | The disk bootable flag. For details, see Parameter in the os-set_bootable field. |
@@ -74,7 +74,7 @@
Yes |
-Specifies whether to set the bootable flag for the disk. + | Whether to set the bootable flag for the disk.
|
@@ -101,7 +101,7 @@
Object |
-Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + | The error message returned if an error occurs. For details, see Parameters in the error field. |
diff --git a/docs/evs/api-ref/evs_04_2085.html b/docs/evs/api-ref/evs_04_2085.html
index 8c3bc60ba..75172a6f1 100644
--- a/docs/evs/api-ref/evs_04_2085.html
+++ b/docs/evs/api-ref/evs_04_2085.html
@@ -17,14 +17,14 @@
Yes |
-Specifies the project ID. + | The project ID. |
volume_id |
Yes |
-Specifies the disk ID. + | The disk ID. |
Yes |
-Specifies the disk read-only flag. For details, see Parameter in the os-update_readonly_flag field. + | The disk read-only flag. For details, see Parameter in the os-update_readonly_flag field. |
@@ -72,7 +72,7 @@
Yes |
-Specifies the read-only flag.
|
@@ -99,7 +99,7 @@
The read-only flag.
|
Object |
-Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + | The error message returned if an error occurs. For details, see Parameters in the error field. |
diff --git a/docs/evs/api-ref/evs_04_2086.html b/docs/evs/api-ref/evs_04_2086.html
index a59db9d48..e469ef49a 100644
--- a/docs/evs/api-ref/evs_04_2086.html
+++ b/docs/evs/api-ref/evs_04_2086.html
@@ -3,7 +3,7 @@
Parameter |
Type diff --git a/docs/evs/api-ref/evs_04_2087.html b/docs/evs/api-ref/evs_04_2087.html index 97d2135b9..3a542cdbe 100644 --- a/docs/evs/api-ref/evs_04_2087.html +++ b/docs/evs/api-ref/evs_04_2087.html @@ -21,14 +21,14 @@ | Yes |
-Specifies the project ID. + | The project ID. |
||
|---|---|---|---|---|---|---|
volume_id |
Yes |
-Specifies the disk ID. + | The disk ID. |
Yes |
-Specifies the disk attachment marker. For details, see Parameters in the os-attach field. + | The disk attachment marker. For details, see Parameters in the os-attach field. |
@@ -76,7 +76,7 @@
Yes |
-Specifies the UUID of the host to be attached to. + | The UUID of the host to be attached to. |
mountpoint @@ -85,7 +85,7 @@ |
Yes |
-Specifies the device name. + | The device name. |
|||
host_name @@ -94,7 +94,7 @@ |
No |
-Specifies the name of the host to be attached to. The value can contain a maximum of 255 bytes. + | The name of the host to be attached to. The value can contain a maximum of 255 bytes. |
|||
mode @@ -103,7 +103,7 @@ |
No |
-Specifies the attachment mode. The value can be rw (read/write) or ro (read-only). + | The attachment mode. The value can be rw (read/write) or ro (read-only). |
Object |
-Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + | The error message returned if an error occurs. For details, see Parameters in the error field. |
diff --git a/docs/evs/api-ref/evs_04_2088.html b/docs/evs/api-ref/evs_04_2088.html
index 3632cc89d..43f2b1368 100644
--- a/docs/evs/api-ref/evs_04_2088.html
+++ b/docs/evs/api-ref/evs_04_2088.html
@@ -21,14 +21,14 @@
Yes |
-Specifies the project ID. + | The project ID. |
volume_id |
Yes |
-Specifies the disk ID. + | The disk ID. |
Yes |
-Specifies disk detachment marker. + | The disk detachment marker. |
@@ -76,7 +76,7 @@
No |
-Specifies the attachment ID. If the disk has only one attachment, this parameter is optional. If it has multiple attachments, the parameter is optional. + | The attachment ID. If the disk has only one attachment, this parameter is optional. If it has multiple attachments, the parameter is mandatory. |
@@ -103,7 +103,7 @@
Object |
-Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + | The error message returned if an error occurs. For details, see Parameters in the error field. |
diff --git a/docs/evs/api-ref/evs_04_2089.html b/docs/evs/api-ref/evs_04_2089.html
index 90403304b..848248895 100644
--- a/docs/evs/api-ref/evs_04_2089.html
+++ b/docs/evs/api-ref/evs_04_2089.html
@@ -19,14 +19,14 @@
Yes |
-Specifies the project ID. + | The project ID. |
volume_id |
Yes |
-Specifies the disk ID. + | The disk ID. |
Yes |
-Specifies disk reservation marker. Defining a value for this parameter is not mandatory, and you are advised to leave it blank. + | The disk reservation marker. Defining a value for this parameter is not mandatory, and you are advised to leave it blank. |
@@ -76,7 +76,7 @@
Object |
-Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + | The error message returned if an error occurs. For details, see Parameters in the error field. |
diff --git a/docs/evs/api-ref/evs_04_2090.html b/docs/evs/api-ref/evs_04_2090.html
index b52eda8d5..4acd4ccfe 100644
--- a/docs/evs/api-ref/evs_04_2090.html
+++ b/docs/evs/api-ref/evs_04_2090.html
@@ -19,14 +19,14 @@
Yes |
-Specifies the project ID. + | The project ID. |
volume_id |
Yes |
-Specifies the disk ID. + | The disk ID. |
Yes |
-Specifies disk reservation canceling marker. Defining a value for this parameter is not mandatory, and you are advised to leave it blank. + | The disk reservation canceling marker. Defining a value for this parameter is not mandatory, and you are advised to leave it blank. |
@@ -76,7 +76,7 @@
Object |
-Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + | The error message returned if an error occurs. For details, see Parameters in the error field. |
diff --git a/docs/evs/api-ref/evs_04_2093.html b/docs/evs/api-ref/evs_04_2093.html
index 33db102b5..306cb6982 100644
--- a/docs/evs/api-ref/evs_04_2093.html
+++ b/docs/evs/api-ref/evs_04_2093.html
@@ -17,7 +17,7 @@
Yes |
-Specifies the project ID. + | The project ID. |
@@ -42,7 +42,7 @@
Yes |
-Specifies the information of the snapshot to be created. For details, see Parameters in the snapshot field. + | The information of the snapshot to be created. For details, see Parameters in the snapshot field. |
@@ -66,7 +66,7 @@
Yes |
-Specifies the ID of the snapshot's source disk. + | The ID of the snapshot's source disk. |
force @@ -75,8 +75,8 @@ |
No |
-Specifies the flag for forcibly creating a snapshot. The default value is false. -
| The flag for forcibly creating a snapshot. The default value is false. +
|
|||
metadata @@ -85,7 +85,7 @@ |
No |
-Specifies the snapshot metadata. + | The snapshot metadata. |
|||
description @@ -94,7 +94,7 @@ |
No |
-Specifies the snapshot description. The value can be null. The value can contain a maximum of 255 bytes. + | The snapshot description. The value can be null. The value can contain a maximum of 255 bytes. |
|||
name @@ -103,7 +103,7 @@ |
No |
-Specifies the snapshot name. The value can contain a maximum of 255 bytes. + | The snapshot name. The value can contain a maximum of 255 bytes. NOTE:
When creating a backup for a disk, a snapshot will be created and named with prefix autobk_snapshot_. The EVS console has imposed operation restrictions on snapshots with prefix autobk_snapshot_. Therefore, you are advised not to use autobk_snapshot_ as the name prefix for the snapshots you created. Otherwise, the snapshots cannot be used normally. |
@@ -136,14 +136,14 @@
Object |
-Specifies the snapshot information. For details, see Parameters in the snapshot field. + | The snapshot information. For details, see Parameters in the snapshot field. |
error |
Object |
-Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + | The error message returned if an error occurs. For details, see Parameters in the error field. |
String |
-Specifies the snapshot ID. + | The snapshot ID. |
status |
String |
-Specifies the snapshot status. For details, see EVS Snapshot Status. + | The snapshot status. For details, see EVS Snapshot Status. |
|||
name |
String |
-Specifies the snapshot name. + | The snapshot name. |
|||
description |
String |
-Specifies the snapshot description. + | The snapshot description. |
|||
created_at |
String |
-Specifies the time when the snapshot was created. + | The time when the snapshot was created. Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX |
Object |
-Specifies the snapshot metadata. + | The snapshot metadata. |
volume_id |
String |
-Specifies the ID of the snapshot's source disk. + | The ID of the snapshot's source disk. |
|||
size |
Integer |
-Specifies the snapshot size, in GB. + | The snapshot size, in GB. |
|||
updated_at |
String |
-Specifies the time when the snapshot was updated. + | The time when the snapshot was updated. Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX |
Yes |
-Specifies the project ID. + | The project ID. |
snapshot_id |
Yes |
-Specifies the snapshot ID. + | The snapshot ID. |
Object |
-Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + | The error message returned if an error occurs. For details, see Parameters in the error field. |
diff --git a/docs/evs/api-ref/evs_04_2098.html b/docs/evs/api-ref/evs_04_2098.html
index 3b244e1d3..f53e6941a 100644
--- a/docs/evs/api-ref/evs_04_2098.html
+++ b/docs/evs/api-ref/evs_04_2098.html
@@ -17,14 +17,14 @@
Yes |
-Specifies the project ID. + | The project ID. |
snapshot_id |
Yes |
-Specifies the snapshot ID. + | The snapshot ID. |
Object |
-Specifies the snapshot information. For details, see Parameters in the snapshot field. + | The snapshot information. For details, see Parameters in the snapshot field. |
error |
Object |
-Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + | The error message returned if an error occurs. For details, see Parameters in the error field. |
String |
-Specifies the snapshot ID. + | The snapshot ID. |
status |
String |
-Specifies the snapshot status. For details, see EVS Snapshot Status. + | The snapshot status. For details, see EVS Snapshot Status. |
|||
name |
String |
-Specifies the snapshot name. + | The snapshot name. Snapshots whose names started with prefix autobk_snapshot_ are automatically created by the system during backup creations. Do not delete these snapshots or use them to roll back the disk data. |
String |
-Specifies the snapshot description. + | The snapshot description. |
created_at |
String |
-Specifies the time when the snapshot was created. + | The time when the snapshot was created. Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX |
String |
-Specifies the time when the snapshot was updated. + | The time when the snapshot was updated. Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX |
@@ -120,7 +120,7 @@
Object |
-Specifies the snapshot metadata. + | The snapshot metadata. If metadata contains the __system__enableActive field, the snapshot is automatically created during the backup of a server. |
@@ -128,21 +128,21 @@
String |
-Specifies the ID of the snapshot's source disk. + | The ID of the snapshot's source disk. |
size |
Integer |
-Specifies the snapshot size, in GB. + | The snapshot size, in GB. |
|||
os-extended-snapshot-attributes:project_id |
String |
-Specifies the tenant ID. The tenant ID is the same as the project ID. + | The tenant ID. The tenant ID is the same as the project ID. |
|||
os-extended-snapshot-attributes:progress @@ -156,7 +156,7 @@ |
String |
-Reserved field + | The reserved field. |
Parameter |
Type diff --git a/docs/evs/api-ref/evs_04_2108.html b/docs/evs/api-ref/evs_04_2108.html index ebccaadae..19e6d7e7d 100644 --- a/docs/evs/api-ref/evs_04_2108.html +++ b/docs/evs/api-ref/evs_04_2108.html @@ -17,14 +17,14 @@ | Yes |
-Specifies the project ID. + | The project ID. |
|---|---|---|---|---|
transfer_id |
Yes |
-Specifies the disk transfer ID. + | The transfer ID. |
Parameter |
Type diff --git a/docs/evs/api-ref/evs_04_3006.html b/docs/evs/api-ref/evs_04_3006.html index fc7b5b0ec..29d8c714b 100644 --- a/docs/evs/api-ref/evs_04_3006.html +++ b/docs/evs/api-ref/evs_04_3006.html @@ -17,14 +17,14 @@ | Yes |
-Specifies the project ID. + | The project ID. |
|---|---|---|---|---|
volume_id |
Yes |
-Specifies the disk ID. + | The disk ID. |
Object |
-Specifies the loading information, in percentage. For details, see Parameter in the info field. + | The loading information, in percentage. For details, see Parameter in the info field. |
error |
Object |
-Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + | The error message returned if an error occurs. For details, see Parameters in the error field. |
Integer |
-Specifies the loading progress of the lazyloading disk. + | The loading progress of the lazyloading disk. |
diff --git a/docs/evs/api-ref/evs_04_3011.html b/docs/evs/api-ref/evs_04_3011.html
index 906bcff6b..c961e3635 100644
--- a/docs/evs/api-ref/evs_04_3011.html
+++ b/docs/evs/api-ref/evs_04_3011.html
@@ -20,14 +20,14 @@
Yes |
-Specifies the project ID. + | The project ID. |
volume_id |
Yes |
-Specifies the disk ID. + | The disk ID. |
Yes |
-Specifies the tag list. For details, see Parameters in the resource_tag field. + | The tag list. For details, see Parameters in the resource_tag field. |
action @@ -61,14 +61,14 @@ |
Yes |
-Specifies the operation to perform. The value can be create or delete. + | The operation to perform. The value can be create or delete. create: specifies to add tags. |
Parameter |
Type @@ -85,7 +85,7 @@ | Yes |
-Specifies the tag key.
The tag key.
| Yes |
-Specifies the tag value.
|
diff --git a/docs/evs/api-ref/evs_04_3013.html b/docs/evs/api-ref/evs_04_3013.html
index 9cdc2f9e1..6374801ec 100644
--- a/docs/evs/api-ref/evs_04_3013.html
+++ b/docs/evs/api-ref/evs_04_3013.html
@@ -19,14 +19,14 @@
The tag value.
|
Yes |
-Specifies the project ID. + | The project ID. |
|---|---|---|---|---|
volume_id |
Yes |
-Specifies the disk ID. + | The disk ID. |
Yes |
-Specifies the project ID. + | The project ID. |
volume_id |
Yes |
-Specifies the disk ID. + | The disk ID. |
List<resource_tag> |
-Specifies the tag list. For details, see Parameters in the tags field. + | The tag list. For details, see Parameters in the resource_tag field. |
Parameter |
Type @@ -68,14 +68,14 @@ | String |
-Specifies the tag key. + | The tag key. |
|---|---|---|---|---|
value |
String |
-Specifies the tag value. + | The tag value. |
Yes |
-Specifies the project ID. + | The project ID. |
@@ -44,7 +44,7 @@
No |
-Specifies the key-value pairs of the tag. For details, see Parameters in the tags field. + | The key-value pairs of tags. For details, see Parameters in the resource_tag field. The tags field cannot be left empty. One tag list can contain a maximum of 10 keys. Tag keys in a tag list must be unique. @@ -59,7 +59,7 @@ |
Yes |
-Specifies the operation identifier. + | The operation identifier. Specifying count queries the number of disks by tag. |
@@ -69,7 +69,7 @@
No |
-Specifies the query criteria that the resource supports. For details, see Parameters in the match field. + | The query criteria that the resource supports. For details, see Parameters in the match field. The matches field cannot be left empty. Tag keys in the list must be unique. |
@@ -94,7 +94,7 @@
Yes |
-Specifies the tag key.
|
@@ -104,7 +104,7 @@
The tag key.
|
Yes |
-Specifies the tag value.
The tag value.
One value list can contain a maximum of 10 values. Tag values in a value list must be unique. @@ -132,7 +132,7 @@ |
-Yes Specifies the tag key. The value is of the enumerated type. + |
@@ -143,7 +143,7 @@
The tag key. The value is of the enumerated type. The value can be as follows:
|
Yes |
-Specifies the tag value. + | The tag value.
|
@@ -188,14 +188,14 @@
Integer |
-Specifies the total number of disks that meet the query criteria. + | The total number of disks that meet the query criteria. |
error |
Object |
-Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + | The error message returned when an error occurs. For details, see Parameters in the error field. |
Yes |
-Specifies the project ID. + | The project ID. |
@@ -224,7 +224,7 @@
Parameter |
Type diff --git a/docs/evs/api-ref/evs_04_3030.html b/docs/evs/api-ref/evs_04_3030.html index ba09c57e4..7ea248b66 100644 --- a/docs/evs/api-ref/evs_04_3030.html +++ b/docs/evs/api-ref/evs_04_3030.html @@ -1,7 +1,7 @@Deleting an EVS Disk- | ||
|---|---|---|---|
volume_id |
Yes |
-Specifies the disk ID. + | The disk ID. |
No |
-Specifies to delete all snapshots associated with the disk. The default value is false. + | Whether to delete all the snapshots created for this disk. The default value is false. |
diff --git a/docs/evs/api-ref/evs_04_3031.html b/docs/evs/api-ref/evs_04_3031.html
index 0858c6fdf..75b19d953 100644
--- a/docs/evs/api-ref/evs_04_3031.html
+++ b/docs/evs/api-ref/evs_04_3031.html
@@ -17,14 +17,14 @@
Yes |
-Specifies the project ID. + | The project ID. |
volume_id |
Yes |
-Specifies the disk ID. + | The disk ID. |
No |
-Also the disk description. You can specify either parameter description or display_description. If both parameters are specified, the description value is used. The value can contain a maximum of 255 bytes. + | Also the disk description. You can specify either parameter description or display_description. If both parameters are specified, the description value is used. The value can contain a maximum of 255 bytes. |
diff --git a/docs/evs/api-ref/evs_04_3033.html b/docs/evs/api-ref/evs_04_3033.html
index cbb420f22..1375a5ace 100644
--- a/docs/evs/api-ref/evs_04_3033.html
+++ b/docs/evs/api-ref/evs_04_3033.html
@@ -596,6 +596,7 @@
}
}
+
Yes |
-Specifies the project ID. + | The project ID. |
diff --git a/docs/evs/api-ref/evs_04_3036.html b/docs/evs/api-ref/evs_04_3036.html
index 6e2decb5c..7a56b7e2d 100644
--- a/docs/evs/api-ref/evs_04_3036.html
+++ b/docs/evs/api-ref/evs_04_3036.html
@@ -17,14 +17,14 @@
Yes |
-Specifies the project ID. + | The project ID. |
type_id |
Yes |
-Specifies the disk type ID. + | The disk type ID. |
Object |
-Specifies the details of queried disk types. For details, see Parameters in the volume_type field. + | The details of queried disk types. For details, see Parameters in the volume_type field. |
error |
Object |
-Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + | The error message returned if an error occurs. For details, see Parameters in the error field. |
Object |
-Specifies the disk type specifications. For details, see Parameters in the extra_specs field. + | The disk type specifications. For details, see Parameters in the extra_specs field. |
name |
String |
-Specifies the name of the disk type. + | The disk type name. |
id |
String |
-Specifies the ID of the disk type. + | The disk type ID. |
description |
String |
-Specifies the description of the disk type. + | The disk type description. |
qos_specs_id diff --git a/docs/evs/api-ref/evs_04_3038.html b/docs/evs/api-ref/evs_04_3038.html index 6cf0b209d..96422b0a8 100644 --- a/docs/evs/api-ref/evs_04_3038.html +++ b/docs/evs/api-ref/evs_04_3038.html @@ -17,14 +17,14 @@ |
Yes |
-Specifies the project ID. + | The project ID. |
volume_id |
Yes |
-Specifies the disk ID. + | The disk ID. |
Yes |
-Specifies the project ID. + | The project ID. |
volume_id |
Yes |
-Specifies the disk ID. + | The disk ID. |
Object |
-Specifies the disk metadata, which is made up of key-value pairs. + | The disk metadata, which is made up of key-value pairs. |
error |
Object |
-Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + | The error message returned if an error occurs. For details, see Parameters in the error field. |
Yes |
-Specifies the project ID. + | The project ID. |
volume_id |
Yes |
-Specifies the disk ID. + | The disk ID. |
Yes |
-Specifies the project ID. + | The project ID. |
volume_id |
Yes |
-Specifies the disk ID. + | The disk ID. |
key |
Yes |
-Specifies the key of the piece of metadata to be queried. + | The key of the piece of metadata to be queried. |
Object |
-Specifies a piece of the disk metadata, which is made up of a key-value pair. + | The piece of the disk metadata, which is made up of a key-value pair. |
error |
Object |
-Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + | The error message returned if an error occurs. For details, see Parameters in the error field. |
Yes |
-Specifies the project ID. + | The project ID. |
volume_id |
Yes |
-Specifies the disk ID. + | The disk ID. |
key |
Yes |
-Specifies the key of the piece of metadata to be updated. + | The key of the piece of metadata to be updated. |
Yes |
-Specifies the disk metadata to be updated. For details, see Parameter in the meta field. + | The disk metadata to be updated. For details, see Parameter in the meta field. |
@@ -79,7 +79,7 @@
No |
-Specifies a piece of metadata, which is made up of a key-value pair. + | A piece of metadata, which is made up of a key-value pair. |
@@ -105,14 +105,14 @@
Object |
-Specifies a piece of the disk metadata, which is made up of a key-value pair. + | The piece of the disk metadata, which is made up of a key-value pair. |
error |
Object |
-Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + | The error message returned if an error occurs. For details, see Parameters in the error field. |
Yes |
-Specifies the project ID. + | The project ID. |
volume_id |
Yes |
-Specifies the disk ID. + | The disk ID. |
key |
Yes |
-Specifies the key of the piece of metadata to be deleted. + | The key of the piece of metadata to be deleted. |
Object |
-Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + | The error message returned if an error occurs. For details, see Parameters in the error field. |
diff --git a/docs/evs/api-ref/evs_04_3044.html b/docs/evs/api-ref/evs_04_3044.html
index 53fad49bc..b79414971 100644
--- a/docs/evs/api-ref/evs_04_3044.html
+++ b/docs/evs/api-ref/evs_04_3044.html
@@ -17,7 +17,7 @@
Yes |
-Specifies the project ID. + | The project ID. |
@@ -41,14 +41,14 @@
list |
-Specifies the extension APIs. For details, see Parameters in the extensions field. + | The extension APIs. For details, see Parameters in the extensions field. |
error |
Object |
-Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + | The error message returned if an error occurs. For details, see Parameters in the error field. |
String |
-Specifies the last update time. + | The last update time. Time format: UTC YYYY-MM-DDTHH:MM:SS.+XX.XX |
@@ -75,7 +75,7 @@
String |
-Specifies the description. + | The description. |
links @@ -89,14 +89,14 @@ |
String |
-Specifies the extension parameter alias. + | The extension parameter alias. |
name |
String |
-Specifies the extension parameter name. + | The extension parameter name. |
Yes |
-Specifies the project ID. + | The project ID. |
diff --git a/docs/evs/api-ref/evs_04_3046.html b/docs/evs/api-ref/evs_04_3046.html
index 8a58be3a6..49c04caf7 100644
--- a/docs/evs/api-ref/evs_04_3046.html
+++ b/docs/evs/api-ref/evs_04_3046.html
@@ -19,7 +19,7 @@
Yes |
-Specifies the project ID. + | The project ID. |
@@ -43,7 +43,7 @@
Object |
-Specifies the summary information of queried disks. For details, see Parameters in the volume-summary field. + | The summary information of queried disks. For details, see Parameters in the volume-summary field. |
@@ -63,21 +63,21 @@
Integer |
-Specifies the total size of disks, in GB. + | The total size of disks, in GB. |
total_count |
Integer |
-Specifies the total quantity of disks. + | The total quantity of disks. |
metadata |
Object |
-Specifies the disk metadata information. This parameter is supported when the request version is 3.36 or later. + | The disk metadata information. This parameter is supported when the request version is 3.36 or later. |
Yes |
-Specifies the project ID. + | The project ID. |
volume_id |
Yes |
-Specifies the ID of a disk. + | The ID of a disk. |
Yes |
-Specifies the project ID. + | The project ID. |
volume_id |
Yes |
-Specifies the disk ID. + | The disk ID. |
Yes |
-Specifies the disk bootable marker. For details, see Parameter in the os-set_bootable field. + | The disk bootable flag. For details, see Parameter in the os-set_bootable field. |
@@ -74,7 +74,7 @@
Yes |
-Specifies whether to set the bootable flag for the disk. + | Whether to set the bootable flag for the disk.
|
@@ -101,7 +101,7 @@
Object |
-Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + | The error message returned if an error occurs. For details, see Parameters in the error field. |
diff --git a/docs/evs/api-ref/evs_04_3050.html b/docs/evs/api-ref/evs_04_3050.html
index cc0389ced..ad2459e8a 100644
--- a/docs/evs/api-ref/evs_04_3050.html
+++ b/docs/evs/api-ref/evs_04_3050.html
@@ -17,14 +17,14 @@
Yes |
-Specifies the project ID. + | The project ID. |
volume_id |
Yes |
-Specifies the disk ID. + | The disk ID. |
Yes |
-Specifies the disk read-only flag. For details, see Parameter in the os-update_readonly_flag field. + | The disk read-only flag. For details, see Parameter in the os-update_readonly_flag field. |
@@ -72,7 +72,7 @@
Yes |
-Specifies the read-only flag.
|
@@ -99,7 +99,7 @@
The read-only flag.
|
Object |
-Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + | The error message returned if an error occurs. For details, see Parameters in the error field. |
diff --git a/docs/evs/api-ref/evs_04_3051.html b/docs/evs/api-ref/evs_04_3051.html
index a15dd8165..cefc82ca2 100644
--- a/docs/evs/api-ref/evs_04_3051.html
+++ b/docs/evs/api-ref/evs_04_3051.html
@@ -17,14 +17,14 @@
Yes |
-Specifies the project ID. + | The project ID. |
volume_id |
Yes |
-Specifies the disk ID. + | The disk ID. |
Parameter |
Type diff --git a/docs/evs/api-ref/evs_04_3052.html b/docs/evs/api-ref/evs_04_3052.html index 7baf0c87d..d572de33a 100644 --- a/docs/evs/api-ref/evs_04_3052.html +++ b/docs/evs/api-ref/evs_04_3052.html @@ -19,14 +19,14 @@ | Yes |
-Specifies the project ID. + | The project ID. |
|---|---|---|---|---|
volume_id |
Yes |
-Specifies the disk ID. + | The disk ID. |
Yes |
-Specifies disk reservation marker. Defining a value for this parameter is not mandatory, and you are advised to leave it blank. + | The disk reservation marker. Defining a value for this parameter is not mandatory, and you are advised to leave it blank. |
@@ -76,7 +76,7 @@
Object |
-Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + | The error message returned if an error occurs. For details, see Parameters in the error field. |
diff --git a/docs/evs/api-ref/evs_04_3053.html b/docs/evs/api-ref/evs_04_3053.html
index f409f2d88..428580151 100644
--- a/docs/evs/api-ref/evs_04_3053.html
+++ b/docs/evs/api-ref/evs_04_3053.html
@@ -19,14 +19,14 @@
Yes |
-Specifies the project ID. + | The project ID. |
volume_id |
Yes |
-Specifies the disk ID. + | The disk ID. |
Yes |
-Specifies disk reservation canceling marker. Defining a value for this parameter is not mandatory, and you are advised to leave it blank. + | The disk reservation canceling marker. Defining a value for this parameter is not mandatory, and you are advised to leave it blank. |
@@ -76,7 +76,7 @@
Object |
-Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + | The error message returned if an error occurs. For details, see Parameters in the error field. |
diff --git a/docs/evs/api-ref/evs_04_3058.html b/docs/evs/api-ref/evs_04_3058.html
index 6420e67f0..6368c07cd 100644
--- a/docs/evs/api-ref/evs_04_3058.html
+++ b/docs/evs/api-ref/evs_04_3058.html
@@ -17,14 +17,14 @@
Yes |
-Specifies the project ID. + | The project ID. |
snapshot_id |
Yes |
-Specifies the snapshot ID. + | The snapshot ID. |
Yes |
-Specifies the project ID. + | The project ID. |
@@ -49,7 +49,7 @@
No |
-Specifies the offset. + | The query offset. NOTE:
This parameter is used when snapshots are queried by page and is used together with the limit parameter. For example, there are a total of 30 snapshots. If you set offset to 11 and limit to 10, the queried snapshot starts from the twelfth snapshot, and at most 10 snapshots can be queried at a time. |
@@ -60,7 +60,7 @@
No |
-Specifies the maximum number of query results that can be returned. + | The maximum number of query results that can be returned. The value ranges from 1 to 1000, and the default value is 1000. The returned value cannot exceed this limit. If the tenant has more than 50 snapshots in total, you are advised to use this parameter and set its value to 50 to improve the query efficiency. Examples are provided as follows: GET /v3/xxx/snapshots?limit=50: Queries the 1–50 snapshots. GET /v3/xxx/snapshots?offset=50&limit=50: Queries the 51–100 snapshots. @@ -72,7 +72,7 @@ |
No |
-Specifies the snapshot name. This parameter does not support fuzzy search. The value can contain a maximum of 255 bytes. + | The snapshot name. This parameter does not support fuzzy search. The value can contain a maximum of 255 bytes. |
sort_dir @@ -81,7 +81,7 @@ |
No |
-Specifies the result sorting order. The default value is desc.
The result sorting order. The default value is desc.
| No |
-Specifies the snapshot status. For details, see EVS Snapshot Status. + | The snapshot status. For details, see EVS Snapshot Status. |
volume_id @@ -100,7 +100,7 @@ |
No |
-Specifies the ID of the snapshot's source disk. + | The ID of the snapshot's source disk. |
|
name~ @@ -109,7 +109,7 @@ |
No |
-Specifies the fuzzy search by disk name. This parameter is supported when the request version is 3.31 or later. + | The fuzzy search by disk name. This parameter is supported when the request version is 3.31 or later. |
|
status~ @@ -118,7 +118,7 @@ |
No |
-Specifies the fuzzy search by disk status. This parameter is supported when the request version is 3.31 or later. + | The fuzzy search by disk status. This parameter is supported when the request version is 3.31 or later. |
|
volume_id~ @@ -127,7 +127,7 @@ |
No |
-Specifies the fuzzy search by the ID of the disk that corresponds to the snapshot. This parameter is supported when the request version is 3.31 or later. + | The fuzzy search by the ID of the disk that corresponds to the snapshot. This parameter is supported when the request version is 3.31 or later. |
|
sort_key @@ -136,7 +136,7 @@ |
No |
-Specifies the sorting query by name (sort_key=name). This parameter is supported when the request version is 3.30 or later. The default sorting order is the descending order. + | The sorting query by name (sort_key=name). This parameter is supported when the request version is 3.30 or later. The default sorting order is the descending order. |
|
with_count @@ -145,7 +145,7 @@ |
No |
-Specifies to return parameter counts in the response. This parameter indicates the number of snapshots queried. This parameter is in the with_count=true format and is supported when the request version is 3.45 or later. + | Whether to return the counts parameter in the response. It shows the number of snapshots queried. This parameter is in the with_count=true format and is supported when the request version is 3.45 or later. This parameter can be used together with parameters marker, limit, sort_key, sort_dir, or offset in the table. It cannot be used with other filter parameters. |
Object |
-Specifies the snapshot information. For details, see Parameters in the snapshots field. + | The snapshot information. For details, see Parameters in the snapshots field. |
snapshots_links |
list<map<String,String>> |
-Specifies the query position marker in the snapshot list. This parameter is at the same level as parameter snapshots in the response body. This parameter is returned only when parameter limit is specified in the request, and this parameter indicates that only some snapshots are returned in this query. + | The query position marker in the snapshot list. This parameter is at the same level as parameter snapshots in the response body. It is returned only when parameter limit is specified in the request, and it indicates that only some snapshots are returned in this query. |
|
count |
Object |
-Specifies the number of records returned in this query. + | The number of records returned in this query. |
|
error |
Object |
-Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + | The error message returned if an error occurs. For details, see Parameters in the error field. |
String |
-Specifies the snapshot ID. + | The snapshot ID. |
status |
String |
-Specifies the snapshot status. For details, see EVS Snapshot Status. + | The snapshot status. For details, see EVS Snapshot Status. |
|
name |
String |
-Specifies the snapshot name. + | The snapshot name. |
|
description |
String |
-Specifies the snapshot description. + | The snapshot description. |
|
created_at |
String |
-Specifies the time when the snapshot was created. + | The time when the snapshot was created. Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX |
Object |
-Specifies the snapshot metadata. + | The snapshot metadata. If metadata contains the __system__enableActive field, the snapshot is automatically created during the backup of a server. |
@@ -255,21 +255,21 @@
String |
-Specifies the ID of the snapshot's source disk. + | The ID of the snapshot's source disk. |
size |
Integer |
-Specifies the snapshot size, in GB. + | The snapshot size, in GB. |
|
updated_at |
String |
-Specifies the time when the snapshot was updated. + | The time when the snapshot was updated. Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX |
Yes |
-Specifies the project ID. + | The project ID. |
@@ -49,7 +49,7 @@
No |
-Specifies the offset. + | The query offset. NOTE:
This parameter is used when snapshots are queried by page and is used together with the limit parameter. For example, there are a total of 30 snapshots. If you set offset to 11 and limit to 10, the queried snapshot starts from the twelfth snapshot, and at most 10 snapshots can be queried at a time. |
@@ -60,7 +60,7 @@
No |
-Specifies the maximum number of query results that can be returned. + | The maximum number of query results that can be returned. The value ranges from 1 to 1000, and the default value is 1000. The returned value cannot exceed this limit. If the tenant has more than 50 snapshots in total, you are advised to use this parameter and set its value to 50 to improve the query efficiency. Examples are provided as follows: GET /v3/xxx/snapshots/detail?limit=50: Queries the 1–50 snapshots. GET /v3/xxx/snapshots/detail?offset=50&limit=50: Queries the 51–100 snapshots. @@ -72,7 +72,7 @@ |
No |
-Specifies the snapshot name. The value can contain a maximum of 255 bytes. + | The snapshot name. The value can contain a maximum of 255 bytes. |
sort_dir @@ -81,7 +81,7 @@ |
No |
-Specifies the result sorting order. The default value is desc.
The result sorting order. The default value is desc.
| No |
-Specifies the snapshot status. For details, see EVS Snapshot Status. + | The snapshot status. For details, see EVS Snapshot Status. |
volume_id @@ -100,7 +100,7 @@ |
No |
-Specifies the ID of the snapshot's source disk. + | The ID of the snapshot's source disk. |
Object |
-Specifies the snapshot information. For details, see Parameters in the snapshots field. + | The snapshot information. For details, see Parameters in the snapshots field. |
snapshots_links |
list<map<String,String>> |
-Specifies the query position marker in the snapshot list. This parameter is at the same level as parameter snapshots in the response body. This parameter is returned only when parameter limit is specified in the request, and this parameter indicates that only some snapshots are returned in this query. + | The query position marker in the snapshot list. This parameter is at the same level as parameter snapshots in the response body. It is returned only when parameter limit is specified in the request, and it indicates that only some snapshots are returned in this query. |
|
count |
Object |
-Specifies the number of records returned in this query. + | The number of records returned in this query. |
|
error |
Object |
-Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + | The error message returned if an error occurs. For details, see Parameters in the error field. |
String |
-Specifies the snapshot ID. + | The snapshot ID. |
status |
String |
-Specifies the snapshot status. For details, see EVS Snapshot Status. + | The snapshot status. For details, see EVS Snapshot Status. |
|
name |
String |
-Specifies the snapshot name. + | The snapshot name. |
|
description |
String |
-Specifies the snapshot description. + | The snapshot description. |
|
created_at |
String |
-Specifies the time when the snapshot was created. + | The time when the snapshot was created. Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX |
String |
-Specifies the time when the snapshot was updated. + | The time when the snapshot was updated. Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX |
@@ -210,7 +210,7 @@
Object |
-Specifies the snapshot metadata. + | The snapshot metadata. If metadata contains the __system__enableActive field, the snapshot is automatically created during the backup of a server. |
@@ -218,21 +218,21 @@
String |
-Specifies the ID of the snapshot's source disk. + | The ID of the snapshot's source disk. |
size |
Integer |
-Specifies the snapshot size, in GB. + | The snapshot size, in GB. |
|
os-extended-snapshot-attributes:project_id |
String |
-Specifies the tenant ID. The tenant ID is the same as the project ID. + | The tenant ID. The tenant ID is the same as the project ID. |
|
os-extended-snapshot-attributes:progress @@ -246,7 +246,7 @@ |
String |
-Reserved field + | The reserved field. |
Yes |
-Specifies the project ID. + | The project ID. |
snapshot_id |
Yes |
-Specifies the snapshot ID. + | The snapshot ID. |
Yes |
-Specifies the metadata to be added. For details, see Parameter in the metadata field. + | The metadata to be added. For details, see Parameter in the metadata field. |
@@ -72,7 +72,7 @@
No |
-Specifies the metadata information, which is made up of one or multiple key-value pairs. + | The metadata information, which is made up of one or multiple key-value pairs. |
@@ -100,14 +100,14 @@
Object |
-Specifies the snapshot metadata, which is made up of key-value pairs. + | The snapshot metadata, which is made up of key-value pairs. |
error |
Object |
-Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + | The error message returned if an error occurs. For details, see Parameters in the error field. |
Yes |
-Specifies the project ID. + | The project ID. |
snapshot_id |
Yes |
-Specifies the snapshot ID. + | The snapshot ID. |
Object |
-Specifies the snapshot metadata, which is made up of key-value pairs. + | The snapshot metadata, which is made up of key-value pairs. If metadata contains the __system__enableActive field, the snapshot is automatically created during the backup of a server. |
@@ -56,7 +56,7 @@
Object |
-Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + | The error message returned if an error occurs. For details, see Parameters in the error field. |
diff --git a/docs/evs/api-ref/evs_04_3064.html b/docs/evs/api-ref/evs_04_3064.html
index fd423210c..e8ecb52a9 100644
--- a/docs/evs/api-ref/evs_04_3064.html
+++ b/docs/evs/api-ref/evs_04_3064.html
@@ -17,21 +17,21 @@
Yes |
-Specifies the project ID. + | The project ID. |
snapshot_id |
Yes |
-Specifies the snapshot ID. + | The snapshot ID. |
|
key |
Yes |
-Specifies the key of the piece of metadata to be updated. + | The key of the piece of metadata to be updated. |
No |
-A piece of metadata, which is made up of a key-value pair. + | The piece of metadata, which is made up of a key-value pair. |
@@ -105,7 +105,7 @@
Object |
-A piece of snapshot metadata, which is made up of a key-value pair. + | The piece of snapshot metadata, which is made up of a key-value pair. |
error diff --git a/docs/evs/api-ref/evs_04_3065.html b/docs/evs/api-ref/evs_04_3065.html index 5fefb0e77..69a41d176 100644 --- a/docs/evs/api-ref/evs_04_3065.html +++ b/docs/evs/api-ref/evs_04_3065.html @@ -17,14 +17,14 @@ |
Yes |
-Specifies the project ID. + | The project ID. |
|
snapshot_id |
Yes |
-Specifies the snapshot ID. + | The snapshot ID. |
Yes |
-Specifies the project ID. + | The project ID. |
snapshot_id |
Yes |
-Specifies the snapshot ID. + | The snapshot ID. |
|
key |
Yes |
-Specifies the key of the piece of metadata to be queried. + | The key of the metadata to be queried. |
Object |
-Specifies a piece of snapshot metadata, which is made up of a key-value pair. + | The piece of snapshot metadata, which is made up of a key-value pair. |
error |
Object |
-Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + | The error message returned if an error occurs. For details, see Parameters in the error field. |
Yes |
-Specifies the project ID. + | The project ID. |
snapshot_id |
Yes |
-Specifies the snapshot ID. + | The snapshot ID. |
|
key |
Yes |
-Specifies the key of the piece of metadata to be deleted. + | The key of the metadata to be deleted. |
Object |
-Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + | The error message returned if an error occurs. For details, see Parameters in the error field. |
diff --git a/docs/evs/api-ref/evs_04_3069.html b/docs/evs/api-ref/evs_04_3069.html
index 4848734ba..1a9545225 100644
--- a/docs/evs/api-ref/evs_04_3069.html
+++ b/docs/evs/api-ref/evs_04_3069.html
@@ -23,7 +23,7 @@
Yes |
-Specifies the project ID. + | The project ID. |
@@ -114,7 +114,7 @@
Parameter |
Type diff --git a/docs/evs/api-ref/evs_04_3070.html b/docs/evs/api-ref/evs_04_3070.html index b786f3dcd..fde13f24d 100644 --- a/docs/evs/api-ref/evs_04_3070.html +++ b/docs/evs/api-ref/evs_04_3070.html @@ -21,14 +21,14 @@ | Yes |
-Specifies the project ID. + | The project ID. |
|---|---|---|---|---|
transfer_id |
Yes |
-Specifies the disk transfer ID. + | The transfer ID. |
Yes |
-Specifies the project ID. + | The project ID. |
transfer_id |
Yes |
-Specifies the disk transfer ID. + | The transfer ID. |
Yes |
-Specifies the project ID. + | The project ID. |
transfer_id |
Yes |
-Specifies the disk transfer ID. + | The transfer ID. |
Yes |
-Specifies the project ID. + | The project ID. |
diff --git a/docs/evs/api-ref/evs_04_3074.html b/docs/evs/api-ref/evs_04_3074.html
index f5a57dff3..0104abe56 100644
--- a/docs/evs/api-ref/evs_04_3074.html
+++ b/docs/evs/api-ref/evs_04_3074.html
@@ -17,7 +17,7 @@
Yes |
-Specifies the project ID. + | The project ID. |
diff --git a/docs/evs/api-ref/evs_04_4008.html b/docs/evs/api-ref/evs_04_4008.html
new file mode 100644
index 000000000..b56e1dd4d
--- /dev/null
+++ b/docs/evs/api-ref/evs_04_4008.html
@@ -0,0 +1,208 @@
+
+
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+The project ID. + |
+
volume_id + |
+Yes + |
+String + |
+The disk ID. + |
+
Request
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
os-retype + |
+Yes + |
+RetypeVolume object + |
+The request body of the disk type change. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
new_type + |
+Yes + |
+String + |
+The new disk type. + NOTE:
+
|
+
Response
Status code: 202
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
job_id + |
+String + |
+The task ID. + |
+
Status code: 400
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
error + |
+Error object + |
+The error code returned if an error occurs. For details about the error code, see Error Codes. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
code + |
+String + |
+The error code returned if an error occurs. For details about the error code, see Error Codes. + |
+
message + |
+String + |
+The error message returned if an error occurs. + |
+
Example Requests
https://{endpoint}/v2/{project_id}/volumes/{volume_id}/retype
+
+{
+ "os-retype" : {
+ "new_type" : "SAS"
+ }
+}
+Example Responses
Status code: 202
+Accepted
+- Example 1
{ + "job_id" : "4011af9965d85d3c0165d8628c650007" +}+
Status code: 400
+Bad Request
+{
+ "error" : {
+ "message" : "XXXX",
+ "code" : "XXX"
+ }
+}
+Status Codes
+Status Code + |
+Description + |
+
|---|---|
202 + |
+Accepted + |
+
400 + |
+Bad Request + |
+
Error Codes
For details, see Error Codes.
+