diff --git a/docs/evs/api-ref/.placeholder b/docs/evs/api-ref/.placeholder deleted file mode 100644 index e69de29bb..000000000 diff --git a/docs/evs/api-ref/ALL_META.TXT.json b/docs/evs/api-ref/ALL_META.TXT.json new file mode 100644 index 000000000..b09523367 --- /dev/null +++ b/docs/evs/api-ref/ALL_META.TXT.json @@ -0,0 +1,1812 @@ +[ + { + "uri":"evs_04_0001.html", + "product_code":"evs", + "code":"1", + "des":"Public cloud Application Programming Interfaces (APIs) comply with the RESTful API design principles. REST-based Web services are organized into resources. Each resource ", + "doc_type":"api", + "kw":"API Usage Guidelines,API Reference", + "title":"API Usage Guidelines", + "githuburl":"" + }, + { + "uri":"evs_04_0018.html", + "product_code":"evs", + "code":"2", + "des":"EVS APIs provide multiple versions. For the APIs offering same functions, you are recommended to use the v2 APIs.The current default microversion of v3 APIs is 3.0, and t", + "doc_type":"api", + "kw":"API Version Description and Usage Instructions,API Reference", + "title":"API Version Description and Usage Instructions", + "githuburl":"" + }, + { + "uri":"evs_04_0019.html", + "product_code":"evs", + "code":"3", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"API Version Query", + "title":"API Version Query", + "githuburl":"" + }, + { + "uri":"evs_04_0020.html", + "product_code":"evs", + "code":"4", + "des":"This API is used to query information of API versions.URI formatGET /GET /Example requestGET https://{endpoint}/Parameter descriptionParameterTypeDescriptionversionsArray", + "doc_type":"api", + "kw":"Querying Information of API Versions,API Version Query,API Reference", + "title":"Querying Information of API Versions", + "githuburl":"" + }, + { + "uri":"evs_04_0021.html", + "product_code":"evs", + "code":"5", + "des":"This API is used to query information of an API version.URI formatGET /{api_version}GET /{api_version}Parameter descriptionParameterTypeDescriptionapi_versionStringSpecif", + "doc_type":"api", + "kw":"Querying Information of an API Version,API Version Query,API Reference", + "title":"Querying Information of an API Version", + "githuburl":"" + }, + { + "uri":"evs_04_2001.html", + "product_code":"evs", + "code":"6", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"API v2 (Recommended)", + "title":"API v2 (Recommended)", + "githuburl":"" + }, + { + "uri":"evs_04_2002.html", + "product_code":"evs", + "code":"7", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"EVS Disk", + "title":"EVS Disk", + "githuburl":"" + }, + { + "uri":"evs_04_2013.html", + "product_code":"evs", + "code":"8", + "des":"This API is used to create one or multiple EVS disks.URI formatPOST /v2/{project_id}/cloudvolumesPOST /v2/{project_id}/cloudvolumesParameter descriptionParameterMandatory", + "doc_type":"api", + "kw":"Creating EVS Disks,EVS Disk,API Reference", + "title":"Creating EVS Disks", + "githuburl":"" + }, + { + "uri":"evs_04_2005.html", + "product_code":"evs", + "code":"9", + "des":"This API is used to query details about all disks.URI formatGET /v2/{project_id}/cloudvolumes/detailGET /v2/{project_id}/cloudvolumes/detailParameter descriptionParameter", + "doc_type":"api", + "kw":"Querying Details About All Disks,EVS Disk,API Reference", + "title":"Querying Details About All Disks", + "githuburl":"" + }, + { + "uri":"evs_04_2008.html", + "product_code":"evs", + "code":"10", + "des":"This API is used to delete an EVS disk.URI formatDELETE /v2/{project_id}/cloudvolumes/{volume_id}DELETE /v2/{project_id}/cloudvolumes/{volume_id}Parameter descriptionPara", + "doc_type":"api", + "kw":"Deleting an EVS Disk,EVS Disk,API Reference", + "title":"Deleting an EVS Disk", + "githuburl":"" + }, + { + "uri":"evs_04_2009.html", + "product_code":"evs", + "code":"11", + "des":"This API is used to update the name and description of an EVS disk.This API has been deprecated. Use another API. For details, see Updating an EVS Disk.URI formatPUT /v2/", + "doc_type":"api", + "kw":"Updating an EVS Disk (Deprecated),EVS Disk,API Reference", + "title":"Updating an EVS Disk (Deprecated)", + "githuburl":"" + }, + { + "uri":"evs_04_2010.html", + "product_code":"evs", + "code":"12", + "des":"This API is used to query details about all disks.URI formatGET /v2/{project_id}/os-vendor-volumes/detailGET /v2/{project_id}/os-vendor-volumes/detailParameter descriptio", + "doc_type":"api", + "kw":"Querying Details About All Disks (Deprecated),EVS Disk,API Reference", + "title":"Querying Details About All Disks (Deprecated)", + "githuburl":"" + }, + { + "uri":"evs_04_2011.html", + "product_code":"evs", + "code":"13", + "des":"This API is used to query details about a disk.URI formatGET /v2/{project_id}/os-vendor-volumes/{volume_id}GET /v2/{project_id}/os-vendor-volumes/{volume_id}Parameter des", + "doc_type":"api", + "kw":"Querying Details About a Disk,EVS Disk,API Reference", + "title":"Querying Details About a Disk", + "githuburl":"" + }, + { + "uri":"evs_04_2012.html", + "product_code":"evs", + "code":"14", + "des":"This API is used to query EVS disks and display the query results in a list.This API has been deprecated. Use another API. For details, see Querying EVS Disks.URI formatG", + "doc_type":"api", + "kw":"Querying EVS Disks (Deprecated),EVS Disk,API Reference", + "title":"Querying EVS Disks (Deprecated)", + "githuburl":"" + }, + { + "uri":"evs_04_2014.html", + "product_code":"evs", + "code":"15", + "des":"This API is used to expand the capacity of an EVS disk.If the status of the to-be-expanded disk is available, there are no restrictions.If the status of the to-be-expande", + "doc_type":"api", + "kw":"Expanding Capacity of an EVS Disk (Deprecated),EVS Disk,API Reference", + "title":"Expanding Capacity of an EVS Disk (Deprecated)", + "githuburl":"" + }, + { + "uri":"evs_04_2015.html", + "product_code":"evs", + "code":"16", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"EVS Snapshot", + "title":"EVS Snapshot", + "githuburl":"" + }, + { + "uri":"evs_04_2022.html", + "product_code":"evs", + "code":"17", + "des":"This API is used to roll back a snapshot to an EVS disk.When you roll back a snapshot to a disk, you can only roll back the snapshot to the source disk. Rollback to a spe", + "doc_type":"api", + "kw":"Rolling Back a Snapshot to an EVS Disk,EVS Snapshot,API Reference", + "title":"Rolling Back a Snapshot to an EVS Disk", + "githuburl":"" + }, + { + "uri":"evs_04_2024.html", + "product_code":"evs", + "code":"18", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"EVS Tag", + "title":"EVS Tag", + "githuburl":"" + }, + { + "uri":"evs_04_2025.html", + "product_code":"evs", + "code":"19", + "des":"This API is used to delete tags of an EVS resource by key.NoneURI formatDELETE /v2/{project_id}/os-vendor-tags/{resource_type}/{resource_id}/{key}DELETE /v2/{project_id}/", + "doc_type":"api", + "kw":"Deleting Tags of an EVS Resource by Key,EVS Tag,API Reference", + "title":"Deleting Tags of an EVS Resource by Key", + "githuburl":"" + }, + { + "uri":"evs_04_2026.html", + "product_code":"evs", + "code":"20", + "des":"This API is used to obtain all tags of an EVS resource type.NoneURI formatGET /v2/{project_id}/os-vendor-tags/{resource_type}GET /v2/{project_id}/os-vendor-tags/{resource", + "doc_type":"api", + "kw":"Obtaining All Tags of an EVS Resource Type,EVS Tag,API Reference", + "title":"Obtaining All Tags of an EVS Resource Type", + "githuburl":"" + }, + { + "uri":"evs_04_2027.html", + "product_code":"evs", + "code":"21", + "des":"This API is used to batch add tags for the specified EVS disk.When adding tags, if a tag key is consistent with an existing one, the new tag will overwrite the existing t", + "doc_type":"api", + "kw":"Batch Adding Tags for the Specified EVS Disk,EVS Tag,API Reference", + "title":"Batch Adding Tags for the Specified EVS Disk", + "githuburl":"" + }, + { + "uri":"evs_04_2029.html", + "product_code":"evs", + "code":"22", + "des":"This API is used to batch delete tags for the specified EVS disk.NoneURI formatPOST /v2/{project_id}/os-vendor-volumes/{volume_id}/tags/actionPOST /v2/{project_id}/os-ven", + "doc_type":"api", + "kw":"Batch Deleting Tags for the Specified EVS Disk,EVS Tag,API Reference", + "title":"Batch Deleting Tags for the Specified EVS Disk", + "githuburl":"" + }, + { + "uri":"evs_04_2031.html", + "product_code":"evs", + "code":"23", + "des":"This API is used to query the tags of the specified EVS disk.NoneURI formatGET /v2/{project_id}/os-vendor-volumes/{volume_id}/tagsGET /v2/{project_id}/os-vendor-volumes/{", + "doc_type":"api", + "kw":"Querying Tags of an EVS Disk,EVS Tag,API Reference", + "title":"Querying Tags of an EVS Disk", + "githuburl":"" + }, + { + "uri":"evs_04_2032.html", + "product_code":"evs", + "code":"24", + "des":"This API is used to query the number of EVS disks by tag.NoneURI formatPOST /v2/{project_id}/os-vendor-volumes/resource_instances/actionPOST /v2/{project_id}/os-vendor-vo", + "doc_type":"api", + "kw":"Querying the Number of EVS Disks by Tag,EVS Tag,API Reference", + "title":"Querying the Number of EVS Disks by Tag", + "githuburl":"" + }, + { + "uri":"evs_04_2034.html", + "product_code":"evs", + "code":"25", + "des":"This API is used to query the details of EVS disks by tag.NoneURI formatPOST /v2/{project_id}/os-vendor-volumes/resource_instances/actionPOST /v2/{project_id}/os-vendor-v", + "doc_type":"api", + "kw":"Querying Details of EVS Disks by Tag,EVS Tag,API Reference", + "title":"Querying Details of EVS Disks by Tag", + "githuburl":"" + }, + { + "uri":"evs_04_2036.html", + "product_code":"evs", + "code":"26", + "des":"This API is used to add or update tags for an EVS resource.This API has been deprecated. Use another API. For details, see Batch Adding Tags for the Specified EVS Disk.A ", + "doc_type":"api", + "kw":"Adding or Updating Tags for an EVS Resource (Deprecated),EVS Tag,API Reference", + "title":"Adding or Updating Tags for an EVS Resource (Deprecated)", + "githuburl":"" + }, + { + "uri":"evs_04_2037.html", + "product_code":"evs", + "code":"27", + "des":"This API is used to batch delete tags for an EVS resource.This API has been deprecated. Use another API. For details, see Batch Deleting Tags for the Specified EVS Disk.N", + "doc_type":"api", + "kw":"Batch Deleting Tags for an EVS Resource (Deprecated),EVS Tag,API Reference", + "title":"Batch Deleting Tags for an EVS Resource (Deprecated)", + "githuburl":"" + }, + { + "uri":"evs_04_2038.html", + "product_code":"evs", + "code":"28", + "des":"This API is used to obtain the tags of a specified EVS resource.This API has been deprecated. Use another API. For details, see Querying Tags of an EVS Disk.NoneURI forma", + "doc_type":"api", + "kw":"Obtaining Tags of a Specified EVS Resource (Deprecated),EVS Tag,API Reference", + "title":"Obtaining Tags of a Specified EVS Resource (Deprecated)", + "githuburl":"" + }, + { + "uri":"evs_04_2039.html", + "product_code":"evs", + "code":"29", + "des":"This API is used to query tags of an EVS resource by key.This API has been deprecated. Use another API. For details, see Querying Tags of an EVS Disk.NoneURI formatGET /v", + "doc_type":"api", + "kw":"Querying Tags of an EVS Resource by Key (Deprecated),EVS Tag,API Reference", + "title":"Querying Tags of an EVS Resource by Key (Deprecated)", + "githuburl":"" + }, + { + "uri":"evs_04_2040.html", + "product_code":"evs", + "code":"30", + "des":"This API is used to reset the tags of an EVS resource, and the existing tags will be deleted.This API call exists for compatibility reasons only and has been deprecated.A", + "doc_type":"api", + "kw":"Resetting Tags of an EVS Resource (Deprecated),EVS Tag,API Reference", + "title":"Resetting Tags of an EVS Resource (Deprecated)", + "githuburl":"" + }, + { + "uri":"evs_04_2041.html", + "product_code":"evs", + "code":"31", + "des":"This API is used to update tags of an EVS resource by key.This API has been deprecated. Use another API. For details, see Batch Adding Tags for the Specified EVS Disk.A t", + "doc_type":"api", + "kw":"Updating Tags of an EVS Resource by Key (Deprecated),EVS Tag,API Reference", + "title":"Updating Tags of an EVS Resource by Key (Deprecated)", + "githuburl":"" + }, + { + "uri":"evs_04_2042.html", + "product_code":"evs", + "code":"32", + "des":"This API is used to query the EVS resources by tag.This API has been deprecated. Use another API. For details, see Querying Details of EVS Disks by Tag.NoneURI formatGET ", + "doc_type":"api", + "kw":"Querying EVS Resources by Tag (Deprecated),EVS Tag,API Reference", + "title":"Querying EVS Resources by Tag (Deprecated)", + "githuburl":"" + }, + { + "uri":"evs_04_2043.html", + "product_code":"evs", + "code":"33", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"EVS Replication Pair (Deprecated)", + "title":"EVS Replication Pair (Deprecated)", + "githuburl":"" + }, + { + "uri":"evs_04_2044.html", + "product_code":"evs", + "code":"34", + "des":"This API is used to create an EVS replication pair using a specified production disk and a disaster recovery (DR) disk. The production disk is in the primary AZ, and the ", + "doc_type":"api", + "kw":"Creating an EVS Replication Pair (Deprecated),EVS Replication Pair (Deprecated),API Reference", + "title":"Creating an EVS Replication Pair (Deprecated)", + "githuburl":"" + }, + { + "uri":"evs_04_2045.html", + "product_code":"evs", + "code":"35", + "des":"This API is used to delete a specified EVS replication pair.This API has been deprecated. To use this function, see Storage Disaster Recovery Service API Reference.The to", + "doc_type":"api", + "kw":"Deleting an EVS Replication Pair (Deprecated),EVS Replication Pair (Deprecated),API Reference", + "title":"Deleting an EVS Replication Pair (Deprecated)", + "githuburl":"" + }, + { + "uri":"evs_04_2046.html", + "product_code":"evs", + "code":"36", + "des":"This API is used to query all EVS replication pairs of the current tenant.This API has been deprecated. To use this function, see Storage Disaster Recovery Service API Re", + "doc_type":"api", + "kw":"Querying All EVS Replication Pairs (Deprecated),EVS Replication Pair (Deprecated),API Reference", + "title":"Querying All EVS Replication Pairs (Deprecated)", + "githuburl":"" + }, + { + "uri":"evs_04_2047.html", + "product_code":"evs", + "code":"37", + "des":"This API is used to query the details about an EVS replication pair, including the name, ID, and status of the replication pair.This API has been deprecated. To use this ", + "doc_type":"api", + "kw":"Querying Details About an EVS Replication Pair (Deprecated),EVS Replication Pair (Deprecated),API Re", + "title":"Querying Details About an EVS Replication Pair (Deprecated)", + "githuburl":"" + }, + { + "uri":"evs_04_2048.html", + "product_code":"evs", + "code":"38", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Replication Consistency Group (Deprecated)", + "title":"Replication Consistency Group (Deprecated)", + "githuburl":"" + }, + { + "uri":"evs_04_2049.html", + "product_code":"evs", + "code":"39", + "des":"This API is used to create a replication consistency group for the specified EVS replication pairs.This API has been deprecated. To use this function, see Storage Disaste", + "doc_type":"api", + "kw":"Creating a Replication Consistency Group (Deprecated),Replication Consistency Group (Deprecated),API", + "title":"Creating a Replication Consistency Group (Deprecated)", + "githuburl":"" + }, + { + "uri":"evs_04_2050.html", + "product_code":"evs", + "code":"40", + "des":"This API is used to delete a replication consistency group.This API has been deprecated. To use this function, see Storage Disaster Recovery Service API Reference.All EVS", + "doc_type":"api", + "kw":"Deleting a Replication Consistency Group (Deprecated),Replication Consistency Group (Deprecated),API", + "title":"Deleting a Replication Consistency Group (Deprecated)", + "githuburl":"" + }, + { + "uri":"evs_04_2051.html", + "product_code":"evs", + "code":"41", + "des":"This API is used to query all replication consistency groups of the current tenant.This API has been deprecated. To use this function, see Storage Disaster Recovery Servi", + "doc_type":"api", + "kw":"Querying All Replication Consistency Groups (Deprecated),Replication Consistency Group (Deprecated),", + "title":"Querying All Replication Consistency Groups (Deprecated)", + "githuburl":"" + }, + { + "uri":"evs_04_2052.html", + "product_code":"evs", + "code":"42", + "des":"This API is used to query the details about a replication consistency group, including the name, ID, and status of the consistency group.This API has been deprecated. To ", + "doc_type":"api", + "kw":"Querying Details About a Replication Consistency Group (Deprecated),Replication Consistency Group (D", + "title":"Querying Details About a Replication Consistency Group (Deprecated)", + "githuburl":"" + }, + { + "uri":"evs_04_2053.html", + "product_code":"evs", + "code":"43", + "des":"This API is used to update a replication consistency group. An update includes the following operations:Update the name or description of the replication consistency grou", + "doc_type":"api", + "kw":"Updating a Replication Consistency Group (Deprecated),Replication Consistency Group (Deprecated),API", + "title":"Updating a Replication Consistency Group (Deprecated)", + "githuburl":"" + }, + { + "uri":"evs_04_2054.html", + "product_code":"evs", + "code":"44", + "des":"This API is used to perform a failover for a replication consistency group. When an exception occurs in the primary AZ, a failover can be performed to change the primary ", + "doc_type":"api", + "kw":"Performing a Failover for a Replication Consistency Group (Deprecated),Replication Consistency Group", + "title":"Performing a Failover for a Replication Consistency Group (Deprecated)", + "githuburl":"" + }, + { + "uri":"evs_04_2055.html", + "product_code":"evs", + "code":"45", + "des":"This API is used to synchronize the data between production disks and DR disks in all EVS replication pairs of a replication consistency group. After the synchronization ", + "doc_type":"api", + "kw":"Synchronizing a Replication Consistency Group (Deprecated),Replication Consistency Group (Deprecated", + "title":"Synchronizing a Replication Consistency Group (Deprecated)", + "githuburl":"" + }, + { + "uri":"evs_04_2056.html", + "product_code":"evs", + "code":"46", + "des":"This API is used to perform a primary/secondary switchover for a replication consistency group. A switchover can be performed to switch the primary and secondary AZs of a", + "doc_type":"api", + "kw":"Performing a Primary/Secondary Switchover for a Replication Consistency Group (Deprecated),Replicati", + "title":"Performing a Primary/Secondary Switchover for a Replication Consistency Group (Deprecated)", + "githuburl":"" + }, + { + "uri":"evs_04_2057.html", + "product_code":"evs", + "code":"47", + "des":"This API is used to pause a replication consistency group, that is, to pause the data synchronization in all EVS replication pairs of a replication consistency group.Befo", + "doc_type":"api", + "kw":"Pausing a Replication Consistency Group (Deprecated),Replication Consistency Group (Deprecated),API ", + "title":"Pausing a Replication Consistency Group (Deprecated)", + "githuburl":"" + }, + { + "uri":"evs_04_2058.html", + "product_code":"evs", + "code":"48", + "des":"This API is used to reprotect a replication consistency group. After resources in a faulty AZ have been restored and functioned as DR resources, a reprotection can be per", + "doc_type":"api", + "kw":"Reprotecting a Replication Consistency Group (Deprecated),Replication Consistency Group (Deprecated)", + "title":"Reprotecting a Replication Consistency Group (Deprecated)", + "githuburl":"" + }, + { + "uri":"evs_04_2059.html", + "product_code":"evs", + "code":"49", + "des":"This API is used to expand the EVS disks in one or multiple EVS replication pairs. In such an expansion operation, two EVS disks in one EVS replication pair are expanded ", + "doc_type":"api", + "kw":"Expanding EVS Disks in a Replication Consistency Group (Deprecated),Replication Consistency Group (D", + "title":"Expanding EVS Disks in a Replication Consistency Group (Deprecated)", + "githuburl":"" + }, + { + "uri":"evs_04_2063.html", + "product_code":"evs", + "code":"50", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"OpenStack Cinder API v2 (Recommended)", + "title":"OpenStack Cinder API v2 (Recommended)", + "githuburl":"" + }, + { + "uri":"evs_04_2064.html", + "product_code":"evs", + "code":"51", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"EVS Disk", + "title":"EVS Disk", + "githuburl":"" + }, + { + "uri":"evs_04_2065.html", + "product_code":"evs", + "code":"52", + "des":"This API is used to create one or multiple EVS disks.URI formatPOST /v2/{project_id}/volumesPOST /v2/{project_id}/volumesParameter descriptionParameterMandatoryDescriptio", + "doc_type":"api", + "kw":"Creating EVS Disks,EVS Disk,API Reference", + "title":"Creating EVS Disks", + "githuburl":"" + }, + { + "uri":"evs_04_2066.html", + "product_code":"evs", + "code":"53", + "des":"This API is used to delete an EVS disk.URI formatDELETE /v2/{project_id}/volumes/{volume_id}DELETE /v2/{project_id}/volumes/{volume_id}Parameter descriptionParameterManda", + "doc_type":"api", + "kw":"Deleting an EVS Disk,EVS Disk,API Reference", + "title":"Deleting an EVS Disk", + "githuburl":"" + }, + { + "uri":"evs_04_2067.html", + "product_code":"evs", + "code":"54", + "des":"This API is used to update the EVS disk information.URI formatPUT /v2/{project_id}/volumes/{volume_id}PUT /v2/{project_id}/volumes/{volume_id}Parameter descriptionParamet", + "doc_type":"api", + "kw":"Updating an EVS Disk,EVS Disk,API Reference", + "title":"Updating an EVS Disk", + "githuburl":"" + }, + { + "uri":"evs_04_2068.html", + "product_code":"evs", + "code":"55", + "des":"This API is used to query EVS disks.URI formatGET /v2/{project_id}/volumesGET /v2/{project_id}/volumesParameter descriptionParameterMandatoryDescriptionproject_idYesSpeci", + "doc_type":"api", + "kw":"Querying EVS Disks,EVS Disk,API Reference", + "title":"Querying EVS Disks", + "githuburl":"" + }, + { + "uri":"evs_04_2069.html", + "product_code":"evs", + "code":"56", + "des":"This API is used to query details about all disks.URI formatGET /v2/{project_id}/volumes/detailGET /v2/{project_id}/volumes/detailParameter descriptionParameterMandatoryD", + "doc_type":"api", + "kw":"Querying Details About All Disks,EVS Disk,API Reference", + "title":"Querying Details About All Disks", + "githuburl":"" + }, + { + "uri":"evs_04_2070.html", + "product_code":"evs", + "code":"57", + "des":"This API is used to query details about a disk.URI formatGET /v2/{project_id}/volumes/{volume_id}GET /v2/{project_id}/volumes/{volume_id}Parameter descriptionParameterMan", + "doc_type":"api", + "kw":"Querying Details About a Disk,EVS Disk,API Reference", + "title":"Querying Details About a Disk", + "githuburl":"" + }, + { + "uri":"evs_04_2071.html", + "product_code":"evs", + "code":"58", + "des":"This API is used to query EVS disk types and display the query results in a list.URI formatGET /v2/{project_id}/typesGET /v2/{project_id}/typesParameter descriptionParame", + "doc_type":"api", + "kw":"Querying EVS Disk Types,EVS Disk,API Reference", + "title":"Querying EVS Disk Types", + "githuburl":"" + }, + { + "uri":"evs_04_2072.html", + "product_code":"evs", + "code":"59", + "des":"This API is used to query details about an EVS disk type.URI formatGET /v2/{project_id}/types/{type_id}GET /v2/{project_id}/types/{type_id}Parameter descriptionParameterM", + "doc_type":"api", + "kw":"Querying Details About an EVS Disk Type,EVS Disk,API Reference", + "title":"Querying Details About an EVS Disk Type", + "githuburl":"" + }, + { + "uri":"evs_04_2073.html", + "product_code":"evs", + "code":"60", + "des":"This API is used to query the details of tenant quotas.URI formatGET /v2/{project_id}/os-quota-sets/{target_project_id}?usage=TrueGET /v2/{project_id}/os-quota-sets/{targ", + "doc_type":"api", + "kw":"Querying Details of Tenant Quotas,EVS Disk,API Reference", + "title":"Querying Details of Tenant Quotas", + "githuburl":"" + }, + { + "uri":"evs_04_2074.html", + "product_code":"evs", + "code":"61", + "des":"This API is used to add or update the metadata of an EVS disk.URI formatPOST /v2/{project_id}/volumes/{volume_id}/metadataPOST /v2/{project_id}/volumes/{volume_id}/metada", + "doc_type":"api", + "kw":"Adding Metadata of an EVS Disk,EVS Disk,API Reference", + "title":"Adding Metadata of an EVS Disk", + "githuburl":"" + }, + { + "uri":"evs_04_2075.html", + "product_code":"evs", + "code":"62", + "des":"This API is used to query the metadata of an EVS disk.URI formatGET /v2/{project_id}/volumes/{volume_id}/metadataGET /v2/{project_id}/volumes/{volume_id}/metadataParamete", + "doc_type":"api", + "kw":"Querying Metadata of an EVS Disk,EVS Disk,API Reference", + "title":"Querying Metadata of an EVS Disk", + "githuburl":"" + }, + { + "uri":"evs_04_2076.html", + "product_code":"evs", + "code":"63", + "des":"This API is used to update the metadata of an EVS disk.URI formatPUT /v2/{project_id}/volumes/{volume_id}/metadataPUT /v2/{project_id}/volumes/{volume_id}/metadataParamet", + "doc_type":"api", + "kw":"Updating Metadata of an EVS Disk,EVS Disk,API Reference", + "title":"Updating Metadata of an EVS Disk", + "githuburl":"" + }, + { + "uri":"evs_04_2077.html", + "product_code":"evs", + "code":"64", + "des":"This API is used to query one piece of the EVS disk metadata.URI formatGET /v2/{project_id}/volumes/{volume_id}/metadata/{key}GET /v2/{project_id}/volumes/{volume_id}/met", + "doc_type":"api", + "kw":"Querying One Piece of Metadata for an EVS Disk,EVS Disk,API Reference", + "title":"Querying One Piece of Metadata for an EVS Disk", + "githuburl":"" + }, + { + "uri":"evs_04_2078.html", + "product_code":"evs", + "code":"65", + "des":"This API is used to update one piece of the EVS disk metadata.URI formatPUT /v2/{project_id}/volumes/{volume_id}/metadata/{key}PUT /v2/{project_id}/volumes/{volume_id}/me", + "doc_type":"api", + "kw":"Updating One Piece of Metadata for an EVS Disk,EVS Disk,API Reference", + "title":"Updating One Piece of Metadata for an EVS Disk", + "githuburl":"" + }, + { + "uri":"evs_04_2079.html", + "product_code":"evs", + "code":"66", + "des":"This API is used to delete one piece of the EVS disk metadata.URI formatDELETE /v2/{project_id}/volumes/{volume_id}/metadata/{key}DELETE /v2/{project_id}/volumes/{volume_", + "doc_type":"api", + "kw":"Deleting One Piece of Metadata for an EVS Disk,EVS Disk,API Reference", + "title":"Deleting One Piece of Metadata for an EVS Disk", + "githuburl":"" + }, + { + "uri":"evs_04_2080.html", + "product_code":"evs", + "code":"67", + "des":"This API is used to query extension APIs.URI formatGET /v2/{project_id}/extensionsGET /v2/{project_id}/extensionsParameter descriptionParameterMandatoryDescriptionproject", + "doc_type":"api", + "kw":"Querying Extension APIs,EVS Disk,API Reference", + "title":"Querying Extension APIs", + "githuburl":"" + }, + { + "uri":"evs_04_2081.html", + "product_code":"evs", + "code":"68", + "des":"This API is used to query all AZs.URI formatGET /v2/{project_id}/os-availability-zoneGET /v2/{project_id}/os-availability-zoneParameter descriptionParameterMandatoryDescr", + "doc_type":"api", + "kw":"Querying All AZs,EVS Disk,API Reference", + "title":"Querying All AZs", + "githuburl":"" + }, + { + "uri":"evs_04_2082.html", + "product_code":"evs", + "code":"69", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"EVS Disk Actions", + "title":"EVS Disk Actions", + "githuburl":"" + }, + { + "uri":"evs_04_2083.html", + "product_code":"evs", + "code":"70", + "des":"This API is used to expand the capacity of an EVS disk.If the status of the to-be-expanded disk is available, there are no restrictions.If the status of the to-be-expande", + "doc_type":"api", + "kw":"Expanding Capacity of an EVS Disk,EVS Disk Actions,API Reference", + "title":"Expanding Capacity of an EVS Disk", + "githuburl":"" + }, + { + "uri":"evs_04_2084.html", + "product_code":"evs", + "code":"71", + "des":"This API is used to set the bootable flag for an EVS disk.A data disk cannot be used as system disk for an ECS even if this API has been called to set the bootable flag f", + "doc_type":"api", + "kw":"Setting Bootable Flag for an EVS Disk,EVS Disk Actions,API Reference", + "title":"Setting Bootable Flag for an EVS Disk", + "githuburl":"" + }, + { + "uri":"evs_04_2085.html", + "product_code":"evs", + "code":"72", + "des":"This API is used to set the read-only flag for the EVS disk.URI formatPOST /v2/{project_id}/volumes/{volume_id}/actionPOST /v2/{project_id}/volumes/{volume_id}/actionPara", + "doc_type":"api", + "kw":"Setting Read-Only Flag for an EVS Disk,EVS Disk Actions,API Reference", + "title":"Setting Read-Only Flag for an EVS Disk", + "githuburl":"" + }, + { + "uri":"evs_04_2086.html", + "product_code":"evs", + "code":"73", + "des":"This API is used to export the system disk data or data disk data as an IMS image. The exported image will be displayed in the IMS private image list and can be viewed an", + "doc_type":"api", + "kw":"Exporting EVS Disk Data as an Image,EVS Disk Actions,API Reference", + "title":"Exporting EVS Disk Data as an Image", + "githuburl":"" + }, + { + "uri":"evs_04_2087.html", + "product_code":"evs", + "code":"74", + "des":"This API is only used to change the EVS disk status from available to in-use.This API call exists for compatibility reasons only and is not meant to be used.Do not call t", + "doc_type":"api", + "kw":"Attaching an EVS Disk (Deprecated),EVS Disk Actions,API Reference", + "title":"Attaching an EVS Disk (Deprecated)", + "githuburl":"" + }, + { + "uri":"evs_04_2088.html", + "product_code":"evs", + "code":"75", + "des":"This API is only used to change the EVS disk status from in-use to available.This API call exists for compatibility reasons only and is not meant to be used.Do not call t", + "doc_type":"api", + "kw":"Detaching an EVS Disk (Deprecated),EVS Disk Actions,API Reference", + "title":"Detaching an EVS Disk (Deprecated)", + "githuburl":"" + }, + { + "uri":"evs_04_2089.html", + "product_code":"evs", + "code":"76", + "des":"This API is used to reserve an EVS disk.This API call exists for compatibility reasons only and is not meant to be used.URI formatPOST /v2/{project_id}/volumes/{volume_id", + "doc_type":"api", + "kw":"Reserving an EVS Disk (Deprecated),EVS Disk Actions,API Reference", + "title":"Reserving an EVS Disk (Deprecated)", + "githuburl":"" + }, + { + "uri":"evs_04_2090.html", + "product_code":"evs", + "code":"77", + "des":"This API is used to cancel the reservation of an EVS disk.This API call exists for compatibility reasons only and is not meant to be used.URI formatPOST /v2/{project_id}/", + "doc_type":"api", + "kw":"Canceling Reservation of an EVS Disk (Deprecated),EVS Disk Actions,API Reference", + "title":"Canceling Reservation of an EVS Disk (Deprecated)", + "githuburl":"" + }, + { + "uri":"evs_04_2092.html", + "product_code":"evs", + "code":"78", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"EVS Snapshot", + "title":"EVS Snapshot", + "githuburl":"" + }, + { + "uri":"evs_04_2093.html", + "product_code":"evs", + "code":"79", + "des":"This API is used to create an EVS snapshot.URI formatPOST /v2/{project_id}/snapshotsPOST /v2/{project_id}/snapshotsParameter descriptionParameterMandatoryDescriptionproje", + "doc_type":"api", + "kw":"Creating an EVS Snapshot,EVS Snapshot,API Reference", + "title":"Creating an EVS Snapshot", + "githuburl":"" + }, + { + "uri":"evs_04_2094.html", + "product_code":"evs", + "code":"80", + "des":"This API is used to delete an EVS snapshot.A snapshot can be deleted only when it is in the available or error state.URI formatDELETE /v2/{project_id}/snapshots/{snapshot", + "doc_type":"api", + "kw":"Deleting an EVS Snapshot,EVS Snapshot,API Reference", + "title":"Deleting an EVS Snapshot", + "githuburl":"" + }, + { + "uri":"evs_04_2095.html", + "product_code":"evs", + "code":"81", + "des":"This API is used to update an EVS snapshot.URI formatPUT /v2/{project_id}/snapshots/{snapshot_id}PUT /v2/{project_id}/snapshots/{snapshot_id}Parameter descriptionParamete", + "doc_type":"api", + "kw":"Updating an EVS Snapshot,EVS Snapshot,API Reference", + "title":"Updating an EVS Snapshot", + "githuburl":"" + }, + { + "uri":"evs_04_2096.html", + "product_code":"evs", + "code":"82", + "des":"This API is used to query the EVS snapshots.URI formatGET /v2/{project_id}/snapshotsGET /v2/{project_id}/snapshotsParameter descriptionParameterMandatoryDescriptionprojec", + "doc_type":"api", + "kw":"Querying EVS Snapshots,EVS Snapshot,API Reference", + "title":"Querying EVS Snapshots", + "githuburl":"" + }, + { + "uri":"evs_04_2097.html", + "product_code":"evs", + "code":"83", + "des":"This API is used to query details about the EVS snapshots.URI formatGET /v2/{project_id}/snapshots/detailGET /v2/{project_id}/snapshots/detailParameter descriptionParamet", + "doc_type":"api", + "kw":"Querying Details About EVS Snapshots,EVS Snapshot,API Reference", + "title":"Querying Details About EVS Snapshots", + "githuburl":"" + }, + { + "uri":"evs_04_2098.html", + "product_code":"evs", + "code":"84", + "des":"This API is used to query details about an EVS snapshot.URI formatGET /v2/{project_id}/snapshots/{snapshot_id}GET /v2/{project_id}/snapshots/{snapshot_id}Parameter descri", + "doc_type":"api", + "kw":"Querying Details About an EVS Snapshot,EVS Snapshot,API Reference", + "title":"Querying Details About an EVS Snapshot", + "githuburl":"" + }, + { + "uri":"evs_04_2099.html", + "product_code":"evs", + "code":"85", + "des":"This API is used to add the metadata of an EVS snapshot.URI formatPOST /v2/{project_id}/snapshots/{snapshot_id}/metadataPOST /v2/{project_id}/snapshots/{snapshot_id}/meta", + "doc_type":"api", + "kw":"Adding Metadata of an EVS Snapshot,EVS Snapshot,API Reference", + "title":"Adding Metadata of an EVS Snapshot", + "githuburl":"" + }, + { + "uri":"evs_04_2100.html", + "product_code":"evs", + "code":"86", + "des":"This API is used to query the metadata of an EVS snapshot.URI formatGET /v2/{project_id}/snapshots/{snapshot_id}/metadataGET /v2/{project_id}/snapshots/{snapshot_id}/meta", + "doc_type":"api", + "kw":"Querying Metadata of an EVS Snapshot,EVS Snapshot,API Reference", + "title":"Querying Metadata of an EVS Snapshot", + "githuburl":"" + }, + { + "uri":"evs_04_2101.html", + "product_code":"evs", + "code":"87", + "des":"This API is used to update one piece of the EVS snapshot metadata.URI formatPUT /v2/{project_id}/snapshots/{snapshot_id}/metadata/{key}PUT /v2/{project_id}/snapshots/{sna", + "doc_type":"api", + "kw":"Updating One Piece of Metadata for an EVS Snapshot,EVS Snapshot,API Reference", + "title":"Updating One Piece of Metadata for an EVS Snapshot", + "githuburl":"" + }, + { + "uri":"evs_04_2102.html", + "product_code":"evs", + "code":"88", + "des":"This API is used to update the metadata of an EVS snapshot.URI formatPUT /v2/{project_id}/snapshots/{snapshot_id}/metadataPUT /v2/{project_id}/snapshots/{snapshot_id}/met", + "doc_type":"api", + "kw":"Updating Metadata of an EVS Snapshot,EVS Snapshot,API Reference", + "title":"Updating Metadata of an EVS Snapshot", + "githuburl":"" + }, + { + "uri":"evs_04_2103.html", + "product_code":"evs", + "code":"89", + "des":"This API is used to query one piece of the EVS snapshot metadata.URI formatGET /v2/{project_id}/snapshots/{snapshot_id}/metadata/{key}GET /v2/{project_id}/snapshots/{snap", + "doc_type":"api", + "kw":"Querying One Piece of Metadata for an EVS Snapshot,EVS Snapshot,API Reference", + "title":"Querying One Piece of Metadata for an EVS Snapshot", + "githuburl":"" + }, + { + "uri":"evs_04_2104.html", + "product_code":"evs", + "code":"90", + "des":"This API is used to delete one piece of the EVS snapshot metadata.URI formatDELETE /v2/{project_id}/snapshots/{snapshot_id}/metadata/{key}DELETE /v2/{project_id}/snapshot", + "doc_type":"api", + "kw":"Deleting One Piece of Metadata for an EVS Snapshot,EVS Snapshot,API Reference", + "title":"Deleting One Piece of Metadata for an EVS Snapshot", + "githuburl":"" + }, + { + "uri":"evs_04_2105.html", + "product_code":"evs", + "code":"91", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"EVS Disk Transfer", + "title":"EVS Disk Transfer", + "githuburl":"" + }, + { + "uri":"evs_04_2106.html", + "product_code":"evs", + "code":"92", + "des":"This API is used to create a disk transfer. After the transfer has been created, a transfer ID and an authentication key are returned.After a disk transfer is created, th", + "doc_type":"api", + "kw":"Creating a Disk Transfer,EVS Disk Transfer,API Reference", + "title":"Creating a Disk Transfer", + "githuburl":"" + }, + { + "uri":"evs_04_2107.html", + "product_code":"evs", + "code":"93", + "des":"This API is used to accept a disk transfer through the transfer ID and authentication key.Encrypted EVS disks cannot be transferred.EVS disks with backups and snapshots a", + "doc_type":"api", + "kw":"Accepting a Disk Transfer,EVS Disk Transfer,API Reference", + "title":"Accepting a Disk Transfer", + "githuburl":"" + }, + { + "uri":"evs_04_2108.html", + "product_code":"evs", + "code":"94", + "des":"This API is used to delete a disk transfer. A disk transfer can be deleted if it is not accepted. Accepted disk transfers cannot be deleted.URI formatDELETE /v2/{project_", + "doc_type":"api", + "kw":"Deleting a Disk Transfer,EVS Disk Transfer,API Reference", + "title":"Deleting a Disk Transfer", + "githuburl":"" + }, + { + "uri":"evs_04_2109.html", + "product_code":"evs", + "code":"95", + "des":"This API is used to query the details of a disk transfer, including the transfer creation time, transfer ID, and transfer name.URI formatGET /v2/{project_id}/os-volume-tr", + "doc_type":"api", + "kw":"Querying Details of a Disk Transfer,EVS Disk Transfer,API Reference", + "title":"Querying Details of a Disk Transfer", + "githuburl":"" + }, + { + "uri":"evs_04_2110.html", + "product_code":"evs", + "code":"96", + "des":"This API is used to query all disk transfers of the current tenant.URI formatGET /v2/{project_id}/os-volume-transferGET /v2/{project_id}/os-volume-transferParameter descr", + "doc_type":"api", + "kw":"Querying All Disk Transfers,EVS Disk Transfer,API Reference", + "title":"Querying All Disk Transfers", + "githuburl":"" + }, + { + "uri":"evs_04_2111.html", + "product_code":"evs", + "code":"97", + "des":"This API is used to query the details of all disk transfers, including the transfer creation time, transfer IDs, and transfer names.URI formatGET /v2/{project_id}/os-volu", + "doc_type":"api", + "kw":"Querying Details of All Disk Transfers,EVS Disk Transfer,API Reference", + "title":"Querying Details of All Disk Transfers", + "githuburl":"" + }, + { + "uri":"evs_04_0063.html", + "product_code":"evs", + "code":"98", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Unrecommended APIs", + "title":"Unrecommended APIs", + "githuburl":"" + }, + { + "uri":"evs_04_3001.html", + "product_code":"evs", + "code":"99", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"API v3", + "title":"API v3", + "githuburl":"" + }, + { + "uri":"evs_04_3002.html", + "product_code":"evs", + "code":"100", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"EVS Disk", + "title":"EVS Disk", + "githuburl":"" + }, + { + "uri":"evs_04_3003.html", + "product_code":"evs", + "code":"101", + "des":"This API is used to create one or multiple EVS disks.URI formatPOST /v3/{project_id}/cloudvolumesPOST /v3/{project_id}/cloudvolumesParameter descriptionParameterMandatory", + "doc_type":"api", + "kw":"Creating EVS Disks,EVS Disk,API Reference", + "title":"Creating EVS Disks", + "githuburl":"" + }, + { + "uri":"evs_04_3004.html", + "product_code":"evs", + "code":"102", + "des":"This API is used to query details about all disks.URI formatGET /v3/{project_id}/os-vendor-volumes/detailGET /v3/{project_id}/os-vendor-volumes/detailParameter descriptio", + "doc_type":"api", + "kw":"Querying Details About All EVS Disks (Deprecated),EVS Disk,API Reference", + "title":"Querying Details About All EVS Disks (Deprecated)", + "githuburl":"" + }, + { + "uri":"evs_04_3005.html", + "product_code":"evs", + "code":"103", + "des":"This API is used to query details about a disk.URI formatGET /v3/{project_id}/os-vendor-volumes/{volume_id}GET /v3/{project_id}/os-vendor-volumes/{volume_id}Parameter des", + "doc_type":"api", + "kw":"Querying Details About an EVS Disk (Deprecated),EVS Disk,API Reference", + "title":"Querying Details About an EVS Disk (Deprecated)", + "githuburl":"" + }, + { + "uri":"evs_04_3006.html", + "product_code":"evs", + "code":"104", + "des":"This API is used to query the loading progress of a lazyloading disk.URI formatGET /v3/{project_id}/os-vendor-volumes/{volume_id}/internal-infoGET /v3/{project_id}/os-ven", + "doc_type":"api", + "kw":"Querying Loading Progress of a Lazyloading Disk,EVS Disk,API Reference", + "title":"Querying Loading Progress of a Lazyloading Disk", + "githuburl":"" + }, + { + "uri":"evs_04_3007.html", + "product_code":"evs", + "code":"105", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"EVS Snapshot", + "title":"EVS Snapshot", + "githuburl":"" + }, + { + "uri":"evs_04_3008.html", + "product_code":"evs", + "code":"106", + "des":"This API is used to roll back a snapshot to an EVS disk.When you roll back a snapshot to a disk, you can only roll back the snapshot to the source disk. Rollback to a spe", + "doc_type":"api", + "kw":"Rolling Back a Snapshot to an EVS Disk,EVS Snapshot,API Reference", + "title":"Rolling Back a Snapshot to an EVS Disk", + "githuburl":"" + }, + { + "uri":"evs_04_3010.html", + "product_code":"evs", + "code":"107", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"EVS Tag", + "title":"EVS Tag", + "githuburl":"" + }, + { + "uri":"evs_04_3011.html", + "product_code":"evs", + "code":"108", + "des":"This API is used to batch add tags for the specified EVS disk.When adding tags, if a tag key is consistent with an existing one, the new tag will overwrite the existing t", + "doc_type":"api", + "kw":"Batch Adding Tags for the Specified EVS Disk,EVS Tag,API Reference", + "title":"Batch Adding Tags for the Specified EVS Disk", + "githuburl":"" + }, + { + "uri":"evs_04_3013.html", + "product_code":"evs", + "code":"109", + "des":"This API is used to batch delete tags for the specified EVS disk.NoneURI formatPOST /v3/{project_id}/os-vendor-volumes/{volume_id}/tags/actionPOST /v3/{project_id}/os-ven", + "doc_type":"api", + "kw":"Batch Deleting Tags for the Specified EVS Disk,EVS Tag,API Reference", + "title":"Batch Deleting Tags for the Specified EVS Disk", + "githuburl":"" + }, + { + "uri":"evs_04_3015.html", + "product_code":"evs", + "code":"110", + "des":"This API is used to query the tags of the specified EVS disk.NoneURI formatGET /v3/{project_id}/os-vendor-volumes/{volume_id}/tagsGET /v3/{project_id}/os-vendor-volumes/{", + "doc_type":"api", + "kw":"Querying Tags of an EVS Disk,EVS Tag,API Reference", + "title":"Querying Tags of an EVS Disk", + "githuburl":"" + }, + { + "uri":"evs_04_3016.html", + "product_code":"evs", + "code":"111", + "des":"This API is used to query the number of EVS disks by tag.NoneURI formatPOST /v3/{project_id}/os-vendor-volumes/resource_instances/actionPOST /v3/{project_id}/os-vendor-vo", + "doc_type":"api", + "kw":"Querying the Number of EVS Disks by Tag,EVS Tag,API Reference", + "title":"Querying the Number of EVS Disks by Tag", + "githuburl":"" + }, + { + "uri":"evs_04_3018.html", + "product_code":"evs", + "code":"112", + "des":"This API is used to query the details of EVS disks by tag.NoneURI formatPOST /v3/{project_id}/os-vendor-volumes/resource_instances/actionPOST /v3/{project_id}/os-vendor-v", + "doc_type":"api", + "kw":"Querying Details of EVS Disks by Tag,EVS Tag,API Reference", + "title":"Querying Details of EVS Disks by Tag", + "githuburl":"" + }, + { + "uri":"evs_04_3027.html", + "product_code":"evs", + "code":"113", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"OpenStack Cinder API v3", + "title":"OpenStack Cinder API v3", + "githuburl":"" + }, + { + "uri":"evs_04_3028.html", + "product_code":"evs", + "code":"114", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"EVS Disk", + "title":"EVS Disk", + "githuburl":"" + }, + { + "uri":"evs_04_3029.html", + "product_code":"evs", + "code":"115", + "des":"This API is used to create one or multiple EVS disks.URI formatPOST /v3/{project_id}/volumesPOST /v3/{project_id}/volumesParameter descriptionParameterMandatoryDescriptio", + "doc_type":"api", + "kw":"Creating EVS Disks,EVS Disk,API Reference", + "title":"Creating EVS Disks", + "githuburl":"" + }, + { + "uri":"evs_04_3030.html", + "product_code":"evs", + "code":"116", + "des":"This API is used to delete an EVS disk.URI formatDELETE /v3/{project_id}/volumes/{volume_id}DELETE /v3/{project_id}/volumes/{volume_id}Parameter descriptionParameterManda", + "doc_type":"api", + "kw":"Deleting an EVS Disk,EVS Disk,API Reference", + "title":"Deleting an EVS Disk", + "githuburl":"" + }, + { + "uri":"evs_04_3031.html", + "product_code":"evs", + "code":"117", + "des":"This API is used to update the EVS disk information.URI formatPUT /v3/{project_id}/volumes/{volume_id}PUT /v3/{project_id}/volumes/{volume_id}Parameter descriptionParamet", + "doc_type":"api", + "kw":"Updating an EVS Disk,EVS Disk,API Reference", + "title":"Updating an EVS Disk", + "githuburl":"" + }, + { + "uri":"evs_04_3032.html", + "product_code":"evs", + "code":"118", + "des":"This API is used to query EVS disks.URI formatGET /v3/{project_id}/volumesGET /v3/{project_id}/volumesParameter descriptionParameterMandatoryDescriptionproject_idYesSpeci", + "doc_type":"api", + "kw":"Querying EVS Disks,EVS Disk,API Reference", + "title":"Querying EVS Disks", + "githuburl":"" + }, + { + "uri":"evs_04_3033.html", + "product_code":"evs", + "code":"119", + "des":"This API is used to query details about all disks.URI formatGET /v3/{project_id}/volumes/detailGET /v3/{project_id}/volumes/detailParameter descriptionParameterMandatoryD", + "doc_type":"api", + "kw":"Querying Details About All Disks,EVS Disk,API Reference", + "title":"Querying Details About All Disks", + "githuburl":"" + }, + { + "uri":"evs_04_3034.html", + "product_code":"evs", + "code":"120", + "des":"This API is used to query details about a disk.URI formatGET /v3/{project_id}/volumes/{volume_id}GET /v3/{project_id}/volumes/{volume_id}Parameter descriptionParameterMan", + "doc_type":"api", + "kw":"Querying Details About a Disk,EVS Disk,API Reference", + "title":"Querying Details About a Disk", + "githuburl":"" + }, + { + "uri":"evs_04_3035.html", + "product_code":"evs", + "code":"121", + "des":"This API is used to query EVS disk types and display the query results in a list.URI formatGET /v3/{project_id}/typesGET /v3/{project_id}/typesParameter descriptionParame", + "doc_type":"api", + "kw":"Querying EVS Disk Types,EVS Disk,API Reference", + "title":"Querying EVS Disk Types", + "githuburl":"" + }, + { + "uri":"evs_04_3036.html", + "product_code":"evs", + "code":"122", + "des":"This API is used to query details about an EVS disk type.URI formatGET /v3/{project_id}/types/{type_id}GET /v3/{project_id}/types/{type_id}Parameter descriptionParameterM", + "doc_type":"api", + "kw":"Querying Details About an EVS Disk Type,EVS Disk,API Reference", + "title":"Querying Details About an EVS Disk Type", + "githuburl":"" + }, + { + "uri":"evs_04_3037.html", + "product_code":"evs", + "code":"123", + "des":"This API is used to query the details of tenant quotas.URI formatGET /v3/{project_id}/os-quota-sets/{target_project_id}?usage=TrueGET /v3/{project_id}/os-quota-sets/{targ", + "doc_type":"api", + "kw":"Querying Details of Tenant Quotas,EVS Disk,API Reference", + "title":"Querying Details of Tenant Quotas", + "githuburl":"" + }, + { + "uri":"evs_04_3038.html", + "product_code":"evs", + "code":"124", + "des":"This API is used to add or update the metadata of an EVS disk.URI formatPOST /v3/{project_id}/volumes/{volume_id}/metadataPOST /v3/{project_id}/volumes/{volume_id}/metada", + "doc_type":"api", + "kw":"Adding Metadata of an EVS Disk,EVS Disk,API Reference", + "title":"Adding Metadata of an EVS Disk", + "githuburl":"" + }, + { + "uri":"evs_04_3039.html", + "product_code":"evs", + "code":"125", + "des":"This API is used to query the metadata of an EVS disk.URI formatGET /v3/{project_id}/volumes/{volume_id}/metadataGET /v3/{project_id}/volumes/{volume_id}/metadataParamete", + "doc_type":"api", + "kw":"Querying Metadata of an EVS Disk,EVS Disk,API Reference", + "title":"Querying Metadata of an EVS Disk", + "githuburl":"" + }, + { + "uri":"evs_04_3040.html", + "product_code":"evs", + "code":"126", + "des":"This API is used to update the metadata of an EVS disk.URI formatPUT /v3/{project_id}/volumes/{volume_id}/metadataPUT /v3/{project_id}/volumes/{volume_id}/metadataParamet", + "doc_type":"api", + "kw":"Updating Metadata of an EVS Disk,EVS Disk,API Reference", + "title":"Updating Metadata of an EVS Disk", + "githuburl":"" + }, + { + "uri":"evs_04_3041.html", + "product_code":"evs", + "code":"127", + "des":"This API is used to query one piece of the EVS disk metadata.URI formatGET /v3/{project_id}/volumes/{volume_id}/metadata/{key}GET /v3/{project_id}/volumes/{volume_id}/met", + "doc_type":"api", + "kw":"Querying One Piece of Metadata for an EVS Disk,EVS Disk,API Reference", + "title":"Querying One Piece of Metadata for an EVS Disk", + "githuburl":"" + }, + { + "uri":"evs_04_3042.html", + "product_code":"evs", + "code":"128", + "des":"This API is used to update one piece of the EVS disk metadata.URI formatPUT /v3/{project_id}/volumes/{volume_id}/metadata/{key}PUT /v3/{project_id}/volumes/{volume_id}/me", + "doc_type":"api", + "kw":"Updating One Piece of Metadata for an EVS Disk,EVS Disk,API Reference", + "title":"Updating One Piece of Metadata for an EVS Disk", + "githuburl":"" + }, + { + "uri":"evs_04_3043.html", + "product_code":"evs", + "code":"129", + "des":"This API is used to delete one piece of the EVS disk metadata.URI formatDELETE /v3/{project_id}/volumes/{volume_id}/metadata/{key}DELETE /v3/{project_id}/volumes/{volume_", + "doc_type":"api", + "kw":"Deleting One Piece of Metadata for an EVS Disk,EVS Disk,API Reference", + "title":"Deleting One Piece of Metadata for an EVS Disk", + "githuburl":"" + }, + { + "uri":"evs_04_3044.html", + "product_code":"evs", + "code":"130", + "des":"This API is used to query extension APIs.URI formatGET /v3/{project_id}/extensionsGET /v3/{project_id}/extensionsParameter descriptionParameterMandatoryDescriptionproject", + "doc_type":"api", + "kw":"Querying Extension APIs,EVS Disk,API Reference", + "title":"Querying Extension APIs", + "githuburl":"" + }, + { + "uri":"evs_04_3045.html", + "product_code":"evs", + "code":"131", + "des":"This API is used to query all AZs.URI formatGET /v3/{project_id}/os-availability-zoneGET /v3/{project_id}/os-availability-zoneParameter descriptionParameterMandatoryDescr", + "doc_type":"api", + "kw":"Querying All AZs,EVS Disk,API Reference", + "title":"Querying All AZs", + "githuburl":"" + }, + { + "uri":"evs_04_3047.html", + "product_code":"evs", + "code":"132", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"EVS Disk Actions", + "title":"EVS Disk Actions", + "githuburl":"" + }, + { + "uri":"evs_04_3048.html", + "product_code":"evs", + "code":"133", + "des":"This API is used to expand the capacity of an EVS disk.If the status of the to-be-expanded disk is available, there are no restrictions.If the status of the to-be-expande", + "doc_type":"api", + "kw":"Expanding Capacity of an EVS Disk,EVS Disk Actions,API Reference", + "title":"Expanding Capacity of an EVS Disk", + "githuburl":"" + }, + { + "uri":"evs_04_3049.html", + "product_code":"evs", + "code":"134", + "des":"This API is used to set the bootable flag for an EVS disk.A data disk cannot be used as system disk for an ECS even if this API has been called to set the bootable flag f", + "doc_type":"api", + "kw":"Setting Bootable Flag for an EVS Disk,EVS Disk Actions,API Reference", + "title":"Setting Bootable Flag for an EVS Disk", + "githuburl":"" + }, + { + "uri":"evs_04_3050.html", + "product_code":"evs", + "code":"135", + "des":"This API is used to set the read-only flag for the EVS disk.URI formatPOST /v3/{project_id}/volumes/{volume_id}/actionPOST /v3/{project_id}/volumes/{volume_id}/actionPara", + "doc_type":"api", + "kw":"Setting Read-Only Flag for an EVS Disk,EVS Disk Actions,API Reference", + "title":"Setting Read-Only Flag for an EVS Disk", + "githuburl":"" + }, + { + "uri":"evs_04_3051.html", + "product_code":"evs", + "code":"136", + "des":"This API is used to export the system disk data or data disk data as an IMS image. The exported image will be displayed in the IMS private image list and can be viewed an", + "doc_type":"api", + "kw":"Exporting EVS Disk Data as an Image,EVS Disk Actions,API Reference", + "title":"Exporting EVS Disk Data as an Image", + "githuburl":"" + }, + { + "uri":"evs_04_3052.html", + "product_code":"evs", + "code":"137", + "des":"This API is used to reserve an EVS disk.This API call exists for compatibility reasons only and is not meant to be used.URI formatPOST /v3/{project_id}/volumes/{volume_id", + "doc_type":"api", + "kw":"Reserving an EVS Disk (Deprecated),EVS Disk Actions,API Reference", + "title":"Reserving an EVS Disk (Deprecated)", + "githuburl":"" + }, + { + "uri":"evs_04_3053.html", + "product_code":"evs", + "code":"138", + "des":"This API is used to cancel the reservation of an EVS disk.This API call exists for compatibility reasons only and is not meant to be used.URI formatPOST /v3/{project_id}/", + "doc_type":"api", + "kw":"Canceling Reservation of an EVS Disk (Deprecated),EVS Disk Actions,API Reference", + "title":"Canceling Reservation of an EVS Disk (Deprecated)", + "githuburl":"" + }, + { + "uri":"evs_04_3055.html", + "product_code":"evs", + "code":"139", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"EVS Snapshot", + "title":"EVS Snapshot", + "githuburl":"" + }, + { + "uri":"evs_04_3056.html", + "product_code":"evs", + "code":"140", + "des":"This API is used to create an EVS snapshot.URI formatPOST /v3/{project_id}/snapshotsPOST /v3/{project_id}/snapshotsParameter descriptionParameterMandatoryDescriptionproje", + "doc_type":"api", + "kw":"Creating an EVS Snapshot,EVS Snapshot,API Reference", + "title":"Creating an EVS Snapshot", + "githuburl":"" + }, + { + "uri":"evs_04_3057.html", + "product_code":"evs", + "code":"141", + "des":"This API is used to delete an EVS snapshot.A snapshot can be deleted only when it is in the available or error state.URI formatDELETE /v3/{project_id}/snapshots/{snapshot", + "doc_type":"api", + "kw":"Deleting an EVS Snapshot,EVS Snapshot,API Reference", + "title":"Deleting an EVS Snapshot", + "githuburl":"" + }, + { + "uri":"evs_04_3058.html", + "product_code":"evs", + "code":"142", + "des":"This API is used to update an EVS snapshot.URI formatPUT /v3/{project_id}/snapshots/{snapshot_id}PUT /v3/{project_id}/snapshots/{snapshot_id}Parameter descriptionParamete", + "doc_type":"api", + "kw":"Updating an EVS Snapshot,EVS Snapshot,API Reference", + "title":"Updating an EVS Snapshot", + "githuburl":"" + }, + { + "uri":"evs_04_3059.html", + "product_code":"evs", + "code":"143", + "des":"This API is used to query the EVS snapshots.URI formatGET /v3/{project_id}/snapshotsGET /v3/{project_id}/snapshotsParameter descriptionParameterMandatoryDescriptionprojec", + "doc_type":"api", + "kw":"Querying EVS Snapshots,EVS Snapshot,API Reference", + "title":"Querying EVS Snapshots", + "githuburl":"" + }, + { + "uri":"evs_04_3060.html", + "product_code":"evs", + "code":"144", + "des":"This API is used to query details about the EVS snapshots.URI formatGET /v3/{project_id}/snapshots/detailGET /v3/{project_id}/snapshots/detailParameter descriptionParamet", + "doc_type":"api", + "kw":"Querying Details About EVS Snapshots,EVS Snapshot,API Reference", + "title":"Querying Details About EVS Snapshots", + "githuburl":"" + }, + { + "uri":"evs_04_3061.html", + "product_code":"evs", + "code":"145", + "des":"This API is used to query details about an EVS snapshot.URI formatGET /v3/{project_id}/snapshots/{snapshot_id}GET /v3/{project_id}/snapshots/{snapshot_id}Parameter descri", + "doc_type":"api", + "kw":"Querying Details About an EVS Snapshot,EVS Snapshot,API Reference", + "title":"Querying Details About an EVS Snapshot", + "githuburl":"" + }, + { + "uri":"evs_04_3062.html", + "product_code":"evs", + "code":"146", + "des":"This API is used to add the metadata of an EVS snapshot.URI formatPOST /v3/{project_id}/snapshots/{snapshot_id}/metadataPOST /v3/{project_id}/snapshots/{snapshot_id}/meta", + "doc_type":"api", + "kw":"Adding Metadata of an EVS Snapshot,EVS Snapshot,API Reference", + "title":"Adding Metadata of an EVS Snapshot", + "githuburl":"" + }, + { + "uri":"evs_04_3063.html", + "product_code":"evs", + "code":"147", + "des":"This API is used to query the metadata of an EVS snapshot.URI formatGET /v3/{project_id}/snapshots/{snapshot_id}/metadataGET /v3/{project_id}/snapshots/{snapshot_id}/meta", + "doc_type":"api", + "kw":"Querying Metadata of an EVS Snapshot,EVS Snapshot,API Reference", + "title":"Querying Metadata of an EVS Snapshot", + "githuburl":"" + }, + { + "uri":"evs_04_3064.html", + "product_code":"evs", + "code":"148", + "des":"This API is used to update one piece of the EVS snapshot metadata.URI formatPUT /v3/{project_id}/snapshots/{snapshot_id}/metadata/{key}PUT /v3/{project_id}/snapshots/{sna", + "doc_type":"api", + "kw":"Updating One Piece of Metadata for an EVS Snapshot,EVS Snapshot,API Reference", + "title":"Updating One Piece of Metadata for an EVS Snapshot", + "githuburl":"" + }, + { + "uri":"evs_04_3065.html", + "product_code":"evs", + "code":"149", + "des":"This API is used to update the metadata of an EVS snapshot.URI formatPUT /v3/{project_id}/snapshots/{snapshot_id}/metadataPUT /v3/{project_id}/snapshots/{snapshot_id}/met", + "doc_type":"api", + "kw":"Updating Metadata of an EVS Snapshot,EVS Snapshot,API Reference", + "title":"Updating Metadata of an EVS Snapshot", + "githuburl":"" + }, + { + "uri":"evs_04_3066.html", + "product_code":"evs", + "code":"150", + "des":"This API is used to query one piece of the EVS snapshot metadata.URI formatGET /v3/{project_id}/snapshots/{snapshot_id}/metadata/{key}GET /v3/{project_id}/snapshots/{snap", + "doc_type":"api", + "kw":"Querying One Piece of Metadata for an EVS Snapshot,EVS Snapshot,API Reference", + "title":"Querying One Piece of Metadata for an EVS Snapshot", + "githuburl":"" + }, + { + "uri":"evs_04_3067.html", + "product_code":"evs", + "code":"151", + "des":"This API is used to delete one piece of the EVS snapshot metadata.URI formatDELETE /v3/{project_id}/snapshots/{snapshot_id}/metadata/{key}DELETE /v3/{project_id}/snapshot", + "doc_type":"api", + "kw":"Deleting One Piece of Metadata for an EVS Snapshot,EVS Snapshot,API Reference", + "title":"Deleting One Piece of Metadata for an EVS Snapshot", + "githuburl":"" + }, + { + "uri":"evs_04_3068.html", + "product_code":"evs", + "code":"152", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"EVS Disk Transfer", + "title":"EVS Disk Transfer", + "githuburl":"" + }, + { + "uri":"evs_04_3069.html", + "product_code":"evs", + "code":"153", + "des":"This API is used to create a disk transfer. After the transfer has been created, a transfer ID and an authentication key are returned.After a disk transfer is created, th", + "doc_type":"api", + "kw":"Creating a Disk Transfer,EVS Disk Transfer,API Reference", + "title":"Creating a Disk Transfer", + "githuburl":"" + }, + { + "uri":"evs_04_3070.html", + "product_code":"evs", + "code":"154", + "des":"This API is used to accept a disk transfer through the transfer ID and authentication key.Encrypted EVS disks cannot be transferred.EVS disks with backups and snapshots a", + "doc_type":"api", + "kw":"Accepting a Disk Transfer,EVS Disk Transfer,API Reference", + "title":"Accepting a Disk Transfer", + "githuburl":"" + }, + { + "uri":"evs_04_3071.html", + "product_code":"evs", + "code":"155", + "des":"This API is used to delete a disk transfer. A disk transfer can be deleted if it is not accepted. Accepted disk transfers cannot be deleted.URI formatDELETE /v3/{project_", + "doc_type":"api", + "kw":"Deleting a Disk Transfer,EVS Disk Transfer,API Reference", + "title":"Deleting a Disk Transfer", + "githuburl":"" + }, + { + "uri":"evs_04_3072.html", + "product_code":"evs", + "code":"156", + "des":"This API is used to query the details of a disk transfer, including the transfer creation time, transfer ID, and transfer name.URI formatGET /v3/{project_id}/os-volume-tr", + "doc_type":"api", + "kw":"Querying Details of a Disk Transfer,EVS Disk Transfer,API Reference", + "title":"Querying Details of a Disk Transfer", + "githuburl":"" + }, + { + "uri":"evs_04_3073.html", + "product_code":"evs", + "code":"157", + "des":"This API is used to query all disk transfers of the current tenant.URI formatGET /v3/{project_id}/os-volume-transferGET /v3/{project_id}/os-volume-transferParameter descr", + "doc_type":"api", + "kw":"Querying All Disk Transfers,EVS Disk Transfer,API Reference", + "title":"Querying All Disk Transfers", + "githuburl":"" + }, + { + "uri":"evs_04_3074.html", + "product_code":"evs", + "code":"158", + "des":"This API is used to query the details of all disk transfers, including the transfer creation time, transfer IDs, and transfer names.URI formatGET /v3/{project_id}/os-volu", + "doc_type":"api", + "kw":"Querying Details of All Disk Transfers,EVS Disk Transfer,API Reference", + "title":"Querying Details of All Disk Transfers", + "githuburl":"" + }, + { + "uri":"evs_04_0053.html", + "product_code":"evs", + "code":"159", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"API v1", + "title":"API v1", + "githuburl":"" + }, + { + "uri":"evs_04_0054.html", + "product_code":"evs", + "code":"160", + "des":"This API is used to query the execution status of tasks, such as the status of disk creation, capacity expansion, and deletion.URI formatGET /v1/{project_id}/jobs/{job_id", + "doc_type":"api", + "kw":"Querying Task Status,API v1,API Reference", + "title":"Querying Task Status", + "githuburl":"" + }, + { + "uri":"evs_04_0050.html", + "product_code":"evs", + "code":"161", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"OpenStack Cinder API v1 (Deprecated)", + "title":"OpenStack Cinder API v1 (Deprecated)", + "githuburl":"" + }, + { + "uri":"evs_04_0051.html", + "product_code":"evs", + "code":"162", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"EVS Disk", + "title":"EVS Disk", + "githuburl":"" + }, + { + "uri":"evs_04_0052.html", + "product_code":"evs", + "code":"163", + "des":"This API is used to query details about a disk.This API has been deprecated. Use another API. For details, see Querying Details About a Disk.URI formatGET /v1/{project_id", + "doc_type":"api", + "kw":"Querying Details About a Disk (Deprecated),EVS Disk,API Reference", + "title":"Querying Details About a Disk (Deprecated)", + "githuburl":"" + }, + { + "uri":"evs_04_0022.html", + "product_code":"evs", + "code":"164", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Permissions Policies and Supported Actions", + "title":"Permissions Policies and Supported Actions", + "githuburl":"" + }, + { + "uri":"evs_04_0023.html", + "product_code":"evs", + "code":"165", + "des":"This chapter describes fine-grained permissions management for your EVS resources. If your account does not need individual IAM users, you can skip this chapter.By defaul", + "doc_type":"api", + "kw":"Introduction,Permissions Policies and Supported Actions,API Reference", + "title":"Introduction", + "githuburl":"" + }, + { + "uri":"evs_04_0024.html", + "product_code":"evs", + "code":"166", + "des":"This topic describes only the authorization information of EVS v2 APIs. For the v3 APIs that provide the same functions as their v2 APIs, their authorization information ", + "doc_type":"api", + "kw":"API Version Query,Permissions Policies and Supported Actions,API Reference", + "title":"API Version Query", + "githuburl":"" + }, + { + "uri":"evs_04_0025.html", + "product_code":"evs", + "code":"167", + "des":"This topic describes only the authorization information of EVS v2 APIs. For the v3 APIs that provide the same functions as their v2 APIs, their authorization information ", + "doc_type":"api", + "kw":"Disk,Permissions Policies and Supported Actions,API Reference", + "title":"Disk", + "githuburl":"" + }, + { + "uri":"evs_04_0026.html", + "product_code":"evs", + "code":"168", + "des":"This topic describes only the authorization information of EVS v2 APIs. For the v3 APIs that provide the same functions as their v2 APIs, their authorization information ", + "doc_type":"api", + "kw":"Disk Action,Permissions Policies and Supported Actions,API Reference", + "title":"Disk Action", + "githuburl":"" + }, + { + "uri":"evs_04_0027.html", + "product_code":"evs", + "code":"169", + "des":"This topic describes only the authorization information of EVS v2 APIs. For the v3 APIs that provide the same functions as their v2 APIs, their authorization information ", + "doc_type":"api", + "kw":"Snapshot,Permissions Policies and Supported Actions,API Reference", + "title":"Snapshot", + "githuburl":"" + }, + { + "uri":"evs_04_0028.html", + "product_code":"evs", + "code":"170", + "des":"This topic describes only the authorization information of EVS v2 APIs. For the v3 APIs that provide the same functions as their v2 APIs, their authorization information ", + "doc_type":"api", + "kw":"Tag,Permissions Policies and Supported Actions,API Reference", + "title":"Tag", + "githuburl":"" + }, + { + "uri":"evs_04_0029.html", + "product_code":"evs", + "code":"171", + "des":"This topic describes only the authorization information of EVS v2 APIs. For the v3 APIs that provide the same functions as their v2 APIs, their authorization information ", + "doc_type":"api", + "kw":"Disk Transfer,Permissions Policies and Supported Actions,API Reference", + "title":"Disk Transfer", + "githuburl":"" + }, + { + "uri":"evs_04_0037.html", + "product_code":"evs", + "code":"172", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Appendix", + "title":"Appendix", + "githuburl":"" + }, + { + "uri":"evs_04_0038.html", + "product_code":"evs", + "code":"173", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Error Codes,Appendix,API Reference", + "title":"Error Codes", + "githuburl":"" + }, + { + "uri":"evs_04_0039.html", + "product_code":"evs", + "code":"174", + "des":"NormalStatus CodeDescription200OK201Created202Accepted204No ContentAbnormalStatus CodeDescription400Bad Request401Unauthorized403Forbidden404Not Found405Method Not Allowe", + "doc_type":"api", + "kw":"Status Codes,Appendix,API Reference", + "title":"Status Codes", + "githuburl":"" + }, + { + "uri":"evs_04_0040.html", + "product_code":"evs", + "code":"175", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"EVS Disk Status,Appendix,API Reference", + "title":"EVS Disk Status", + "githuburl":"" + }, + { + "uri":"evs_04_0041.html", + "product_code":"evs", + "code":"176", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"EVS Snapshot Status,Appendix,API Reference", + "title":"EVS Snapshot Status", + "githuburl":"" + }, + { + "uri":"evs_04_0042.html", + "product_code":"evs", + "code":"177", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"EVS Replication Pair Status (Deprecated),Appendix,API Reference", + "title":"EVS Replication Pair Status (Deprecated)", + "githuburl":"" + }, + { + "uri":"evs_04_0043.html", + "product_code":"evs", + "code":"178", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Replication Consistency Group Status (Deprecated),Appendix,API Reference", + "title":"Replication Consistency Group Status (Deprecated)", + "githuburl":"" + }, + { + "uri":"evs_04_0044.html", + "product_code":"evs", + "code":"179", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Details of EVS Replication failure_detail Values (Deprecated),Appendix,API Reference", + "title":"Details of EVS Replication failure_detail Values (Deprecated)", + "githuburl":"" + }, + { + "uri":"evs_04_0045.html", + "product_code":"evs", + "code":"180", + "des":"This topic describes only the authorization information of EVS v2 APIs. For the v3 APIs that provide the same functions as their v2 APIs, their authorization information ", + "doc_type":"api", + "kw":"API Actions,Appendix,API Reference", + "title":"API Actions", + "githuburl":"" + }, + { + "uri":"evs_04_0048.html", + "product_code":"evs", + "code":"181", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Change History,API Reference", + "title":"Change History", + "githuburl":"" + } +] \ No newline at end of file diff --git a/docs/evs/api-ref/CLASS.TXT.json b/docs/evs/api-ref/CLASS.TXT.json new file mode 100644 index 000000000..4b59c946f --- /dev/null +++ b/docs/evs/api-ref/CLASS.TXT.json @@ -0,0 +1,1631 @@ +[ + { + "desc":"Public cloud Application Programming Interfaces (APIs) comply with the RESTful API design principles. REST-based Web services are organized into resources. Each resource ", + "product_code":"evs", + "title":"API Usage Guidelines", + "uri":"evs_04_0001.html", + "doc_type":"api", + "p_code":"", + "code":"1" + }, + { + "desc":"EVS APIs provide multiple versions. For the APIs offering same functions, you are recommended to use the v2 APIs.The current default microversion of v3 APIs is 3.0, and t", + "product_code":"evs", + "title":"API Version Description and Usage Instructions", + "uri":"evs_04_0018.html", + "doc_type":"api", + "p_code":"", + "code":"2" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"evs", + "title":"API Version Query", + "uri":"evs_04_0019.html", + "doc_type":"api", + "p_code":"", + "code":"3" + }, + { + "desc":"This API is used to query information of API versions.URI formatGET /GET /Example requestGET https://{endpoint}/Parameter descriptionParameterTypeDescriptionversionsArray", + "product_code":"evs", + "title":"Querying Information of API Versions", + "uri":"evs_04_0020.html", + "doc_type":"api", + "p_code":"3", + "code":"4" + }, + { + "desc":"This API is used to query information of an API version.URI formatGET /{api_version}GET /{api_version}Parameter descriptionParameterTypeDescriptionapi_versionStringSpecif", + "product_code":"evs", + "title":"Querying Information of an API Version", + "uri":"evs_04_0021.html", + "doc_type":"api", + "p_code":"3", + "code":"5" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"evs", + "title":"API v2 (Recommended)", + "uri":"evs_04_2001.html", + "doc_type":"api", + "p_code":"", + "code":"6" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"evs", + "title":"EVS Disk", + "uri":"evs_04_2002.html", + "doc_type":"api", + "p_code":"6", + "code":"7" + }, + { + "desc":"This API is used to create one or multiple EVS disks.URI formatPOST /v2/{project_id}/cloudvolumesPOST /v2/{project_id}/cloudvolumesParameter descriptionParameterMandatory", + "product_code":"evs", + "title":"Creating EVS Disks", + "uri":"evs_04_2013.html", + "doc_type":"api", + "p_code":"7", + "code":"8" + }, + { + "desc":"This API is used to query details about all disks.URI formatGET /v2/{project_id}/cloudvolumes/detailGET /v2/{project_id}/cloudvolumes/detailParameter descriptionParameter", + "product_code":"evs", + "title":"Querying Details About All Disks", + "uri":"evs_04_2005.html", + "doc_type":"api", + "p_code":"7", + "code":"9" + }, + { + "desc":"This API is used to delete an EVS disk.URI formatDELETE /v2/{project_id}/cloudvolumes/{volume_id}DELETE /v2/{project_id}/cloudvolumes/{volume_id}Parameter descriptionPara", + "product_code":"evs", + "title":"Deleting an EVS Disk", + "uri":"evs_04_2008.html", + "doc_type":"api", + "p_code":"7", + "code":"10" + }, + { + "desc":"This API is used to update the name and description of an EVS disk.This API has been deprecated. Use another API. For details, see Updating an EVS Disk.URI formatPUT /v2/", + "product_code":"evs", + "title":"Updating an EVS Disk (Deprecated)", + "uri":"evs_04_2009.html", + "doc_type":"api", + "p_code":"7", + "code":"11" + }, + { + "desc":"This API is used to query details about all disks.URI formatGET /v2/{project_id}/os-vendor-volumes/detailGET /v2/{project_id}/os-vendor-volumes/detailParameter descriptio", + "product_code":"evs", + "title":"Querying Details About All Disks (Deprecated)", + "uri":"evs_04_2010.html", + "doc_type":"api", + "p_code":"7", + "code":"12" + }, + { + "desc":"This API is used to query details about a disk.URI formatGET /v2/{project_id}/os-vendor-volumes/{volume_id}GET /v2/{project_id}/os-vendor-volumes/{volume_id}Parameter des", + "product_code":"evs", + "title":"Querying Details About a Disk", + "uri":"evs_04_2011.html", + "doc_type":"api", + "p_code":"7", + "code":"13" + }, + { + "desc":"This API is used to query EVS disks and display the query results in a list.This API has been deprecated. Use another API. For details, see Querying EVS Disks.URI formatG", + "product_code":"evs", + "title":"Querying EVS Disks (Deprecated)", + "uri":"evs_04_2012.html", + "doc_type":"api", + "p_code":"7", + "code":"14" + }, + { + "desc":"This API is used to expand the capacity of an EVS disk.If the status of the to-be-expanded disk is available, there are no restrictions.If the status of the to-be-expande", + "product_code":"evs", + "title":"Expanding Capacity of an EVS Disk (Deprecated)", + "uri":"evs_04_2014.html", + "doc_type":"api", + "p_code":"7", + "code":"15" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"evs", + "title":"EVS Snapshot", + "uri":"evs_04_2015.html", + "doc_type":"api", + "p_code":"6", + "code":"16" + }, + { + "desc":"This API is used to roll back a snapshot to an EVS disk.When you roll back a snapshot to a disk, you can only roll back the snapshot to the source disk. Rollback to a spe", + "product_code":"evs", + "title":"Rolling Back a Snapshot to an EVS Disk", + "uri":"evs_04_2022.html", + "doc_type":"api", + "p_code":"16", + "code":"17" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"evs", + "title":"EVS Tag", + "uri":"evs_04_2024.html", + "doc_type":"api", + "p_code":"6", + "code":"18" + }, + { + "desc":"This API is used to delete tags of an EVS resource by key.NoneURI formatDELETE /v2/{project_id}/os-vendor-tags/{resource_type}/{resource_id}/{key}DELETE /v2/{project_id}/", + "product_code":"evs", + "title":"Deleting Tags of an EVS Resource by Key", + "uri":"evs_04_2025.html", + "doc_type":"api", + "p_code":"18", + "code":"19" + }, + { + "desc":"This API is used to obtain all tags of an EVS resource type.NoneURI formatGET /v2/{project_id}/os-vendor-tags/{resource_type}GET /v2/{project_id}/os-vendor-tags/{resource", + "product_code":"evs", + "title":"Obtaining All Tags of an EVS Resource Type", + "uri":"evs_04_2026.html", + "doc_type":"api", + "p_code":"18", + "code":"20" + }, + { + "desc":"This API is used to batch add tags for the specified EVS disk.When adding tags, if a tag key is consistent with an existing one, the new tag will overwrite the existing t", + "product_code":"evs", + "title":"Batch Adding Tags for the Specified EVS Disk", + "uri":"evs_04_2027.html", + "doc_type":"api", + "p_code":"18", + "code":"21" + }, + { + "desc":"This API is used to batch delete tags for the specified EVS disk.NoneURI formatPOST /v2/{project_id}/os-vendor-volumes/{volume_id}/tags/actionPOST /v2/{project_id}/os-ven", + "product_code":"evs", + "title":"Batch Deleting Tags for the Specified EVS Disk", + "uri":"evs_04_2029.html", + "doc_type":"api", + "p_code":"18", + "code":"22" + }, + { + "desc":"This API is used to query the tags of the specified EVS disk.NoneURI formatGET /v2/{project_id}/os-vendor-volumes/{volume_id}/tagsGET /v2/{project_id}/os-vendor-volumes/{", + "product_code":"evs", + "title":"Querying Tags of an EVS Disk", + "uri":"evs_04_2031.html", + "doc_type":"api", + "p_code":"18", + "code":"23" + }, + { + "desc":"This API is used to query the number of EVS disks by tag.NoneURI formatPOST /v2/{project_id}/os-vendor-volumes/resource_instances/actionPOST /v2/{project_id}/os-vendor-vo", + "product_code":"evs", + "title":"Querying the Number of EVS Disks by Tag", + "uri":"evs_04_2032.html", + "doc_type":"api", + "p_code":"18", + "code":"24" + }, + { + "desc":"This API is used to query the details of EVS disks by tag.NoneURI formatPOST /v2/{project_id}/os-vendor-volumes/resource_instances/actionPOST /v2/{project_id}/os-vendor-v", + "product_code":"evs", + "title":"Querying Details of EVS Disks by Tag", + "uri":"evs_04_2034.html", + "doc_type":"api", + "p_code":"18", + "code":"25" + }, + { + "desc":"This API is used to add or update tags for an EVS resource.This API has been deprecated. Use another API. For details, see Batch Adding Tags for the Specified EVS Disk.A ", + "product_code":"evs", + "title":"Adding or Updating Tags for an EVS Resource (Deprecated)", + "uri":"evs_04_2036.html", + "doc_type":"api", + "p_code":"18", + "code":"26" + }, + { + "desc":"This API is used to batch delete tags for an EVS resource.This API has been deprecated. Use another API. For details, see Batch Deleting Tags for the Specified EVS Disk.N", + "product_code":"evs", + "title":"Batch Deleting Tags for an EVS Resource (Deprecated)", + "uri":"evs_04_2037.html", + "doc_type":"api", + "p_code":"18", + "code":"27" + }, + { + "desc":"This API is used to obtain the tags of a specified EVS resource.This API has been deprecated. Use another API. For details, see Querying Tags of an EVS Disk.NoneURI forma", + "product_code":"evs", + "title":"Obtaining Tags of a Specified EVS Resource (Deprecated)", + "uri":"evs_04_2038.html", + "doc_type":"api", + "p_code":"18", + "code":"28" + }, + { + "desc":"This API is used to query tags of an EVS resource by key.This API has been deprecated. Use another API. For details, see Querying Tags of an EVS Disk.NoneURI formatGET /v", + "product_code":"evs", + "title":"Querying Tags of an EVS Resource by Key (Deprecated)", + "uri":"evs_04_2039.html", + "doc_type":"api", + "p_code":"18", + "code":"29" + }, + { + "desc":"This API is used to reset the tags of an EVS resource, and the existing tags will be deleted.This API call exists for compatibility reasons only and has been deprecated.A", + "product_code":"evs", + "title":"Resetting Tags of an EVS Resource (Deprecated)", + "uri":"evs_04_2040.html", + "doc_type":"api", + "p_code":"18", + "code":"30" + }, + { + "desc":"This API is used to update tags of an EVS resource by key.This API has been deprecated. Use another API. For details, see Batch Adding Tags for the Specified EVS Disk.A t", + "product_code":"evs", + "title":"Updating Tags of an EVS Resource by Key (Deprecated)", + "uri":"evs_04_2041.html", + "doc_type":"api", + "p_code":"18", + "code":"31" + }, + { + "desc":"This API is used to query the EVS resources by tag.This API has been deprecated. Use another API. For details, see Querying Details of EVS Disks by Tag.NoneURI formatGET ", + "product_code":"evs", + "title":"Querying EVS Resources by Tag (Deprecated)", + "uri":"evs_04_2042.html", + "doc_type":"api", + "p_code":"18", + "code":"32" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"evs", + "title":"EVS Replication Pair (Deprecated)", + "uri":"evs_04_2043.html", + "doc_type":"api", + "p_code":"6", + "code":"33" + }, + { + "desc":"This API is used to create an EVS replication pair using a specified production disk and a disaster recovery (DR) disk. The production disk is in the primary AZ, and the ", + "product_code":"evs", + "title":"Creating an EVS Replication Pair (Deprecated)", + "uri":"evs_04_2044.html", + "doc_type":"api", + "p_code":"33", + "code":"34" + }, + { + "desc":"This API is used to delete a specified EVS replication pair.This API has been deprecated. To use this function, see Storage Disaster Recovery Service API Reference.The to", + "product_code":"evs", + "title":"Deleting an EVS Replication Pair (Deprecated)", + "uri":"evs_04_2045.html", + "doc_type":"api", + "p_code":"33", + "code":"35" + }, + { + "desc":"This API is used to query all EVS replication pairs of the current tenant.This API has been deprecated. To use this function, see Storage Disaster Recovery Service API Re", + "product_code":"evs", + "title":"Querying All EVS Replication Pairs (Deprecated)", + "uri":"evs_04_2046.html", + "doc_type":"api", + "p_code":"33", + "code":"36" + }, + { + "desc":"This API is used to query the details about an EVS replication pair, including the name, ID, and status of the replication pair.This API has been deprecated. To use this ", + "product_code":"evs", + "title":"Querying Details About an EVS Replication Pair (Deprecated)", + "uri":"evs_04_2047.html", + "doc_type":"api", + "p_code":"33", + "code":"37" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"evs", + "title":"Replication Consistency Group (Deprecated)", + "uri":"evs_04_2048.html", + "doc_type":"api", + "p_code":"6", + "code":"38" + }, + { + "desc":"This API is used to create a replication consistency group for the specified EVS replication pairs.This API has been deprecated. To use this function, see Storage Disaste", + "product_code":"evs", + "title":"Creating a Replication Consistency Group (Deprecated)", + "uri":"evs_04_2049.html", + "doc_type":"api", + "p_code":"38", + "code":"39" + }, + { + "desc":"This API is used to delete a replication consistency group.This API has been deprecated. To use this function, see Storage Disaster Recovery Service API Reference.All EVS", + "product_code":"evs", + "title":"Deleting a Replication Consistency Group (Deprecated)", + "uri":"evs_04_2050.html", + "doc_type":"api", + "p_code":"38", + "code":"40" + }, + { + "desc":"This API is used to query all replication consistency groups of the current tenant.This API has been deprecated. To use this function, see Storage Disaster Recovery Servi", + "product_code":"evs", + "title":"Querying All Replication Consistency Groups (Deprecated)", + "uri":"evs_04_2051.html", + "doc_type":"api", + "p_code":"38", + "code":"41" + }, + { + "desc":"This API is used to query the details about a replication consistency group, including the name, ID, and status of the consistency group.This API has been deprecated. To ", + "product_code":"evs", + "title":"Querying Details About a Replication Consistency Group (Deprecated)", + "uri":"evs_04_2052.html", + "doc_type":"api", + "p_code":"38", + "code":"42" + }, + { + "desc":"This API is used to update a replication consistency group. An update includes the following operations:Update the name or description of the replication consistency grou", + "product_code":"evs", + "title":"Updating a Replication Consistency Group (Deprecated)", + "uri":"evs_04_2053.html", + "doc_type":"api", + "p_code":"38", + "code":"43" + }, + { + "desc":"This API is used to perform a failover for a replication consistency group. When an exception occurs in the primary AZ, a failover can be performed to change the primary ", + "product_code":"evs", + "title":"Performing a Failover for a Replication Consistency Group (Deprecated)", + "uri":"evs_04_2054.html", + "doc_type":"api", + "p_code":"38", + "code":"44" + }, + { + "desc":"This API is used to synchronize the data between production disks and DR disks in all EVS replication pairs of a replication consistency group. After the synchronization ", + "product_code":"evs", + "title":"Synchronizing a Replication Consistency Group (Deprecated)", + "uri":"evs_04_2055.html", + "doc_type":"api", + "p_code":"38", + "code":"45" + }, + { + "desc":"This API is used to perform a primary/secondary switchover for a replication consistency group. A switchover can be performed to switch the primary and secondary AZs of a", + "product_code":"evs", + "title":"Performing a Primary/Secondary Switchover for a Replication Consistency Group (Deprecated)", + "uri":"evs_04_2056.html", + "doc_type":"api", + "p_code":"38", + "code":"46" + }, + { + "desc":"This API is used to pause a replication consistency group, that is, to pause the data synchronization in all EVS replication pairs of a replication consistency group.Befo", + "product_code":"evs", + "title":"Pausing a Replication Consistency Group (Deprecated)", + "uri":"evs_04_2057.html", + "doc_type":"api", + "p_code":"38", + "code":"47" + }, + { + "desc":"This API is used to reprotect a replication consistency group. After resources in a faulty AZ have been restored and functioned as DR resources, a reprotection can be per", + "product_code":"evs", + "title":"Reprotecting a Replication Consistency Group (Deprecated)", + "uri":"evs_04_2058.html", + "doc_type":"api", + "p_code":"38", + "code":"48" + }, + { + "desc":"This API is used to expand the EVS disks in one or multiple EVS replication pairs. In such an expansion operation, two EVS disks in one EVS replication pair are expanded ", + "product_code":"evs", + "title":"Expanding EVS Disks in a Replication Consistency Group (Deprecated)", + "uri":"evs_04_2059.html", + "doc_type":"api", + "p_code":"38", + "code":"49" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"evs", + "title":"OpenStack Cinder API v2 (Recommended)", + "uri":"evs_04_2063.html", + "doc_type":"api", + "p_code":"", + "code":"50" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"evs", + "title":"EVS Disk", + "uri":"evs_04_2064.html", + "doc_type":"api", + "p_code":"50", + "code":"51" + }, + { + "desc":"This API is used to create one or multiple EVS disks.URI formatPOST /v2/{project_id}/volumesPOST /v2/{project_id}/volumesParameter descriptionParameterMandatoryDescriptio", + "product_code":"evs", + "title":"Creating EVS Disks", + "uri":"evs_04_2065.html", + "doc_type":"api", + "p_code":"51", + "code":"52" + }, + { + "desc":"This API is used to delete an EVS disk.URI formatDELETE /v2/{project_id}/volumes/{volume_id}DELETE /v2/{project_id}/volumes/{volume_id}Parameter descriptionParameterManda", + "product_code":"evs", + "title":"Deleting an EVS Disk", + "uri":"evs_04_2066.html", + "doc_type":"api", + "p_code":"51", + "code":"53" + }, + { + "desc":"This API is used to update the EVS disk information.URI formatPUT /v2/{project_id}/volumes/{volume_id}PUT /v2/{project_id}/volumes/{volume_id}Parameter descriptionParamet", + "product_code":"evs", + "title":"Updating an EVS Disk", + "uri":"evs_04_2067.html", + "doc_type":"api", + "p_code":"51", + "code":"54" + }, + { + "desc":"This API is used to query EVS disks.URI formatGET /v2/{project_id}/volumesGET /v2/{project_id}/volumesParameter descriptionParameterMandatoryDescriptionproject_idYesSpeci", + "product_code":"evs", + "title":"Querying EVS Disks", + "uri":"evs_04_2068.html", + "doc_type":"api", + "p_code":"51", + "code":"55" + }, + { + "desc":"This API is used to query details about all disks.URI formatGET /v2/{project_id}/volumes/detailGET /v2/{project_id}/volumes/detailParameter descriptionParameterMandatoryD", + "product_code":"evs", + "title":"Querying Details About All Disks", + "uri":"evs_04_2069.html", + "doc_type":"api", + "p_code":"51", + "code":"56" + }, + { + "desc":"This API is used to query details about a disk.URI formatGET /v2/{project_id}/volumes/{volume_id}GET /v2/{project_id}/volumes/{volume_id}Parameter descriptionParameterMan", + "product_code":"evs", + "title":"Querying Details About a Disk", + "uri":"evs_04_2070.html", + "doc_type":"api", + "p_code":"51", + "code":"57" + }, + { + "desc":"This API is used to query EVS disk types and display the query results in a list.URI formatGET /v2/{project_id}/typesGET /v2/{project_id}/typesParameter descriptionParame", + "product_code":"evs", + "title":"Querying EVS Disk Types", + "uri":"evs_04_2071.html", + "doc_type":"api", + "p_code":"51", + "code":"58" + }, + { + "desc":"This API is used to query details about an EVS disk type.URI formatGET /v2/{project_id}/types/{type_id}GET /v2/{project_id}/types/{type_id}Parameter descriptionParameterM", + "product_code":"evs", + "title":"Querying Details About an EVS Disk Type", + "uri":"evs_04_2072.html", + "doc_type":"api", + "p_code":"51", + "code":"59" + }, + { + "desc":"This API is used to query the details of tenant quotas.URI formatGET /v2/{project_id}/os-quota-sets/{target_project_id}?usage=TrueGET /v2/{project_id}/os-quota-sets/{targ", + "product_code":"evs", + "title":"Querying Details of Tenant Quotas", + "uri":"evs_04_2073.html", + "doc_type":"api", + "p_code":"51", + "code":"60" + }, + { + "desc":"This API is used to add or update the metadata of an EVS disk.URI formatPOST /v2/{project_id}/volumes/{volume_id}/metadataPOST /v2/{project_id}/volumes/{volume_id}/metada", + "product_code":"evs", + "title":"Adding Metadata of an EVS Disk", + "uri":"evs_04_2074.html", + "doc_type":"api", + "p_code":"51", + "code":"61" + }, + { + "desc":"This API is used to query the metadata of an EVS disk.URI formatGET /v2/{project_id}/volumes/{volume_id}/metadataGET /v2/{project_id}/volumes/{volume_id}/metadataParamete", + "product_code":"evs", + "title":"Querying Metadata of an EVS Disk", + "uri":"evs_04_2075.html", + "doc_type":"api", + "p_code":"51", + "code":"62" + }, + { + "desc":"This API is used to update the metadata of an EVS disk.URI formatPUT /v2/{project_id}/volumes/{volume_id}/metadataPUT /v2/{project_id}/volumes/{volume_id}/metadataParamet", + "product_code":"evs", + "title":"Updating Metadata of an EVS Disk", + "uri":"evs_04_2076.html", + "doc_type":"api", + "p_code":"51", + "code":"63" + }, + { + "desc":"This API is used to query one piece of the EVS disk metadata.URI formatGET /v2/{project_id}/volumes/{volume_id}/metadata/{key}GET /v2/{project_id}/volumes/{volume_id}/met", + "product_code":"evs", + "title":"Querying One Piece of Metadata for an EVS Disk", + "uri":"evs_04_2077.html", + "doc_type":"api", + "p_code":"51", + "code":"64" + }, + { + "desc":"This API is used to update one piece of the EVS disk metadata.URI formatPUT /v2/{project_id}/volumes/{volume_id}/metadata/{key}PUT /v2/{project_id}/volumes/{volume_id}/me", + "product_code":"evs", + "title":"Updating One Piece of Metadata for an EVS Disk", + "uri":"evs_04_2078.html", + "doc_type":"api", + "p_code":"51", + "code":"65" + }, + { + "desc":"This API is used to delete one piece of the EVS disk metadata.URI formatDELETE /v2/{project_id}/volumes/{volume_id}/metadata/{key}DELETE /v2/{project_id}/volumes/{volume_", + "product_code":"evs", + "title":"Deleting One Piece of Metadata for an EVS Disk", + "uri":"evs_04_2079.html", + "doc_type":"api", + "p_code":"51", + "code":"66" + }, + { + "desc":"This API is used to query extension APIs.URI formatGET /v2/{project_id}/extensionsGET /v2/{project_id}/extensionsParameter descriptionParameterMandatoryDescriptionproject", + "product_code":"evs", + "title":"Querying Extension APIs", + "uri":"evs_04_2080.html", + "doc_type":"api", + "p_code":"51", + "code":"67" + }, + { + "desc":"This API is used to query all AZs.URI formatGET /v2/{project_id}/os-availability-zoneGET /v2/{project_id}/os-availability-zoneParameter descriptionParameterMandatoryDescr", + "product_code":"evs", + "title":"Querying All AZs", + "uri":"evs_04_2081.html", + "doc_type":"api", + "p_code":"51", + "code":"68" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"evs", + "title":"EVS Disk Actions", + "uri":"evs_04_2082.html", + "doc_type":"api", + "p_code":"50", + "code":"69" + }, + { + "desc":"This API is used to expand the capacity of an EVS disk.If the status of the to-be-expanded disk is available, there are no restrictions.If the status of the to-be-expande", + "product_code":"evs", + "title":"Expanding Capacity of an EVS Disk", + "uri":"evs_04_2083.html", + "doc_type":"api", + "p_code":"69", + "code":"70" + }, + { + "desc":"This API is used to set the bootable flag for an EVS disk.A data disk cannot be used as system disk for an ECS even if this API has been called to set the bootable flag f", + "product_code":"evs", + "title":"Setting Bootable Flag for an EVS Disk", + "uri":"evs_04_2084.html", + "doc_type":"api", + "p_code":"69", + "code":"71" + }, + { + "desc":"This API is used to set the read-only flag for the EVS disk.URI formatPOST /v2/{project_id}/volumes/{volume_id}/actionPOST /v2/{project_id}/volumes/{volume_id}/actionPara", + "product_code":"evs", + "title":"Setting Read-Only Flag for an EVS Disk", + "uri":"evs_04_2085.html", + "doc_type":"api", + "p_code":"69", + "code":"72" + }, + { + "desc":"This API is used to export the system disk data or data disk data as an IMS image. The exported image will be displayed in the IMS private image list and can be viewed an", + "product_code":"evs", + "title":"Exporting EVS Disk Data as an Image", + "uri":"evs_04_2086.html", + "doc_type":"api", + "p_code":"69", + "code":"73" + }, + { + "desc":"This API is only used to change the EVS disk status from available to in-use.This API call exists for compatibility reasons only and is not meant to be used.Do not call t", + "product_code":"evs", + "title":"Attaching an EVS Disk (Deprecated)", + "uri":"evs_04_2087.html", + "doc_type":"api", + "p_code":"69", + "code":"74" + }, + { + "desc":"This API is only used to change the EVS disk status from in-use to available.This API call exists for compatibility reasons only and is not meant to be used.Do not call t", + "product_code":"evs", + "title":"Detaching an EVS Disk (Deprecated)", + "uri":"evs_04_2088.html", + "doc_type":"api", + "p_code":"69", + "code":"75" + }, + { + "desc":"This API is used to reserve an EVS disk.This API call exists for compatibility reasons only and is not meant to be used.URI formatPOST /v2/{project_id}/volumes/{volume_id", + "product_code":"evs", + "title":"Reserving an EVS Disk (Deprecated)", + "uri":"evs_04_2089.html", + "doc_type":"api", + "p_code":"69", + "code":"76" + }, + { + "desc":"This API is used to cancel the reservation of an EVS disk.This API call exists for compatibility reasons only and is not meant to be used.URI formatPOST /v2/{project_id}/", + "product_code":"evs", + "title":"Canceling Reservation of an EVS Disk (Deprecated)", + "uri":"evs_04_2090.html", + "doc_type":"api", + "p_code":"69", + "code":"77" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"evs", + "title":"EVS Snapshot", + "uri":"evs_04_2092.html", + "doc_type":"api", + "p_code":"50", + "code":"78" + }, + { + "desc":"This API is used to create an EVS snapshot.URI formatPOST /v2/{project_id}/snapshotsPOST /v2/{project_id}/snapshotsParameter descriptionParameterMandatoryDescriptionproje", + "product_code":"evs", + "title":"Creating an EVS Snapshot", + "uri":"evs_04_2093.html", + "doc_type":"api", + "p_code":"78", + "code":"79" + }, + { + "desc":"This API is used to delete an EVS snapshot.A snapshot can be deleted only when it is in the available or error state.URI formatDELETE /v2/{project_id}/snapshots/{snapshot", + "product_code":"evs", + "title":"Deleting an EVS Snapshot", + "uri":"evs_04_2094.html", + "doc_type":"api", + "p_code":"78", + "code":"80" + }, + { + "desc":"This API is used to update an EVS snapshot.URI formatPUT /v2/{project_id}/snapshots/{snapshot_id}PUT /v2/{project_id}/snapshots/{snapshot_id}Parameter descriptionParamete", + "product_code":"evs", + "title":"Updating an EVS Snapshot", + "uri":"evs_04_2095.html", + "doc_type":"api", + "p_code":"78", + "code":"81" + }, + { + "desc":"This API is used to query the EVS snapshots.URI formatGET /v2/{project_id}/snapshotsGET /v2/{project_id}/snapshotsParameter descriptionParameterMandatoryDescriptionprojec", + "product_code":"evs", + "title":"Querying EVS Snapshots", + "uri":"evs_04_2096.html", + "doc_type":"api", + "p_code":"78", + "code":"82" + }, + { + "desc":"This API is used to query details about the EVS snapshots.URI formatGET /v2/{project_id}/snapshots/detailGET /v2/{project_id}/snapshots/detailParameter descriptionParamet", + "product_code":"evs", + "title":"Querying Details About EVS Snapshots", + "uri":"evs_04_2097.html", + "doc_type":"api", + "p_code":"78", + "code":"83" + }, + { + "desc":"This API is used to query details about an EVS snapshot.URI formatGET /v2/{project_id}/snapshots/{snapshot_id}GET /v2/{project_id}/snapshots/{snapshot_id}Parameter descri", + "product_code":"evs", + "title":"Querying Details About an EVS Snapshot", + "uri":"evs_04_2098.html", + "doc_type":"api", + "p_code":"78", + "code":"84" + }, + { + "desc":"This API is used to add the metadata of an EVS snapshot.URI formatPOST /v2/{project_id}/snapshots/{snapshot_id}/metadataPOST /v2/{project_id}/snapshots/{snapshot_id}/meta", + "product_code":"evs", + "title":"Adding Metadata of an EVS Snapshot", + "uri":"evs_04_2099.html", + "doc_type":"api", + "p_code":"78", + "code":"85" + }, + { + "desc":"This API is used to query the metadata of an EVS snapshot.URI formatGET /v2/{project_id}/snapshots/{snapshot_id}/metadataGET /v2/{project_id}/snapshots/{snapshot_id}/meta", + "product_code":"evs", + "title":"Querying Metadata of an EVS Snapshot", + "uri":"evs_04_2100.html", + "doc_type":"api", + "p_code":"78", + "code":"86" + }, + { + "desc":"This API is used to update one piece of the EVS snapshot metadata.URI formatPUT /v2/{project_id}/snapshots/{snapshot_id}/metadata/{key}PUT /v2/{project_id}/snapshots/{sna", + "product_code":"evs", + "title":"Updating One Piece of Metadata for an EVS Snapshot", + "uri":"evs_04_2101.html", + "doc_type":"api", + "p_code":"78", + "code":"87" + }, + { + "desc":"This API is used to update the metadata of an EVS snapshot.URI formatPUT /v2/{project_id}/snapshots/{snapshot_id}/metadataPUT /v2/{project_id}/snapshots/{snapshot_id}/met", + "product_code":"evs", + "title":"Updating Metadata of an EVS Snapshot", + "uri":"evs_04_2102.html", + "doc_type":"api", + "p_code":"78", + "code":"88" + }, + { + "desc":"This API is used to query one piece of the EVS snapshot metadata.URI formatGET /v2/{project_id}/snapshots/{snapshot_id}/metadata/{key}GET /v2/{project_id}/snapshots/{snap", + "product_code":"evs", + "title":"Querying One Piece of Metadata for an EVS Snapshot", + "uri":"evs_04_2103.html", + "doc_type":"api", + "p_code":"78", + "code":"89" + }, + { + "desc":"This API is used to delete one piece of the EVS snapshot metadata.URI formatDELETE /v2/{project_id}/snapshots/{snapshot_id}/metadata/{key}DELETE /v2/{project_id}/snapshot", + "product_code":"evs", + "title":"Deleting One Piece of Metadata for an EVS Snapshot", + "uri":"evs_04_2104.html", + "doc_type":"api", + "p_code":"78", + "code":"90" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"evs", + "title":"EVS Disk Transfer", + "uri":"evs_04_2105.html", + "doc_type":"api", + "p_code":"50", + "code":"91" + }, + { + "desc":"This API is used to create a disk transfer. After the transfer has been created, a transfer ID and an authentication key are returned.After a disk transfer is created, th", + "product_code":"evs", + "title":"Creating a Disk Transfer", + "uri":"evs_04_2106.html", + "doc_type":"api", + "p_code":"91", + "code":"92" + }, + { + "desc":"This API is used to accept a disk transfer through the transfer ID and authentication key.Encrypted EVS disks cannot be transferred.EVS disks with backups and snapshots a", + "product_code":"evs", + "title":"Accepting a Disk Transfer", + "uri":"evs_04_2107.html", + "doc_type":"api", + "p_code":"91", + "code":"93" + }, + { + "desc":"This API is used to delete a disk transfer. A disk transfer can be deleted if it is not accepted. Accepted disk transfers cannot be deleted.URI formatDELETE /v2/{project_", + "product_code":"evs", + "title":"Deleting a Disk Transfer", + "uri":"evs_04_2108.html", + "doc_type":"api", + "p_code":"91", + "code":"94" + }, + { + "desc":"This API is used to query the details of a disk transfer, including the transfer creation time, transfer ID, and transfer name.URI formatGET /v2/{project_id}/os-volume-tr", + "product_code":"evs", + "title":"Querying Details of a Disk Transfer", + "uri":"evs_04_2109.html", + "doc_type":"api", + "p_code":"91", + "code":"95" + }, + { + "desc":"This API is used to query all disk transfers of the current tenant.URI formatGET /v2/{project_id}/os-volume-transferGET /v2/{project_id}/os-volume-transferParameter descr", + "product_code":"evs", + "title":"Querying All Disk Transfers", + "uri":"evs_04_2110.html", + "doc_type":"api", + "p_code":"91", + "code":"96" + }, + { + "desc":"This API is used to query the details of all disk transfers, including the transfer creation time, transfer IDs, and transfer names.URI formatGET /v2/{project_id}/os-volu", + "product_code":"evs", + "title":"Querying Details of All Disk Transfers", + "uri":"evs_04_2111.html", + "doc_type":"api", + "p_code":"91", + "code":"97" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"evs", + "title":"Unrecommended APIs", + "uri":"evs_04_0063.html", + "doc_type":"api", + "p_code":"", + "code":"98" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"evs", + "title":"API v3", + "uri":"evs_04_3001.html", + "doc_type":"api", + "p_code":"98", + "code":"99" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"evs", + "title":"EVS Disk", + "uri":"evs_04_3002.html", + "doc_type":"api", + "p_code":"99", + "code":"100" + }, + { + "desc":"This API is used to create one or multiple EVS disks.URI formatPOST /v3/{project_id}/cloudvolumesPOST /v3/{project_id}/cloudvolumesParameter descriptionParameterMandatory", + "product_code":"evs", + "title":"Creating EVS Disks", + "uri":"evs_04_3003.html", + "doc_type":"api", + "p_code":"100", + "code":"101" + }, + { + "desc":"This API is used to query details about all disks.URI formatGET /v3/{project_id}/os-vendor-volumes/detailGET /v3/{project_id}/os-vendor-volumes/detailParameter descriptio", + "product_code":"evs", + "title":"Querying Details About All EVS Disks (Deprecated)", + "uri":"evs_04_3004.html", + "doc_type":"api", + "p_code":"100", + "code":"102" + }, + { + "desc":"This API is used to query details about a disk.URI formatGET /v3/{project_id}/os-vendor-volumes/{volume_id}GET /v3/{project_id}/os-vendor-volumes/{volume_id}Parameter des", + "product_code":"evs", + "title":"Querying Details About an EVS Disk (Deprecated)", + "uri":"evs_04_3005.html", + "doc_type":"api", + "p_code":"100", + "code":"103" + }, + { + "desc":"This API is used to query the loading progress of a lazyloading disk.URI formatGET /v3/{project_id}/os-vendor-volumes/{volume_id}/internal-infoGET /v3/{project_id}/os-ven", + "product_code":"evs", + "title":"Querying Loading Progress of a Lazyloading Disk", + "uri":"evs_04_3006.html", + "doc_type":"api", + "p_code":"100", + "code":"104" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"evs", + "title":"EVS Snapshot", + "uri":"evs_04_3007.html", + "doc_type":"api", + "p_code":"99", + "code":"105" + }, + { + "desc":"This API is used to roll back a snapshot to an EVS disk.When you roll back a snapshot to a disk, you can only roll back the snapshot to the source disk. Rollback to a spe", + "product_code":"evs", + "title":"Rolling Back a Snapshot to an EVS Disk", + "uri":"evs_04_3008.html", + "doc_type":"api", + "p_code":"105", + "code":"106" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"evs", + "title":"EVS Tag", + "uri":"evs_04_3010.html", + "doc_type":"api", + "p_code":"99", + "code":"107" + }, + { + "desc":"This API is used to batch add tags for the specified EVS disk.When adding tags, if a tag key is consistent with an existing one, the new tag will overwrite the existing t", + "product_code":"evs", + "title":"Batch Adding Tags for the Specified EVS Disk", + "uri":"evs_04_3011.html", + "doc_type":"api", + "p_code":"107", + "code":"108" + }, + { + "desc":"This API is used to batch delete tags for the specified EVS disk.NoneURI formatPOST /v3/{project_id}/os-vendor-volumes/{volume_id}/tags/actionPOST /v3/{project_id}/os-ven", + "product_code":"evs", + "title":"Batch Deleting Tags for the Specified EVS Disk", + "uri":"evs_04_3013.html", + "doc_type":"api", + "p_code":"107", + "code":"109" + }, + { + "desc":"This API is used to query the tags of the specified EVS disk.NoneURI formatGET /v3/{project_id}/os-vendor-volumes/{volume_id}/tagsGET /v3/{project_id}/os-vendor-volumes/{", + "product_code":"evs", + "title":"Querying Tags of an EVS Disk", + "uri":"evs_04_3015.html", + "doc_type":"api", + "p_code":"107", + "code":"110" + }, + { + "desc":"This API is used to query the number of EVS disks by tag.NoneURI formatPOST /v3/{project_id}/os-vendor-volumes/resource_instances/actionPOST /v3/{project_id}/os-vendor-vo", + "product_code":"evs", + "title":"Querying the Number of EVS Disks by Tag", + "uri":"evs_04_3016.html", + "doc_type":"api", + "p_code":"107", + "code":"111" + }, + { + "desc":"This API is used to query the details of EVS disks by tag.NoneURI formatPOST /v3/{project_id}/os-vendor-volumes/resource_instances/actionPOST /v3/{project_id}/os-vendor-v", + "product_code":"evs", + "title":"Querying Details of EVS Disks by Tag", + "uri":"evs_04_3018.html", + "doc_type":"api", + "p_code":"107", + "code":"112" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"evs", + "title":"OpenStack Cinder API v3", + "uri":"evs_04_3027.html", + "doc_type":"api", + "p_code":"98", + "code":"113" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"evs", + "title":"EVS Disk", + "uri":"evs_04_3028.html", + "doc_type":"api", + "p_code":"113", + "code":"114" + }, + { + "desc":"This API is used to create one or multiple EVS disks.URI formatPOST /v3/{project_id}/volumesPOST /v3/{project_id}/volumesParameter descriptionParameterMandatoryDescriptio", + "product_code":"evs", + "title":"Creating EVS Disks", + "uri":"evs_04_3029.html", + "doc_type":"api", + "p_code":"114", + "code":"115" + }, + { + "desc":"This API is used to delete an EVS disk.URI formatDELETE /v3/{project_id}/volumes/{volume_id}DELETE /v3/{project_id}/volumes/{volume_id}Parameter descriptionParameterManda", + "product_code":"evs", + "title":"Deleting an EVS Disk", + "uri":"evs_04_3030.html", + "doc_type":"api", + "p_code":"114", + "code":"116" + }, + { + "desc":"This API is used to update the EVS disk information.URI formatPUT /v3/{project_id}/volumes/{volume_id}PUT /v3/{project_id}/volumes/{volume_id}Parameter descriptionParamet", + "product_code":"evs", + "title":"Updating an EVS Disk", + "uri":"evs_04_3031.html", + "doc_type":"api", + "p_code":"114", + "code":"117" + }, + { + "desc":"This API is used to query EVS disks.URI formatGET /v3/{project_id}/volumesGET /v3/{project_id}/volumesParameter descriptionParameterMandatoryDescriptionproject_idYesSpeci", + "product_code":"evs", + "title":"Querying EVS Disks", + "uri":"evs_04_3032.html", + "doc_type":"api", + "p_code":"114", + "code":"118" + }, + { + "desc":"This API is used to query details about all disks.URI formatGET /v3/{project_id}/volumes/detailGET /v3/{project_id}/volumes/detailParameter descriptionParameterMandatoryD", + "product_code":"evs", + "title":"Querying Details About All Disks", + "uri":"evs_04_3033.html", + "doc_type":"api", + "p_code":"114", + "code":"119" + }, + { + "desc":"This API is used to query details about a disk.URI formatGET /v3/{project_id}/volumes/{volume_id}GET /v3/{project_id}/volumes/{volume_id}Parameter descriptionParameterMan", + "product_code":"evs", + "title":"Querying Details About a Disk", + "uri":"evs_04_3034.html", + "doc_type":"api", + "p_code":"114", + "code":"120" + }, + { + "desc":"This API is used to query EVS disk types and display the query results in a list.URI formatGET /v3/{project_id}/typesGET /v3/{project_id}/typesParameter descriptionParame", + "product_code":"evs", + "title":"Querying EVS Disk Types", + "uri":"evs_04_3035.html", + "doc_type":"api", + "p_code":"114", + "code":"121" + }, + { + "desc":"This API is used to query details about an EVS disk type.URI formatGET /v3/{project_id}/types/{type_id}GET /v3/{project_id}/types/{type_id}Parameter descriptionParameterM", + "product_code":"evs", + "title":"Querying Details About an EVS Disk Type", + "uri":"evs_04_3036.html", + "doc_type":"api", + "p_code":"114", + "code":"122" + }, + { + "desc":"This API is used to query the details of tenant quotas.URI formatGET /v3/{project_id}/os-quota-sets/{target_project_id}?usage=TrueGET /v3/{project_id}/os-quota-sets/{targ", + "product_code":"evs", + "title":"Querying Details of Tenant Quotas", + "uri":"evs_04_3037.html", + "doc_type":"api", + "p_code":"114", + "code":"123" + }, + { + "desc":"This API is used to add or update the metadata of an EVS disk.URI formatPOST /v3/{project_id}/volumes/{volume_id}/metadataPOST /v3/{project_id}/volumes/{volume_id}/metada", + "product_code":"evs", + "title":"Adding Metadata of an EVS Disk", + "uri":"evs_04_3038.html", + "doc_type":"api", + "p_code":"114", + "code":"124" + }, + { + "desc":"This API is used to query the metadata of an EVS disk.URI formatGET /v3/{project_id}/volumes/{volume_id}/metadataGET /v3/{project_id}/volumes/{volume_id}/metadataParamete", + "product_code":"evs", + "title":"Querying Metadata of an EVS Disk", + "uri":"evs_04_3039.html", + "doc_type":"api", + "p_code":"114", + "code":"125" + }, + { + "desc":"This API is used to update the metadata of an EVS disk.URI formatPUT /v3/{project_id}/volumes/{volume_id}/metadataPUT /v3/{project_id}/volumes/{volume_id}/metadataParamet", + "product_code":"evs", + "title":"Updating Metadata of an EVS Disk", + "uri":"evs_04_3040.html", + "doc_type":"api", + "p_code":"114", + "code":"126" + }, + { + "desc":"This API is used to query one piece of the EVS disk metadata.URI formatGET /v3/{project_id}/volumes/{volume_id}/metadata/{key}GET /v3/{project_id}/volumes/{volume_id}/met", + "product_code":"evs", + "title":"Querying One Piece of Metadata for an EVS Disk", + "uri":"evs_04_3041.html", + "doc_type":"api", + "p_code":"114", + "code":"127" + }, + { + "desc":"This API is used to update one piece of the EVS disk metadata.URI formatPUT /v3/{project_id}/volumes/{volume_id}/metadata/{key}PUT /v3/{project_id}/volumes/{volume_id}/me", + "product_code":"evs", + "title":"Updating One Piece of Metadata for an EVS Disk", + "uri":"evs_04_3042.html", + "doc_type":"api", + "p_code":"114", + "code":"128" + }, + { + "desc":"This API is used to delete one piece of the EVS disk metadata.URI formatDELETE /v3/{project_id}/volumes/{volume_id}/metadata/{key}DELETE /v3/{project_id}/volumes/{volume_", + "product_code":"evs", + "title":"Deleting One Piece of Metadata for an EVS Disk", + "uri":"evs_04_3043.html", + "doc_type":"api", + "p_code":"114", + "code":"129" + }, + { + "desc":"This API is used to query extension APIs.URI formatGET /v3/{project_id}/extensionsGET /v3/{project_id}/extensionsParameter descriptionParameterMandatoryDescriptionproject", + "product_code":"evs", + "title":"Querying Extension APIs", + "uri":"evs_04_3044.html", + "doc_type":"api", + "p_code":"114", + "code":"130" + }, + { + "desc":"This API is used to query all AZs.URI formatGET /v3/{project_id}/os-availability-zoneGET /v3/{project_id}/os-availability-zoneParameter descriptionParameterMandatoryDescr", + "product_code":"evs", + "title":"Querying All AZs", + "uri":"evs_04_3045.html", + "doc_type":"api", + "p_code":"114", + "code":"131" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"evs", + "title":"EVS Disk Actions", + "uri":"evs_04_3047.html", + "doc_type":"api", + "p_code":"113", + "code":"132" + }, + { + "desc":"This API is used to expand the capacity of an EVS disk.If the status of the to-be-expanded disk is available, there are no restrictions.If the status of the to-be-expande", + "product_code":"evs", + "title":"Expanding Capacity of an EVS Disk", + "uri":"evs_04_3048.html", + "doc_type":"api", + "p_code":"132", + "code":"133" + }, + { + "desc":"This API is used to set the bootable flag for an EVS disk.A data disk cannot be used as system disk for an ECS even if this API has been called to set the bootable flag f", + "product_code":"evs", + "title":"Setting Bootable Flag for an EVS Disk", + "uri":"evs_04_3049.html", + "doc_type":"api", + "p_code":"132", + "code":"134" + }, + { + "desc":"This API is used to set the read-only flag for the EVS disk.URI formatPOST /v3/{project_id}/volumes/{volume_id}/actionPOST /v3/{project_id}/volumes/{volume_id}/actionPara", + "product_code":"evs", + "title":"Setting Read-Only Flag for an EVS Disk", + "uri":"evs_04_3050.html", + "doc_type":"api", + "p_code":"132", + "code":"135" + }, + { + "desc":"This API is used to export the system disk data or data disk data as an IMS image. The exported image will be displayed in the IMS private image list and can be viewed an", + "product_code":"evs", + "title":"Exporting EVS Disk Data as an Image", + "uri":"evs_04_3051.html", + "doc_type":"api", + "p_code":"132", + "code":"136" + }, + { + "desc":"This API is used to reserve an EVS disk.This API call exists for compatibility reasons only and is not meant to be used.URI formatPOST /v3/{project_id}/volumes/{volume_id", + "product_code":"evs", + "title":"Reserving an EVS Disk (Deprecated)", + "uri":"evs_04_3052.html", + "doc_type":"api", + "p_code":"132", + "code":"137" + }, + { + "desc":"This API is used to cancel the reservation of an EVS disk.This API call exists for compatibility reasons only and is not meant to be used.URI formatPOST /v3/{project_id}/", + "product_code":"evs", + "title":"Canceling Reservation of an EVS Disk (Deprecated)", + "uri":"evs_04_3053.html", + "doc_type":"api", + "p_code":"132", + "code":"138" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"evs", + "title":"EVS Snapshot", + "uri":"evs_04_3055.html", + "doc_type":"api", + "p_code":"113", + "code":"139" + }, + { + "desc":"This API is used to create an EVS snapshot.URI formatPOST /v3/{project_id}/snapshotsPOST /v3/{project_id}/snapshotsParameter descriptionParameterMandatoryDescriptionproje", + "product_code":"evs", + "title":"Creating an EVS Snapshot", + "uri":"evs_04_3056.html", + "doc_type":"api", + "p_code":"139", + "code":"140" + }, + { + "desc":"This API is used to delete an EVS snapshot.A snapshot can be deleted only when it is in the available or error state.URI formatDELETE /v3/{project_id}/snapshots/{snapshot", + "product_code":"evs", + "title":"Deleting an EVS Snapshot", + "uri":"evs_04_3057.html", + "doc_type":"api", + "p_code":"139", + "code":"141" + }, + { + "desc":"This API is used to update an EVS snapshot.URI formatPUT /v3/{project_id}/snapshots/{snapshot_id}PUT /v3/{project_id}/snapshots/{snapshot_id}Parameter descriptionParamete", + "product_code":"evs", + "title":"Updating an EVS Snapshot", + "uri":"evs_04_3058.html", + "doc_type":"api", + "p_code":"139", + "code":"142" + }, + { + "desc":"This API is used to query the EVS snapshots.URI formatGET /v3/{project_id}/snapshotsGET /v3/{project_id}/snapshotsParameter descriptionParameterMandatoryDescriptionprojec", + "product_code":"evs", + "title":"Querying EVS Snapshots", + "uri":"evs_04_3059.html", + "doc_type":"api", + "p_code":"139", + "code":"143" + }, + { + "desc":"This API is used to query details about the EVS snapshots.URI formatGET /v3/{project_id}/snapshots/detailGET /v3/{project_id}/snapshots/detailParameter descriptionParamet", + "product_code":"evs", + "title":"Querying Details About EVS Snapshots", + "uri":"evs_04_3060.html", + "doc_type":"api", + "p_code":"139", + "code":"144" + }, + { + "desc":"This API is used to query details about an EVS snapshot.URI formatGET /v3/{project_id}/snapshots/{snapshot_id}GET /v3/{project_id}/snapshots/{snapshot_id}Parameter descri", + "product_code":"evs", + "title":"Querying Details About an EVS Snapshot", + "uri":"evs_04_3061.html", + "doc_type":"api", + "p_code":"139", + "code":"145" + }, + { + "desc":"This API is used to add the metadata of an EVS snapshot.URI formatPOST /v3/{project_id}/snapshots/{snapshot_id}/metadataPOST /v3/{project_id}/snapshots/{snapshot_id}/meta", + "product_code":"evs", + "title":"Adding Metadata of an EVS Snapshot", + "uri":"evs_04_3062.html", + "doc_type":"api", + "p_code":"139", + "code":"146" + }, + { + "desc":"This API is used to query the metadata of an EVS snapshot.URI formatGET /v3/{project_id}/snapshots/{snapshot_id}/metadataGET /v3/{project_id}/snapshots/{snapshot_id}/meta", + "product_code":"evs", + "title":"Querying Metadata of an EVS Snapshot", + "uri":"evs_04_3063.html", + "doc_type":"api", + "p_code":"139", + "code":"147" + }, + { + "desc":"This API is used to update one piece of the EVS snapshot metadata.URI formatPUT /v3/{project_id}/snapshots/{snapshot_id}/metadata/{key}PUT /v3/{project_id}/snapshots/{sna", + "product_code":"evs", + "title":"Updating One Piece of Metadata for an EVS Snapshot", + "uri":"evs_04_3064.html", + "doc_type":"api", + "p_code":"139", + "code":"148" + }, + { + "desc":"This API is used to update the metadata of an EVS snapshot.URI formatPUT /v3/{project_id}/snapshots/{snapshot_id}/metadataPUT /v3/{project_id}/snapshots/{snapshot_id}/met", + "product_code":"evs", + "title":"Updating Metadata of an EVS Snapshot", + "uri":"evs_04_3065.html", + "doc_type":"api", + "p_code":"139", + "code":"149" + }, + { + "desc":"This API is used to query one piece of the EVS snapshot metadata.URI formatGET /v3/{project_id}/snapshots/{snapshot_id}/metadata/{key}GET /v3/{project_id}/snapshots/{snap", + "product_code":"evs", + "title":"Querying One Piece of Metadata for an EVS Snapshot", + "uri":"evs_04_3066.html", + "doc_type":"api", + "p_code":"139", + "code":"150" + }, + { + "desc":"This API is used to delete one piece of the EVS snapshot metadata.URI formatDELETE /v3/{project_id}/snapshots/{snapshot_id}/metadata/{key}DELETE /v3/{project_id}/snapshot", + "product_code":"evs", + "title":"Deleting One Piece of Metadata for an EVS Snapshot", + "uri":"evs_04_3067.html", + "doc_type":"api", + "p_code":"139", + "code":"151" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"evs", + "title":"EVS Disk Transfer", + "uri":"evs_04_3068.html", + "doc_type":"api", + "p_code":"113", + "code":"152" + }, + { + "desc":"This API is used to create a disk transfer. After the transfer has been created, a transfer ID and an authentication key are returned.After a disk transfer is created, th", + "product_code":"evs", + "title":"Creating a Disk Transfer", + "uri":"evs_04_3069.html", + "doc_type":"api", + "p_code":"152", + "code":"153" + }, + { + "desc":"This API is used to accept a disk transfer through the transfer ID and authentication key.Encrypted EVS disks cannot be transferred.EVS disks with backups and snapshots a", + "product_code":"evs", + "title":"Accepting a Disk Transfer", + "uri":"evs_04_3070.html", + "doc_type":"api", + "p_code":"152", + "code":"154" + }, + { + "desc":"This API is used to delete a disk transfer. A disk transfer can be deleted if it is not accepted. Accepted disk transfers cannot be deleted.URI formatDELETE /v3/{project_", + "product_code":"evs", + "title":"Deleting a Disk Transfer", + "uri":"evs_04_3071.html", + "doc_type":"api", + "p_code":"152", + "code":"155" + }, + { + "desc":"This API is used to query the details of a disk transfer, including the transfer creation time, transfer ID, and transfer name.URI formatGET /v3/{project_id}/os-volume-tr", + "product_code":"evs", + "title":"Querying Details of a Disk Transfer", + "uri":"evs_04_3072.html", + "doc_type":"api", + "p_code":"152", + "code":"156" + }, + { + "desc":"This API is used to query all disk transfers of the current tenant.URI formatGET /v3/{project_id}/os-volume-transferGET /v3/{project_id}/os-volume-transferParameter descr", + "product_code":"evs", + "title":"Querying All Disk Transfers", + "uri":"evs_04_3073.html", + "doc_type":"api", + "p_code":"152", + "code":"157" + }, + { + "desc":"This API is used to query the details of all disk transfers, including the transfer creation time, transfer IDs, and transfer names.URI formatGET /v3/{project_id}/os-volu", + "product_code":"evs", + "title":"Querying Details of All Disk Transfers", + "uri":"evs_04_3074.html", + "doc_type":"api", + "p_code":"152", + "code":"158" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"evs", + "title":"API v1", + "uri":"evs_04_0053.html", + "doc_type":"api", + "p_code":"98", + "code":"159" + }, + { + "desc":"This API is used to query the execution status of tasks, such as the status of disk creation, capacity expansion, and deletion.URI formatGET /v1/{project_id}/jobs/{job_id", + "product_code":"evs", + "title":"Querying Task Status", + "uri":"evs_04_0054.html", + "doc_type":"api", + "p_code":"159", + "code":"160" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"evs", + "title":"OpenStack Cinder API v1 (Deprecated)", + "uri":"evs_04_0050.html", + "doc_type":"api", + "p_code":"98", + "code":"161" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"evs", + "title":"EVS Disk", + "uri":"evs_04_0051.html", + "doc_type":"api", + "p_code":"161", + "code":"162" + }, + { + "desc":"This API is used to query details about a disk.This API has been deprecated. Use another API. For details, see Querying Details About a Disk.URI formatGET /v1/{project_id", + "product_code":"evs", + "title":"Querying Details About a Disk (Deprecated)", + "uri":"evs_04_0052.html", + "doc_type":"api", + "p_code":"162", + "code":"163" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"evs", + "title":"Permissions Policies and Supported Actions", + "uri":"evs_04_0022.html", + "doc_type":"api", + "p_code":"", + "code":"164" + }, + { + "desc":"This chapter describes fine-grained permissions management for your EVS resources. If your account does not need individual IAM users, you can skip this chapter.By defaul", + "product_code":"evs", + "title":"Introduction", + "uri":"evs_04_0023.html", + "doc_type":"api", + "p_code":"164", + "code":"165" + }, + { + "desc":"This topic describes only the authorization information of EVS v2 APIs. For the v3 APIs that provide the same functions as their v2 APIs, their authorization information ", + "product_code":"evs", + "title":"API Version Query", + "uri":"evs_04_0024.html", + "doc_type":"api", + "p_code":"164", + "code":"166" + }, + { + "desc":"This topic describes only the authorization information of EVS v2 APIs. For the v3 APIs that provide the same functions as their v2 APIs, their authorization information ", + "product_code":"evs", + "title":"Disk", + "uri":"evs_04_0025.html", + "doc_type":"api", + "p_code":"164", + "code":"167" + }, + { + "desc":"This topic describes only the authorization information of EVS v2 APIs. For the v3 APIs that provide the same functions as their v2 APIs, their authorization information ", + "product_code":"evs", + "title":"Disk Action", + "uri":"evs_04_0026.html", + "doc_type":"api", + "p_code":"164", + "code":"168" + }, + { + "desc":"This topic describes only the authorization information of EVS v2 APIs. For the v3 APIs that provide the same functions as their v2 APIs, their authorization information ", + "product_code":"evs", + "title":"Snapshot", + "uri":"evs_04_0027.html", + "doc_type":"api", + "p_code":"164", + "code":"169" + }, + { + "desc":"This topic describes only the authorization information of EVS v2 APIs. For the v3 APIs that provide the same functions as their v2 APIs, their authorization information ", + "product_code":"evs", + "title":"Tag", + "uri":"evs_04_0028.html", + "doc_type":"api", + "p_code":"164", + "code":"170" + }, + { + "desc":"This topic describes only the authorization information of EVS v2 APIs. For the v3 APIs that provide the same functions as their v2 APIs, their authorization information ", + "product_code":"evs", + "title":"Disk Transfer", + "uri":"evs_04_0029.html", + "doc_type":"api", + "p_code":"164", + "code":"171" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"evs", + "title":"Appendix", + "uri":"evs_04_0037.html", + "doc_type":"api", + "p_code":"", + "code":"172" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"evs", + "title":"Error Codes", + "uri":"evs_04_0038.html", + "doc_type":"api", + "p_code":"172", + "code":"173" + }, + { + "desc":"NormalStatus CodeDescription200OK201Created202Accepted204No ContentAbnormalStatus CodeDescription400Bad Request401Unauthorized403Forbidden404Not Found405Method Not Allowe", + "product_code":"evs", + "title":"Status Codes", + "uri":"evs_04_0039.html", + "doc_type":"api", + "p_code":"172", + "code":"174" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"evs", + "title":"EVS Disk Status", + "uri":"evs_04_0040.html", + "doc_type":"api", + "p_code":"172", + "code":"175" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"evs", + "title":"EVS Snapshot Status", + "uri":"evs_04_0041.html", + "doc_type":"api", + "p_code":"172", + "code":"176" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"evs", + "title":"EVS Replication Pair Status (Deprecated)", + "uri":"evs_04_0042.html", + "doc_type":"api", + "p_code":"172", + "code":"177" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"evs", + "title":"Replication Consistency Group Status (Deprecated)", + "uri":"evs_04_0043.html", + "doc_type":"api", + "p_code":"172", + "code":"178" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"evs", + "title":"Details of EVS Replication failure_detail Values (Deprecated)", + "uri":"evs_04_0044.html", + "doc_type":"api", + "p_code":"172", + "code":"179" + }, + { + "desc":"This topic describes only the authorization information of EVS v2 APIs. For the v3 APIs that provide the same functions as their v2 APIs, their authorization information ", + "product_code":"evs", + "title":"API Actions", + "uri":"evs_04_0045.html", + "doc_type":"api", + "p_code":"172", + "code":"180" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"evs", + "title":"Change History", + "uri":"evs_04_0048.html", + "doc_type":"api", + "p_code":"", + "code":"181" + } +] \ No newline at end of file diff --git a/docs/evs/api-ref/PARAMETERS.txt b/docs/evs/api-ref/PARAMETERS.txt new file mode 100644 index 000000000..6da8d5f07 --- /dev/null +++ b/docs/evs/api-ref/PARAMETERS.txt @@ -0,0 +1,3 @@ +version="" +language="en-us" +type="" \ No newline at end of file diff --git a/docs/evs/api-ref/evs_04_0001.html b/docs/evs/api-ref/evs_04_0001.html new file mode 100644 index 000000000..60c325e35 --- /dev/null +++ b/docs/evs/api-ref/evs_04_0001.html @@ -0,0 +1,8 @@ + + +
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.
+EVS APIs provide multiple versions. For the APIs offering same functions, you are recommended to use the v2 APIs.
+The current default microversion of v3 APIs is 3.0, and the maximum version is 3.50. You can specify the version number by adding OpenStack-API-Version:volume Version number to the request header. For example, add OpenStack-API-Version:volume 3.50.
+v3 APIs are not recommended, especially non-OpenStack v3 APIs, which will be changed in the future. Therefore, v2 APIs are strongly recommended.
+This API is used to query information of API versions.
+GET https://{endpoint}/
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
versions + |
+Array of objects + |
+Specifies the API versions. For details, see Parameters in the versions field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
min_version + |
+String + |
+Specifies the minimum microversion supported. If this version does not support microversions, the value is an empty string. + |
+
media-types + |
+Array of objects + |
+Specifies the request message type of the API version. For details, see Parameters in the media-types field. + |
+
links + |
+Array of objects + |
+Specifies the URI of the API version. For details, see Parameters in the links field. + |
+
id + |
+String + |
+Specifies the ID of the API version. + |
+
updated + |
+String + |
+Specifies the last time when the API version was updated. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
version + |
+String + |
+Specifies the maximum microversion supported. If this version does not support microversions, the value is an empty string. + |
+
status + |
+String + |
+Specifies the API version status. The value can be as follows:
+
|
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
type + |
+String + |
+Specifies the response type. + |
+
base + |
+String + |
+Specifies the text type. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
rel + |
+String + |
+Specifies the domain name description. + |
+
href + |
+String + |
+Specifies the domain name. + |
+
type + |
+String + |
+Specifies the response type. + |
+
{
+ "versions": [
+ {
+ "min_version": "",
+ "media-types": [
+ {
+ "type": "application/vnd.openstack.volume+json;version=1",
+ "base": "application/json"
+ },
+ {
+ "type": "application/vnd.openstack.volume+xml;version=1",
+ "base": "application/xml"
+ }
+ ],
+ "links": [
+ {
+ "rel": "describedby",
+ "href": "http://docs.openstack.org/",
+ "type": "text/html"
+ },
+ {
+ "rel": "self",
+ "href": "https://evs.localdomain.com/v1"
+ }
+ ],
+ "id": "v1.0",
+ "updated": "2014-06-28T12:20:21Z",
+ "version": "",
+ "status": "SUPPORTED"
+ },
+ {
+ "min_version": "",
+ "media-types": [
+ {
+ "type": "application/vnd.openstack.volume+json;version=1",
+ "base": "application/json"
+ },
+ {
+ "type": "application/vnd.openstack.volume+xml;version=1",
+ "base": "application/xml"
+ }
+ ],
+ "links": [
+ {
+ "rel": "describedby",
+ "href": "http://docs.openstack.org/",
+ "type": "text/html"
+ },
+ {
+ "rel": "self",
+ "href": "https://evs.localdomain.com/v2"
+ }
+ ],
+ "id": "v2.0",
+ "updated": "2014-06-28T12:20:21Z",
+ "version": "",
+ "status": "SUPPORTED"
+ },
+ {
+ "min_version": "3.0",
+ "media-types": [
+ {
+ "type": "application/vnd.openstack.volume+json;version=1",
+ "base": "application/json"
+ },
+ {
+ "type": "application/vnd.openstack.volume+xml;version=1",
+ "base": "application/xml"
+ }
+ ],
+ "links": [
+ {
+ "rel": "describedby",
+ "href": "http://docs.openstack.org/",
+ "type": "text/html"
+ },
+ {
+ "rel": "self",
+ "href": "https://evs.localdomain.com/v3"
+ }
+ ],
+ "id": "v3.0",
+ "updated": "2016-02-08T12:20:21Z",
+ "version": "3.0",
+ "status": "CURRENT"
+ }
+ ]
+}
+For details, see Error Codes.
+This API is used to query information of an API version.
+GET https://{endpoint}/v2
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
versions + |
+Array of objects + |
+Specifies the API version information. For details, see Parameters in the versions field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
min_version + |
+String + |
+Specifies the minimum microversion supported. If this version does not support microversions, the value is an empty string. + |
+
media-types + |
+Array of objects + |
+Specifies the request message type of the API version. For details, see Parameters in the media-types field. + |
+
links + |
+Array of objects + |
+Specifies the URI of the API version. For details, see Parameters in the links field. + |
+
id + |
+String + |
+Specifies the ID of the API version. + |
+
updated + |
+String + |
+Specifies the last time when the API version was updated. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
version + |
+String + |
+Specifies the maximum microversion supported. If this version does not support microversions, the value is an empty string. + |
+
status + |
+String + |
+Specifies the API version status. The value can be as follows: +
|
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
type + |
+String + |
+Specifies the response type. + |
+
base + |
+String + |
+Specifies the text type. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
rel + |
+String + |
+Specifies the domain name description. + |
+
href + |
+String + |
+Specifies the domain name. + |
+
type + |
+String + |
+Specifies the response type. + |
+
{
+ "versions": [
+ {
+ "min_version": "",
+ "media-types": [
+ {
+ "type": "application/vnd.openstack.volume+json;version=1",
+ "base": "application/json"
+ },
+ {
+ "type": "application/vnd.openstack.volume+xml;version=1",
+ "base": "application/xml"
+ }
+ ],
+ "links": [
+ {
+ "rel": "describedby",
+ "href": "http://docs.openstack.org/",
+ "type": "text/html"
+ },
+ {
+ "rel": "self",
+ "href": "https://evs.localdomain.com/v2"
+ }
+ ],
+ "id": "v2.0",
+ "updated": "2014-06-28T12:20:21Z",
+ "version": "",
+ "status": "SUPPORTED"
+ }
+ ]
+}
+For details, see Error Codes.
+This chapter describes fine-grained permissions management for your EVS resources. If your account does not need individual IAM users, you can skip this chapter.
+By default, new IAM users do not have permissions assigned. You need to add a user to one or more groups, and attach permissions policies or roles to these groups. Users inherit permissions from the groups to which they are added and can perform specified operations on cloud services based on the permissions.
+You can grant users permissions by using roles and policies. Roles are a type of coarse-grained authorization mechanism that defines permissions related to user responsibilities. Policies define API-based permissions for operations on specific resources under certain conditions, allowing for more fine-grained, secure access control of cloud resources.
+
Policy-based authorization is useful if you want to allow or deny the access to an API.
+An account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. The permissions required for calling an API are determined by the actions supported by the API. Only users who have been granted permissions allowing the actions can call the API successfully. For example, if an IAM user queries EVS disks using an API, the user must have been granted permissions that allow the evs:volumes:list action.
+EVS provides system-defined policies that can be directly used in IAM. You can also create custom policies and use them to supplement system-defined policies, implementing more refined access control. Operations supported by policies are specific to APIs. The following are common concepts related to policies:
+EVS supports the following actions that can be defined in custom policies:
+This topic describes only the authorization information of EVS v2 APIs. For the v3 APIs that provide the same functions as their v2 APIs, their authorization information is the same as that of the v2 APIs.
+For example, the v2 API for creating disks is POST /v2/{project_id}/cloudvolumes, and the v3 API for creating disks is POST /v3/{project_id}/cloudvolumes. The authorization information of both APIs is the same.
+In the following tables, √ indicates that the item is supported, and × indicates that the item is not supported.
+ +Permission + |
+API + |
+Action + |
+IAM Project +(Project) + |
+
|---|---|---|---|
Query API versions (OpenStack Cinder API). + |
+GET / + |
+None + |
+√ + |
+
Query the API version (OpenStack Cinder API). + |
+GET /{api_version} + |
+None + |
+√ + |
+
If Action is None, no authorization is required.
+This topic describes only the authorization information of EVS v2 APIs. For the v3 APIs that provide the same functions as their v2 APIs, their authorization information is the same as that of the v2 APIs.
+For example, the v2 API for creating disks is POST /v2/{project_id}/cloudvolumes, and the v3 API for creating disks is POST /v3/{project_id}/cloudvolumes. The authorization information of both APIs is the same.
+In the following tables, √ indicates that the item is supported, and × indicates that the item is not supported.
+ +Permission + |
+API + |
+Action + |
+IAM Project +(Project) + |
+
|---|---|---|---|
Create EVS disks. + |
+POST /v2/{project_id}/cloudvolumes + |
+evs:volumes:create + |
+√ + |
+
Create EVS disks (OpenStack Cinder API). + |
+POST /v2/{project_id}/volumes + |
++ | +√ + |
+
Expand the capacity of an EVS disk. + |
+POST /v2/{project_id}/cloudvolumes/{volume_id}/action + |
+evs:volumes:extend + |
+√ + |
+
Query EVS disks. + |
+GET /v2/{project_id}/cloudvolumes + |
+evs:volumes:list + |
+√ + |
+
Query EVS disks (OpenStack Cinder API). + |
+GET /v2/{project_id}/volumes + |
+evs:volumes:list + |
+√ + |
+
Query details of all EVS disks. + |
+GET /v2/{project_id}/cloudvolumes/detail + |
+evs:volumes:list + |
+√ + |
+
Querying Details About All Disks + |
+GET /v2/{project_id}/os-vendor-volumes/detail + |
+evs:volumes:list + |
+√ + |
+
Query details of all EVS disks (OpenStack Cinder API). + |
+GET /v2/{project_id}/volumes/detail + |
+evs:volumes:list + |
+√ + |
+
Query details of an EVS disk. + |
+GET /v2/{project_id}/os-vendor-volumes/{volume_id} + + |
+evs:volumes:get + |
+√ + |
+
Query details of an EVS disk (OpenStack Cinder API). + |
+GET /v2/{project_id}/volumes/{volume_id} + |
+evs:volumes:get + |
+√ + |
+
Query details of an EVS disk. + |
+GET /v2/{project_id}/cloudvolumes/{volume_id} + |
+evs:volumes:get + |
+√ + |
+
Delete an EVS disk. + |
+DELETE /v2/{project_id}/cloudvolumes/{volume_id} + |
+evs:volumes:delete + |
+√ + |
+
Delete an EVS disk (OpenStack Cinder API). + |
+DELETE /v2/{project_id}/volumes/{volume_id} + |
+evs:volumes:delete +evs:volumes:get + |
+√ + |
+
Update EVS disk information. + |
+PUT /v2/{project_id}/cloudvolumes/{volume_id} + |
+evs:volumes:update + |
+√ + |
+
Update EVS disk information (OpenStack Cinder API). + |
+PUT /v2/{project_id}/volumes/{volume_id} + |
+evs:volumes:update +evs:volumes:get + |
+√ + |
+
Update one piece of EVS disk metadata (OpenStack Cinder API). + |
+PUT /v2/{project_id}/volumes/{volume_id}/metadata/{key} + |
+evs:volumes:update +evs:volumes:get + |
+√ + |
+
Update the metadata of an EVS disk (OpenStack Cinder API). + |
+PUT /v2/{project_id}/volumes/{volume_id}/metadata + |
+evs:volumes:update +evs:volumes:get + |
+√ + |
+
Query one piece of EVS disk metadata (OpenStack Cinder API). + |
+GET /v2/{project_id}/volumes/{volume_id}/metadata/{key} + |
+evs:volumes:get + |
+√ + |
+
Delete one piece of EVS disk metadata (OpenStack Cinder API). + |
+DELETE /v2/{project_id}/volumes/{volume_id}/metadata/{key} + |
+evs:volumes:delete +evs:volumes:get + |
+√ + |
+
Query the metadata of an EVS disk (OpenStack Cinder API). + |
+GET /v2/{project_id}/volumes/{volume_id}/metadata/{key} + |
+evs:volumes:get + |
+√ + |
+
Add the metadata of an EVS disk (OpenStack Cinder API). + |
+POST /v2/{project_id}/volumes/{volume_id}/metadata + |
+evs:volumes:update +evs:volumes:get + |
+√ + |
+
Query EVS disk types (OpenStack Cinder API). + |
+GET /v2/{project_id}/types + |
+evs:types:get + |
+√ + |
+
Query details of an EVS disk type (OpenStack Cinder API). + |
+GET /v2/{project_id}/types/{type_id} + |
+evs:types:get + |
+√ + |
+
Query tenant quotas (OpenStack Cinder API). + |
+GET /v2/{project_id}/os-quota-sets/{project_id} + |
+evs:quotas:get + |
+√ + |
+
Query extension APIs (OpenStack Cinder API). + |
+GET /v2/{project_id}/extensions + |
+None + |
+√ + |
+
Query information of all AZs (OpenStack Cinder API). + |
+GET /v2/{project_id}/os-availability-zone + |
+None + |
+√ + |
+
Query loading progress of a lazyloading disk. + |
+GET /v3/{project_id}/os-vendor-volumes/{volume_id}/internal-info + |
+evs:volumes:get + |
+√ + |
+
Query EVS disks (OpenStack Cinder API). + |
+GET /v3/{project_id}/volumes/summary + |
+evs:volumes:get +evs:volumes:list + |
+√ + |
+
If Action is None, no authorization is required.
+This topic describes only the authorization information of EVS v2 APIs. For the v3 APIs that provide the same functions as their v2 APIs, their authorization information is the same as that of the v2 APIs.
+For example, the v2 API for creating disks is POST /v2/{project_id}/cloudvolumes, and the v3 API for creating disks is POST /v3/{project_id}/cloudvolumes. The authorization information of both APIs is the same.
+In the following tables, √ indicates that the item is supported, and × indicates that the item is not supported.
+ +Permission + |
+API + |
+Action + |
+IAM Project +(Project) + |
+
|---|---|---|---|
Expand the capacity of an EVS disk (OpenStack Cinder API). + |
+POST /v2/{project_id}/volumes/{volume_id}/action +action="os-extend" + |
+evs:volumes:extend +evs:volumes:get + |
+√ + |
+
Export the EVS disk data as an image (OpenStack Cinder API). + + |
+POST /v2/{project_id}/volumes/{volume_id}/action +action="os-volume_upload_image" + |
+evs:volumes:uploadImage + |
+√ + |
+
Attach an EVS disk (OpenStack Cinder API). + + |
+POST /v2/{project_id}/volumes/{volume_id}/action +action="os-attach" + |
+evs:volumes:attach +evs:volumes:get + |
+√ + |
+
Detach an EVS disk (OpenStack Cinder API). + + |
+POST /v2/{project_id}/volumes/{volume_id}/action +action="os-detach" + |
+evs:volumes:detach +evs:volumes:get + |
+√ + |
+
Reserve an EVS disk (OpenStack Cinder API). + |
+POST /v2/{project_id}/volumes/{volume_id}/action +action="os-reserve" + |
+evs:volumes:attach + |
+√ + |
+
Cancel reservation of an EVS disk (OpenStack Cinder API). + + |
+POST /v2/{project_id}/volumes/{volume_id}/action +action="os-unreserve" + |
+evs:volumes:attach + |
+√ + |
+
Set the bootable flag for an EVS disk (OpenStack Cinder API). + + |
+POST /v2/{project_id}/volumes/{volume_id}/action +action="os-set_bootable" + |
+evs:volumes:update + |
+√ + |
+
Set the read-only attribute for an EVS disk (OpenStack Cinder API). + + |
+POST /v2/{project_id}/volumes/{volume_id}/action +action="os-update_readonly_flag" + |
+evs:volumes:update + |
+√ + |
+
This topic describes only the authorization information of EVS v2 APIs. For the v3 APIs that provide the same functions as their v2 APIs, their authorization information is the same as that of the v2 APIs.
+For example, the v2 API for creating disks is POST /v2/{project_id}/cloudvolumes, and the v3 API for creating disks is POST /v3/{project_id}/cloudvolumes. The authorization information of both APIs is the same.
+In the following tables, √ indicates that the item is supported, and × indicates that the item is not supported.
+ +Permission + |
+API + |
+Action + |
+IAM Project +(Project) + |
+
|---|---|---|---|
Create an EVS snapshot (OpenStack Cinder API). + |
+POST /v2/{project_id}/snapshots + |
+evs:snapshots:create +evs:volumes:get + |
+√ + |
+
Create an EVS snapshot. + |
+POST /v2/{project_id}/cloudsnapshots + |
+evs:snapshots:create + |
+√ + |
+
Query EVS snapshots (OpenStack Cinder API). + |
+GET /v2/{project_id}/snapshots + |
+evs:snapshots:list + |
+√ + |
+
Query details of EVS snapshots (OpenStack Cinder API). + |
+GET /v2/{project_id}/snapshots/detail + |
+evs:snapshots:list + |
+√ + |
+
Query details about EVS snapshots. + |
+GET /v2/{project_id}/cloudsnapshots/detail + |
+evs:snapshots:list + |
+√ + |
+
Update an EVS snapshot (OpenStack Cinder API). + |
+PUT /v2/{project_id}/snapshots/{snapshot_id} + |
+evs:snapshots:update +evs:snapshots:get + |
+√ + |
+
Update an EVS snapshot. + |
+PUT /v2/{project_id}/cloudsnapshots/{snapshot_id} + |
+evs:snapshots:update + |
+√ + |
+
Query details about a single EVS snapshot (OpenStack Cinder API). + + |
+GET /v2/{project_id}/snapshots/{snapshot_id} + |
+evs:snapshots:get + + |
+√ + |
+
Querying details about an EVS snapshot. + + |
+GET /v2/{project_id}/cloudsnapshots/{snapshot_id} + |
+evs:snapshots:get + + |
+√ + |
+
Delete an EVS snapshot (OpenStack Cinder API). + |
+DELETE /v2/{project_id}/snapshots/{snapshot_id} + |
+evs:snapshots:delete +evs:snapshots:get +evs:volumes:get + |
+√ + |
+
Deleting an EVS snapshot. + |
+DELETE /v2/{project_id}/cloudsnapshots/{snapshot_id} + |
+evs:snapshots:delete + |
+√ + |
+
Roll back a snapshot to an EVS disk. + |
+POST /v2/{project_id}/cloudsnapshots/{snapshot_id}/rollback + |
+evs:snapshots:rollback + |
+√ + |
+
Roll back a snapshot to an EVS disk. + |
+POST /v2/{project_id}/os-vendor-snapshots/{snapshot_id}/rollback + |
+evs:snapshots:rollback +evs:snapshots:get +evs:volumes:get + |
+√ + |
+
Add the metadata of an EVS snapshot (OpenStack Cinder API). + |
+POST /v2/{project_id}/snapshots/{snapshot_id}/metadata + |
+evs:snapshots:update +evs:snapshots:get + |
+√ + |
+
Query the metadata of an EVS snapshot (OpenStack Cinder API). + |
+GET /v2/{project_id}/snapshots/{snapshot_id}/metadata + |
+evs:snapshots:get + |
+√ + |
+
Update one piece of EVS snapshot metadata (OpenStack Cinder API). + |
+PUT /v2/{project_id}/snapshots/{snapshot_id}/metadata/{key} + |
+evs:snapshots:update +evs:snapshots:get + |
+√ + |
+
Update the metadata of an EVS snapshot (OpenStack Cinder API). + |
+PUT /v2/{project_id}/snapshots/{snapshot_id}/metadata + |
+evs:snapshots:update +evs:snapshots:get + |
+√ + |
+
Query one piece of EVS snapshot metadata (OpenStack Cinder API). + |
+GET /v2/{project_id}/snapshots/{snapshot_id}/metadata/{key} + |
+evs:snapshots:get + |
+√ + |
+
Delete one piece of EVS snapshot metadata (OpenStack Cinder API). + |
+DELETE /v2/{project_id}/snapshots/{snapshot_id}/metadata/{key} + |
+evs:snapshots:delete +evs:snapshots:get + |
+√ + |
+
This topic describes only the authorization information of EVS v2 APIs. For the v3 APIs that provide the same functions as their v2 APIs, their authorization information is the same as that of the v2 APIs.
+For example, the v2 API for creating disks is POST /v2/{project_id}/cloudvolumes, and the v3 API for creating disks is POST /v3/{project_id}/cloudvolumes. The authorization information of both APIs is the same.
+In the following tables, √ indicates that the item is supported, and × indicates that the item is not supported.
+ +Permission + |
+API + |
+Action + |
+IAM Project +(Project) + |
+
|---|---|---|---|
Obtain all EVS tags of a tenant. + |
+GET /v2/{project_id}/os-vendor-tags/{resource_type} + |
+
|
+√ + |
+
Query EVS resources by tag. + |
+GET /v2/{project_id}/os-vendor-tags/{resource_type}/resource_instances + |
+
|
+√ + |
+
Add or update tags for an EVS resource. + |
+POST /v2/{project_id}/os-vendor-tags/{resource_type}/{resource_id} + |
+
|
+√ + |
+
Obtain tags of an EVS resource. + |
+GET /v2/{project_id}/os-vendor-tags/{resource_type}/{resource_id} + |
+
|
+√ + |
+
Reset the tags of an EVS resource. + |
+PUT /v2/{project_id}/os-vendor-tags/{resource_type}/{resource_id} + |
+
|
+√ + |
+
Batch delete the tags for an EVS resource. + |
+POST /v2/{project_id}/os-vendor-tags/{resource_type}/{resource_id}/action + |
++ | +√ + |
+
Delete the tags of an EVS resource by key. + |
+DELETE /v2/{project_id}/os-vendor-tags/{resource_type}/{resource_id}/{key} + |
++ | +√ + |
+
Update the tags of an EVS resource by key. + |
+PUT /v2/{project_id}/os-vendor-tags/{resource_type}/{resource_id}/{key} + |
+
|
+√ + |
+
Batch delete tags for a specified EVS disk. + |
+POST /v2/{project_id}/os-vendor-volumes/{volume_id}/tags/action + |
+evs:volumeTags:delete + |
+√ + |
+
Query the tags of an EVS disk. + |
+GET /v2/{project_id}/os-vendor-volumes/{volume_id}/tags + |
+evs:volumeTags:getById + |
+√ + |
+
Batch add tags for a specified EVS disk. + |
+POST /v2/{project_id}/os-vendor-volumes/{volume_id}/tags/action + |
+evs:volumeTags:create + |
+√ + |
+
Query details of EVS disks by tag. + |
+POST /v2/{project_id}/os-vendor-volumes/resource_instances/action + |
+evs:volumeTags:get + |
+√ + |
+
Query tags of an EVS resource by key. + |
+GET /v2/{project_id}/os-vendor-tags/{resource_type}/{resource_id}/{key} + |
+evs:volumeTags:getById + |
+√ + |
+
Query the number of EVS disks by tag. + |
+POST /v2/{project_id}/os-vendor-volumes/resource_instances/action + |
+evs:volumeTags:get + |
+√ + |
+
Permission + |
+API + |
+Action + |
+IAM Project +(Project) + |
+
|---|---|---|---|
Obtain all EVS tags of a tenant. + |
+GET /v2/{project_id}/cloudvolumes/tags + |
+
|
+√ + |
+
Batch add tags for a specified EVS disk. + |
+POST /v2/{project_id}/cloudvolumes/{volume_id}/tags/action + |
+evs:volumeTags:create + |
+√ + |
+
Batch delete tags for a specified EVS disk. + |
+POST /v2/{project_id}/cloudvolumes/{volume_id}/tags/action + |
+evs:volumeTags:delete + |
+√ + |
+
Query the tags of an EVS disk. + |
+GET /v2/{project_id}/cloudvolumes/{volume_id}/tags + |
+evs:volumeTags:getById + |
+√ + |
+
Query details of EVS disks by tag. + |
+POST /v2/{project_id}/cloudvolumes/resource_instances/action + |
+evs:volumeTags:get + |
+√ + |
+
This topic describes only the authorization information of EVS v2 APIs. For the v3 APIs that provide the same functions as their v2 APIs, their authorization information is the same as that of the v2 APIs.
+For example, the v2 API for creating disks is POST /v2/{project_id}/cloudvolumes, and the v3 API for creating disks is POST /v3/{project_id}/cloudvolumes. The authorization information of both APIs is the same.
+In the following tables, √ indicates that the item is supported, and × indicates that the item is not supported.
+ +Permission + |
+API + |
+Action + |
+IAM Project +(Project) + |
+
|---|---|---|---|
Create an EVS disk transfer (OpenStack Cinder API). + |
+POST /v2/{project_id}/os-volume-transfer + |
+evs:transfers:create + |
+√ + |
+
Query all EVS disk transfers of a tenant (OpenStack Cinder API). + |
+GET /v2/{project_id}/os-volume-transfer + |
+evs:transfers:list + |
+√ + |
+
Query details of all EVS disk transfers of a tenant (OpenStack Cinder API). + |
+GET /v2/{project_id}/os-volume-transfer/detail + |
+evs:transfers:list + |
+√ + |
+
Query details of an EVS disk transfer (OpenStack Cinder API). + |
+GET /v2/{project_id}/os-volume-transfer/{transfer_id} + |
+evs:transfers:get + |
+√ + |
+
Accept an EVS disk transfer (OpenStack Cinder API). + |
+POST /v2/{project_id}/os-volume-transfer/{transfer_id}/accept + |
+evs:transfers:accept + |
+√ + |
+
Delete an EVS disk transfer (OpenStack Cinder API). + |
+DELETE /v2/{project_id}/os-volume-transfer/{transfer_id} + |
+evs:transfers:delete + |
+√ + |
+
Status Code + |
+Error Code + |
+Error Message + |
+Error Description + |
+Solution + |
+
|---|---|---|---|---|
400 + |
+EVS.0001 + |
+invalid tenant id! + |
+Incorrect tenant ID in the URI. +The tenant ID is actually the project ID. + |
+Use the correct tenant ID. + |
+
400 + |
+EVS.0002 + |
+invalid token! + |
+Header parameters in the HTTP request are incorrect. + |
+Use the correct token. + |
+
403 + |
+EVS.0003 + |
+invalid token roles! + |
+The token used is incorrect. + |
+The account permission set is empty. Add the required permissions to this account. + |
+
400 + |
+EVS.1001 + |
+null volume! + |
+The name and description formats set in the request to update the disk are incorrect. + |
+Enter the disk name and description in the correct format. + |
+
400 + |
+EVS.1002 + |
+invalid volume id! + |
+Incorrect disk ID. + |
+Enter the disk ID in the correct format. + |
+
400 + |
+EVS.1003 + |
+invalid volume name! + |
+Incorrect disk name format. + |
+Enter the disk name in the correct format. + |
+
400 + |
+EVS.1004 + |
+invalid volume description! + |
+Incorrect disk description format. + |
+Enter the disk description in the correct format. + |
+
400 + |
+EVS.1005 + |
+size of metadata is too large! + |
+The size of the metadata set in the request to create the disk exceeds the upper limit. + |
+Check whether the metadata is too large. The metadata size must be smaller than 1048576 bytes. + |
+
400 + |
+EVS.1006 + |
+invalid backup id! + |
+The ID of the backup used to create the disk is incorrect. + |
+Enter the correct backup ID. + |
+
400 + |
+EVS.1007 + |
+volume name and description can not both be empty! + |
+Parameters name and description are incorrect. + |
+Enter the correct disk name and description. + |
+
400 + |
+EVS.1008 + |
+null createVolumeReq! + |
+The format of the request to create the disk is incorrect. + |
+Use the correct request format. + |
+
400 + |
+EVS.1009 + |
+invalid volumeForCreate! + |
+The body of the request to create the disk is incorrect. + |
+Check the body of the request used to create the disk. + |
+
400 + |
+EVS.1010 + |
+invalid volume size! + |
+Parameter size set in the request to create the disk is invalid. + |
+Enter a valid size value. + |
+
400 + |
+EVS.1011 + |
+null extendVolumeReq! + |
+The format of the request to expand the disk capacity is incorrect. + |
+Use the correct request format. + |
+
400 + |
+EVS.1012 + |
+temporary volume! + |
+You do not have the permission to access this disk. + |
+Do not perform operations for a temporary disk as it does not allow any operation. + |
+
400 + |
+EVS.1013 + |
+request transforming failed! + |
+Request conversion error. + |
+Check whether the request body is correct. + |
+
400 + |
+EVS.1014 + |
+volume can not be extended! + |
+Failed to meet the capacity expansion requirements. + |
+Ensure that the disk meets the expansion requirements. + |
+
400 + |
+EVS.1015 + |
+new volume Size must be greater than old Size! + |
+The new size of the disk is incorrect. + |
+Ensure that the new disk capacity is larger than the original disk capacity. + |
+
400 + |
+EVS.1016 + |
+Invalid input received: May specify only one of imageRef, snapshot_id, backup_id! + |
+Only one data source among image, snapshot, and backup can be selected when creating a disk from a data source. + |
+Select one data source. + |
+
400 + |
+EVS.1018 + |
+Type conversion error , parameter type is unexpected + |
+Type conversion error. The parameter type is unexpected. + |
+Check whether the input parameters are correct. See the parameter description in the Elastic Volume Service API Reference. + |
+
400 + |
+EVS.1020 + |
+invalid volume type! + |
+The disk type set in the request to create the disk is incorrect. + |
+Enter a valid disk type. + |
+
400 + |
+EVS.1021 + |
+the quantity of volume is invalid! + |
+The disk quantity set in the request to batch create disks is incorrect. + |
+Enter a valid disk quantity. + |
+
400 + |
+EVS.1022 + |
+the size param is less than backup size! + |
+Parameter size set in the request to create the disk using a backup is incorrect. + |
+Ensure that the entered disk size is larger than the backup size. + |
+
400 + |
+EVS.1023 + |
+invalid filter limit! + |
+Parameter limit in the URL for querying the disk is incorrect. + |
+Ensure that the limit value ranges from 1 to 1000. The default value is 1000. + |
+
400 + |
+EVS.1024 + |
+invalid filter marker! + |
+Parameter marker in the URL for querying the disk is incorrect. + |
+Ensure that the marker value is in the UUID format. + |
+
400 + |
+EVS.1025 + |
+url encoding failed! + |
+Metadata decoding error. + |
+Check whether parameter metadata is correctly specified. + |
+
403 + |
+EVS.1027 + |
+user role is not allowed for this action! + |
+You do not have the rights to perform the operation. + |
+Check whether the account has relevant permissions, or the account is in arrears, does not pass real-name authentication, or has violations. + |
+
400 + |
+EVS.1031 + |
+invalid resources status! + |
+Input value of parameter resources status is invalid. + |
+Specify a valid value for resources status. + |
+
400 + |
+EVS.1032 + |
+invalid resources ID! + |
+Parameter resources id cannot be left empty. + |
+Specify a valid value for resources id. + |
+
400 + |
+EVS.1033 + |
+query quota failed! + |
+Failed to query the tenant quota. + |
+Check whether the tenant quota is configured. + |
+
400 + |
+EVS.1034 + |
+volume count exceeded volume count quota! + |
+Insufficient disk quantity quota assigned to the tenant. + |
+Increase the disk quantity quota. + |
+
400 + |
+EVS.1036 + |
+invalid availability zone! + |
+Parameter availability_zone set in the request to create the disk is incorrect. + |
+Enter the correct AZ. + |
+
400 + |
+EVS.1039 + |
+invalid sort_key! + |
+Input parameter sort_key is incorrect. + |
+Check whether parameter sort_key is correctly specified. + |
+
400 + |
+EVS.1040 + |
+invalid sort_dir! + |
+Parameter sort_dir in the URL for querying the disk is incorrect. + |
+Ensure that the sort_dir value is desc or asc. + |
+
400 + |
+EVS.1041 + |
+invalid filter availablity-zone! + |
+Parameter availability-zone in the URL for querying the disk is incorrect. + |
+Check whether the AZ specified in the request is valid. + |
+
400 + |
+EVS.1042 + |
+volume gigabytes exceeded volume gigabytes quota! + |
+Insufficient disk capacity quota assigned to the tenant. + |
+Increase the disk capacity quota. + |
+
400 + |
+EVS.1043 + |
+encrypt and cmk and passthrougth in metadata is not support when create volume from snapshot or image! + |
+Parameters __system__encrypted, __system__cmkid, and hw:passthrough are not supported when a disk is created from an image or a snapshot. + |
+Check whether the request body is correct. For details, see the metadata field description for creating disks. + |
+
400 + |
+EVS.1044 + |
+backup status must be available when create a volume from it! + |
+The backup cannot be used to create a disk. + |
+The backup is unavailable. + |
+
400 + |
+EVS.1045 + |
+backupDetail returned by FSP is null! + |
+Failed to query the backup details. + |
+Check whether the backup exists. Contact customer service. + |
+
400 + |
+EVS.1046 + |
+volume status must be available, error, error_extending, error_restoring, error_rollbacking when delete volume! + |
+Failed to delete the disk because the disk status is incorrect. + |
+Contact customer service. + |
+
400 + |
+EVS.1047 + |
+snapshot status must be available or error when delete snapshot! + |
+Failed to delete the snapshot because the snapshot status is incorrect. + |
+Contact customer service. + |
+
400 + |
+EVS.1048 + |
+volume status must be available when extend volume! + |
+Failed to expand the disk capacity because the disk status is incorrect. + |
+Ensure that the disk status meets the expansion requirements. + |
+
400 + |
+EVS.1049 + |
+available-zone is not equal to backup available-zone! + |
+The backup used to create the disk is in the incorrect AZ. + |
+The backup and the disk to be created must in the same AZ. + |
+
400 + |
+EVS.1051 + |
+can not batch create volume from backup! + |
+Batch creating disks from a backup is not available. + |
+Batch creating disks from a backup is not available. + |
+
400 + |
+EVS.1052 + |
+invalid http body! + |
+Request conversion error. + |
+Check whether the request body is correct. + |
+
400 + |
+EVS.1053 + |
+the size of volumes to be deleted is too large! + |
+Too many disks are specified in the request for batch deleting disks. + |
+Reduce the number of disks specified in the batch. + |
+
400 + |
+EVS.1054 + |
+invalid shareable parameter! + |
+Input parameter shareable is invalid. + |
+Check whether parameter shareable is correctly specified. + |
+
400 + |
+EVS.1057 + |
+invalid hw:passthrough in metadata! + |
+Input parameter hw:passthrough under metadata is invalid. + |
+Check whether parameter hw:passthrough is correctly specified. + |
+
400 + |
+EVS.1058 + |
+invalid metadata filter! + |
+Metadata decoding error. + |
+Check whether parameter metadata is correctly specified. + |
+
400 + |
+EVS.1061 + |
+The Volume Tags is Exceed Max Limit Num. + |
+The tag quantity of this EVS disk exceeds the upper limit. + |
+Ensure that the tag quantity of the disk is within the upper limit. + |
+
400 + |
+EVS.1062 + |
+invalid tag! + |
+Invalid tag. + |
+Check the formats of the tag key and tag value and ensure that the formats are correct. + |
+
400 + |
+EVS.1063 + |
+invalid full_clone in metadata! + |
+Input parameter full_clone under metadata is invalid. + |
+Check whether parameter full_clone in metadata is correctly specified. + |
+
400 + |
+EVS.1064 + |
+volume status must be available or in-use when extending! + |
+A disk can be expanded only when its status is available or in-use. + |
+Ensure that the disk is in the available or in-use state before expansion. + |
+
400 + |
+EVS.1065 + |
+multiattach volume status must be available when extending! + |
+A shared disk can be expanded only when its status is available. + |
+Ensure that the shared disk is in the available state before expansion. + |
+
400 + |
+EVS.1066 + |
+status of ECS or BMS does not support volume online extension! + |
+The ECS or BMS status does to meet the requirement of online disk expansion. + |
+Ensure that the ECS or BMS status meets the requirement. + |
+
400 + |
+EVS.1070 + |
+invalid request. + |
+Request conversion error. + |
+Check whether the request body is correct. + |
+
500 + |
+EVS.2001 + |
+submit job failed! + |
+Failed to submit the task. + |
+Contact customer service. + |
+
500 + |
+EVS.2002 + |
+internal error! + |
+The system is currently unavailable. + |
+Contact customer service. + |
+
500 + |
+EVS.2005 + |
+client exception! + |
+A connection exception occurs. + |
+Contact customer service. + |
+
500 + |
+EVS.2007 + |
+update volume timeout! + |
+Updating the metadata of the disk timed out. + |
+Try again later or contact customer service. + |
+
500 + |
+EVS.2010 + |
+exchange token failed! + |
+Failed to obtain the token for the tenant. + |
+Check the user permissions. + |
+
500 + |
+EVS.2011 + |
+delete orderId and productId timeout! + |
+Deleting order information from the disk metadata timed out. + |
+Try again later or contact customer service. + |
+
500 + |
+EVS.2013 + |
+assume role error! + |
+Failed to elevate the permissions. + |
+Contact customer service. + |
+
500 + |
+EVS.2014 + |
+thread is interrupted when sleep! + |
+Failed to escalate rights. + |
+Try again later or contact customer service. + |
+
500 + |
+EVS.2019 + |
+snapshot is error_deleting! + |
+Failed to delete the snapshot because the snapshot is in the error_deleting status. + |
+Contact customer service. + |
+
500 + |
+EVS.2020 + |
+volume is error_deleting! + |
+Failed to delete the disk because the disk is in the error_deleting status. + |
+Contact customer service. + |
+
500 + |
+EVS.2021 + |
+volume is error_detaching! + |
+The disk status is error_detaching. + |
+Try again later or contact customer service. + |
+
500 + |
+EVS.2023 + |
+ConnectException happened! + |
+Network connection timed out. + |
+Try again. If the network fails, check the network status. +If the network status is normal, contact customer service. + |
+
500 + |
+EVS.2024 + |
+volume is error! + |
+The status of the created disk is error. + |
+Contact customer service. + |
+
500 + |
+EVS.2025 + |
+volume is error_restoring! + |
+The status of the created disk is error_restoring. + |
+Contact customer service. + |
+
500 + |
+EVS.2026 + |
+volume is error_extending! + |
+Failed to expand the disk capacity because the disk is in the error_extending state. + |
+Contact customer service. + |
+
500 + |
+EVS.2029 + |
+The size of joIdList and resultList are mismatched! + |
+Incorrect subtask quantity. + |
+Contact customer service. + |
+
500 + |
+EVS.2030 + |
+query context based on parent jobId exception! + |
+Failed to submit the subtask again. + |
+Contact customer service. + |
+
500 + |
+EVS.2031 + |
+result queried from context is null! + |
+Failed to query the context. + |
+Contact customer service. + |
+
500 + |
+EVS.2032 + |
+some volume count quota usage params are null! + |
+Failed to query the disk quantity quota assigned to the tenant. + |
+Try again later or contact customer service. + |
+
500 + |
+EVS.2033 + |
+some volume gigabytes quota usage params are null! + |
+Failed to query the disk capacity quota assigned to the tenant. + |
+Try again later or contact customer service. + |
+
500 + |
+EVS.2034 + |
+domainId decoded from token is null or empty! + |
+Token resolution failure. + |
+Check whether the account information is correct. + |
+
500 + |
+EVS.2035 + |
+domainName decoded from token is null or empty! + |
+Token resolution failure. + |
+Check whether the account information is correct. + |
+
500 + |
+EVS.2036 + |
+the result of decode token is null! + |
+Empty token. + |
+Check whether the account information is correct. + |
+
400 + |
+EVS.2040 + |
+The status of encrypt Key is not enable! + |
+Incorrect key status. + |
+Ensure that the key status is correct. + |
+
400 + |
+EVS.2041 + |
+The encrypt Param is invalid! + |
+The input encryption parameter is invalid. + |
+Check whether the encryption parameter in the request body is correct. + |
+
500 + |
+EVS.2042 + |
+Failed to create cmk. + |
+Failed to create the CMK. + |
+Try again later or contact customer service. + |
+
400 + |
+EVS.2043 + |
+The status of snapshot is not available or backing-up. + |
+The snapshot status is in correct. + |
+Ensure that the snapshot status is available or backing-up. + |
+
404 + |
+EVS.2044 + |
+Failed to check the role of kms. + |
+Failed to check KMS. + |
+Try again later or contact customer service. + |
+
400 + |
+EVS.2045 + |
+invalid snapshot_id! + |
+Input parameter snapshot_id is invalid. + |
+Ensure that the input snapshot_id value is correct. + |
+
400 + |
+EVS.2046 + |
+invalid imageRef! + |
+Input parameter imageRef is invalid. + |
+Ensure that the input imageRef value is correct. + |
+
400 + |
+EVS.2047 + |
+the metadata Param is not allowed to be updated! + |
+The metadata field cannot be modified. + |
+Ensure that the input metadata value is correct. + |
+
500 + |
+EVS.2050 + |
+set volume Qos failed! + |
+Failed to set the disk QoS. + |
+Ensure that the input qos value is correct. + |
+
400 + |
+EVS.2052 + |
+the job result using order id to query is invalid! + |
+The job corresponding to the order ID is not unique. + |
+Try again later or contact customer service. + |
+
400 + |
+EVS.2053 + |
+The az information from request is invalid! + |
+Input parameter availability_zone is invalid. + |
+Ensure that the input availability_zone value is correct. + |
+
400 + |
+EVS.2054 + |
+Cannot create volume from snapshot as the az is invalid! + |
+When the disk is created from a snapshot, the input availability_zone value of the disk is inconsistent with that of the snapshot. + |
+Ensure that the availability_zone value of the disk is consistent with that of the snapshot. + |
+
400 + |
+EVS.2055 + |
+can not create encrypt volume because hasn't xrole. + |
+KMS access rights have not been granted to EVS. + |
+Before you use the disk encryption function, KMS access rights need to be granted to EVS. Grant the KMS access rights to EVS on the management console. After the rights have been granted, EVS can obtain KMS keys to encrypt or decrypt EVS disks. +For details about how to grant the KMS access rights, see EVS Disk Encryption in the Elastic Volume Service User Guide. + |
+
403 + |
+EVS.2056 + |
+action in pdp check deny! + |
+Fine-grained PDP authentication failed. + |
+Check whether the account has relevant permissions, or the account is in arrears, does not pass real-name authentication, or has violations. + |
+
400 + |
+EVS.2068 + |
+operation failed because of volume be locked + |
+Operations cannot be performed on locked resources. + |
+Unlock the resource and then perform the operation. + |
+
400 + |
+EVS.2070 + |
+VolumeTypes are not supported ! + |
+Disk type does not exist. + |
+Try again later or contact customer service. + |
+
400 + |
+EVS.2071 + |
+Invalid input received: Availability zone [%s] do not have volume type [%s] + |
+This type of disks in the current AZ is sold out. + |
+Try again later or contact customer service. + |
+
400 + |
+EVS.2072 + |
+Volume type [SSD] in availability zone [AZ1] is sold out ! + |
+Disks of the ultra-high I/O type in AZ1 are sold out. + NOTE:
+The ultra-high I/O disk type and AZ1 are used as the sample disk type and AZ. The disk type and AZ vary depending on the actual condition. + |
+Select another disk type or contact customer service. + |
+
400 + |
+EVS.2078 + |
+checkQuotaCapacity request body is invalid. + |
+Request conversion error. + |
+Check whether the request body is empty. + |
+
400 + |
+EVS.2083 + |
+AZ and volume type must not be empty or null! + |
+The AZ or disk type parameter in the request is invalid. + |
+Ensure that the input AZ and disk type parameters are correct. + |
+
400 + |
+EVS.2084 + |
+resource size must greater than zero! + |
+The disk size parameter in the request is invalid. + |
+Check whether the disk size specified in the request body is correct. + |
+
400 + |
+EVS.2085 + |
+when operation type is SPEC_CHG, resource id must not be empty or null! + |
+The disk ID is invalid during expansion. + |
+Check whether the disk ID specified in the request body is correct. + |
+
400 + |
+EVS.2087 + |
+retype failed. please make sure that type is supported and the new one is higher than origin + |
+Invalid request parameter. + |
+Ensure that the new type has higher specifications than the old type. + |
+
400 + |
+EVS.2089 + |
+operation failed because the volume is belong to SDRS + |
+The disk is used by the SDRS service. + |
+Free the disk from SDRS or select another disk. + |
+
400 + |
+EVS.2093 + |
+operation failed because the volume is not EVS + |
+The disk is not an EVS disk. + |
+This operation cannot be performed because the disk is not an EVS disk. + |
+
400 + |
+EVS.2094 + |
+system image is not support to create Multiattach/shareable volume ! + |
+A shared disk cannot be created from a system disk image. + |
+A shared disk cannot be created from a system disk image. + |
+
400 + |
+EVS.2096 + |
+Target volumeType[%s] is not matched with snapshot[%s] ! + |
+When a disk is created from a snapshot, the disk type of the snapshot's source disk is inconsistent with that of the new disk. + |
+Ensure that the disk type of the snapshot's source disk is consistent with that of the new disk. + |
+
500 + |
+EVS.2105 + |
+Volume can not be reverted, because the encrypt volume's __system__cmkid is not exist! + |
+The ID of the CMK used to encrypt the disk does not exist, or has been deleted and cannot be restored. + |
+Contact customer service. + |
+
400 + |
+EVS.2108 + |
+Request body is invalid. + |
+Request conversion error. + |
+Check whether the request body is correct. + |
+
400 + |
+EVS.2130 + |
+Volume is backing-up, forbidden deleting! + |
+Failed to delete the disk because the snapshot is in the backing-up state when a disk backup is being created. + |
+Wait until the backup is created or contact customer service. + |
+
400 + |
+EVS.2131 + |
+Query server info from ecs fail + |
+Failed to query the server details. + |
+Try again later or contact customer service. + |
+
400 + |
+EVS.2134 + |
+call ecs api - attach volume fail. + |
+Failed to attach the disk. + |
+Try again later or contact customer service. + |
+
400 + |
+EVS.2142 + |
+invalid filter limit, can not greater than 1000. + |
+Request parameter limit cannot be greater than 1000. + |
+Ensure that the limit value ranges from 1 to 1000. The default value is 1000. + |
+
401 + |
+EVS.2143 + |
+You need to create an agency for this project for the first time ever + |
+The account does not have the encryption permission. + |
+Create an agency. + |
+
403 + |
+EVS.2144 + |
+Your account is frozen and resources cannot be used. + |
+Insufficient permission because the account is frozen. + |
+Check whether either of the following conditions exists: (If no such condition exists, contact customer service.)
+
|
+
403 + |
+EVS.2145 + |
+Your account is suspended and resources cannot be used. + |
+Insufficient permission because the account is suspended. + |
+Check whether any of the following conditions exists: (If no such condition exists, contact customer service.)
+
|
+
400 + |
+EVS.5400 + |
+Malformed request body. + |
+Incorrect request body parameter and format. + |
+Check whether the parameters and format of the request body are correct. + |
+
400 + |
+EVS.5400 + |
+Malformed request url. + |
+Incorrect request URL parameter and format. + |
+Check whether the parameters and format of the request URL are correct. + |
+
400 + |
+EVS.5400 + |
+Request body and URI mismatch. + |
+Request body and URI mismatch. + |
+Check whether the request body and URI belong to the same API. + |
+
400 + |
+EVS.5400 + |
+Invalid imageRef provided. + |
+The image is unavailable. + |
+Select another image. + |
+
400 + |
+EVS.5400 + |
+Must specify a valid status. + |
+The disk status is incorrect. + |
+Specify a disk that is in the correct state. + |
+
400 + |
+EVS.5400 + |
+offset param must be an integer. + |
+The value of parameter offset must be an integer. + |
+Set the value of parameter offset to an integer. + |
+
400 + |
+EVS.5400 + |
+limit param must be an integer. + |
+The value of parameter limit must be set to an integer. + |
+Set the value of parameter limit to an integer. + |
+
400 + |
+EVS.5400 + |
+limit param must be positive. + |
+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. + |
+
401 + |
+EVS.5401 + |
+Authentication required. + |
+This operation is unauthorized. + |
+Call the API after authorization. + |
+
403 + |
+EVS.5403 + |
+Policy check failed. + |
+Insufficient permission. + |
+Add the permission and try again. + |
+
403 + |
+EVS.5403 + |
+metadata can not be operated. + |
+No operation permission. + |
+Modifying parameter metadata is forbidden. + |
+
404 + |
+EVS.5404 + |
+Resource(Volume, Snapshot, Backup .etc) cound not be found. + |
+Resources, such as the disk, snapshot, and backup, do not exist. + |
+Check whether the resources are available. + |
+
413 + |
+EVS.5413 + |
+Insufficient volume quota. + |
+Insufficient disk quotas. + |
+Check whether the disk capacity and quantity quotas are sufficient. + |
+
500 + |
+EVS.5500 + |
+Internal server error. + |
+Internal server error. + |
+Try again later or contact customer service. + |
+
503 + |
+EVS.5503 + |
+Service unavailable. + |
+The service is unavailable. + |
+Try again later or contact customer service. + |
+
400 + |
+Common.0011 + |
+query job fail. + |
+Incorrect tenant ID. The tenant ID is actually the project ID. + |
+Use the correct tenant ID and ensure that the tenant has desired permissions. The tenant ID is actually the project ID. + |
+
400 + |
+Common.0011 + |
+No jobs found. + |
+jobId is empty. + |
+Enter the correct jobId value. + |
+
400 + |
+Common.0011 + |
+query job fail. + |
+Failed to query JobVO using jobId. + |
+Check whether the jobId value is correct. If the jobId value is correct, check whether the request is delivered to the target EVS service node. If the request has been delivered, contact customer service to locate the fault. If the request has not been delivered, contact customer service to deliver the request to the target EVS service node. + |
+
400 + |
+Common.0013 + |
+Invalid token in the header. + |
+Failed to parse the token because the token expires or the token string is incomplete. + |
+Obtain the token again and ensure that the token string is complete. + |
+
400 + |
+Common.0018 + |
+Invalid token in the header + |
+The project ID in the URI is different from the project ID in the token. + |
+Ensure that the project ID in the URI is the same as that in the token and try again. + |
+
Status Code + |
+Description + |
+
|---|---|
200 + |
+OK + |
+
201 + |
+Created + |
+
202 + |
+Accepted + |
+
204 + |
+No Content + |
+
Status Code + |
+Description + |
+
|---|---|
400 + |
+Bad Request + |
+
401 + |
+Unauthorized + |
+
403 + |
+Forbidden + |
+
404 + |
+Not Found + |
+
405 + |
+Method Not Allowed + |
+
406 + |
+Not Acceptable + |
+
407 + |
+Proxy Authentication Required + |
+
408 + |
+Request Timeout + |
+
409 + |
+Conflict + |
+
413 + |
+overLimit + |
+
415 + |
+badMediaType + |
+
500 + |
+Internal Server Error + |
+
501 + |
+Not Implemented + |
+
502 + |
+Bad Gateway + |
+
503 + |
+Service Unavailable + |
+
504 + |
+Gateway Timeout + |
+
EVS Disk Status + |
+Description + |
+
|---|---|
creating + |
+The EVS disk is being created. + |
+
available + |
+The EVS disk has not been attached to any server and can be attached. + |
+
in-use + |
+The EVS disk is attached to a server and is in use. + |
+
error + |
+An error occurs when you try to create an EVS disk. + |
+
attaching + |
+The EVS disk is being attached. + |
+
detaching + |
+The EVS disk is being detached. + |
+
restoring-backup + |
+The EVS disk is being restored from a backup. + |
+
backing-up + |
+The EVS disk is being created from a backup. + |
+
error_restoring + |
+An error occurs when you try to restore the EVS disk from a backup. + |
+
uploading + |
+Data on the EVS disk is being uploaded to an image. This status occurs when you create an image from a server. + |
+
downloading + |
+Data is being downloaded from an image to the EVS disk. This status occurs when you create a server. + |
+
extending + |
+The capacity of the EVS disk is being expanded. + |
+
error_extending + |
+An error occurs when you try to expand the capacity of the EVS disk. + |
+
deleting + |
+The EVS disk is being deleted. + |
+
error_deleting + |
+An error occurs when you try to delete the EVS disk. + |
+
rollbacking + |
+Data on the EVS disk is being restored from a snapshot. + NOTE:
+
|
+
error_rollbacking + |
+An error occurs when the EVS disk is being rolled back from a snapshot. + |
+
awaiting-transfer + |
+The EVS disk is awaiting for a transfer. + |
+
EVS Snapshot Status + |
+Description + |
+
|---|---|
creating + |
+The EVS snapshot is being created. + |
+
available + |
+The EVS snapshot is successfully created. + |
+
error + |
+An error occurs when you try to create an EVS snapshot. + |
+
deleting + |
+The EVS snapshot is being deleted. + |
+
error_deleting + |
+An error occurs when you try to delete an EVS snapshot. + |
+
rollbacking + |
+The EVS snapshot is rolling back data. + NOTE:
+
|
+
backing-up + |
+The EVS snapshot is being created from a backup via a native OpenStack API. +The system is automatically creating the EVS snapshot when an EVS disk is created from a backup via an API. + |
+
EVS Replication Pair Status + |
+Description + |
+
|---|---|
creating + |
+The EVS replication pair is being created. + |
+
available + |
+The EVS replication pair is successfully created and is available for use. + |
+
error + |
+An error occurs when you try to create an EVS replication pair. + |
+
deleting + |
+The EVS replication pair is being deleted. + |
+
error_deleting + |
+An error occurs when you try to delete an EVS replication pair. + |
+
EVS Replication Pair Replication Status + |
+Description + |
+
|---|---|
active + |
+The replication status of the EVS replication pair is normal, and the data in the production disk is consistent with the data in the DR disk. + |
+
active-stopped + |
+The replication status of the EVS replication pair is paused, and the data in the production disk is consistent with the data in the DR disk. + |
+
copying + |
+The data in the two disks of the EVS replication pair is being synchronized. + |
+
inactive + |
+The replication status of the EVS replication pair is paused, or the data replication is interrupted. Data in the two disks is inconsistent and needs to be synchronized. + |
+
error + |
+The replication status of the EVS replication pair becomes abnormal. + |
+
Replication Consistency Group Status + |
+Description + |
+
|---|---|
creating + |
+The replication consistency group is being created. + |
+
available + |
+The replication consistency group is successfully created and is available for use. + |
+
error + |
+An error occurs when you try to create a replication consistency group. + |
+
deleting + |
+The replication consistency group is being deleted. + |
+
updating + |
+The replication consistency group is being updated. The update includes adding EVS replication pairs to and deleting EVS replication pairs from the replication consistency group. + |
+
reversing + |
+The replication consistency group is being migrated as planned. + |
+
error_reversing + |
+An error occurs during a planned migration of the replication consistency group. + |
+
failovering + |
+The failover of the replication consistency group is in progress. + |
+
failovered + |
+The replication consistency group failover is successful. + |
+
error_failovering + |
+An error occurs during a failover of the replication consistency group. + |
+
error_deleting + |
+An error occurs during the deletion of the replication consistency group. + |
+
Replication Consistency Group Replication Status + |
+Description + |
+
|---|---|
active + |
+The replication status of the replication consistency group is normal, and the data in production disks is consistent with the data in DR disks. + |
+
active-stopped + |
+The replication status of the replication consistency group is paused, and the data between production disks and DR disks within the group is inconsistent. + |
+
copying + |
+The data of the replication consistency group is being synchronized. + |
+
inactive + |
+The replication status of the replication consistency group is paused. The data between production disks and DR disks within the group is inconsistent and needs to be synchronized. + |
+
error + |
+The replication status of the replication consistency group becomes abnormal. + |
+
failure_detail Value + |
+Description + |
+Cause + |
+Solution + |
+
|---|---|---|---|
37100041 + |
+Failed to create the EVS replication pair because the production disk capacity is inconsistent with the DR disk capacity. + |
+The production disk capacity is inconsistent with the DR disk capacity. + |
+Ensure that the capacities of the production and DR disks are consistent before you create the EVS replication pair. + |
+
37100043 + + |
+The operation fails because messages failed to be sent to the peer AZ. + |
+A communication error occurred. + |
+Contact technical support to check whether the link status is normal. + |
+
37100044 + |
+Failed to create the EVS replication pair because the specified production disk is a lazyloading EVS disk. + |
+Lazyloading EVS disks cannot be used as member disks of EVS replication pairs. + |
+Wait until the lazyloading process is complete and try again. If the fault persists, contact technical support. + |
+
37100045 + |
+Failed to create the EVS replication pair because the specified DR disk is a lazyloading EVS disk. + |
+Lazyloading EVS disks cannot be used as member disks of EVS replication pairs. + |
+Wait until the lazyloading process is complete and try again. If the fault persists, contact technical support. + |
+
37100048 + |
+Failed to create the EVS replication pair because the specified production disk does not exist. + |
+The specified production disk does not exist. + |
+Specify an existing production disk. + |
+
37100050 + |
+Failed to create the EVS replication pair because the specified DR disk does not exist. + |
+The specified DR disk does not exist. + |
+Specify an existing DR disk. + |
+
37100053 + |
+Failed to create the EVS replication pair because the specified production disk has been used in another EVS replication pair. + |
+The specified production disk is the member disk in another EVS replication pair. + |
+Specify a production disk that has not been used by another EVS replication pair. + |
+
37100054 + |
+Failed to create the EVS replication pair because the specified DR disk has been used in another EVS replication pair. + |
+The specified DR disk is the member disk in another EVS replication pair. + |
+Specify a DR disk that has not been used by another EVS replication pair. + |
+
37100058 + |
+Failed to create the EVS replication pair because the DR disk has been attached to a server and the server is in the Running state. + |
+The specified DR disk has been attached to a server and the server is in the Running state. + |
+Stop the server , or specify a DR disk that has not been attached to any server. + |
+
37100177 + |
+Failed to create the EVS replication pair because the storage pool status of the primary AZ is abnormal. + |
+The storage pool status of the primary AZ is abnormal. + |
+Create the EVS replication pair when the storage pool status is normal. If the fault persists, contact technical support. + |
+
37100178 + |
+Failed to create the EVS replication pair because the storage pool status of the secondary AZ is abnormal. + |
+The storage pool status of the secondary AZ is abnormal. + |
+Create the EVS replication pair when the storage pool status is normal. If the fault persists, contact technical support. + |
+
37000212 + |
+System internal processing failure. + |
+An internal system error occurred. + |
+Contact technical support. + |
+
37000216 + |
+The system is busy. Try again later. + |
+The system is busy. Try again later. + |
+Try again later. If the fault persists, contact technical support. + |
+
failure_detail Value + |
+Description + |
+Cause + |
+Solution + |
+
|---|---|---|---|
37100017 + |
+Failed to create the replication consistency group because the number of replication consistency groups in the primary AZ has reached the upper limit. + + |
+The number of replication consistency groups in the primary AZ has reached the upper limit. + + |
+Contact technical support. + |
+
37100043 + + |
+The operation fails because messages failed to be sent to the peer AZ. + |
+The communication between the primary AZ and secondary AZ fails. + |
+Contact technical support to check whether the link status is normal. + |
+
37100159 + + |
+Failed to create the replication consistency group because the number of replication consistency groups in the secondary AZ has reached the upper limit. + + |
+The number of replication consistency groups in the secondary AZ has reached the upper limit. + + |
+Contact technical support. + |
+
37000212 + |
+System internal processing failure. + |
+An internal system error occurred. + |
+Contact technical support. + |
+
37000216 + |
+The system is busy. Try again later. + |
+The system is busy. Try again later. + |
+Try again later. If the fault persists, contact technical support. + |
+
This topic describes only the authorization information of EVS v2 APIs. For the v3 APIs that provide the same functions as their v2 APIs, their authorization information is the same as that of the v2 APIs.
+For example, the v2 API for creating disks is POST /v2/{project_id}/cloudvolumes, and the v3 API for creating disks is POST /v3/{project_id}/cloudvolumes. The authorization information of both APIs is the same.
+In the following tables, √ indicates that the item is supported, and × indicates that the item is not supported.
+Permission + |
+API + |
+Action + |
+IAM Project +(Project) + |
+
|---|---|---|---|
Query API versions (OpenStack Cinder API). + |
+GET / + |
+None + |
+√ + |
+
Query the API version (OpenStack Cinder API). + |
+GET /{api_version} + |
+None + |
+√ + |
+
Permission + |
+API + |
+Action + |
+IAM Project +(Project) + |
+
|---|---|---|---|
Create EVS disks. + |
+POST /v2/{project_id}/cloudvolumes + |
+evs:volumes:create + |
+√ + |
+
Create EVS disks (OpenStack Cinder API). + |
+POST /v2/{project_id}/volumes + |
++ | +√ + |
+
Expand the capacity of an EVS disk. + |
+POST /v2/{project_id}/cloudvolumes/{volume_id}/action + |
+evs:volumes:extend + |
+√ + |
+
Query EVS disks. + |
+GET /v2/{project_id}/cloudvolumes + |
+evs:volumes:list + |
+√ + |
+
Query EVS disks (OpenStack Cinder API). + |
+GET /v2/{project_id}/volumes + |
+evs:volumes:list + |
+√ + |
+
Query details of all EVS disks. + |
+GET /v2/{project_id}/cloudvolumes/detail + |
+evs:volumes:list + |
+√ + |
+
Querying Details About All Disks + |
+GET /v2/{project_id}/os-vendor-volumes/detail + |
+evs:volumes:list + |
+√ + |
+
Query details of all EVS disks (OpenStack Cinder API). + |
+GET /v2/{project_id}/volumes/detail + |
+evs:volumes:list + |
+√ + |
+
Query details of an EVS disk. + |
+GET /v2/{project_id}/os-vendor-volumes/{volume_id} + + |
+evs:volumes:get + |
+√ + |
+
Query details of an EVS disk (OpenStack Cinder API). + |
+GET /v2/{project_id}/volumes/{volume_id} + |
+evs:volumes:get + |
+√ + |
+
Query details of an EVS disk. + |
+GET /v2/{project_id}/cloudvolumes/{volume_id} + |
+evs:volumes:get + |
+√ + |
+
Delete an EVS disk. + |
+DELETE /v2/{project_id}/cloudvolumes/{volume_id} + |
+evs:volumes:delete + |
+√ + |
+
Delete an EVS disk (OpenStack Cinder API). + |
+DELETE /v2/{project_id}/volumes/{volume_id} + |
+evs:volumes:delete +evs:volumes:get + |
+√ + |
+
Update EVS disk information. + |
+PUT /v2/{project_id}/cloudvolumes/{volume_id} + |
+evs:volumes:update + |
+√ + |
+
Update EVS disk information (OpenStack Cinder API). + |
+PUT /v2/{project_id}/volumes/{volume_id} + |
+evs:volumes:update +evs:volumes:get + |
+√ + |
+
Update one piece of EVS disk metadata (OpenStack Cinder API). + |
+PUT /v2/{project_id}/volumes/{volume_id}/metadata/{key} + |
+evs:volumes:update +evs:volumes:get + |
+√ + |
+
Update the metadata of an EVS disk (OpenStack Cinder API). + |
+PUT /v2/{project_id}/volumes/{volume_id}/metadata + |
+evs:volumes:update +evs:volumes:get + |
+√ + |
+
Query one piece of EVS disk metadata (OpenStack Cinder API). + |
+GET /v2/{project_id}/volumes/{volume_id}/metadata/{key} + |
+evs:volumes:get + |
+√ + |
+
Delete one piece of EVS disk metadata (OpenStack Cinder API). + |
+DELETE /v2/{project_id}/volumes/{volume_id}/metadata/{key} + |
+evs:volumes:delete +evs:volumes:get + |
+√ + |
+
Query the metadata of an EVS disk (OpenStack Cinder API). + |
+GET /v2/{project_id}/volumes/{volume_id}/metadata/{key} + |
+evs:volumes:get + |
+√ + |
+
Add the metadata of an EVS disk (OpenStack Cinder API). + |
+POST /v2/{project_id}/volumes/{volume_id}/metadata + |
+evs:volumes:update +evs:volumes:get + |
+√ + |
+
Query EVS disk types (OpenStack Cinder API). + |
+GET /v2/{project_id}/types + |
+evs:types:get + |
+√ + |
+
Query details of an EVS disk type (OpenStack Cinder API). + |
+GET /v2/{project_id}/types/{type_id} + |
+evs:types:get + |
+√ + |
+
Query tenant quotas (OpenStack Cinder API). + |
+GET /v2/{project_id}/os-quota-sets/{project_id} + |
+evs:quotas:get + |
+√ + |
+
Query extension APIs (OpenStack Cinder API). + |
+GET /v2/{project_id}/extensions + |
+None + |
+√ + |
+
Query information of all AZs (OpenStack Cinder API). + |
+GET /v2/{project_id}/os-availability-zone + |
+None + |
+√ + |
+
Query loading progress of a lazyloading disk. + |
+GET /v3/{project_id}/os-vendor-volumes/{volume_id}/internal-info + |
+evs:volumes:get + |
+√ + |
+
Query EVS disks (OpenStack Cinder API). + |
+GET /v3/{project_id}/volumes/summary + |
+evs:volumes:get +evs:volumes:list + |
+√ + |
+
Permission + |
+API + |
+Action + |
+IAM Project +(Project) + |
+
|---|---|---|---|
Expand the capacity of an EVS disk (OpenStack Cinder API). + |
+POST /v2/{project_id}/volumes/{volume_id}/action +action="os-extend" + |
+evs:volumes:extend +evs:volumes:get + |
+√ + |
+
Export the EVS disk data as an image (OpenStack Cinder API). + + |
+POST /v2/{project_id}/volumes/{volume_id}/action +action="os-volume_upload_image" + |
+evs:volumes:uploadImage + |
+√ + |
+
Attach an EVS disk (OpenStack Cinder API). + + |
+POST /v2/{project_id}/volumes/{volume_id}/action +action="os-attach" + |
+evs:volumes:attach +evs:volumes:get + |
+√ + |
+
Detach an EVS disk (OpenStack Cinder API). + + |
+POST /v2/{project_id}/volumes/{volume_id}/action +action="os-detach" + |
+evs:volumes:detach +evs:volumes:get + |
+√ + |
+
Reserve an EVS disk (OpenStack Cinder API). + |
+POST /v2/{project_id}/volumes/{volume_id}/action +action="os-reserve" + |
+evs:volumes:attach + |
+√ + |
+
Cancel reservation of an EVS disk (OpenStack Cinder API). + + |
+POST /v2/{project_id}/volumes/{volume_id}/action +action="os-unreserve" + |
+evs:volumes:attach + |
+√ + |
+
Set the bootable flag for an EVS disk (OpenStack Cinder API). + + |
+POST /v2/{project_id}/volumes/{volume_id}/action +action="os-set_bootable" + |
+evs:volumes:update + |
+√ + |
+
Set the read-only attribute for an EVS disk (OpenStack Cinder API). + + |
+POST /v2/{project_id}/volumes/{volume_id}/action +action="os-update_readonly_flag" + |
+evs:volumes:update + |
+√ + |
+
Permission + |
+API + |
+Action + |
+IAM Project +(Project) + |
+
|---|---|---|---|
Create an EVS snapshot (OpenStack Cinder API). + |
+POST /v2/{project_id}/snapshots + |
+evs:snapshots:create +evs:volumes:get + |
+√ + |
+
Create an EVS snapshot. + |
+POST /v2/{project_id}/cloudsnapshots + |
+evs:snapshots:create + |
+√ + |
+
Query EVS snapshots (OpenStack Cinder API). + |
+GET /v2/{project_id}/snapshots + |
+evs:snapshots:list + |
+√ + |
+
Query details of EVS snapshots (OpenStack Cinder API). + |
+GET /v2/{project_id}/snapshots/detail + |
+evs:snapshots:list + |
+√ + |
+
Query details about EVS snapshots. + |
+GET /v2/{project_id}/cloudsnapshots/detail + |
+evs:snapshots:list + |
+√ + |
+
Update an EVS snapshot (OpenStack Cinder API). + |
+PUT /v2/{project_id}/snapshots/{snapshot_id} + |
+evs:snapshots:update +evs:snapshots:get + |
+√ + |
+
Update an EVS snapshot. + |
+PUT /v2/{project_id}/cloudsnapshots/{snapshot_id} + |
+evs:snapshots:update + |
+√ + |
+
Query details about a single EVS snapshot (OpenStack Cinder API). + + |
+GET /v2/{project_id}/snapshots/{snapshot_id} + |
+evs:snapshots:get + + |
+√ + |
+
Querying details about an EVS snapshot. + + |
+GET /v2/{project_id}/cloudsnapshots/{snapshot_id} + |
+evs:snapshots:get + + |
+√ + |
+
Delete an EVS snapshot (OpenStack Cinder API). + |
+DELETE /v2/{project_id}/snapshots/{snapshot_id} + |
+evs:snapshots:delete +evs:snapshots:get +evs:volumes:get + |
+√ + |
+
Deleting an EVS snapshot. + |
+DELETE /v2/{project_id}/cloudsnapshots/{snapshot_id} + |
+evs:snapshots:delete + |
+√ + |
+
Roll back a snapshot to an EVS disk. + |
+POST /v2/{project_id}/cloudsnapshots/{snapshot_id}/rollback + |
+evs:snapshots:rollback + |
+√ + |
+
Roll back a snapshot to an EVS disk. + |
+POST /v2/{project_id}/os-vendor-snapshots/{snapshot_id}/rollback + |
+evs:snapshots:rollback +evs:snapshots:get +evs:volumes:get + |
+√ + |
+
Add the metadata of an EVS snapshot (OpenStack Cinder API). + |
+POST /v2/{project_id}/snapshots/{snapshot_id}/metadata + |
+evs:snapshots:update +evs:snapshots:get + |
+√ + |
+
Query the metadata of an EVS snapshot (OpenStack Cinder API). + |
+GET /v2/{project_id}/snapshots/{snapshot_id}/metadata + |
+evs:snapshots:get + |
+√ + |
+
Update one piece of EVS snapshot metadata (OpenStack Cinder API). + |
+PUT /v2/{project_id}/snapshots/{snapshot_id}/metadata/{key} + |
+evs:snapshots:update +evs:snapshots:get + |
+√ + |
+
Update the metadata of an EVS snapshot (OpenStack Cinder API). + |
+PUT /v2/{project_id}/snapshots/{snapshot_id}/metadata + |
+evs:snapshots:update +evs:snapshots:get + |
+√ + |
+
Query one piece of EVS snapshot metadata (OpenStack Cinder API). + |
+GET /v2/{project_id}/snapshots/{snapshot_id}/metadata/{key} + |
+evs:snapshots:get + |
+√ + |
+
Delete one piece of EVS snapshot metadata (OpenStack Cinder API). + |
+DELETE /v2/{project_id}/snapshots/{snapshot_id}/metadata/{key} + |
+evs:snapshots:delete +evs:snapshots:get + |
+√ + |
+
Permission + |
+API + |
+Action + |
+IAM Project +(Project) + |
+
|---|---|---|---|
Obtain all EVS tags of a tenant. + |
+GET /v2/{project_id}/os-vendor-tags/{resource_type} + |
+
|
+√ + |
+
Query EVS resources by tag. + |
+GET /v2/{project_id}/os-vendor-tags/{resource_type}/resource_instances + |
+
|
+√ + |
+
Add or update tags for an EVS resource. + |
+POST /v2/{project_id}/os-vendor-tags/{resource_type}/{resource_id} + |
+
|
+√ + |
+
Obtain tags of an EVS resource. + |
+GET /v2/{project_id}/os-vendor-tags/{resource_type}/{resource_id} + |
+
|
+√ + |
+
Reset the tags of an EVS resource. + |
+PUT /v2/{project_id}/os-vendor-tags/{resource_type}/{resource_id} + |
+
|
+√ + |
+
Batch delete the tags for an EVS resource. + |
+POST /v2/{project_id}/os-vendor-tags/{resource_type}/{resource_id}/action + |
++ | +√ + |
+
Delete the tags of an EVS resource by key. + |
+DELETE /v2/{project_id}/os-vendor-tags/{resource_type}/{resource_id}/{key} + |
++ | +√ + |
+
Update the tags of an EVS resource by key. + |
+PUT /v2/{project_id}/os-vendor-tags/{resource_type}/{resource_id}/{key} + |
+
|
+√ + |
+
Batch delete tags for a specified EVS disk. + |
+POST /v2/{project_id}/os-vendor-volumes/{volume_id}/tags/action + |
+evs:volumeTags:delete + |
+√ + |
+
Query the tags of an EVS disk. + |
+GET /v2/{project_id}/os-vendor-volumes/{volume_id}/tags + |
+evs:volumeTags:getById + |
+√ + |
+
Batch add tags for a specified EVS disk. + |
+POST /v2/{project_id}/os-vendor-volumes/{volume_id}/tags/action + |
+evs:volumeTags:create + |
+√ + |
+
Query details of EVS disks by tag. + |
+POST /v2/{project_id}/os-vendor-volumes/resource_instances/action + |
+evs:volumeTags:get + |
+√ + |
+
Query tags of an EVS resource by key. + |
+GET /v2/{project_id}/os-vendor-tags/{resource_type}/{resource_id}/{key} + |
+evs:volumeTags:getById + |
+√ + |
+
Query the number of EVS disks by tag. + |
+POST /v2/{project_id}/os-vendor-volumes/resource_instances/action + |
+evs:volumeTags:get + |
+√ + |
+
Permission + |
+API + |
+Action + |
+IAM Project +(Project) + |
+
|---|---|---|---|
Obtain all EVS tags of a tenant. + |
+GET /v2/{project_id}/cloudvolumes/tags + |
+
|
+√ + |
+
Batch add tags for a specified EVS disk. + |
+POST /v2/{project_id}/cloudvolumes/{volume_id}/tags/action + |
+evs:volumeTags:create + |
+√ + |
+
Batch delete tags for a specified EVS disk. + |
+POST /v2/{project_id}/cloudvolumes/{volume_id}/tags/action + |
+evs:volumeTags:delete + |
+√ + |
+
Query the tags of an EVS disk. + |
+GET /v2/{project_id}/cloudvolumes/{volume_id}/tags + |
+evs:volumeTags:getById + |
+√ + |
+
Query details of EVS disks by tag. + |
+POST /v2/{project_id}/cloudvolumes/resource_instances/action + |
+evs:volumeTags:get + |
+√ + |
+
Permission + |
+API + |
+Action + |
+IAM Project +(Project) + |
+
|---|---|---|---|
Create an EVS disk transfer (OpenStack Cinder API). + |
+POST /v2/{project_id}/os-volume-transfer + |
+evs:transfers:create + |
+√ + |
+
Query all EVS disk transfers of a tenant (OpenStack Cinder API). + |
+GET /v2/{project_id}/os-volume-transfer + |
+evs:transfers:list + |
+√ + |
+
Query details of all EVS disk transfers of a tenant (OpenStack Cinder API). + |
+GET /v2/{project_id}/os-volume-transfer/detail + |
+evs:transfers:list + |
+√ + |
+
Query details of an EVS disk transfer (OpenStack Cinder API). + |
+GET /v2/{project_id}/os-volume-transfer/{transfer_id} + |
+evs:transfers:get + |
+√ + |
+
Accept an EVS disk transfer (OpenStack Cinder API). + |
+POST /v2/{project_id}/os-volume-transfer/{transfer_id}/accept + |
+evs:transfers:accept + |
+√ + |
+
Delete an EVS disk transfer (OpenStack Cinder API). + |
+DELETE /v2/{project_id}/os-volume-transfer/{transfer_id} + |
+evs:transfers:delete + |
+√ + |
+
Released On + |
+Description + |
+
|---|---|
2022-04-15 + |
+Added the following content: +
|
+
2021-09-12 + |
+Modified the following content: +
|
+
2019-02-15 + |
+Modified the following content: +
|
+
2018-11-30 + |
+Modified the following content: +
|
+
2018-09-30 + |
+Added the following content: +
|
+
2018-05-30 + |
+Added the following content: + +Modified the following content: +
|
+
2018-03-30 + |
+Added the following content: +
Modified the following content:
+
|
+
2018-03-15 + |
+Modified the following content: +
|
+
2018-02-23 + |
+Added the following content: +
|
+
2018-02-08 + |
+Modified the following content: +
|
+
2018-01-31 + |
+Added the following content: +
Modified the following content: +
|
+
2018-01-25 + |
+Added the following content: +
|
+
2018-01-19 + |
+Added the following content: +
|
+
2017-12-01 + |
+Modified the following content: +
|
+
2017-11-30 + |
+
+ Modified the following content: +
|
+
2017-10-30 + |
+Added the following content: +
|
+
2017-10-19 + |
+Modified the following content: +
|
+
2017-09-30 + |
+Added the following content: +
|
+
2017-08-18 + |
+Modified the following content: +
|
+
2017-07-30 + |
+Added the following content: +
|
+
2017-06-30 + |
+Modified the following content: +
|
+
2017-06-05 + |
+Added the following content: +
|
+
2017-06-01 + |
+Added the following content: +
Modified the following content: +
|
+
2017-05-30 + |
+Added the following content: +
|
+
2017-05-20 + |
+Added the following content: +
|
+
2017-05-10 + |
+Added the following content: +
|
+
2017-03-30 + |
+Added the following content: +
|
+
2017-02-22 + |
+Added the following content: +
|
+
2016-11-24 + |
+Modified the following content: +
|
+
2016-08-25 + |
+Modified the following content: +
|
+
2016-07-30 + |
+Modified the following content: +
|
+
2016-07-15 + |
+Added the following content: +
|
+
2016-06-16 + |
+Modified the following content: +
|
+
2016-06-02 + |
+Modified the following content: +
|
+
2016-04-14 + |
+Modified the following content: +
|
+
2016-03-09 + |
+This issue is the first official release. + |
+
This API is used to query details about a disk.
+
This API has been deprecated. Use another API. For details, see Querying Details About a Disk.
+GET https://{endpoint}/v1/{project_id}/volumes/b104b8db-170d-441b-897a-3c8ba9c5a214
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
volume + |
+Object + |
+Specifies the disk information. For details, see Parameters in the volume field. + |
+
error + |
+Object + |
+Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+Specifies the disk ID. + |
+
display_name + |
+String + |
+Specifies the disk name. + |
+
status + |
+String + |
+Specifies the disk status. For details, see EVS Disk Status. + |
+
attachments + |
+list + |
+Specifies the attachment information. + |
+
availability_zone + |
+String + |
+Specifies the AZ to which the disk belongs. + |
+
os-vol-host-attr:host + |
+String + |
+Reserved field + |
+
source_volid + |
+String + |
+Specifies the source disk ID. This parameter has a value if the disk is created from a source disk. +Currently, this field is not supported by EVS. + |
+
snapshot_id + |
+String + |
+Specifies the snapshot ID. This parameter has a value if the disk is created from a snapshot. + |
+
display_description + |
+String + |
+Specifies the disk description. + |
+
created_at + |
+String + |
+Specifies the time when the disk was created. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
volume_type + |
+String + |
+Specifies the disk type. +Currently, the value can be SSD, SAS, SATA, co-p1, or uh-l1.
+
|
+
os-vol-tenant-attr:tenant_id + |
+String + |
+Specifies the ID of the tenant to which the disk belongs. The tenant ID is actually the project ID. + |
+
size + |
+Integer + |
+Specifies the disk size, in GB. + |
+
metadata + |
+Object + |
+Specifies the disk metadata. +If metadata does not contain the hw:passthrough field, the disk device type is VBD. +If metadata does not contain the __system__encrypted field, the disk is not encrypted. + |
+
os-vol-mig-status-attr:migstat + |
+String + |
+Reserved field + |
+
os-vol-mig-status-attr:name_id + |
+String + |
+Reserved field + |
+
os-volume-replication:extended_status + |
+String + |
+Reserved field + |
+
encrypted + |
+Boolean + |
+Currently, this field is not supported by EVS. + |
+
bootable + |
+String + |
+Specifies whether the disk is bootable.
+
|
+
shareable + |
+String + |
+Specifies whether the disk is shareable. + NOTE:
+This field is no longer used. Use multiattach. + |
+
multiattach + |
+Boolean + |
+Specifies whether the disk is shareable.
+
|
+
volume_image_metadata + |
+Object + |
+Specifies the metadata of the disk image. This field has a value if the disk is created from an image. Otherwise, it is left empty. + NOTE:
+For details about volume_image_metadata, see Querying Image Details (Native OpenStack API) in the Image Management Service API Reference. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
server_id + |
+String + |
+Specifies the ID of the server to which the disk is attached. + |
+
attachment_id + |
+String + |
+Specifies the ID of the attachment information. + |
+
attached_at + |
+String + |
+Specifies the time when the disk was attached. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
host_name + |
+String + |
+Specifies the name of the physical host accommodating the server to which the disk is attached. + |
+
volume_id + |
+String + |
+Specifies the disk ID. + |
+
device + |
+String + |
+Specifies the device name. + |
+
id + |
+String + |
+Specifies the ID of the attached resource. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
__system__encrypted + |
+String + |
+Specifies the parameter that describes the encryption function in metadata. The value can be 0 or 1.
+
|
+
__system__cmkid + |
+String + |
+Specifies the encryption CMK ID in metadata. This parameter is used together with __system__encrypted for encryption. The length of cmkid is fixed at 36 bytes. + |
+
hw:passthrough + |
+String + |
+Specifies the parameter that describes the disk device type in metadata. The value can be true or false.
+
|
+
full_clone + |
+String + |
+Specifies the clone method. When the disk is created from a snapshot, the parameter value is 0, indicating the linked cloning method. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "volume": {
+ "attachments": [],
+ "availability_zone": "az-dc-1",
+ "os-vol-host-attr:host": "db-rabbitmq201#LVM_iSCSI",
+ "encrypted": false,
+ "os-volume-replication:extended_status": null,
+ "volume_image_metadata": null,
+ "snapshot_id": null,
+ "id": "da4f9c7a-c275-4bc9-80c4-76c7d479a218",
+ "size": 1,
+ "os-vol-tenant-attr:tenant_id": "3dab0aaf682849678a94ec7b5a3af2ce",
+ "os-vol-mig-status-attr:migstat": null,
+ "metadata": {},
+ "status": "available",
+ "display_description": null,
+ "source_volid": null,
+ "os-vol-mig-status-attr:name_id": null,
+ "display_name": "test",
+ "bootable": "false",
+ "created_at": "2014-12-18T17:14:38.000000",
+ "volume_type": "SATA",
+ "multiattach": false
+ }
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badrequest or itemNotFound. An example is provided as follows:
+{
+ "itemNotFound": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to query the execution status of tasks, such as the status of disk creation, capacity expansion, and deletion.
+The following example shows how to query the status of the task whose task ID is ff808081692a62c70169b4dcf9514264.
+ GET https://{endpoint}/v1/{project_id}/jobs/ff808081692a62c70169b4dcf9514264
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
status + |
+String + |
+Specifies the task status. +
|
+
entities + |
+Object + |
+Specifies the response to the task. For details, see •Parameters in the entities field. +The contents for each type of task are different. + |
+
job_id + |
+String + |
+Specifies the task ID. + |
+
job_type + |
+String + |
+Specifies the task type. +
|
+
begin_time + |
+String + |
+Specifies the time when the task was started. +Time format: YYYY-MM-DDTHH:MM:SS.SSS'Z' + |
+
end_time + |
+String + |
+Specifies the time when the task finished. +Time format: YYYY-MM-DDTHH:MM:SS.SSS'Z' + |
+
error_code + |
+String + |
+Specifies the returned error code when the task execution fails. + |
+
fail_reason + |
+String + |
+Specifies 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. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
name + |
+String + |
+Specifies the EVS disk name. + |
+
size + |
+Integer + |
+Specifies 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. + |
+
volume_id + |
+String + |
+Specifies the disk ID. + |
+
volume_type + |
+String + |
+Specifies the disk type. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
status + |
+String + |
+Specifies the task status. +
|
+
entities + |
+Object + |
+Specifies the response to the task. For details, see •Parameters in the entities field. +The content for each type of task is different. + |
+
job_id + |
+String + |
+Specifies the task ID. + |
+
job_type + |
+String + |
+Specifies the task type. +
|
+
begin_time + |
+String + |
+Specifies the time when the task was started. +Time format: YYYY-MM-DDTHH:MM:SS.SSS'Z' + |
+
end_time + |
+String + |
+Specifies the time when the task finished. +Time format: YYYY-MM-DDTHH:MM:SS.SSS'Z' + |
+
error_code + |
+String + |
+Specifies the returned error code when the task execution fails. + |
+
fail_reason + |
+String + |
+Specifies the cause of the task execution failure. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
name + |
+String + |
+Specifies the EVS disk name. + |
+
size + |
+Integer + |
+Specifies the disk size, in GB. + |
+
volume_id + |
+String + |
+Specifies the disk ID. + |
+
volume_type + |
+String + |
+Specifies the disk type. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "status": "RUNNING",
+ "entities": {
+ "volume_id": "bdf1bb37-f20f-4266-9a04-f43e0a127376"
+ },
+ "job_id": "4010a32d535527910153552b492c0002",
+ "job_type": "createVolume",
+ "begin_time": "2016-03-08T07:40:13.219Z",
+ "end_time": "",
+ "error_code": null,
+ "fail_reason": null
+}
+or
+{
+ "status": "SUCCESS",
+ "entities": {
+ "sub_jobs": [
+ {
+ "status": "SUCCESS",
+ "entities": {
+ "volume_id": "0b549095-4937-4849-8e4c-52aa027d64f7"
+ },
+ "job_id": "21917a8d52a19b040152a9f2f2e50041",
+ "job_type": "createVolume",
+ "begin_time": "2016-02-04T01:43:37.445Z",
+ "end_time": "2016-02-04T01:44:02.239Z",
+ "error_code": null,
+ "fail_reason": null
+ },
+ {
+ "status": "SUCCESS",
+ "entities": {
+ "volume_id": "e7bca1a2-d3ed-434f-86f4-a1f11aa80072"
+ },
+ "job_id": "21917a8d52a19b040152a9f2f2f60042",
+ "job_type": "createVolume",
+ "begin_time": "2016-02-04T01:43:37.462Z",
+ "end_time": "2016-02-04T01:44:02.245Z",
+ "error_code": null,
+ "fail_reason": null
+ }
+ ]
+ },
+ "job_id": "21917a8d52a19b040152a9f2f1eb003e",
+ "job_type": "batchCreateVolume",
+ "begin_time": "2016-02-04T01:43:37.193Z",
+ "end_time": "2016-02-04T01:44:08.283Z",
+ "error_code": null,
+ "fail_reason": null
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to query details about all disks.
+Parameter + |
+Mandatory + |
+Description + |
+
|---|---|---|
project_id + |
+Yes + |
+Specifies the project ID. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
marker + |
+String + |
+No + |
+Specifies the ID of the last record on the previous page. The returned value is the value of the item after this one. + |
+
name + |
+String + |
+No + |
+Specifies the disk name. The value can contain a maximum of 255 bytes. + |
+
status + |
+String + |
+No + |
+Specifies the disk status. For details, see EVS Disk Status. + |
+
limit + |
+Integer + |
+No + |
+Specifies 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. + |
+
availability_zone + |
+String + |
+No + |
+Specifies the AZ. + |
+
sort_key + |
+String + |
+No + |
+Specifies the keyword based on which the returned results are sorted. The value can be id, status, size, or created_at, and the default value is created_at. + |
+
sort_dir + |
+String + |
+No + |
+Specifies the result sorting order. The default value is desc.
+
|
+
GET https://{endpoint}/v2/{project_id}/cloudvolumes/detail?status=available
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
volumes + |
+Array of objects + |
+Specifies the list of queried disks. For details, see Parameters in the volumes field. + |
+
error + |
+Object + |
+Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+Specifies the disk ID. + |
+
links + |
+Array of objects + |
+Specifies the disk URI. For details, see Parameters in the links field. + |
+
name + |
+String + |
+Specifies the disk name. + |
+
status + |
+String + |
+Specifies the disk status. For details, see EVS Disk Status. + |
+
attachments + |
+Array of objects + |
+Specifies the disk attachment information. For details, see Parameters in the attachments field. + |
+
availability_zone + |
+String + |
+Specifies the AZ to which the disk belongs. + |
+
source_volid + |
+String + |
+Specifies the source disk ID. This parameter has a value if the disk is created from a source disk. +Currently, this field is not supported by EVS. + |
+
snapshot_id + |
+String + |
+Specifies the snapshot ID. This parameter has a value if the disk is created from a snapshot. + |
+
description + |
+String + |
+Specifies the disk description. + |
+
os-vol-tenant-attr:tenant_id + |
+String + |
+Specifies the ID of the tenant to which the disk belongs. The tenant ID is actually the project ID. + |
+
volume_image_metadata + |
+Object + |
+Specifies the metadata of the disk image. + NOTE:
+For details about volume_image_metadata, see Querying Image Details (Native OpenStack API) in the Image Management Service API Reference. + |
+
created_at + |
+String + |
+Specifies the time when the disk was created. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
volume_type + |
+String + |
+Specifies the disk type. +Currently, the value can be SSD, SAS, SATA, co-p1, or uh-l1.
+
|
+
size + |
+Integer + |
+Specifies the disk size, in GB. + |
+
bootable + |
+String + |
+Specifies whether the disk is bootable.
+
|
+
metadata + |
+Object + |
+Specifies the disk metadata. For details, see Parameters in the metadata field. +If metadata does not contain the hw:passthrough field, the disk device type is VBD. +If metadata does not contain the __system__encrypted field, the disk is not encrypted. + |
+
os-vol-host-attr:host + |
+String + |
+Reserved field + |
+
shareable + |
+String + |
+Specifies whether the disk is shareable. + NOTE:
+This field is no longer used. Use multiattach. + |
+
multiattach + |
+Boolean + |
+Specifies whether the disk is shareable.
+
|
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
href + |
+String + |
+Specifies the corresponding shortcut link. + |
+
rel + |
+String + |
+Specifies the shortcut link marker name. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
server_id + |
+String + |
+Specifies the ID of the server to which the disk is attached. + |
+
attachment_id + |
+String + |
+Specifies the ID of the attachment information. + |
+
attached_at + |
+String + |
+Specifies the time when the disk was attached. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
host_name + |
+String + |
+Specifies the name of the physical host accommodating the server to which the disk is attached. + |
+
volume_id + |
+String + |
+Specifies the disk ID. + |
+
device + |
+String + |
+Specifies the device name. + |
+
id + |
+String + |
+Specifies the ID of the attached resource. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
__system__encrypted + |
+String + |
+Specifies the parameter that describes the encryption function in metadata. The value can be 0 or 1.
+
|
+
__system__cmkid + |
+String + |
+Specifies the encryption CMK ID in metadata. This parameter is used together with __system__encrypted for encryption. The length of cmkid is fixed at 36 bytes. + |
+
hw:passthrough + |
+String + |
+Specifies the parameter that describes the disk device type in metadata. The value can be true or false.
+
|
+
full_clone + |
+String + |
+Specifies the clone method. When the disk is created from a snapshot, the parameter value is 0, indicating the linked cloning method. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "volumes": [
+ {
+ "id": "c6ccc84e-feff-4114-ad83-42a11c0434e2",
+ "links": [
+ {
+ "href": "https://volume.az0.dc1.domainname.com/v2/9e179fd535e44f19a9dabb36deadf47e/volumes/c6ccc84e-feff-4114-ad83-42a11c0434e2",
+ "rel": "self"
+ },
+ {
+ "href": "https://volume.az0.dc1.domainname.com/9e179fd535e44f19a9dabb36deadf47e/volumes/c6ccc84e-feff-4114-ad83-42a11c0434e2",
+ "rel": "bookmark"
+ }
+ ],
+ "name": "test_volume",
+ "status": "available",
+ "attachments": [ ],
+ "description": null,
+ "size": 100,
+ "metadata": null,
+ "bootable": "false",
+ "availability_zone": "az-dc-1",
+ "os-vol-host-attr:host": "az-dc-1#sata",
+ "source_volid": null,
+ "snapshot_id": null,
+ "created_at": "2015-09-17T06:37:16.275659",
+ "volume_type": "SATA",
+ "os-vol-tenant-attr:tenant_id": "9e179fd535e44f19a9dabb36deadf47e",
+ "volume_image_metadata": null
+ },
+ {
+ "id": "a05d9342-bf27-44a6-8ab8-33afc7545d19",
+ "links": [
+ {
+ "href": "https://volume.az0.dc1.domainname.com/v2/9e179fd535e44f19a9dabb36deadf47e/volumes/a05d9342-bf27-44a6-8ab8-33afc7545d19",
+ "rel": "self"
+ },
+ {
+ "href": "https://volume.az0.dc1.domainname.com/9e179fd535e44f19a9dabb36deadf47e/volumes/a05d9342-bf27-44a6-8ab8-33afc7545d19",
+ "rel": "bookmark"
+ }
+ ],
+ "name": "test_volume",
+ "status": "available",
+ "attachments": [ ],
+ "description": null,
+ "size": 100,
+ "metadata": null,
+ "bootable": "false",
+ "availability_zone": "az-dc-1",
+ "os-vol-host-attr:host": "az-dc-1#sata",
+ "source_volid": null,
+ "snapshot_id": null,
+ "created_at": "2015-09-17T06:37:16.192556",
+ "volume_type": "SATA",
+ "os-vol-tenant-attr:tenant_id": "9e179fd535e44f19a9dabb36deadf47e",
+ "volume_image_metadata": null
+ }
+ ]
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to delete an EVS disk.
+DELETE https://{endpoint}/v2/{project_id}/cloudvolumes/b104b8db-170d-441b-897a-3c8ba9c5a214
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
job_id + |
+String + |
+Specifies the task ID. + NOTE:
+For details about how to query the task status, see Querying Task Status. + |
+
error + |
+Object + |
+Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "job_id": "70a599e0-31e7-49b7-b260-868f441e862b"
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to update the name and description of an EVS disk.
+
This API has been deprecated. Use another API. For details, see Updating an EVS Disk.
+Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
volume + |
+Object + |
+Yes + |
+Specifies the information of the disk to be updated. For details, see Parameters in the volume field. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
name + |
+String + |
+No + |
+Specifies the new name of the disk. Parameters name and description cannot be null at the same time. The value can contain a maximum of 255 bytes. + |
+
description + |
+String + |
+No + |
+Specifies the new description of the disk. name and description cannot be null at the same time. The value can contain a maximum of 255 bytes. + |
+
{
+ "volume": {
+ "name": "test_volume",
+ "description": "test"
+ }
+}
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+Specifies the disk ID. + |
+
links + |
+Array of objects + |
+Specifies the disk URI. For details, see Parameters in the links field. + |
+
name + |
+String + |
+Specifies the disk name. + |
+
status + |
+String + |
+Specifies the disk status. For details, see EVS Disk Status. + |
+
attachments + |
+Array of objects + |
+Specifies the disk attachment information. For details, see Parameters in the attachments field. + |
+
availability_zone + |
+String + |
+Specifies the AZ to which the disk belongs. + |
+
source_volid + |
+String + |
+Specifies the source disk ID. This parameter has a value if the disk is created from a source disk. +Currently, this field is not supported by EVS. + |
+
snapshot_id + |
+String + |
+Specifies the snapshot ID. This parameter has a value if the disk is created from a snapshot. + |
+
description + |
+String + |
+Specifies the disk description. + |
+
os-vol-tenant-attr:tenant_id + |
+String + |
+Specifies the ID of the tenant to which the disk belongs. Currently, the returned parameter value is invalid. The tenant ID is actually the project ID. + |
+
volume_image_metadata + |
+Object + |
+Specifies the metadata of the disk image. Currently, the returned parameter value is invalid. + NOTE:
+For details about volume_image_metadata, see Querying Image Details (Native OpenStack API) in the Image Management Service API Reference. + |
+
created_at + |
+String + |
+Specifies the time when the disk was created. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
volume_type + |
+String + |
+Specifies the disk type. +Currently, the value can be SSD, SAS, SATA, co-p1, or uh-l1.
+
|
+
size + |
+Integer + |
+Specifies the disk size, in GB. + |
+
bootable + |
+String + |
+Specifies whether the disk is bootable.
+
|
+
metadata + |
+Object + |
+Specifies the disk metadata. For details, see Parameters in the metadata field. + |
+
os-vol-host-attr:host + |
+String + |
+Reserved field + |
+
shareable + |
+String + |
+Specifies whether the disk is shareable. + NOTE:
+This field is no longer used. Use multiattach. + |
+
error + |
+Object + |
+Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + |
+
multiattach + |
+Boolean + |
+Specifies whether the disk is shareable.
+
|
+
os-volume-replication:extended_status + |
+String + |
+Reserved field + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
href + |
+String + |
+Specifies the corresponding shortcut link. + |
+
rel + |
+String + |
+Specifies the shortcut link marker name. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
server_id + |
+String + |
+Specifies the ID of the server to which the disk is attached. + |
+
attachment_id + |
+String + |
+Specifies the ID of the attachment information. + |
+
attached_at + |
+String + |
+Specifies the time when the disk was attached. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
host_name + |
+String + |
+Specifies the name of the physical host accommodating the server to which the disk is attached. + |
+
volume_id + |
+String + |
+Specifies the disk ID. + |
+
device + |
+String + |
+Specifies the device name. + |
+
id + |
+String + |
+Specifies the ID of the attached resource. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
__system__encrypted + |
+String + |
+Specifies the parameter that describes the encryption function in metadata. The value can be 0 or 1.
+
|
+
__system__cmkid + |
+String + |
+Specifies the encryption CMK ID in metadata. This parameter is used together with __system__encrypted for encryption. The length of cmkid is fixed at 36 bytes. + |
+
hw:passthrough + |
+String + |
+Specifies the parameter that describes the disk device type in metadata. The value can be true or false.
+
|
+
full_clone + |
+String + |
+Specifies the clone method. When the disk is created from a snapshot, the parameter value is 0, indicating the linked cloning method. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "id": "36ba39af-3579-4e6e-adfc-b764349c0f77",
+ "links": [
+ {
+ "href": "https://volume.region.xxx.xxx-tsi.de/v2/3cfb09080bd944d0b4cdd72ef26857bd/volumes/36ba39af-3579-4e6e-adfc-b764349c0f77",
+ "rel": "self"
+ },
+ {
+ "href": "https://volume.region.xxx.xxx-tsi.de/3cfb09080bd944d0b4cdd72ef26857bd/volumes/36ba39af-3579-4e6e-adfc-b764349c0f77",
+ "rel": "bookmark"
+ }
+ ],
+ "name": "newVolume",
+ "status": "in-use",
+ "attachments": [
+ {
+ "server_id": "c3d3250c-7ce5-42cc-b620-dd2b63d19ca5",
+ "attachment_id": "011a2bdb-a033-4479-845b-50bd8ed7f4d4",
+ "attached_at": "2017-05-23T11:27:38.604815",
+ "host_name": null,
+ "volume_id": "36ba39af-3579-4e6e-adfc-b764349c0f77",
+ "device": "/dev/sdf",
+ "id": "36ba39af-3579-4e6e-adfc-b764349c0f77"
+ }
+ ],
+ "description": "new volume",
+ "multiattach": false,
+ "shareable": false,
+ "size": 10,
+ "metadata": {
+ "policy": "dc71a9c9-b3fa-429d-a070-037682d82d21",
+ "attached_mode": "rw",
+ "readonly": "False",
+ "hw:passthrough": "false"
+ },
+ "bootable": "false",
+ "availability_zone": "az-dc-1",
+ "os-vol-host-attr:host": null,
+ "source_volid": null,
+ "snapshot_id": null,
+ "created_at": "2017-05-23T09:49:44.481299",
+ "volume_type": "SATA",
+ "os-vol-tenant-attr:tenant_id": null,
+ "os-volume-replication:extended_status": null,
+ "volume_image_metadata": null
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to query details about all disks.
+Parameter + |
+Mandatory + |
+Description + |
+
|---|---|---|
project_id + |
+Yes + |
+Specifies the project ID. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
marker + |
+String + |
+No + |
+Specifies the ID of the last record on the previous page. The returned value is the value of the item after this one. + |
+
name + |
+String + |
+No + |
+Specifies the disk name. The value can contain a maximum of 255 bytes. + |
+
limit + |
+Integer + |
+No + |
+Specifies 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. + |
+
sort_key + |
+String + |
+No + |
+Specifies the keyword based on which the returned results are sorted. The value can be id, status, size, or created_at, and the default value is created_at. + |
+
sort_dir + |
+String + |
+No + |
+Specifies the result sorting order. The default value is desc. +
|
+
offset + |
+Integer + |
+No + |
+Specifies the offset. All disks after this offset will be queried. The value must be an integer greater than 0 but less than the number of disks. + |
+
status + |
+String + |
+No + |
+Specifies the disk status. For details, see EVS Disk Status. + |
+
metadata + |
+String + |
+No + |
+Specifies the disk metadata. + |
+
availability_zone + |
+String + |
+No + |
+Specifies the AZ to which the disk belongs. + |
+
multiattach + |
+Boolean + |
+No + |
+Specifies whether the disk is shareable.
+
|
+
volume_type_id + |
+String + |
+No + |
+Specifies the disk type ID. + |
+
id + |
+String + |
+No + |
+Specifies the disk ID. + |
+
ids + |
+Array of strings + |
+No + |
+Specifies the disk IDs. The parameter value is in the ids=['id1','id2',...,'idx'] format. In the response, the ids value contains valid disk IDs only. Invalid disk IDs will be ignored. +Details about a maximum of 60 disks can be queried. +If parameters id and ids are both specified in the request, id will be ignored. + |
+
GET https://{endpoint}/v2/{project_id}/os-vendor-volumes/detail?status=available&multiattach=true
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
volumes + |
+Array of objects + |
+Specifies the list of queried disks. For details, see Parameters in the volumes field. + |
+
volumes_links + |
+Array of objects + |
+Specifies the query position marker in the disk list. If only some disks are returned in this query, the URL of the last disk queried will be returned. You can use this URL to continue to query the remaining disks in the next query. For details, see Parameters in the links field. + |
+
count + |
+Integer + |
+Specifies the number of queried disks. This value is not affected by the pagination. + |
+
error + |
+Object + |
+Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+Specifies the disk ID. + |
+
links + |
+Array of objects + |
+Specifies the disk URI. For details, see Parameters in the links field. + |
+
name + |
+String + |
+Specifies the disk name. + |
+
status + |
+String + |
+Specifies the disk status. For details, see EVS Disk Status. + |
+
attachments + |
+Array of objects + |
+Specifies the disk attachment information. For details, see Parameters in the attachments field. + |
+
availability_zone + |
+String + |
+Specifies the AZ to which the disk belongs. + |
+
os-vol-host-attr:host + |
+String + |
+Reserved field + |
+
source_volid + |
+String + |
+Specifies the source disk ID. This parameter has a value if the disk is created from a source disk. +Currently, this field is not supported by EVS. + |
+
snapshot_id + |
+String + |
+Specifies the snapshot ID. This parameter has a value if the disk is created from a snapshot. + |
+
description + |
+String + |
+Specifies the disk description. + |
+
created_at + |
+String + |
+Specifies the time when the disk was created. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
volume_type + |
+String + |
+Specifies the disk type. +Currently, the value can be SSD, SAS, SATA, co-p1, or uh-l1.
+
|
+
os-vol-tenant-attr:tenant_id + |
+String + |
+Specifies the ID of the tenant to which the disk belongs. The tenant ID is actually the project ID. + |
+
size + |
+Integer + |
+Specifies the disk size, in GB. + |
+
metadata + |
+Object + |
+Specifies the disk metadata. For details, see Parameters in the metadata field. +If metadata does not contain the hw:passthrough field, the disk device type is VBD. +If metadata does not contain the __system__encrypted field, the disk is not encrypted. + |
+
os-vol-mig-status-attr:migstat + |
+String + |
+Reserved field + |
+
os-vol-mig-status-attr:name_id + |
+String + |
+Reserved field + |
+
os-volume-replication:extended_status + |
+String + |
+Reserved field + |
+
encrypted + |
+Boolean + |
+Currently, this field is not supported by EVS. + |
+
replication_status + |
+String + |
+Reserved field + |
+
user_id + |
+String + |
+Reserved field + |
+
consistencygroup_id + |
+String + |
+Reserved field + |
+
bootable + |
+String + |
+Specifies whether the disk is bootable.
+
|
+
updated_at + |
+String + |
+Specifies the time when the disk was updated. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
shareable + |
+String + |
+Specifies whether the disk is shareable. + NOTE:
+This field is no longer used. Use multiattach. + |
+
multiattach + |
+Boolean + |
+Specifies whether the disk is shareable.
+
|
+
volume_image_metadata + |
+Object + |
+Specifies the metadata of the disk image. This field has a value if the disk is created from an image. Otherwise, it is left empty. + NOTE:
+For details about volume_image_metadata, see Querying Image Details (Native OpenStack API) in the Image Management Service API Reference. + |
+
tags + |
+Object + |
+Specifies the disk tags. +This field is returned if the disk has tags. Otherwise, it is left empty. + |
+
wwn + |
+String + |
+Specifies the unique identifier used when attaching the disk. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
href + |
+String + |
+Specifies the corresponding shortcut link. + |
+
rel + |
+String + |
+Specifies the shortcut link marker name. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
server_id + |
+String + |
+Specifies the ID of the server to which the disk is attached. + |
+
attachment_id + |
+String + |
+Specifies the ID of the attachment information. + |
+
attached_at + |
+String + |
+Specifies the time when the disk was attached. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
host_name + |
+String + |
+Specifies the name of the physical host accommodating the server to which the disk is attached. + |
+
volume_id + |
+String + |
+Specifies the disk ID. + |
+
device + |
+String + |
+Specifies the device name. + |
+
id + |
+String + |
+Specifies the ID of the attached resource. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
__system__encrypted + |
+String + |
+Specifies the parameter that describes the encryption function in metadata. The value can be 0 or 1.
+
|
+
__system__cmkid + |
+String + |
+Specifies the encryption CMK ID in metadata. This parameter is used together with __system__encrypted for encryption. The length of cmkid is fixed at 36 bytes. + |
+
hw:passthrough + |
+String + |
+Specifies the parameter that describes the disk device type in metadata. The value can be true or false.
+
|
+
full_clone + |
+String + |
+Specifies the clone method. When the disk is created from a snapshot, the parameter value is 0, indicating the linked cloning method. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "count": 1,
+ "volumes": [
+ {
+ "attachments": [ ],
+ "availability_zone": "az-dc-1",
+ "bootable": "false",
+ "consistencygroup_id": null,
+ "created_at": "2016-05-25T02:42:10.856332",
+ "description": null,
+ "encrypted": false,
+ "id": "b104b8db-170d-441b-897a-3c8ba9c5a214",
+ "links": [
+ {
+ "href": "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/b104b8db-170d-441b-897a-3c8ba9c5a214",
+ "rel": "self"
+ },
+ {
+ "href": "https://volume.localdomain.com:8776/dd14c6ac581f40059e27f5320b60bf2f/volumes/b104b8db-170d-441b-897a-3c8ba9c5a214",
+ "rel": "bookmark"
+ }
+ ],
+ "metadata": {},
+ "name": "zjb_u25_test",
+ "os-vol-host-attr:host": "pod01.xxx#SATA",
+ "volume_image_metadata": { },
+ "os-vol-mig-status-attr:migstat": null,
+ "os-vol-mig-status-attr:name_id": null,
+ "os-vol-tenant-attr:tenant_id": "dd14c6ac581f40059e27f5320b60bf2f",
+ "os-volume-replication:extended_status": null,
+ "replication_status": "disabled",
+ "multiattach": false,
+ "size": 1,
+ "snapshot_id": null,
+ "source_volid": null,
+ "status": "available",
+ "updated_at": "2016-05-25T02:42:22.341984",
+ "user_id": "b0524e8342084ef5b74f158f78fc3049",
+ "volume_type": "SATA",
+ "service_type": "EVS",
+ "wwn": " 688860300000d136fa16f48f05992360"
+ }
+ ],
+ "volumes_links": [
+ {
+ "href": "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/detail?limit=1&marker=b104b8db-170d-441b-897a-3c8ba9c5a214",
+ "rel": "next"
+ }
+ ]
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badRequest or itemNotFound. An example is provided as follows:
+{
+ "badRequest": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to query details about a disk.
+GET https://{endpoint}/v2/{project_id}/os-vendor-volumes/b104b8db-170d-441b-897a-3c8ba9c5a214
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
volume + |
+Object + |
+Specifies the queried disk. For details, see Parameters in the volume field. + |
+
error + |
+Object + |
+Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+Specifies the disk ID. + |
+
links + |
+Array of objects + |
+Specifies the disk URI. For details, see Parameters in the links field. + |
+
name + |
+String + |
+Specifies the disk name. + |
+
status + |
+String + |
+Specifies the disk status. For details, see EVS Disk Status. + |
+
attachments + |
+Array of objects + |
+Specifies the disk attachment information. For details, see Parameters in the attachments field. + |
+
availability_zone + |
+String + |
+Specifies the AZ to which the disk belongs. + |
+
source_volid + |
+String + |
+Specifies the source disk ID. This parameter has a value if the disk is created from a source disk. +Currently, this field is not supported by EVS. + |
+
snapshot_id + |
+String + |
+Specifies the snapshot ID. This parameter has a value if the disk is created from a snapshot. + |
+
description + |
+String + |
+Specifies the disk description. + |
+
os-vol-tenant-attr:tenant_id + |
+String + |
+Specifies the ID of the tenant to which the disk belongs. The tenant ID is actually the project ID. + |
+
volume_image_metadata + |
+Object + |
+Specifies the metadata of the disk image. + NOTE:
+For details about volume_image_metadata, see Querying Image Details (Native OpenStack API) in the Image Management Service API Reference. + |
+
created_at + |
+String + |
+Specifies the time when the disk was created. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
volume_type + |
+String + |
+Specifies the disk type. +Currently, the value can be SSD, SAS, SATA, co-p1, or uh-l1.
+
|
+
size + |
+Integer + |
+Specifies the disk size, in GB. + |
+
bootable + |
+String + |
+Specifies whether the disk is bootable.
+
|
+
metadata + |
+Object + |
+Specifies the disk metadata. For details, see Parameters in the metadata field. +If metadata does not contain the hw:passthrough field, the disk device type is VBD. +If metadata does not contain the __system__encrypted field, the disk is not encrypted. + |
+
os-vol-host-attr:host + |
+String + |
+Reserved field + |
+
encrypted + |
+Boolean + |
+Currently, this field is not supported by EVS. + |
+
updated_at + |
+String + |
+Specifies the time when the disk was updated. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
os-volume-replication:extended_status + |
+String + |
+Reserved field + |
+
replication_status + |
+String + |
+Reserved field + |
+
os-vol-mig-status-attr:migstat + |
+String + |
+Reserved field + |
+
consistencygroup_id + |
+String + |
+Reserved field + |
+
os-vol-mig-status-attr:name_id + |
+String + |
+Reserved field + |
+
shareable + |
+String + + |
+Specifies whether the disk is shareable. + NOTE:
+This field is no longer used. Use multiattach. + |
+
user_id + |
+String + |
+Reserved field + |
+
multiattach + |
+Boolean + |
+Specifies whether the disk is shareable.
+
|
+
service_type + |
+String + |
+Specifies the service type. The value can be EVS. + |
+
tags + |
+Object + |
+Specifies the disk tags. +This field is returned if the disk has tags. Otherwise, it is left empty. + |
+
wwn + |
+String + |
+Specifies the unique identifier used when attaching the disk. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
href + |
+String + |
+Specifies the corresponding shortcut link. + |
+
rel + |
+String + |
+Specifies the shortcut link marker name. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
server_id + |
+String + |
+Specifies the ID of the server to which the disk is attached. + |
+
attachment_id + |
+String + |
+Specifies the ID of the attachment information. + |
+
attached_at + |
+String + |
+Specifies the time when the disk was attached. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
host_name + |
+String + |
+Specifies the name of the physical host accommodating the server to which the disk is attached. + |
+
volume_id + |
+String + |
+Specifies the disk ID. + |
+
device + |
+String + |
+Specifies the device name. + |
+
id + |
+String + |
+Specifies the ID of the attached resource. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
__system__encrypted + |
+String + |
+Specifies the parameter that describes the encryption function in metadata. The value can be 0 or 1.
+
|
+
__system__cmkid + |
+String + |
+Specifies the encryption CMK ID in metadata. This parameter is used together with __system__encrypted for encryption. The length of cmkid is fixed at 36 bytes. + |
+
hw:passthrough + |
+String + |
+Specifies the parameter that describes the disk device type in metadata. The value can be true or false.
+
|
+
full_clone + |
+String + |
+Specifies the clone method. When the disk is created from a snapshot, the parameter value is 0, indicating the linked cloning method. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "volume": {
+ "attachments": [ ],
+ "links": [
+ {
+ "href": "https://volume.az0.dc1.domainname.com/v2/40acc331ac784f34842ba4f08ff2be48/volumes/591ac654-26d8-41be-bb77-4f90699d2d41",
+ "rel": "self"
+ },
+ {
+ "href": "https://volume.az0.dc1.domainname.com/40acc331ac784f34842ba4f08ff2be48/volumes/591ac654-26d8-41be-bb77-4f90699d2d41",
+ "rel": "bookmark"
+ }
+ ],
+ "availability_zone": "az-dc-1",
+ "os-vol-host-attr:host": "az-dc-1#SSD",
+ "encrypted": false,
+ "multiattach": true,
+ "updated_at": "2016-02-03T02:19:29.895237",
+ "os-volume-replication:extended_status": null,
+ "replication_status": "disabled",
+ "snapshot_id": null,
+ "id": "591ac654-26d8-41be-bb77-4f90699d2d41",
+ "size": 40,
+ "user_id": "fd03ee73295e45478d88e15263d2ee4e",
+ "os-vol-tenant-attr:tenant_id": "40acc331ac784f34842ba4f08ff2be48",
+ "volume_image_metadata": null,
+ "os-vol-mig-status-attr:migstat": null,
+ "metadata": {},
+ "tags": {
+ "key1": "value1",
+ "key2": "value2"
+ },
+ "status": "available",
+ "description": "auto-created_from_restore_from_backup",
+ "source_volid": null,
+ "consistencygroup_id": null,
+ "os-vol-mig-status-attr:name_id": null,
+ "name": "restore_backup_0115efb3-678c-4a9e-bff6-d3cd278238b9",
+ "bootable": "false",
+ "created_at": "2016-02-03T02:19:11.723797",
+ "volume_type": null,
+ "service_type": "EVS",
+ "wwn": " 688860300000d136fa16f48f05992360"
+ }
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badrequest or itemNotFound. An example is provided as follows:
+{
+ "badrequest": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to query EVS disks and display the query results in a list.
+
This API has been deprecated. Use another API. For details, see Querying EVS Disks.
+Parameter + |
+Mandatory + |
+Description + |
+
|---|---|---|
project_id + |
+Yes + |
+Specifies the project ID. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
marker + |
+String + |
+No + |
+Specifies the ID of the last record on the previous page. The returned value is the value of the item after this one. + |
+
name + |
+String + |
+No + |
+Specifies the disk name. The value can contain a maximum of 255 bytes. + |
+
status + |
+String + |
+No + |
+Specifies the disk status. For details, see EVS Disk Status. + |
+
limit + |
+Integer + |
+No + |
+Specifies 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. + |
+
availability_zone + |
+String + |
+No + |
+Specifies the AZ. + |
+
sort_key + |
+String + |
+No + |
+Specifies the keyword based on which the returned results are sorted. The value can be id, status, size, or created_at, and the default value is created_at. + |
+
sort_dir + |
+String + |
+No + |
+Specifies the result sorting order. The default value is desc.
+
|
+
GET https://{endpoint}/v2/{project_id}/cloudvolumes?status=available
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
volumes + |
+Array of objects + |
+Specifies the list of queried disks. For details, see Parameters in the volumes field. + |
+
error + |
+Object + |
+Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+Specifies the disk ID. + |
+
links + |
+Array of objects + |
+Specifies the disk URI. For details, see Parameters in the links field. + |
+
name + |
+String + |
+Specifies the disk name. The value can contain a maximum of 255 bytes. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
href + |
+String + |
+Specifies the corresponding shortcut link. + |
+
rel + |
+String + |
+Specifies the shortcut link marker name. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "volumes": [
+ {
+ "id": "e6cf4401-15f6-44bd-ae2b-cff4dc9523e6",
+ "links": [
+ {
+ "href": "https://volume.az0.dc1.domainname.com/v2/cd631140887d4b6e9c786b67a6dd4c02/volumes/e6cf4401-15f6-44bd-ae2b-cff4dc9523e6",
+ "rel": "self"
+ },
+ {
+ "href": "https://volume.az0.dc1.domainname.com/cd631140887d4b6e9c786b67a6dd4c02/volumes/e6cf4401-15f6-44bd-ae2b-cff4dc9523e6",
+ "rel": "bookmark"
+ }
+ ],
+ "name": "hallo5"
+ },
+ {
+ "id": "4c5e8203-f70e-4717-90cd-4a8f636888d1",
+ "links": [
+ {
+ "href": "https://volume.az0.dc1.domainname.com/v2/cd631140887d4b6e9c786b67a6dd4c02/volumes/4c5e8203-f70e-4717-90cd-4a8f636888d1",
+ "rel": "self"
+ },
+ {
+ "href": "https://volume.az0.dc1.domainname.com/cd631140887d4b6e9c786b67a6dd4c02/volumes/4c5e8203-f70e-4717-90cd-4a8f636888d1",
+ "rel": "bookmark"
+ }
+ ],
+ "name": "hallo4"
+ }
+ ]
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to create one or multiple EVS disks.
+Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
volume + |
+Object + |
+Yes + |
+Specifies the information of the disks to be created. For details, see Parameters in the volume field. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
backup_id + |
+String + |
+No + |
+Specifies the ID of the backup that can be used to create a disk. This parameter is mandatory when you use a backup to create the disk. + NOTE:
+For how to obtain the backup ID, see Querying All Backups in the Cloud Backup and Recovery API Reference. + |
+
availability_zone + |
+String + |
+Yes + |
+Specifies the AZ where you want to create the disk. If the AZ does not exist, the disk will fail to create. + NOTE:
+For details about how to obtain the AZ, see Querying All AZs. + |
+
description + |
+String + |
+No + |
+Specifies the disk description. The value can contain a maximum of 255 bytes. + |
+
size + |
+Integer + |
+No + |
+Specifies the disk size, in GB. Its value can be as follows:
+
This parameter is mandatory when you create an empty disk. You can specify the parameter value as required within the value range. +This parameter is mandatory when you create the disk from a snapshot. Ensure that the disk size is greater than or equal to the snapshot size. +This parameter is mandatory when you create the disk from an image. Ensure that the disk size is greater than or equal to the minimum disk capacity required by min_disk in the image attributes. +This parameter is optional when you create the disk from a backup. If this parameter is not specified, the disk size is equal to the backup size. + NOTE:
+If the specified parameter value is a decimal, the integral part of the value is used by default when the request is sent. + |
+
name + |
+String + |
+No + |
+Specifies the disk name. +
|
+
snapshot_id + |
+String + |
+No + |
+Specifies the snapshot ID. If this parameter is specified, the disk is created from a snapshot. + NOTE:
+For details about how to obtain the snapshot ID, see Querying Details About EVS Snapshots. + |
+
imageRef + |
+String + |
+No + |
+Specifies the image ID. If this parameter is specified, the disk is created from an image. + NOTE:
+BMS system disks cannot be created from BMS images. +For how to obtain the image ID, see Querying Images in the Image Management Service API Reference. + |
+
volume_type + |
+String + |
+Yes + |
+Specifies the disk type. +Currently, the value can be SSD, SAS, SATA, co-p1, or uh-l1.
+
If the specified disk type is not available in the AZ, the disk will fail to create. + NOTE:
+
|
+
count + |
+Integer + |
+No + |
+Specifies the number of disks to be created in a batch. If this parameter is not specified, only one disk is created. You can create a maximum of 100 disks in a batch. +If disks are created from a backup, batch creation is not supported, and this parameter must be set to 1. + NOTE:
+If the specified parameter value is a decimal, the integral part of the value is used by default when the request is sent. + |
+
shareable + |
+String + |
+No + |
+Specifies whether the disk is shareable. The value can be true (shared disk) or false (common disk). + NOTE:
+This field is no longer used. Use multiattach. + |
+
metadata + |
+Object + |
+No + |
+Specifies the metadata of the created disk. The length of the key or value in the metadata cannot exceed 255 bytes. +For details about metadata, see Parameters in the metadata field. Only the listed parameters can be specified when creating a disk. + NOTE:
+Parameter values under metadata cannot be null. + |
+
multiattach + |
+Boolean + |
+No + |
+Specifies whether the disk is shareable. The default value is false.
+
|
+
tags + |
+Object + |
+No + |
+Specifies the tags added to the disk during the disk creation. +A maximum of 10 tags can be created for a disk. +Tag keys of a tag must be unique. Deduplication will be performed for duplicate keys. Therefore, only one tag key in the duplicate keys is valid. +
|
+
Specifying either two of the backup_id, snapshot_id, and imageRef fields is not supported.
+Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
__system__encrypted + |
+String + |
+No + |
+Specifies the encryption field in metadata. The value can be 0 (not encrypted) or 1 (encrypted). +If this parameter does not exist, the disk will not be encrypted by default. + |
+
__system__cmkid + |
+String + |
+No + |
+Specifies the encryption CMK ID in metadata. This parameter is used together with __system__encrypted for encryption. The length of cmkid is fixed at 36 bytes. + NOTE:
+For details about how to obtain the CMK ID, see Querying the List of CMKs in the Key Management Service API Reference. + |
+
hw:passthrough + |
+String + |
+No + |
+
|
+
full_clone + |
+String + |
+No + |
+If the disk is created from a snapshot and linked cloning needs to be used, set this parameter to 0. + |
+
When creating a disk, you can only specify the fields of metadata listed in the preceding table.
+{
+ "volume": {
+ "backup_id": null,
+ "count": 1,
+ "availability_zone": "az-dc-1",
+ "description": "test_volume_1",
+ "size": 120,
+ "name": "test_volume_1",
+ "volume_type": "SSD",
+ "metadata": {
+ "__system__encrypted": "1",
+ "__system__cmkid": "37b0d52e-c249-40d6-83cb-2b93f22445bd"
+ }
+ }
+}
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
job_id + |
+String + |
+Specifies the task ID. + NOTE:
+For details about how to query the task status, see Querying Task Status. + |
+
error + |
+Object + |
+Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "job_id": "70a599e0-31e7-49b7-b260-868f441e862b"
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to expand the capacity of an EVS disk.
+
This API call exists for compatibility reasons only and is not meant to be used.
+Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
os-extend + |
+Object + |
+Yes + |
+Specifies the disk expansion marker. For details, see Parameter in the os-extend field. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
new_size + |
+Integer + |
+Yes + |
+Specifies the size of the disk after capacity expansion, in GB. +The new disk size ranges from the original disk size to the maximum size (32768 for a data disk and 1024 for a system disk). + NOTE:
+If the specified parameter value is a decimal, the integral part of the value is used by default when the request is sent. + |
+
{
+ "os-extend": {
+ "new_size": 200
+ }
+}
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
job_id + |
+String + |
+Specifies the task ID. + NOTE:
+For details about how to query the task status, see Querying Task Status. + |
+
error + |
+Object + |
+Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "job_id": "70a599e0-31e7-49b7-b260-868f441e862b"
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to roll back a snapshot to an EVS disk.
+Parameter + |
+Mandatory + |
+Description + |
+
|---|---|---|
project_id + |
+Yes + |
+Specifies the project ID. + |
+
snapshot_id + |
+Yes + |
+Specifies the snapshot ID. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
rollback + |
+Object + |
+Yes + |
+Specifies the snapshot rollback information. For details, see Parameters in the rollback field. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
volume_id + |
+String + |
+Yes + |
+Specifies the ID of the target disk. + |
+
name + |
+String + |
+No + |
+Specifies the name of the target disk. The value can contain a maximum of 255 bytes. + NOTE:
+Parameter name cannot be used independently. When name is going to be used, volume_id must also be specified. + |
+
{
+ "rollback": {
+ "name": "test-001",
+ "volume_id": "5aa119a8-d25b-45a7-8d1b-88e127885635"
+ }
+}
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
rollback + |
+Object + |
+Specifies the snapshot rollback information. For details, see Parameter in the rollback field. + |
+
error + |
+Object + |
+Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
volume_id + |
+String + |
+Specifies the ID of the target disk. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "rollback": {
+ "volume_id": "5aa119a8-d25b-45a7-8d1b-88e127885635"
+ }
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badRequest or itemNotFound. An example is provided as follows:
+{
+ "badRequest": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to delete tags of an EVS resource by key.
+None
+DELETE /v2/{project_id}/os-vendor-tags/{resource_type}/{resource_id}/{key}
+Parameter + |
+Mandatory + |
+Description + |
+
|---|---|---|
project_id + |
+Yes + |
+Specifies the project ID. + |
+
resource_type + |
+Yes + |
+Specifies the resource type. The value can be volumes, snapshots, or backups. + |
+
resource_id + |
+Yes + |
+Specifies the resource ID. The value can be the ID of a disk, snapshot, or backup. + |
+
key + |
+Yes + |
+Specifies the key of the tag. + |
+
None
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
error + |
+Object + |
+Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
For details, see Error Codes.
+This API is used to obtain all tags of an EVS resource type.
+None
+None
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
tags + |
+Object + |
+Specifies the tag information about all EVS disks. + |
+
{
+ "tags": {
+ "key_0": [
+ "value_0"
+ ],
+ "key_1": [
+ "value_1",
+ "value_2",
+ "value_3",
+ "value_4"
+ ]
+ }
+}
+For details, see Error Codes.
+This API is used to batch add tags for the specified EVS disk.
+None
+Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
tags + |
+Array of objects + |
+Yes + |
+Specifies the tag list. For details, see Parameters in the tag field. + |
+
action + |
+String + |
+Yes + |
+Specifies the operation to perform. The value can be create or delete. +create: specifies to add tags. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
key + |
+String + |
+Yes + |
+Specifies the tag key.
+
|
+
value + |
+String + |
+Yes + |
+Specifies the tag value.
+
|
+
{
+ "action": "create",
+ "tags": [
+ {
+ "key": "key1",
+ "value": "value1"
+ },
+ {
+ "key": "key2",
+ "value": "value3"
+ }
+ ]
+}
+None
+For details, see Error Codes.
+This API is used to batch delete tags for the specified EVS disk.
+None
+Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
tags + |
+List<resource_tag> + |
+Yes + |
+Specifies the tag list. For details, see Parameters in the tags field. + |
+
action + |
+String + |
+Yes + |
+Specifies the operation to perform. The value can be create or delete. +delete: specifies to delete tags. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
key + |
+String + |
+Yes + |
+Specifies the tag key. + |
+
value + |
+String + |
+No + |
+Specifies the tag value. +
|
+
{
+ "action": "delete",
+ "tags": [
+ {
+ "key": "key1"
+ },
+ {
+ "key": "key2"
+ }
+ ]
+}
+None
+For details, see Error Codes.
+This API is used to query the tags of the specified EVS disk.
+None
+None
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
tags + |
+List<resource_tag> + |
+Specifies the tag list. For details, see Parameters in the tags field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
key + |
+String + |
+Specifies the tag key. + |
+
value + |
+String + |
+Specifies the tag value. + |
+
{
+ "tags": [
+ {
+ "value": "value1",
+ "key": "key1"
+ },
+ {
+ "value": "value2",
+ "key": "key2"
+ }
+ ]
+}
+For details, see Error Codes.
+This API is used to query the number of EVS disks by tag.
+None
+Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
tags + |
+Array of objects + |
+No + |
+Specifies the key-value pairs of the tag. 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. +When multiple keys are specified in a tag list, only the disks having all specified keys are queried. + NOTE:
+If multiple tag lists are specified in the request, only the disks that meet the requirements of the last tag list are queried. + |
+
action + |
+String + |
+Yes + |
+Specifies the operation identifier. +Specifying count queries the number of disks by tag. + |
+
matches + |
+Array of objects + |
+No + |
+Specifies 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. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
key + |
+String + |
+Yes + |
+Specifies the tag key.
+
|
+
values + |
+Array of objects + |
+Yes + |
+Specifies the tag value.
+
One value list can contain a maximum of 10 values. +Tag values in a value list must be unique. +If the value list is left empty, any tag value can be matched. +When multiple values are specified in a value list and the key requirements are met, disks that have any of the specified values are queried. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
key + |
+String + |
+Yes + |
+Specifies the tag key. The value is of the enumerated type. +The value can be as follows: +
|
+
value + |
+String + |
+Yes + |
+Specifies the tag value. +
|
+
{
+ "action": "count",
+ "tags": [
+ {
+ "key": "key1",
+ "values": [
+ "value1",
+ "value2"
+ ]
+ }
+ ],
+ "matches": [
+ {
+ "key": "resource_name",
+ "value": "resource1"
+ },
+ {
+ "key": "service_type",
+ "value": "EVS"
+ }
+ ]
+}
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
total_count + |
+Integer + |
+Specifies 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. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "total_count": 1000
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badRequest or itemNotFound. An example is provided as follows:
+{
+ "computeFault": {
+ "message": "The server has either erred or is incapable of performing the requested operation.",
+ "code": 500
+ }
+}
+For details, see Error Codes.
+This API is used to query the details of EVS disks by tag.
+None
+Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
tags + |
+Array of objects + |
+Yes + |
+Specifies the key-value pairs of the tag. For details, see Parameters in the tags field. +One tag list can contain a maximum of 10 keys. +Tag keys in a tag list must be unique. +When multiple keys are specified in a tag list, only the disks having all specified keys are queried. + NOTE:
+If multiple tag lists are specified in the request, only the disks that meet the requirements of the last tag list are queried. + |
+
limit + |
+Integer + |
+No + |
+Specifies the number of query records. +The value ranges from 1 to 1000, and the default value is 1000. The returned value cannot exceed this limit. + |
+
offset + |
+Integer + |
+No + |
+Specifies the index location. +The minimum value is 0, which is also the default value. +The first record in the query result is the offset+1 record that meets the query criteria. + |
+
action + |
+String + |
+Yes + |
+Specifies the operation identifier. +Specifying filter queries the details of disks by tag. + |
+
matches + |
+Array of objects + |
+No + |
+Specifies the query criteria that the resource supports. For details, see Parameters in the matches field. +Tag keys in the list must be unique. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
key + |
+String + |
+Yes + |
+Specifies the tag key. + |
+
values + |
+Array of objects + |
+Yes + |
+Specifies the tag value. +
|
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
key + |
+String + |
+Yes + |
+Specifies the tag key. The value is of the enumerated type. +The value can be as follows: +
|
+
value + |
+String + |
+Yes + |
+Specifies the tag value. +
|
+
{
+ "offset": "100",
+ "limit": "100",
+ "action": "filter",
+ "tags": [
+ {
+ "key": "key1",
+ "values": [
+ "value1",
+ "value2"
+ ]
+ }
+ ],
+ "matches": [
+ {
+ "key": "resource_name",
+ "value": "resource1"
+ },
+ {
+ "key": "service_type",
+ "value": "EVS"
+ }
+ ]
+}
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
total_count + |
+Integer + |
+Specifies the total number of disks that meet the query criteria. + |
+
resources + |
+List<resource> + |
+Specifies the resources that meet the query criteria. For details, see Parameters in the resources field. + |
+
error + |
+Object + |
+Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
resource_id + |
+String + |
+Specifies the disk ID. + |
+
resource_name + |
+String + |
+Specifies the disk name. + |
+
resource_detail + |
+object + |
+Specifies the resource details. + |
+
tags + |
+Array of objects + |
+Specifies the tag list. For details, see Parameters in the tags field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
key + |
+String + |
+Specifies the tag key. + |
+
value + |
+String + |
+Specifies the tag value. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "total_count": 1,
+ "resources": [{
+ "resource_name": "resource1",
+ "resource_detail": {
+ "attachments": [{
+ "server_id": "2080869e-ba46-4ea5-b45e-3191ac0f1d54",
+ "attachment_id": "1335f039-7a42-4d1e-be49-ac584db0ba0b",
+ "attached_at": "2019-08-06T07:00:21.842812",
+ "host_name": null,
+ "volume_id": "7fa6b592-ac75-460d-a28a-bb17429d1eb2",
+ "device": "/dev/vda",
+ "id": "7fa6b592-ac75-460d-a28a-bb17429d1eb2"
+ }],
+ "links": [{
+ "href": "https://volume.Region.dc1.domainname.com/v2/051375756c80d5eb2ff0c014498645fb/volumes/7fa6b592-ac75-460d-a28a-bb17429d1eb2",
+ "rel": "self"
+ },
+ {
+ "href": "https://volume.Region.dc1.domainname.com/051375756c80d5eb2ff0c014498645fb/volumes/7fa6b592-ac75-460d-a28a-bb17429d1eb2",
+ "rel": "bookmark"
+ }],
+ "availability_zone": "kvmxen.dc1",
+ "os-vol-host-attr:host": "az21.dc1#2",
+ "encrypted": false,
+ "updated_at": "2019-08-09T06:19:35.874737",
+ "os-volume-replication:extended_status": null,
+ "replication_status": "disabled",
+ "snapshot_id": null,
+ "id": "7fa6b592-ac75-460d-a28a-bb17429d1eb2",
+ "size": 40,
+ "user_id": "75f26e17348643bfb7718578b04635c2",
+ "os-vol-tenant-attr:tenant_id": "051375756c80d5eb2ff0c014498645fb",
+ "service_type": "EVS",
+ "os-vol-mig-status-attr:migstat": null,
+ "metadata": {
+
+ },
+ "status": "in-use",
+ "volume_image_metadata": {
+ "size": "0",
+ "__quick_start": "False",
+ "container_format": "bare",
+ "min_ram": "0",
+ "image_name": "test-hua-centos7.3-0725",
+ "image_id": "c6c153a6-dde8-4bac-8e40-3d7619436934",
+ "__os_type": "Linux",
+ "min_disk": "20",
+ "__support_kvm": "true",
+ "virtual_env_type": "FusionCompute",
+ "__description": "",
+ "__os_version": "CentOS 7.3 64bit",
+ "__os_bit": "64",
+ "__image_source_type": "uds",
+ "__support_xen": "true",
+ "file_format": "zvhd2",
+ "checksum": "d41d8cd98f00b204e9800998ecf8427e",
+ "__imagetype": "gold",
+ "disk_format": "zvhd2",
+ "__image_cache_type": "Not_Cache",
+ "__isregistered": "true",
+ "__image_location": "192.168.46.200:5443:pcsimsregion:c6c153a6-dde8-4bac-8e40-3d7619436934",
+ "__image_size": "911269888",
+ "__platform": "CentOS"
+ },
+ "description": "",
+ "multiattach": false,
+ "source_volid": null,
+ "consistencygroup_id": null,
+ "os-vol-mig-status-attr:name_id": null,
+ "name": "resource1",
+ "bootable": "true",
+ "created_at": "2019-08-06T06:59:03.056682",
+ "volume_type": "SAS",
+ "shareable": false,
+ },
+ "tags": [{
+ "key": "key1",
+ "value": "value1"
+ },
+ {
+ "key": "key1",
+ "value": "value2"
+ }],
+ "resource_id": "7fa6b592-ac75-460d-a28a-bb17429d1eb2"
+ }]
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badRequest or itemNotFound. An example is provided as follows:
+{
+ "computeFault": {
+ "message": "The server has either erred or is incapable of performing the requested operation.",
+ "code": 500
+ }
+}
+For details, see Error Codes.
+This API is used to add or update tags for an EVS resource.
+
This API has been deprecated. Use another API. For details, see Batch Adding Tags for the Specified EVS Disk.
+POST /v2/{project_id}/os-vendor-tags/{resource_type}/{resource_id}
+Parameter + |
+Mandatory + |
+Description + |
+
|---|---|---|
project_id + |
+Yes + |
+Specifies the project ID. + |
+
resource_type + |
+Yes + |
+Specifies the resource type. The value can be volumes, snapshots, or backups. + |
+
resource_id + |
+Yes + |
+Specifies the resource ID. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
tags + |
+Object + |
+Yes + |
+Specifies the key-value pair of the tag. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
Content-Type + |
+Object + |
+Yes + |
+Specifies the type. The value can be application/json. + |
+
{
+ "tags" : {
+ "key_0" : "value_0",
+ "key_1" : "value_1"
+ }
+}
+
If the request body contains an existing key of the resource, the original tag containing this key will be overwritten. For example, "key_1":"val_1" is an existing tag of the resource. If the request body contains "key_1":"val_11", the tag of key_1 for this resource is "key_1":"val_11".
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
tags + |
+Object + |
+Specifies the key-value pair of the tag. + |
+
{
+ "tags" : {
+ "key_0" : "value_0",
+ "key_1" : "value_1"
+ }
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badRequest or itemNotFound. An example is provided as follows:
+{
+ "badRequest": {
+ "message": "Invalid tags: Tags property value contains invalid characters.",
+ "code": 400
+ }
+}
+For details, see Error Codes.
+This API is used to batch delete tags for an EVS resource.
+
This API has been deprecated. Use another API. For details, see Batch Deleting Tags for the Specified EVS Disk.
+None
+POST /v2/{project_id}/os-vendor-tags/{resource_type}/{resource_id}/action
+Parameter + |
+Mandatory + |
+Description + |
+
|---|---|---|
project_id + |
+Yes + |
+Specifies the project ID. + |
+
resource_type + |
+Yes + |
+Specifies the resource type. The value can be volumes, snapshots, or backups. + |
+
resource_id + |
+Yes + |
+Specifies the resource ID. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
os-delete_tags + |
+Object + |
+Yes + |
+Specifies the key-value pair of the tag. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
Content-Type + |
+Object + |
+Yes + |
+Specifies the type. The value can be application/json. + |
+
{
+ "os-delete_tags": {
+ "key_0": "value_0",
+ "key_1": "value_1"
+ }
+}
+None
+For details, see Error Codes.
+This API is used to obtain the tags of a specified EVS resource.
+
This API has been deprecated. Use another API. For details, see Querying Tags of an EVS Disk.
+None
+GET /v2/{project_id}/os-vendor-tags/{resource_type}/{resource_id}
+Parameter + |
+Mandatory + |
+Description + |
+
|---|---|---|
project_id + |
+Yes + |
+Specifies the project ID. + |
+
resource_type + |
+Yes + |
+Specifies the resource type. The value can be volumes, snapshots, or backups. + |
+
resource_id + |
+Yes + |
+Specifies the resource ID. + |
+
None
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
tags + |
+Object + |
+Specifies the key-value pair of the tag. + |
+
{
+ "tags" : {
+ "key_0" : "value_0",
+ "key_1" : "value_1"
+ }
+}
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badRequest or itemNotFound. An example is provided as follows:
+{
+ "itemNotFound": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to query tags of an EVS resource by key.
+
This API has been deprecated. Use another API. For details, see Querying Tags of an EVS Disk.
+None
+GET /v2/{project_id}/os-vendor-tags/{resource_type}/{resource_id}/{key}
+Parameter + |
+Mandatory + |
+Description + |
+
|---|---|---|
project_id + |
+Yes + |
+Specifies the project ID. + |
+
resource_type + |
+Yes + |
+Specifies the resource type. The value can be volumes, snapshots, or backups. + |
+
resource_id + |
+Yes + |
+Specifies the resource ID. + |
+
key + |
+Yes + |
+Specifies the key of the tag. + |
+
None
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
tag + |
+Object + |
+Specifies the key-value pair of the tag. + |
+
{
+ "tag": {
+ "key_0": "value_0"
+ }
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badRequest or itemNotFound. An example is provided as follows:
+{
+ "itemNotFound": {
+ "message": "Tags item was not found",
+ "code": 404
+ }
+}
+For details, see Error Codes.
+This API is used to reset the tags of an EVS resource, and the existing tags will be deleted.
+
This API call exists for compatibility reasons only and has been deprecated.
+PUT /v2/{project_id}/os-vendor-tags/{resource_type}/{resource_id}
+Parameter + |
+Mandatory + |
+Description + |
+
|---|---|---|
project_id + |
+Yes + |
+Specifies the project ID. + |
+
resource_type + |
+Yes + |
+Specifies the resource type. The value can be volumes, snapshots, or backups. + |
+
resource_id + |
+Yes + |
+Specifies the resource ID. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
tags + |
+Object + |
+Yes + |
+Specifies the key-value pair of the tag. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
Content-Type + |
+Object + |
+Yes + |
+Specifies the type. The value can be application/json. + |
+
{
+ "tags": {
+ "key_new": "value_new"
+ }
+}
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
tags + |
+Object + |
+Specifies the key-value pair of the tag. + |
+
{
+ "tags": {
+ "key_new": "value_new"
+ }
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badRequest or itemNotFound. An example is provided as follows:
+{
+ "badRequest": {
+ "message": "Invalid tags: Tags property key contains invalid characters.",
+ "code": 400
+ }
+}
+For details, see Error Codes.
+This API is used to update tags of an EVS resource by key.
+
This API has been deprecated. Use another API. For details, see Batch Adding Tags for the Specified EVS Disk.
+PUT /v2/{project_id}/os-vendor-tags/{resource_type}/{resource_id}/{key}
+Parameter + |
+Mandatory + |
+Description + |
+
|---|---|---|
project_id + |
+Yes + |
+Specifies the project ID. + |
+
resource_type + |
+Yes + |
+Specifies the resource type. The value can be volumes, snapshots, or backups. + |
+
resource_id + |
+Yes + |
+Specifies the resource ID. + |
+
key + |
+Yes + |
+Specifies the key of the tag. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
tag + |
+Object + |
+Yes + |
+Specifies the key-value pair of the tag. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
Content-Type + |
+Object + |
+Yes + |
+Specifies the type. The value can be application/json. + |
+
{
+ "tag": {
+ "key_0": "value_0"
+ }
+}
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
tag + |
+Object + |
+Specifies the key-value pair of the tag. + |
+
{
+ "tag": {
+ "key_0": "value_0"
+ }
+}
+or
+{
+ "error": {
+ ta "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badRequest or itemNotFound. An example is provided as follows:
+{
+ "badRequest": {
+ "message": "Request body and URI mismatch",
+ "code": 400
+ }
+}
+For details, see Error Codes.
+This API is used to query the EVS resources by tag.
+
This API has been deprecated. Use another API. For details, see Querying Details of EVS Disks by Tag.
+None
+GET /v2/{project_id}/os-vendor-tags/{resource_type}/resource_instances
+Examples:
+Parameter + |
+Mandatory + |
+Description + |
+
|---|---|---|
project_id + |
+Yes + |
+Specifies the project ID. + |
+
resource_type + |
+Yes + |
+Specifies the resource type. The value can be volumes, snapshots, or backups. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
tags + |
+String + |
+No + |
+Specifies to query the EVS resources owning the tags in the filtering tag. +For example, if the filtering tag is tags={'a':['b', 'c'], 'd':['e']}, EVS resources owning tags (key is a and value is b or c) and tags (key is d and value is e) are queried. + |
+
tags_any + |
+String + |
+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. + |
+
not_tags + |
+String + |
+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. + |
+
not_tags_any + |
+String + |
+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. + |
+
None
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
total_count + |
+Integer + |
+Specifies the number of EVS resources. + |
+
resources + |
+list + |
+Specifies the EVS resource lists. + |
+
{
+ "total_count": 2,
+ "resources": [
+ {
+ "resource_name": null,
+ "resource_detail": {
+ "status": "available",
+ "description": null,
+ "availability_zone": "az-dc-1",
+ "updated_at": "2017-07-26T08:14:07.857625",
+ "source_volid": null,
+ "snapshot_id": null,
+ "id": "47cc4949-447a-43dc-b482-a1d7917fef69",
+ "size": 45,
+ "name": null,
+ "bootable": "true",
+ "created_at": "2017-07-26T08:09:39.787432",
+ "multiattach": false
+ },
+ "tags": {
+ "a": "c",
+ "d": "e"
+ },
+ "resource_id": "47cc4949-447a-43dc-b482-a1d7917fef69"
+ },
+ {
+ "resource_name": null,
+ "resource_detail": {
+ "status": "available",
+ "description": null,
+ "availability_zone": "az-dc-1",
+ "updated_at": "2017-07-26T08:02:11.250455",
+ "source_volid": null,
+ "snapshot_id": null,
+ "id": "588e94ef-eb2d-4895-a692-18163a7eeddc",
+ "size": 100,
+ "name": null,
+ "bootable": "false",
+ "created_at": "2017-07-26T08:00:51.563309",
+ "multiattach": false
+ },
+ "tags": {
+ "a": "c",
+ "d": "e"
+ },
+ "resource_id": "588e94ef-eb2d-4895-a692-18163a7eeddc"
+ }
+ ]
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badRequest or itemNotFound. An example is provided as follows:
+{
+ "computeFault": {
+ "message": "The server has either erred or is incapable of performing the requested operation.",
+ "code": 500
+ }
+}
+For details, see Error Codes.
+This API is used to create an EVS replication pair using a specified production disk and a disaster recovery (DR) disk. The production disk is in the primary AZ, and the DR disk is in the secondary AZ.
+
This API has been deprecated. To use this function, see Storage Disaster Recovery Service API Reference.
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
replication + |
+Yes + |
+Object + |
+Specifies the replication pair creation marker. For details, see Parameters in the replication field. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
name + |
+No + |
+String + |
+Specifies the name of the EVS replication pair. The name can contain a maximum of 255 bytes. + |
+
description + |
+No + |
+String + |
+Specifies the description of the EVS replication pair. The description can contain a maximum of 255 bytes. + |
+
volume_ids + |
+Yes + |
+list + |
+Specifies the IDs of the EVS disks used to create the EVS replication pair. + |
+
priority_station + |
+Yes + |
+String + |
+Specifies the primary AZ of the EVS replication pair, that is, the AZ where the production disk belongs. + |
+
replication_model + |
+Yes + |
+String + |
+Specifies the type of the EVS replication pair. Currently, only type hypermetro is supported. + |
+
{
+ "replication": {
+ "name": "my replication",
+ "description": "my replication",
+ "volume_ids": [
+ "18aa67ea-c7cb-4826-800d-50e67f0de75b",
+ "375d23be-3658-498f-8b50-d3b950a890ec"
+ ],
+ "priority_station": "az2.dc2",
+ "replication_model": "hypermetro"
+ }
+}
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
replication + |
+Object + |
+Specifies the EVS replication pair information. + |
+
id + |
+String + |
+Specifies the ID of the EVS replication pair. + |
+
name + |
+String + |
+Specifies the name of the EVS replication pair. + |
+
description + |
+String + |
+Specifies the description of the EVS replication pair. + |
+
status + |
+String + |
+Specifies the status of the EVS replication pair. For details, see EVS Replication Pair Status (Deprecated). + |
+
replication_consistency_group_id + |
+String + |
+Specifies the ID of the replication consistency group where the EVS replication pair belongs. + |
+
volume_ids + |
+String + |
+Specifies the IDs of the EVS disks used to create the EVS replication pair. + |
+
priority_station + |
+String + |
+Specifies the primary site of the EVS replication pair. + |
+
created_at + |
+datetime + |
+Specifies the creation time. + |
+
updated_at + |
+datetime + |
+Specifies the update time. + |
+
{
+ "replication": {
+ "id": "91085433-9499-4a68-b2c6-35072467ccd2",
+ "name": "my replication",
+ "description": "my replication",
+ "status": "creating",
+ "replication_consistency_group_id": null,
+ "volume_ids": "18aa67ea-c7cb-4826-800d-50e67f0de75b, 375d23be-3658-498f-8b50-d3b950a890ec",
+ "priority_station": "az2.dc2",
+ "created_at": "2017-09-28T05:08:32.839953",
+ "updated_at": null
+ }
+}
+Returned Value + |
+Description + |
+
|---|---|
202 + |
+The server has accepted the request. + |
+
Returned Value + |
+Description + |
+
|---|---|
400 Bad Request + |
+The server failed to process the request. + |
+
401 Unauthorized + |
+You must enter the username and password to access the requested page. + |
+
403 Forbidden + |
+You are forbidden to access the requested page. + |
+
404 Not Found + |
+The requested page was not found. + |
+
405 Method Not Allowed + |
+You are not allowed to use the method specified in the request. + |
+
406 Not Acceptable + |
+The response generated by the server cannot be accepted by the client. + |
+
407 Proxy Authentication Required + |
+You must use the proxy server for authentication. Then, the request can be processed. + |
+
408 Request Timeout + |
+The request timed out. + |
+
409 Conflict + |
+The request cannot be processed due to a conflict. + |
+
500 Internal Server Error + |
+Failed to complete the request because of an internal service error. + |
+
501 Not Implemented + |
+Failed to complete the request because the server does not support the requested function. + |
+
502 Bad Gateway + |
+Failed to complete the request because the server has received an invalid response. + |
+
503 Service Unavailable + |
+Failed to complete the request because the service is unavailable. + |
+
504 Gateway Timeout + |
+A gateway timeout error occurs. + |
+
This API is used to delete a specified EVS replication pair.
+
This API has been deprecated. To use this function, see Storage Disaster Recovery Service API Reference.
+None
+None
+Returned Value + |
+Description + |
+
|---|---|
202 + |
+The server has accepted the request. + |
+
Returned Value + |
+Description + |
+
|---|---|
400 Bad Request + |
+The server failed to process the request. + |
+
401 Unauthorized + |
+You must enter the username and password to access the requested page. + |
+
403 Forbidden + |
+You are forbidden to access the requested page. + |
+
404 Not Found + |
+The requested page was not found. + |
+
405 Method Not Allowed + |
+You are not allowed to use the method specified in the request. + |
+
406 Not Acceptable + |
+The response generated by the server cannot be accepted by the client. + |
+
407 Proxy Authentication Required + |
+You must use the proxy server for authentication. Then, the request can be processed. + |
+
408 Request Timeout + |
+The request timed out. + |
+
409 Conflict + |
+The request cannot be processed due to a conflict. + |
+
500 Internal Server Error + |
+Failed to complete the request because of an internal service error. + |
+
501 Not Implemented + |
+Failed to complete the request because the server does not support the requested function. + |
+
502 Bad Gateway + |
+Failed to complete the request because the server has received an invalid response. + |
+
503 Service Unavailable + |
+Failed to complete the request because the service is unavailable. + |
+
504 Gateway Timeout + |
+A gateway timeout error occurs. + |
+
This API is used to query all EVS replication pairs of the current tenant.
+
This API has been deprecated. To use this function, see Storage Disaster Recovery Service API Reference.
+None
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
marker + |
+No + |
+String + |
+Specifies the ID of the last EVS replication pair on the previous page, and the next EVS replication pair ID is returned. + |
+
limit + |
+No + |
+integer + |
+Specifies 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. + |
+
sort_key + |
+No + |
+String + |
+Specifies that the returned results are sorted by keyword. The default keyword is created_at, indicating that the EVS replication pairs are sorted by creation time. + |
+
sort_dir + |
+No + |
+String + |
+Specifies that the returned results are sorted by ascending or descending order. The default value is desc, indicating that the EVS replication pairs are sorted by descending order. + |
+
offset + |
+No + |
+integer + |
+Specifies the offset. + |
+
changes-since + |
+No + |
+String + |
+Specifies to query all the EVS replication pairs that have been updated from the specified time point to the current time. + |
+
name + |
+No + |
+String + |
+Specifies the name of the EVS replication pair. + |
+
status + |
+No + |
+String + |
+Specifies the status of the EVS replication pair. + |
+
replication_consistency_group_id + |
+No + |
+String + |
+Specifies the ID of the replication consistency group where the EVS replication pair belongs. + |
+
volume_ids + |
+No + |
+String + |
+Specifies the IDs of the EVS disks used to create the EVS replication pair. + |
+
volume_id + |
+No + |
+String + |
+Specifies the ID of an EVS disk. + |
+
priority_station + |
+No + |
+String + |
+Specifies the primary site of the EVS replication pair. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
replications + |
+List<replication> + |
+Specifies the EVS replication pairs. + |
+
id + |
+String + |
+Specifies the ID of the EVS replication pair. + |
+
name + |
+String + |
+Specifies the name of the EVS replication pair. + |
+
description + |
+String + |
+Specifies the description of the EVS replication pair. + |
+
status + |
+String + |
+Specifies the status of the EVS replication pair. For details, see EVS Replication Pair Status (Deprecated). + |
+
replication_consistency_group_id + |
+String + |
+Specifies the ID of the replication consistency group where the EVS replication pair belongs. + |
+
volume_ids + |
+String + |
+Specifies the IDs of the EVS disks used to create the EVS replication pair. + |
+
priority_station + |
+String + |
+Specifies the primary site of the EVS replication pair. + |
+
created_at + |
+datetime + |
+Specifies the creation time. + |
+
updated_at + |
+datetime + |
+Specifies the update time. + |
+
replication_model + |
+String + |
+Specifies the replication type of the EVS replication pair. + |
+
replication_status + |
+String + |
+Specifies the replication status of the EVS replication pair. For details, see EVS Replication Pair Status (Deprecated). + |
+
progress + |
+String + |
+Specifies the synchronization progress of the EVS replication pair. +Unit: % + |
+
failure_detail + |
+String + |
+Specifies the returned error code if the EVS replication pair status is error. For details, see Details of EVS Replication failure_detail Values (Deprecated). + |
+
record_metadata + |
+Object + |
+Specifies the billing record of the replication pair. For details, see Parameters in the record_metadata field. + |
+
fault_level + |
+String + |
+Specifies the fault level of the EVS replication pair. The value can be as follows:
+
|
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
volume_type + |
+String + |
+Specifies the type of the EVS disks in the EVS replication pair. + |
+
multiattach + |
+Boolean + |
+Specifies whether the EVS disks in the EVS replication pair are shared EVS disks. + |
+
volume_size + |
+integer + |
+Specifies the size of each EVS disk in the EVS replication pair. The unit is GB. + |
+
{
+ "replications": [
+ {
+ "status": "available",
+ "replication_model": "hypermetro",
+ "description": "replication",
+ "record_metadata": "{ \"volume_size\": 5, \"volume_type\": \"ssd\", \"multiattach\": false}",
+ "updated_at": "2017-11-27T12:08:01.463824",
+ "replication_status": "inactive",
+ "fault_level": "0",
+ "id": "190081db-9023-431d-a51a-197faf3762b5",
+ "replication_consistency_group_id": null,
+ "priority_station": "az2.dc2",
+ "volume_ids": "288a6cac-1352-460f-9b93-bfd41979f805,905d5dee-2ce4-406b-bb8a-314b3e92643e",
+ "name": "replication",
+ "created_at": "2017-11-27T12:07:59.993903",
+ "progress": null
+ },
+ {
+ "status": "available",
+ "replication_model": "hypermetro",
+ "description": "replication",
+ "record_metadata": "{ \"volume_size\": 10, \"volume_type\": \"ssd\", \"multiattach\": false}",
+ "updated_at": "2017-11-28T06:16:30.725816",
+ "replication_status": "active",
+ "fault_level": "0",
+ "id": "6690b30a-b40c-4a50-bd4a-7e5c1e28b821",
+ "replication_consistency_group_id": "13b582e6-092e-4f7a-9260-8eb7a4ad860e",
+ "priority_station": "az3.dc3",
+ "volume_ids": "f3bd8265-130a-4917-815b-a074ddb06850,32eb83a2-dd2f-480d-a49e-7af6edf3c7c7",
+ "name": "replication",
+ "created_at": "2017-11-27T11:37:24.459062",
+ "progress": "100"
+ }
+ ]
+}
+Returned Value + |
+Description + |
+
|---|---|
200 + |
+The server has processed the request. + |
+
Returned Value + |
+Description + |
+
|---|---|
400 Bad Request + |
+The server failed to process the request. + |
+
401 Unauthorized + |
+You must enter the username and password to access the requested page. + |
+
403 Forbidden + |
+You are forbidden to access the requested page. + |
+
404 Not Found + |
+The requested page was not found. + |
+
405 Method Not Allowed + |
+You are not allowed to use the method specified in the request. + |
+
406 Not Acceptable + |
+The response generated by the server cannot be accepted by the client. + |
+
407 Proxy Authentication Required + |
+You must use the proxy server for authentication. Then, the request can be processed. + |
+
408 Request Timeout + |
+The request timed out. + |
+
409 Conflict + |
+The request cannot be processed due to a conflict. + |
+
500 Internal Server Error + |
+Failed to complete the request because of an internal service error. + |
+
501 Not Implemented + |
+Failed to complete the request because the server does not support the requested function. + |
+
502 Bad Gateway + |
+Failed to complete the request because the server has received an invalid response. + |
+
503 Service Unavailable + |
+Failed to complete the request because the service is unavailable. + |
+
504 Gateway Timeout + |
+A gateway timeout error occurs. + |
+
This API is used to query the details about an EVS replication pair, including the name, ID, and status of the replication pair.
+
This API has been deprecated. To use this function, see Storage Disaster Recovery Service API Reference.
+None
+None
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
replication + |
+Object + |
+Specifies the details of the EVS replication pair. + |
+
id + |
+String + |
+Specifies the ID of the EVS replication pair. + |
+
name + |
+String + |
+Specifies the name of the EVS replication pair. + |
+
description + |
+String + |
+Specifies the description of the EVS replication pair. + |
+
status + |
+String + |
+Specifies the status of the EVS replication pair. For details, see EVS Replication Pair Status (Deprecated). + |
+
replication_consistency_group_id + |
+String + |
+Specifies the ID of the replication consistency group where the EVS replication pair belongs. + |
+
volume_ids + |
+String + |
+Specifies the IDs of the EVS disks used to create the EVS replication pair. + |
+
priority_station + |
+String + |
+Specifies the primary site of the EVS replication pair. + |
+
created_at + |
+datetime + |
+Specifies the creation time. + |
+
updated_at + |
+datetime + |
+Specifies the update time. + |
+
replication_model + |
+String + |
+Specifies the replication type of the EVS replication pair. + |
+
replication_status + |
+String + |
+Specifies the replication status of the EVS replication pair. For details, see EVS Replication Pair Status (Deprecated). + |
+
progress + |
+String + |
+Specifies the synchronization progress of the EVS replication pair. +Unit: % + |
+
failure_detail + |
+String + |
+Specifies the returned error code if the EVS replication pair status is error. For details, see Details of EVS Replication failure_detail Values (Deprecated). + |
+
record_metadata + |
+Object + |
+Specifies the billing record of the replication pair. For details, see Parameters in the record_metadata field. + |
+
fault_level + |
+String + |
+Specifies the fault level of the EVS replication pair. The value can be as follows:
+
|
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
volume_type + |
+String + |
+Specifies the type of the EVS disks in the EVS replication pair. + |
+
multiattach + |
+Boolean + |
+Specifies whether the EVS disks in the EVS replication pair are shared EVS disks. + |
+
volume_size + |
+integer + |
+Specifies the size of each EVS disk in the EVS replication pair. The unit is GB. + |
+
{
+ "replication": {
+ "status": "available",
+ "priority_station": "az2.dc2",
+ "volume_ids": "a623cd91-89f9-4baf-a5aa-7774d2bfcb8b,3e8fdded-64bb-4c60-a55e-2e4bc3d240d6",
+ "record_metadata": "{\"volume_size\": 10,\"volume_type\": \"ssd\", \"multiattach\": false}",
+ "name": "yes",
+ "created_at": "2017-09-30T10:14:32.747000",
+ "updated_at": "2017-09-30T10:14:34.505912",
+ "replication_consistency_group_id": null,
+ "replication_status": "active",
+ "fault_level": "0",
+ "replication_model": "hypermetro",
+ "id": "dddd9746-14df-4823-be9d-7b4f4f8518ed",
+ "description": "yes",
+ "progress": "100"
+ }
+}
+Returned Value + |
+Description + |
+
|---|---|
200 + |
+The server has processed the request. + |
+
Returned Value + |
+Description + |
+
|---|---|
400 Bad Request + |
+The server failed to process the request. + |
+
401 Unauthorized + |
+You must enter the username and password to access the requested page. + |
+
403 Forbidden + |
+You are forbidden to access the requested page. + |
+
404 Not Found + |
+The requested page was not found. + |
+
405 Method Not Allowed + |
+You are not allowed to use the method specified in the request. + |
+
406 Not Acceptable + |
+The response generated by the server cannot be accepted by the client. + |
+
407 Proxy Authentication Required + |
+You must use the proxy server for authentication. Then, the request can be processed. + |
+
408 Request Timeout + |
+The request timed out. + |
+
409 Conflict + |
+The request cannot be processed due to a conflict. + |
+
500 Internal Server Error + |
+Failed to complete the request because of an internal service error. + |
+
501 Not Implemented + |
+Failed to complete the request because the server does not support the requested function. + |
+
502 Bad Gateway + |
+Failed to complete the request because the server has received an invalid response. + |
+
503 Service Unavailable + |
+Failed to complete the request because the service is unavailable. + |
+
504 Gateway Timeout + |
+A gateway timeout error occurs. + |
+
This API is used to create a replication consistency group for the specified EVS replication pairs.
+
This API has been deprecated. To use this function, see Storage Disaster Recovery Service API Reference.
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
replication_consistency_group + |
+Yes + |
+Object + |
+Specifies to create the replication consistency group. For details, see •Parameters in the replication_consistency_group field. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
name + |
+No + |
+String + |
+Specifies the name of the replication consistency group. The name can contain a maximum of 255 bytes. + |
+
description + |
+No + |
+String + |
+Specifies the description of the replication consistency group. The description can contain a maximum of 255 bytes. + |
+
replication_ids + |
+Yes + |
+list + |
+Specifies the IDs of the EVS replication pairs used to create the replication consistency group. + |
+
priority_station + |
+Yes + |
+String + |
+Specifies the current primary AZ, that is, the AZ where the production disks belong. + |
+
replication_model + |
+Yes + |
+String + |
+Specifies the type of the created replication consistency group. Currently, only type hypermetro is supported. + |
+
{
+ "replication_consistency_group": {
+ "name": "my replication consistency group",
+ "description": "my replication consistency group",
+ "replication_ids": [
+ "18aa67ea-c7cb-4826-800d-50e67f0de75b",
+ "375d23be-3658-498f-8b50-d3b950a890ec"
+ ],
+ "priority_station": "az2.dc2",
+ "replication_model": "hypermetro"
+ }
+}
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
replication_consistency_group + |
+Object + |
+Specifies the replication consistency group information. + |
+
id + |
+String + |
+Specifies the ID of the replication consistency group. + |
+
name + |
+String + |
+Specifies the name of the replication consistency group. + |
+
description + |
+String + |
+Specifies the description of the replication consistency group. + |
+
status + |
+String + |
+Specifies the status of the replication consistency group. For details, see Replication Consistency Group Status (Deprecated). + |
+
priority_station + |
+String + |
+Specifies the primary site of the replication consistency group. + |
+
created_at + |
+datetime + |
+Specifies the creation time. + |
+
updated_at + |
+datetime + |
+Specifies the update time. + |
+
{
+ "replication_consistency_group": {
+ "id": "91085433-9499-4a68-b2c6-35072467ccd2",
+ "name": "my replication consistency group",
+ "description": "my replication consistency group",
+ "status": "creating",
+ "priority_station": "az2.dc2",
+ "created_at": "2017-09-28T05:08:32.839953",
+ "updated_at": null
+ }
+}
+Returned Value + |
+Description + |
+
|---|---|
202 + |
+The server has accepted the request. + |
+
Returned Value + |
+Description + |
+
|---|---|
400 Bad Request + |
+The server failed to process the request. + |
+
401 Unauthorized + |
+You must enter the username and password to access the requested page. + |
+
403 Forbidden + |
+You are forbidden to access the requested page. + |
+
404 Not Found + |
+The requested page was not found. + |
+
405 Method Not Allowed + |
+You are not allowed to use the method specified in the request. + |
+
406 Not Acceptable + |
+The response generated by the server cannot be accepted by the client. + |
+
407 Proxy Authentication Required + |
+You must use the proxy server for authentication. Then, the request can be processed. + |
+
408 Request Timeout + |
+The request timed out. + |
+
409 Conflict + |
+The request cannot be processed due to a conflict. + |
+
500 Internal Server Error + |
+Failed to complete the request because of an internal service error. + |
+
501 Not Implemented + |
+Failed to complete the request because the server does not support the requested function. + |
+
502 Bad Gateway + |
+Failed to complete the request because the server has received an invalid response. + |
+
503 Service Unavailable + |
+Failed to complete the request because the service is unavailable. + |
+
504 Gateway Timeout + |
+A gateway timeout error occurs. + |
+
This API is used to delete a replication consistency group.
+
This API has been deprecated. To use this function, see Storage Disaster Recovery Service API Reference.
+DELETE /v2/{project_id}/os-vendor-replication-consistency-groups/{replication_consistency_group_id}
+Parameter + |
+Mandatory + |
+Description + |
+
|---|---|---|
project_id + |
+Yes + |
+Specifies the project ID. + |
+
replication_consistency_group_id + |
+Yes + |
+Specifies the ID of the replication consistency group. + |
+
None
+None
+Returned Value + |
+Description + |
+
|---|---|
202 + |
+The server has accepted the request. + |
+
Returned Value + |
+Description + |
+
|---|---|
400 Bad Request + |
+The server failed to process the request. + |
+
401 Unauthorized + |
+You must enter the username and password to access the requested page. + |
+
403 Forbidden + |
+You are forbidden to access the requested page. + |
+
404 Not Found + |
+The requested page was not found. + |
+
405 Method Not Allowed + |
+You are not allowed to use the method specified in the request. + |
+
406 Not Acceptable + |
+The response generated by the server cannot be accepted by the client. + |
+
407 Proxy Authentication Required + |
+You must use the proxy server for authentication. Then, the request can be processed. + |
+
408 Request Timeout + |
+The request timed out. + |
+
409 Conflict + |
+The request cannot be processed due to a conflict. + |
+
500 Internal Server Error + |
+Failed to complete the request because of an internal service error. + |
+
501 Not Implemented + |
+Failed to complete the request because the server does not support the requested function. + |
+
502 Bad Gateway + |
+Failed to complete the request because the server has received an invalid response. + |
+
503 Service Unavailable + |
+Failed to complete the request because the service is unavailable. + |
+
504 Gateway Timeout + |
+A gateway timeout error occurs. + |
+
This API is used to query all replication consistency groups of the current tenant.
+
This API has been deprecated. To use this function, see Storage Disaster Recovery Service API Reference.
+None
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
marker + |
+No + |
+String + |
+Specifies the ID of the last replication consistency group on the previous page. The next replication consistency group ID is returned. + |
+
limit + |
+No + |
+integer + |
+Specifies 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. + |
+
sort_key + |
+No + |
+String + |
+Specifies that the returned results are sorted by keyword. The default keyword is created_at, indicating that the replication consistency groups are sorted by creation time. + |
+
sort_dir + |
+No + |
+String + |
+Specifies that the returned results are sorted by ascending or descending order. The default value is desc, indicating that the replication consistency groups are sorted by descending order. + |
+
offset + |
+No + |
+integer + |
+Specifies the offset. + |
+
changes-since + |
+No + |
+String + |
+Specifies to query all the replication consistency groups that have been updated from the specified time point to the current time. + |
+
name + |
+No + |
+String + |
+Specifies the name of the replication consistency group. + |
+
status + |
+No + |
+String + |
+Specifies the status of the replication consistency group. + |
+
priority_station + |
+No + |
+String + |
+Specifies the primary site of the replication consistency group. + |
+
volume_id + |
+No + |
+String + |
+Specifies the ID of an EVS disk. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
replication_consistency_groups + |
+List<replication_consistency_group> + |
+Specifies the replication consistency groups. + |
+
id + |
+String + |
+Specifies the ID of the replication consistency group. + |
+
name + |
+String + |
+Specifies the name of the replication consistency group. + |
+
description + |
+String + |
+Specifies the description of the replication consistency group. + |
+
status + |
+String + |
+Specifies the status of the replication consistency group. For details, see Replication Consistency Group Status (Deprecated). + |
+
priority_station + |
+String + |
+Specifies the primary site. + |
+
replication_model + |
+String + |
+Specifies the replication type of the replication consistency group. + |
+
replication_status + |
+String + |
+Specifies the replication status of the replication consistency group. For details, see Replication Consistency Group Status (Deprecated). + |
+
replication_ids + |
+list + |
+Specifies the IDs of all EVS replication pairs in the replication consistency group. + |
+
created_at + |
+datetime + |
+Specifies the creation time. + |
+
updated_at + |
+datetime + |
+Specifies the latest update time. + |
+
failure_detail + |
+String + |
+Specifies the returned error code if the status of the replication consistency group is error. For details, see Details of EVS Replication failure_detail Values (Deprecated). + |
+
fault_level + |
+String + |
+Specifies the fault level of the replication consistency group. The value can be as follows:
+
|
+
{
+ "replication_consistency_groups": [
+ {
+ "status": "available",
+ "priority_station": "az3.dc3",
+ "replication_ids": [
+ "86080dc0-2fcf-4b85-8102-bc123eb8dcaa",
+ "580b730e-3160-4382-8a4e-174515d1fa77"
+ ],
+ "name": "replication consistency group",
+ "replication_model": "hypermetro",
+ "fault_level": "0",
+ "updated_at": "2017-11-28T07:17:21.904376",
+ "created_at": "2017-11-28T03:05:10.677939",
+ "replication_status": "active-stopped",
+ "id": "57b84092-7a75-4e22-bc2a-fab0bec547c5",
+ "description": "replication consistency group"
+ },
+ {
+ "status": "available",
+ "priority_station": "az3.dc3",
+ "replication_ids": [
+ "3e9ba31c-6406-4060-870e-b7736ac76836",
+ "6690b30a-b40c-4a50-bd4a-7e5c1e28b821"
+ ],
+ "name": "replication consistency group",
+ "replication_model": "hypermetro",
+ "fault_level": "0",
+ "updated_at": "2017-11-28T06:29:27.155762",
+ "created_at": "2017-11-27T11:38:50.421364",
+ "replication_status": "active",
+ "id": "13b582e6-092e-4f7a-9260-8eb7a4ad860e",
+ "description": "replication consistency group"
+ }
+ ]
+}
+Returned Value + |
+Description + |
+
|---|---|
200 + |
+The server has processed the request. + |
+
Returned Value + |
+Description + |
+
|---|---|
400 Bad Request + |
+The server failed to process the request. + |
+
401 Unauthorized + |
+You must enter the username and password to access the requested page. + |
+
403 Forbidden + |
+You are forbidden to access the requested page. + |
+
404 Not Found + |
+The requested page was not found. + |
+
405 Method Not Allowed + |
+You are not allowed to use the method specified in the request. + |
+
406 Not Acceptable + |
+The response generated by the server cannot be accepted by the client. + |
+
407 Proxy Authentication Required + |
+You must use the proxy server for authentication. Then, the request can be processed. + |
+
408 Request Timeout + |
+The request timed out. + |
+
409 Conflict + |
+The request cannot be processed due to a conflict. + |
+
500 Internal Server Error + |
+Failed to complete the request because of an internal service error. + |
+
501 Not Implemented + |
+Failed to complete the request because the server does not support the requested function. + |
+
502 Bad Gateway + |
+Failed to complete the request because the server has received an invalid response. + |
+
503 Service Unavailable + |
+Failed to complete the request because the service is unavailable. + |
+
504 Gateway Timeout + |
+A gateway timeout error occurs. + |
+
This API is used to query the details about a replication consistency group, including the name, ID, and status of the consistency group.
+
This API has been deprecated. To use this function, see Storage Disaster Recovery Service API Reference.
+None
+GET /v2/{project_id}/os-vendor-replication-consistency-groups/{replication_consistency_group_id}
+Parameter + |
+Mandatory + |
+Description + |
+
|---|---|---|
project_id + |
+Yes + |
+Specifies the project ID. + |
+
replication_consistency_group_id + |
+Yes + |
+Specifies the ID of the replication consistency group. + |
+
None
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
replication_consistency_group + |
+Object + |
+Specifies the details of replication consistency groups. + |
+
id + |
+String + |
+Specifies the ID of the replication consistency group. + |
+
name + |
+String + |
+Specifies the name of the replication consistency group. + |
+
description + |
+String + |
+Specifies the description of the replication consistency group. + |
+
status + |
+String + |
+Specifies the status of the replication consistency group. For details, see Replication Consistency Group Status (Deprecated). + |
+
priority_station + |
+String + |
+Specifies the primary site of the replication consistency group. + |
+
replication_model + |
+String + |
+Specifies the replication type of the replication consistency group. + |
+
replication_status + |
+String + |
+Specifies the replication status of the replication consistency group. For details, see Replication Consistency Group Status (Deprecated). + |
+
replication_ids + |
+list + |
+Specifies the IDs of all EVS replication pairs in the replication consistency group. + |
+
created_at + |
+datetime + |
+Specifies the creation time. + |
+
updated_at + |
+datetime + |
+Specifies the update time. + |
+
failure_detail + |
+String + |
+Specifies the returned error code if the status of the replication consistency group is error. For details, see Details of EVS Replication failure_detail Values (Deprecated). + |
+
fault_level + |
+String + |
+Specifies the fault level of the replication consistency group. The value can be as follows:
+
|
+
{
+ "replication_consistency_group": {
+ "id": "bd35d31b-7ab9-47fc-84c6-3d326c6fa6cb",
+ "name": " replicationcgtest",
+ "description": "my replicationcg pair",
+ "status": "available",
+ "priority_staion": "az2.dc2",
+ "replication_model": "hypermetro",
+ "fault_level": "0",
+ "replication_status": "active-stopped",
+ "replication_ids": [
+ "e5bd643b-7407-4a0e-8d9a-2a88903e8812"
+ ],
+ "created_at": "2017-09-30T07:37:06.035360",
+ "updated_at": null
+ }
+}
+Returned Value + |
+Description + |
+
|---|---|
200 + |
+The server has processed the request. + |
+
Returned Value + |
+Description + |
+
|---|---|
400 Bad Request + |
+The server failed to process the request. + |
+
401 Unauthorized + |
+You must enter the username and password to access the requested page. + |
+
403 Forbidden + |
+You are forbidden to access the requested page. + |
+
404 Not Found + |
+The requested page was not found. + |
+
405 Method Not Allowed + |
+You are not allowed to use the method specified in the request. + |
+
406 Not Acceptable + |
+The response generated by the server cannot be accepted by the client. + |
+
407 Proxy Authentication Required + |
+You must use the proxy server for authentication. Then, the request can be processed. + |
+
408 Request Timeout + |
+The request timed out. + |
+
409 Conflict + |
+The request cannot be processed due to a conflict. + |
+
500 Internal Server Error + |
+Failed to complete the request because of an internal service error. + |
+
501 Not Implemented + |
+Failed to complete the request because the server does not support the requested function. + |
+
502 Bad Gateway + |
+Failed to complete the request because the server has received an invalid response. + |
+
503 Service Unavailable + |
+Failed to complete the request because the service is unavailable. + |
+
504 Gateway Timeout + |
+A gateway timeout error occurs. + |
+
This API is used to update a replication consistency group. An update includes the following operations:
+
This API has been deprecated. To use this function, see Storage Disaster Recovery Service API Reference.
+PUT /v2/{project_id}/os-vendor-replication-consistency-groups/{replication_consistency_group_id}
+Parameter + |
+Mandatory + |
+Description + |
+
|---|---|---|
project_id + |
+Yes + |
+Specifies the project ID. + |
+
replication_consistency_group_id + |
+Yes + |
+Specifies the ID of the replication consistency group. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
replication_consistency_group + |
+Yes + |
+Object + |
+Specifies the replication consistency group information. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
name + |
+No + |
+String + |
+Specifies the name of the replication consistency group. + |
+
description + |
+No + |
+String + |
+Specifies the description of the replication consistency group. + |
+
replication_model + |
+No + |
+String + |
+Specifies the type of the replication consistency group. Currently, only type hypermetro is supported. + |
+
add_replication_ids + |
+No + |
+list + |
+Specifies the IDs of the EVS replication pairs to be added. + |
+
remove_replication_ids + |
+No + |
+list + |
+Specifies the IDs of the EVS replication pairs to be removed. + |
+
{
+ "replication_consistency_group": {
+ "name": "my replication consistency group",
+ "description": "my replication consistency group",
+ "replication_model": "hypermetro",
+ "add_replication_ids": [
+ "0fc12f4e-381d-4f4a-acb0-9890c1683afe",
+ "0aee8399-4aeb-4d84-8d77-9d8a9d3dbe1a"
+ ],
+ "remove_replication_ids": [
+ "6b27b8b3-95d2-44e3-9cb2-f7de9e8739f2",
+ "cadeda61-7817-466e-bc0c-96448c4d106e"
+ ]
+ }
+}
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
replication_consistency_group + |
+Yes + |
+Object + |
+Specifies the replication consistency group information. + |
+
id + |
+Yes + |
+String + |
+Specifies the ID of the replication consistency group. + |
+
name + |
+Yes + |
+String + |
+Specifies the name of the replication consistency group. + |
+
description + |
+Yes + |
+String + |
+Specifies the description of the replication consistency group. + |
+
status + |
+Yes + |
+String + |
+Specifies the status of the replication consistency group. + |
+
priority_station + |
+Yes + |
+String + |
+Specifies the primary site of the replication consistency group. + |
+
created_at + |
+Yes + |
+String + |
+Specifies the time when the replication consistency group was created. + |
+
updated_at + |
+Yes + |
+String + |
+Specifies the time when the replication consistency group was updated. + |
+
{
+ "replication_consistency_group": {
+ "id": "91085433-9499-4a68-b2c6-35072467ccd2",
+ "name": "my replication consistency group",
+ "description": "my replication consistency group",
+ "status": "updating",
+ "priority_station": "az2.dc2",
+ "created_at": "2017-10-19T03:57:36.577967",
+ "updated_at": "2017-10-19T04:45:26.467988"
+ }
+}
+Returned Value + |
+Description + |
+
|---|---|
202 + |
+The server has accepted the request. + |
+
Returned Value + |
+Description + |
+
|---|---|
400 Bad Request + |
+The server failed to process the request. + |
+
401 Unauthorized + |
+You must enter the username and password to access the requested page. + |
+
403 Forbidden + |
+You are forbidden to access the requested page. + |
+
404 Not Found + |
+The requested page was not found. + |
+
405 Method Not Allowed + |
+You are not allowed to use the method specified in the request. + |
+
406 Not Acceptable + |
+The response generated by the server cannot be accepted by the client. + |
+
407 Proxy Authentication Required + |
+You must use the proxy server for authentication. Then, the request can be processed. + |
+
408 Request Timeout + |
+The request timed out. + |
+
409 Conflict + |
+The request cannot be processed due to a conflict. + |
+
500 Internal Server Error + |
+Failed to complete the request because of an internal service error. + |
+
501 Not Implemented + |
+Failed to complete the request because the server does not support the requested function. + |
+
502 Bad Gateway + |
+Failed to complete the request because the server has received an invalid response. + |
+
503 Service Unavailable + |
+Failed to complete the request because the service is unavailable. + |
+
504 Gateway Timeout + |
+A gateway timeout error occurs. + |
+
This API is used to perform a failover for a replication consistency group. When an exception occurs in the primary AZ, a failover can be performed to change the primary site of a replication consistency group from the primary AZ to the secondary AZ and enable DR ECSs and DR disks in the secondary AZ to provide services.
+After the failover, the replication_status value of the replication consistency group is active-stopped. In this case, EVS replication is available only after the primary AZ is restored and the replication consistency group is synchronized.
+
This API has been deprecated. To use this function, see Storage Disaster Recovery Service API Reference.
+If a fault occurs in the physical environment of the primary AZ due to force majeure and services become unavailable, perform a failover for the replication consistency group.
+POST /v2/{project_id}/os-vendor-replication-consistency-groups/{replication_consistency_group_id}/action
+Parameter + |
+Mandatory + |
+Description + |
+
|---|---|---|
project_id + |
+Yes + |
+Specifies the project ID. + |
+
replication_consistency_group_id + |
+Yes + |
+Specifies the ID of the replication consistency group. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
os-failover-replication-consistency-group + |
+Yes + |
+object + |
+The parameter value is null, indicating that a replication consistency group failover will be performed. + |
+
{
+ "os-failover-replication-consistency-group": null
+}
+None
+Returned Value + |
+Description + |
+
|---|---|
200 + |
+The server has processed the request. + |
+
Returned Value + |
+Description + |
+
|---|---|
400 Bad Request + |
+The server failed to process the request. + |
+
401 Unauthorized + |
+You must enter the username and password to access the requested page. + |
+
403 Forbidden + |
+You are forbidden to access the requested page. + |
+
404 Not Found + |
+The requested page was not found. + |
+
405 Method Not Allowed + |
+You are not allowed to use the method specified in the request. + |
+
406 Not Acceptable + |
+The response generated by the server cannot be accepted by the client. + |
+
407 Proxy Authentication Required + |
+You must use the proxy server for authentication. Then, the request can be processed. + |
+
408 Request Timeout + |
+The request timed out. + |
+
409 Conflict + |
+The request cannot be processed due to a conflict. + |
+
500 Internal Server Error + |
+Failed to complete the request because of an internal service error. + |
+
501 Not Implemented + |
+Failed to complete the request because the server does not support the requested function. + |
+
502 Bad Gateway + |
+Failed to complete the request because the server has received an invalid response. + |
+
503 Service Unavailable + |
+Failed to complete the request because the service is unavailable. + |
+
504 Gateway Timeout + |
+A gateway timeout error occurs. + |
+
This API is used to synchronize the data between production disks and DR disks in all EVS replication pairs of a replication consistency group. After the synchronization is complete, the data in all EVS replication pairs of the replication consistency group is consistent.
+
This API has been deprecated. To use this function, see Storage Disaster Recovery Service API Reference.
+None
+POST /v2/{project_id}/os-vendor-replication-consistency-groups/{replication_consistency_group_id}/action
+Parameter + |
+Mandatory + |
+Description + |
+
|---|---|---|
project_id + |
+Yes + |
+Specifies the project ID. + |
+
replication_consistency_group_id + |
+Yes + |
+Specifies the ID of the replication consistency group. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
os-sync-replication-consistency-group + |
+Yes + |
+object + |
+The parameter value is null, indicating that the replication consistency group will be synchronized. + |
+
{
+ "os-sync-replication-consistency-group": null
+}
+None
+Returned Value + |
+Description + |
+
|---|---|
200 + |
+The server has processed the request. + |
+
Returned Value + |
+Description + |
+
|---|---|
400 Bad Request + |
+The server failed to process the request. + |
+
401 Unauthorized + |
+You must enter the username and password to access the requested page. + |
+
403 Forbidden + |
+You are forbidden to access the requested page. + |
+
404 Not Found + |
+The requested page was not found. + |
+
405 Method Not Allowed + |
+You are not allowed to use the method specified in the request. + |
+
406 Not Acceptable + |
+The response generated by the server cannot be accepted by the client. + |
+
407 Proxy Authentication Required + |
+You must use the proxy server for authentication. Then, the request can be processed. + |
+
408 Request Timeout + |
+The request timed out. + |
+
409 Conflict + |
+The request cannot be processed due to a conflict. + |
+
500 Internal Server Error + |
+Failed to complete the request because of an internal service error. + |
+
501 Not Implemented + |
+Failed to complete the request because the server does not support the requested function. + |
+
502 Bad Gateway + |
+Failed to complete the request because the server has received an invalid response. + |
+
503 Service Unavailable + |
+Failed to complete the request because the service is unavailable. + |
+
504 Gateway Timeout + |
+A gateway timeout error occurs. + |
+
This API is used to perform a primary/secondary switchover for a replication consistency group. A switchover can be performed to switch the primary and secondary AZs of a replication consistency group, which means that the original secondary AZ will be switched to function as the primary AZ, and original DR ECSs and DR disks will be enabled.
+After the primary/secondary switchover, the replication_status value of the replication consistency group is active. At this time, the data between production disks and DR disks in the primary and secondary AZs is consistent in real time, and EVS replication is working normally.
+
This API has been deprecated. To use this function, see Storage Disaster Recovery Service API Reference.
+The data synchronization of the replication consistency group is complete, and the replication consistency group is working normally.
+POST /v2/{project_id}/os-vendor-replication-consistency-groups/{replication_consistency_group_id}/action
+Parameter + |
+Mandatory + |
+Description + |
+
|---|---|---|
project_id + |
+Yes + |
+Specifies the project ID. + |
+
replication_consistency_group_id + |
+Yes + |
+Specifies the ID of the replication consistency group. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
os-reverse-replication-consistency-group + |
+Yes + |
+object + |
+The parameter value is null, indicating that a primary/secondary switchover will be performed for the replication consistency group. + |
+
{
+ "os-reverse-replication-consistency-group": null
+}
+None
+Returned Value + |
+Description + |
+
|---|---|
200 + |
+The server has processed the request. + |
+
Returned Value + |
+Description + |
+
|---|---|
400 Bad Request + |
+The server failed to process the request. + |
+
401 Unauthorized + |
+You must enter the username and password to access the requested page. + |
+
403 Forbidden + |
+You are forbidden to access the requested page. + |
+
404 Not Found + |
+The requested page was not found. + |
+
405 Method Not Allowed + |
+You are not allowed to use the method specified in the request. + |
+
406 Not Acceptable + |
+The response generated by the server cannot be accepted by the client. + |
+
407 Proxy Authentication Required + |
+You must use the proxy server for authentication. Then, the request can be processed. + |
+
408 Request Timeout + |
+The request timed out. + |
+
409 Conflict + |
+The request cannot be processed due to a conflict. + |
+
500 Internal Server Error + |
+Failed to complete the request because of an internal service error. + |
+
501 Not Implemented + |
+Failed to complete the request because the server does not support the requested function. + |
+
502 Bad Gateway + |
+Failed to complete the request because the server has received an invalid response. + |
+
503 Service Unavailable + |
+Failed to complete the request because the service is unavailable. + |
+
504 Gateway Timeout + |
+A gateway timeout error occurs. + |
+
This API is used to pause a replication consistency group, that is, to pause the data synchronization in all EVS replication pairs of a replication consistency group.
+Before deleting or updating a replication consistency group, you need to pause the replication consistency group.
+
This API has been deprecated. To use this function, see Storage Disaster Recovery Service API Reference.
+None
+POST /v2/{project_id}/os-vendor-replication-consistency-groups/{replication_consistency_group_id}/action
+Parameter + |
+Mandatory + |
+Description + |
+
|---|---|---|
project_id + |
+Yes + |
+Specifies the project ID. + |
+
replication_consistency_group_id + |
+Yes + |
+Specifies the ID of the replication consistency group. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
os-stop-replication-consistency-group + |
+Yes + |
+object + |
+The parameter value is null, indicating that the replication consistency group will be paused. + |
+
{
+ "os-stop-replication-consistency-group": null
+}
+None
+Returned Value + |
+Description + |
+
|---|---|
200 + |
+The server has processed the request. + |
+
Returned Value + |
+Description + |
+
|---|---|
400 Bad Request + |
+The server failed to process the request. + |
+
401 Unauthorized + |
+You must enter the username and password to access the requested page. + |
+
403 Forbidden + |
+You are forbidden to access the requested page. + |
+
404 Not Found + |
+The requested page was not found. + |
+
405 Method Not Allowed + |
+You are not allowed to use the method specified in the request. + |
+
406 Not Acceptable + |
+The response generated by the server cannot be accepted by the client. + |
+
407 Proxy Authentication Required + |
+You must use the proxy server for authentication. Then, the request can be processed. + |
+
408 Request Timeout + |
+The request timed out. + |
+
409 Conflict + |
+The request cannot be processed due to a conflict. + |
+
500 Internal Server Error + |
+Failed to complete the request because of an internal service error. + |
+
501 Not Implemented + |
+Failed to complete the request because the server does not support the requested function. + |
+
502 Bad Gateway + |
+Failed to complete the request because the server has received an invalid response. + |
+
503 Service Unavailable + |
+Failed to complete the request because the service is unavailable. + |
+
504 Gateway Timeout + |
+A gateway timeout error occurs. + |
+
This API is used to reprotect a replication consistency group. After resources in a faulty AZ have been restored and functioned as DR resources, a reprotection can be performed to synchronize data in all EVS replication pairs of a replication consistency group.
+A reprotection can only be performed after the resources in the faulty primary AZ have been restored and can be used to synchronize data in all EVS replication pairs of a replication consistency group.
+
This API has been deprecated. To use this function, see Storage Disaster Recovery Service API Reference.
+POST /v2/{project_id}/os-vendor-replication-consistency-groups/{replication_consistency_group_id}/action
+Parameter + |
+Mandatory + |
+Description + |
+
|---|---|---|
project_id + |
+Yes + |
+Specifies the project ID. + |
+
replication_consistency_group_id + |
+Yes + |
+Specifies the ID of the replication consistency group. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
os-reprotect-replication-consistency-group + |
+Yes + |
+object + |
+The parameter value is null, indicating that the replication consistency group will be reprotected. + |
+
{
+ "os-reprotect-replication-consistency-group": null
+}
+None
+Returned Value + |
+Description + |
+
|---|---|
200 + |
+The server has processed the request. + |
+
Returned Value + |
+Description + |
+
|---|---|
400 Bad Request + |
+The server failed to process the request. + |
+
401 Unauthorized + |
+You must enter the username and password to access the requested page. + |
+
403 Forbidden + |
+You are forbidden to access the requested page. + |
+
404 Not Found + |
+The requested page was not found. + |
+
405 Method Not Allowed + |
+You are not allowed to use the method specified in the request. + |
+
406 Not Acceptable + |
+The response generated by the server cannot be accepted by the client. + |
+
407 Proxy Authentication Required + |
+You must use the proxy server for authentication. Then, the request can be processed. + |
+
408 Request Timeout + |
+The request timed out. + |
+
409 Conflict + |
+The request cannot be processed due to a conflict. + |
+
500 Internal Server Error + |
+Failed to complete the request because of an internal service error. + |
+
501 Not Implemented + |
+Failed to complete the request because the server does not support the requested function. + |
+
502 Bad Gateway + |
+Failed to complete the request because the server has received an invalid response. + |
+
503 Service Unavailable + |
+Failed to complete the request because the service is unavailable. + |
+
504 Gateway Timeout + |
+A gateway timeout error occurs. + |
+
This API is used to expand the EVS disks in one or multiple EVS replication pairs. In such an expansion operation, two EVS disks in one EVS replication pair are expanded together.
+
The status and replication_status values of the replication consistency group remain unchanged before and after capacity expansion. When 200 is returned, the capacity expansion is complete.
+If the expansion fails, contact technical support engineers to locate and rectify the fault. After the fault is rectified, expand the disks again.
+If the capacities of multiple EVS replication pairs in a protection group are expanded, an error indicating incorrect capacity will occur after the capacity expansion.
+This API has been deprecated. To use this function, see Storage Disaster Recovery Service API Reference.
+POST /v2/{project_id}/os-vendor-replication-consistency-groups/{replication_consistency_group_id}/action
+Parameter + |
+Mandatory + |
+Description + |
+
|---|---|---|
project_id + |
+Yes + |
+Specifies the project ID. + |
+
replication_consistency_group_id + |
+Yes + |
+Specifies the ID of the replication consistency group. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
os-extend-replication-volumes + |
+Yes + |
+Object + |
+Specifies the EVS disk expansion operation. + |
+
replications + |
+Yes + |
+list + |
+Specifies the expansion information of one or multiple EVS replication pairs. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
id + |
+Yes + |
+String + |
+Specifies the IDs of EVS replication pairs. + |
+
new_size + |
+Yes + |
+integer + |
+Specifies the disk capacity after expansion in the EVS replication pair. The unit is GB. + |
+
{
+ "os-extend-replication-volumes": {
+ "replications": [
+ {"id": "25132c7a-bf71-4d18-8a2e-1ad11416c057", "new_size": 10},
+ {"id": "6a61d65c-269e-4592-8a89-95742b075b1a", "new_size": 20}
+ ]
+ }
+}
+None
+Returned Value + |
+Description + |
+
|---|---|
200 + |
+The server has processed the request. + |
+
Returned Value + |
+Description + |
+
|---|---|
400 Bad Request + |
+The server failed to process the request. + |
+
401 Unauthorized + |
+You must enter the username and password to access the requested page. + |
+
403 Forbidden + |
+You are forbidden to access the requested page. + |
+
404 Not Found + |
+The requested page was not found. + |
+
405 Method Not Allowed + |
+You are not allowed to use the method specified in the request. + |
+
406 Not Acceptable + |
+The response generated by the server cannot be accepted by the client. + |
+
407 Proxy Authentication Required + |
+You must use the proxy server for authentication. Then, the request can be processed. + |
+
408 Request Timeout + |
+The request timed out. + |
+
409 Conflict + |
+The request cannot be processed due to a conflict. + |
+
500 Internal Server Error + |
+Failed to complete the request because of an internal service error. + |
+
501 Not Implemented + |
+Failed to complete the request because the server does not support the requested function. + |
+
502 Bad Gateway + |
+Failed to complete the request because the server has received an invalid response. + |
+
503 Service Unavailable + |
+Failed to complete the request because the service is unavailable. + |
+
504 Gateway Timeout + |
+A gateway timeout error occurs. + |
+
This API is used to create one or multiple EVS disks.
+Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
volume + |
+Object + |
+Yes + |
+Specifies the information of the disks to be created. For details, see Parameters in the volume field. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
availability_zone + |
+String + |
+Yes + |
+Specifies the AZ where you want to create the disk. If the AZ does not exist, the disk will fail to create. + NOTE:
+For details about how to obtain the AZ, see Querying All AZs. + |
+
source_volid + |
+String + |
+No + |
+Specifies the source disk ID. If this parameter is specified, the disk is cloned from an existing disk. Currently, this function is not supported. + |
+
description + |
+String + |
+No + |
+Specifies the disk description. The value can contain a maximum of 255 bytes. + |
+
snapshot_id + |
+String + |
+No + |
+Specifies the snapshot ID. If this parameter is specified, the disk is created from a snapshot. + NOTE:
+For details about how to obtain the snapshot ID, see Querying Details About EVS Snapshots. + |
+
size + |
+Integer + |
+Yes + |
+Specifies the disk size, in GB. Its value can be as follows:
+
This parameter is mandatory when you create an empty disk. You can specify the parameter value as required within the value range. +This parameter is mandatory when you create the disk from a snapshot. Ensure that the disk size is greater than or equal to the snapshot size. +This parameter is mandatory when you create the disk from an image. Ensure that the disk size is greater than or equal to the minimum disk capacity required by min_disk in the image attributes. + |
+
name + |
+String + |
+No + |
+Specifies the disk name. The value can contain a maximum of 255 bytes. + |
+
imageRef + |
+String + |
+No + |
+Specifies the image ID. If this parameter is specified, the disk is created from an image. + NOTE:
+BMS system disks cannot be created from BMS images. +For how to obtain the image ID, see Querying Images in the Image Management Service API Reference. + |
+
volume_type + |
+String + |
+No + |
+Specifies the disk type. +Currently, the value can be SSD, SAS, SATA, co-p1, or uh-l1.
+
If the specified disk type is not available in the AZ, the disk will fail to create. + NOTE:
+
|
+
metadata + |
+Object + |
+No + |
+Specifies the disk metadata. The length of the key or value in the metadata cannot exceed 255 bytes. +For details about metadata, see Parameters in the metadata field. The table lists some fields. You can also specify other fields based on the disk creation requirements. + NOTE:
+Parameter values under metadata cannot be null. + |
+
source_replica + |
+String + |
+No + |
+Specifies the source disk ID. If this parameter is specified, the disk is cloned from an existing disk. Currently, this function is not supported. + |
+
consistencygroup_id + |
+String + |
+No + |
+Reserved field + |
+
shareable + |
+String + |
+No + |
+Specifies whether the disk is shareable. The value can be true (sharable) or false (not sharable). This is an extended attribute. + NOTE:
+This field is no longer used. Use multiattach. + |
+
multiattach + |
+Boolean + |
+No + |
+Specifies whether the disk is shareable. The default value is false.
+
|
+
Specifying either two of the source_volid, snapshot_id, and imageRef fields is not supported.
+Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
__system__encrypted + |
+String + |
+No + |
+Specifies the encryption field in metadata. The value can be 0 (not encrypted) or 1 (encrypted). +If this parameter does not exist, the disk will not be encrypted by default. + |
+
__system__cmkid + |
+String + |
+No + |
+Specifies the encryption CMK ID in metadata. This parameter is used together with __system__encrypted for encryption. The length of cmkid is fixed at 36 bytes. + NOTE:
+For details about how to obtain the CMK ID, see Querying the List of CMKs in the Key Management Service API Reference. + |
+
hw:passthrough + |
+String + |
+No + |
+
|
+
full_clone + |
+String + |
+No + |
+If the disk is created from a snapshot and linked cloning needs to be used, set this parameter to 0. + |
+
The preceding table provides only some parameters in metadata for your reference. You can also specify other fields based on the disk creation requirements.
+{
+ "volume": {
+ "name": "openapi_vol01",
+ "imageRef": "027cf713-45a6-45f0-ac1b-0ccc57ac12e2",
+ "availability_zone": "az-dc-1",
+ "description": "create for api test",
+ "volume_type": "SATA",
+ "metadata": {
+ "volume_owner": "openapi"
+ },
+ "multiattach": false,
+ "size": 40
+ },
+}
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
volume + |
+Object + |
+Specifies the information of the created disks. For details, see Parameters in the volumes field. + |
+
error + |
+Object + |
+Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+Specifies the disk ID. + |
+
links + |
+list + |
+Specifies the disk URI. For details, see Parameters in the links field. + |
+
name + |
+String + |
+Specifies the disk name. + |
+
status + |
+String + |
+Specifies the disk status. For details, see EVS Disk Status. + |
+
attachments + |
+list + |
+Specifies the disk attachment information. For details, see Parameters in the attachments field. + |
+
availability_zone + |
+String + |
+Specifies the AZ to which the disk belongs. + |
+
bootable + |
+String + |
+Specifies whether the disk is bootable.
+
|
+
encrypted + |
+Boolean + |
+Currently, this field is not supported by EVS. + |
+
created_at + |
+String + |
+Specifies the time when the disk was created. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
description + |
+String + |
+Specifies the disk description. + |
+
volume_type + |
+String + |
+Specifies the disk type. +Currently, the value can be SSD, SAS, SATA, co-p1, or uh-l1.
+
|
+
replication_status + |
+String + |
+Reserved field + |
+
consistencygroup_id + |
+String + |
+Specifies the ID of the consistency group where the disk belongs. +Currently, this field is not supported by EVS. + |
+
source_volid + |
+String + |
+Specifies the source disk ID. +Currently, this field is not supported by EVS. + |
+
snapshot_id + |
+String + |
+Specifies the snapshot ID. + |
+
metadata + |
+Object + |
+Specifies the disk metadata. For details, see Parameters in the metadata field. + |
+
size + |
+Integer + |
+Specifies the disk size, in GB. + |
+
user_id + |
+String + |
+Reserved field + |
+
updated_at + |
+String + |
+Specifies the time when the disk was updated. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
shareable + |
+Boolean + |
+Specifies whether the disk is shareable. + NOTE:
+This field is no longer used. Use multiattach. + |
+
multiattach + |
+Boolean + |
+Specifies whether the disk is shareable.
+
|
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
href + |
+String + |
+Specifies the corresponding shortcut link. + |
+
rel + |
+String + |
+Specifies the shortcut link marker name. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
server_id + |
+String + |
+Specifies the ID of the server to which the disk is attached. + |
+
attachment_id + |
+String + |
+Specifies the ID of the attachment information. + |
+
attached_at + |
+String + |
+Specifies the time when the disk was attached. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
host_name + |
+String + |
+Specifies the name of the physical host accommodating the server to which the disk is attached. + |
+
volume_id + |
+String + |
+Specifies the disk ID. + |
+
device + |
+String + |
+Specifies the device name. + |
+
id + |
+String + |
+Specifies the ID of the attached resource. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
__system__encrypted + |
+String + |
+Specifies the parameter that describes the encryption function in metadata. The value can be 0 or 1.
+
|
+
__system__cmkid + |
+String + |
+Specifies the encryption CMK ID in metadata. This parameter is used together with __system__encrypted for encryption. The length of cmkid is fixed at 36 bytes. + |
+
hw:passthrough + |
+String + |
+Specifies the parameter that describes the disk device type in metadata. The value can be true or false.
+
|
+
full_clone + |
+String + |
+Specifies the clone method. When the disk is created from a snapshot, the parameter value is 0, indicating the linked cloning method. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "volume": {
+ "attachments": [ ],
+ "availability_zone": "az-dc-1",
+ "bootable": "false",
+ "consistencygroup_id": null,
+ "created_at": "2016-05-25T02:38:40.392463",
+ "description": "create for api test",
+ "encrypted": false,
+ "id": "8dd7c486-8e9f-49fe-bceb-26aa7e312b66",
+ "links": [
+ {
+ "href": "https://volume.localdomain.com:8776/v2/5dd0b0056f3d47b6ab4121667d35621a/volumes/8dd7c486-8e9f-49fe-bceb-26aa7e312b66",
+ "rel": "self"
+ },
+ {
+ "href": "https://volume.localdomain.com:8776/5dd0b0056f3d47b6ab4121667d35621a/volumes/8dd7c486-8e9f-49fe-bceb-26aa7e312b66",
+ "rel": "bookmark"
+ }
+ ],
+ "metadata": {
+ "volume_owner": "openapi"
+ },
+ "name": "openapi_vol01",
+ "replication_status": "disabled",
+ "multiattach": false,
+ "size": 40,
+ "snapshot_id": null,
+ "source_volid": null,
+ "status": "creating",
+ "updated_at": null,
+ "user_id": "39f6696ae23740708d0f358a253c2637",
+ "volume_type": "SATA"
+ }
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badRequest or itemNotFound. An example is provided as follows:
+{
+ "badRequest": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to delete an EVS disk.
+Parameter + |
+Mandatory + |
+Description + |
+
|---|---|---|
project_id + |
+Yes + |
+Specifies the project ID. + |
+
volume_id + |
+Yes + |
+Specifies the disk ID. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
cascade + |
+Boolean + |
+No + |
+Specifies to delete all snapshots associated with the disk. The default value is false. + |
+
The following example shows how to delete a disk and all its snapshots.
+DELETE https://{endpoint}/v2/{project_id}/volumes/{volume_id}?cascade=true
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
error + |
+Object + |
+Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badrequest or itemNotFound. An example is provided as follows:
+{
+ "itemNotFound": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to update the EVS disk information.
+Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
volume + |
+Object + |
+Yes + |
+Specifies the information of the disk to be updated. For details, see Parameters in the volume field. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
name + |
+String + |
+No + |
+Specifies the disk name. The value can contain a maximum of 255 bytes. + |
+
description + |
+String + |
+No + |
+Specifies the disk description. The value can contain a maximum of 255 bytes. + |
+
metadata + |
+Object + |
+No + |
+Specifies the disk metadata. +The length of the key or value in the metadata cannot exceed 255 bytes. + |
+
display_name + |
+String + |
+No + |
+Specifies also the disk name. You can specify either parameter name or display_name. If both parameters are specified, the name value is used. The value can contain a maximum of 255 bytes. + |
+
display_description + |
+String + |
+No + |
+Specifies 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. + |
+
{
+ "volume": {
+ "name": "test_volume",
+ "description": "test"
+ }
+}
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
volume + |
+Object + |
+Specifies the information of the updated disk. For details, see Parameters in the volumes field. + |
+
error + |
+Object + |
+Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+Specifies the disk ID. + |
+
links + |
+list<map<String,String>> + |
+Specifies the disk URI. For details, see Parameters in the links field. + |
+
name + |
+String + |
+Specifies the disk name. + |
+
status + |
+String + |
+Specifies the disk status. For details, see EVS Disk Status. + |
+
attachments + |
+list + |
+Specifies the disk attachment information. For details, see Parameters in the attachments field. + |
+
availability_zone + |
+String + |
+Specifies the AZ to which the disk belongs. + |
+
bootable + |
+String + |
+Specifies whether the disk is bootable.
+
|
+
encrypted + |
+Boolean + |
+Currently, this field is not supported by EVS. + |
+
created_at + |
+String + |
+Specifies the time when the disk was created. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
description + |
+String + |
+Specifies the disk description. + |
+
volume_type + |
+String + |
+Specifies the disk type. +Currently, the value can be SSD, SAS, SATA, co-p1, or uh-l1.
+
|
+
replication_status + |
+String + |
+Reserved field + |
+
consistencygroup_id + |
+String + |
+Reserved field + |
+
source_volid + |
+String + |
+Specifies the source disk ID. +Currently, this field is not supported by EVS. + |
+
snapshot_id + |
+String + |
+Specifies the snapshot ID. + |
+
metadata + |
+Object + |
+Specifies the disk metadata. For details, see Parameters in the metadata field. + |
+
size + |
+Integer + |
+Specifies the disk size, in GB. + |
+
user_id + |
+String + |
+Reserved field + |
+
updated_at + |
+String + |
+Specifies the time when the disk was updated. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
shareable + |
+Boolean + |
+Specifies whether the disk is shareable. + NOTE:
+This field is no longer used. Use multiattach. + |
+
multiattach + |
+Boolean + |
+Specifies whether the disk is shareable.
+
|
+
storage_cluster_id + |
+String + |
+Reserved field + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
href + |
+String + |
+Specifies the corresponding shortcut link. + |
+
rel + |
+String + |
+Specifies the shortcut link marker name. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
server_id + |
+String + |
+Specifies the ID of the server to which the disk is attached. + |
+
attachment_id + |
+String + |
+Specifies the ID of the attachment information. + |
+
attached_at + |
+String + |
+Specifies the time when the disk was attached. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
host_name + |
+String + |
+Specifies the name of the physical host accommodating the server to which the disk is attached. + |
+
volume_id + |
+String + |
+Specifies the disk ID. + |
+
device + |
+String + |
+Specifies the device name. + |
+
id + |
+String + |
+Specifies the ID of the attached resource. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
__system__encrypted + |
+String + |
+Specifies the parameter that describes the encryption function in metadata. The value can be 0 or 1.
+
|
+
__system__cmkid + |
+String + |
+Specifies the encryption CMK ID in metadata. This parameter is used together with __system__encrypted for encryption. The length of cmkid is fixed at 36 bytes. + |
+
hw:passthrough + |
+String + |
+Specifies the parameter that describes the disk device type in metadata. The value can be true or false.
+
|
+
full_clone + |
+String + |
+Specifies the clone method. When the disk is created from a snapshot, the parameter value is 0, indicating the linked cloning method. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "volume": {
+ "attachments": [ ],
+ "availability_zone": "az-dc-1",
+ "bootable": "false",
+ "consistencygroup_id": null,
+ "created_at": "2016-05-25T02:38:40.392463",
+ "description": "create for api test",
+ "encrypted": false,
+ "id": "8dd7c486-8e9f-49fe-bceb-26aa7e312b66",
+ "links": [
+ {
+ "href": "https://volume.localdomain.com:8776/v2/5dd0b0056f3d47b6ab4121667d35621a/volumes/8dd7c486-8e9f-49fe-bceb-26aa7e312b66",
+ "rel": "self"
+ },
+ {
+ "href": "https://volume.localdomain.com:8776/5dd0b0056f3d47b6ab4121667d35621a/volumes/8dd7c486-8e9f-49fe-bceb-26aa7e312b66",
+ "rel": "bookmark"
+ }
+ ],
+ "metadata": {
+ "volume_owner": "openapi"
+ },
+ "name": "openapi_vol01",
+ "replication_status": "disabled",
+ "multiattach": false,
+ "size": 40,
+ "snapshot_id": null,
+ "source_volid": null,
+ "status": "creating",
+ "updated_at": null,
+ "user_id": "39f6696ae23740708d0f358a253c2637",
+ "volume_type": "SATA"
+ }
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badRequest or itemNotFound. An example is provided as follows:
+{
+ "badRequest": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to query EVS disks.
+Parameter + |
+Mandatory + |
+Description + |
+
|---|---|---|
project_id + |
+Yes + |
+Specifies the project ID. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
marker + |
+String + |
+No + |
+Specifies the ID of the last record on the previous page. The returned value is the value of the item after this one. + |
+
name + |
+String + |
+No + |
+Specifies the disk name. The value can contain a maximum of 255 bytes. + |
+
limit + |
+Integer + |
+No + |
+Specifies 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 disks 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 /v2/xxx/volumes?limit=50: Queries the 1–50 disks. GET /v2/xxx/volumes?offset=50&limit=50: Queries the 51–100 disks. + |
+
sort_key + |
+String + |
+No + |
+Specifies the keyword based on which the returned results are sorted. The value can be id, status, size, or created_at, and the default value is created_at. + |
+
sort_dir + |
+String + |
+No + |
+Specifies the result sorting order. The default value is desc.
+
|
+
offset + |
+Integer + |
+No + |
+Specifies the offset. +All disks after this offset will be queried. The value must be an integer greater than 0 but less than the number of disks. + |
+
status + |
+String + |
+No + |
+Specifies the disk status. For details, see EVS Disk Status. + |
+
metadata + |
+String + |
+No + |
+Specifies the disk metadata. + |
+
availability_zone + |
+String + |
+No + |
+Specifies the AZ. + |
+
The following example shows how to query the disks in the available state.
+GET https://{endpoint}/v2/{project_id}/volumes?status=available
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
volumes + |
+list + |
+Specifies the list of queried disks. For details, see Parameters in the volumes field. + |
+
volumes_links + |
+list + |
+Specifies the query position marker in the disk list. If only some disks are returned in this query, the URL of the last disk queried will be returned. You can use this URL to continue to query the remaining disks in the next query. + |
+
error + |
+Object + |
+Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+Specifies the disk ID. + |
+
links + |
+list<map<String, String>> + |
+Specifies the disk URI. For details, see Parameters in the links field. + |
+
name + |
+String + |
+Specifies the disk name. The value can contain a maximum of 255 bytes. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
href + |
+String + |
+Specifies the corresponding shortcut link. + |
+
rel + |
+String + |
+Specifies the shortcut link marker name. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "volumes": [
+ {
+ "id": "6b604cef-9bd8-4f5a-ae56-45839e6e1f0a",
+ "links": [
+ {
+ "href": "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/6b604cef-9bd8-4f5a-ae56-45839e6e1f0a",
+ "rel": "self"
+ },
+ {
+ "href": "https://volume.localdomain.com:8776/dd14c6ac581f40059e27f5320b60bf2f/volumes/6b604cef-9bd8-4f5a-ae56-45839e6e1f0a",
+ "rel": "bookmark"
+ }
+ ],
+ "name": "zjb_u25_test"
+ },
+ {
+ "id": "2bce4552-9a7d-48fa-8484-abbbf64b206e",
+ "links": [
+ {
+ "href": "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/2bce4552-9a7d-48fa-8484-abbbf64b206e",
+ "rel": "self"
+ },
+ {
+ "href": "https://volume.localdomain.com:8776/dd14c6ac581f40059e27f5320b60bf2f/volumes/2bce4552-9a7d-48fa-8484-abbbf64b206e",
+ "rel": "bookmark"
+ }
+ ],
+ "name": "zjb_u25_test"
+ },
+ {
+ "id": "3f1b98ec-a8b5-4e92-a727-88def62d5ad3",
+ "links": [
+ {
+ "href": "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/3f1b98ec-a8b5-4e92-a727-88def62d5ad3",
+ "rel": "self"
+ },
+ {
+ "href": "https://volume.localdomain.com:8776/dd14c6ac581f40059e27f5320b60bf2f/volumes/3f1b98ec-a8b5-4e92-a727-88def62d5ad3",
+ "rel": "bookmark"
+ }
+ ],
+ "name": "zjb_u25_test"
+ }
+ ],
+ "volumes_links": [
+ {
+ "href": "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes?limit=3&marker=3f1b98ec-a8b5-4e92-a727-88def62d5ad3",
+ "rel": "next"
+ }
+ ]
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badRequest or itemNotFound. An example is provided as follows:
+{
+ "badRequest": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to query details about all disks.
+Parameter + |
+Mandatory + |
+Description + |
+
|---|---|---|
project_id + |
+Yes + |
+Specifies the project ID. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
marker + |
+String + |
+No + |
+Specifies the ID of the last record on the previous page. The returned value is the value of the item after this one. + |
+
name + |
+String + |
+No + |
+Specifies the disk name. The value can contain a maximum of 255 bytes. + |
+
limit + |
+Integer + |
+No + |
+Specifies 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 disks 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 /v2/xxx/volumes/detail?limit=50: Queries the 1–50 disks. GET /v2/xxx/volumes/detail?offset=50&limit=50: Queries the 51–100 disks. + |
+
sort_key + |
+String + |
+No + |
+Specifies the keyword based on which the returned results are sorted. The value can be id, status, size, or created_at, and the default value is created_at. + |
+
sort_dir + |
+String + |
+No + |
+Specifies the result sorting order. The default value is desc.
+
|
+
offset + |
+Integer + |
+No + |
+Specifies the offset. +All disks after this offset will be queried. The value must be an integer greater than 0 but less than the number of disks. + |
+
status + |
+String + |
+No + |
+Specifies the disk status. For details, see EVS Disk Status. + |
+
metadata + |
+String + |
+No + |
+Specifies the disk metadata. + |
+
availability_zone + |
+String + |
+No + |
+Specifies the AZ. + |
+
The following example shows how to query details of the disks in the available state.
+GET https://{endpoint}/v2/{project_id}/volumes/detail?status=available
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
volumes + |
+list + |
+Specifies the list of queried disks. For details, see Parameters in the volumes field. + |
+
volumes_links + |
+list + |
+Specifies the query position marker in the disk list. If only some disks are returned in this query, the URL of the last disk queried will be returned. You can use this URL to continue to query the remaining disks in the next query. For details, see Parameters in the links field. + |
+
error + |
+Object + |
+Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+Specifies the disk ID. + |
+
links + |
+list<map<String,String>> + |
+Specifies the disk URI. For details, see Parameters in the links field. + |
+
name + |
+String + |
+Specifies the disk name. + |
+
status + |
+String + |
+Specifies the disk status. For details, see EVS Disk Status. + |
+
attachments + |
+list + |
+Specifies the disk attachment information. For details, see Parameters in the attachments field. + |
+
availability_zone + |
+String + |
+Specifies the AZ to which the disk belongs. + |
+
os-vol-host-attr:host + |
+String + |
+Reserved field + |
+
source_volid + |
+String + |
+Specifies the source disk ID. This parameter has a value if the disk is created from a source disk. +Currently, this field is not supported by EVS. + |
+
snapshot_id + |
+String + |
+Specifies the snapshot ID. This parameter has a value if the disk is created from a snapshot. + |
+
description + |
+String + |
+Specifies the disk description. + |
+
created_at + |
+String + |
+Specifies the time when the disk was created. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
volume_type + |
+String + |
+Specifies the disk type. +Currently, the value can be SSD, SAS, SATA, co-p1, or uh-l1.
+
|
+
os-vol-tenant-attr:tenant_id + |
+String + |
+Specifies the ID of the tenant to which the disk belongs. The tenant ID is actually the project ID. + |
+
size + |
+Integer + |
+Specifies the disk size, in GB. + |
+
metadata + |
+Object + |
+Specifies the disk metadata. For details, see Parameters in the metadata field. +If metadata does not contain the hw:passthrough field, the disk device type is VBD. +If metadata does not contain the __system__encrypted field, the disk is not encrypted. + |
+
os-vol-mig-status-attr:migstat + |
+String + |
+Reserved field + |
+
os-vol-mig-status-attr:name_id + |
+String + |
+Reserved field + |
+
os-volume-replication:extended_status + |
+String + |
+Reserved field + |
+
encrypted + |
+Boolean + |
+Currently, this field is not supported by EVS. + |
+
replication_status + |
+String + |
+Reserved field + |
+
user_id + |
+String + |
+Reserved field + |
+
consistencygroup_id + |
+String + |
+Specifies the ID of the consistency group where the disk belongs. +Currently, this field is not supported by EVS. + |
+
bootable + |
+String + |
+Specifies whether the disk is bootable.
+
|
+
updated_at + |
+String + |
+Specifies the time when the disk was updated. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
shareable + |
+Boolean + |
+Specifies whether the disk is shareable. + NOTE:
+This field is no longer used. Use multiattach. + |
+
multiattach + |
+Boolean + |
+Specifies whether the disk is shareable.
+
|
+
volume_image_metadata + |
+Object + |
+Specifies the metadata of the disk image. This field has a value if the disk is created from an image. Otherwise, it is left empty. + NOTE:
+For details about volume_image_metadata, see Querying Image Details (Native OpenStack API) in the Image Management Service API Reference. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
href + |
+String + |
+Specifies the corresponding shortcut link. + |
+
rel + |
+String + |
+Specifies the shortcut link marker name. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
server_id + |
+String + |
+Specifies the ID of the server to which the disk is attached. + |
+
attachment_id + |
+String + |
+Specifies the ID of the attachment information. + |
+
attached_at + |
+String + |
+Specifies the time when the disk was attached. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
host_name + |
+String + |
+Specifies the name of the physical host accommodating the server to which the disk is attached. + |
+
volume_id + |
+String + |
+Specifies the disk ID. + |
+
device + |
+String + |
+Specifies the device name. + |
+
id + |
+String + |
+Specifies the ID of the attached resource. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
__system__encrypted + |
+String + |
+Specifies the parameter that describes the encryption function in metadata. The value can be 0 or 1.
+
|
+
__system__cmkid + |
+String + |
+Specifies the encryption CMK ID in metadata. This parameter is used together with __system__encrypted for encryption. The length of cmkid is fixed at 36 bytes. + |
+
hw:passthrough + |
+String + |
+Specifies the parameter that describes the disk device type in metadata. The value can be true or false.
+
|
+
full_clone + |
+String + |
+Specifies the clone method. When the disk is created from a snapshot, the parameter value is 0, indicating the linked cloning method. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "volumes": [
+ {
+ "attachments": [ ],
+ "availability_zone": "az-dc-1",
+ "bootable": "false",
+ "consistencygroup_id": null,
+ "created_at": "2016-05-25T02:42:10.856332",
+ "description": null,
+ "encrypted": false,
+ "id": "b104b8db-170d-441b-897a-3c8ba9c5a214",
+ "links": [
+ {
+ "href": "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/b104b8db-170d-441b-897a-3c8ba9c5a214",
+ "rel": "self"
+ },
+ {
+ "href": "https://volume.localdomain.com:8776/dd14c6ac581f40059e27f5320b60bf2f/volumes/b104b8db-170d-441b-897a-3c8ba9c5a214",
+ "rel": "bookmark"
+ }
+ ],
+ "metadata": {},
+ "name": "zjb_u25_test",
+ "os-vol-host-attr:host": "pod01.xxx#SATA",
+ "volume_image_metadata": { },
+ "os-vol-mig-status-attr:migstat": null,
+ "os-vol-mig-status-attr:name_id": null,
+ "os-vol-tenant-attr:tenant_id": "dd14c6ac581f40059e27f5320b60bf2f",
+ "os-volume-replication:extended_status": null,
+ "replication_status": "disabled",
+ "multiattach": false,
+ "size": 1,
+ "snapshot_id": null,
+ "source_volid": null,
+ "status": "available",
+ "updated_at": "2016-05-25T02:42:22.341984",
+ "user_id": "b0524e8342084ef5b74f158f78fc3049",
+ "volume_type": "SATA"
+ }
+ ],
+ "volumes_links": [
+ {
+ "href": "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/detail?limit=1&marker=b104b8db-170d-441b-897a-3c8ba9c5a214",
+ "rel": "next"
+ }
+ ]
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badrequest or itemNotFound. An example is provided as follows:
+{
+ "itemNotFound": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to query details about a disk.
+GET https://{endpoint}/v2/{project_id}/volumes/b104b8db-170d-441b-897a-3c8ba9c5a214
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
volume + |
+Object + |
+Specifies the queried disk. For details, see Parameters in the volume field. + |
+
error + |
+Object + |
+Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+Specifies the disk ID. + |
+
links + |
+list<map<String, String>> + |
+Specifies the disk URI. For details, see Parameters in the links field. + |
+
name + |
+String + |
+Specifies the disk name. + |
+
status + |
+String + |
+Specifies the disk status. For details, see EVS Disk Status. + |
+
attachments + |
+list<map<String, String>> + |
+Specifies the disk attachment information. For details, see Parameters in the attachments field. + |
+
availability_zone + |
+String + |
+Specifies the AZ to which the disk belongs. + |
+
source_volid + |
+String + |
+Specifies the source disk ID. This parameter has a value if the disk is created from a source disk. +Currently, this field is not supported by EVS. + |
+
snapshot_id + |
+String + |
+Specifies the snapshot ID. This parameter has a value if the disk is created from a snapshot. + |
+
description + |
+String + |
+Specifies the disk description. + |
+
os-vol-tenant-attr:tenant_id + |
+String + |
+Specifies the ID of the tenant to which the disk belongs. The tenant ID is actually the project ID. + |
+
volume_image_metadata + |
+Object + |
+Specifies the metadata of the disk image. + NOTE:
+For details about volume_image_metadata, see Querying Image Details (Native OpenStack API) in the Image Management Service API Reference. + |
+
created_at + |
+String + |
+Specifies the time when the disk was created. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
volume_type + |
+String + |
+Specifies the disk type. +Currently, the value can be SSD, SAS, SATA, co-p1, or uh-l1.
+
|
+
size + |
+Integer + |
+Specifies the disk size, in GB. + |
+
bootable + |
+String + |
+Specifies whether the disk is bootable.
+
|
+
metadata + |
+Object + |
+Specifies the disk metadata. For details, see Parameters in the metadata field. +If metadata does not contain the hw:passthrough field, the disk device type is VBD. +If metadata does not contain the __system__encrypted field, the disk is not encrypted. + |
+
os-vol-host-attr:host + |
+String + |
+Reserved field + |
+
encrypted + |
+Boolean + |
+Currently, this field is not supported by EVS. + |
+
updated_at + |
+String + |
+Specifies the time when the disk was updated. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
os-volume-replication:extended_status + |
+String + |
+Reserved field + |
+
replication_status + |
+String + |
+Reserved field + |
+
os-vol-mig-status-attr:migstat + |
+String + |
+Reserved field + |
+
consistencygroup_id + |
+String + |
+Reserved field + |
+
os-vol-mig-status-attr:name_id + |
+String + |
+Reserved field + |
+
shareable + |
+Boolean + |
+Specifies whether the disk is shareable. + NOTE:
+This field is no longer used. Use multiattach. + |
+
user_id + |
+String + |
+Reserved field + |
+
multiattach + |
+Boolean + |
+Specifies whether the disk is shareable.
+
|
+
storage_cluster_id + |
+String + |
+Reserved field + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
href + |
+String + |
+Specifies the corresponding shortcut link. + |
+
rel + |
+String + |
+Specifies the shortcut link marker name. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
server_id + |
+String + |
+Specifies the ID of the server to which the disk is attached. + |
+
attachment_id + |
+String + |
+Specifies the ID of the attachment information. + |
+
attached_at + |
+String + |
+Specifies the time when the disk was attached. + |
+
host_name + |
+String + |
+Specifies the name of the physical host accommodating the server to which the disk is attached. + |
+
volume_id + |
+String + |
+Specifies the disk ID. + |
+
device + |
+String + |
+Specifies the device name. + |
+
id + |
+String + |
+Specifies the ID of the attached resource. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
__system__encrypted + |
+String + |
+Specifies the parameter that describes the encryption function in metadata. The value can be 0 or 1.
+
|
+
__system__cmkid + |
+String + |
+Specifies the encryption CMK ID in metadata. This parameter is used together with __system__encrypted for encryption. The length of cmkid is fixed at 36 bytes. + |
+
hw:passthrough + |
+String + |
+Specifies the parameter that describes the disk device type in metadata. The value can be true or false.
+
|
+
full_clone + |
+String + |
+Specifies the clone method. When the disk is created from a snapshot, the parameter value is 0, indicating the linked cloning method. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "volume": {
+ "attachments": [ ],
+ "links": [
+ {
+ "href": "https://volume.az0.dc1.domainname.com/v2/40acc331ac784f34842ba4f08ff2be48/volumes/591ac654-26d8-41be-bb77-4f90699d2d41",
+ "rel": "self"
+ },
+ {
+ "href": "https://volume.az0.dc1.domainname.com/40acc331ac784f34842ba4f08ff2be48/volumes/591ac654-26d8-41be-bb77-4f90699d2d41",
+ "rel": "bookmark"
+ }
+ ],
+ "availability_zone": "az-dc-1",
+ "os-vol-host-attr:host": "az-dc-1#SSD",
+ "encrypted": false,
+ "multiattach": true,
+ "updated_at": "2016-02-03T02:19:29.895237",
+ "os-volume-replication:extended_status": null,
+ "replication_status": "disabled",
+ "snapshot_id": null,
+ "id": "591ac654-26d8-41be-bb77-4f90699d2d41",
+ "size": 40,
+ "user_id": "fd03ee73295e45478d88e15263d2ee4e",
+ "os-vol-tenant-attr:tenant_id": "40acc331ac784f34842ba4f08ff2be48",
+ "volume_image_metadata": null,
+ "os-vol-mig-status-attr:migstat": null,
+ "metadata": {},
+ "status": "error_restoring",
+ "description": "auto-created_from_restore_from_backup",
+ "source_volid": null,
+ "consistencygroup_id": null,
+ "os-vol-mig-status-attr:name_id": null,
+ "name": "restore_backup_0115efb3-678c-4a9e-bff6-d3cd278238b9",
+ "bootable": "false",
+ "created_at": "2016-02-03T02:19:11.723797",
+ "volume_type": null
+ }
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badrequest or itemNotFound. An example is provided as follows:
+{
+ "badrequest": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to query EVS disk types and display the query results in a list.
+GET https://{endpoint}/v2/{project_id}/types
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
volume_types + |
+list + |
+Specifies the list of queried disk types. For details, see Parameters in the volume_types field. + |
+
error + |
+Object + |
+Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
extra_specs + |
+Object + |
+Specifies the disk type specifications. For details, see Parameters in the extra_specs field. + |
+
name + |
+String + |
+Specifies the name of the disk type. + |
+
id + |
+String + |
+Specifies the ID of the disk type. + |
+
description + |
+String + |
+Specifies the description of the disk type. + |
+
qos_specs_id + |
+String + |
+Reserved field + |
+
is_public + |
+Boolean + |
+Reserved field + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
volume_backend_name + |
+String + |
+Reserved field + |
+
availability-zone + |
+String + |
+Reserved field + |
+
HW:availability_zone + |
+String + |
+Reserved field + |
+
RESKEY:availability_zones + |
+String + |
+Specifies the AZs that support the current disk type. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "volume_types": [
+ {
+ "extra_specs": {
+ "volume_backend_name": "SAS",
+ "availability-zone": "az-dc-1"
+ },
+ "name": "SAS",
+ "qos_specs_id": null,
+ "id": "6c81c680-df58-4512-81e7-ecf66d160638",
+ "is_public": true,
+ "description": null
+ },
+ {
+ "extra_specs": {
+ "volume_backend_name": "SATA",
+ "availability-zone": "az-dc-1"
+ },
+ "name": "SATA",
+ "qos_specs_id": "585f29d6-7147-42e7-bfb8-ca214f640f6f",
+ "is_public": true,
+ "id": "ea6e3c13-aac5-46e0-b280-745ed272e662",
+ "description": null
+ },
+ {
+ "extra_specs": {
+ "volume_backend_name": "SSD",
+ "availability-zone": "az-dc-1"
+ },
+ "name": "SSD",
+ "qos_specs_id": "39b0c29a-308b-4f86-b478-5d3d02a43837",
+ "is_public": true,
+ "id": "6f2dee9e-82f0-4be3-ad89-bae605a3d24f",
+ "description": null
+ }
+ ]
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badrequest or itemNotFound. An example is provided as follows:
+{
+ "badrequest": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to query details about an EVS disk type.
+GET https://{endpoint}/v2/{project_id}/types/6c81c680-df58-4512-81e7-ecf66d160638
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
volume_type + |
+Object + |
+Specifies 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. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
extra_specs + |
+Object + |
+Specifies the disk type specifications. For details, see Parameters in the extra_specs field. + |
+
name + |
+String + |
+Specifies the name of the disk type. + |
+
id + |
+String + |
+Specifies the ID of the disk type. + |
+
description + |
+String + |
+Specifies the description of the disk type. + |
+
qos_specs_id + |
+String + |
+Reserved field + |
+
is_public + |
+Boolean + |
+Reserved field + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
volume_backend_name + |
+String + |
+Reserved field + |
+
availability-zone + |
+String + |
+Reserved field + |
+
HW:availability_zone + |
+String + |
+Reserved field + |
+
RESKEY:availability_zones + |
+String + |
+Specifies the AZs that support the current disk type. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "volume_type": {
+ "extra_specs": {
+ "volume_backend_name": "SATA",
+ "availability-zone": "az-dc-1"
+ },
+ "name": "SATA",
+ "qos_specs_id": null,
+ "is_public": true,
+ "id": "ea6e3c13-aac5-46e0-b280-745ed272e662",
+ "description": null
+ }
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badrequest or itemNotFound. An example is provided as follows:
+{
+ "badrequest": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to query the details of tenant quotas.
+GET /v2/{project_id}/os-quota-sets/{target_project_id}?usage=True
+Parameter + |
+Mandatory + |
+Description + |
+
|---|---|---|
project_id + |
+Yes + |
+Specifies the project ID. + |
+
target_project_id + |
+Yes + |
+Specifies the ID of the target project. Set this parameter to the value of project_id. + |
+
usage + |
+Yes + |
+Specifies whether to query the quota details. Only value true is supported currently. + |
+
GET https://{endpoint}/v2/{project_id}/os-quota-sets/{project_id}?usage=True
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
quota_set + |
+Object + |
+Specifies the queried quota information. For details, see Parameters in the quota_set field. + |
+
error + |
+Object + |
+Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
volumes + |
+Object + |
+Specifies the number of disks. Sub-parameters include reserved (reserved quota), limit (maximum quota), and in_use (used quota), and are made up of key-value pairs. + |
+
snapshots + |
+Object + |
+Specifies the number of snapshots. Sub-parameters include reserved (reserved quota), limit (maximum quota), and in_use (used quota), and are made up of key-value pairs. + |
+
gigabytes + |
+Object + |
+Specifies the total size (GB) of disks and snapshots allowed. Sub-parameters include reserved (reserved quota), limit (maximum quota), and in_use (used quota), and are made up of key-value pairs. + |
+
volumes_SSD + |
+Object + |
+Specifies the number of reserved ultra-high I/O disks. Sub-parameters include reserved (reserved quota), limit (maximum quota), and in_use (used quota), and are made up of key-value pairs. + |
+
volumes_SAS + |
+Object + |
+Specifies the number of reserved high I/O disks. Sub-parameters include reserved (reserved quota), limit (maximum quota), and in_use (used quota), and are made up of key-value pairs. + |
+
volumes_SATA + |
+Object + |
+Specifies the number of reserved common I/O disks. Sub-parameters include reserved (reserved quota), limit (maximum quota), and in_use (used quota), and are made up of key-value pairs. + |
+
snapshots_SSD + |
+Object + |
+Specifies the number of snapshots reserved for ultra-high I/O disks. Sub-parameters include reserved (reserved quota), limit (maximum quota), and in_use (used quota), and are made up of key-value pairs. + |
+
snapshots_SAS + |
+Object + |
+Specifies the number of snapshots reserved for high I/O disks. Sub-parameters include reserved (reserved quota), limit (maximum quota), and in_use (used quota), and are made up of key-value pairs. + |
+
snapshots_SATA + |
+Object + |
+Specifies the number of snapshots reserved for common I/O disks. Sub-parameters include reserved (reserved quota), limit (maximum quota), and in_use (used quota), and are made up of key-value pairs. + |
+
gigabytes_SSD + |
+Object + |
+Specifies the size (GB) reserved for ultra-high I/O disks. Sub-parameters include reserved (reserved quota), limit (maximum quota), and in_use (used quota), and are made up of key-value pairs. + |
+
gigabytes_SAS + |
+Object + |
+Specifies the size (GB) reserved for high I/O disks. Sub-parameters include reserved (reserved quota), limit (maximum quota), and in_use (used quota), and are made up of key-value pairs. + |
+
gigabytes_SATA + |
+Object + |
+Specifies the size (GB) reserved for common I/O disks. Sub-parameters include reserved (reserved quota), limit (maximum quota), and in_use (used quota), and are made up of key-value pairs. + |
+
id + |
+String + |
+Specifies the tenant ID. The tenant ID is actually the project ID. + |
+
backups + |
+Object + |
+Specifies the number of backups. Sub-parameters include reserved (reserved quota), limit (maximum quota), and in_use (used quota), and are made up of key-value pairs. + |
+
backup_gigabytes + |
+Object + |
+Specifies the backup size (GB). Sub-parameters include reserved (reserved quota), limit (maximum quota), and in_use (used quota), and are made up of key-value pairs. + |
+
per_volume_gigabytes + |
+Object + |
+Specifies the capacity quota of each EVS disk. Sub-parameters include reserved (reserved quota), limit (maximum quota), and in_use (used quota), and are made up of key-value pairs. + |
+
If the limit value returned in the response is -1, no quota limit has been set.
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "quota_set": {
+ "gigabytes_SAS": {
+ "reserved": 0,
+ "limit": -1,
+ "in_use": 21
+ },
+ "volumes_SATA": {
+ "reserved": 0,
+ "limit": -1,
+ "in_use": 8
+ },
+ "gigabytes": {
+ "reserved": 0,
+ "limit": 42790,
+ "in_use": 2792
+ },
+ "backup_gigabytes": {
+ "reserved": 0,
+ "limit": 5120,
+ "in_use": 51
+ },
+ "snapshots_SAS": {
+ "reserved": 0,
+ "limit": -1,
+ "in_use": 0
+ },
+ "volumes_SSD": {
+ "reserved": 0,
+ "limit": -1,
+ "in_use": 28
+ },
+ "snapshots": {
+ "reserved": 0,
+ "limit": 10,
+ "in_use": 6
+ },
+ "id": "cd631140887d4b6e9c786b67a6dd4c02",
+ "volumes_SAS": {
+ "reserved": 0,
+ "limit": -1,
+ "in_use": 2
+ },
+ "snapshots_SSD": {
+ "reserved": 0,
+ "limit": -1,
+ "in_use": 0
+ },
+ "volumes": {
+ "reserved": 0,
+ "limit": -1,
+ "in_use": 108
+ },
+ "gigabytes_SATA": {
+ "reserved": 0,
+ "limit": -1,
+ "in_use": 168
+ },
+ "backups": {
+ "reserved": 0,
+ "limit": 100,
+ "in_use": 10
+ },
+ "gigabytes_SSD": {
+ "reserved": 0,
+ "limit": -1,
+ "in_use": 1085
+ },
+ "snapshots_SATA": {
+ "reserved": 0,
+ "limit": -1,
+ "in_use": 0
+ }
+ }
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badrequest or itemNotFound. An example is provided as follows:
+{
+ "badrequest": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to add or update the metadata of an EVS disk.
+Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
metadata + |
+Object + |
+Yes + |
+Specifies the metadata to be updated. For details, see Parameter in the metadata field. +The length of the key or value in the metadata cannot exceed 255 bytes. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
key_val + |
+String + |
+No + |
+Specifies the metadata information, which is made up of one or multiple key-value pairs. + |
+
{
+ "metadata": {
+ "key1": "value1",
+ "key2": "value2"
+ }
+}
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
metadata + |
+Object + |
+Specifies 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. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "metadata": {
+ "key1": "value1",
+ "key2": "value2"
+ }
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badrequest or itemNotFound. An example is provided as follows:
+{
+ "badrequest": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to query the metadata of an EVS disk.
+GET https://{endpoint}/v2/{project_id}/volumes/{volume_id}/metadata
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
metadata + |
+Object + |
+Specifies 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. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "metadata": {
+ "key1": "value1",
+ "key2": "value2"
+ }
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badrequest or itemNotFound. An example is provided as follows:
+{
+ "badrequest": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to update the metadata of an EVS disk.
+Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
metadata + |
+Object + |
+Yes + |
+Specifies the disk metadata to be updated. For details, see Parameter in the metadata field. +The length of the key or value in the metadata cannot exceed 255 bytes. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
key_val + |
+String + |
+No + |
+Specifies the metadata information, which is made up of one or multiple key-value pairs. + |
+
{
+ "metadata": {
+ "key1": "value1",
+ "key2": "value2"
+ }
+}
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
metadata + |
+Object + |
+Specifies 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. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "metadata": {
+ "key1": "value1",
+ "key2": "value2"
+ }
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badrequest or itemNotFound. An example is provided as follows:
+{
+ "badrequest": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to query one piece of the EVS disk metadata.
+Parameter + |
+Mandatory + |
+Description + |
+
|---|---|---|
project_id + |
+Yes + |
+Specifies the project ID. + |
+
volume_id + |
+Yes + |
+Specifies the disk ID. + |
+
key + |
+Yes + |
+Specifies the key of the piece of metadata to be queried. + |
+
GET https://{endpoint}/v2/{project_id}/volumes/b104b8db-170d-441b-897a-3c8ba9c5a214/metadata/value1
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
meta + |
+Object + |
+Specifies a 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. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "meta": {
+ "key1": "value1"
+ }
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badrequest or itemNotFound. An example is provided as follows:
+{
+ "itemNotFound": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to update one piece of the EVS disk metadata.
+Parameter + |
+Mandatory + |
+Description + |
+
|---|---|---|
project_id + |
+Yes + |
+Specifies the project ID. + |
+
volume_id + |
+Yes + |
+Specifies the disk ID. + |
+
key + |
+Yes + |
+Specifies the key of the piece of metadata to be updated. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
meta + |
+Object + |
+Yes + |
+Specifies the disk metadata to be updated. For details, see Parameter in the meta field. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
key_val + |
+String + |
+No + |
+Specifies a piece of metadata, which is made up of a key-value pair. + |
+
{
+ "meta": {
+ "key1": "value1"
+ }
+}
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
meta + |
+Object + |
+Specifies a 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. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "meta": {
+ "key1": "value1"
+ }
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badRequest or itemNotFound. An example is provided as follows:
+{
+ "badRequest": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to delete one piece of the EVS disk metadata.
+Parameter + |
+Mandatory + |
+Description + |
+
|---|---|---|
project_id + |
+Yes + |
+Specifies the project ID. + |
+
volume_id + |
+Yes + |
+Specifies the disk ID. + |
+
key + |
+Yes + |
+Specifies the key of the piece of metadata to be deleted. + |
+
DELETE https://{endpoint}/v2/{project_id}/volumes/b104b8db-170d-441b-897a-3c8ba9c5a214/metadata/value1
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
error + |
+Object + |
+Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badrequest or itemNotFound. An example is provided as follows:
+{
+ "itemNotFound": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to query extension APIs.
+GET https://{endpoint}/v2/{project_id}/extensions
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
extensions + |
+list + |
+Specifies 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. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
updated + |
+String + |
+Specifies the last update time. +Time format: UTC YYYY-MM-DDTHH:MM:SS.+XX.XX + |
+
description + |
+String + |
+Specifies the description. + |
+
links + |
+list<map<String,String>> + |
+Reserved field + |
+
alias + |
+String + |
+Specifies the extension parameter alias. + |
+
name + |
+String + |
+Specifies the extension parameter name. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "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."
+ }
+ ]
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badRequest or itemNotFound. An example is provided as follows:
+{
+ "badRequest": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to query all AZs.
+GET https://{endpoint}/v2/{project_id}/os-availability-zone
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
availabilityZoneInfo + |
+list + |
+Specifies the list of queried AZs. For details, see Parameters in the availabilityZoneInfo field. + |
+
error + |
+Object + |
+Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
zoneState + |
+Object + |
+Specifies the status of the AZ. For details, see Parameter in the zoneState field. + |
+
zoneName + |
+String + |
+Specifies the AZ name. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
available + |
+Boolean + |
+Specifies whether the AZ is available.
+
|
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "availabilityZoneInfo": [
+ {
+ "zoneState": {
+ "available": true
+ },
+ "zoneName": "az-dc-1"
+ }
+ ]
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to expand the capacity of an EVS disk.
+Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
os-extend + |
+Object + |
+Yes + |
+Specifies the disk expansion marker. For details, see Parameter in the os-extend field. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
new_size + |
+Integer + |
+Yes + |
+Specifies the size of the disk after capacity expansion, in GB. +The new disk size ranges from the original disk size to the maximum size (32768 for a data disk and 1024 for a system disk). + |
+
{
+ "os-extend": {
+ "new_size": 100
+ }
+}
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
error + |
+Object + |
+Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
For details, see Error Codes.
+This API is used to set the bootable flag for an EVS disk.
+A data disk cannot be used as system disk for an ECS even if this API has been called to set the bootable flag for it.
+Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
os-set_bootable + |
+Object + |
+Yes + |
+Specifies the disk bootable marker. For details, see Parameter in the os-set_bootable field. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
bootable + |
+Boolean + |
+Yes + |
+Specifies whether to set the bootable flag for the disk. +
|
+
{
+ "os-set_bootable": {
+ "bootable": true
+ }
+}
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
error + |
+Object + |
+Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
For details, see Error Codes.
+This API is used to set the read-only flag for the EVS disk.
+Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
os-update_readonly_flag + |
+Object + |
+Yes + |
+Specifies the disk read-only flag. For details, see Parameter in the os-update_readonly_flag field. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
readonly + |
+Boolean + |
+Yes + |
+Specifies the read-only flag.
+
|
+
{
+ "os-update_readonly_flag": {
+ "readonly": true
+ }
+}
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
error + |
+Object + |
+Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
For details, see Error Codes.
+This API is used to export the system disk data or data disk data as an IMS image. The exported image will be displayed in the IMS private image list and can be viewed and used.
+If the target disk is in the in-use state, stop the server where the disk has been attached before calling this API. If the target disk is a shared disk, stop all servers where the shared disk has been attached before calling this API.
+Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
os-volume_upload_image + |
+Object + |
+Yes + |
+Specifies the operation to export the disk data as an image. For details, see Parameters in the os-volume_upload_image field. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
disk_format + |
+String + |
+No + |
+Specifies the format of the exported image. +The value can be vhd, zvhd, zvhd2, raw, or qcow2. The default value is zvhd2. + |
+
image_name + |
+String + |
+Yes + |
+Specifies the name of the exported image.
+
|
+
force + |
+Boolean + |
+No + |
+Specifies whether to forcibly export the image. The default value is false. +
|
+
container_format + |
+String + |
+No + |
+Specifies the container type of the exported image. +The value can be ami, ari, aki, ovf, or bare. The default value is bare. + |
+
__os_type + |
+String + |
+No + |
+Specifies the OS type of the exported image. Currently, only windows and linux are supported. The default value is linux. + NOTE:
+
|
+
{
+ "os-volume_upload_image": {
+ "image_name": "sxmatch2",
+ "force": true,
+ "container_format": "bare",
+ "disk_format": "vhd",
+ "__os_type": "linux"
+ }
+}
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
os-volume_upload_image + |
+Object + |
+Specifies the operation to export the disk data as an image. For details, see Parameters in the os-volume_upload_image field. + |
+
error + |
+Object + |
+Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
status + |
+String + |
+Specifies the disk status after the image is exported. The correct value is uploading. + |
+
image_id + |
+String + |
+Specifies the ID of the exported image. + |
+
image_name + |
+String + |
+Specifies the name of the exported image. + |
+
volume_type + |
+Object + |
+Specifies the disk type information. For details, see Parameters in the volume_type field. + |
+
container_format + |
+String + |
+Specifies the container type of the exported image. +The value can be ami, ari, aki, ovf, or bare. The default value is bare. + |
+
size + |
+Integer + |
+Specifies the disk size, in GB. + |
+
disk_format + |
+String + |
+Specifies the format of the exported image. +The value can be vhd, zvhd, zvhd2, raw, or qcow2. The default value is vhd. + |
+
id + |
+String + |
+Specifies the disk ID. + |
+
display_description + |
+String + |
+Specifies the disk description. + |
+
updated_at + |
+String + |
+Specifies the time when the disk was updated. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+Specifies the ID of the disk type. + |
+
name + |
+String + |
+Specifies the name of the disk type. + |
+
deleted + |
+Boolean + |
+Specifies whether to delete the disk type. + |
+
is_public + |
+Boolean + |
+Reserved field + |
+
extra_spec + |
+Object + |
+Specifies the disk type specifications. For details, see Parameters in the extra_specs field. + |
+
description + |
+Integer + |
+Specifies the description of the disk type. + |
+
created_at + |
+String + |
+Specifies the time when the disk type was created. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
updated_at + |
+String + |
+Specifies the time when the disk type was updated. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
deleted_at + |
+String + |
+Specifies the time when the disk type was deleted. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
volume_backend_name + |
+String + |
+Reserved field + |
+
availability-zone + |
+String + |
+Reserved field + |
+
HW:availability_zone + |
+String + |
+Reserved field + |
+
RESKEY:availability_zones + |
+String + |
+Specifies the AZs that support the current disk type. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "os-volume_upload_image": {
+ "status": "uploading",
+ "size": 40,
+ "id": "16369c5d-384d-4e64-b37a-56d898769362",
+ "image_id": "c5333daa-fbc8-4d1d-bf79-b0567bb45d15",
+ "image_name": "evs-ims-test1027",
+ "volume_type": {
+ "description": "None",
+ "deleted": false,
+ "created_at": "2015-05-24T14:47:22.132268",
+ "updated_at": "2017-07-29T11:29:33.730076",
+ "extra_specs": {
+ "volume_backend_name": "<or> iaas blockstorage_SATA <or> iaas blockstorage_SAS <or> iaas blockstoragesata",
+ "XX:availability_zone": "az-dc-1"
+ },
+ "is_public": true,
+ "deleted_at": null,
+ "id": "8247b6ed-37f0-4c48-8ef1-f0027fb332bc",
+ "name": "SATA"
+ },
+ "container_format": "bare",
+ "disk_format": "vhd",
+ "display_description": "",
+ "updated_at": "2018-01-11T01:50:25.800931"
+ }
+}
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+{
+ "itemNotFound": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is only used to change the EVS disk status from available to in-use.
+
This API call exists for compatibility reasons only and is not meant to be used.
+Do not call this API to attach a disk. If you need to attach a disk, call the ECS Attach Volume API.
+Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
os-attach + |
+Object + |
+Yes + |
+Specifies the disk attachment marker. For details, see Parameters in the os-attach field. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
instance_uuid + |
+String + |
+Yes + |
+Specifies the UUID of the host to be attached to. + |
+
mountpoint + |
+String + |
+Yes + |
+Specifies the device name. + |
+
host_name + |
+String + |
+No + |
+Specifies the name of the host to be attached to. The value can contain a maximum of 255 bytes. + |
+
mode + |
+String + |
+No + |
+Specifies the attachment mode. The value can be rw (read/write) or ro (read-only). + |
+
POST https://{endpoint}/v2/{project_id}/volumes/b104b8db-170d-441b-897a-3c8ba9c5a214/action
+{
+ "os-attach": {
+ "instance_uuid": "95D9EF50-507D-11E5-B970-0800200C9A66",
+ "mountpoint": "/dev/vdc"
+ }
+}
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
error + |
+Object + |
+Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
For details, see Error Codes.
+This API is only used to change the EVS disk status from in-use to available.
+
This API call exists for compatibility reasons only and is not meant to be used.
+Do not call this API to detach a disk. If you need to detach a disk, call the ECS Detach Volume API.
+Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
os-detach + |
+Object + |
+Yes + |
+Specifies disk detachment marker. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
attachment_id + |
+String + |
+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. + |
+
POST https://{endpoint}/v2/{project_id}/volumes/b104b8db-170d-441b-897a-3c8ba9c5a214/action
+{
+ "os-detach": {
+ "attachment_id": "d8777f54-84cf-4809-a679-468ffed56cf1"
+ }
+}
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
error + |
+Object + |
+Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
For details, see Error Codes.
+This API is used to reserve an EVS disk.
+
This API call exists for compatibility reasons only and is not meant to be used.
+Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
os-reserve + |
+Object + |
+Yes + |
+Specifies disk reservation marker. Defining a value for this parameter is not mandatory, and you are advised to leave it blank. + |
+
POST https://{endpoint}/v2/{project_id}/volumes/b104b8db-170d-441b-897a-3c8ba9c5a214/action
+{
+ "os-reserve": {}
+}
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
error + |
+Object + |
+Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
For details, see Error Codes.
+This API is used to cancel the reservation of an EVS disk.
+
This API call exists for compatibility reasons only and is not meant to be used.
+Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
os-unreserve + |
+Object + |
+Yes + |
+Specifies disk reservation canceling marker. Defining a value for this parameter is not mandatory, and you are advised to leave it blank. + |
+
POST https://{endpoint}/v2/{project_id}/volumes/b104b8db-170d-441b-897a-3c8ba9c5a214/action
+{
+ "os-unreserve": {}
+}
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
error + |
+Object + |
+Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
For details, see Error Codes.
+This API is used to create an EVS snapshot.
+Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
snapshot + |
+Object + |
+Yes + |
+Specifies the information of the snapshot to be created. For details, see Parameters in the snapshot field. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
volume_id + |
+String + |
+Yes + |
+Specifies the ID of the snapshot's source disk. + |
+
force + |
+Boolean + |
+No + |
+Specifies the flag for forcibly creating a snapshot. The default value is false. +
|
+
metadata + |
+Object + |
+No + |
+Specifies the snapshot metadata. + |
+
description + |
+String + |
+No + |
+Specifies the snapshot description. The value can be null. The value can contain a maximum of 255 bytes. + |
+
name + |
+String + |
+No + |
+Specifies 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. + |
+
{
+ "snapshot": {
+ "name": "snap-001",
+ "description": "Daily backup",
+ "volume_id": "5aa119a8-d25b-45a7-8d1b-88e127885635",
+ "force": false,
+ "metadata": { }
+ }
+}
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
snapshot + |
+Object + |
+Specifies 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. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+Specifies the snapshot ID. + |
+
status + |
+String + |
+Specifies the snapshot status. For details, see EVS Snapshot Status. + |
+
name + |
+String + |
+Specifies the snapshot name. + |
+
description + |
+String + |
+Specifies the snapshot description. + |
+
created_at + |
+String + |
+Specifies the time when the snapshot was created. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
metadata + |
+Object + |
+Specifies the snapshot metadata. + |
+
volume_id + |
+String + |
+Specifies the ID of the snapshot's source disk. + |
+
size + |
+Integer + |
+Specifies the snapshot size, in GB. + |
+
updated_at + |
+String + |
+Specifies the time when the snapshot was updated. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
os-extended-snapshot-attributes:progress + |
+String + |
+Reserved field + |
+
os-extended-snapshot-attributes:project_id + |
+String + |
+Reserved field + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "snapshot": {
+ "status": "creating",
+ "description": "Daily backup",
+ "created_at": "2013-02-25T03:56:53.081642",
+ "metadata": { },
+ "volume_id": "5aa119a8-d25b-45a7-8d1b-88e127885635",
+ "size": 1,
+ "id": "ffa9bc5e-1172-4021-acaf-cdcd78a9584d",
+ "name": "snap-001",
+ "updated_at": "2013-02-25T03:56:53.081642"
+ }
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badRequest or itemNotFound. An example is provided as follows:
+{
+ "itemNotFound": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to delete an EVS snapshot.
+DELETE https://{endpoint}/v2/{project_id}/snapshots/f9faf7df-fdc1-4093-9ef3-5cba06eef995
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
error + |
+Object + |
+Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badRequest or itemNotFound. An example is provided as follows:
+{
+ "itemNotFound": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to update an EVS snapshot.
+Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
snapshot + |
+Object + |
+Yes + |
+Specifies the information of the snapshot to be updated. For details, see Parameters in the snapshot field. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
name + |
+String + |
+No + |
+Specifies 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. + |
+
description + |
+String + |
+No + |
+Specifies the snapshot description. The value can contain a maximum of 255 bytes. + |
+
{
+ "snapshot": {
+ "name": "snap-001",
+ "description": "Daily backup"
+ }
+}
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
snapshot + |
+Object + |
+Specifies 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. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+Specifies the snapshot ID. + |
+
status + |
+String + |
+Specifies the snapshot status. For details, see EVS Snapshot Status. + |
+
name + |
+String + |
+Specifies the snapshot name. + |
+
description + |
+String + |
+Specifies the snapshot description. + |
+
created_at + |
+String + |
+Specifies the time when the snapshot was created. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
metadata + |
+Object + |
+Specifies the snapshot metadata. + |
+
volume_id + |
+String + |
+Specifies the ID of the snapshot's source disk. + |
+
size + |
+Integer + |
+Specifies the snapshot size, in GB. + |
+
updated_at + |
+String + |
+Specifies the time when the snapshot was updated. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
os-extended-snapshot-attributes:progress + |
+String + |
+Reserved field + |
+
os-extended-snapshot-attributes:project_id + |
+String + |
+Reserved field + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "snapshot": {
+ "status": "available",
+ "description": "Daily backup",
+ "created_at": "2013-02-25T03:56:53.081642",
+ "metadata": { },
+ "volume_id": "5aa119a8-d25b-45a7-8d1b-88e127885635",
+ "size": 1,
+ "id": "f9faf7df-fdc1-4093-9ef3-5cba06eef995",
+ "name": "snap-001",
+ "updated_at": "2013-02-25T03:56:53.081642"
+ }
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badRequest or itemNotFound. An example is provided as follows:
+{
+ "itemNotFound": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to query the EVS snapshots.
+Parameter + |
+Mandatory + |
+Description + |
+
|---|---|---|
project_id + |
+Yes + |
+Specifies the project ID. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
marker + |
+String + |
+No + |
+Specifies the ID of the last record on the previous page. The returned value is the value of the item after this one. + |
+
offset + |
+Integer + |
+No + |
+Specifies the 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. + |
+
limit + |
+Integer + |
+No + |
+Specifies 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 /v2/xxx/snapshots?limit=50: Queries the 1–50 snapshots. GET /v2/xxx/snapshots?offset=50&limit=50: Queries the 51–100 snapshots. + |
+
name + |
+String + |
+No + |
+Specifies the snapshot name. This parameter does not support fuzzy search. The value can contain a maximum of 255 bytes. + |
+
status + |
+String + |
+No + |
+Specifies the snapshot status. For details, see EVS Snapshot Status. + |
+
volume_id + |
+String + |
+No + |
+Specifies the ID of the snapshot's source disk. + |
+
The following example shows how to query the snapshots in the available state.
+GET https://{endpoint}/v2/{project_id}/snapshots?status=available
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
snapshots + |
+Object + |
+Specifies 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. + |
+
error + |
+Object + |
+Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+Specifies the snapshot ID. + |
+
status + |
+String + |
+Specifies the snapshot status. For details, see EVS Snapshot Status. + |
+
name + |
+String + |
+Specifies the snapshot name. + |
+
description + |
+String + |
+Specifies the snapshot description. + |
+
created_at + |
+String + |
+Specifies the time when the snapshot was created. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
metadata + |
+Object + |
+Specifies the snapshot metadata. +If metadata contains the __system__enableActive field, the snapshot is automatically created during the backup of a server. + |
+
volume_id + |
+String + |
+Specifies the ID of the snapshot's source disk. + |
+
size + |
+Integer + |
+Specifies the snapshot size, in GB. + |
+
updated_at + |
+String + |
+Specifies the time when the snapshot was updated. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "snapshots": [
+ {
+ "created_at": "2016-02-16T16:54:14.981520",
+ "description": null,
+ "id": "b836dc3d-4e10-4ea4-a34c-8f6b0460a583",
+ "metadata": { },
+ "name": "test01",
+ "size": 1,
+ "status": "available",
+ "volume_id": "ba5730ea-8621-4ae8-b702-ff0ffc12c209",
+ "updated_at": null
+ },
+ {
+ "created_at": "2016-02-16T16:54:19.475397",
+ "description": null,
+ "id": "83be494d-329e-4a78-8ac5-9af900f48b95",
+ "metadata": { },
+ "name": "test02",
+ "size": 1,
+ "status": "available",
+ "volume_id": "ba5730ea-8621-4ae8-b702-ff0ffc12c209",
+ "updated_at": null
+ },
+ {
+ "created_at": "2016-02-16T16:54:24.367414",
+ "description": null,
+ "id": "dd360f46-7593-4d35-8f2c-5566fd0bd79e",
+ "metadata": { },
+ "name": "test03",
+ "size": 1,
+ "status": "available",
+ "volume_id": "ba5730ea-8621-4ae8-b702-ff0ffc12c209",
+ "updated_at": null
+ },
+ {
+ "created_at": "2016-02-16T16:54:29.766740",
+ "description": null,
+ "id": "4c29796a-8cf4-4482-9afc-e66da9a81240",
+ "metadata": { },
+ "name": "test04",
+ "size": 1,
+ "status": "available",
+ "volume_id": "ba5730ea-8621-4ae8-b702-ff0ffc12c209",
+ "updated_at": null
+ }
+ ],
+ "snapshots_links": null
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badRequest or itemNotFound. An example is provided as follows:
+{
+ "itemNotFound": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to query details about the EVS snapshots.
+Parameter + |
+Mandatory + |
+Description + |
+
|---|---|---|
project_id + |
+Yes + |
+Specifies the project ID. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
marker + |
+String + |
+No + |
+Specifies the ID of the last record on the previous page. The returned value is the value of the item after this one. + |
+
offset + |
+Integer + |
+No + |
+Specifies the 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. + |
+
limit + |
+Integer + |
+No + |
+Specifies 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 /v2/xxx/snapshots/detail?limit=50: Queries the 1–50 snapshots. GET /v2/xxx/snapshots/detail?offset=50&limit=50: Queries the 51–100 snapshots. + |
+
name + |
+String + |
+No + |
+Specifies the snapshot name. The value can contain a maximum of 255 bytes. + |
+
status + |
+String + |
+No + |
+Specifies the snapshot status. For details, see EVS Snapshot Status. + |
+
volume_id + |
+String + |
+No + |
+Specifies the ID of the snapshot's source disk. + |
+
The following example shows how to query details of the snapshots in the available state.
+GET https://{endpoint}/v2/{project_id}/snapshots/detail?status=available
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
snapshots + |
+Object + |
+Specifies 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. + |
+
error + |
+Object + |
+Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+Specifies the snapshot ID. + |
+
status + |
+String + |
+Specifies the snapshot status. For details, see EVS Snapshot Status. + |
+
name + |
+String + |
+Specifies the snapshot name. + |
+
description + |
+String + |
+Specifies the snapshot description. + |
+
created_at + |
+String + |
+Specifies the time when the snapshot was created. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
updated_at + |
+String + |
+Specifies the time when the snapshot was updated. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
metadata + |
+Object + |
+Specifies the snapshot metadata. +If metadata contains the __system__enableActive field, the snapshot is automatically created during the backup of a server. + |
+
volume_id + |
+String + |
+Specifies the ID of the snapshot's source disk. + |
+
size + |
+Integer + |
+Specifies the snapshot size, in GB. + |
+
os-extended-snapshot-attributes:project_id + |
+String + |
+Specifies the tenant ID. The tenant ID is actually the project ID. + |
+
os-extended-snapshot-attributes:progress + |
+String + |
+Reserved field + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "snapshots": [
+ {
+ "status": "available",
+ "os-extended-snapshot-attributes:progress": "100%",
+ "description": null,
+ "created_at": "2013-06-19T07:15:29.000000",
+ "metadata": { },
+ "volume_id": "ae11e59c-bd56-434a-a00c-04757e1c066d",
+ "os-extended-snapshot-attributes:project_id": "d6c277ba8820452e83df36f33c9fa561",
+ "size": 5,
+ "id": "6cd26877-3ca3-4f4e-ae2a-38cc3d6183fa",
+ "name": "name_xx2-snap",
+ "updated_at": null
+ },
+ {
+ "status": "available",
+ "os-extended-snapshot-attributes:progress": "100%",
+ "description": null,
+ "created_at": "2013-06-19T09:08:08.000000",
+ "metadata": { },
+ "volume_id": "ae11e59c-bd56-434a-a00c-04757e1c066d",
+ "os-extended-snapshot-attributes:project_id": "d6c277ba8820452e83df36f33c9fa561",
+ "size": 5,
+ "id": "b3253e26-5c37-48dd-8bf2-8795dd1e848f",
+ "name": "name_xx2-snap",
+ "updated_at": null
+ }
+ ]
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badRequest or itemNotFound. An example is provided as follows:
+{
+ "itemNotFound": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to query details about an EVS snapshot.
+GET https://{endpoint}/v2/{project_id}/snapshots/f9faf7df-fdc1-4093-9ef3-5cba06eef995
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
snapshot + |
+Object + |
+Specifies 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. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+Specifies the snapshot ID. + |
+
status + |
+String + |
+Specifies the snapshot status. For details, see EVS Snapshot Status. + |
+
name + |
+String + |
+Specifies 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. + |
+
description + |
+String + |
+Specifies the snapshot description. + |
+
created_at + |
+String + |
+Specifies the time when the snapshot was created. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
updated_at + |
+String + |
+Specifies the time when the snapshot was updated. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
metadata + |
+Object + |
+Specifies the snapshot metadata. +If metadata contains the __system__enableActive field, the snapshot is automatically created during the backup of a server. + |
+
volume_id + |
+String + |
+Specifies the ID of the snapshot's source disk. + |
+
size + |
+Integer + |
+Specifies the snapshot size, in GB. + |
+
os-extended-snapshot-attributes:project_id + |
+String + |
+Specifies the tenant ID. The tenant ID is actually the project ID. + |
+
os-extended-snapshot-attributes:progress + |
+String + |
+Reserved field + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "snapshot": {
+ "status": "available",
+ "os-extended-snapshot-attributes:progress": "100%",
+ "description": "daily backup",
+ "created_at": "2013-02-25t04:13:17.000000",
+ "metadata": {},
+ "volume_id": "5aa119a8-d25b-45a7-8d1b-88e127885635",
+ "os-extended-snapshot-attributes:project_id": "0c2eba2c5af04d3f9e9d0d410b371fde",
+ "size": 1,
+ "id": "2bb856e1-b3d8-4432-a858-09e4ce939389",
+ "name": "snap-001",
+ "updated_at": null
+
+ }
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badRequest or itemNotFound. An example is provided as follows:
+{
+ "itemNotFound": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to add the metadata of an EVS snapshot.
+Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
metadata + |
+Object + |
+Yes + |
+Specifies the metadata to be added. For details, see Parameter in the metadata field. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
key_val + |
+String + |
+No + |
+Specifies the metadata information, which is made up of one or multiple key-value pairs. + |
+
{
+ "metadata": {
+ "key1": "value1",
+ "key2": "value2"
+ }
+}
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
metadata + |
+Object + |
+Specifies 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. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "metadata": {
+ "key1": "value1",
+ "key2": "value2"
+ }
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badRequest or itemNotFound. An example is provided as follows:
+{
+ "badRequest": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to query the metadata of an EVS snapshot.
+GET https://{endpoint}/v2/{project_id}/snapshots/f9faf7df-fdc1-4093-9ef3-5cba06eef995/metadata
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
metadata + |
+Object + |
+Specifies 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. + |
+
error + |
+Object + |
+Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "metadata": {
+ "key1": "value1",
+ "key2": "value2"
+ }
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badRequest or itemNotFound. An example is provided as follows:
+{
+ "badRequest": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to update one piece of the EVS snapshot metadata.
+Parameter + |
+Mandatory + |
+Description + |
+
|---|---|---|
project_id + |
+Yes + |
+Specifies the project ID. + |
+
snapshot_id + |
+Yes + |
+Specifies the snapshot ID. + |
+
key + |
+Yes + |
+Specifies the key of the piece of metadata to be updated. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
meta + |
+Object + |
+Yes + |
+Specifies the metadata to be updated. For details, see Parameter in the metadata field. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
key_val + |
+String + |
+No + |
+Specifies a piece of metadata, which is made up of a key-value pair. + |
+
{
+ "meta": {
+ "key1": "value1"
+ }
+}
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
meta + |
+Object + |
+Specifies a 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. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "meta": {
+ "key1": "value1"
+ }
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badRequest or itemNotFound. An example is provided as follows:
+{
+ "badRequest": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to update the metadata of an EVS snapshot.
+Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
metadata + |
+Object + |
+Yes + |
+Specifies the metadata to be updated. For details, see Parameter in the metadata field. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
key_val + |
+String + |
+No + |
+Specifies the metadata information, which is made up of one or multiple key-value pairs. + |
+
{
+ "metadata": {
+ "key1": "value1",
+ "key2": "value2"
+ }
+}
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
metadata + |
+Object + |
+Specifies 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. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "metadata": {
+ "key1": "value1",
+ "key2": "value2"
+ }
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badRequest or itemNotFound. An example is provided as follows:
+{
+ "badRequest": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to query one piece of the EVS snapshot metadata.
+Parameter + |
+Mandatory + |
+Description + |
+
|---|---|---|
project_id + |
+Yes + |
+Specifies the project ID. + |
+
snapshot_id + |
+Yes + |
+Specifies the snapshot ID. + |
+
key + |
+Yes + |
+Specifies the key of the piece of metadata to be queried. + |
+
GET https://{endpoint}/v2/{project_id}/snapshots/f9faf7df-fdc1-4093-9ef3-5cba06eef995/metadata/value1
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
meta + |
+Object + |
+Specifies a 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. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "meta": {
+ "key1": "value1"
+ }
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badRequest or itemNotFound. An example is provided as follows:
+{
+ "badRequest": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to delete one piece of the EVS snapshot metadata.
+DELETE /v2/{project_id}/snapshots/{snapshot_id}/metadata/{key}
+Parameter + |
+Mandatory + |
+Description + |
+
|---|---|---|
project_id + |
+Yes + |
+Specifies the project ID. + |
+
snapshot_id + |
+Yes + |
+Specifies the snapshot ID. + |
+
key + |
+Yes + |
+Specifies the key of the piece of metadata to be deleted. + |
+
DELETE https://{endpoint}/v2/{project_id}/snapshots/f9faf7df-fdc1-4093-9ef3-5cba06eef995/metadata/value1
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
error + |
+Object + |
+Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
For details, see Error Codes.
+This API is used to create a disk transfer. After the transfer has been created, a transfer ID and an authentication key are returned.
+After a disk transfer is created, the disk status changes from available to awaiting-transfer. Once the disk transfer is accepted, the disk status changes to available again.
+A disk transfer can be created only when the disk status is available. The detailed constraints are as follows:
+
If the disk transfer is created using one of the unsupported disks, error code 400 will be returned.
+Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
transfer + |
+Object + |
+Yes + |
+Specifies the disk transfer marker. For details, see Parameters in the transfer field. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
volume_id + |
+String + |
+Yes + |
+Specifies the disk ID. + |
+
name + |
+String + |
+No + |
+Specifies the disk transfer name. The value can contain a maximum of 255 bytes. + |
+
{
+ "transfer": {
+ "volume_id": "c86b9af4-151d-4ead-b62c-5fb967af0e37",
+ "name": "first volume"
+ }
+}
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
transfer + |
+Object + |
+Specifies the disk transfer information. For details, see Parameters in the transfer field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
auth_key + |
+String + |
+Specifies the authentication key of the disk transfer. + |
+
links + |
+List< Dict > + |
+Specifies the links of the disk transfer. + |
+
created_at + |
+String + |
+Specifies the time when the disk transfer was created. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
volume_id + |
+String + |
+Specifies the disk ID. + |
+
id + |
+String + |
+Specifies the disk transfer ID. + |
+
name + |
+String + |
+Specifies the name of the disk transfer. + |
+
{
+ "transfer": {
+ "id": "1a7059f5-8ed7-45b7-8d05-2811e5d09f24",
+ "created_at": "2015-02-25T03:56:53.081642",
+ "name": "first volume",
+ "volume_id": "c86b9af4-151d-4ead-b62c-5fb967af0e37",
+ "auth_key": "9266c59563c84664",
+ "links": [
+ {
+ "href": "https://localhost/v2/firstproject/os-volume-transfer/3",
+ "rel": "self"
+ },
+ {
+ "href": "https://localhost/firstproject/os-volume-transfer/3",
+ "rel": "bookmark"
+ }
+ ]
+ }
+}
+For details, see Error Codes.
+This API is used to accept a disk transfer through the transfer ID and authentication key.
+
If the disk transfer is created using one of the unsupported disks, error code 400 will be returned.
+Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
accept + |
+Object + |
+Yes + |
+Specifies the disk transfer acceptance marker. For details, see Parameter in the accept field. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
auth_key + |
+String + |
+Yes + |
+Specifies the authentication key of the disk transfer. +Specifies the authentication key returned during the disk transfer creation. + |
+
{
+ "accept": {
+ "auth_key": "9266c59563c84664"
+ }
+}
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
transfer + |
+Object + |
+Specifies the disk transfer information. For details, see Parameters in the transfer field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
volume_id + |
+String + |
+Specifies the disk ID. + |
+
id + |
+String + |
+Specifies the disk transfer ID. + |
+
name + |
+String + |
+Specifies the name of the disk transfer. + |
+
links + |
+List< Dict > + |
+Specifies the links of the disk transfer. + |
+
{
+ "transfer": {
+ "id": "cac5c677-73a9-4288-bb9c-b2ebfb547377",
+ "name": "first volume transfer",
+ "volume_id": "894623a6-e901-4312-aa06-4275e6321cce",
+ "links": [
+ {
+ "href": "https://localhost/v2/firstproject/os-volume-transfer/1",
+ "rel": "self"
+ },
+ {
+ "href": "https://localhost/firstproject/os-volume-transfer/1",
+ "rel": "bookmark"
+ }
+ ]
+ }
+}
+For details, see Error Codes.
+This API is used to delete a disk transfer. A disk transfer can be deleted if it is not accepted. Accepted disk transfers cannot be deleted.
+DELETE https://{endpoint}/v2/{project_id}/os-volume-transfer/cac5c677-73a9-4288-bb9c-b2ebfb547377
+None
+For details, see Error Codes.
+This API is used to query the details of a disk transfer, including the transfer creation time, transfer ID, and transfer name.
+GET https://{endpoint}/v2/{project_id}/os-volume-transfer/cac5c677-73a9-4288-bb9c-b2ebfb547377
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
transfer + |
+Object + |
+Specifies the disk transfer details. For details, see Parameters in the transfer field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
links + |
+List< Dict > + |
+Specifies the links of the disk transfer. + |
+
created_at + |
+String + |
+Specifies the time when the disk transfer was created. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
volume_id + |
+String + |
+Specifies the disk ID. + |
+
id + |
+String + |
+Specifies the disk transfer ID. + |
+
name + |
+String + |
+Specifies the name of the disk transfer. + |
+
{
+ "transfer": {
+ "id": "cac5c677-73a9-4288-bb9c-b2ebfb547377",
+ "created_at": "2015-02-25T03:56:53.081642",
+ "name": "first volume transfer",
+ "volume_id": "894623a6-e901-4312-aa06-4275e6321cce",
+ "links": [
+ {
+ "href": "https://localhost/v2/firstproject/os-volume-transfer/1",
+ "rel": "self"
+ },
+ {
+ "href": "https://localhost/firstproject/os-volume-transfer/1",
+ "rel": "bookmark"
+ }
+ ]
+ }
+}
+For details, see Error Codes.
+This API is used to query all disk transfers of the current tenant.
+Parameter + |
+Mandatory + |
+Description + |
+
|---|---|---|
project_id + |
+Yes + |
+Specifies the project ID. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
limit + |
+Integer + |
+No + |
+Specifies 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. + |
+
offset + |
+Integer + |
+No + |
+Specifies the offset. All disk transfers after this offset will be queried. The value must be an integer greater than 0 but less than the number of disk transfers. + |
+
The following example shows how to query details of the disk transfers whose limit is no more than 50.
+GET https://{endpoint}/v2/{project_id}/os-volume-transfer?limit=50
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
transfers + |
+List<Transfer> + |
+Specifies the disk transfers. For details, see Parameters in the transfers field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
links + |
+List< Dict > + |
+Specifies the links of the disk transfer. + |
+
volume_id + |
+String + |
+Specifies the disk ID. + |
+
id + |
+String + |
+Specifies the disk transfer ID. + |
+
name + |
+String + |
+Specifies the name of the disk transfer. + |
+
{
+ "transfers": [
+ {
+ "id": "cac5c677-73a9-4288-bb9c-b2ebfb547377",
+ "name": "first volume transfer",
+ "volume_id": "894623a6-e901-4312-aa06-4275e6321cce",
+ "links": [
+ {
+ "href": "https://localhost/v2/firstproject/os-volume-transfer/1",
+ "rel": "self"
+ },
+ {
+ "href": "https://localhost/firstproject/os-volume-transfer/1",
+ "rel": "bookmark"
+ }
+ ]
+ },
+ {
+ "id": "f26c0dee-d20d-4e80-8dee-a8d91b9742a1",
+ "name": "second volume transfer",
+ "volume_id": "673db275-379f-41af-8371-e1652132b4c1",
+ "links": [
+ {
+ "href": "https://localhost/v2/firstproject/os-volume-transfer/2",
+ "rel": "self"
+ },
+ {
+ "href": "https://localhost/firstproject/os-volume-transfer/2",
+ "rel": "bookmark"
+ }
+ ]
+ }
+ ]
+}
+For details, see Error Codes.
+This API is used to query the details of all disk transfers, including the transfer creation time, transfer IDs, and transfer names.
+Parameter + |
+Mandatory + |
+Description + |
+
|---|---|---|
project_id + |
+Yes + |
+Specifies the project ID. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
limit + |
+Integer + |
+No + |
+Specifies 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. + |
+
offset + |
+Integer + |
+No + |
+Specifies the offset. All disk transfers after this offset will be queried. The value must be an integer greater than 0 but less than the number of disk transfers. + |
+
The following example shows how to query details of the disk transfers whose limit is no more than 50.
+GET https://{endpoint}/v2/{project_id}/os-volume-transfer/detail?limit=50
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
transfers + |
+List<Transfer> + |
+Specifies the disk transfer details. For details, see Parameters in the transfers field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
links + |
+List< Dict > + |
+Specifies the links of the disk transfer. + |
+
created_at + |
+String + |
+Specifies the time when the disk transfer was created. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
volume_id + |
+String + |
+Specifies the disk ID. + |
+
id + |
+String + |
+Specifies the disk transfer ID. + |
+
name + |
+String + |
+Specifies the name of the disk transfer. + |
+
{
+ "transfers": [
+ {
+ "id": "cac5c677-73a9-4288-bb9c-b2ebfb547377",
+ "created_at": "2015-02-25T03:56:53.081642",
+ "name": "first volume transfer",
+ "volume_id": "894623a6-e901-4312-aa06-4275e6321cce",
+ "links": [
+ {
+ "href": "https://localhost/v2/firstproject/os-volume-transfer/1",
+ "rel": "self"
+ },
+ {
+ "href": "https://localhost/firstproject/os-volume-transfer/1",
+ "rel": "bookmark"
+ }
+ ]
+ },
+ {
+ "id": "f26c0dee-d20d-4e80-8dee-a8d91b9742a1",
+ "created_at": "2015-03-25T03:56:53.081642",
+ "name": "second volume transfer",
+ "volume_id": "673db275-379f-41af-8371-e1652132b4c1",
+ "links": [
+ {
+ "href": "https://localhost/v2/firstproject/os-volume-transfer/2",
+ "rel": "self"
+ },
+ {
+ "href": "https://localhost/firstproject/os-volume-transfer/2",
+ "rel": "bookmark"
+ }
+ ]
+ }
+ ]
+}
+For details, see Error Codes.
+This API is used to create one or multiple EVS disks.
+Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
volume + |
+Object + |
+Yes + |
+Specifies the information of the disks to be created. For details, see Parameters in the volume field. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
backup_id + |
+String + |
+No + |
+Specifies the ID of the backup that can be used to create a disk. This parameter is mandatory when you use a backup to create the disk. + NOTE:
+For how to obtain the backup ID, see Querying All Backups in the Cloud Backup and Recovery API Reference. + |
+
availability_zone + |
+String + |
+Yes + |
+Specifies the AZ where you want to create the disk. If the AZ does not exist, the disk will fail to create. + NOTE:
+For details about how to obtain the AZ, see Querying All AZs. + |
+
description + |
+String + |
+No + |
+Specifies the disk description. The value can contain a maximum of 255 bytes. + |
+
size + |
+Integer + |
+No + |
+Specifies the disk size, in GB. Its value can be as follows:
+
This parameter is mandatory when you create an empty disk. You can specify the parameter value as required within the value range. +This parameter is mandatory when you create the disk from a snapshot. Ensure that the disk size is greater than or equal to the snapshot size. +This parameter is mandatory when you create the disk from an image. Ensure that the disk size is greater than or equal to the minimum disk capacity required by min_disk in the image attributes. +This parameter is optional when you create the disk from a backup. If this parameter is not specified, the disk size is equal to the backup size. + NOTE:
+If the specified parameter value is a decimal, the integral part of the value is used by default when the request is sent. + |
+
name + |
+String + |
+No + |
+Specifies the disk name. +
|
+
snapshot_id + |
+String + |
+No + |
+Specifies the snapshot ID. If this parameter is specified, the disk is created from a snapshot. + NOTE:
+For details about how to obtain the snapshot ID, see Querying Details About EVS Snapshots. + |
+
imageRef + |
+String + |
+No + |
+Specifies the image ID. If this parameter is specified, the disk is created from an image. + NOTE:
+BMS system disks cannot be created from BMS images. +For how to obtain the image ID, see Querying Images in the Image Management Service API Reference. + |
+
volume_type + |
+String + |
+Yes + |
+Specifies the disk type. +Currently, the value can be SSD, SAS, SATA, co-p1, or uh-l1.
+
If the specified disk type is not available in the AZ, the disk will fail to create. + NOTE:
+
|
+
count + |
+Integer + |
+No + |
+Specifies the number of disks to be created in a batch. If this parameter is not specified, only one disk is created. You can create a maximum of 100 disks in a batch. +If disks are created from a backup, batch creation is not supported, and this parameter must be set to 1. + NOTE:
+If the specified parameter value is a decimal, the integral part of the value is used by default when the request is sent. + |
+
shareable + |
+String + |
+No + |
+Specifies whether the disk is shareable. The value can be true (shared disk) or false (common disk). + NOTE:
+This field is no longer used. Use multiattach. + |
+
metadata + |
+Object + |
+No + |
+Specifies the metadata of the created disk. The length of the key or value in the metadata cannot exceed 255 bytes. +For details about metadata, see Parameters in the metadata field. Only the listed parameters can be specified when creating a disk. + NOTE:
+Parameter values under metadata cannot be null. + |
+
multiattach + |
+Boolean + |
+No + |
+Specifies whether the disk is shareable. The default value is false.
+
|
+
tags + |
+Object + |
+No + |
+Specifies the tags added to the disk during the disk creation. +A maximum of 10 tags can be created for a disk. +Tag keys of a tag must be unique. Deduplication will be performed for duplicate keys. Therefore, only one tag key in the duplicate keys is valid. +
|
+
Specifying either two of the backup_id, snapshot_id, and imageRef fields is not supported.
+Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
__system__encrypted + |
+String + |
+No + |
+Specifies the encryption field in metadata. The value can be 0 (not encrypted) or 1 (encrypted). +If this parameter does not exist, the disk will not be encrypted by default. + |
+
__system__cmkid + |
+String + |
+No + |
+Specifies the encryption CMK ID in metadata. This parameter is used together with __system__encrypted for encryption. The length of cmkid is fixed at 36 bytes. + NOTE:
+For details about how to obtain the CMK ID, see Querying the List of CMKs in the Key Management Service API Reference. + |
+
hw:passthrough + |
+String + |
+No + |
+
|
+
full_clone + |
+String + |
+No + |
+If the disk is created from a snapshot and linked cloning needs to be used, set this parameter to 0. + |
+
When creating a disk, you can only specify the fields of metadata listed in the preceding table.
+{
+ "volume": {
+ "backup_id": null,
+ "count": 1,
+ "availability_zone": "az-dc-1",
+ "description": "test_volume_1",
+ "size": 120,
+ "name": "test_volume_1",
+ "volume_type": "SSD",
+ "metadata": {
+ "__system__encrypted": "1",
+ "__system__cmkid": "37b0d52e-c249-40d6-83cb-2b93f22445bd"
+ }
+ }
+}
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
job_id + |
+String + |
+Specifies the task ID. + NOTE:
+For details about how to query the task status, see Querying Task Status. + |
+
error + |
+Object + |
+Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "job_id": "70a599e0-31e7-49b7-b260-868f441e862b"
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to query details about all disks.
+Parameter + |
+Mandatory + |
+Description + |
+
|---|---|---|
project_id + |
+Yes + |
+Specifies the project ID. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
marker + |
+String + |
+No + |
+Specifies the ID of the last record on the previous page. The returned value is the value of the item after this one. + |
+
name + |
+String + |
+No + |
+Specifies the disk name. The value can contain a maximum of 255 bytes. + |
+
limit + |
+Integer + |
+No + |
+Specifies 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. + |
+
sort_key + |
+String + |
+No + |
+Specifies the keyword based on which the returned results are sorted. The value can be id, status, size, or created_at, and the default value is created_at. + |
+
sort_dir + |
+String + |
+No + |
+Specifies the result sorting order. The default value is desc. +
|
+
offset + |
+Integer + |
+No + |
+Specifies the offset. All disks after this offset will be queried. The value must be an integer greater than 0 but less than the number of disks. + |
+
status + |
+String + |
+No + |
+Specifies the disk status. For details, see EVS Disk Status. + |
+
metadata + |
+String + |
+No + |
+Specifies the disk metadata. + |
+
availability_zone + |
+String + |
+No + |
+Specifies the AZ to which the disk belongs. + |
+
multiattach + |
+Boolean + |
+No + |
+Specifies whether the disk is shareable.
+
|
+
volume_type_id + |
+String + |
+No + |
+Specifies the disk type ID. + |
+
id + |
+String + |
+No + |
+Specifies the disk ID. + |
+
ids + |
+Array of strings + |
+No + |
+Specifies the disk IDs. The parameter value is in the ids=['id1','id2',...,'idx'] format. In the response, the ids value contains valid disk IDs only. Invalid disk IDs will be ignored. +Details about a maximum of 60 disks can be queried. +If parameters id and ids are both specified in the request, id will be ignored. + |
+
GET https://{endpoint}/v3/{project_id}/os-vendor-volumes/detail?status=available&multiattach=true
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
volumes + |
+Array of objects + |
+Specifies the list of queried disks. For details, see Parameters in the volumes field. + |
+
volumes_links + |
+Array of objects + |
+Specifies the query position marker in the disk list. If only some disks are returned in this query, the URL of the last disk queried will be returned. You can use this URL to continue to query the remaining disks in the next query. For details, see Parameters in the links field. + |
+
count + |
+Integer + |
+Specifies the number of queried disks. This value is not affected by the pagination. + |
+
error + |
+Object + |
+Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+Specifies the disk ID. + |
+
links + |
+Array of objects + |
+Specifies the disk URI. For details, see Parameters in the links field. + |
+
name + |
+String + |
+Specifies the disk name. + |
+
status + |
+String + |
+Specifies the disk status. For details, see EVS Disk Status. + |
+
attachments + |
+Array of objects + |
+Specifies the disk attachment information. For details, see Parameters in the attachments field. + |
+
availability_zone + |
+String + |
+Specifies the AZ to which the disk belongs. + |
+
os-vol-host-attr:host + |
+String + |
+Reserved field + |
+
source_volid + |
+String + |
+Specifies the source disk ID. This parameter has a value if the disk is created from a source disk. +Currently, this field is not supported by EVS. + |
+
snapshot_id + |
+String + |
+Specifies the snapshot ID. This parameter has a value if the disk is created from a snapshot. + |
+
description + |
+String + |
+Specifies the disk description. + |
+
created_at + |
+String + |
+Specifies the time when the disk was created. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
volume_type + |
+String + |
+Specifies the disk type. +Currently, the value can be SSD, SAS, SATA, co-p1, or uh-l1.
+
|
+
os-vol-tenant-attr:tenant_id + |
+String + |
+Specifies the ID of the tenant to which the disk belongs. The tenant ID is actually the project ID. + |
+
size + |
+Integer + |
+Specifies the disk size, in GB. + |
+
metadata + |
+Object + |
+Specifies the disk metadata. For details, see Parameters in the metadata field. +If metadata does not contain the hw:passthrough field, the disk device type is VBD. +If metadata does not contain the __system__encrypted field, the disk is not encrypted. + |
+
os-vol-mig-status-attr:migstat + |
+String + |
+Reserved field + |
+
os-vol-mig-status-attr:name_id + |
+String + |
+Reserved field + |
+
os-volume-replication:extended_status + |
+String + |
+Reserved field + |
+
encrypted + |
+Boolean + |
+Currently, this field is not supported by EVS. + |
+
replication_status + |
+String + |
+Reserved field + |
+
user_id + |
+String + |
+Reserved field + |
+
consistencygroup_id + |
+String + |
+Reserved field + |
+
bootable + |
+String + |
+Specifies whether the disk is bootable.
+
|
+
updated_at + |
+String + |
+Specifies the time when the disk was updated. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
shareable + |
+String + |
+Specifies whether the disk is shareable. + NOTE:
+This field is no longer used. Use multiattach. + |
+
multiattach + |
+Boolean + |
+Specifies whether the disk is shareable.
+
|
+
volume_image_metadata + |
+Object + |
+Specifies the metadata of the disk image. This field has a value if the disk is created from an image. Otherwise, it is left empty. + NOTE:
+For details about volume_image_metadata, see Querying Image Details (Native OpenStack API) in the Image Management Service API Reference. + |
+
tags + |
+Object + |
+Specifies the disk tags. +This field is returned if the disk has tags. Otherwise, it is left empty. + |
+
wwn + |
+String + |
+Specifies the unique identifier used when attaching the disk. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
href + |
+String + |
+Specifies the corresponding shortcut link. + |
+
rel + |
+String + |
+Specifies the shortcut link marker name. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
server_id + |
+String + |
+Specifies the ID of the server to which the disk is attached. + |
+
attachment_id + |
+String + |
+Specifies the ID of the attachment information. + |
+
attached_at + |
+String + |
+Specifies the time when the disk was attached. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
host_name + |
+String + |
+Specifies the name of the physical host accommodating the server to which the disk is attached. + |
+
volume_id + |
+String + |
+Specifies the disk ID. + |
+
device + |
+String + |
+Specifies the device name. + |
+
id + |
+String + |
+Specifies the ID of the attached resource. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
__system__encrypted + |
+String + |
+Specifies the parameter that describes the encryption function in metadata. The value can be 0 or 1.
+
|
+
__system__cmkid + |
+String + |
+Specifies the encryption CMK ID in metadata. This parameter is used together with __system__encrypted for encryption. The length of cmkid is fixed at 36 bytes. + |
+
hw:passthrough + |
+String + |
+Specifies the parameter that describes the disk device type in metadata. The value can be true or false.
+
|
+
full_clone + |
+String + |
+Specifies the clone method. When the disk is created from a snapshot, the parameter value is 0, indicating the linked cloning method. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "count": 1,
+ "volumes": [
+ {
+ "attachments": [ ],
+ "availability_zone": "az-dc-1",
+ "bootable": "false",
+ "consistencygroup_id": null,
+ "created_at": "2016-05-25T02:42:10.856332",
+ "description": null,
+ "encrypted": false,
+ "id": "b104b8db-170d-441b-897a-3c8ba9c5a214",
+ "links": [
+ {
+ "href": "https://volume.localdomain.com:8776/v3/dd14c6ac581f40059e27f5320b60bf2f/volumes/b104b8db-170d-441b-897a-3c8ba9c5a214",
+ "rel": "self"
+ },
+ {
+ "href": "https://volume.localdomain.com:8776/dd14c6ac581f40059e27f5320b60bf2f/volumes/b104b8db-170d-441b-897a-3c8ba9c5a214",
+ "rel": "bookmark"
+ }
+ ],
+ "metadata": {},
+ "name": "zjb_u25_test",
+ "os-vol-host-attr:host": "pod01.xxx#SATA",
+ "volume_image_metadata": { },
+ "os-vol-mig-status-attr:migstat": null,
+ "os-vol-mig-status-attr:name_id": null,
+ "os-vol-tenant-attr:tenant_id": "dd14c6ac581f40059e27f5320b60bf2f",
+ "os-volume-replication:extended_status": null,
+ "replication_status": "disabled",
+ "multiattach": false,
+ "size": 1,
+ "snapshot_id": null,
+ "source_volid": null,
+ "status": "available",
+ "updated_at": "2016-05-25T02:42:22.341984",
+ "user_id": "b0524e8342084ef5b74f158f78fc3049",
+ "volume_type": "SATA",
+ "service_type": "EVS",
+ "wwn": " 688860300000d136fa16f48f05992360"
+ }
+ ],
+ "volumes_links": [
+ {
+ "href": "https://volume.localdomain.com:8776/v3/dd14c6ac581f40059e27f5320b60bf2f/volumes/detail?limit=1&marker=b104b8db-170d-441b-897a-3c8ba9c5a214",
+ "rel": "next"
+ }
+ ]
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badRequest or itemNotFound. An example is provided as follows:
+{
+ "badRequest": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to query details about a disk.
+GET https://{endpoint}/v3/{project_id}/os-vendor-volumes/b104b8db-170d-441b-897a-3c8ba9c5a214
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
volume + |
+Object + |
+Specifies the queried disk. For details, see Parameters in the volume field. + |
+
error + |
+Object + |
+Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+Specifies the disk ID. + |
+
links + |
+Array of objects + |
+Specifies the disk URI. For details, see Parameters in the links field. + |
+
name + |
+String + |
+Specifies the disk name. + |
+
status + |
+String + |
+Specifies the disk status. For details, see EVS Disk Status. + |
+
attachments + |
+Array of objects + |
+Specifies the disk attachment information. For details, see Parameters in the attachments field. + |
+
availability_zone + |
+String + |
+Specifies the AZ to which the disk belongs. + |
+
source_volid + |
+String + |
+Specifies the source disk ID. This parameter has a value if the disk is created from a source disk. + |
+
snapshot_id + |
+String + |
+Specifies the snapshot ID. This parameter has a value if the disk is created from a snapshot. + |
+
description + |
+String + |
+Specifies the disk description. + |
+
os-vol-tenant-attr:tenant_id + |
+String + |
+Specifies the ID of the tenant to which the disk belongs. The tenant ID is actually the project ID. + |
+
volume_image_metadata + |
+Object + |
+Specifies the metadata of the disk image. + NOTE:
+For details about volume_image_metadata, see Querying Image Details (Native OpenStack API) in the Image Management Service API Reference. + |
+
created_at + |
+String + |
+Specifies the time when the disk was created. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
volume_type + |
+String + |
+Specifies the disk type. +Currently, the value can be SSD, SAS, SATA, co-p1, or uh-l1.
+
|
+
size + |
+Integer + |
+Specifies the disk size, in GB. + |
+
bootable + |
+String + |
+Specifies whether the disk is bootable.
+
|
+
metadata + |
+Object + |
+Specifies the disk metadata. For details, see Parameters in the metadata field. +If metadata does not contain the hw:passthrough field, the disk device type is VBD. +If metadata does not contain the __system__encrypted field, the disk is not encrypted. + |
+
os-vol-host-attr:host + |
+String + |
+Reserved field + |
+
encrypted + |
+Boolean + |
+Currently, this field is not supported by EVS. + |
+
updated_at + |
+String + |
+Specifies the time when the disk was updated. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
os-volume-replication:extended_status + |
+String + |
+Reserved field + |
+
replication_status + |
+String + |
+Reserved field + |
+
os-vol-mig-status-attr:migstat + |
+String + |
+Reserved field + |
+
consistencygroup_id + |
+String + |
+Reserved field + |
+
os-vol-mig-status-attr:name_id + |
+String + |
+Reserved field + |
+
shareable + |
+String + |
+Specifies whether the disk is shareable. + NOTE:
+This field is no longer used. Use multiattach. + |
+
user_id + |
+String + |
+Reserved field + |
+
multiattach + |
+Boolean + |
+Specifies whether the disk is shareable.
+
|
+
service_type + |
+String + |
+Specifies the service type. The value can be EVS. + |
+
tags + |
+Object + |
+Specifies the disk tags. +This field is returned if the disk has tags. Otherwise, it is left empty. + |
+
wwn + |
+String + |
+Specifies the unique identifier used when attaching the disk. + |
+
storage_cluster_id + |
+String + |
+Reserved field + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
href + |
+String + |
+Specifies the corresponding shortcut link. + |
+
rel + |
+String + |
+Specifies the shortcut link marker name. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
server_id + |
+String + |
+Specifies the ID of the server to which the disk is attached. + |
+
attachment_id + |
+String + |
+Specifies the ID of the attachment information. + |
+
attached_at + |
+String + |
+Specifies the time when the disk was attached. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
host_name + |
+String + |
+Specifies the name of the physical host accommodating the server to which the disk is attached. + |
+
volume_id + |
+String + |
+Specifies the disk ID. + |
+
device + |
+String + |
+Specifies the device name. + |
+
id + |
+String + |
+Specifies the ID of the attached resource. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
__system__encrypted + |
+String + |
+Specifies the parameter that describes the encryption function in metadata. The value can be 0 or 1.
+
|
+
__system__cmkid + |
+String + |
+Specifies the encryption CMK ID in metadata. This parameter is used together with __system__encrypted for encryption. The length of cmkid is fixed at 36 bytes. + |
+
hw:passthrough + |
+String + |
+Specifies the parameter that describes the disk device type in metadata. The value can be true or false.
+
|
+
full_clone + |
+String + |
+Specifies the clone method. When the disk is created from a snapshot, the parameter value is 0, indicating the linked cloning method. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "volume": {
+ "attachments": [ ],
+ "links": [
+ {
+ "href": "https://volume.az0.dc1.domainname.com/v3/40acc331ac784f34842ba4f08ff2be48/volumes/591ac654-26d8-41be-bb77-4f90699d2d41",
+ "rel": "self"
+ },
+ {
+ "href": "https://volume.az0.dc1.domainname.com/40acc331ac784f34842ba4f08ff2be48/volumes/591ac654-26d8-41be-bb77-4f90699d2d41",
+ "rel": "bookmark"
+ }
+ ],
+ "availability_zone": "az-dc-1",
+ "os-vol-host-attr:host": "az-dc-1#SSD",
+ "encrypted": false,
+ "multiattach": true,
+ "updated_at": "2016-02-03T02:19:29.895237",
+ "os-volume-replication:extended_status": null,
+ "replication_status": "disabled",
+ "snapshot_id": null,
+ "id": "591ac654-26d8-41be-bb77-4f90699d2d41",
+ "size": 40,
+ "user_id": "fd03ee73295e45478d88e15263d2ee4e",
+ "os-vol-tenant-attr:tenant_id": "40acc331ac784f34842ba4f08ff2be48",
+ "volume_image_metadata": null,
+ "os-vol-mig-status-attr:migstat": null,
+ "metadata": {},
+ "tags": {
+ "key1": "value1",
+ "key2": "value2"
+ },
+ "status": "error_restoring",
+ "description": "auto-created_from_restore_from_backup",
+ "source_volid": null,
+ "consistencygroup_id": null,
+ "os-vol-mig-status-attr:name_id": null,
+ "name": "restore_backup_0115efb3-678c-4a9e-bff6-d3cd278238b9",
+ "bootable": "false",
+ "created_at": "2016-02-03T02:19:11.723797",
+ "volume_type": null,
+ "service_type": "EVS",
+ "wwn": " 688860300000d136fa16f48f05992360"
+ }
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badrequest or itemNotFound. An example is provided as follows:
+{
+ "badrequest": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to query the loading progress of a lazyloading disk.
+None
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
info + |
+Object + |
+Specifies 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. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
loading_progress + |
+Integer + |
+Specifies the loading progress of the lazyloading disk. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "info": {
+ "loading_progress": 36
+ }
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badrequest or itemNotFound. An example is provided as follows:
+{
+ "badrequest": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to roll back a snapshot to an EVS disk.
+Parameter + |
+Mandatory + |
+Description + |
+
|---|---|---|
project_id + |
+Yes + |
+Specifies the project ID. + |
+
snapshot_id + |
+Yes + |
+Specifies the snapshot ID. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
rollback + |
+Object + |
+Yes + |
+Specifies the snapshot rollback information. For details, see Parameters in the rollback field. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
volume_id + |
+String + |
+Yes + |
+Specifies the ID of the target disk. + |
+
name + |
+String + |
+No + |
+Specifies the name of the target disk. The value can contain a maximum of 255 bytes. + NOTE:
+Parameter name cannot be used independently. When name is going to be used, volume_id must also be specified. + |
+
{
+ "rollback": {
+ "name": "test-001",
+ "volume_id": "5aa119a8-d25b-45a7-8d1b-88e127885635"
+ }
+}
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
rollback + |
+Object + |
+Specifies the snapshot rollback information. For details, see Parameter in the rollback field. + |
+
error + |
+Object + |
+Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
volume_id + |
+String + |
+Specifies the ID of the target disk. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "rollback": {
+ "volume_id": "5aa119a8-d25b-45a7-8d1b-88e127885635"
+ }
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badRequest or itemNotFound. An example is provided as follows:
+{
+ "badRequest": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to batch add tags for the specified EVS disk.
+None
+Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
tags + |
+Array of objects + |
+Yes + |
+Specifies the tag list. For details, see Parameters in the tag field. + |
+
action + |
+String + |
+Yes + |
+Specifies the operation to perform. The value can be create or delete. +create: specifies to add tags. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
key + |
+String + |
+Yes + |
+Specifies the tag key.
+
|
+
value + |
+String + |
+Yes + |
+Specifies the tag value.
+
|
+
{
+ "action": "create",
+ "tags": [
+ {
+ "key": "key1",
+ "value": "value1"
+ },
+ {
+ "key": "key2",
+ "value": "value3"
+ }
+ ]
+}
+None
+For details, see Error Codes.
+This API is used to batch delete tags for the specified EVS disk.
+None
+Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
tags + |
+List<resource_tag> + |
+Yes + |
+Specifies the tag list. For details, see Parameters in the tags field. + |
+
action + |
+String + |
+Yes + |
+Specifies the operation to perform. The value can be create or delete. +delete: specifies to delete tags. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
key + |
+String + |
+Yes + |
+Specifies the tag key. + |
+
value + |
+String + |
+No + |
+Specifies the tag value. +
|
+
{
+ "action": "delete",
+ "tags": [
+ {
+ "key": "key1"
+ },
+ {
+ "key": "key2"
+ }
+ ]
+}
+None
+For details, see Error Codes.
+This API is used to query the tags of the specified EVS disk.
+None
+None
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
tags + |
+List<resource_tag> + |
+Specifies the tag list. For details, see Parameters in the tags field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
key + |
+String + |
+Specifies the tag key. + |
+
value + |
+String + |
+Specifies the tag value. + |
+
{
+ "tags": [
+ {
+ "value": "value1",
+ "key": "key1"
+ },
+ {
+ "value": "value2",
+ "key": "key2"
+ }
+ ]
+}
+For details, see Error Codes.
+This API is used to query the number of EVS disks by tag.
+None
+Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
tags + |
+Array of objects + |
+No + |
+Specifies the key-value pairs of the tag. 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. +When multiple keys are specified in a tag list, only the disks having all specified keys are queried. + NOTE:
+If multiple tag lists are specified in the request, only the disks that meet the requirements of the last tag list are queried. + |
+
action + |
+String + |
+Yes + |
+Specifies the operation identifier. +Specifying count queries the number of disks by tag. + |
+
matches + |
+Array of objects + |
+No + |
+Specifies 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. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
key + |
+String + |
+Yes + |
+Specifies the tag key.
+
|
+
values + |
+Array of objects + |
+Yes + |
+Specifies the tag value.
+
One value list can contain a maximum of 10 values. +Tag values in a value list must be unique. +If the value list is left empty, any tag value can be matched. +When multiple values are specified in a value list and the key requirements are met, disks that have any of the specified values are queried. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
key + |
+String + |
+Yes + |
+Specifies the tag key. The value is of the enumerated type. +The value can be as follows: +
|
+
value + |
+String + |
+Yes + |
+Specifies the tag value. +
|
+
{
+ "action": "count",
+ "tags": [
+ {
+ "key": "key1",
+ "values": [
+ "value1",
+ "value2"
+ ]
+ }
+ ],
+ "matches": [
+ {
+ "key": "resource_name",
+ "value": "resource1"
+ },
+ {
+ "key": "service_type",
+ "value": "EVS"
+ }
+ ]
+}
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
total_count + |
+Integer + |
+Specifies 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. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "total_count": 1000
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badRequest or itemNotFound. An example is provided as follows:
+{
+ "computeFault": {
+ "message": "The server has either erred or is incapable of performing the requested operation.",
+ "code": 500
+ }
+}
+For details, see Error Codes.
+This API is used to query the details of EVS disks by tag.
+None
+Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
tags + |
+Array of objects + |
+Yes + |
+Specifies the key-value pairs of the tag. For details, see Parameters in the tags field. +One tag list can contain a maximum of 10 keys. +Tag keys in a tag list must be unique. +When multiple keys are specified in a tag list, only the disks having all specified keys are queried. + NOTE:
+If multiple tag lists are specified in the request, only the disks that meet the requirements of the last tag list are queried. + |
+
limit + |
+Integer + |
+No + |
+Specifies the number of query records. +The value ranges from 1 to 1000, and the default value is 1000. The returned value cannot exceed this limit. + |
+
offset + |
+Integer + |
+No + |
+Specifies the index location. +The minimum value is 0, which is also the default value. +The first record in the query result is the offset+1 record that meets the query criteria. + |
+
action + |
+String + |
+Yes + |
+Specifies the operation identifier. +Specifying filter queries the details of disks by tag. + |
+
matches + |
+Array of objects + |
+No + |
+Specifies the query criteria that the resource supports. For details, see Parameters in the matches field. +Tag keys in the list must be unique. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
key + |
+String + |
+Yes + |
+Specifies the tag key. + |
+
values + |
+Array of objects + |
+Yes + |
+Specifies the tag value. +
|
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
key + |
+String + |
+Yes + |
+Specifies the tag key. The value is of the enumerated type. +The value can be as follows: +
|
+
value + |
+String + |
+Yes + |
+Specifies the tag value. +
|
+
{
+ "offset": "100",
+ "limit": "100",
+ "action": "filter",
+ "tags": [
+ {
+ "key": "key1",
+ "values": [
+ "value1",
+ "value2"
+ ]
+ }
+ ],
+ "matches": [
+ {
+ "key": "resource_name",
+ "value": "resource1"
+ },
+ {
+ "key": "service_type",
+ "value": "EVS"
+ }
+ ]
+}
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
total_count + |
+Integer + |
+Specifies the total number of disks that meet the query criteria. + |
+
resources + |
+List<resource> + |
+Specifies the resources that meet the query criteria. For details, see Parameters in the resources field. + |
+
error + |
+Object + |
+Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
resource_id + |
+String + |
+Specifies the disk ID. + |
+
resource_name + |
+String + |
+Specifies the disk name. + |
+
resource_detail + |
+object + |
+Specifies the resource details. + |
+
tags + |
+Array of objects + |
+Specifies the tag list. For details, see Parameters in the tags field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
key + |
+String + |
+Specifies the tag key. + |
+
value + |
+String + |
+Specifies the tag value. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "total_count": 1,
+ "resources": [{
+ "resource_name": "resource1",
+ "resource_detail": {
+ "attachments": [{
+ "server_id": "2080869e-ba46-4ea5-b45e-3191ac0f1d54",
+ "attachment_id": "1335f039-7a42-4d1e-be49-ac584db0ba0b",
+ "attached_at": "2019-08-06T07:00:21.842812",
+ "host_name": null,
+ "volume_id": "7fa6b592-ac75-460d-a28a-bb17429d1eb2",
+ "device": "/dev/vda",
+ "id": "7fa6b592-ac75-460d-a28a-bb17429d1eb2"
+ }],
+ "links": [{
+ "href": "https://volume.Region.dc1.domainname.com/v2/051375756c80d5eb2ff0c014498645fb/volumes/7fa6b592-ac75-460d-a28a-bb17429d1eb2",
+ "rel": "self"
+ },
+ {
+ "href": "https://volume.Region.dc1.domainname.com/051375756c80d5eb2ff0c014498645fb/volumes/7fa6b592-ac75-460d-a28a-bb17429d1eb2",
+ "rel": "bookmark"
+ }],
+ "availability_zone": "kvmxen.dc1",
+ "os-vol-host-attr:host": "az21.dc1#2",
+ "encrypted": false,
+ "updated_at": "2019-08-09T06:19:35.874737",
+ "os-volume-replication:extended_status": null,
+ "replication_status": "disabled",
+ "snapshot_id": null,
+ "id": "7fa6b592-ac75-460d-a28a-bb17429d1eb2",
+ "size": 40,
+ "user_id": "75f26e17348643bfb7718578b04635c2",
+ "os-vol-tenant-attr:tenant_id": "051375756c80d5eb2ff0c014498645fb",
+ "service_type": "EVS",
+ "os-vol-mig-status-attr:migstat": null,
+ "metadata": {
+
+ },
+ "status": "in-use",
+ "volume_image_metadata": {
+ "size": "0",
+ "__quick_start": "False",
+ "container_format": "bare",
+ "min_ram": "0",
+ "image_name": "test-hua-centos7.3-0725",
+ "image_id": "c6c153a6-dde8-4bac-8e40-3d7619436934",
+ "__os_type": "Linux",
+ "min_disk": "20",
+ "__support_kvm": "true",
+ "virtual_env_type": "FusionCompute",
+ "__description": "",
+ "__os_version": "CentOS 7.3 64bit",
+ "__os_bit": "64",
+ "__image_source_type": "uds",
+ "__support_xen": "true",
+ "file_format": "zvhd2",
+ "checksum": "d41d8cd98f00b204e9800998ecf8427e",
+ "__imagetype": "gold",
+ "disk_format": "zvhd2",
+ "__image_cache_type": "Not_Cache",
+ "__isregistered": "true",
+ "__image_location": "192.168.46.200:5443:pcsimsregion:c6c153a6-dde8-4bac-8e40-3d7619436934",
+ "__image_size": "911269888",
+ "__platform": "CentOS"
+ },
+ "description": "",
+ "multiattach": false,
+ "source_volid": null,
+ "consistencygroup_id": null,
+ "os-vol-mig-status-attr:name_id": null,
+ "name": "resource1",
+ "bootable": "true",
+ "created_at": "2019-08-06T06:59:03.056682",
+ "volume_type": "SAS",
+ "shareable": false,
+ },
+ "tags": [{
+ "key": "key1",
+ "value": "value1"
+ },
+ {
+ "key": "key1",
+ "value": "value2"
+ }],
+ "resource_id": "7fa6b592-ac75-460d-a28a-bb17429d1eb2"
+ }]
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badRequest or itemNotFound. An example is provided as follows:
+{
+ "computeFault": {
+ "message": "The server has either erred or is incapable of performing the requested operation.",
+ "code": 500
+ }
+}
+For details, see Error Codes.
+This API is used to create one or multiple EVS disks.
+Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
volume + |
+Object + |
+Yes + |
+Specifies the information of the disks to be created. For details, see Parameters in the volume field. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
availability_zone + |
+String + |
+Yes + |
+Specifies the AZ where you want to create the disk. If the AZ does not exist, the disk will fail to create. + NOTE:
+For details about how to obtain the AZ, see Querying All AZs. + |
+
source_volid + |
+String + |
+No + |
+Specifies the source disk ID. If this parameter is specified, the disk is cloned from an existing disk. Currently, this function is not supported. + |
+
description + |
+String + |
+No + |
+Specifies the disk description. The value can contain a maximum of 255 bytes. + |
+
snapshot_id + |
+String + |
+No + |
+Specifies the snapshot ID. If this parameter is specified, the disk is created from a snapshot. + NOTE:
+For details about how to obtain the snapshot ID, see Querying Details About EVS Snapshots. + |
+
size + |
+Integer + |
+Yes + |
+Specifies the disk size, in GB. Its value can be as follows:
+
This parameter is mandatory when you create an empty disk. You can specify the parameter value as required within the value range. +This parameter is mandatory when you create the disk from a snapshot. Ensure that the disk size is greater than or equal to the snapshot size. +This parameter is mandatory when you create the disk from an image. Ensure that the disk size is greater than or equal to the minimum disk capacity required by min_disk in the image attributes. + |
+
name + |
+String + |
+No + |
+Specifies the disk name. The value can contain a maximum of 255 bytes. + |
+
imageRef + |
+String + |
+No + |
+Specifies the image ID. If this parameter is specified, the disk is created from an image. + NOTE:
+BMS system disks cannot be created from BMS images. +For how to obtain the image ID, see Querying Images in the Image Management Service API Reference. + |
+
volume_type + |
+String + |
+No + |
+Specifies the disk type. +Currently, the value can be SSD, SAS, SATA, co-p1, or uh-l1.
+
If the specified disk type is not available in the AZ, the disk will fail to create. + NOTE:
+
|
+
metadata + |
+Object + |
+No + |
+Specifies the disk metadata. The length of the key or value in the metadata cannot exceed 255 bytes. +For details about metadata, see Parameters in the metadata field. The table lists some fields. You can also specify other fields based on the disk creation requirements. + NOTE:
+Parameter values under metadata cannot be null. + |
+
source_replica + |
+String + |
+No + |
+Specifies the source disk ID. If this parameter is specified, the disk is cloned from an existing disk. Currently, this function is not supported. + |
+
consistencygroup_id + |
+String + |
+No + |
+Reserved field + |
+
shareable + |
+String + |
+No + |
+Specifies whether the disk is shareable. The value can be true (sharable) or false (not sharable). This is an extended attribute. + NOTE:
+This field is no longer used. Use multiattach. + |
+
multiattach + |
+Boolean + |
+No + |
+Specifies whether the disk is shareable. The default value is false.
+
|
+
Specifying either two of the source_volid, snapshot_id, and imageRef fields is not supported.
+Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
__system__encrypted + |
+String + |
+No + |
+Specifies the encryption field in metadata. The value can be 0 (not encrypted) or 1 (encrypted). +If this parameter does not exist, the disk will not be encrypted by default. + |
+
__system__cmkid + |
+String + |
+No + |
+Specifies the encryption CMK ID in metadata. This parameter is used together with __system__encrypted for encryption. The length of cmkid is fixed at 36 bytes. + NOTE:
+For details about how to obtain the CMK ID, see Querying the List of CMKs in the Key Management Service API Reference. + |
+
hw:passthrough + |
+String + |
+No + |
+
|
+
full_clone + |
+String + |
+No + |
+If the disk is created from a snapshot and linked cloning needs to be used, set this parameter to 0. + |
+
The preceding table provides only some parameters in metadata for your reference. You can also specify other fields based on the disk creation requirements.
+{
+ "volume": {
+ "name": "openapi_vol01",
+ "imageRef": "027cf713-45a6-45f0-ac1b-0ccc57ac12e2",
+ "availability_zone": "az-dc-1",
+ "description": "create for api test",
+ "volume_type": "SATA",
+ "metadata": {
+ "volume_owner": "openapi"
+ },
+ "multiattach": false,
+ "size": 40
+ },
+}
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
volume + |
+Object + |
+Specifies the information of the created disks. For details, see Parameters in the volumes field. + |
+
error + |
+Object + |
+Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+Specifies the disk ID. + |
+
links + |
+list + |
+Specifies the disk URI. For details, see Parameters in the links field. + |
+
name + |
+String + |
+Specifies the disk name. + |
+
status + |
+String + |
+Specifies the disk status. For details, see EVS Disk Status. + |
+
attachments + |
+list + |
+Specifies the disk attachment information. For details, see Parameters in the attachments field. + |
+
availability_zone + |
+String + |
+Specifies the AZ to which the disk belongs. + |
+
bootable + |
+String + |
+Specifies whether the disk is bootable.
+
|
+
encrypted + |
+Boolean + |
+Currently, this field is not supported by EVS. + |
+
created_at + |
+String + |
+Specifies the time when the disk was created. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
description + |
+String + |
+Specifies the disk description. + |
+
volume_type + |
+String + |
+Specifies the disk type. +Currently, the value can be SSD, SAS, SATA, co-p1, or uh-l1.
+
|
+
replication_status + |
+String + |
+Reserved field + |
+
consistencygroup_id + |
+String + |
+Specifies the ID of the consistency group where the disk belongs. +Currently, this field is not supported by EVS. + |
+
source_volid + |
+String + |
+Specifies the source disk ID. +Currently, this field is not supported by EVS. + |
+
snapshot_id + |
+String + |
+Specifies the snapshot ID. + |
+
metadata + |
+Object + |
+Specifies the disk metadata. For details, see Parameters in the metadata field. + |
+
size + |
+Integer + |
+Specifies the disk size, in GB. + |
+
user_id + |
+String + |
+Reserved field + |
+
updated_at + |
+String + |
+Specifies the time when the disk was updated. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
shareable + |
+Boolean + |
+Specifies whether the disk is shareable. + NOTE:
+This field is no longer used. Use multiattach. + |
+
multiattach + |
+Boolean + |
+Specifies whether the disk is shareable.
+
|
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
href + |
+String + |
+Specifies the corresponding shortcut link. + |
+
rel + |
+String + |
+Specifies the shortcut link marker name. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
server_id + |
+String + |
+Specifies the ID of the server to which the disk is attached. + |
+
attachment_id + |
+String + |
+Specifies the ID of the attachment information. + |
+
attached_at + |
+String + |
+Specifies the time when the disk was attached. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
host_name + |
+String + |
+Specifies the name of the physical host accommodating the server to which the disk is attached. + |
+
volume_id + |
+String + |
+Specifies the disk ID. + |
+
device + |
+String + |
+Specifies the device name. + |
+
id + |
+String + |
+Specifies the ID of the attached resource. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
__system__encrypted + |
+String + |
+Specifies the parameter that describes the encryption function in metadata. The value can be 0 or 1.
+
|
+
__system__cmkid + |
+String + |
+Specifies the encryption CMK ID in metadata. This parameter is used together with __system__encrypted for encryption. The length of cmkid is fixed at 36 bytes. + |
+
hw:passthrough + |
+String + |
+Specifies the parameter that describes the disk device type in metadata. The value can be true or false.
+
|
+
full_clone + |
+String + |
+Specifies the clone method. When the disk is created from a snapshot, the parameter value is 0, indicating the linked cloning method. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "volume": {
+ "attachments": [ ],
+ "availability_zone": "az-dc-1",
+ "bootable": "false",
+ "consistencygroup_id": null,
+ "created_at": "2016-05-25T02:38:40.392463",
+ "description": "create for api test",
+ "encrypted": false,
+ "id": "8dd7c486-8e9f-49fe-bceb-26aa7e312b66",
+ "links": [
+ {
+ "href": "https://volume.localdomain.com:8776/v2/5dd0b0056f3d47b6ab4121667d35621a/volumes/8dd7c486-8e9f-49fe-bceb-26aa7e312b66",
+ "rel": "self"
+ },
+ {
+ "href": "https://volume.localdomain.com:8776/5dd0b0056f3d47b6ab4121667d35621a/volumes/8dd7c486-8e9f-49fe-bceb-26aa7e312b66",
+ "rel": "bookmark"
+ }
+ ],
+ "metadata": {
+ "volume_owner": "openapi"
+ },
+ "name": "openapi_vol01",
+ "replication_status": "disabled",
+ "multiattach": false,
+ "size": 40,
+ "snapshot_id": null,
+ "source_volid": null,
+ "status": "creating",
+ "updated_at": null,
+ "user_id": "39f6696ae23740708d0f358a253c2637",
+ "volume_type": "SATA"
+ }
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badRequest or itemNotFound. An example is provided as follows:
+{
+ "badRequest": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to delete an EVS disk.
+Parameter + |
+Mandatory + |
+Description + |
+
|---|---|---|
project_id + |
+Yes + |
+Specifies the project ID. + |
+
volume_id + |
+Yes + |
+Specifies the disk ID. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
cascade + |
+Boolean + |
+No + |
+Specifies to delete all snapshots associated with the disk. The default value is false. + |
+
The following example shows how to delete a disk and all its snapshots.
+DELETE https://{endpoint}/v3/{project_id}/volumes/{volume_id}?cascade=true
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
error + |
+Object + |
+Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badrequest or itemNotFound. An example is provided as follows:
+{
+ "itemNotFound": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to update the EVS disk information.
+Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
volume + |
+Object + |
+Yes + |
+Specifies the information of the disk to be updated. For details, see Parameters in the volume field. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
name + |
+String + |
+No + |
+Specifies the disk name. The value can contain a maximum of 255 bytes. + |
+
description + |
+String + |
+No + |
+Specifies the disk description. The value can contain a maximum of 255 bytes. + |
+
metadata + |
+Object + |
+No + |
+Specifies the disk metadata. +The length of the key or value in the metadata cannot exceed 255 bytes. + |
+
display_name + |
+String + |
+No + |
+Specifies also the disk name. You can specify either parameter name or display_name. If both parameters are specified, the name value is used. The value can contain a maximum of 255 bytes. + |
+
display_description + |
+String + |
+No + |
+Specifies 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. + |
+
{
+ "volume": {
+ "name": "test_volume",
+ "description": "test"
+ }
+}
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
volume + |
+Object + |
+Specifies the information of the updated disk. For details, see Parameters in the volumes field. + |
+
error + |
+Object + |
+Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+Specifies the disk ID. + |
+
links + |
+list<map<String,String>> + |
+Specifies the disk URI. For details, see Parameters in the links field. + |
+
name + |
+String + |
+Specifies the disk name. + |
+
status + |
+String + |
+Specifies the disk status. For details, see EVS Disk Status. + |
+
attachments + |
+list + |
+Specifies the disk attachment information. For details, see Parameters in the attachments field. + |
+
availability_zone + |
+String + |
+Specifies the AZ to which the disk belongs. + |
+
bootable + |
+String + |
+Specifies whether the disk is bootable.
+
|
+
encrypted + |
+Boolean + |
+Currently, this field is not supported by EVS. + |
+
created_at + |
+String + |
+Specifies the time when the disk was created. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
description + |
+String + |
+Specifies the disk description. + |
+
volume_type + |
+String + |
+Specifies the disk type. +Currently, the value can be SSD, SAS, SATA, co-p1, or uh-l1.
+
|
+
replication_status + |
+String + |
+Reserved field + |
+
consistencygroup_id + |
+String + |
+Reserved field + |
+
source_volid + |
+String + |
+Specifies the source disk ID. +Currently, this field is not supported by EVS. + |
+
snapshot_id + |
+String + |
+Specifies the snapshot ID. + |
+
metadata + |
+Object + |
+Specifies the disk metadata. For details, see Parameters in the metadata field. + |
+
size + |
+Integer + |
+Specifies the disk size, in GB. + |
+
user_id + |
+String + |
+Reserved field + |
+
updated_at + |
+String + |
+Specifies the time when the disk was updated. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
shareable + |
+Boolean + |
+Specifies whether the disk is shareable. + NOTE:
+This field is no longer used. Use multiattach. + |
+
multiattach + |
+Boolean + |
+Specifies whether the disk is shareable.
+
|
+
storage_cluster_id + |
+String + |
+Reserved field + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
href + |
+String + |
+Specifies the corresponding shortcut link. + |
+
rel + |
+String + |
+Specifies the shortcut link marker name. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
server_id + |
+String + |
+Specifies the ID of the server to which the disk is attached. + |
+
attachment_id + |
+String + |
+Specifies the ID of the attachment information. + |
+
attached_at + |
+String + |
+Specifies the time when the disk was attached. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
host_name + |
+String + |
+Specifies the name of the physical host accommodating the server to which the disk is attached. + |
+
volume_id + |
+String + |
+Specifies the disk ID. + |
+
device + |
+String + |
+Specifies the device name. + |
+
id + |
+String + |
+Specifies the ID of the attached resource. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
__system__encrypted + |
+String + |
+Specifies the parameter that describes the encryption function in metadata. The value can be 0 or 1.
+
|
+
__system__cmkid + |
+String + |
+Specifies the encryption CMK ID in metadata. This parameter is used together with __system__encrypted for encryption. The length of cmkid is fixed at 36 bytes. + |
+
hw:passthrough + |
+String + |
+Specifies the parameter that describes the disk device type in metadata. The value can be true or false.
+
|
+
full_clone + |
+String + |
+Specifies the clone method. When the disk is created from a snapshot, the parameter value is 0, indicating the linked cloning method. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "volume": {
+ "attachments": [ ],
+ "availability_zone": "az-dc-1",
+ "bootable": "false",
+ "consistencygroup_id": null,
+ "created_at": "2016-05-25T02:38:40.392463",
+ "description": "create for api test",
+ "encrypted": false,
+ "id": "8dd7c486-8e9f-49fe-bceb-26aa7e312b66",
+ "links": [
+ {
+ "href": "https://volume.localdomain.com:8776/v2/5dd0b0056f3d47b6ab4121667d35621a/volumes/8dd7c486-8e9f-49fe-bceb-26aa7e312b66",
+ "rel": "self"
+ },
+ {
+ "href": "https://volume.localdomain.com:8776/5dd0b0056f3d47b6ab4121667d35621a/volumes/8dd7c486-8e9f-49fe-bceb-26aa7e312b66",
+ "rel": "bookmark"
+ }
+ ],
+ "metadata": {
+ "volume_owner": "openapi"
+ },
+ "name": "openapi_vol01",
+ "replication_status": "disabled",
+ "multiattach": false,
+ "size": 40,
+ "snapshot_id": null,
+ "source_volid": null,
+ "status": "creating",
+ "updated_at": null,
+ "user_id": "39f6696ae23740708d0f358a253c2637",
+ "volume_type": "SATA"
+ }
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badRequest or itemNotFound. An example is provided as follows:
+{
+ "badRequest": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to query EVS disks.
+Parameter + |
+Mandatory + |
+Description + |
+
|---|---|---|
project_id + |
+Yes + |
+Specifies the project ID. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
marker + |
+String + |
+No + |
+Specifies the ID of the last record on the previous page. The returned value is the value of the item after this one. + |
+
name + |
+String + |
+No + |
+Specifies the disk name. The value can contain a maximum of 255 bytes. + |
+
limit + |
+Integer + |
+No + |
+Specifies 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 disks 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/volumes?limit=50: Queries the 1–50 disks. GET /v3/xxx/volumes?offset=50&limit=50: Queries the 51–100 disks. + |
+
sort_key + |
+String + |
+No + |
+Specifies the keyword based on which the returned results are sorted. The value can be id, status, size, or created_at, and the default value is created_at. + |
+
sort_dir + |
+String + |
+No + |
+Specifies the result sorting order. The default value is desc.
+
|
+
offset + |
+Integer + |
+No + |
+Specifies the offset. +All disks after this offset will be queried. The value must be an integer greater than 0 but less than the number of disks. + |
+
status + |
+String + |
+No + |
+Specifies the disk status. For details, see EVS Disk Status. + |
+
metadata + |
+String + |
+No + |
+Specifies the disk metadata. + |
+
availability_zone + |
+String + |
+No + |
+Specifies the AZ. + |
+
The following example shows how to query the disks in the available state.
+GET https://{endpoint}/v3/{project_id}/volumes?status=available
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
volumes + |
+list + |
+Specifies the list of queried disks. For details, see Parameters in the volumes field. + |
+
volumes_links + |
+list + |
+Specifies the query position marker in the disk list. If only some disks are returned in this query, the URL of the last disk queried will be returned. You can use this URL to continue to query the remaining disks in the next query. + |
+
count + |
+Object + |
+Specifies 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. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+Specifies the disk ID. + |
+
links + |
+Array of objects + |
+Specifies the disk URI. For details, see Parameters in the links field. + |
+
name + |
+String + |
+Specifies the disk name. The value can contain a maximum of 255 bytes. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
href + |
+String + |
+Specifies the corresponding shortcut link. + |
+
rel + |
+String + |
+Specifies the shortcut link marker name. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+
+ "volumes": [
+ {
+ "id": "6b604cef-9bd8-4f5a-ae56-45839e6e1f0a",
+ "links": [
+ {
+ "href": "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/6b604cef-9bd8-4f5a-ae56-45839e6e1f0a",
+ "rel": "self"
+ },
+ {
+ "href": "https://volume.localdomain.com:8776/dd14c6ac581f40059e27f5320b60bf2f/volumes/6b604cef-9bd8-4f5a-ae56-45839e6e1f0a",
+ "rel": "bookmark"
+ }
+ ],
+ "name": "zjb_u25_test"
+ },
+ {
+ "id": "2bce4552-9a7d-48fa-8484-abbbf64b206e",
+ "links": [
+ {
+ "href": "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/2bce4552-9a7d-48fa-8484-abbbf64b206e",
+ "rel": "self"
+ },
+ {
+ "href": "https://volume.localdomain.com:8776/dd14c6ac581f40059e27f5320b60bf2f/volumes/2bce4552-9a7d-48fa-8484-abbbf64b206e",
+ "rel": "bookmark"
+ }
+ ],
+ "name": "zjb_u25_test"
+ },
+ {
+ "id": "3f1b98ec-a8b5-4e92-a727-88def62d5ad3",
+ "links": [
+ {
+ "href": "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/3f1b98ec-a8b5-4e92-a727-88def62d5ad3",
+ "rel": "self"
+ },
+ {
+ "href": "https://volume.localdomain.com:8776/dd14c6ac581f40059e27f5320b60bf2f/volumes/3f1b98ec-a8b5-4e92-a727-88def62d5ad3",
+ "rel": "bookmark"
+ }
+ ],
+ "name": "zjb_u25_test"
+ }
+ ],
+ "volumes_links": [
+ {
+ "href": "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes?limit=3&marker=3f1b98ec-a8b5-4e92-a727-88def62d5ad3",
+ "rel": "next"
+ }
+ ]
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badRequest or itemNotFound. An example is provided as follows:
+{
+ "badRequest": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to query details about all disks.
+Parameter + |
+Mandatory + |
+Description + |
+
|---|---|---|
project_id + |
+Yes + |
+Specifies the project ID. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
marker + |
+String + |
+No + |
+Specifies the ID of the last record on the previous page. The returned value is the value of the item after this one. + |
+
name + |
+String + |
+No + |
+Specifies the disk name. The value can contain a maximum of 255 bytes. + |
+
limit + |
+Integer + |
+No + |
+Specifies 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 disks 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/volumes/detail?limit=50: Queries the 1–50 disks. GET /v3/xxx/volumes/detail?offset=50&limit=50: Queries the 51–100 disks. + |
+
sort_key + |
+String + |
+No + |
+Specifies the keyword based on which the returned results are sorted. The value can be id, status, size, or created_at, and the default value is created_at. + |
+
sort_dir + |
+String + |
+No + |
+Specifies the result sorting order. The default value is desc.
+
|
+
offset + |
+Integer + |
+No + |
+Specifies the offset. +All disks after this offset will be queried. The value must be an integer greater than 0 but less than the number of disks. + |
+
status + |
+String + |
+No + |
+Specifies the disk status. For details, see EVS Disk Status. + |
+
metadata + |
+String + |
+No + |
+Specifies the disk metadata. + |
+
availability_zone + |
+String + |
+No + |
+Specifies the AZ. + |
+
The following example shows how to query details of the disks in the available state.
+GET https://{endpoint}/v3/{project_id}/volumes/detail?status=available
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
volumes + |
+list + |
+Specifies the list of queried disks. For details, see Parameters in the volumes field. + |
+
volumes_links + |
+list + |
+Specifies the query position marker in the disk list. If only some disks are returned in this query, the URL of the last disk queried will be returned. You can use this URL to continue to query the remaining disks in the next query. For details, see Parameters in the links field. + |
+
error + |
+Object + |
+Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+Specifies the disk ID. + |
+
links + |
+Array of objects + |
+Specifies the disk URI. For details, see Parameters in the links field. + |
+
name + |
+String + |
+Specifies the disk name. + |
+
status + |
+String + |
+Specifies the disk status. For details, see EVS Disk Status. + |
+
attachments + |
+list + |
+Specifies the disk attachment information. For details, see Parameters in the attachments field. + |
+
availability_zone + |
+String + |
+Specifies the AZ to which the disk belongs. + |
+
os-vol-host-attr:host + |
+String + |
+Reserved field + |
+
source_volid + |
+String + |
+Specifies the source disk ID. This parameter has a value if the disk is created from a source disk. +Currently, this field is not supported by EVS. + |
+
snapshot_id + |
+String + |
+Specifies the snapshot ID. This parameter has a value if the disk is created from a snapshot. + |
+
description + |
+String + |
+Specifies the disk description. + |
+
created_at + |
+String + |
+Specifies the time when the disk was created. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
volume_type + |
+String + |
+Specifies the disk type. +Currently, the value can be SSD, SAS, SATA, co-p1, or uh-l1.
+
|
+
os-vol-tenant-attr:tenant_id + |
+String + |
+Specifies the ID of the tenant to which the disk belongs. The tenant ID is actually the project ID. + |
+
size + |
+Integer + |
+Specifies the disk size, in GB. + |
+
metadata + |
+Object + |
+Specifies the disk metadata. For details, see Parameters in the metadata field. +If metadata does not contain the hw:passthrough field, the disk device type is VBD. +If metadata does not contain the __system__encrypted field, the disk is not encrypted. + |
+
os-vol-mig-status-attr:migstat + |
+String + |
+Reserved field + |
+
os-vol-mig-status-attr:name_id + |
+String + |
+Reserved field + |
+
os-volume-replication:extended_status + |
+String + |
+Reserved field + |
+
encrypted + |
+Boolean + |
+Currently, this field is not supported by EVS. + |
+
replication_status + |
+String + |
+Reserved field + |
+
user_id + |
+String + |
+Reserved field + |
+
consistencygroup_id + |
+String + |
+Reserved field + |
+
bootable + |
+String + |
+Specifies whether the disk is bootable.
+
|
+
updated_at + |
+String + |
+Specifies the time when the disk was updated. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
shareable + |
+Boolean + |
+Specifies whether the disk is shareable. + NOTE:
+This field is no longer used. Use multiattach. + |
+
multiattach + |
+Boolean + |
+Specifies whether the disk is shareable.
+
|
+
volume_image_metadata + |
+Object + |
+Specifies the metadata of the disk image. This field has a value if the disk is created from an image. Otherwise, it is left empty. + NOTE:
+For details about volume_image_metadata, see Querying Image Details (Native OpenStack API) in the Image Management Service API Reference. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
href + |
+String + |
+Specifies the corresponding shortcut link. + |
+
rel + |
+String + |
+Specifies the shortcut link marker name. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
server_id + |
+String + |
+Specifies the ID of the server to which the disk is attached. + |
+
attachment_id + |
+String + |
+Specifies the ID of the attachment information. + |
+
attached_at + |
+String + |
+Specifies the time when the disk was attached. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
host_name + |
+String + |
+Specifies the name of the physical host accommodating the server to which the disk is attached. + |
+
volume_id + |
+String + |
+Specifies the disk ID. + |
+
device + |
+String + |
+Specifies the device name. + |
+
id + |
+String + |
+Specifies the ID of the attached resource. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
__system__encrypted + |
+String + |
+Specifies the parameter that describes the encryption function in metadata. The value can be 0 or 1.
+
|
+
__system__cmkid + |
+String + |
+Specifies the encryption CMK ID in metadata. This parameter is used together with __system__encrypted for encryption. The length of cmkid is fixed at 36 bytes. + |
+
hw:passthrough + |
+String + |
+Specifies the parameter that describes the disk device type in metadata. The value can be true or false.
+
|
+
full_clone + |
+String + |
+Specifies the clone method. When the disk is created from a snapshot, the parameter value is 0, indicating the linked cloning method. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+
+ "volumes": [
+ {
+ "attachments": [ ],
+ "availability_zone": "az-dc-1",
+ "bootable": "false",
+ "consistencygroup_id": null,
+ "created_at": "2016-05-25T02:42:10.856332",
+ "description": null,
+ "encrypted": false,
+ "id": "b104b8db-170d-441b-897a-3c8ba9c5a214",
+ "links": [
+ {
+ "href": "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/b104b8db-170d-441b-897a-3c8ba9c5a214",
+ "rel": "self"
+ },
+ {
+ "href": "https://volume.localdomain.com:8776/dd14c6ac581f40059e27f5320b60bf2f/volumes/b104b8db-170d-441b-897a-3c8ba9c5a214",
+ "rel": "bookmark"
+ }
+ ],
+ "metadata": {},
+ "name": "zjb_u25_test",
+ "os-vol-host-attr:host": "pod01.xxx#SATA",
+ "volume_image_metadata": { },
+ "os-vol-mig-status-attr:migstat": null,
+ "os-vol-mig-status-attr:name_id": null,
+ "os-vol-tenant-attr:tenant_id": "dd14c6ac581f40059e27f5320b60bf2f",
+ "os-volume-replication:driver_data": null,
+ "replication_status": "disabled",
+ "multiattach": false,
+ "size": 1,
+ "snapshot_id": null,
+ "source_volid": null,
+ "status": "available",
+ "updated_at": "2016-05-25T02:42:22.341984",
+ "user_id": "b0524e8342084ef5b74f158f78fc3049",
+ "volume_type": "SATA"
+ }
+ ],
+ "volumes_links": [
+ {
+ "href": "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/detail?limit=1&marker=b104b8db-170d-441b-897a-3c8ba9c5a214",
+ "rel": "next"
+ }
+ ]
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badrequest or itemNotFound. An example is provided as follows:
+{
+ "itemNotFound": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to query details about a disk.
+GET https://{endpoint}/v3/{project_id}/volumes/b104b8db-170d-441b-897a-3c8ba9c5a214
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
volume + |
+Object + |
+Specifies the queried disk. For details, see Parameters in the volume field. + |
+
error + |
+Object + |
+Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+Specifies the disk ID. + |
+
links + |
+list<map<String, String>> + |
+Specifies the disk URI. For details, see Parameters in the links field. + |
+
name + |
+String + |
+Specifies the disk name. + |
+
status + |
+String + |
+Specifies the disk status. For details, see EVS Disk Status. + |
+
attachments + |
+list<map<String, String>> + |
+Specifies the disk attachment information. For details, see Parameters in the attachments field. + |
+
availability_zone + |
+String + |
+Specifies the AZ to which the disk belongs. + |
+
source_volid + |
+String + |
+Specifies the source disk ID. This parameter has a value if the disk is created from a source disk. +Currently, this field is not supported by EVS. + |
+
snapshot_id + |
+String + |
+Specifies the snapshot ID. This parameter has a value if the disk is created from a snapshot. + |
+
description + |
+String + |
+Specifies the disk description. + |
+
os-vol-tenant-attr:tenant_id + |
+String + |
+Specifies the ID of the tenant to which the disk belongs. The tenant ID is actually the project ID. + |
+
volume_image_metadata + |
+Object + |
+Specifies the metadata of the disk image. + NOTE:
+For details about volume_image_metadata, see Querying Image Details (Native OpenStack API) in the Image Management Service API Reference. + |
+
created_at + |
+String + |
+Specifies the time when the disk was created. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
volume_type + |
+String + |
+Specifies the disk type. +Currently, the value can be SSD, SAS, SATA, co-p1, or uh-l1.
+
|
+
size + |
+Integer + |
+Specifies the disk size, in GB. + |
+
bootable + |
+String + |
+Specifies whether the disk is bootable.
+
|
+
metadata + |
+Object + |
+Specifies the disk metadata. For details, see Parameters in the metadata field. +If metadata does not contain the hw:passthrough field, the disk device type is VBD. +If metadata does not contain the __system__encrypted field, the disk is not encrypted. + |
+
os-vol-host-attr:host + |
+String + |
+Reserved field + |
+
encrypted + |
+Boolean + |
+Currently, this field is not supported by EVS. + |
+
updated_at + |
+String + |
+Specifies the time when the disk was updated. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
os-volume-replication:extended_status + |
+String + |
+Reserved field + |
+
replication_status + |
+String + |
+Reserved field + |
+
os-vol-mig-status-attr:migstat + |
+String + |
+Reserved field + |
+
consistencygroup_id + |
+String + |
+Reserved field + |
+
os-vol-mig-status-attr:name_id + |
+String + |
+Reserved field + |
+
shareable + |
+Boolean + |
+Specifies whether the disk is shareable. + NOTE:
+This field is no longer used. Use multiattach. + |
+
user_id + |
+String + |
+Reserved field + |
+
multiattach + |
+Boolean + |
+Specifies whether the disk is shareable.
+
|
+
storage_cluster_id + |
+String + |
+Reserved field + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
href + |
+String + |
+Specifies the corresponding shortcut link. + |
+
rel + |
+String + |
+Specifies the shortcut link marker name. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
server_id + |
+String + |
+Specifies the ID of the server to which the disk is attached. + |
+
attachment_id + |
+String + |
+Specifies the ID of the attachment information. + |
+
attached_at + |
+String + |
+Specifies the time when the disk was attached. + |
+
host_name + |
+String + |
+Specifies the name of the physical host accommodating the server to which the disk is attached. + |
+
volume_id + |
+String + |
+Specifies the disk ID. + |
+
device + |
+String + |
+Specifies the device name. + |
+
id + |
+String + |
+Specifies the ID of the attached resource. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
__system__encrypted + |
+String + |
+Specifies the parameter that describes the encryption function in metadata. The value can be 0 or 1.
+
|
+
__system__cmkid + |
+String + |
+Specifies the encryption CMK ID in metadata. This parameter is used together with __system__encrypted for encryption. The length of cmkid is fixed at 36 bytes. + |
+
hw:passthrough + |
+String + |
+Specifies the parameter that describes the disk device type in metadata. The value can be true or false.
+
|
+
full_clone + |
+String + |
+Specifies the clone method. When the disk is created from a snapshot, the parameter value is 0, indicating the linked cloning method. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "volume": {
+ "attachments": [ ],
+ "links": [
+ {
+ "href": "https://volume.az0.dc1.domainname.com/v2/40acc331ac784f34842ba4f08ff2be48/volumes/591ac654-26d8-41be-bb77-4f90699d2d41",
+ "rel": "self"
+ },
+ {
+ "href": "https://volume.az0.dc1.domainname.com/40acc331ac784f34842ba4f08ff2be48/volumes/591ac654-26d8-41be-bb77-4f90699d2d41",
+ "rel": "bookmark"
+ }
+ ],
+ "availability_zone": "az-dc-1",
+ "os-vol-host-attr:host": "az-dc-1#SSD",
+ "encrypted": false,
+ "multiattach": true,
+ "updated_at": "2016-02-03T02:19:29.895237",
+ "os-volume-replication:extended_status": null,
+ "replication_status": "disabled",
+ "snapshot_id": null,
+ "id": "591ac654-26d8-41be-bb77-4f90699d2d41",
+ "size": 40,
+ "user_id": "fd03ee73295e45478d88e15263d2ee4e",
+ "os-vol-tenant-attr:tenant_id": "40acc331ac784f34842ba4f08ff2be48",
+ "volume_image_metadata": null,
+ "os-vol-mig-status-attr:migstat": null,
+ "metadata": {},
+ "status": "error_restoring",
+ "description": "auto-created_from_restore_from_backup",
+ "source_volid": null,
+ "consistencygroup_id": null,
+ "os-vol-mig-status-attr:name_id": null,
+ "name": "restore_backup_0115efb3-678c-4a9e-bff6-d3cd278238b9",
+ "bootable": "false",
+ "created_at": "2016-02-03T02:19:11.723797",
+ "volume_type": null
+ }
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badrequest or itemNotFound. An example is provided as follows:
+{
+ "badrequest": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to query EVS disk types and display the query results in a list.
+GET https://{endpoint}/v3/{project_id}/types
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
volume_types + |
+list + |
+Specifies the list of queried disk types. For details, see Parameters in the volume_types field. + |
+
error + |
+Object + |
+Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
extra_specs + |
+Object + |
+Specifies the disk type specifications. For details, see Parameters in the extra_specs field. + |
+
name + |
+String + |
+Specifies the name of the disk type. + |
+
id + |
+String + |
+Specifies the ID of the disk type. + |
+
description + |
+String + |
+Specifies the description of the disk type. + |
+
qos_specs_id + |
+String + |
+Reserved field + |
+
is_public + |
+Boolean + |
+Reserved field + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
volume_backend_name + |
+String + |
+Reserved field + |
+
availability-zone + |
+String + |
+Reserved field + |
+
HW:availability_zone + |
+String + |
+Reserved field + |
+
RESKEY:availability_zones + |
+String + |
+Specifies the AZs that support the current disk type. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "volume_types": [
+ {
+ "extra_specs": {
+ "volume_backend_name": "SAS",
+ "availability-zone": "az-dc-1"
+ },
+ "name": "SAS",
+ "qos_specs_id": null,
+ "id": "6c81c680-df58-4512-81e7-ecf66d160638",
+ "is_public": true,
+ "description": null
+ },
+ {
+ "extra_specs": {
+ "volume_backend_name": "SATA",
+ "availability-zone": "az-dc-1"
+ },
+ "name": "SATA",
+ "qos_specs_id": "585f29d6-7147-42e7-bfb8-ca214f640f6f",
+ "is_public": true,
+ "id": "ea6e3c13-aac5-46e0-b280-745ed272e662",
+ "description": null
+ },
+ {
+ "extra_specs": {
+ "volume_backend_name": "SSD",
+ "availability-zone": "az-dc-1"
+ },
+ "name": "SSD",
+ "qos_specs_id": "39b0c29a-308b-4f86-b478-5d3d02a43837",
+ "is_public": true,
+ "id": "6f2dee9e-82f0-4be3-ad89-bae605a3d24f",
+ "description": null
+ }
+ ]
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badrequest or itemNotFound. An example is provided as follows:
+{
+ "badrequest": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to query details about an EVS disk type.
+GET https://{endpoint}/v3/{project_id}/types/6c81c680-df58-4512-81e7-ecf66d160638
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
volume_type + |
+Object + |
+Specifies 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. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
extra_specs + |
+Object + |
+Specifies the disk type specifications. For details, see Parameters in the extra_specs field. + |
+
name + |
+String + |
+Specifies the name of the disk type. + |
+
id + |
+String + |
+Specifies the ID of the disk type. + |
+
description + |
+String + |
+Specifies the description of the disk type. + |
+
qos_specs_id + |
+String + |
+Reserved field + |
+
is_public + |
+Boolean + |
+Reserved field + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
volume_backend_name + |
+String + |
+Reserved field + |
+
availability-zone + |
+String + |
+Reserved field + |
+
HW:availability_zone + |
+String + |
+Reserved field + |
+
RESKEY:availability_zones + |
+String + |
+Specifies the AZs that support the current disk type. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "volume_type": {
+ "extra_specs": {
+ "volume_backend_name": "SATA",
+ "availability-zone": "az-dc-1"
+ },
+ "name": "SATA",
+ "qos_specs_id": null,
+ "is_public": true,
+ "id": "ea6e3c13-aac5-46e0-b280-745ed272e662",
+ "description": null
+ }
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badrequest or itemNotFound. An example is provided as follows:
+{
+ "badrequest": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to query the details of tenant quotas.
+GET /v3/{project_id}/os-quota-sets/{target_project_id}?usage=True
+Parameter + |
+Mandatory + |
+Description + |
+
|---|---|---|
project_id + |
+Yes + |
+Specifies the project ID. + |
+
target_project_id + |
+Yes + |
+Specifies the ID of the target project. Set this parameter to the value of project_id. + |
+
usage + |
+Yes + |
+Specifies whether to query the quota details. Only value true is supported currently. + |
+
GET https://{endpoint}/v3/{project_id}/os-quota-sets/{project_id}?usage=True
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
quota_set + |
+Object + |
+Specifies the queried quota information. For details, see Parameters in the quota_set field. + |
+
error + |
+Object + |
+Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
volumes + |
+Object + |
+Specifies the number of disks. Sub-parameters include reserved (reserved quota), limit (maximum quota), and in_use (used quota), and are made up of key-value pairs. + |
+
snapshots + |
+Object + |
+Specifies the number of snapshots. Sub-parameters include reserved (reserved quota), limit (maximum quota), and in_use (used quota), and are made up of key-value pairs. + |
+
gigabytes + |
+Object + |
+Specifies the total size (GB) of disks and snapshots allowed. Sub-parameters include reserved (reserved quota), limit (maximum quota), and in_use (used quota), and are made up of key-value pairs. + |
+
volumes_SSD + |
+Object + |
+Specifies the number of reserved ultra-high I/O disks. Sub-parameters include reserved (reserved quota), limit (maximum quota), and in_use (used quota), and are made up of key-value pairs. + |
+
volumes_SAS + |
+Object + |
+Specifies the number of reserved high I/O disks. Sub-parameters include reserved (reserved quota), limit (maximum quota), and in_use (used quota), and are made up of key-value pairs. + |
+
volumes_SATA + |
+Object + |
+Specifies the number of reserved common I/O disks. Sub-parameters include reserved (reserved quota), limit (maximum quota), and in_use (used quota), and are made up of key-value pairs. + |
+
snapshots_SSD + |
+Object + |
+Specifies the number of snapshots reserved for ultra-high I/O disks. Sub-parameters include reserved (reserved quota), limit (maximum quota), and in_use (used quota), and are made up of key-value pairs. + |
+
snapshots_SAS + |
+Object + |
+Specifies the number of snapshots reserved for high I/O disks. Sub-parameters include reserved (reserved quota), limit (maximum quota), and in_use (used quota), and are made up of key-value pairs. + |
+
snapshots_SATA + |
+Object + |
+Specifies the number of snapshots reserved for common I/O disks. Sub-parameters include reserved (reserved quota), limit (maximum quota), and in_use (used quota), and are made up of key-value pairs. + |
+
gigabytes_SSD + |
+Object + |
+Specifies the size (GB) reserved for ultra-high I/O disks. Sub-parameters include reserved (reserved quota), limit (maximum quota), and in_use (used quota), and are made up of key-value pairs. + |
+
gigabytes_SAS + |
+Object + |
+Specifies the size (GB) reserved for high I/O disks. Sub-parameters include reserved (reserved quota), limit (maximum quota), and in_use (used quota), and are made up of key-value pairs. + |
+
gigabytes_SATA + |
+Object + |
+Specifies the size (GB) reserved for common I/O disks. Sub-parameters include reserved (reserved quota), limit (maximum quota), and in_use (used quota), and are made up of key-value pairs. + |
+
id + |
+String + |
+Specifies the tenant ID. The tenant ID is actually the project ID. + |
+
backups + |
+Object + |
+Specifies the number of backups. Sub-parameters include reserved (reserved quota), limit (maximum quota), and in_use (used quota), and are made up of key-value pairs. + |
+
backup_gigabytes + |
+Object + |
+Specifies the backup size (GB). Sub-parameters include reserved (reserved quota), limit (maximum quota), and in_use (used quota), and are made up of key-value pairs. + |
+
per_volume_gigabytes + |
+Object + |
+Specifies the capacity quota of each EVS disk. Sub-parameters include reserved (reserved quota), limit (maximum quota), and in_use (used quota), and are made up of key-value pairs. + |
+
If the limit value returned in the response is -1, no quota limit has been set.
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "quota_set": {
+ "gigabytes_SAS": {
+ "reserved": 0,
+ "limit": -1,
+ "in_use": 21
+ },
+ "volumes_SATA": {
+ "reserved": 0,
+ "limit": -1,
+ "in_use": 8
+ },
+ "gigabytes": {
+ "reserved": 0,
+ "limit": 42790,
+ "in_use": 2792
+ },
+ "backup_gigabytes": {
+ "reserved": 0,
+ "limit": 5120,
+ "in_use": 51
+ },
+ "snapshots_SAS": {
+ "reserved": 0,
+ "limit": -1,
+ "in_use": 0
+ },
+ "volumes_SSD": {
+ "reserved": 0,
+ "limit": -1,
+ "in_use": 28
+ },
+ "snapshots": {
+ "reserved": 0,
+ "limit": 10,
+ "in_use": 6
+ },
+ "id": "cd631140887d4b6e9c786b67a6dd4c02",
+ "volumes_SAS": {
+ "reserved": 0,
+ "limit": -1,
+ "in_use": 2
+ },
+ "snapshots_SSD": {
+ "reserved": 0,
+ "limit": -1,
+ "in_use": 0
+ },
+ "volumes": {
+ "reserved": 0,
+ "limit": -1,
+ "in_use": 108
+ },
+ "gigabytes_SATA": {
+ "reserved": 0,
+ "limit": -1,
+ "in_use": 168
+ },
+ "backups": {
+ "reserved": 0,
+ "limit": 100,
+ "in_use": 10
+ },
+ "gigabytes_SSD": {
+ "reserved": 0,
+ "limit": -1,
+ "in_use": 1085
+ },
+ "snapshots_SATA": {
+ "reserved": 0,
+ "limit": -1,
+ "in_use": 0
+ }
+ }
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badrequest or itemNotFound. An example is provided as follows:
+{
+ "badrequest": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to add or update the metadata of an EVS disk.
+Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
metadata + |
+Object + |
+Yes + |
+Specifies the metadata to be updated. For details, see Parameter in the metadata field. +The length of the key or value in the metadata cannot exceed 255 bytes. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
key_val + |
+String + |
+No + |
+Specifies the metadata information, which is made up of one or multiple key-value pairs. + |
+
{
+ "metadata": {
+ "key1": "value1",
+ "key2": "value2"
+ }
+}
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
metadata + |
+Object + |
+Specifies 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. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "metadata": {
+ "key1": "value1",
+ "key2": "value2"
+ }
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badrequest or itemNotFound. An example is provided as follows:
+{
+ "badrequest": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to query the metadata of an EVS disk.
+GET https://{endpoint}/v3/{project_id}/volumes/{volume_id}/metadata
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
metadata + |
+Object + |
+Specifies 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. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "metadata": {
+ "key1": "value1",
+ "key2": "value2"
+ }
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badrequest or itemNotFound. An example is provided as follows:
+{
+ "badrequest": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to update the metadata of an EVS disk.
+Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
metadata + |
+Object + |
+Yes + |
+Specifies the disk metadata to be updated. For details, see Parameter in the metadata field. +The length of the key or value in the metadata cannot exceed 255 bytes. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
key_val + |
+String + |
+No + |
+Specifies the metadata information, which is made up of one or multiple key-value pairs. + |
+
{
+ "metadata": {
+ "key1": "value1",
+ "key2": "value2"
+ }
+}
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
metadata + |
+Object + |
+Specifies 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. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "metadata": {
+ "key1": "value1",
+ "key2": "value2"
+ }
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badrequest or itemNotFound. An example is provided as follows:
+{
+ "badrequest": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to query one piece of the EVS disk metadata.
+Parameter + |
+Mandatory + |
+Description + |
+
|---|---|---|
project_id + |
+Yes + |
+Specifies the project ID. + |
+
volume_id + |
+Yes + |
+Specifies the disk ID. + |
+
key + |
+Yes + |
+Specifies the key of the piece of metadata to be queried. + |
+
GET https://{endpoint}/v3/{project_id}/volumes/b104b8db-170d-441b-897a-3c8ba9c5a214/metadata/value1
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
meta + |
+Object + |
+Specifies a 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. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "meta": {
+ "key1": "value1"
+ }
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badrequest or itemNotFound. An example is provided as follows:
+{
+ "itemNotFound": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to update one piece of the EVS disk metadata.
+Parameter + |
+Mandatory + |
+Description + |
+
|---|---|---|
project_id + |
+Yes + |
+Specifies the project ID. + |
+
volume_id + |
+Yes + |
+Specifies the disk ID. + |
+
key + |
+Yes + |
+Specifies the key of the piece of metadata to be updated. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
meta + |
+Object + |
+Yes + |
+Specifies the disk metadata to be updated. For details, see Parameter in the meta field. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
key_val + |
+String + |
+No + |
+Specifies a piece of metadata, which is made up of a key-value pair. + |
+
{
+ "meta": {
+ "key1": "value1"
+ }
+}
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
meta + |
+Object + |
+Specifies a 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. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "meta": {
+ "key1": "value1"
+ }
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badRequest or itemNotFound. An example is provided as follows:
+{
+ "badRequest": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to delete one piece of the EVS disk metadata.
+Parameter + |
+Mandatory + |
+Description + |
+
|---|---|---|
project_id + |
+Yes + |
+Specifies the project ID. + |
+
volume_id + |
+Yes + |
+Specifies the disk ID. + |
+
key + |
+Yes + |
+Specifies the key of the piece of metadata to be deleted. + |
+
DELETE https://{endpoint}/v3/{project_id}/volumes/b104b8db-170d-441b-897a-3c8ba9c5a214/metadata/value1
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
error + |
+Object + |
+Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badrequest or itemNotFound. An example is provided as follows:
+{
+ "itemNotFound": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to query extension APIs.
+GET https://{endpoint}/v3/{project_id}/extensions
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
extensions + |
+list + |
+Specifies 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. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
updated + |
+String + |
+Specifies the last update time. +Time format: UTC YYYY-MM-DDTHH:MM:SS.+XX.XX + |
+
description + |
+String + |
+Specifies the description. + |
+
links + |
+list<map<String,String>> + |
+Reserved field + |
+
alias + |
+String + |
+Specifies the extension parameter alias. + |
+
name + |
+String + |
+Specifies the extension parameter name. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "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."
+ }
+ ]
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badRequest or itemNotFound. An example is provided as follows:
+{
+ "badRequest": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to query all AZs.
+GET https://{endpoint}/v3/{project_id}/os-availability-zone
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
availabilityZoneInfo + |
+list + |
+Specifies the list of queried AZs. For details, see Parameters in the availabilityZoneInfo field. + |
+
error + |
+Object + |
+Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
zoneState + |
+Object + |
+Specifies the status of the AZ. For details, see Parameter in the zoneState field. + |
+
zoneName + |
+String + |
+Specifies the AZ name. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
available + |
+Boolean + |
+Specifies whether the AZ is available.
+
|
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "availabilityZoneInfo": [
+ {
+ "zoneState": {
+ "available": true
+ },
+ "zoneName": "az-dc-1"
+ }
+ ]
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to expand the capacity of an EVS disk.
+Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
os-extend + |
+Object + |
+Yes + |
+Specifies the disk expansion marker. For details, see Parameter in the os-extend field. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
new_size + |
+Integer + |
+Yes + |
+Specifies the size of the disk after capacity expansion, in GB. +The new disk size ranges from the original disk size to the maximum size (32768 for a data disk and 1024 for a system disk). + |
+
{
+ "os-extend": {
+ "new_size": 100
+ }
+}
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
error + |
+Object + |
+Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
For details, see Error Codes.
+This API is used to set the bootable flag for an EVS disk.
+A data disk cannot be used as system disk for an ECS even if this API has been called to set the bootable flag for it.
+Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
os-set_bootable + |
+Object + |
+Yes + |
+Specifies the disk bootable marker. For details, see Parameter in the os-set_bootable field. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
bootable + |
+Boolean + |
+Yes + |
+Specifies whether to set the bootable flag for the disk. +
|
+
{
+ "os-set_bootable": {
+ "bootable": true
+ }
+}
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
error + |
+Object + |
+Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
For details, see Error Codes.
+This API is used to set the read-only flag for the EVS disk.
+Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
os-update_readonly_flag + |
+Object + |
+Yes + |
+Specifies the disk read-only flag. For details, see Parameter in the os-update_readonly_flag field. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
readonly + |
+Boolean + |
+Yes + |
+Specifies the read-only flag.
+
|
+
{
+ "os-update_readonly_flag": {
+ "readonly": true
+ }
+}
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
error + |
+Object + |
+Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
For details, see Error Codes.
+This API is used to export the system disk data or data disk data as an IMS image. The exported image will be displayed in the IMS private image list and can be viewed and used.
+Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
os-volume_upload_image + |
+Object + |
+Yes + |
+Specifies the operation to export the disk data as an image. For details, see Parameters in the os-volume_upload_image field. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
disk_format + |
+String + |
+No + |
+Specifies the format of the exported image. +The value can be vhd, zvhd, zvhd2, raw, or qcow2. The default value is zvhd2. + |
+
image_name + |
+String + |
+Yes + |
+Specifies the name of the exported image.
+
|
+
force + |
+Boolean + |
+No + |
+Specifies whether to forcibly export the image. The default value is false. +
|
+
container_format + |
+String + |
+No + |
+Specifies the container type of the exported image. +The value can be ami, ari, aki, ovf, or bare. The default value is bare. + |
+
__os_type + |
+String + |
+No + |
+Specifies the OS type of the exported image. Currently, only windows and linux are supported. The default value is linux. + NOTE:
+
|
+
{
+ "os-volume_upload_image": {
+ "image_name": "sxmatch2",
+ "force": true,
+ "container_format": "bare",
+ "disk_format": "vhd",
+ "__os_type": "linux"
+ }
+}
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
os-volume_upload_image + |
+Object + |
+Specifies the operation to export the disk data as an image. For details, see Parameters in the os-volume_upload_image field. + |
+
error + |
+Object + |
+Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
status + |
+String + |
+Specifies the disk status after the image is exported. The correct value is uploading. + |
+
image_id + |
+String + |
+Specifies the ID of the exported image. + |
+
image_name + |
+String + |
+Specifies the name of the exported image. + |
+
volume_type + |
+Object + |
+Specifies the disk type information. For details, see Parameters in the volume_type field. + |
+
container_format + |
+String + |
+Specifies the container type of the exported image. +The value can be ami, ari, aki, ovf, or bare. The default value is bare. + |
+
size + |
+Integer + |
+Specifies the disk size, in GB. + |
+
disk_format + |
+String + |
+Specifies the format of the exported image. +The value can be vhd, zvhd, zvhd2, raw, or qcow2. The default value is vhd. + |
+
id + |
+String + |
+Specifies the disk ID. + |
+
display_description + |
+String + |
+Specifies the disk description. + |
+
updated_at + |
+String + |
+Specifies the time when the disk was updated. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+Specifies the ID of the disk type. + |
+
name + |
+String + |
+Specifies the name of the disk type. + |
+
deleted + |
+Boolean + |
+Specifies whether to delete the disk type. + |
+
is_public + |
+Boolean + |
+Reserved field + |
+
extra_spec + |
+Object + |
+Specifies the disk type specifications. For details, see Parameters in the extra_specs field. + |
+
description + |
+Integer + |
+Specifies the description of the disk type. + |
+
created_at + |
+String + |
+Specifies the time when the disk type was created. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
updated_at + |
+String + |
+Specifies the time when the disk type was updated. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
deleted_at + |
+String + |
+Specifies the time when the disk type was deleted. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
volume_backend_name + |
+String + |
+Reserved field + |
+
availability-zone + |
+String + |
+Reserved field + |
+
HW:availability_zone + |
+String + |
+Reserved field + |
+
RESKEY:availability_zones + |
+String + |
+Specifies the AZs that support the current disk type. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "os-volume_upload_image": {
+ "status": "uploading",
+ "size": 40,
+ "id": "16369c5d-384d-4e64-b37a-56d898769362",
+ "image_id": "c5333daa-fbc8-4d1d-bf79-b0567bb45d15",
+ "image_name": "evs-ims-test1027",
+ "volume_type": {
+ "description": "None",
+ "deleted": false,
+ "created_at": "2015-05-24T14:47:22.132268",
+ "updated_at": "2017-07-29T11:29:33.730076",
+ "extra_specs": {
+ "volume_backend_name": "<or> iaas blockstorage_SATA <or> iaas blockstorage_SAS <or> iaas blockstoragesata",
+ "XX:availability_zone": "az-dc-1"
+ },
+ "is_public": true,
+ "deleted_at": null,
+ "id": "8247b6ed-37f0-4c48-8ef1-f0027fb332bc",
+ "name": "SATA"
+ },
+ "container_format": "bare",
+ "disk_format": "vhd",
+ "display_description": "",
+ "updated_at": "2018-01-11T01:50:25.800931"
+ }
+}
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+{
+ "itemNotFound": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to reserve an EVS disk.
+
This API call exists for compatibility reasons only and is not meant to be used.
+Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
os-reserve + |
+Object + |
+Yes + |
+Specifies disk reservation marker. Defining a value for this parameter is not mandatory, and you are advised to leave it blank. + |
+
POST https://{endpoint}/v2/{project_id}/volumes/b104b8db-170d-441b-897a-3c8ba9c5a214/action
+{
+ "os-reserve": {}
+}
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
error + |
+Object + |
+Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
For details, see Error Codes.
+This API is used to cancel the reservation of an EVS disk.
+
This API call exists for compatibility reasons only and is not meant to be used.
+Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
os-unreserve + |
+Object + |
+Yes + |
+Specifies disk reservation canceling marker. Defining a value for this parameter is not mandatory, and you are advised to leave it blank. + |
+
POST https://{endpoint}/v2/{project_id}/volumes/b104b8db-170d-441b-897a-3c8ba9c5a214/action
+{
+ "os-unreserve": {}
+}
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
error + |
+Object + |
+Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
For details, see Error Codes.
+This API is used to create an EVS snapshot.
+Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
snapshot + |
+Object + |
+Yes + |
+Specifies the information of the snapshot to be created. For details, see Parameters in the snapshot field. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
volume_id + |
+String + |
+Yes + |
+Specifies the ID of the snapshot's source disk. + |
+
force + |
+Boolean + |
+No + |
+Specifies the flag for forcibly creating a snapshot. The default value is false. +
|
+
metadata + |
+Object + |
+No + |
+Specifies the snapshot metadata. + |
+
description + |
+String + |
+No + |
+Specifies the snapshot description. The value can be null. The value can contain a maximum of 255 bytes. + |
+
name + |
+String + |
+No + |
+Specifies 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. + |
+
{
+ "snapshot": {
+ "name": "snap-001",
+ "description": "Daily backup",
+ "volume_id": "5aa119a8-d25b-45a7-8d1b-88e127885635",
+ "force": false,
+ "metadata": { }
+ }
+}
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
snapshot + |
+Object + |
+Specifies 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. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+Specifies the snapshot ID. + |
+
status + |
+String + |
+Specifies the snapshot status. For details, see EVS Snapshot Status. + |
+
name + |
+String + |
+Specifies the snapshot name. + |
+
description + |
+String + |
+Specifies the snapshot description. + |
+
created_at + |
+String + |
+Specifies the time when the snapshot was created. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
metadata + |
+Object + |
+Specifies the snapshot metadata. + |
+
volume_id + |
+String + |
+Specifies the ID of the snapshot's source disk. + |
+
size + |
+Integer + |
+Specifies the snapshot size, in GB. + |
+
updated_at + |
+String + |
+Specifies the time when the snapshot was updated. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "snapshot": {
+ "status": "creating",
+ "description": "Daily backup",
+ "created_at": "2013-02-25T03:56:53.081642",
+ "metadata": { },
+ "volume_id": "5aa119a8-d25b-45a7-8d1b-88e127885635",
+ "size": 1,
+ "id": "ffa9bc5e-1172-4021-acaf-cdcd78a9584d",
+ "name": "snap-001",
+ "updated_at": "2013-02-25T03:56:53.081642"
+ }
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badRequest or itemNotFound. An example is provided as follows:
+{
+ "itemNotFound": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to delete an EVS snapshot.
+DELETE https://{endpoint}/v3/{project_id}/snapshots/f9faf7df-fdc1-4093-9ef3-5cba06eef995
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
error + |
+Object + |
+Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badRequest or itemNotFound. An example is provided as follows:
+{
+ "itemNotFound": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to update an EVS snapshot.
+Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
snapshot + |
+Object + |
+Yes + |
+Specifies the information of the snapshot to be updated. For details, see Parameters in the snapshot field. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
name + |
+String + |
+No + |
+Specifies 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. + |
+
description + |
+String + |
+No + |
+Specifies the snapshot description. The value can contain a maximum of 255 bytes. + |
+
{
+ "snapshot": {
+ "name": "snap-001",
+ "description": "Daily backup"
+ }
+}
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
snapshot + |
+Object + |
+Specifies 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. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+Specifies the snapshot ID. + |
+
status + |
+String + |
+Specifies the snapshot status. For details, see EVS Snapshot Status. + |
+
name + |
+String + |
+Specifies the snapshot name. + |
+
description + |
+String + |
+Specifies the snapshot description. + |
+
created_at + |
+String + |
+Specifies the time when the snapshot was created. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
metadata + |
+Object + |
+Specifies the snapshot metadata. + |
+
volume_id + |
+String + |
+Specifies the ID of the snapshot's source disk. + |
+
size + |
+Integer + |
+Specifies the snapshot size, in GB. + |
+
updated_at + |
+String + |
+Specifies the time when the snapshot was updated. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
os-extended-snapshot-attributes:progress + |
+String + |
+Reserved field + |
+
os-extended-snapshot-attributes:project_id + |
+String + |
+Reserved field + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "snapshot": {
+ "status": "available",
+ "description": "Daily backup",
+ "created_at": "2013-02-25T03:56:53.081642",
+ "metadata": { },
+ "volume_id": "5aa119a8-d25b-45a7-8d1b-88e127885635",
+ "size": 1,
+ "id": "f9faf7df-fdc1-4093-9ef3-5cba06eef995",
+ "name": "snap-001",
+ "updated_at": "2013-02-25T03:56:53.081642"
+ }
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badRequest or itemNotFound. An example is provided as follows:
+{
+ "itemNotFound": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to query the EVS snapshots.
+Parameter + |
+Mandatory + |
+Description + |
+
|---|---|---|
project_id + |
+Yes + |
+Specifies the project ID. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
marker + |
+String + |
+No + |
+Specifies the ID of the last record on the previous page. The returned value is the value of the item after this one. + |
+
offset + |
+Integer + |
+No + |
+Specifies the 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. + |
+
limit + |
+Integer + |
+No + |
+Specifies 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. + |
+
name + |
+String + |
+No + |
+Specifies the snapshot name. This parameter does not support fuzzy search. The value can contain a maximum of 255 bytes. + |
+
sort_dir + |
+String + |
+No + |
+Specifies the result sorting order. The default value is desc.
+
|
+
status + |
+String + |
+No + |
+Specifies the snapshot status. For details, see EVS Snapshot Status. + |
+
volume_id + |
+String + |
+No + |
+Specifies the ID of the snapshot's source disk. + |
+
name~ + |
+String + |
+No + |
+Specifies the fuzzy search by disk name. This parameter is supported when the request version is 3.31 or later. + |
+
status~ + |
+String + |
+No + |
+Specifies the fuzzy search by disk status. This parameter is supported when the request version is 3.31 or later. + |
+
volume_id~ + |
+String + |
+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. + |
+
sort_key + |
+String + |
+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. + |
+
with_count + |
+Boolean + |
+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. +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. + |
+
The following example shows how to query the snapshots in the available state.
+GET https://{endpoint}/v3/{project_id}/snapshots?status=available
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
snapshots + |
+Object + |
+Specifies 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. + |
+
count + |
+Object + |
+Specifies 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. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+Specifies the snapshot ID. + |
+
status + |
+String + |
+Specifies the snapshot status. For details, see EVS Snapshot Status. + |
+
name + |
+String + |
+Specifies the snapshot name. + |
+
description + |
+String + |
+Specifies the snapshot description. + |
+
created_at + |
+String + |
+Specifies the time when the snapshot was created. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
metadata + |
+Object + |
+Specifies the snapshot metadata. +If metadata contains the __system__enableActive field, the snapshot is automatically created during the backup of a server. + |
+
volume_id + |
+String + |
+Specifies the ID of the snapshot's source disk. + |
+
size + |
+Integer + |
+Specifies the snapshot size, in GB. + |
+
updated_at + |
+String + |
+Specifies the time when the snapshot was updated. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "count": 4,
+ "snapshots": [
+ {
+ "created_at": "2016-02-16T16:54:14.981520",
+ "description": null,
+ "id": "b836dc3d-4e10-4ea4-a34c-8f6b0460a583",
+ "metadata": { },
+ "name": "test01",
+ "size": 1,
+ "status": "available",
+ "volume_id": "ba5730ea-8621-4ae8-b702-ff0ffc12c209",
+ "updated_at": null
+ },
+ {
+ "created_at": "2016-02-16T16:54:19.475397",
+ "description": null,
+ "id": "83be494d-329e-4a78-8ac5-9af900f48b95",
+ "metadata": { },
+ "name": "test02",
+ "size": 1,
+ "status": "available",
+ "volume_id": "ba5730ea-8621-4ae8-b702-ff0ffc12c209",
+ "updated_at": null
+ },
+ {
+ "created_at": "2016-02-16T16:54:24.367414",
+ "description": null,
+ "id": "dd360f46-7593-4d35-8f2c-5566fd0bd79e",
+ "metadata": { },
+ "name": "test03",
+ "size": 1,
+ "status": "available",
+ "volume_id": "ba5730ea-8621-4ae8-b702-ff0ffc12c209",
+ "updated_at": null
+ },
+ {
+ "created_at": "2016-02-16T16:54:29.766740",
+ "description": null,
+ "id": "4c29796a-8cf4-4482-9afc-e66da9a81240",
+ "metadata": { },
+ "name": "test04",
+ "size": 1,
+ "status": "available",
+ "volume_id": "ba5730ea-8621-4ae8-b702-ff0ffc12c209",
+ "updated_at": null
+ }
+ ],
+ "snapshots_links": null
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badRequest or itemNotFound. An example is provided as follows:
+{
+ "itemNotFound": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to query details about the EVS snapshots.
+Parameter + |
+Mandatory + |
+Description + |
+
|---|---|---|
project_id + |
+Yes + |
+Specifies the project ID. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
marker + |
+String + |
+No + |
+Specifies the ID of the last record on the previous page. The returned value is the value of the item after this one. + |
+
offset + |
+Integer + |
+No + |
+Specifies the 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. + |
+
limit + |
+Integer + |
+No + |
+Specifies 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. + |
+
name + |
+String + |
+No + |
+Specifies the snapshot name. The value can contain a maximum of 255 bytes. + |
+
sort_dir + |
+String + |
+No + |
+Specifies the result sorting order. The default value is desc.
+
|
+
status + |
+String + |
+No + |
+Specifies the snapshot status. For details, see EVS Snapshot Status. + |
+
volume_id + |
+String + |
+No + |
+Specifies the ID of the snapshot's source disk. + |
+
The following example shows how to query details of the snapshots in the available state.
+GET https://{endpoint}/v3/{project_id}/snapshots/detail?status=available
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
snapshots + |
+Object + |
+Specifies 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. + |
+
count + |
+Object + |
+Specifies 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. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+Specifies the snapshot ID. + |
+
status + |
+String + |
+Specifies the snapshot status. For details, see EVS Snapshot Status. + |
+
name + |
+String + |
+Specifies the snapshot name. + |
+
description + |
+String + |
+Specifies the snapshot description. + |
+
created_at + |
+String + |
+Specifies the time when the snapshot was created. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
updated_at + |
+String + |
+Specifies the time when the snapshot was updated. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
metadata + |
+Object + |
+Specifies the snapshot metadata. +If metadata contains the __system__enableActive field, the snapshot is automatically created during the backup of a server. + |
+
volume_id + |
+String + |
+Specifies the ID of the snapshot's source disk. + |
+
size + |
+Integer + |
+Specifies the snapshot size, in GB. + |
+
os-extended-snapshot-attributes:project_id + |
+String + |
+Specifies the tenant ID. The tenant ID is actually the project ID. + |
+
os-extended-snapshot-attributes:progress + |
+String + |
+Reserved field + |
+
user_id + |
+String + |
+Reserved field + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+
+ "snapshots": [
+ {
+ "status": "available",
+ "os-extended-snapshot-attributes:progress": "100%",
+ "description": null,
+ "created_at": "2013-06-19T07:15:29.000000",
+ "metadata": { },
+ "volume_id": "ae11e59c-bd56-434a-a00c-04757e1c066d",
+ "os-extended-snapshot-attributes:project_id": "d6c277ba8820452e83df36f33c9fa561",
+ "size": 5,
+ "id": "6cd26877-3ca3-4f4e-ae2a-38cc3d6183fa",
+ "name": "name_xx2-snap",
+ "updated_at": null,
+ "user_id": "48d70679b8644035846b2cb53633c256"
+ },
+ {
+ "status": "available",
+ "os-extended-snapshot-attributes:progress": "100%",
+ "description": null,
+ "created_at": "2013-06-19T09:08:08.000000",
+ "metadata": { },
+ "volume_id": "ae11e59c-bd56-434a-a00c-04757e1c066d",
+ "os-extended-snapshot-attributes:project_id": "d6c277ba8820452e83df36f33c9fa561",
+ "size": 5,
+ "id": "b3253e26-5c37-48dd-8bf2-8795dd1e848f",
+ "name": "name_xx2-snap",
+ "updated_at": null,
+ "user_id": "48d70679b8644035846b2cb53633c256"
+ }
+ ]
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badRequest or itemNotFound. An example is provided as follows:
+{
+ "itemNotFound": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to query details about an EVS snapshot.
+GET https://{endpoint}/v3/{project_id}/snapshots/f9faf7df-fdc1-4093-9ef3-5cba06eef995
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
snapshot + |
+Object + |
+Specifies 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. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+Specifies the snapshot ID. + |
+
status + |
+String + |
+Specifies the snapshot status. For details, see EVS Snapshot Status. + |
+
name + |
+String + |
+Specifies 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. + |
+
description + |
+String + |
+Specifies the snapshot description. + |
+
created_at + |
+String + |
+Specifies the time when the snapshot was created. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
updated_at + |
+String + |
+Specifies the time when the snapshot was updated. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
metadata + |
+Object + |
+Specifies the snapshot metadata. +If metadata contains the __system__enableActive field, the snapshot is automatically created during the backup of a server. + |
+
volume_id + |
+String + |
+Specifies the ID of the snapshot's source disk. + |
+
size + |
+Integer + |
+Specifies the snapshot size, in GB. + |
+
os-extended-snapshot-attributes:project_id + |
+String + |
+Specifies the tenant ID. The tenant ID is actually the project ID. + |
+
os-extended-snapshot-attributes:progress + |
+String + |
+Reserved field + |
+
user_id + |
+String + |
+Reserved field + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "snapshot": {
+ "status": "available",
+ "os-extended-snapshot-attributes:progress": "100%",
+ "description": "daily backup",
+ "created_at": "2013-02-25t04:13:17.000000",
+ "metadata": { },
+ "volume_id": "5aa119a8-d25b-45a7-8d1b-88e127885635",
+ "os-extended-snapshot-attributes:project_id": "0c2eba2c5af04d3f9e9d0d410b371fde",
+ "size": 1,
+ "user_id": "48d70679b8644035846b2cb53633c256",
+ "id": "2bb856e1-b3d8-4432-a858-09e4ce939389",
+ "name": "snap-001",
+ "updated_at": null
+ }
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badRequest or itemNotFound. An example is provided as follows:
+{
+ "itemNotFound": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to add the metadata of an EVS snapshot.
+Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
metadata + |
+Object + |
+Yes + |
+Specifies the metadata to be added. For details, see Parameter in the metadata field. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
key_val + |
+String + |
+No + |
+Specifies the metadata information, which is made up of one or multiple key-value pairs. + |
+
{
+ "metadata": {
+ "key1": "value1",
+ "key2": "value2"
+ }
+}
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
metadata + |
+Object + |
+Specifies 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. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "metadata": {
+ "key1": "value1",
+ "key2": "value2"
+ }
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badRequest or itemNotFound. An example is provided as follows:
+{
+ "badRequest": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to query the metadata of an EVS snapshot.
+GET https://{endpoint}/v3/{project_id}/snapshots/f9faf7df-fdc1-4093-9ef3-5cba06eef995/metadata
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
metadata + |
+Object + |
+Specifies 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. + |
+
error + |
+Object + |
+Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "metadata": {
+ "key1": "value1",
+ "key2": "value2"
+ }
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badRequest or itemNotFound. An example is provided as follows:
+{
+ "badRequest": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to update one piece of the EVS snapshot metadata.
+Parameter + |
+Mandatory + |
+Description + |
+
|---|---|---|
project_id + |
+Yes + |
+Specifies the project ID. + |
+
snapshot_id + |
+Yes + |
+Specifies the snapshot ID. + |
+
key + |
+Yes + |
+Specifies the key of the piece of metadata to be updated. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
meta + |
+Object + |
+Yes + |
+Specifies the metadata to be updated. For details, see Parameter in the metadata field. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
key_val + |
+String + |
+No + |
+Specifies a piece of metadata, which is made up of a key-value pair. + |
+
{
+ "meta": {
+ "key1": "value1"
+ }
+}
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
meta + |
+Object + |
+Specifies a 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. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "meta": {
+ "key1": "value1"
+ }
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badRequest or itemNotFound. An example is provided as follows:
+{
+ "badRequest": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to update the metadata of an EVS snapshot.
+Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
metadata + |
+Object + |
+Yes + |
+Specifies the metadata to be updated. For details, see Parameter in the metadata field. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
key_val + |
+String + |
+No + |
+Specifies the metadata information, which is made up of one or multiple key-value pairs. + |
+
{
+ "metadata": {
+ "key1": "value1",
+ "key2": "value2"
+ }
+}
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
metadata + |
+Object + |
+Specifies 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. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "metadata": {
+ "key1": "value1",
+ "key2": "value2"
+ }
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badRequest or itemNotFound. An example is provided as follows:
+{
+ "badRequest": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For details, see Error Codes.
+This API is used to query one piece of the EVS snapshot metadata.
+Parameter + |
+Mandatory + |
+Description + |
+
|---|---|---|
project_id + |
+Yes + |
+Specifies the project ID. + |
+
snapshot_id + |
+Yes + |
+Specifies the snapshot ID. + |
+
key + |
+Yes + |
+Specifies the key of the piece of metadata to be queried. + |
+
GET https://{endpoint}/v3/{project_id}/snapshots/f9faf7df-fdc1-4093-9ef3-5cba06eef995/metadata/value1
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
meta + |
+Object + |
+Specifies a 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. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
{
+ "meta": {
+ "key1": "value1"
+ }
+}
+or
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+In the preceding example, error indicates a general error, for example, badRequest or itemNotFound. An example is provided as follows:
+{
+ "badRequest": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+This API is used to delete one piece of the EVS snapshot metadata.
+DELETE /v3/{project_id}/snapshots/{snapshot_id}/metadata/{key}
+Parameter + |
+Mandatory + |
+Description + |
+
|---|---|---|
project_id + |
+Yes + |
+Specifies the project ID. + |
+
snapshot_id + |
+Yes + |
+Specifies the snapshot ID. + |
+
key + |
+Yes + |
+Specifies the key of the piece of metadata to be deleted. + |
+
DELETE https://{endpoint}/v3/{project_id}/snapshots/f9faf7df-fdc1-4093-9ef3-5cba06eef995/metadata/value1
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
error + |
+Object + |
+Specifies the error message returned when an error occurs. For details, see Parameters in the error field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
message + |
+String + |
+Specifies the error message returned when an error occurs. + |
+
code + |
+String + |
+Specifies the error code returned when an error occurs. +For details about the error code, see Error Codes. + |
+
For details, see Error Codes.
+This API is used to create a disk transfer. After the transfer has been created, a transfer ID and an authentication key are returned.
+After a disk transfer is created, the disk status changes from available to awaiting-transfer. Once the disk transfer is accepted, the disk status changes to available again.
+A disk transfer can be created only when the disk status is available. The detailed constraints are as follows:
+
If the disk transfer is created using one of the unsupported disks, error code 400 will be returned.
+Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
transfer + |
+Object + |
+Yes + |
+Specifies the disk transfer marker. For details, see Parameters in the transfer field. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
volume_id + |
+String + |
+Yes + |
+Specifies the disk ID. + |
+
name + |
+String + |
+No + |
+Specifies the disk transfer name. The value can contain a maximum of 255 bytes. + |
+
{
+ "transfer": {
+ "volume_id": "c86b9af4-151d-4ead-b62c-5fb967af0e37",
+ "name": "first volume"
+ }
+}
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
transfer + |
+Object + |
+Specifies the disk transfer information. For details, see Parameters in the transfer field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
auth_key + |
+String + |
+Specifies the authentication key of the disk transfer. + |
+
links + |
+List< Dict > + |
+Specifies the links of the disk transfer. + |
+
created_at + |
+String + |
+Specifies the time when the disk transfer was created. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
volume_id + |
+String + |
+Specifies the disk ID. + |
+
id + |
+String + |
+Specifies the disk transfer ID. + |
+
name + |
+String + |
+Specifies the name of the disk transfer. + |
+
{
+ "transfer": {
+ "id": "1a7059f5-8ed7-45b7-8d05-2811e5d09f24",
+ "created_at": "2015-02-25T03:56:53.081642",
+ "name": "first volume",
+ "volume_id": "c86b9af4-151d-4ead-b62c-5fb967af0e37",
+ "auth_key": "9266c59563c84664",
+ "links": [
+ {
+ "href": "https://localhost/v2/firstproject/os-volume-transfer/3",
+ "rel": "self"
+ },
+ {
+ "href": "https://localhost/firstproject/os-volume-transfer/3",
+ "rel": "bookmark"
+ }
+ ]
+ }
+}
+For details, see Error Codes.
+This API is used to accept a disk transfer through the transfer ID and authentication key.
+
If the disk transfer is created using one of the unsupported disks, error code 400 will be returned.
+Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
accept + |
+Object + |
+Yes + |
+Specifies the disk transfer acceptance marker. For details, see Parameter in the accept field. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
auth_key + |
+String + |
+Yes + |
+Specifies the authentication key of the disk transfer. +Specifies the authentication key returned during the disk transfer creation. + |
+
{
+ "accept": {
+ "auth_key": "9266c59563c84664"
+ }
+}
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
transfer + |
+Object + |
+Specifies the disk transfer information. For details, see Parameters in the transfer field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
volume_id + |
+String + |
+Specifies the disk ID. + |
+
id + |
+String + |
+Specifies the disk transfer ID. + |
+
name + |
+String + |
+Specifies the name of the disk transfer. + |
+
links + |
+List< Dict > + |
+Specifies the links of the disk transfer. + |
+
{
+ "transfer": {
+ "id": "cac5c677-73a9-4288-bb9c-b2ebfb547377",
+ "name": "first volume transfer",
+ "volume_id": "894623a6-e901-4312-aa06-4275e6321cce",
+ "links": [
+ {
+ "href": "https://localhost/v2/firstproject/os-volume-transfer/1",
+ "rel": "self"
+ },
+ {
+ "href": "https://localhost/firstproject/os-volume-transfer/1",
+ "rel": "bookmark"
+ }
+ ]
+ }
+}
+For details, see Error Codes.
+This API is used to delete a disk transfer. A disk transfer can be deleted if it is not accepted. Accepted disk transfers cannot be deleted.
+DELETE https://{endpoint}/v3/{project_id}/os-volume-transfer/cac5c677-73a9-4288-bb9c-b2ebfb547377
+None
+For details, see Error Codes.
+This API is used to query the details of a disk transfer, including the transfer creation time, transfer ID, and transfer name.
+GET https://{endpoint}/v3/{project_id}/os-volume-transfer/cac5c677-73a9-4288-bb9c-b2ebfb547377
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
transfer + |
+Object + |
+Specifies the disk transfer details. For details, see Parameters in the transfer field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
links + |
+List< Dict > + |
+Specifies the links of the disk transfer. + |
+
created_at + |
+String + |
+Specifies the time when the disk transfer was created. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
volume_id + |
+String + |
+Specifies the disk ID. + |
+
id + |
+String + |
+Specifies the disk transfer ID. + |
+
name + |
+String + |
+Specifies the name of the disk transfer. + |
+
{
+ "transfer": {
+ "id": "cac5c677-73a9-4288-bb9c-b2ebfb547377",
+ "created_at": "2015-02-25T03:56:53.081642",
+ "name": "first volume transfer",
+ "volume_id": "894623a6-e901-4312-aa06-4275e6321cce",
+ "links": [
+ {
+ "href": "https://localhost/v2/firstproject/os-volume-transfer/1",
+ "rel": "self"
+ },
+ {
+ "href": "https://localhost/firstproject/os-volume-transfer/1",
+ "rel": "bookmark"
+ }
+ ]
+ }
+}
+For details, see Error Codes.
+This API is used to query all disk transfers of the current tenant.
+Parameter + |
+Mandatory + |
+Description + |
+
|---|---|---|
project_id + |
+Yes + |
+Specifies the project ID. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
limit + |
+Integer + |
+No + |
+Specifies 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. + |
+
offset + |
+Integer + |
+No + |
+Specifies the offset. All disk transfers after this offset will be queried. The value must be an integer greater than 0 but less than the number of disk transfers. + |
+
The following example shows how to query details of the disk transfers whose limit is no more than 50.
+GET https://{endpoint}/v3/{project_id}/os-volume-transfer?limit=50
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
transfers + |
+List<Transfer> + |
+Specifies the disk transfers. For details, see Parameters in the transfers field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
links + |
+List< Dict > + |
+Specifies the links of the disk transfer. + |
+
volume_id + |
+String + |
+Specifies the disk ID. + |
+
id + |
+String + |
+Specifies the disk transfer ID. + |
+
name + |
+String + |
+Specifies the name of the disk transfer. + |
+
{
+ "transfers": [
+ {
+ "id": "cac5c677-73a9-4288-bb9c-b2ebfb547377",
+ "name": "first volume transfer",
+ "volume_id": "894623a6-e901-4312-aa06-4275e6321cce",
+ "links": [
+ {
+ "href": "https://localhost/v2/firstproject/os-volume-transfer/1",
+ "rel": "self"
+ },
+ {
+ "href": "https://localhost/firstproject/os-volume-transfer/1",
+ "rel": "bookmark"
+ }
+ ]
+ },
+ {
+ "id": "f26c0dee-d20d-4e80-8dee-a8d91b9742a1",
+ "name": "second volume transfer",
+ "volume_id": "673db275-379f-41af-8371-e1652132b4c1",
+ "links": [
+ {
+ "href": "https://localhost/v2/firstproject/os-volume-transfer/2",
+ "rel": "self"
+ },
+ {
+ "href": "https://localhost/firstproject/os-volume-transfer/2",
+ "rel": "bookmark"
+ }
+ ]
+ }
+ ]
+}
+For details, see Error Codes.
+This API is used to query the details of all disk transfers, including the transfer creation time, transfer IDs, and transfer names.
+Parameter + |
+Mandatory + |
+Description + |
+
|---|---|---|
project_id + |
+Yes + |
+Specifies the project ID. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
limit + |
+Integer + |
+No + |
+Specifies 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. + |
+
offset + |
+Integer + |
+No + |
+Specifies the offset. All disk transfers after this offset will be queried. The value must be an integer greater than 0 but less than the number of disk transfers. + |
+
The following example shows how to query details of the disk transfers whose limit is no more than 50.
+GET https://{endpoint}/v3/{project_id}/os-volume-transfer/detail?limit=50
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
transfers + |
+List<Transfer> + |
+Specifies the disk transfer details. For details, see Parameters in the transfers field. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
links + |
+List< Dict > + |
+Specifies the links of the disk transfer. + |
+
created_at + |
+String + |
+Specifies the time when the disk transfer was created. +Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX + |
+
volume_id + |
+String + |
+Specifies the disk ID. + |
+
id + |
+String + |
+Specifies the disk transfer ID. + |
+
name + |
+String + |
+Specifies the name of the disk transfer. + |
+
{
+ "transfers": [
+ {
+ "id": "cac5c677-73a9-4288-bb9c-b2ebfb547377",
+ "created_at": "2015-02-25T03:56:53.081642",
+ "name": "first volume transfer",
+ "volume_id": "894623a6-e901-4312-aa06-4275e6321cce",
+ "links": [
+ {
+ "href": "https://localhost/v2/firstproject/os-volume-transfer/1",
+ "rel": "self"
+ },
+ {
+ "href": "https://localhost/firstproject/os-volume-transfer/1",
+ "rel": "bookmark"
+ }
+ ]
+ },
+ {
+ "id": "f26c0dee-d20d-4e80-8dee-a8d91b9742a1",
+ "created_at": "2015-03-25T03:56:53.081642",
+ "name": "second volume transfer",
+ "volume_id": "673db275-379f-41af-8371-e1652132b4c1",
+ "links": [
+ {
+ "href": "https://localhost/v2/firstproject/os-volume-transfer/2",
+ "rel": "self"
+ },
+ {
+ "href": "https://localhost/firstproject/os-volume-transfer/2",
+ "rel": "bookmark"
+ }
+ ]
+ }
+ ]
+}
+For details, see Error Codes.
+This document describes how to call the Elastic Volume Service (EVS) APIs to use various EVS functions.
+This chapter describes the concepts related to EVS to help you quickly understand the service.
+EVS offers scalable block storage for servers. With high reliability, high performance, and rich specifications, EVS disks can be used for distributed file systems, development and test environments, data warehouse applications, and high-performance computing (HPC) scenarios to meet diverse service requirements.
+EVS disks are also referred to as disks in this document.
+An availability zone (AZ) is a physical location where resources use independent power supply and networks within a region. An AZ is insulated from failures in other AZs and provides inexpensive, low-latency network connectivity to other AZs in the same regions. A region can have more than one AZ. AZs are physically isolated but interconnected through an internal network.
+A project is used to group and isolate OpenStack resources, such as computing, storage, and network resources. A project can either be a department or a project team. You can access the Identity and Access Management (IAM) service with a security administrator to create projects in a region and perform isolated management of resources.
+An image must contain an OS and can also contain application software (such as database software) and software configuration.
+Images can be public or private. Public images are provided by the system by default, and private images are manually created by users. You can create system disks using a public or private image.
+An EVS snapshot is a complete copy or image of the disk data at a specific time point. As a major disaster recovery (DR) approach, you can use a snapshot to completely restore the data to the time point when the snapshot was created.
+The EVS implements the backup function through Cloud Backup and Recovery (CBR). CBR allows you to create backups for EVS disks on the management console without stopping the servers. When data loss or data damage occurred due to virus invasion, misoperations, or software and hardware faults, you can use backups to restore the data, maximizing your data correctness and security.
+You need to learn how to call the EVS APIs before you start. For details about how to call RESTful APIs, see API Usage Guidelines.
+This API is used to create one or multiple EVS disks.
+None
+Query the AZs before you create EVS disks.
+If you need to create system disks, query the image information and obtain the image ID.
+If you need to create the disk from a data source, for example a snapshot or backup, query the snapshot or backup information and obtain the snapshot ID or backup ID.
+Obtain the required information and then create the disk.
+To meet the preceding requirements, call the following APIs:
+URI format: GET /v3/{project_id}/os-availability-zone
+For details, see OpenStack Cinder API v3 > EVS Disk > Querying Information About All AZs in the Elastic Volume Service API Reference.
+GET /v3/9c53a566cb3443ab910cf0daebca90c4/os-availability-zone
+ {
+ "availabilityZoneInfo": [
+ {
+ "zoneState": {
+ "available": true
+ },
+ "zoneName": "az1.dc1"
+ },
+ {
+ "zoneState": {
+ "available": true
+ },
+ "zoneName": "vmware.az1"
+ }
+ ]
+}
+For details, see API > Image (Native OpenStack APIs) > Querying Images (Native OpenStack API) in the Image Management Service API Reference.
+{
+ "images": [
+ {
+ "status": "queued",
+ "name": "test",
+ "tags": [
+ "test",
+ "image"
+ ],
+ "container_format": "bare",
+ "created_at": "2014-12-16T01:22:05Z",
+ "disk_format": "qcow2",
+ "updated_at": "2014-12-16T01:22:05Z",
+ "visibility": "private",
+ "self": "/v2/images/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90",
+ "min_disk": 1,
+ "protected": false,
+ "id": "4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90",
+ "file": "/v2/images/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/file",
+ "owner": "aed2c611711548a4a9c16fb8fe166af4",
+ "min_ram": 1024,
+ "schema": "/v2/schemas/image"
+ },
+ {
+ "status": "active",
+ "name": "cirros",
+ "tags": [
+ "new"
+ ],
+ "container_format": "bare",
+ "created_at": "2014-12-11T03:53:43Z",
+ "size": 13147648,
+ "disk_format": "qcow2",
+ "updated_at": "2014-12-15T20:02:12Z",
+ "visibility": "private",
+ "self": "/v2/images/5155a22a-834e-4ffe-a95d-ed9665a8ed76",
+ "min_disk": 0,
+ "protected": false,
+ "id": "5155a22a-834e-4ffe-a95d-ed9665a8ed76",
+ "file": "/v2/images/5155a22a-834e-4ffe-a95d-ed9665a8ed76/file",
+ "checksum": "d972013792949d0d3ba628fbe8685bce",
+ "owner": "aed2c611711548a4a9c16fb8fe166af4",
+ "min_ram": 0,
+ "schema": "/v2/schemas/image"
+ }
+ ],
+ "schema": "/v2/schemas/images",
+ "first": "/v2/images"
+}
+URI format: GET /v3/{project_id}/snapshots
+For details, see OpenStack Cinder API v3 > EVS Snapshot > Querying EVS Snapshots in the Elastic Volume Service API Reference.
+{
+ "snapshots": [
+ {
+ "created_at": "2016-02-16T16:54:14.981520",
+ "description": null,
+ "id": "b836dc3d-4e10-4ea4-a34c-8f6b0460a583",
+ "metadata": { },
+ "name": "test01",
+ "size": 1,
+ "status": "available",
+ "volume_id": "ba5730ea-8621-4ae8-b702-ff0ffc12c209",
+ "updated_at": null
+ },
+ {
+ "created_at": "2016-02-16T16:54:19.475397",
+ "description": null,
+ "id": "83be494d-329e-4a78-8ac5-9af900f48b95",
+ "metadata": { },
+ "name": "test02",
+ "size": 1,
+ "status": "available",
+ "volume_id": "ba5730ea-8621-4ae8-b702-ff0ffc12c209",
+ "updated_at": null
+ },
+ {
+ "created_at": "2016-02-16T16:54:24.367414",
+ "description": null,
+ "id": "dd360f46-7593-4d35-8f2c-5566fd0bd79e",
+ "metadata": { },
+ "name": "test03",
+ "size": 1,
+ "status": "available",
+ "volume_id": "ba5730ea-8621-4ae8-b702-ff0ffc12c209",
+ "updated_at": null
+ },
+ {
+ "created_at": "2016-02-16T16:54:29.766740",
+ "description": null,
+ "id": "4c29796a-8cf4-4482-9afc-e66da9a81240",
+ "metadata": { },
+ "name": "test04",
+ "size": 1,
+ "status": "available",
+ "volume_id": "ba5730ea-8621-4ae8-b702-ff0ffc12c209",
+ "updated_at": null
+ }
+ ],
+ "snapshots_links": null
+}
+URI format: GET /v3/{project_id}/backups
+For details, see CBR APIs > Backups > Querying All Backups in the Cloud Backup and Recovery API Reference.
+{
+ "backups": [
+ {
+ "id": "1d1139d8-8989-49d3-8aa1-83eb691e6db2",
+ "links": [
+ {
+ "href": "http://192.168.82.222:8776/v2/b23b579f08c84228b9b4673c46f0c442/backups/1d1139d8-8989-49d3-8aa1-83eb691e6db2",
+ "rel": "self"
+ },
+ {
+ "href": "http://192.168.82.222:8776/b23b579f08c84228b9b4673c46f0c442/backups/1d1139d8-8989-49d3-8aa1-83eb691e6db2",
+ "rel": "bookmark"
+ }
+ ],
+ "name": null
+ },
+ {
+ "id": "b3cf7a16-decc-4beb-8077-682737d94a58",
+ "links": [
+ {
+ "href": "http://192.168.82.222:8776/v2/b23b579f08c84228b9b4673c46f0c442/backups/b3cf7a16-decc-4beb-8077-682737d94a58",
+ "rel": "self"
+ },
+ {
+ "href": "http://192.168.82.222:8776/b23b579f08c84228b9b4673c46f0c442/backups/b3cf7a16-decc-4beb-8077-682737d94a58",
+ "rel": "bookmark"
+ }
+ ],
+ "name": null
+ }
+ ],
+ "backups_links": [
+ {
+ "href": "http://192.168.82.222:8776/b23b579f08c84228b9b4673c46f0c442/backups?limit=1&offset=1&marker=b3cf7a16-decc-4beb-8077-682737d94a58",
+ "rel": "next"
+ }
+ ]
+}
+URI format: POST /v3/{project_id}/volumes
+For details, see OpenStack Cinder API v3 > EVS Disk > Creating EVS Disks in the Elastic Volume Service API Reference.
+POST /v3/9c53a566cb3443ab910cf0daebca90c4/volumes
+{
+ "volume": {
+ "name": "openapi_vol01",
+ "imageRef": "027cf713-45a6-45f0-ac1b-0ccc57ac12e2",
+ "availability_zone": "xxx",
+ "description": "create for api test",
+ "volume_type": "SATA",
+ "metadata": {
+ "volume_owner": "openapi"
+ },
+ "consistencygroup_id": null,
+ "OS-SCH-HNT:scheduler_hints": {
+ "dedicated_storage_id": "eddc1a3e-4145-45be-98d7-bf6f65af9767"
+ },
+ "source_volid": null,
+ "snapshot_id": null,
+ "shareable": "false",
+ "multiattach": false,
+ "source_replica": null,
+ "size": 40
+ }
+}
+{
+ "volume": {
+ "attachments": [ ],
+ "availability_zone": "xxx",
+ "bootable": "false",
+ "consistencygroup_id": null,
+ "created_at": "2016-05-25T02:38:40.392463",
+ "description": "create for api test",
+ "encrypted": false,
+ "id": "8dd7c486-8e9f-49fe-bceb-26aa7e312b66",
+ "links": [
+ {
+ "href": "https://volume.localdomain.com:8776/v2/5dd0b0056f3d47b6ab4121667d35621a/volumes/8dd7c486-8e9f-49fe-bceb-26aa7e312b66",
+ "rel": "self"
+ },
+ {
+ "href": "https://volume.localdomain.com:8776/5dd0b0056f3d47b6ab4121667d35621a/volumes/8dd7c486-8e9f-49fe-bceb-26aa7e312b66",
+ "rel": "bookmark"
+ }
+ ],
+ "metadata": {
+ "volume_owner": "openapi"
+ },
+ "name": "openapi_vol01",
+ "replication_status": "disabled",
+ "shareable": false,
+ "multiattach": false,
+ "size": 40,
+ "snapshot_id": null,
+ "source_volid": null,
+ "status": "creating",
+ "updated_at": null,
+ "user_id": "39f6696ae23740708d0f358a253c2637",
+ "volume_type": "SATA"
+ }
+}
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+{
+ "badRequest": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+For an EVS disk that has been created, you can call this API to expand the disk capacity if the disk space is insufficient.
+Query the disk list, obtain the ID of the target disk, and then expand the disk capacity.
+To meet the preceding requirements, call the following APIs:
+URI format: GET /v3/{project_id}/volumes
+For details, see OpenStack Cinder API v3 > EVS Disk > Querying EVS Disks in the Elastic Volume Service API Reference.
+{
+ "volumes": [
+ {
+ "id": "6b604cef-9bd8-4f5a-ae56-45839e6e1f0a",
+ "links": [
+ {
+ "href": "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/6b604cef-9bd8-4f5a-ae56-45839e6e1f0a",
+ "rel": "self"
+ },
+ {
+ "href": "https://volume.localdomain.com:8776/dd14c6ac581f40059e27f5320b60bf2f/volumes/6b604cef-9bd8-4f5a-ae56-45839e6e1f0a",
+ "rel": "bookmark"
+ }
+ ],
+ "name": "zjb_u25_test"
+ },
+ {
+ "id": "2bce4552-9a7d-48fa-8484-abbbf64b206e",
+ "links": [
+ {
+ "href": "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/2bce4552-9a7d-48fa-8484-abbbf64b206e",
+ "rel": "self"
+ },
+ {
+ "href": "https://volume.localdomain.com:8776/dd14c6ac581f40059e27f5320b60bf2f/volumes/2bce4552-9a7d-48fa-8484-abbbf64b206e",
+ "rel": "bookmark"
+ }
+ ],
+ "name": "zjb_u25_test"
+ },
+ {
+ "id": "3f1b98ec-a8b5-4e92-a727-88def62d5ad3",
+ "links": [
+ {
+ "href": "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/3f1b98ec-a8b5-4e92-a727-88def62d5ad3",
+ "rel": "self"
+ },
+ {
+ "href": "https://volume.localdomain.com:8776/dd14c6ac581f40059e27f5320b60bf2f/volumes/3f1b98ec-a8b5-4e92-a727-88def62d5ad3",
+ "rel": "bookmark"
+ }
+ ],
+ "name": "zjb_u25_test"
+ }
+ ],
+ "volumes_links": [
+ {
+ "href": "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes?limit=3&marker=3f1b98ec-a8b5-4e92-a727-88def62d5ad3",
+ "rel": "next"
+ }
+ ]
+}
+URI format: POST /v3/{project_id}/volumes/{volume_id}/action
+For details, see OpenStack Cinder API v3 > EVS Disk Actions > Expanding the Capacity of an EVS Disk in the Elastic Volume Service API Reference.
+POST /v3/000efdc5f9064584b718b181df137bd7/ volumes/9ab74d89-61e7-4259-8546-465fdebe4944/ action
+{
+ "os-extend": {
+ "new_size": 100
+ }
+}
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+{
+ "badRequest": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+If an EVS disk is no longer used, you can delete it to release virtual resources.
+
Query the disk list, obtain the ID of the target disk, and then delete the disk.
+To meet the preceding requirements, call the following APIs:
+URI format: GET /v3/{project_id}/volumes
+For details, see OpenStack Cinder API v3 > EVS Disk > Querying EVS Disks in the Elastic Volume Service API Reference.
+{
+ "volumes": [
+ {
+ "id": "6b604cef-9bd8-4f5a-ae56-45839e6e1f0a",
+ "links": [
+ {
+ "href": "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/6b604cef-9bd8-4f5a-ae56-45839e6e1f0a",
+ "rel": "self"
+ },
+ {
+ "href": "https://volume.localdomain.com:8776/dd14c6ac581f40059e27f5320b60bf2f/volumes/6b604cef-9bd8-4f5a-ae56-45839e6e1f0a",
+ "rel": "bookmark"
+ }
+ ],
+ "name": "zjb_u25_test"
+ },
+ {
+ "id": "2bce4552-9a7d-48fa-8484-abbbf64b206e",
+ "links": [
+ {
+ "href": "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/2bce4552-9a7d-48fa-8484-abbbf64b206e",
+ "rel": "self"
+ },
+ {
+ "href": "https://volume.localdomain.com:8776/dd14c6ac581f40059e27f5320b60bf2f/volumes/2bce4552-9a7d-48fa-8484-abbbf64b206e",
+ "rel": "bookmark"
+ }
+ ],
+ "name": "zjb_u25_test"
+ },
+ {
+ "id": "3f1b98ec-a8b5-4e92-a727-88def62d5ad3",
+ "links": [
+ {
+ "href": "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/3f1b98ec-a8b5-4e92-a727-88def62d5ad3",
+ "rel": "self"
+ },
+ {
+ "href": "https://volume.localdomain.com:8776/dd14c6ac581f40059e27f5320b60bf2f/volumes/3f1b98ec-a8b5-4e92-a727-88def62d5ad3",
+ "rel": "bookmark"
+ }
+ ],
+ "name": "zjb_u25_test"
+ }
+ ],
+ "volumes_links": [
+ {
+ "href": "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes?limit=3&marker=3f1b98ec-a8b5-4e92-a727-88def62d5ad3",
+ "rel": "next"
+ }
+ ]
+}
+URI format: DELETE /v3/{project_id}/volumes/{volume_id}
+For details, see OpenStack Cinder API v3 > EVS Disk > Deleting an EVS Disk in the Elastic Volume Service API Reference.
+DELETE /v3/000efdc5f9064584b718b181df137bd7/baremetalservers/5850a7e7-88dd-4d99-8439-347de8cc0dd7/volume/50ef9435-ca68-4b9b-a837-73377b9fdaa3?cascade=true
+
cascade=true indicates that the snapshots created for the disk will also be deleted.
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+{
+ "badRequest": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+You can create an EVS snapshot on the management console to save the disk data at a specific time point.
+A maximum of 7 snapshots can be created for an EVS disk.
+Query the disk list, obtain the ID of the target disk, and then create the snapshot.
+To meet the preceding requirements, call the following APIs:
+URI format: GET /v3/{project_id}/volumes
+For details, see OpenStack Cinder API v3 > EVS Disk > Querying EVS Disks in the Elastic Volume Service API Reference.
+{
+ "volumes": [
+ {
+ "id": "6b604cef-9bd8-4f5a-ae56-45839e6e1f0a",
+ "links": [
+ {
+ "href": "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/6b604cef-9bd8-4f5a-ae56-45839e6e1f0a",
+ "rel": "self"
+ },
+ {
+ "href": "https://volume.localdomain.com:8776/dd14c6ac581f40059e27f5320b60bf2f/volumes/6b604cef-9bd8-4f5a-ae56-45839e6e1f0a",
+ "rel": "bookmark"
+ }
+ ],
+ "name": "zjb_u25_test"
+ },
+ {
+ "id": "2bce4552-9a7d-48fa-8484-abbbf64b206e",
+ "links": [
+ {
+ "href": "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/2bce4552-9a7d-48fa-8484-abbbf64b206e",
+ "rel": "self"
+ },
+ {
+ "href": "https://volume.localdomain.com:8776/dd14c6ac581f40059e27f5320b60bf2f/volumes/2bce4552-9a7d-48fa-8484-abbbf64b206e",
+ "rel": "bookmark"
+ }
+ ],
+ "name": "zjb_u25_test"
+ },
+ {
+ "id": "3f1b98ec-a8b5-4e92-a727-88def62d5ad3",
+ "links": [
+ {
+ "href": "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/3f1b98ec-a8b5-4e92-a727-88def62d5ad3",
+ "rel": "self"
+ },
+ {
+ "href": "https://volume.localdomain.com:8776/dd14c6ac581f40059e27f5320b60bf2f/volumes/3f1b98ec-a8b5-4e92-a727-88def62d5ad3",
+ "rel": "bookmark"
+ }
+ ],
+ "name": "zjb_u25_test"
+ }
+ ],
+ "volumes_links": [
+ {
+ "href": "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes?limit=3&marker=3f1b98ec-a8b5-4e92-a727-88def62d5ad3",
+ "rel": "next"
+ }
+ ]
+}
+URI format: POST /v3/{project_id}/snapshots
+For details, see OpenStack Cinder API v3 > EVS Snapshot > Creating an EVS Snapshot in the Elastic Volume Service API Reference.
+GET /v3/000efdc5f9064584b718b181df137bd7/snapshots
+{
+ "snapshot": {
+ "name": "snap-001",
+ "description": "Daily backup",
+ "volume_id": "5aa119a8-d25b-45a7-8d1b-88e127885635",
+ "force": false,
+ "metadata": { }
+ }
+}
+{
+ "snapshot": {
+ "status": "creating",
+ "description": "Daily backup",
+ "created_at": "2013-02-25T03:56:53.081642",
+ "metadata": { },
+ "volume_id": "5aa119a8-d25b-45a7-8d1b-88e127885635",
+ "size": 1,
+ "id": "ffa9bc5e-1172-4021-acaf-cdcd78a9584d",
+ "name": "snap-001",
+ "updated_at": "2013-02-25T03:56:53.081642"
+ }
+}
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+{
+ "badRequest": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+If an EVS snapshot is no longer used, you can delete it to release virtual resources.
+Query the snapshot list, obtain the ID of the target snapshot, and then delete the snapshot.
+To meet the preceding requirements, call the following APIs:
+URI format: GET /v3/{project_id}/snapshots
+For details, see OpenStack Cinder API v3 > EVS Snapshot > Querying EVS Snapshots in the Elastic Volume Service API Reference.
+{
+ "snapshots": [
+ {
+ "created_at": "2016-02-16T16:54:14.981520",
+ "description": null,
+ "id": "b836dc3d-4e10-4ea4-a34c-8f6b0460a583",
+ "metadata": { },
+ "name": "test01",
+ "size": 1,
+ "status": "available",
+ "volume_id": "ba5730ea-8621-4ae8-b702-ff0ffc12c209",
+ "updated_at": null
+ },
+ {
+ "created_at": "2016-02-16T16:54:19.475397",
+ "description": null,
+ "id": "83be494d-329e-4a78-8ac5-9af900f48b95",
+ "metadata": { },
+ "name": "test02",
+ "size": 1,
+ "status": "available",
+ "volume_id": "ba5730ea-8621-4ae8-b702-ff0ffc12c209",
+ "updated_at": null
+ },
+ {
+ "created_at": "2016-02-16T16:54:24.367414",
+ "description": null,
+ "id": "dd360f46-7593-4d35-8f2c-5566fd0bd79e",
+ "metadata": { },
+ "name": "test03",
+ "size": 1,
+ "status": "available",
+ "volume_id": "ba5730ea-8621-4ae8-b702-ff0ffc12c209",
+ "updated_at": null
+ },
+ {
+ "created_at": "2016-02-16T16:54:29.766740",
+ "description": null,
+ "id": "4c29796a-8cf4-4482-9afc-e66da9a81240",
+ "metadata": { },
+ "name": "test04",
+ "size": 1,
+ "status": "available",
+ "volume_id": "ba5730ea-8621-4ae8-b702-ff0ffc12c209",
+ "updated_at": null
+ }
+ ],
+ "snapshots_links": null
+}
+URI format: DELETE /v3/{project_id}/snapshots/{snapshot_id}
+For details, see OpenStack Cinder API v3 > EVS Snapshot > Deleting an EVS Snapshot in the Elastic Volume Service API Reference.
+DELETE /v3/000efdc5f9064584b718b181df137bd7/snapshots/b836dc3d-4e10-4ea4-a34c-8f6b0460a583
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+{
+ "badRequest": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+If the data in an EVS disk is incorrect or damaged, you can roll back the data from a snapshot to the source EVS disk to restore the data.
+Query the snapshot list, obtain the ID of the snapshot and the ID of the snapshot's source disk, and then roll back the snapshot to the source disk.
+To meet the preceding requirements, call the following APIs:
+URI format: GET /v3/{project_id}/snapshots
+For details, see OpenStack Cinder API v3 > EVS Snapshot > Querying EVS Snapshots in the Elastic Volume Service API Reference.
+{
+ "snapshots": [
+ {
+ "created_at": "2016-02-16T16:54:14.981520",
+ "description": null,
+ "id": "b836dc3d-4e10-4ea4-a34c-8f6b0460a583",
+ "metadata": { },
+ "name": "test01",
+ "size": 1,
+ "status": "available",
+ "volume_id": "ba5730ea-8621-4ae8-b702-ff0ffc12c209",
+ "updated_at": null
+ },
+ {
+ "created_at": "2016-02-16T16:54:19.475397",
+ "description": null,
+ "id": "83be494d-329e-4a78-8ac5-9af900f48b95",
+ "metadata": { },
+ "name": "test02",
+ "size": 1,
+ "status": "available",
+ "volume_id": "ba5730ea-8621-4ae8-b702-ff0ffc12c209",
+ "updated_at": null
+ },
+ {
+ "created_at": "2016-02-16T16:54:24.367414",
+ "description": null,
+ "id": "dd360f46-7593-4d35-8f2c-5566fd0bd79e",
+ "metadata": { },
+ "name": "test03",
+ "size": 1,
+ "status": "available",
+ "volume_id": "ba5730ea-8621-4ae8-b702-ff0ffc12c209",
+ "updated_at": null
+ },
+ {
+ "created_at": "2016-02-16T16:54:29.766740",
+ "description": null,
+ "id": "4c29796a-8cf4-4482-9afc-e66da9a81240",
+ "metadata": { },
+ "name": "test04",
+ "size": 1,
+ "status": "available",
+ "volume_id": "ba5730ea-8621-4ae8-b702-ff0ffc12c209",
+ "updated_at": null
+ }
+ ],
+ "snapshots_links": null
+}
+URI format: POST /v3/{project_id}/os-vendor-snapshots/{snapshot_id}/rollback
+For details, see API v3 > EVS Snapshot > Rolling Back a Snapshot to an EVS Disk in the Elastic Volume Service API Reference.
+POST /v3/000efdc5f9064584b718b181df137bd7/os-vendor-snapshots/b836dc3d-4e10-4ea4-a34c-8f6b0460a583 /rollback
+{
+ "rollback": {
+ "name": "test-001",
+ "volume_id": "5aa119a8-d25b-45a7-8d1b-88e127885635"
+ }
+}
+{
+ "rollback": {
+ "volume_id": "5aa119a8-d25b-45a7-8d1b-88e127885635"
+ }
+}
+{
+ "error": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+{
+ "badRequest": {
+ "message": "XXXX",
+ "code": "XXX"
+ }
+}
+Release On + |
+What's New + |
+
|---|---|
2018-11-08 + |
+This issue is the first official release. + |
+
Elastic Volume Service (EVS) offers scalable block storage for cloud servers. With high reliability, high performance, and rich specifications, EVS disks can be used for distributed file systems, development and testing environments, data warehouse applications, and high-performance computing (HPC) scenarios to meet diverse service requirements. Servers that EVS supports include Elastic Cloud Servers (ECSs) and Bare Metal Servers (BMSs).
+EVS disks are sometimes just referred to as disks in this document.
+
EVS has the following advantages:
+EVS provides various disk types for you to choose from, and EVS disks can be used as data disks and system disks for servers. You may select the disk type based on your budget and service requirements.
+The EVS disk capacity ranges from 10 GB to 32 TB. When it no longer meets your needs, you can expand the disk capacity up to 32 TB in increments of 1 GB, without interrupting your applications.
+Besides the disk capacity limit, the additional space you can add cannot exceed the remaining quota. You can increase the quota if the remaining quota is insufficient.
+On Cloud Eye, you can monitor the disk health and operating status at any time.
+Currently, there are three data storage services available for you to choose from: EVS, Scalable File Service (SFS), and Object Storage Service (OBS). The differences are described in the following table.
+ +Service + |
+Overall Introduction + |
+Typical Application Scenarios + |
+Storage Capacity + |
+
|---|---|---|---|
EVS + |
+EVS provides scalable block storage that features high reliability, high performance, and rich specifications for servers. + |
+
|
+EVS disks start at 10 GB and can be expanded as required in 1 GB increments to up to 32 TB. + |
+
SFS + |
+SFS provides completely hosted sharable file storage for ECSs. Compatible with the Network File System (NFS) protocol, SFS is expandable to petabytes and seamlessly handles data-intensive and bandwidth-intensive applications. + |
+
|
+SFS storage capacity is available on demand and can be expanded to 10 PB at most. + |
+
OBS + |
+OBS provides cloud storage for unstructured data, such as files, pictures, and videos. With multiple options for migration to the cloud, OBS provides low-cost, reliable storage access for massive data and supports online multimedia processing. + |
+
|
+OBS provides limitless storage capacity, and storage resources are available for linear and nearly infinite expansion. + |
+
Users with resource management permissions can control the operations performed on cloud service resources. For EVS, a user with the Server Administrator permission can perform operations on EVS resources, including creating disks, deleting disks, and creating snapshots.
+For details about user permissions, see Permissions.
+A project is used to group and isolate OpenStack resources, including compute, storage, and network resources. A project can be a department or a project team. You can access IAM with a security administrator to create projects in a region and perform isolated management of resources. For details about projects, see Managing Projects.
+EVS disks are classified based on the disk I/O performance. EVS disks differ in performance and price. Choose the disk type most appropriate for your applications.
+
Currently, high I/O (performance optimized I) and ultra-high I/O (latency optimized) EVS disks can be attached to SAP HANA ECSs or HL1 ECSs only.
+Parameter + |
+Common I/O + |
+High I/O + |
+Ultra-high I/O + |
+High I/O (Performance optimized I) + |
+Ultra-high I/O (Latency optimized) + |
+
|---|---|---|---|---|---|
IOPS per GB/EVS disk + |
+1 + |
+3 + |
+50 + |
+3 + |
+50 + |
+
Min. IOPS/EVS disk + |
+100 + |
+100 + |
+100 + |
+100 + |
+100 + |
+
Max. IOPS/EVS disk + |
+1,000 + |
+3,000 + |
+20,000 + |
+3,000 + |
+30,000 + |
+
IOPS burst limit/EVS disk + |
+1,000 + |
+3,000 + |
+10,000 + |
+3,000 + |
+15,000 + |
+
Max. throughput + |
+40 MB/s + |
+120 MB/s + |
+320 MB/s + |
+550 MB/s + |
+1 GB/s + |
+
Read/write I/O latency + NOTE:
+This parameter specifies the single-queue access latencies of EVS disks. + |
+10 ms to 15 ms + |
+6 ms to 10 ms + |
+1 ms to 3 ms + |
+6 ms to 10 ms + |
+1 ms + |
+
After a disk has been expanded on the management console, the disk size is enlarged, but the additional space cannot be used directly.
+In Windows, you must allocate the additional space to an existing partition or a new partition.
+
Performing the expansion operations with caution. Misoperation may lead to data loss or exceptions. Therefore, you are advised to back up the disk data using backups or snapshots before expansion. For details about backups, see Managing EVS Backup. For details about snapshots, see Creating a Snapshot.
+In this example, the system disk has 50 GB originally, and 22 GB is added on the management console. The following procedure describes how to add this 22 GB to volume (C:) on the server. After the operation is complete, volume (C:) will have 72 GB of capacity and can be used as a system volume.
+The Server Manager window is displayed.
+The Disk Management window is displayed.
+
If you cannot view the additional space, right-click Disk Management and choose Refresh from the shortcut menu.
+



In this example, the system disk has 40 GB originally, and 60 GB is added on the management console. The following procedure describes how to use this 60 GB to create a new volume, for example volume (F:), on the server. After the operation is complete, new volume (F:) has 60 GB of capacity and can be used as a data volume.
+The Server Manager window is displayed.
+
After the refresh, the additional space is displayed in the right area and is unallocated.
+







In this example, the data disk has 100 GB originally, and 50 GB is added on the management console. The following procedure describes how to add this 50 GB to volume (D:) on the server. After the operation is complete, volume (D:) has 150 GB of capacity and can be used as a data volume.
+The Server Manager window is displayed.
+
If you cannot view the additional space, right-click Disk Management and choose Refresh from the shortcut menu.
+



In this example, the data disk has 40 GB originally, and 60 GB is added on the management console. The following procedure describes how to use this 60 GB to create a new volume, for example volume (E:), on the server. After the operation is complete, new volume (E:) has 60 GB of capacity and can be used as a data volume.
+The Server Manager window is displayed.
+
After the refresh, the additional space is displayed in the right area and is unallocated.
+







EVS disks can be used as system disks or data disks for servers.
+This section describes how to separately create disks on the EVS console.
+
in the upper left corner and select the desired region and project.The disk list page is displayed.
++
Parameter + |
+Description + |
+Example Value + |
+
|---|---|---|
Region + |
+Mandatory +Resources are region-specific and cannot be used across regions through internal network connections. For low network latency and quick resource access, select the nearest region. + |
+eu-de + |
+
AZ + |
+Mandatory +Specifies the availability zone (AZ) where you want to create the disk. + NOTE:
+
|
+eu-de-1 + |
+
Disk Type + |
+Mandatory +
NOTE:
+
|
+Common I/O + |
+
Capacity (GB) + |
+Mandatory +Specifies the disk size. Only data disks can be created on the current page, and the disk capacity ranges from 10 GB to 32768 GB. + NOTE:
+
|
+20 GB + |
+
Create from backup + |
+Optional +Specifies to create the disk from a backup. +Click Select Data Source and choose Create from backup. On the displayed page, select the target backup and click OK. + NOTE:
+
|
+autobackup-001 + |
+
Create from snapshot + |
+Optional +Specifies to create the disk from a snapshot. +Click Select Data Source and choose Create from snapshot. On the displayed page, select the target snapshot and click OK. + NOTE:
+
For details about the disk creation from snapshots, see Creating an EVS Disk from a Snapshot. + |
+snapshot-001 + |
+
Auto Backup + |
+Optional +If auto backup is enabled, the system automatically creates backups for the disk data at specified time points and deletes outdated backups according to the configured backup policy. +When Enable is selected, a backup policy must be configured. You can either use the default backup policy or customize the policy based on your service requirements. + NOTE:
+For details about the backup policy, see Managing EVS Backup. + |
+- + |
+
Share + |
+Optional +
If both SCSI and Share are selected, a shared SCSI disk is created. + NOTE:
+The sharing attribute of a disk cannot be changed after the disk has been created. +For details about shared EVS disks, see Managing a Shared EVS Disk. + |
+- + |
+
SCSI + |
+Optional +
NOTE:
+The device type of a disk cannot be changed after the disk has been created. +For details about the ECS types, OSs, and ECS software supported by SCSI EVS disks, see Device Types and Usage Instructions. + |
+- + |
+
Encryption + |
+Optional +Disk encryption is used for data disk encryption only. For system disk encryption, see the Image Management Service User Guide. +To use the disk encryption function, select Encryption. The displayed dialog box contains the following parameters: +
NOTE:
+
For details, see EVS Disk Encryption. + |
+- + |
+
Tag + |
+Optional +During the EVS disk creation, you can tag the EVS resources. Tags identify cloud resources for purposes of easy categorization and quick search. +A tag is composed of a key-value pair.
+
NOTE:
+
For details about tags, see the Tag Management Service User Guide. + |
+- + |
+
Disk Name + |
+Mandatory +
|
+For example, if you create two disks and set volume for Disk Name, the EVS disk names will be volume-0001 and volume-0002. + |
+
Quantity + |
+Optional +Specifies the number of disks to be created. The default value is set to 1, which means only one disk is created. Currently, you can create up to 100 disks at a time. + NOTE:
+
|
+1 + |
+
When the disk status changes to Available, the disk is successfully created.
+Shared EVS disks are block storage devices that support concurrent read/write operations and can be attached to multiple servers. Shared EVS disks feature multiple attachments, high-concurrency, high-performance, and high-reliability. They are usually used for enterprise business-critical applications that require cluster deployment. Multiple servers can access the same shared EVS disk at the same time.
+A shared EVS disk can be attached to a maximum of 16 servers. Servers that EVS supports include ECSs and BMSs. To achieve file sharing, you need to deploy a shared file system or a cluster management system, such as Windows MSCS, Veritas VCS, or CFS.
+
To use shared EVS disks, you must set up a shared file system or similar cluster management system. If you directly attach EVS disks to multiple servers, the EVS disks cannot be shared and data may be overwritten.
+
Most common clusters, such as Windows MSCS and Veritas VCS and CFS, require SCSI reservations. Therefore, you are advised to use shared SCSI EVS disks for clusters. If a SCSI EVS disk is attached to a Xen ECS for use, you must install the driver. For details, see Device Types and Usage Instructions.
+
Concepts of the anti-affinity ECS group and SCSI reservations:
+For details about ECS groups, see Managing ECS Groups in the Elastic Cloud Server User Guide.
+The specifications and performance of shared EVS disks are the same as those of non-shared EVS disks. For details, see Disk Types and Performance.
+A shared EVS disk is essentially the disk that can be attached to multiple servers for use, which is similar to a physical disk in that the disk can be attached to multiple physical servers, and each server can read data from and write data into any space on the disk. If the data read/write rules, such as the read/write sequence and meaning, between these servers are not defined, data read/write interference between servers or other unpredictable errors may occur.
+Though shared EVS disks are block storage devices that provide shared access for servers, shared EVS disks do not have the cluster management capability. Therefore, you need to deploy a cluster system to manage shared EVS disks. Common cluster management systems include Windows MSCS, Linux RHCS, Veritas VCS, and Veritas CFS.
+When a shared EVS disk is attached to two servers (server A and server B), server A cannot recognize the disk spaces allocated to server B, vice versa. That said, a disk space allocated to server A may be already used by server B. In this case, repeated disk space allocation occurs, which leads to data errors.
+For example, a shared EVS disk has been formatted into the ext3 file system and attached to server A and server B. Server A has written metadata into the file system in space R and space G. Then server B has written metadata into space E and space G. In this case, the data written into space G by server A will be replaced. When the metadata in space G is read, an error will occur.
+When a shared EVS disk is attached to two servers (server A and server B), the application on server A has read the data in space R and space G, then cached the data. At that time, other processes and threads on server A would then read this data directly from the cache. At the same time, if the application on server B has modified the data in space R and space G, the application on server A cannot detect this data change and still reads this data from the cache. As a result, the user cannot view the modified data on server A.
+For example, a shared EVS disk has been formatted into the ext3 file system and attached to server A and server B. Both servers have cached the metadata in the file system. Then server A has created a new file (file F) on the shared disk, but server B cannot detect this modification and still reads data from its cached data. As a result, the user cannot view file F on server B.
+Before you attach a shared EVS disk to multiple servers, the disk device type needs to be determined. The device type can be either VBD or SCSI. Shared SCSI EVS disks support SCSI reservations. Before using SCSI reservations, you need to install a driver in the server OS and ensure that the OS image is included in the compatibility list.
+For details about the usages of shared EVS disks, see Managing a Shared EVS Disk.
+
If you simply attach a shared EVS disk to multiple servers, files cannot be shared between the servers as shared EVS disks do not have the cluster capability. Therefore, build a shared file system or deploy a cluster management system if you need to share files between servers.
+Device type is configured during creation. It cannot be changed after the disk has been created.
+SCSI reservations take effect only when shared SCSI EVS disks are attached to ECSs in the same ECS group. For more information about shared EVS disks, see Shared EVS Disks and Usage Instructions.
+Both the Windows and Linux images for BMSs are pre-installed with the required SDI card driver. Therefore, no driver needs to be installed.
+You are advised to use SCSI EVS disks with KVM ECSs. Linux images and Windows images for KVM ECSs already have the required driver. Therefore, no driver needs to be installed for KVM ECSs.
+ +Due to driver limitations, you are advised not to use SCSI EVS disk with Xen ECSs.
+
After confirming that the OS images of Xen ECSs support SCSI EVS disks, determine whether you need to install the driver:
+For details, see (Optional) Optimizing Windows Private Images in the Image Management Service User Guide.
+Note that this driver is different from the PVSCSI drivers attached to some Linux distributions.
+Virtualization Type + |
+OS + |
+|
|---|---|---|
Xen + |
+Windows + |
+See the Windows images listed on the Public Images page. +Log in to the management console, choose Image Management Service, click the Public Images tab, and select ECS image and Windows from the drop-down lists, respectively. + |
+
Linux + |
+
|
+|
You can create an EVS snapshot on the management console to save the EVS disk data at a specific time point.
+
in the upper left corner and select the desired region and project.The disk list page is displayed.
+Configure the basic settings for the snapshot according to Table 1.
+ + +When the snapshot status changes to Available, the snapshot has been created.
+
in the upper left corner and select the desired region and project.The disk list page is displayed.
+On the Snapshots page, click Create Snapshot.
+Configure the basic settings for the snapshot according to Table 2.
+ +Parameter + |
+Description + |
+Example Value + |
+
|---|---|---|
Region + |
+Mandatory +After you select a region, disks in the selected region will be displayed for you to choose. + |
+- + |
+
Snapshot Name + |
+Mandatory +The name can contain a maximum of 64 characters. + |
+snapshot-01 + |
+
Select Disk + |
+Mandatory +Select a disk based on which the snapshot is to be created. + |
+volume-01 + |
+
When the snapshot status changes to Available, the snapshot has been created.
+EVS allows you to create snapshots for disks on the management console or by making API calls. An EVS snapshot is a complete copy or image of the disk data at a specific time point. As a major disaster recovery (DR) approach, you can use a snapshot to completely restore the data to the time point when the snapshot was created.
+EVS snapshots are sometimes referred to as snapshots in this document.
+You can create snapshots to rapidly save the disk data at specified time points. In addition, you can use snapshots to create new disks so that the created disks will contain the snapshot data in the beginning.
+The snapshot function helps address your following needs:
+You can create snapshots for disks on a timely basis and use snapshots to recover your data in case that data loss or data inconsistency occurred due to misoperations, viruses, or attacks.
+You can create a snapshot or multiple snapshots before an application software upgrade or a service data migration. If an exception occurs during the upgrade or migration, service data can be rapidly restored to the time point when the snapshot was created.
+For example, a fault occurred on system disk A of server A, and therefore server A cannot be started. Because system disk A is already faulty, the data on system disk A cannot be restored by rolling back snapshots. However, you can create disk B using an existing snapshot of system disk A and attach disk B to a properly running server, for example server B. In this case, server B can read the data of system disk A from disk B.
+
Currently, when rolling back data from snapshots, the snapshot data can be rolled back only to its source EVS disk, and a rollback to another EVS disk is not possible.
+You can use a snapshot to create multiple disks containing the same initial data, and these disks can be used as data resources for various services, for example data mining, report query, and development and testing. This method protects the initial data and creates disks rapidly, meeting the diversified service data requirements.
+For details about the snapshot usages, see Managing Snapshots.
+In case your services require encryption for the data stored on EVS disks, EVS provides you with the encryption function. You can encrypt newly created EVS disks.
+EVS uses the industry-standard XTS-AES-256 encryption algorithm and keys to encrypt EVS disks. Keys used by encrypted EVS disks are provided by the Key Management Service (KMS), which is secure and convenient. Therefore, you do not need to establish and maintain the key management infrastructure. KMS uses the Hardware Security Module (HSM) that complies with FIPS 140-2 level 3 requirements to protect keys. All user keys are protected by the root key in HSM to prevent key exposure.
+The Default Master Key cannot be disabled and does not support scheduled deletion.
+CMK Status + |
+Impact + |
+How to Restore + |
+
|---|---|---|
Disabled + |
++ | +Enable the CMK. For details, see Managing CMKs > Enabling One or More CMKs in the Key Management Service User Guide. + |
+
Scheduled deletion + |
+Cancel the scheduled deletion for the CMK. For details, see Managing CMKs > Canceling the Scheduled Deletion of One or More CMKs in the Key Management Service User Guide. + |
+|
Deleted + |
+Data on the disks can never be restored. + |
+
From the perspective of a tenant, as long as the KMS access rights have been granted to EVS in a region, all the users in the same region can directly use the disk encryption function.
+If there are multiple projects in the current region, the KMS access rights need to be granted to each project in this region.
+Figure 1 shows the user relationships under regions and projects from the perspective of a tenant. The following example uses region B to describe the two application scenarios of the disk encryption function.
+ +After the KMS access rights have been granted, the system automatically creates a Default Master Key and names it evs/default. DMK can be used for disk encryption.
+
The EVS disk encryption relies on KMS. When the encryption function is used for the first time ever, the KMS access rights need to be granted to EVS. After the KMS access rights have been granted, all users in this region can use the encryption function, without requiring the KMS access rights to be granted again.
+After the security administrator has used the disk encryption function, all users in Region B can directly use the encryption function.
+After the KMS access rights have been granted to EVS, User E as well as all users in Region B can directly use the disk encryption function and do not need to contact the security administrator to grant the KMS access rights to EVS again.
+A system disk can only be detached offline, that is, its server must be in the Stopped state before the system disk is detached. Therefore, you need to first stop the server and then detach the system disk.
+
Bootable disks are the system disks detached from servers. A bootable disk can be re-attached to a server and be used as a system disk or data disk depending on the device name selected.
+
in the upper left corner and select the desired region and project.The Elastic Cloud Server page is displayed.
+When the server status changes to Stopped, the server has been stopped.
+The server details page is displayed.
+After the operation had succeeded, the detached system disk is no longer displayed under the Disks tab.
+For more detachment FAQs, see Detachment.
+For a data disk attached to a server, the disk function is displayed as Data disk, and the disk status is displayed as In-use in the disk list. After the data disk has been detached from the server, the disk function remains unchanged, the disk status changes to Available for a non-shared data disk, and the disk status changes to Available for a shared data disk after it is detached from all its servers.
+
in the upper left corner and select the desired region and project.The disk list page is displayed.
+
to select the server and click Detach Disk.The disk list is displayed. The disk status is Detaching, indicating that the disk is being detached from the server.
+When the status changes to Available, the disk is successfully detached.
+
in the upper left corner and select the desired region and project.The disk list page is displayed.
+
to select the server and click Detach Disk.Shared EVS disks support batch detachment so that you can select multiple servers at a time.
+
to select the server.Shared EVS disks support batch detachment so that you can select multiple servers at a time.
+The disk list page is displayed. The disk status is Detaching, indicating that the disk is being detached from the server.
+If the shared EVS disk has been attached to multiple servers and needs to be detached from only some of its servers, the disk status will go back to In-use after the disk has been detached from the target servers. The disk status changes to Available only when it has been detached from all the servers.
+If an EVS disk is no longer used, you can release the virtual resources by deleting the disk from the system.
+
in the upper left corner and select the desired region and project.The disk list page is displayed.
+
in front of each disk and click Delete in the upper area of the list.If the capacity of an existing disk is insufficient, you can expand the disk capacity to increase the storage space.
+Both system disks and data disks can be expanded. Currently, disk capacities can be expanded only. Capacity reduction is not supported.
+A capacity expansion operation includes the following steps:
+
The disk has not been attached to any server and can be directly expanded by referring to Expanding Capacity for an Available EVS Disk.
+A shared disk can be expanded only when its status is Available.
+Capacity After Expansion + |
+Extend Disk Partition and File System + |
+
|---|---|
Disk capacity ≤ 2 TB + |
++ | +
Disk capacity > 2 TB + |
+
|
+
For more expansion FAQs, see Capacity Expansion.
+This section describes how to expand the capacity of an In-use EVS disk on the management console. The In-use status indicates that the disk has been attached to a server. You do not need to detach the disk when expanding an In-use disk.
+If the server OS does not support capacity expansion of In-use disks, detach the disk and then expand its capacity. Otherwise, you may need to stop and then start the server after the expansion to make the additional space available.
+
in the upper left corner and select the desired region and project.The disk list page is displayed.
+The expansion page is displayed.
+After the specifications are submitted, go back to the disk list page.
+When the disk status changes from Expanding to In-use and the disk capacity increases, the expansion has succeeded.
+
If the expansion fails, technical support personnel will contact you and help you handle this error. Do not perform any operations on the disk before the technical support personnel contact you. If you require that the error be handled as soon as possible, contact our technical support personnel. The disk will no longer be charged after its status changes to Expansion failed.
+The operation method varies depending on the server OS.
+This section describes how to expand the capacity of an Available EVS disk on the management console. The Available status indicates that the disk has not been attached to any server.
+
in the upper left corner and select the desired region and project.The disk list page is displayed.
+The expansion page is displayed.
+After the specifications are submitted, go back to the disk list page.
+When the disk status changes from Expanding to Available and the disk capacity increases, the expansion has succeeded.
+
If the expansion fails, technical support personnel will contact you and help you handle this error. Do not perform any operations on the disk before the technical support personnel contact you. If you require that the error be handled as soon as possible, contact our technical support personnel. The disk will no longer be charged after its status changes to Expansion failed.
+The operation method varies depending on the server OS.
+Before you use the disk encryption function, KMS access rights need to be granted to EVS. If you have the Security Administrator rights, grant the KMS access rights to EVS directly. If you do not have this permission, contact a user with the security administrator rights to grant KMS access rights to EVS, then repeat the preceding operations.
+For details about how to create an encrypted disk, see Create an EVS Disk.
+Before you detach an EVS disk encrypted by a CMK, check whether the CMK is disabled or scheduled for deletion. If the CMK is unavailable, the disk can still be used, but there is no guarantee how long it will be usable. If the disk is detached, it will not be possible to re-attach it later. In this case, do not detach the disk without a working CMK.
+The restoration method varies depending on the current CMK status. For details, see EVS Disk Encryption.
+If the CMK is available, the disk can be detached and re-attached, and data on the disk will not be lost.
+For details about how to detach an encrypted disk, see Detaching a Data Disk.
+
Concepts of the anti-affinity ECS group and SCSI reservations:
+For details about ECS groups, see Managing ECS Groups in the Elastic Cloud Server User Guide.
+A common EVS disk can only be attached to one server, whereas a shared EVS disk can be attached to up to 16 servers.
+For details about how to attach a shared EVS disk, see Attaching a Shared Disk.
+Because a shared EVS disk can be attached to multiple servers, ensure that the shared EVS disk is detached from all the servers before deletion.
+For details about how to delete a shared EVS disk, see Deleting an EVS Disk.
+Shared EVS disks must be expanded when they are in the Available state. For details, see Expanding Capacity for an Available EVS Disk.
+For more disk sharing FAQs, see Sharing.
+If a snapshot is no longer needed, you can delete the snapshot to release the virtual resources. Snapshot deletion has the following constraints:
+
in the upper left corner and select the desired region and project.The snapshot list page is displayed.
+
in front of each snapshot and click Delete in the upper area of the list.If the snapshot is no longer displayed in the snapshot list, the snapshot is deleted successfully.
+If the data on an EVS disk is incorrect or damaged, you can roll back the data from a snapshot to the source disk to restore data. Snapshot rollback has the following constraints:
+
in the upper left corner and select the desired region and project.The snapshot list page is displayed.
+This section describes how to create an EVS disk on the Snapshots page. Besides, you can also create an EVS disk from a snapshot by specifying the Create from snapshot parameter on the disk creation page. For details, see Create an EVS Disk.
+
in the upper left corner and select the desired region and project.The snapshot list page is displayed.
+
A maximum of 128 disks can be created from a snapshot.
+If you create a disk from a snapshot, the disk capacity must be greater than or equal to the snapshot size. In the condition that you do not specify the disk capacity, if the snapshot size is smaller than 10 GB, the default capacity 10 GB will be used as the disk capacity; if the snapshot size is greater than 10 GB, the disk capacity will be consistent with the snapshot size.
+When the disk status changes to Available, the disk is successfully created.
+This section is used to guide users to add a tag for an existing EVS disk. You can also add tags during the EVS disk creation. For details, see Create an EVS Disk.
+Tags are used to identify the cloud resources for purposes of easy categorization and quick search.
+
in the upper left corner and select the desired region and project.The disk list page is displayed.
+The disk details page is displayed.
+The Add Tag page is displayed.
+The Tags tab is displayed, and you can view the newly added tag.
+You can change the value of a tag for an existing disk, but cannot change the key of a tag.
+
in the upper left corner and select the desired region and project.The disk list page is displayed.
+The disk details page is displayed.
+The Edit Tag page is displayed.
+Return to the tag list. If the tag value is changed, the modification is complete.
+If an existing tag is no longer needed, you can delete it.
+
in the upper left corner and select the desired region and project.The disk list page is displayed.
+The disk details page is displayed.
+The Delete Tag page is displayed.
+Return to the tag list. If the tag is no longer displayed in the tag list, the deletion is successful.
+After a disk has been expanded on the management console, the disk size is enlarged, but the additional space cannot be used directly.
+In Linux, you must allocate the additional space to an existing partition or a new partition.
+
Performing the expansion operations with caution. Misoperation may lead to data loss or exceptions. Therefore, you are advised to back up the disk data using backups or snapshots before expansion. For details about backups, see Managing EVS Backup. For details about snapshots, see Creating a Snapshot.
+Originally, data disk /dev/sda has 50 GB and one partition (/dev/sda1), and then 50 GB is added to the disk. The following procedure shows you how to create a new MBR partition /dev/sda2 with this 50 GB.
+fdisk -l
+[root@ecs-scsi ~]# fdisk -l + +Disk /dev/vda: 42.9 GB, 42949672960 bytes, 83886080 sectors +Units = sectors of 1 * 512 = 512 bytes +Sector size (logical/physical): 512 bytes / 512 bytes +I/O size (minimum/optimal): 512 bytes / 512 bytes +Disk label type: dos +Disk identifier: 0x000bcb4e + + Device Boot Start End Blocks Id System +/dev/vda1 * 2048 83886079 41942016 83 Linux + +Disk /dev/sda: 107.4 GB, 107374182400 bytes, 209715200 sectors +Units = sectors of 1 * 512 = 512 bytes +Sector size (logical/physical): 512 bytes / 512 bytes +I/O size (minimum/optimal): 512 bytes / 512 bytes +Disk label type: dos +Disk identifier: 0x915ffe6a + + Device Boot Start End Blocks Id System +/dev/sda1 2048 104857599 52427776 83 Linux+
echo 1 > /sys/class/scsi_device/%d:%d:%d:%d/device/rescan &
+In the command, %d:%d:%d:%d indicates a folder in the /sys/class/scsi_device/ directory and can be obtained using ll /sys/class/scsi_device/.
+cs-xen-02:/sys/class/scsi_device # ll /sys/class/scsi_device/ +total 0 +lrwxrwxrwx 1 root root 0 Sep 26 11:37 2:0:0:0 -> ../../devices/xen/vscsi-2064/host2/target2:0:0/2:0:0:0/scsi_device/2:0:0:0+
In this example, run the following command:
+echo 1 > /sys/class/scsi_device/2:0:0:0/device/rescan &
+If the additional space is included, go to 3.
+fdisk Disk
+In this example, run the following command:
+fdisk /dev/sda
+[root@ecs-scsi ~]# fdisk /dev/sda +Welcome to fdisk (util-linux 2.23.2). + +Changes will remain in memory only, until you decide to write them. +Be careful before using the write command. + + +Command (m for help):+
Command (m for help): n +Partition type: + p primary (1 primary, 0 extended, 3 free) + e extended +Select (default p):+
If the MBR partition style is used, a maximum of 4 primary partitions, or 3 primary partitions and 1 extended partition can be created. The extended partition cannot be used directly and must be divided into logical partitions before use.
+Disk partitions created using GPT are not categorized.
+Select (default p): p +Partition number (2-4, default 2):+
Partition number indicates the serial number of the primary partition. Because partition number 1 has been used, the value ranges from 2 to 4.
+Partition number (2-4, default 2): 2 +First sector (104857600-209715199, default 104857600):+
First sector indicates the start sector. The value ranges from 104857600 to 209715199, and the default value is 104857600.
+The system displays the start and end sectors of the partition's available space. You can customize the value within this range or use the default value. The start sector must be smaller than the partition's end sector.
+First sector (104857600-209715199, default 104857600):
+Using default value 104857600
+Last sector, +sectors or +size{K,M,G} (104857600-209715199, default 209715199):
+Last sector indicates the end sector. The value ranges from 104857600 to 209715199, and the default value is 209715199.
+The system displays the start and end sectors of the partition's available space. You can customize the value within this range or use the default value. The start sector must be smaller than the partition's end sector.
+Last sector, +sectors or +size{K,M,G} (104857600-209715199, default 209715199):
+Using default value 209715199
+Partition 2 of type Linux and of size 50 GiB is set
+
+Command (m for help):
+Command (m for help): p + +Disk /dev/sda: 107.4 GB, 107374182400 bytes, 209715200 sectors +Units = sectors of 1 * 512 = 512 bytes +Sector size (logical/physical): 512 bytes / 512 bytes +I/O size (minimum/optimal): 512 bytes / 512 bytes +Disk label type: dos +Disk identifier: 0x915ffe6a + + Device Boot Start End Blocks Id System +/dev/sda1 2048 104857599 52427776 83 Linux +/dev/sda2 104857600 209715199 52428800 83 Linux + +Command (m for help):+
Command (m for help): w +The partition table has been altered! + +Calling ioctl() to re-read partition table. + +WARNING: Re-reading the partition table failed with error 16: Device or resource busy. +The kernel still uses the old table. The new table will be used at +the next reboot or after you run partprobe(8) or kpartx(8) +Syncing disks.+
In case that you want to discard the changes made before, you can exit fdisk by entering q.
+partprobe
+mkfs -t File system Disk partition
+[root@ecs-scsi ~]# mkfs -t ext4 /dev/sda2 +mke2fs 1.42.9 (28-Dec-2013) +Filesystem label= +OS type: Linux +Block size=4096 (log=2) +Fragment size=4096 (log=2) +Stride=0 blocks, Stripe width=0 blocks +3276800 inodes, 13107200 blocks +655360 blocks (5.00%) reserved for the super user +First data block=0 +Maximum filesystem blocks=2162163712 +400 block groups +32768 blocks per group, 32768 fragments per group +8192 inodes per group +Superblock backups stored on blocks: + 32768, 98304, 163840, 229376, 294912, 819200, 884736, 1605632, 2654208, + 4096000, 7962624, 11239424 + +Allocating group tables: done +Writing inode tables: done +Creating journal (32768 blocks): done +Writing superblocks and filesystem accounting information: done+
Information similar to the following is displayed:
+[root@ecs-scsi ~]# mkfs -t xfs /dev/sda2 +meta-data=/dev/sda2 isize=512 agcount=4, agsize=3276800 blks + = sectsz=512 attr=2, projid32bit=1 + = crc=1 finobt=0, sparse=0 +data = bsize=4096 blocks=13107200, imaxpct=25 + = sunit=0 swidth=0 blks +naming =version2 bsize=4096 ascii-ci=0 ftype=1 +log =internal log bsize=4096 blocks=6400, version=2 + = sectsz=512 sunit=0 blks, lazy-count=1 +realtime =none extsz=4096 blocks=0, rtextents=0+
The formatting takes a while, and you need to observe the system running status. Once done is displayed in the command output, the formatting is complete.
+Perform this step if you want to mount the partition on a new mount point.
+mkdir Mount point
+In this example, run the following command to create the /mnt/test mount point:
+mkdir /mnt/test
+mount Disk partition Mount point
+In this example, run the following command to mount the new partition /dev/sda2 on /mnt/test:
+mount /dev/sda2 /mnt/test
+
If the new partition is mounted on a directory that is not empty, the subdirectories and files in the directory will be hidden. Therefore, you are advised to mount the new partition on an empty directory or a new directory. If the new partition must be mounted on a directory that is not empty, move the subdirectories and files in this directory to another directory temporarily. After the partition is successfully mounted, move the subdirectories and files back.
+df -TH
+[root@ecs-scsi ~]# df -TH +Filesystem Type Size Used Avail Use% Mounted on +/dev/vda1 ext4 43G 2.0G 39G 5% / +devtmpfs devtmpfs 509M 0 509M 0% /dev +tmpfs tmpfs 520M 0 520M 0% /dev/shm +tmpfs tmpfs 520M 7.2M 513M 2% /run +tmpfs tmpfs 520M 0 520M 0% /sys/fs/cgroup +tmpfs tmpfs 104M 0 104M 0% /run/user/0 +/dev/sda1 ext4 53G 55M 50G 1% /mnt/sdc +/dev/sda2 ext4 53G 55M 50G 1% /mnt/test+
If the server is restarted, the mounting will become invalid. You can set automatic mounting for partitions at system start by modifying the /etc/fstab file. For details, see Setting Automatic Mounting at System Start.
+
If the additional space is allocated to an existing partition, data on the disk will not be cleared but you must use umount to unmount the existing partition. In this case, services will be affected.
+Originally, SCSI data disk /dev/sda has 100 GB and two partitions (/dev/sda1 and /dev/sda2), and then 50 GB is added to the disk. The following procedure shows you how to add this 50 GB to the existing MBR partition /dev/sda2.
+During an expansion, the additional space is added to the end of the disk. Therefore, if the disk has multiple partitions, the additional space can only be allocated to the partition at the disk end.
+fdisk -l
+[root@ecs-scsi ~]# fdisk -l + +Disk /dev/vda: 42.9 GB, 42949672960 bytes, 83886080 sectors +Units = sectors of 1 * 512 = 512 bytes +Sector size (logical/physical): 512 bytes / 512 bytes +I/O size (minimum/optimal): 512 bytes / 512 bytes +Disk label type: dos +Disk identifier: 0x000bcb4e + + Device Boot Start End Blocks Id System +/dev/vda1 * 2048 83886079 41942016 83 Linux + +Disk /dev/sda: 161.1 GB, 161061273600 bytes, 314572800 sectors +Units = sectors of 1 * 512 = 512 bytes +Sector size (logical/physical): 512 bytes / 512 bytes +I/O size (minimum/optimal): 512 bytes / 512 bytes +Disk label type: dos +Disk identifier: 0x915ffe6a + + Device Boot Start End Blocks Id System +/dev/sda1 2048 104857599 52427776 83 Linux +/dev/sda2 104857600 209715199 52428800 83 Linux+
In the command output, take note of the partition's start and end sectors. In this example, /dev/sda2's start sector is 104857600, and its end sector is 209715199.
+echo 1 > /sys/class/scsi_device/%d:%d:%d:%d/device/rescan &
+In the command, %d:%d:%d:%d indicates a folder in the /sys/class/scsi_device/ directory and can be obtained using ll /sys/class/scsi_device/.
+cs-xen-02:/sys/class/scsi_device # ll /sys/class/scsi_device/ +total 0 +lrwxrwxrwx 1 root root 0 Sep 26 11:37 2:0:0:0 -> ../../devices/xen/vscsi-2064/host2/target2:0:0/2:0:0:0/scsi_device/2:0:0:0+
In this example, run the following command:
+echo 1 > /sys/class/scsi_device/2:0:0:0/device/rescan &
+If the additional space is included, take note of the start and end sectors of the target partition and then go to 3. These values will be used in the subsequent operations.
+umount Disk partition
+In this example, run the following command:
+umount /dev/sda2
+fdisk Disk
+In this example, run the following command:
+fdisk /dev/sda
+[root@ecs-scsi ~]# fdisk /dev/sda +Welcome to fdisk (util-linux 2.23.2). + +Changes will remain in memory only, until you decide to write them. +Be careful before using the write command. + + +Command (m for help):+
Command (m for help): d +Partition number (1,2, default 2):+
Partition number (1,2, default 2): 2 +Partition 2 is deleted + +Command (m for help):+
After deleting the partition, recreate the partition according to the following steps, and data on this disk will not be lost.
+Command (m for help): n +Partition type: + p primary (1 primary, 0 extended, 3 free) + e extended +Select (default p):+
If the MBR partition style is used, a maximum of 4 primary partitions, or 3 primary partitions and 1 extended partition can be created. The extended partition cannot be used directly and must be divided into logical partitions before use.
+Disk partitions created using GPT are not categorized.
+Select (default p): p +Partition number (2-4, default 2):+
Partition number indicates the serial number of the primary partition.
+Partition number (2-4, default 2): 2 +First sector (104857600-314572799, default 104857600):+
In the command output, First sector specifies the start sector.
+
First sector (104857600-314572799, default 104857600):
+Using default value 104857600
+Last sector, +sectors or +size{K,M,G} (104857600-314572799, default 314572799):
+In the command output, Last sector specifies the end sector.
+Last sector, +sectors or +size{K,M,G} (104857600-314572799, default 314572799):
+Using default value 314572799
+Partition 2 of type Linux and of size 100 GiB is set
+
+Command (m for help):
+The partition is created.
+Information similar to the following is displayed:
+Command (m for help): p + +Disk /dev/sda: 161.1 GB, 161061273600 bytes, 314572800 sectors +Units = sectors of 1 * 512 = 512 bytes +Sector size (logical/physical): 512 bytes / 512 bytes +I/O size (minimum/optimal): 512 bytes / 512 bytes +Disk label type: dos +Disk identifier: 0x915ffe6a + + Device Boot Start End Blocks Id System +/dev/sda1 2048 104857599 52427776 83 Linux +/dev/sda2 104857600 314572799 104857600 83 Linux + +Command (m for help):+
Command (m for help): w +The partition table has been altered! + +Calling ioctl() to re-read partition table. + +WARNING: Re-reading the partition table failed with error 16: Device or resource busy. +The kernel still uses the old table. The new table will be used at +the next reboot or after you run partprobe(8) or kpartx(8) +Syncing disks.+
In case that you want to discard the changes made before, you can exit fdisk by entering q.
+partprobe
+In this example, run the following command:
+e2fsck -f /dev/sda2
+[root@ecs-scsi ~]# e2fsck -f /dev/sda2 +e2fsck 1.42.9 (28-Dec-2013) +Pass 1: Checking inodes, blocks, and sizes +Pass 2: Checking directory structure +Pass 3: Checking directory connectivity +Pass 4: Checking reference counts +Pass 5: Checking group summary information +/dev/sda2: 11/3276800 files (0.0% non-contiguous), 251790/13107200 blocks+
In this example, run the following command:
+resize2fs /dev/sda2
+[root@ecs-scsi ~]# resize2fs /dev/sda2 +resize2fs 1.42.9 (28-Dec-2013) +Resizing the filesystem on /dev/sda2 to 26214400 (4k) blocks. +The filesystem on /dev/sda2 is now 26214400 blocks long.+
Perform this step if you want to mount the partition on a new mount point.
+mkdir Mount point
+In this example, run the following command to create the /mnt/test mount point:
+mkdir /mnt/test
+mount Disk partition Mount point
+In this example, run the following command to mount the partition /dev/sda2 on /mnt/test:
+mount /dev/sda2 /mnt/test
+
If the new partition is mounted on a directory that is not empty, the subdirectories and files in the directory will be hidden. Therefore, you are advised to mount the new partition on an empty directory or a new directory. If the new partition must be mounted on a directory that is not empty, move the subdirectories and files in this directory to another directory temporarily. After the partition is successfully mounted, move the subdirectories and files back.
+Perform this step if you want to mount the partition on a new mount point.
+mkdir Mount point
+In this example, run the following command to create the /mnt/test mount point:
+mkdir /mnt/test
+mount Disk partition Mount point
+In this example, run the following command to mount the partition /dev/sda2 on /mnt/test:
+mount /dev/sda2 /mnt/test
+
If the new partition is mounted on a directory that is not empty, the subdirectories and files in the directory will be hidden. Therefore, you are advised to mount the new partition on an empty directory or a new directory. If the new partition must be mounted on a directory that is not empty, move the subdirectories and files in this directory to another directory temporarily. After the partition is successfully mounted, move the subdirectories and files back.
+sudo xfs_growfs Disk partition
+In this example, run the following command:
+sudo xfs_growfs /dev/sda2
+Information similar to the following is displayed:
+[root@ecs-scsi ~]# sudo xfs_growfs /dev/sda2 +meta-data=/dev/sda2 isize=512 agcount=4, agsize=3276800 blks + = sectsz=512 attr=2, projid32bit=1 + = crc=1 finobt=0, spinodes=0 +data = bsize=4096 blocks=13107200, imaxpct=25 + = sunit=0 swidth=0 blks +naming =version2 bsize=4096 ascii-ci=0 ftype=1 +log =internal bsize=4096 blocks=6400, version=2 + = sectsz=512 sunit=0 blks, lazy-count=1 +realtime =none extsz=4096 blocks=0, rtextents=0 +data blocks changed from 13107200 to 26214400df .+
df -TH
+Information similar to the following is displayed:
+[root@ecs-scsi ~]# df -TH +Filesystem Type Size Used Avail Use% Mounted on +/dev/vda1 ext4 43G 2.0G 39G 5% / +devtmpfs devtmpfs 509M 0 509M 0% /dev +tmpfs tmpfs 520M 0 520M 0% /dev/shm +tmpfs tmpfs 520M 7.2M 513M 2% /run +tmpfs tmpfs 520M 0 520M 0% /sys/fs/cgroup +tmpfs tmpfs 104M 0 104M 0% /run/user/0 +/dev/sda1 ext4 53G 55M 50G 1% /mnt/sdc +/dev/sda2 ext4 106G 63M 101G 1% /mnt/test+
If the server is restarted, the mounting will become invalid. You can set automatic mounting for partitions at system start by modifying the /etc/fstab file. For details, see Setting Automatic Mounting at System Start.
+Modify the fstab file to set automatic disk mounting at server start. You can also set automatic mounting for the servers containing data. This operation will not affect the existing data.
+The following procedure shows how to set automatic disk mounting at server start by using UUIDs to identify disks in the fstab file. You are advised not to use device names to identify disks in the file because a device name may change (for example, from /dev/vdb1 to /dev/vdb2) during the server stop or start, resulting in improper server running after restart.
+
UUID is the unique character string for disk partitions in a Linux system.
+blkid Disk partition
+In this example, run the following command to query the UUID of the /dev/vdb1 partition:
+blkid /dev/vdb1
+Information similar to the following is displayed:
+[root@ecs-test-0001 ~]# blkid /dev/vdb1 +/dev/vdb1: UUID="0b3040e2-1367-4abb-841d-ddb0b92693df" TYPE="ext4"+
The UUID of the /dev/vdb1 partition is displayed.
+vi /etc/fstab
+UUID=0b3040e2-1367-4abb-841d-ddb0b92693df /mnt/sdc ext4 defaults 0 2+
The system saves the configurations and exits the vi editor.
+In this example, run the following command:
+umount /dev/vdb1
+mount -a
+In this example, run the following command:
+mount | grep /mnt/sdc
+If information similar to the following is displayed, the automatic mounting function takes effect:
+root@ecs-test-0001 ~]# mount | grep /mnt/sdc +/dev/vdb1 on /mnt/sdc type ext4 (rw,relatime,data=ordered)+
Tags can be used to categorize EVS disks, and users can quickly search for their desired EVS disks by tags. This section is used to guide users to search for EVS disk by existing tags.
+
in the upper left corner and select the desired region and project.The disk list page is displayed.
+The Search by Tag page is displayed.
+
to add tags.A maximum of 10 tags can be added at a time.
+For the added tags, you can delete them individually or click Reset to clear all of them.
+Disks owning the added tags are displayed in the list, and the search is complete.
+For more use methods of EVS replication, see Managing EVS Replication (Deprecated).
+
EVS replication APIs have been deprecated. If you need to use the replication function, see Storage Disaster Recovery Service User Guide and Storage Disaster Recovery Service API Reference.
+Cloud Disk Backup provided by Cloud Backup and Recovery (CBR) allows you to create backups for your EVS disks while servers are running. If data loss or damage occurred due to virus invasions, misoperations, or software and hardware faults, you can use backups to restore data, guaranteeing your data integrity and security.
+For more information, see the Cloud Backup and Recovery User Guide.
+Create and apply backup policies to schedule periodic backups for your EVS disks. You can use the backup data to create new EVS disks or restore to source disks.
+For how to back up EVS disks, see Managing EVS Backup or the Cloud Backup and Recovery User Guide.
+Before you create an EVS replication pair, create a DR ECS in the secondary AZ for the production ECS. The DR ECS parameters must be consistent with those of the production ECS. The parameters include the ECS specifications and the parameters of the production ECS's EVS disks, subnet, and security group.
+If a large number of physical resources in the primary AZ are faulty due to force majeure, you can attach DR disks in the secondary AZ to DR ECSs and use DR disks to ensure the service availability and continuity.
+
EVS replication APIs have been deprecated. If you need to use the replication function, see Storage Disaster Recovery Service User Guide and Storage Disaster Recovery Service API Reference.
+
in the upper left corner and select the desired region and project.The Elastic Cloud Server page is displayed.
+The ECS details page is displayed.
+
The listed parameter values are for reference only.
+Production Resource + |
+Parameter + |
+Example Value + |
+
|---|---|---|
ECS + |
+VPC + |
+vpc-001 + |
+
ECS type + |
+General-purpose + |
+|
Specification + |
+s2.xlarge.2 + |
+|
vCPU + |
+4 cores + |
+|
Memory + |
+8 GB + |
+|
Image + |
+CentOS 7.2 64bit + |
+|
AZ + |
+AZ1 + |
+|
EVS disk + |
+Quantity + |
+
|
+
Capacity + |
+
|
+|
Disk type + |
+
|
+|
Disk sharing + |
+
|
+|
Device type + |
+
|
+|
Others + |
+Private IP address + |
+192.168.12.2 + |
+
Security group + |
+Sys-default + |
+|
Virtual IP address + |
+192.168.12.23 + |
+
For details, see Creating an ECS in the Elastic Cloud Server User Guide.
+
Check the parameter values carefully and ensure that information of the DR ECS and production ECS is consistent.
+Stopping the DR ECS prevents it from being incorrectly used.
+
When the DR ECS is not stopped and its system disk is used to create an EVS replication pair, the DR ECS status will change to REBUILDING. In this state, you cannot stop the DR ECS, detach EVS disks from it, or expand its EVS disks.
+This section is used to guide users to collect the production ECS and DR ECS information, including the ECS IDs and the IDs of the EVS disks attached the ECSs.
+Two EVS disks form an EVS replication pair. Therefore, the production disk ID, DR disk ID, and EVS replication pair ID can be used to identify disks and the EVS replication pair.
+
EVS replication APIs have been deprecated. If you need to use the replication function, see Storage Disaster Recovery Service User Guide and Storage Disaster Recovery Service API Reference.
+
in the upper left corner and select the desired region and project.The Elastic Cloud Server page is displayed.
+The ECS details page is displayed.
+
to view the details of the corresponding disk and take note of all the production disk IDs.You need to take note of the IDs of all the system disks and data disks attached to the production ECS.
+Example ID: ce86f381-99dc-422c-bb10-8014604cf5b9
+
to view the private IP address, elastic IP address (EIP), virtual IP address, and MAC address of a production NIC and take note of the private IP addresses, EIPs, virtual IP addresses, and MAC addresses of all NICs accordingly.You need to take note of IP addresses of all NICs bound to the production ECS.
+Example addresses: 192.168.xx.xx, 10.154.xx.xx, 192.168.xx.xx, {mac}
+
Replace {mac} with the MAC address during operation.
+Before you use EVS replication, bind a virtual IP address to the production server and DR server, respectively. Then configure the virtual IP address as the static IP address for the servers. This virtual IP address is used to access applications on servers.
+
EVS replication APIs have been deprecated. If you need to use the replication function, see Storage Disaster Recovery Service User Guide and Storage Disaster Recovery Service API Reference.
+You have obtained the VPC, subnet, MAC address, and virtual IP address of the production server. For details, see Collecting ECS Information (Deprecated).
+The following operations are for reference only. For details, see Assigning a Virtual IP Address in the Virtual Private Cloud User Guide.
+
in the upper left corner and select the desired region and project.The Elastic Cloud Server page is displayed.
+The ECS details page is displayed.
+The Virtual Private Cloud page is displayed.
+The VPC details page is displayed.
+The subnet details page is displayed.
+After the virtual IP address is bound with the DR server, the subnet details page is displayed.
+After the application succeeds, you can view the virtual IP address in the virtual IP address list.
+
When assigning the virtual IP address, you can select the Automatic or Manual mode based on your service requirements.
+After the virtual IP address is bound with the production server, the subnet details page is displayed.
+After the virtual IP address is bound with the DR server, the subnet details page is displayed.
+
The configuration method varies depending on the server OS. This document is used for reference only. For the detailed operations and differences, see the corresponding OS documents.
+For the Windows OS, see the Microsoft official documentation.
+You can obtain the NIC name using the NIC IP address recorded in 9. In this example, the NIC name is eth0.
+cp eth0 eth0:1
+vi ifcfg-eth0:1
+BOOTPROTO=static +DEVICE=eth0:1 +NAME=eth0:1 +ONBOOT=yes +TYPE=Ethernet +USERCTL=no +IPADDR=192.168.0.176 +NETMASK=255.255.255.0+
The system saves the configurations and exits the vi editor.
+rm Name of the unnecessary NIC file
+For example, run the following command:
+rm ifcfg-eth1
+
Before deleting the unnecessary NIC files, you are advised to back up the files.
+If multiple unnecessary NIC files exist, delete them individually. Ensure that the /etc/sysconfig/network-scripts directory contains only the in-use NIC file.
+vi /etc/udev/rules.d/70-persistent-ipoib.rules
+ACTION=="add", SUBSYSTEM=="net", DRIVERS=="?*", ATTR{type}=="32", ATTR{address}=={mac}, NAME="eth0"
+ACTION=="add", SUBSYSTEM=="net", DRIVERS=="?*", ATTR{type}=="32", ATTR{address}=={mac}, NAME="eth1"
+
+ACTION=="add", SUBSYSTEM=="net", DRIVERS=="?*", ATTR{type}=="32", ATTR{address}=={mac}, NAME="eth0"
+ACTION=="add", SUBSYSTEM=="net", DRIVERS=="?*", ATTR{type}=="32", ATTR{address}=={mac}, NAME="eth1"
+Configuration descriptions of the ATTR{address} and NAME fields:
+
a. Ensure that the NAME (NIC name) values of the production and DR servers are consistent. The ATTR{address} (MAC address) value can be obtained in Collecting ECS Information (Deprecated).
+b. Replace {mac} with the MAC address during operation.
+The system saves the configurations and exits the vi editor.
+Currently, users need to make API calls to create EVS replication pairs. Each server can have multiple EVS replication pairs. For details, see EVS Replication Pair in the Elastic Volume Service API Reference.
+If a production disk needs to be deleted after it has been used together with its DR disk to create an EVS replication pair, delete the EVS replication pair first and then delete the production disk and DR disk. For details, see Deleting an EVS Replication Pair in the Elastic Volume Service API Reference.
+
EVS replication APIs have been deprecated. If you need to use the replication function, see Storage Disaster Recovery Service User Guide and Storage Disaster Recovery Service API Reference.
+For details, see Creating an EVS Replication Pair in the Elastic Volume Service API Reference.
+For details, see Querying Details About an EVS Replication Pair in the Elastic Volume Service API Reference.
+If the EVS replication pair status changes to available, the creation is successful.
+
Two EVS disks form an EVS replication pair. Therefore, the production disk ID, DR disk ID, and EVS replication pair ID can be used to identify disks and the EVS replication pair.
+Currently, users need to make API calls to create replication consistency groups and add EVS replication pairs to the groups. For details, see Replication Consistency Group in the Elastic Volume Service API Reference.
+A replication consistency group is composed of EVS replication pairs from a group of servers. These servers may run applications that are strongly correlated with each other and require unified management and application consistency. In this case, you can first create EVS replication pairs using the disks attached to these servers, then add these EVS replication pairs to a replication consistency group to facilitate management and consistency. Figure 1 shows the relationship between EVS replication pairs and replication consistency groups. If you have performed an operation to a replication consistency group, all EVS replication pairs in this group are affected.
+ +Existing EVS replication pairs can be added to a replication consistency group upon the group creation. To add EVS replication pairs to or remove them from a replication consistency group after the group creation, see Updating a Replication Consistency Group (Deprecated).
+
EVS replication APIs have been deprecated. If you need to use the replication function, see Storage Disaster Recovery Service User Guide and Storage Disaster Recovery Service API Reference.
+For details, see Creating a Replication Consistency Group in the Elastic Volume Service API Reference.
+For details, see Querying Details About a Replication Consistency Group in the Elastic Volume Service API Reference.
+When the consistency group status changes to available, the creation is successful.
+
For details about how to obtain the production server ID and DR server ID, see Collecting ECS Information (Deprecated).
+For details, see Synchronizing a Replication Consistency Group in the Elastic Volume Service API Reference.
+For details, see Querying Details About a Replication Consistency Group in the Elastic Volume Service API Reference.
+When the replication status of the replication consistency group changes to active, the data in all EVS replication pairs of this group has been synchronized.
+
The time required for the initial data synchronization within a replication consistency group varies depending on the number of the EVS replication pairs in the group, EVS disk capacity, and actual data amount. Normally, the initial data synchronization takes a relative long period of time. Please wait patiently.
+Currently, EVS replication pairs can be added to or removed from replication consistency groups through APIs only. For details, see Updating a Replication Consistency Group in the Elastic Volume Service API Reference.
+If an EVS replication pair needs to be deleted after it has been added to a replication consistency group, remove this EVS replication pair from the group first, delete this EVS replication pair, and then delete the production disk and DR disk. For details, see Deleting an EVS Replication Pair and Deleting a Replication Consistency Group in the Elastic Volume Service API Reference.
+
EVS replication APIs have been deprecated. If you need to use the replication function, see Storage Disaster Recovery Service User Guide and Storage Disaster Recovery Service API Reference.
+The replication consistency group status is available.
+For details, see Pausing a Replication Consistency Group in the Elastic Volume Service API Reference.
+
Pausing a replication consistency group means that the data synchronization within the group is paused. Therefore, the data between production disks and DR disks will be temporarily inconsistent and needs to be synchronized after the replication consistency group update is complete.
+For details, see Updating a Replication Consistency Group in the Elastic Volume Service API Reference.
+For details, see Synchronizing a Replication Consistency Group in the Elastic Volume Service API Reference.
+For details, see Querying Details About a Replication Consistency Group in the Elastic Volume Service API Reference.
+When the replication status of the replication consistency group changes to active, the data in all EVS replication pairs of this group has been synchronized.
+Production servers and production disks belong to the primary AZ, and DR servers and DR disks belong to the secondary AZ. Users can make API calls to perform a planned migration, for example, perform a primary/secondary AZ switchover for the replication consistency group and enable the servers and disks in the secondary AZ.
+
EVS replication APIs have been deprecated. If you need to use the replication function, see Storage Disaster Recovery Service User Guide and Storage Disaster Recovery Service API Reference.
+For details, see Performing a Primary/Secondary Switchover for a Replication Consistency Group in the Elastic Volume Service API Reference.
+
Performing a primary/secondary switchover for a replication consistency group takes a relative long period of time, and it takes about 10 seconds for the system to respond the request.
+When the production servers and disks in the primary AZ become faulty due to force majeure, users can make API calls to perform a failover for the replication consistency group and enable the DR servers and disks in the secondary AZ to ensure the service continuity.
+
EVS replication APIs have been deprecated. If you need to use the replication function, see Storage Disaster Recovery Service User Guide and Storage Disaster Recovery Service API Reference.
+Confirm with the customer service that servers and disks in the production AZ are faulty, and the deployed services are unavailable.
+For details, see Performing a Failover for a Replication Consistency Group in the Elastic Volume Service API Reference.
+When the production servers and disks in the primary AZ become faulty due to force majeure and a failover has been performed, enable the DR servers and disks to provide services. After the fault in the faulty AZ has been restored, users can make API calls to reprotect a replication consistency group, that is, to enable the restored resources in the faulty AZ to function as DR servers and DR disks.
+
EVS replication APIs have been deprecated. If you need to use the replication function, see Storage Disaster Recovery Service User Guide and Storage Disaster Recovery Service API Reference.
+For details, see Reprotecting a Replication Consistency Group in the Elastic Volume Service API Reference.
+For details, see Querying Details About a Replication Consistency Group in the Elastic Volume Service API Reference.
+After the request has been delivered, the replication status of the replication consistency group changes to copying. Once the replication status changes to active, the data synchronization is complete.
+
The time required for the data synchronization within a replication consistency group varies depending on the number of EVS replication pairs in the group, EVS disk capacity, and amount of differential data generated after a primary AZ fault occurred. Normally, the data synchronization of a reprotection takes a relative long period of time. Please wait patiently.
+This section uses CentOS 7.4 64bit to describe how to initialize a data disk attached to a server running Linux and use fdisk to partition the data disk.
+The maximum disk capacity supported by MBR is 2 TB, and that supported by GPT is 18 EB. Therefore, use the GPT partition style if your disk capacity is larger than 2 TB. In Linux, if you choose to use the GPT partition style, the fdisk partitioning tool cannot be used. Use the parted partitioning tool instead. For details about disk partition styles, see Introduction to Data Disk Initialization Scenarios and Partition Styles.
+The method for initializing a disk varies depending on the OS running on the server. This document is used for reference only. For the detailed operations and differences, see the product documents of the corresponding OS.
+The following example shows you how a new primary partition can be created on a new data disk that has been attached to a server. The primary partition will be created using fdisk, and MBR is the default partition style. Furthermore, the partition will be formatted using the ext4 file system, mounted on /mnt/sdc, and configured with automatic mounting at system start.
+fdisk -l
+[root@ecs-test-0001 ~]# fdisk -l + +Disk /dev/vda: 42.9 GB, 42949672960 bytes, 83886080 sectors +Units = sectors of 1 * 512 = 512 bytes +Sector size (logical/physical): 512 bytes / 512 bytes +I/O size (minimum/optimal): 512 bytes / 512 bytes +Disk label type: dos +Disk identifier: 0x000bcb4e + + Device Boot Start End Blocks Id System +/dev/vda1 * 2048 83886079 41942016 83 Linux + +Disk /dev/vdb: 107.4 GB, 107374182400 bytes, 209715200 sectors +Units = sectors of 1 * 512 = 512 bytes +Sector size (logical/physical): 512 bytes / 512 bytes +I/O size (minimum/optimal): 512 bytes / 512 bytes+
In the command output, the server contains two disks. /dev/vda is the system disk, and /dev/vdb is the new data disk.
+fdisk New data disk
+In this example, run the following command:
+fdisk /dev/vdb
+[root@ecs-test-0001 ~]# fdisk /dev/vdb +Welcome to fdisk (util-linux 2.23.2). + +Changes will remain in memory only, until you decide to write them. +Be careful before using the write command. + +Device does not contain a recognized partition table +Building a new DOS disklabel with disk identifier 0x38717fc1. + +Command (m for help):+
Command (m for help): n +Partition type: + p primary (0 primary, 0 extended, 4 free) + e extended+
If the MBR partition style is used, a maximum of 4 primary partitions, or 3 primary partitions and 1 extended partition can be created. The extended partition cannot be used directly and must be divided into logical partitions before use.
+Disk partitions created using GPT are not categorized.
+Select (default p): p +Partition number (1-4, default 1):+
Partition number indicates the serial number of the primary partition. The value ranges from 1 to 4.
+Partition number (1-4, default 1): 1 +First sector (2048-209715199, default 2048):+
First sector indicates the start sector. The value ranges from 2048 to 209715199, and the default value is 2048.
+The system displays the start and end sectors of the partition's available space. You can customize the value within this range or use the default value. The start sector must be smaller than the partition's end sector.
+First sector (2048-209715199, default 2048):
+Using default value 2048
+Last sector, +sectors or +size{K,M,G} (2048-209715199, default 209715199):
+Last sector indicates the end sector. The value ranges from 2048 to 209715199, and the default value is 209715199.
+The system displays the start and end sectors of the partition's available space. You can customize the value within this range or use the default value. The start sector must be smaller than the partition's end sector.
+Information similar to the following is displayed:
+Last sector, +sectors or +size{K,M,G} (2048-209715199, default 209715199):
+Using default value 209715199
+Partition 1 of type Linux and of size 100 GiB is set
+
+Command (m for help):
+A primary partition has been created for the new data disk.
+Command (m for help): p + +Disk /dev/vdb: 107.4 GB, 107374182400 bytes, 209715200 sectors +Units = sectors of 1 * 512 = 512 bytes +Sector size (logical/physical): 512 bytes / 512 bytes +I/O size (minimum/optimal): 512 bytes / 512 bytes +Disk label type: dos +Disk identifier: 0x38717fc1 + + Device Boot Start End Blocks Id System +/dev/vdb1 2048 209715199 104856576 83 Linux + +Command (m for help):+
Details about the /dev/vdb1 partition are displayed.
+Command (m for help): w +The partition table has been altered! + +Calling ioctl() to re-read partition table. +Syncing disks.+
The partition is created.
+
In case that you want to discard the changes made before, you can exit fdisk by entering q.
+partprobe
+mkfs -t File system format /dev/vdb1
+In this example, run the following command to set the ext4 file system for the new partition:
+mkfs -t ext4 /dev/vdb1
+[root@ecs-test-0001 ~]# mkfs -t ext4 /dev/vdb1 +mke2fs 1.42.9 (28-Dec-2013) +Filesystem label= +OS type: Linux +Block size=4096 (log=2) +Fragment size=4096 (log=2) +Stride=0 blocks, Stripe width=0 blocks +6553600 inodes, 26214144 blocks +1310707 blocks (5.00%) reserved for the super user +First data block=0 +Maximum filesystem blocks=2174746624 +800 block groups +32768 blocks per group, 32768 fragments per group +8192 inodes per group +Superblock backups stored on blocks: + 32768, 98304, 163840, 229376, 294912, 819200, 884736, 1605632, 2654208, + 4096000, 7962624, 11239424, 20480000, 23887872 + +Allocating group tables: done +Writing inode tables: done +Creating journal (32768 blocks): done +Writing superblocks and filesystem accounting information: done+
The formatting takes a period of time. Observe the system running status and do not exit.
+
The partition sizes supported by file systems vary. Therefore, you are advised to choose an appropriate file system based on your service requirements.
+mkdir Mount point
+In this example, run the following command to create the /mnt/sdc mount point:
+mkdir /mnt/sdc
+mount Disk partition Mount point
+In this example, run the following command to mount the new partition /dev/vdb1 on /mnt/sdc:
+mount /dev/vdb1 /mnt/sdc
+df -TH
+Information similar to the following is displayed:
+[root@ecs-test-0001 ~]# df -TH +Filesystem Type Size Used Avail Use% Mounted on +/dev/vda1 ext4 43G 1.9G 39G 5% / +devtmpfs devtmpfs 2.0G 0 2.0G 0% /dev +tmpfs tmpfs 2.0G 0 2.0G 0% /dev/shm +tmpfs tmpfs 2.0G 9.1M 2.0G 1% /run +tmpfs tmpfs 2.0G 0 2.0G 0% /sys/fs/cgroup +tmpfs tmpfs 398M 0 398M 0% /run/user/0 +/dev/vdb1 ext4 106G 63M 101G 1% /mnt/sdc+
New partition /dev/vdb1 is mounted on /mnt/sdc.
+
If the server is restarted, the mounting will become invalid. You can set automatic mounting for partitions at system start by modifying the /etc/fstab file. For details, see Setting Automatic Mounting at System Start.
+Modify the fstab file to set automatic disk mounting at server start. You can also set automatic mounting for the servers containing data. This operation will not affect the existing data.
+The following procedure shows how to set automatic disk mounting at server start by using UUIDs to identify disks in the fstab file. You are advised not to use device names to identify disks in the file because a device name may change (for example, from /dev/vdb1 to /dev/vdb2) during the server stop or start, resulting in improper server running after restart.
+
UUID is the unique character string for disk partitions in a Linux system.
+blkid Disk partition
+In this example, run the following command to query the UUID of the /dev/vdb1 partition:
+blkid /dev/vdb1
+Information similar to the following is displayed:
+[root@ecs-test-0001 ~]# blkid /dev/vdb1 +/dev/vdb1: UUID="0b3040e2-1367-4abb-841d-ddb0b92693df" TYPE="ext4"+
The UUID of the /dev/vdb1 partition is displayed.
+vi /etc/fstab
+UUID=0b3040e2-1367-4abb-841d-ddb0b92693df /mnt/sdc ext4 defaults 0 2+
The system saves the configurations and exits the vi editor.
+In this example, run the following command:
+umount /dev/vdb1
+mount -a
+In this example, run the following command:
+mount | grep /mnt/sdc
+If information similar to the following is displayed, the automatic mounting function takes effect:
+root@ecs-test-0001 ~]# mount | grep /mnt/sdc +/dev/vdb1 on /mnt/sdc type ext4 (rw,relatime,data=ordered)+
This section uses CentOS 7.4 64bit to describe how to initialize a data disk attached to a server running Linux and use parted to partition the data disk.
+The maximum disk capacity supported by MBR is 2 TB, and that supported by GPT is 18 EB. Therefore, use the GPT partition style if your disk capacity is larger than 2 TB. In Linux, if you choose to use the GPT partition style, the fdisk partitioning tool cannot be used. Use the parted partitioning tool instead. For details about disk partition styles, see Introduction to Data Disk Initialization Scenarios and Partition Styles.
+The method for initializing a disk varies depending on the OS running on the server. This document is used for reference only. For the detailed operations and differences, see the product documents of the corresponding OS.
+The following example shows you how a new partition can be created on a new data disk that has been attached to a server. The partition will be created using parted, and GPT is used as the partition style. Furthermore, the partition will be formatted using the ext4 file system, mounted on /mnt/sdc, and configured automatic mounting at system start.
+lsblk
+root@ecs-test-0001 ~]# lsblk +NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINT +vda 253:0 0 40G 0 disk +└─vda1 253:1 0 40G 0 part / +vdb 253:16 0 100G 0 disk+
In the command output, the server contains two disks. /dev/vda is the system disk, and /dev/vdb is the new data disk.
+parted New data disk
+In this example, run the following command:
+parted /dev/vdb
+[root@ecs-test-0001 ~]# parted /dev/vdb +GNU Parted 3.1 +Using /dev/vdb +Welcome to GNU Parted! Type 'help' to view a list of commands. +(parted)+
(parted) p +Error: /dev/vdb: unrecognised disk label +Model: Virtio Block Device (virtblk) +Disk /dev/vdb: 107GB +Sector size (logical/physical): 512B/512B +Partition Table: unknown +Disk Flags: +(parted)+
In the command output, the Partition Table value is unknown, indicating that no partition style is set for the new disk.
+mklabel Disk partition style
+In this example, run the following command to set the partition style to GPT: (Disk partition styles can be MBR or GPT.)
+mklabel gpt
+
The maximum disk capacity supported by MBR is 2 TB, and that supported by GPT is 18 EB. Because a data disk currently supports up to 32 TB, use the GPT partition style if your disk capacity is larger than 2 TB.
+If you change the disk partition style after the disk has been used, the data on the disk will be cleared. Therefore, select a proper disk partition style when initializing the disk.
+(parted) mklabel gpt +(parted) p +Model: Virtio Block Device (virtblk) +Disk /dev/vdb: 107GB +Sector size (logical/physical): 512B/512B +Partition Table: gpt +Disk Flags: + +Number Start End Size File system Name Flags + +(parted)+
In the command output, the Partition Table value is gpt, indicating that the disk partition style is GPT.
+mkpart Partition name Start sector End sector
+In this example, run the following command:
+mkpart test 2048s 100%
+In this example, one partition is created for the new data disk. Variable 2048s indicates the disk start sector, and variable 100% indicates the disk end sector. The two values are used for reference only. You can determine the number of partitions and the partition size based on your service requirements.
+(parted) mkpart opt 2048s 100% +(parted)+
(parted) p +Model: Virtio Block Device (virtblk) +Disk /dev/vdb: 209715200s +Sector size (logical/physical): 512B/512B +Partition Table: gpt +Disk Flags: + +Number Start End Size File system Name Flags + 1 2048s 209713151s 209711104s test + +(parted)+
(parted) q +Information: You may need to update /etc/fstab.+
You can set automatic disk mounting by updating the /etc/fstab file. Before updating the file, set the file system format for the partition and mount the partition on the mount point.
+lsblk
+[root@ecs-test-0001 ~]# lsblk +NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINT +vda 253:0 0 40G 0 disk +└─vda1 253:1 0 40G 0 part / +vdb 253:16 0 100G 0 disk +└─vdb1 253:17 0 100G 0 part+
In the command output, /dev/vdb1 is the partition you created.
+mkfs -t File system format /dev/vdb1
+In this example, run the following command to set the ext4 file system for the new partition:
+mkfs -t ext4 /dev/vdb1
+[root@ecs-test-0001 ~]# mkfs -t ext4 /dev/vdb1 +mke2fs 1.42.9 (28-Dec-2013) +Filesystem label= +OS type: Linux +Block size=4096 (log=2) +Fragment size=4096 (log=2) +Stride=0 blocks, Stripe width=0 blocks +6553600 inodes, 26213888 blocks +1310694 blocks (5.00%) reserved for the super user +First data block=0 +Maximum filesystem blocks=2174746624 +800 block groups +32768 blocks per group, 32768 fragments per group +8192 inodes per group +Superblock backups stored on blocks: + 32768, 98304, 163840, 229376, 294912, 819200, 884736, 1605632, 2654208, + 4096000, 7962624, 11239424, 20480000, 23887872 + +Allocating group tables: done +Writing inode tables: done +Creating journal (32768 blocks): done +Writing superblocks and filesystem accounting information: done+
The formatting takes a period of time. Observe the system running status and do not exit.
+
The partition sizes supported by file systems vary. Therefore, you are advised to choose an appropriate file system based on your service requirements.
+mkdir Mount point
+In this example, run the following command to create the /mnt/sdc mount point:
+mkdir /mnt/sdc
+mount Disk partition Mount point
+In this example, run the following command to mount the new partition /dev/vdb1 on /mnt/sdc:
+mount /dev/vdb1 /mnt/sdc
+df -TH
+Information similar to the following is displayed:
+[root@ecs-test-0001 ~]# df -TH +Filesystem Type Size Used Avail Use% Mounted on +/dev/vda1 ext4 43G 1.9G 39G 5% / +devtmpfs devtmpfs 2.0G 0 2.0G 0% /dev +tmpfs tmpfs 2.0G 0 2.0G 0% /dev/shm +tmpfs tmpfs 2.0G 9.0M 2.0G 1% /run +tmpfs tmpfs 2.0G 0 2.0G 0% /sys/fs/cgroup +tmpfs tmpfs 398M 0 398M 0% /run/user/0 +/dev/vdb1 ext4 106G 63M 101G 1% /mnt/sdc+
New partition /dev/vdb1 is mounted on /mnt/sdc.
+
If the server is restarted, the mounting will become invalid. You can set automatic mounting for partitions at system start by modifying the /etc/fstab file. For details, see Setting Automatic Mounting at System Start.
+Modify the fstab file to set automatic disk mounting at server start. You can also set automatic mounting for the servers containing data. This operation will not affect the existing data.
+The following procedure shows how to set automatic disk mounting at server start by using UUIDs to identify disks in the fstab file. You are advised not to use device names to identify disks in the file because a device name may change (for example, from /dev/vdb1 to /dev/vdb2) during the server stop or start, resulting in improper server running after restart.
+
UUID is the unique character string for disk partitions in a Linux system.
+blkid Disk partition
+In this example, run the following command to query the UUID of the /dev/vdb1 partition:
+blkid /dev/vdb1
+Information similar to the following is displayed:
+[root@ecs-test-0001 ~]# blkid /dev/vdb1 +/dev/vdb1: UUID="0b3040e2-1367-4abb-841d-ddb0b92693df" TYPE="ext4"+
The UUID of the /dev/vdb1 partition is displayed.
+vi /etc/fstab
+UUID=0b3040e2-1367-4abb-841d-ddb0b92693df /mnt/sdc ext4 defaults 0 2+
The system saves the configurations and exits the vi editor.
+In this example, run the following command:
+umount /dev/vdb1
+mount -a
+In this example, run the following command:
+mount | grep /mnt/sdc
+If information similar to the following is displayed, the automatic mounting function takes effect:
+root@ecs-test-0001 ~]# mount | grep /mnt/sdc +/dev/vdb1 on /mnt/sdc type ext4 (rw,relatime,data=ordered)+
Before extending the disk partition and file system, you must check the disk partition style and file system format, and then select the appropriate operation accordingly.
+Disk + |
+Scenario + |
+Method + |
+
|---|---|---|
System disk + |
+Create a new MBR partition with the additional space. + |
++ | +
Allocate the additional space to an existing MBR partition. + |
++ | +|
Data disk + |
+Create a new MBR partition with the additional space. + |
++ | +
Allocate the additional space to an existing MBR partition. + |
++ | +|
Create a new GPT partition with the additional space. + |
++ | +|
Allocate the additional space to an existing GPT partition. + |
++ | +|
SCSI data disk + |
+Create a new MBR partition with the additional space. + |
++ | +
Allocate the additional space to an existing MBR partition. + |
++ | +
The maximum disk capacity that MBR supports is 2 TB, and the disk space exceeding 2 TB cannot be used.
+If your disk uses MBR and you need to expand the disk capacity to over 2 TB, change the partition style from MBR to GPT. Ensure that the disk data has been backed up before changing the partition style because services will be interrupted and data on the disk will be cleared during this change.
+lsblk
+[root@ecs-test-0001 ~]# lsblk +NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINT +vda 253:0 0 40G 0 disk +└─vda1 253:1 0 40G 0 part / +vdb 253:16 0 150G 0 disk +└─vdb1 253:17 0 100G 0 part /mnt/sdc+
In this example, data disk /dev/vdb already has partition /dev/vdb1 before capacity expansion, and the additional 50 GB added has not been allocated yet. Therefore, /dev/vdb has 150 GB, and /dev/vdb1 has 100 GB.
+fdisk -l
+[root@ecs-test-0001 ~]# fdisk -l + +Disk /dev/vda: 42.9 GB, 42949672960 bytes, 83886080 sectors +Units = sectors of 1 * 512 = 512 bytes +Sector size (logical/physical): 512 bytes / 512 bytes +I/O size (minimum/optimal): 512 bytes / 512 bytes +Disk label type: dos +Disk identifier: 0x000bcb4e + + Device Boot Start End Blocks Id System +/dev/vda1 * 2048 83886079 41942016 83 Linux + +Disk /dev/vdb: 161.1 GB, 161061273600 bytes, 314572800 sectors +Units = sectors of 1 * 512 = 512 bytes +Sector size (logical/physical): 512 bytes / 512 bytes +I/O size (minimum/optimal): 512 bytes / 512 bytes +Disk label type: dos +Disk identifier: 0x38717fc1 + + Device Boot Start End Blocks Id System +/dev/vdb1 2048 209715199 104856576 83 Linux+
The value in the System column indicates the disk partition style. Value Linux indicates the MBR partition style. Value GPT indicates the GPT partition style.
+blkid Disk partition
+In this example, run the following command:
+blkid /dev/vdb1
+In the command output, the TYPE value is ext4, indicating that /dev/vdb1's file system format is ext4.
+ext*: e2fsck -n Disk partition
+xfs: xfs_repair -n Disk partition
+In this example, the ext4 file system is used. Therefore, run the following command:
+e2fsck -n /dev/vdb1
+[root@ecs-test-0001 ~]# e2fsck -n /dev/vdb1 +e2fsck 1.42.9 (28-Dec-2013) +Warning! /dev/vdb1 is mounted. +Warning: skipping journal recovery because doing a read-only filesystem check. +/dev/vdb1: clean, 11/6553600 files, 459544/26214144 blocks+
If the file system status is clean, the file system status is normal. Otherwise, rectify the faulty and then perform the capacity expansion.
+lsblk
+[root@ecs-test-0001 ~]# lsblk +NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINT +vda 253:0 0 40G 0 disk +└─vda1 253:1 0 40G 0 part / +vdb 253:16 0 150G 0 disk +└─vdb1 253:17 0 100G 0 part /mnt/sdc+
In this example, data disk /dev/vdb already has partition /dev/vdb1 before capacity expansion, and the additional 50 GB added has not been allocated yet. Therefore, /dev/vdb has 150 GB, and /dev/vdb1 has 100 GB.
+parted Disk
+For example, run the following command to view /dev/vdb's partition style:
+parted /dev/vdb
+[root@ecs-test-0001 ~]# parted /dev/vdb +GNU Parted 3.1 +Using /dev/vdb +Welcome to GNU Parted! Type 'help' to view a list of commands. +(parted) p +Error: The backup GPT table is not at the end of the disk, as it should be. This might mean that another operating system believes the +disk is smaller. Fix, by moving the backup to the end (and removing the old backup)? +Fix/Ignore/Cancel? Fix +Warning: Not all of the space available to /dev/vdb appears to be used, you can fix the GPT to use all of the space (an extra 104857600 +blocks) or continue with the current setting? +Fix/Ignore? Fix +Model: Virtio Block Device (virtblk) +Disk /dev/vdb: 161GB +Sector size (logical/physical): 512B/512B +Partition Table: gpt +Disk Flags: + +Number Start End Size File system Name Flags + 1 1049kB 107GB 107GB ext4 test + +(parted)+
Error: The backup GPT table is not at the end of the disk, as it should be. This might mean that another operating system believes the +disk is smaller. Fix, by moving the backup to the end (and removing the old backup)?+
The GPT partition table information is stored at the start of the disk. To reduce the risk of damage, a backup of the information is saved at the end of the disk. When you expand the disk capacity, the end of the disk changes accordingly. In this case, enter Fix to move the backup file of the information to new disk end.
+Warning: Not all of the space available to /dev/vdb appears to be used, you can fix the GPT to use all of the space (an extra 104857600 +blocks) or continue with the current setting? +Fix/Ignore? Fix+
Enter Fix as prompted. The system automatically sets the GPT partition style for the additional space.
+Independently created EVS disks are data disks. In the disk list, the function of such disks is displayed as Data disk, and the status is displayed as Available. In this case, you need to attach the data disks to servers for use.
+
Bootable disks are the system disks detached from servers. A bootable disk can be re-attached to a server and be used as a system disk or data disk depending on the device name selected.
+This section describes how to attach a non-shared disk. A non-shared disk can be attached to one server only.
+
in the upper left corner and select the desired region and project.The disk list page is displayed.
+After the disk has been attached to a server, the disk can be used only after you have initialized it. For details, see Introduction to Data Disk Initialization Scenarios and Partition Styles.
+Independently created EVS disks are data disks. In the disk list, the function of such disks is displayed as Data disk, and the status is displayed as Available. In this case, you need to attach the data disks to servers for use.
+This section describes how to attach a shared disk.
+For example, if you attach a shared disk to multiple Windows servers in a batch and then detach it from all its servers, the disk cannot be attached to Linux servers later. This is because Windows and Linux support different file systems and cannot identify the original file system on the disk. Improper operations may damage the original file system.
+
in the upper left corner and select the desired region and project.The disk list page is displayed.
+The Attach Disk dialog box is displayed.
+
If you simply attach a shared disk to multiple servers, files cannot be shared between the servers as shared disks do not have the cluster capability. Therefore, build a shared file system or deploy a cluster management system to share files between servers.
+A system disk does not require manual initialization because it is automatically created and initialized upon server creation. The default disk partition style is master boot record (MBR).
+In both cases, you must initialize the data disk before using it. Choose a proper disk partition style based on your service plan.
+A disk created from a data source does not need to be initialized. Such a disk contains the data of the data source in the beginning. Initializing the disk may clear the initial data on this disk.
+Table 1 lists the common disk partition styles. In Linux, different disk partition styles require different partitioning tools.
+ +Disk Partition Style + |
+Maximum Disk Capacity Supported + |
+Maximum Number of Partitions Supported + |
+Linux Partitioning Tool + |
+
|---|---|---|---|
Master Boot Record (MBR) + |
+2 TB + |
+
With MBR, one may create several primary partitions and an extended partition. An extended partition must be divided into several logical partitions before use. For example, if 6 partitions need to be created, you can create the partitions in the following two ways:
+
|
+
|
+
GUID Partition Table (GPT) + |
+18 EB +1 EB = 1048576 TB + |
+Unlimited +Disk partitions created using GPT are not categorized. + |
+parted + |
+
The maximum disk capacity supported by MBR is 2 TB, and that supported by GPT is 18 EB. Because a data disk currently supports up to 32 TB, use the GPT partition style if your disk capacity is larger than 2 TB.
+If you change the disk partition style after the disk has been used, the data on the disk will be cleared. Therefore, select a proper disk partition style when initializing the disk.
+EVS Disk Status + |
+Description + |
+Allowed Operation + |
+
|---|---|---|
In-use + |
+The EVS disk is attached to a server and is in use. + |
+
|
+
Available + |
+The EVS disk has not been attached to any server and can be attached. + |
+
|
+
Creating + |
+The EVS disk is being created. + |
+None + |
+
Attaching + |
+The EVS disk is being attached to a server. + |
+None + |
+
Detaching + |
+The EVS disk is being detached from a server. + |
+None + |
+
Deleting + |
+The EVS disk is being deleted. + |
+None + |
+
Restoring + |
+A backup is being used to restore the EVS disk. + |
+None + |
+
Expanding + |
+The capacity of the EVS disk is being expanded. + |
+None + |
+
Uploading + |
+Data on the EVS disk is being uploaded to an image. This state occurs when you create an image from a server. + |
+None + |
+
Downloading + |
+Data is being downloaded from an image to the EVS disk. This state occurs when you create a server. + |
+None + |
+
Error + |
+An error occurs when you try to create an EVS disk. + |
+Deleting + |
+
Deletion failed + |
+An error occurs when you try to delete the EVS disk. + |
+None + |
+
Expansion failed + |
+An error occurs when you try to expand the capacity of the EVS disk. + |
+Deleting + |
+
Restoration failed + |
+An error occurs when you try to restore the EVS disk from a backup. + |
+Deleting + |
+
Rolling back + |
+Data on the EVS disk is being restored from a snapshot. + NOTE:
+
|
+None + |
+
Rollback failed + |
+An error occurs when the EVS disk is rolled back from a snapshot. + |
+
|
+
Awaiting transfer + |
+The EVS disk is awaiting for a transfer. + |
+None + |
+
If an EVS disk status is Error, Deletion failed, Expansion failed, Restoration failed, or Rollback failed, you can rectify the error by following the steps provided in What Should I Do If an Error Occurs on My EVS Disk?.
+Snapshot Status + |
+Description + |
+Allowed Operation + |
+
|---|---|---|
Creating + |
+The snapshot is being created. + |
+No operations are allowed. + |
+
Available + |
+The snapshot is successfully created. + |
+
|
+
Deleting + |
+The snapshot is being deleted. + |
+No operations are allowed. + |
+
Error + |
+An error occurs when you try to create a snapshot. + |
+Deleting + |
+
Deletion failed + |
+An error occurs when you try to delete a snapshot. + |
+No operations are allowed. + |
+
Rolling back + |
+The snapshot is rolling back data. + NOTE:
+
|
+No operations are allowed. + |
+
Backing up + |
+This status is available only to temporary snapshots. When you create a backup for an EVS disk, a temporary snapshot is automatically created. This status indicates that a temporary snapshot is being created during the backup creation. + NOTE:
+Temporary snapshots are created through the CBR service. Do not perform any operation on these snapshots. + |
+No operations are allowed. + |
+
Through EVS disk transfer, EVS disks can be transferred from one account to another. After the transfer succeeds, the ownerships of the EVS disks belong to the target account only. Currently, only data disks can be transferred.
+Currently, users can use the disk transfer function via API only. For details, see chapter "EVS Disk Transfer" in the Elastic Volume Service API Reference.
+
After the transfer is successfully created, transfer_id and auth_key are returned.
+User A can delete the unaccepted disk transfer. For details, see "Deleting a Disk Transfer" in the Elastic Volume Service API Reference.
+Users can make an API call to expand the EVS disks in one or multiple EVS replication pairs of a replication consistency group. In such an expansion operation, two EVS disks in one EVS replication pair are expanded together.
+
The status and replication_status values of the replication consistency group remain unchanged before and after capacity expansion.
+If the expansion fails, contact customer service to locate and rectify the fault. After the fault is rectified, expand the disks again.
+EVS replication APIs have been deprecated. If you need to use the replication function, see Storage Disaster Recovery Service User Guide and Storage Disaster Recovery Service API Reference.
+For details, see Expanding EVS Disks a Replication Consistency Group in the Elastic Volume Service API Reference.
+This section describes monitored metrics reported by EVS to Cloud Eye as well as their namespaces and dimensions. You can use console or APIs provided by Cloud Eye to query the metrics of the monitored objects and alarms generated for EVS.
+SYS.EVS
+Metric ID + |
+Metric Name + |
+Description + |
+Value Range + |
+Monitored Object + |
+Monitoring Period (Raw Data) + |
+
|---|---|---|---|---|---|
disk_device_read_bytes_rate + |
+Disk Read Bandwidth + |
+Number of bytes read from the monitored disk per second +Unit: Bytes/s + |
+≥ 0 bytes/s + |
+EVS disk + |
+5 minutes + |
+
disk_device_write_bytes_rate + |
+Disk Write Bandwidth + |
+Number of bytes written to the monitored disk per second +Unit: Bytes/s + |
+≥ 0 bytes/s + |
+EVS disk + |
+5 minutes + |
+
disk_device_read_requests_rate + |
+Disk Read IOPS + |
+Number of read requests sent to the monitored disk per second +Unit: Requests/s + |
+≥ 0 Requests/s + |
+EVS disk + |
+5 minutes + |
+
disk_device_write_requests_rate + |
+Disk Write IOPS + |
+Number of write requests sent to the monitored disk per second +Unit: Requests/s + |
+≥ 0 Requests/s + |
+EVS disk + |
+5 minutes + |
+
Key + |
+Value + |
+
|---|---|
disk_name + |
+Server ID-drive letter, for example, 6f3c6f91-4b24-4e1b-b7d1-a94ac1cb011d-vda (vda is the drive letter) + |
+
in the upper left corner and select the desired region and project.The disk list page is displayed.
+The disk details page is displayed.
+The monitoring graphs page is displayed.
+For more information about Cloud Eye, see the Cloud Eye User Guide.
+This section uses Windows Server 2016 Standard 64bit to describe how to initialize a data disk attached to a server running Windows.
+The maximum disk capacity supported by MBR is 2 TB, and that supported by GPT is 18 EB. Therefore, use the GPT partition style if your disk capacity is larger than 2 TB. For details about disk partition styles, see Introduction to Data Disk Initialization Scenarios and Partition Styles.
+The method for initializing a disk varies depending on the OS running on the server. This document is used for reference only. For the detailed operations and differences, see the product documents of the corresponding OS.
+The Windows Server window is displayed.
+The Server Manager window is displayed.
+
The Computer Management window is displayed.
+


The maximum disk capacity supported by MBR is 2 TB, and that supported by GPT is 18 EB. Because a data disk currently supports up to 32 TB, use the GPT partition style if your disk capacity is larger than 2 TB.
+If you change the disk partition style after the disk has been used, the data on the disk will be cleared. Therefore, select a proper disk partition style when initializing the disk.
+


The Format Partition page is displayed.
+

The partition sizes supported by file systems vary. Therefore, you are advised to choose an appropriate file system based on your service requirements.
+
on the task bar and check whether a new volume appears in This PC. In this example, New Volume (D:) is the new volume.
Both EVS disk backup and EVS snapshot provide redundancies for the EVS disk data to improve reliability. Table 1 lists the differences between them.
+ +Item + |
+Storage Solution + |
+Data Synchronization + |
+DR Range + |
+Service Recovery + |
+
|---|---|---|---|---|
Backup + |
+Backup data is stored in OBS, instead of disks. This ensures data restoration upon disk data loss or corruption. + |
+A backup is the data copy of a disk at a given point in time. CBR supports automatic backup by configuring backup policies. Deleting a disk will not clear its backups. + |
+A backup and its source disk reside in the same AZ. + |
+Data can be recovered and services can be restored by restoring the backup data to original disks or creating new disks from backups, ensuring excellent data reliability. + |
+
Snapshot + |
+Snapshot data is stored with disk data. + NOTE:
+Creating a backup requires a certain amount of time because data needs to be transferred. Therefore, creating or rolling back a snapshot consumes less time than creating a backup. + |
+A snapshot is the state of a disk at a specific point in time. If a disk is deleted, all the snapshots created for this disk will also be deleted. If you have reinstalled or changed the server OS, snapshots of the system disk are automatically deleted. Snapshots of the data disks can be used as usual. + |
+A snapshot and its source disk reside in the same AZ. + |
+You can use a snapshot to roll back its original disk or create a disk for data restoration and service recovery. + |
+
EVS replication APIs have been deprecated. If you need to use the replication function, see Storage Disaster Recovery Service User Guide and Storage Disaster Recovery Service API Reference.
+After a disk has been expanded on the management console, the disk size is enlarged, but the additional space cannot be used directly.
+In Linux, you must allocate the additional space to an existing partition or a new partition.
+This section uses CentOS 7.4 64bit and CentOS 6.5 64bit as the sample OSs to describe how to extend the disk partition using growpart and fdisk. The method for allocating the additional space varies with the server OS. This document is used for reference only. For detailed operations and differences, see the corresponding OS documents.
+For how to query the Linux kernel version, see Querying the Linux Kernel Version.
+
Performing the expansion operations with caution. Misoperation may lead to data loss or exceptions. Therefore, you are advised to back up the disk data using backups or snapshots before expansion. For details about backups, see Managing EVS Backup. For details about snapshots, see Creating a Snapshot.
+Run the following command to query the Linux kernel version:
+uname -a
+Linux ecs-test-0001 3.10.0-957.5.1.el7.x86_64 #1 SMP Fri Feb 1 14:54:57 UTC 2019 x86_64 x86_64+
The kernel version is 3.10.0, which is later than 3.6.0. For subsequent operations, see Extending an Existing MBR Partition (Kernel Version Later Than 3.6.0).
+Linux ecs-test-0002 2.6.32-754.10.1.el6.x86_64 #1 SMP Tue Jan 15 17:07:28 UTC 2019 x86_64+
The kernel version is 2.6.32, which is earlier than 3.6.0. In this case, the disk partition and file system extension take effect only after a server reboot. For subsequent operations, see Extending an Existing MBR Partition (Kernel Version Earlier Than 3.6.0).
+CentOS 7.4 64bit is used as the sample OS. Originally, system disk /dev/vda has 40 GB and one partition (/dev/vda1), and then 60 GB is added to the disk. The following procedure shows you how to allocate the additional 60 GB to the existing MBR partition /dev/vda1.
+yum install cloud-utils-growpart
+
You can run the growpart command to check whether the growpart tool has been installed. If the command output displays the tool usage instructions, the tool has been installed and you do not need to install it separately.
+fdisk -l
+[root@ecs-test-0001 ~]# fdisk -l + +Disk /dev/vda: 107.4 GB, 107374182400 bytes, 209715200 sectors +Units = sectors of 1 * 512 = 512 bytes +Sector size (logical/physical): 512 bytes / 512 bytes +I/O size (minimum/optimal): 512 bytes / 512 bytes +Disk label type: dos +Disk identifier: 0x000bcb4e + + Device Boot Start End Blocks Id System +/dev/vda1 * 2048 83886079 41942016 83 Linux+
df -TH
+[root@ecs-test-0001 ~]# df -TH +Filesystem Type Size Used Avail Use% Mounted on +/dev/vda1 ext4 43G 2.0G 39G 5% / +devtmpfs devtmpfs 2.0G 0 2.0G 0% /dev +tmpfs tmpfs 2.0G 0 2.0G 0% /dev/shm +tmpfs tmpfs 2.0G 9.0M 2.0G 1% /run +tmpfs tmpfs 2.0G 0 2.0G 0% /sys/fs/cgroup +tmpfs tmpfs 398M 0 398M 0% /run/user/0+
growpart System disk Partition number
+In this example, run the following command:
+growpart /dev/vda 1
+[root@ecs-test-0001 ~]# growpart /dev/vda 1 +CHANGED: partition=1 start=2048 old: size=83884032 end=83886080 new: size=209713119,end=209715167+
resize2fs Disk partition
+In this example, run the following command:
+resize2fs /dev/vda1
+[root@ecs-test-0001 ~]# resize2fs /dev/vda1 +resize2fs 1.42.9 (28-Dec-2013) +Filesystem at /dev/vda1 is mounted on /; on-line resizing required +old_desc_blocks = 5, new_desc_blocks = 13 +The filesystem on /dev/vda1 is now 26214139 blocks long.+
df -TH
+[root@ecs-test-0001 ~]# df -TH +Filesystem Type Size Used Avail Use% Mounted on +/dev/vda1 ext4 106G 2.0G 99G 2% / +devtmpfs devtmpfs 2.0G 0 2.0G 0% /dev +tmpfs tmpfs 2.0G 0 2.0G 0% /dev/shm +tmpfs tmpfs 2.0G 9.0M 2.0G 1% /run +tmpfs tmpfs 2.0G 0 2.0G 0% /sys/fs/cgroup +tmpfs tmpfs 398M 0 398M 0% /run/user/0+
If the OS kernel version is earlier than 3.6.0, the extension of an existing MBR disk partition and file system takes effect only after a server reboot, and services will be interrupted.
+CentOS 6.5 64bit is used as the sample OS. Originally, system disk /dev/vda has 40 GB and one partition (/dev/vda1), and then 60 GB is added to the disk. The following procedure shows you how to allocate the additional 60 GB to the existing MBR partition /dev/vda1.
+yum install cloud-utils-growpart
+
You can run the growpart command to check whether the growpart tool has been installed. If the command output displays the tool usage instructions, the tool has been installed and you do not need to install it separately.
+yum install cloud-utils-growpart
+[root@ecs-test-0002 ~]# yum install cloud-utils-growpart +Loaded plugins: fastestmirror, security +Setting up Install Process +Determining fastest mirrors +... +Package cloud-utils-growpart-0.27-10.el6.x86_64 already installed and latest version +Nothing to do+
dracut -f
+fdisk -l
+[root@ecs-test-0002 ~]# fdisk -l + +Disk /dev/vda: 107.4 GB, 107374182400 bytes +255 heads, 63 sectors/track, 13054 cylinders +Units = cylinders of 16065 * 512 = 8225280 bytes +Sector size (logical/physical): 512 bytes / 512 bytes +I/O size (minimum/optimal): 512 bytes / 512 bytes +Disk identifier: 0x0004e0be + + Device Boot Start End Blocks Id System +/dev/vda1 * 1 5222 41942016 83 Linux+
df -TH
+[root@ecs-test-0002 ~]# df -TH +Filesystem Type Size Used Avail Use% Mounted on +/dev/vda1 ext4 43G 1.7G 39G 5% / +tmpfs tmpfs 2.1G 0 2.1G 0% /dev/shm+
growpart System disk Partition number
+In this example, run the following command:
+growpart /dev/vda 1
+[root@ecs-test-0002 ~]# growpart /dev/vda 1 +CHANGED: partition=1 start=2048 old: size=83884032 end=83886080 new: size=209710462,end=209712510+
reboot
+After the server is restarted, reconnect to the server and perform the following steps.
+resize2fs Disk partition
+In this example, run the following command:
+resize2fs /dev/vda1
+[root@ecs-test-0002 ~]# resize2fs /dev/vda1 +resize2fs 1.41.12 (17-May-2010) +The filesystem is already 26213807 blocks long. Nothing to do!+
df -TH
+[root@ecs-test-0002 ~]# df -TH +Filesystem Type Size Used Avail Use% Mounted on +/dev/vda1 ext4 106G 1.7G 99G 2% / +tmpfs tmpfs 2.1G 0 2.1G 0% /dev/shm+
Originally, system disk /dev/vda has 40 GB and one partition (/dev/vda1), and then 40 GB is added to the disk. The following procedure shows you how to create a new MBR partition /dev/vda2 with this 40 GB.
+fdisk -l
+[root@ecs-2220 ~]# fdisk -l + +Disk /dev/vda: 85.9 GB, 85899345920 bytes, 167772160 sectors +Units = sectors of 1 * 512 = 512 bytes +Sector size (logical/physical): 512 bytes / 512 bytes +I/O size (minimum/optimal): 512 bytes / 512 bytes +Disk label type: dos +Disk identifier: 0x0008d18f + + Device Boot Start End Blocks Id System +/dev/vda1 * 2048 83886079 41942016 83 Linux+
In the command output, the capacity of the dev/vda system disk is 80 GB, in which the in-use dev/vda1 partition takes 40 GB and the additional 40 GB has not been allocated.
+fdisk /dev/vda
+[root@ecs-2220 ~]# fdisk /dev/vda +Welcome to fdisk (util-linux 2.23.2). + +Changes will remain in memory only, until you decide to write them. +Be careful before using the write command. + + +Command (m for help):+
Command (m for help): n +Partition type: + p primary (1 primary, 0 extended, 3 free) + e extended+
If the MBR partition style is used, a maximum of 4 primary partitions, or 3 primary partitions and 1 extended partition can be created. The extended partition cannot be used directly and must be divided into logical partitions before use.
+Disk partitions created using GPT are not categorized.
+Select (default p): p +Partition number (2-4, default 2):+
Partition number (2-4, default 2): 2 +First sector (83886080-167772159, default 83886080):+
The system displays the start and end sectors of the partition's available space. You can customize the value within this range or use the default value. The start sector must be smaller than the partition's end sector.
+First sector (83886080-167772159, default 83886080):
+Using default value 83886080
+Last sector, +sectors or +size{K,M,G} (83886080-167772159,default 167772159):
+The system displays the start and end sectors of the partition's available space. You can customize the value within this range or use the default value. The start sector must be smaller than the partition's end sector.
+Last sector, +sectors or +size{K,M,G} (83886080-167772159,
+default 167772159):
+Using default value 167772159
+Partition 2 of type Linux and of size 40 GiB is set
+
+Command (m for help):
+Command (m for help): p + +Disk /dev/vda: 85.9 GB, 85899345920 bytes, 167772160 sectors +Units = sectors of 1 * 512 = 512 bytes +Sector size (logical/physical): 512 bytes / 512 bytes +I/O size (minimum/optimal): 512 bytes / 512 bytes +Disk label type: dos +Disk identifier: 0x0008d18f + + Device Boot Start End Blocks Id System +/dev/vda1 * 2048 83886079 41942016 83 Linux +/dev/vda2 83886080 167772159 41943040 83 Linux +Command (m for help):+
Command (m for help): w +The partition table has been altered! + +Calling ioctl() to re-read partition table. + +WARNING: Re-reading the partition table failed with error 16: Device or resource busy. +The kernel still uses the old table. The new table will be used at +the next reboot or after you run partprobe(8) or kpartx(8) +Syncing disks.+
The partition is created.
+
In case that you want to discard the changes made before, you can exit fdisk by entering q.
+partprobe
+mkfs -t File system Disk partition
+(The ext4 file system is used in this example.)
+mkfs -t ext4 /dev/vda2
+[root@ecs-2220 ~]# mkfs -t ext4 /dev/vda2 +mke2fs 1.42.9 (28-Dec-2013) +Filesystem label= +OS type: Linux +Block size=4096 (log=2) +Fragment size=4096 (log=2) +Stride=0 blocks, Stripe width=0 blocks +2621440 inodes, 10485760 blocks +524288 blocks (5.00%) reserved for the super user +First data block=0 +Maximum filesystem blocks=2157969408 +320 block groups +32768 blocks per group, 32768 fragments per group +8192 inodes per group +Superblock backups stored on blocks: + 32768, 98304, 163840, 229376, 294912, 819200, 884736, 1605632, 2654208, + 4096000, 7962624 + +Allocating group tables: done +Writing inode tables: done +Creating journal (32768 blocks): done +Writing superblocks and filesystem accounting information: done+
Information similar to the following is displayed:
+[root@ecs-2220 ~]# mkfs -t xfs /dev/vda2 +meta-data=/dev/vda2 isize=512 agcount=4, agsize=2621440 blks + = sectsz=512 attr=2, projid32bit=1 + = crc=1 finobt=0, sparse=0 +data = bsize=4096 blocks=10485760, imaxpct=25 + = sunit=0 swidth=0 blks +naming =version2 bsize=4096 ascii-ci=0 ftype=1 +log =internal log bsize=4096 blocks=5120, version=2 + = sectsz=512 sunit=0 blks, lazy-count=1 +realtime =none extsz=4096 blocks=0, rtextents=0+
The formatting takes a while, and you need to observe the system running status. Once done is displayed in the command output, the formatting is complete.
+Perform this step if you want to mount the partition on a new mount point.
+mkdir Mount point
+In this example, run the following command to create the /opt mount point:
+mkdir /opt
+mount Disk partition Mount point
+In this example, run the following command to mount the new partition /dev/vda2 on /opt:
+mount /dev/vda2 /opt
+
If the new partition is mounted on a directory that is not empty, the subdirectories and files in the directory will be hidden. Therefore, you are advised to mount the new partition on an empty directory or a new directory. If the new partition must be mounted on a directory that is not empty, move the subdirectories and files in this directory to another directory temporarily. After the partition is successfully mounted, move the subdirectories and files back.
+df -TH
+Information similar to the following is displayed:
+[root@ecs-2220 ~]# df -TH +Filesystem Type Size Used Avail Use% Mounted on +/dev/vda1 ext4 43G 2.0G 39G 5% / +devtmpfs devtmpfs 509M 0 509M 0% /dev +tmpfs tmpfs 520M 0 520M 0% /dev/shm +tmpfs tmpfs 520M 7.2M 513M 2% /run +tmpfs tmpfs 520M 0 520M 0% /sys/fs/cgroup +tmpfs tmpfs 104M 0 104M 0% /run/user/0 +/dev/vda2 ext4 43G 51M 40G 1% /opt+
If the server is restarted, the mounting will become invalid. You can set automatic mounting for partitions at system start by modifying the /etc/fstab file. For details, see Setting Automatic Mounting at System Start.
+Modify the fstab file to set automatic disk mounting at server start. You can also set automatic mounting for the servers containing data. This operation will not affect the existing data.
+The following procedure shows how to set automatic disk mounting at server start by using UUIDs to identify disks in the fstab file. You are advised not to use device names to identify disks in the file because a device name may change (for example, from /dev/vdb1 to /dev/vdb2) during the server stop or start, resulting in improper server running after restart.
+
UUID is the unique character string for disk partitions in a Linux system.
+blkid Disk partition
+In this example, run the following command to query the UUID of the /dev/vdb1 partition:
+blkid /dev/vdb1
+Information similar to the following is displayed:
+[root@ecs-test-0001 ~]# blkid /dev/vdb1 +/dev/vdb1: UUID="0b3040e2-1367-4abb-841d-ddb0b92693df" TYPE="ext4"+
The UUID of the /dev/vdb1 partition is displayed.
+vi /etc/fstab
+UUID=0b3040e2-1367-4abb-841d-ddb0b92693df /mnt/sdc ext4 defaults 0 2+
The system saves the configurations and exits the vi editor.
+In this example, run the following command:
+umount /dev/vdb1
+mount -a
+In this example, run the following command:
+mount | grep /mnt/sdc
+If information similar to the following is displayed, the automatic mounting function takes effect:
+root@ecs-test-0001 ~]# mount | grep /mnt/sdc +/dev/vdb1 on /mnt/sdc type ext4 (rw,relatime,data=ordered)+
If you need to assign different permissions to employees in your enterprise to access your EVS resources, IAM is a good choice for fine-grained permissions management. IAM provides identity authentication, permissions management, and access control, helping you secure access to your cloud resources.
+With IAM, you can use your cloud account to create IAM users for your employees, and assign permissions to the users to control their access to specific resource types. For example, some management personnel in your enterprise need to view EVS resources but should not be allowed to delete the resources or perform any high-risk operations. In this scenario, you can create IAM users for the management personnel and grant them only the permissions required for viewing EVS resources.
+If your account does not need individual IAM users for permissions management, you may skip this chapter.
+IAM can be used free of charge. You pay only for the resources in your account. For more information about IAM, see section "Service Overview" in the Identity and Access Management User Guide.
+By default, new IAM users do not have permissions assigned. You need to add a user to one or more groups, and attach permissions policies or roles to these groups. Users inherit permissions from the groups to which they are added and can perform specified operations on cloud services based on the permissions.
+EVS is a project-level service deployed and accessed in specific physical regions. To assign EVS permissions to a user group, specify the scope as region-specific projects and select projects for the permissions to take effect. If All projects is selected, the permissions will take effect for the user group in all region-specific projects. When accessing EVS, the users need to switch to a region where they have been authorized to use this service. When accessing EVS, users need to switch to a region where they have been authorized to use EVS.
+Role/Policy Name + |
+Description + |
+Type + |
+Dependency + |
+
|---|---|---|---|
EVS FullAccess + |
+Full permissions for EVS. Users granted these permissions can create, attach, detach, query, and delete EVS resources, and expand capacity of EVS disks. + |
+System-defined policy + |
+None + |
+
EVS ReadOnlyAccess + |
+Read-only permissions for EVS. Users granted these permissions can view EVS resource data only. + |
+System-defined policy + |
+None + |
+
Server Administrator + |
+Full permissions for EVS + |
+System role + |
+None + |
+
The EVS Admin and EVS FullAccess roles have the same permissions, and EVS Admin will be deprecated later. The EVS Viewer and EVS ReadOnlyAccess roles have the same permissions, and EVS Viewer will be deprecated later.
+Operation + |
+EVS FullAccess + |
+EVS ReadOnlyAccess + |
+
|---|---|---|
Creating disks + |
+√ + |
+x + |
+
Viewing disk list + |
+√ + |
+√ + |
+
Viewing disk details + |
+√ + |
+√ + |
+
Attaching disks + |
+√ + |
+x + |
+
Detaching disks + |
+√ + |
+x + |
+
Deleting disks + |
+√ + |
+x + |
+
Expanding disk capacities + |
+√ + |
+x + |
+
Creating snapshots + |
+√ + |
+x + |
+
Deleting snapshots + |
+√ + |
+x + |
+
Rolling back snapshot data + |
+√ + |
+x + |
+
Creating disks from snapshots + |
+√ + |
+x + |
+
Adding tags for disks + |
+√ + |
+x + |
+
Modifying tags + |
+√ + |
+x + |
+
Deleting tags + |
+√ + |
+x + |
+
Searching for disks by tag + |
+√ + |
+√ + |
+
This chapter describes how to use IAM to implement fine-grained permissions control for your EVS resources. With IAM, you can:
+If your account does not require individual IAM users, skip this chapter.
+This section describes the procedure for granting permissions (see Figure 1).
+Learn about the permissions (see section "Permissions Management" in the Elastic Volume Service User Guide) supported by EVS and choose policies or roles according to your requirements.
+Create a user group on the IAM console, and attach the EVS ReadOnlyAccess policy to the group.
+Create a user on the IAM console and add the user to the group created in 1.
+Log in to the EVS console by using the user created in 2, and verify that the user only has read permissions for EVS.
+Custom policies can be created to supplement the system-defined policies of EVS. For the actions supported for custom policies, see section "Permissions Policies and Supported Actions" in the Elastic Volume Service API Reference.
+You can create custom policies in either of the following ways:
+
For operation details, see section "Creating a Custom Policy" in the Identity and Access Management User Guide. The following section contains examples of common EVS custom policies.
+{
+ "Version": "1.1",
+ "Statement": [
+ {
+ "Action": [
+ "evs:volumes:list",
+ "evs:volumes:get",
+ "evs:quotas:get",
+ "evs:volumeTags:list",
+ "evs:types:get",
+ "evs:volumes:create",
+ "ecs:cloudServerFlavors:get",
+ "ecs:cloudServers:list",
+ "bss:balance:view",
+ "bss:order:pay",
+ "bss:order:update"
+ ],
+ "Effect": "Allow"
+ }
+ ]
+}
+A policy with only "Deny" permissions must be used in conjunction with other policies to take effect. If the permissions assigned to a user contain both "Allow" and "Deny", the "Deny" permissions take precedence over the "Allow" permissions.
+The following method can be used if you need to assign permissions of the EVS FullAccess policy to a user but you want to prevent the user from deleting EVS disks. Create a custom policy for denying disk deletion, and attach both policies to the group to which the user belongs. Then, the user can perform all operations on disks except deleting disks. The following is an example of a deny policy:
+{
+ "Version": "1.1",
+ "Statement": [
+ {
+ "Effect": "Deny",
+ "Action": [
+ "evs:volumes:delete"
+ ]
+ }
+ ]
+}
+A region and availability zone (AZ) identify the location of a data center. You can create resources in a specific region and AZ.
+Figure 1 shows the relationship between regions and AZs.
+ +Select a region closest to your target users for lower network latency and quick access.
+When deploying resources, consider your applications' requirements on disaster recovery (DR) and network latency.
+Before you use an API to call resources, specify its region and endpoint. For more details, see Regions and Endpoints.
+EVS allows you to create snapshots for disks on the management console or by making API calls. An EVS snapshot is a complete copy or image of the disk data at a specific time point. As a major disaster recovery (DR) approach, you can use a snapshot to completely restore the data to the time point when the snapshot was created.
+EVS snapshots are sometimes referred to as snapshots in this document.
+You can create snapshots to rapidly save the disk data at specified time points. In addition, you can use snapshots to create new disks so that the created disks will contain the snapshot data in the beginning.
+The snapshot function helps address your following needs:
+You can create snapshots for disks on a timely basis and use snapshots to recover your data in case that data loss or data inconsistency occurred due to misoperations, viruses, or attacks.
+You can create a snapshot or multiple snapshots before an application software upgrade or a service data migration. If an exception occurs during the upgrade or migration, service data can be rapidly restored to the time point when the snapshot was created.
+For example, a fault occurred on system disk A of server A, and therefore server A cannot be started. Because system disk A is already faulty, the data on system disk A cannot be restored by rolling back snapshots. However, you can create disk B using an existing snapshot of system disk A and attach disk B to a properly running server, for example server B. In this case, server B can read the data of system disk A from disk B.
+
Currently, when rolling back data from snapshots, the snapshot data can be rolled back only to its source EVS disk, and a rollback to another EVS disk is not possible.
+You can use a snapshot to create multiple disks containing the same initial data, and these disks can be used as data resources for various services, for example data mining, report query, and development and testing. This method protects the initial data and creates disks rapidly, meeting the diversified service data requirements.
+You can create snapshots according to Creating a Snapshot to rapidly save the disk data at specified points in time.
+If data lost occurs, you may choose to roll back the disk data to the snapshot creation time based on Rolling Back Data from a Snapshot. In addition, you may create a new disk from the snapshot so that the disk will contain the snapshot data in the beginning. For details, see Creating an EVS Disk from a Snapshot.
+When a snapshot is no longer needed, delete it according to Deleting a Snapshot to release the virtual resources.
+Tags identify EVS resources for purposes of easy categorization and quick search.
+ +Operation + |
+Scenario + |
+
|---|---|
| + | +Add tags for existing disks or during disk creations. + |
+
| + | +Change tag values for existing disks. Tag keys of existing disks cannot be changed. + |
+
| + | +Delete tags that are no longer needed for existing disks. + |
+
| + | +After tags are added, search for disks by tags. + |
+
This section uses Windows Server 2008 R2 Enterprise 64bit to describe how to initialize a data disk attached to a server running Windows.
+The maximum disk capacity supported by MBR is 2 TB, and that supported by GPT is 18 EB. Therefore, use the GPT partition style if your disk capacity is larger than 2 TB. For details about disk partition styles, see Introduction to Data Disk Initialization Scenarios and Partition Styles.
+The method for initializing a disk varies depending on the OS running on the server. This document is used for reference only. For the detailed operations and differences, see the product documents of the corresponding OS.
+The Server Manager window is displayed.
+
If the disk is offline, you need to online the disk before initializing it.
+
The maximum disk capacity supported by MBR is 2 TB, and that supported by GPT is 18 EB. Because a data disk currently supports up to 32 TB, use the GPT partition style if your disk capacity is larger than 2 TB.
+If you change the disk partition style after the disk has been used, the data on the disk will be cleared. Therefore, select a proper disk partition style when initializing the disk.
+




The partition sizes supported by file systems vary. Therefore, you are advised to choose an appropriate file system based on your service requirements.
+After a disk has been expanded on the management console, the disk size is enlarged, but the additional space cannot be used directly.
+In Linux, you must allocate the additional space to an existing partition or a new partition.
+This section uses CentOS 7.4 64bit as the sample OS to describe how to extend an MBR or GPT partition. The method for allocating the additional space varies depending on the server OS. This document is used for reference only. For detailed operations and differences, see the corresponding OS documents.
+
Performing the expansion operations with caution. Misoperation may lead to data loss or exceptions. Therefore, you are advised to back up the disk data using backups or snapshots before expansion. For details about backups, see Managing EVS Backup. For details about snapshots, see Creating a Snapshot.
+Originally, data disk /dev/vdb has 100 GB and one partition (/dev/vdb1), and then 50 GB is added to the disk. The following procedure shows you how to create a new MBR partition /dev/vdb2 with this 50 GB.
+fdisk -l
+[root@ecs-test-0001 ~]# fdisk -l + +Disk /dev/vda: 42.9 GB, 42949672960 bytes, 83886080 sectors +Units = sectors of 1 * 512 = 512 bytes +Sector size (logical/physical): 512 bytes / 512 bytes +I/O size (minimum/optimal): 512 bytes / 512 bytes +Disk label type: dos +Disk identifier: 0x000bcb4e + + Device Boot Start End Blocks Id System +/dev/vda1 * 2048 83886079 41942016 83 Linux + +Disk /dev/vdb: 161.1 GB, 161061273600 bytes, 314572800 sectors +Units = sectors of 1 * 512 = 512 bytes +Sector size (logical/physical): 512 bytes / 512 bytes +I/O size (minimum/optimal): 512 bytes / 512 bytes +Disk label type: dos +Disk identifier: 0x38717fc1 + + Device Boot Start End Blocks Id System +/dev/vdb1 2048 209715199 104856576 83 Linux+
fdisk Disk
+In this example, run the following command:
+fdisk /dev/vdb
+[root@ecs-test-0001 ~]# fdisk /dev/vdb +Welcome to fdisk (util-linux 2.23.2). + +Changes will remain in memory only, until you decide to write them. +Be careful before using the write command. + + +Command (m for help):+
Command (m for help): n +Partition type: + p primary (1 primary, 0 extended, 3 free) + e extended +Select (default p):+
If the MBR partition style is used, a maximum of 4 primary partitions, or 3 primary partitions and 1 extended partition can be created. The extended partition cannot be used directly and must be divided into logical partitions before use.
+Disk partitions created using GPT are not categorized.
+Select (default p): p +Partition number (2-4, default 2):+
Partition number indicates the serial number of the primary partition. Because partition number 1 has been used, the value ranges from 2 to 4.
+Partition number (2-4, default 2): 2 +First sector (209715200-314572799, default 209715200):+
First sector indicates the start sector. The value ranges from 209715200 to 314572799, and the default value is 209715200.
+The system displays the start and end sectors of the partition's available space. You can customize the value within this range or use the default value. The start sector must be smaller than the partition's end sector.
+First sector (209715200-314572799, default 209715200):
+Using default value 209715200
+Last sector, +sectors or +size{K,M,G} (209715200-314572799, default 314572799):
+Last sector indicates the end sector. The value ranges from 209715200 to 314572799, and the default value is 314572799.
+The system displays the start and end sectors of the partition's available space. You can customize the value within this range or use the default value. The start sector must be smaller than the partition's end sector.
+Last sector, +sectors or +size{K,M,G} (209715200-314572799, default 314572799):
+Using default value 314572799
+Partition 2 of type Linux and of size 50 GiB is set
+
+Command (m for help):
+Command (m for help): p + +Disk /dev/vdb: 161.1 GB, 161061273600 bytes, 314572800 sectors +Units = sectors of 1 * 512 = 512 bytes +Sector size (logical/physical): 512 bytes / 512 bytes +I/O size (minimum/optimal): 512 bytes / 512 bytes +Disk label type: dos +Disk identifier: 0x38717fc1 + + Device Boot Start End Blocks Id System +/dev/vdb1 2048 209715199 104856576 83 Linux +/dev/vdb2 209715200 314572799 52428800 83 Linux + +Command (m for help):+
Command (m for help): w +The partition table has been altered! + +Calling ioctl() to re-read partition table. + +WARNING: Re-reading the partition table failed with error 16: Device or resource busy. +The kernel still uses the old table. The new table will be used at +the next reboot or after you run partprobe(8) or kpartx(8) +Syncing disks.+
In case that you want to discard the changes made before, you can exit fdisk by entering q.
+partprobe
+[root@ecs-test-0001 ~]# mkfs -t ext4 /dev/vdb2 +mke2fs 1.42.9 (28-Dec-2013) +Filesystem label= +OS type: Linux +Block size=4096 (log=2) +Fragment size=4096 (log=2) +Stride=0 blocks, Stripe width=0 blocks +3276800 inodes, 13107200 blocks +655360 blocks (5.00%) reserved for the super user +First data block=0 +Maximum filesystem blocks=2162163712 +400 block groups +32768 blocks per group, 32768 fragments per group +8192 inodes per group +Superblock backups stored on blocks: + 32768, 98304, 163840, 229376, 294912, 819200, 884736, 1605632, 2654208, + 4096000, 7962624, 11239424 + +Allocating group tables: done +Writing inode tables: done +Creating journal (32768 blocks): done +Writing superblocks and filesystem accounting information: done+
Information similar to the following is displayed:
+[root@ecs-test-0001 ~]# mkfs -t xfs /dev/vdb2 +meta-data=/dev/vdb2 isize=512 agcount=4, agsize=3276800 blks + = sectsz=512 attr=2, projid32bit=1 + = crc=1 finobt=0, sparse=0 +data = bsize=4096 blocks=13107200, imaxpct=25 + = sunit=0 swidth=0 blks +naming =version2 bsize=4096 ascii-ci=0 ftype=1 +log =internal log bsize=4096 blocks=6400, version=2 + = sectsz=512 sunit=0 blks, lazy-count=1 +realtime =none extsz=4096 blocks=0, rtextents=0+
The formatting takes a while, and you need to observe the system running status. Once done is displayed in the command output, the formatting is complete.
+Perform this step if you want to mount the partition on a new mount point.
+mkdir Mount point
+In this example, run the following command to create the /mnt/test mount point:
+mkdir /mnt/test
+mount Disk partition Mount point
+In this example, run the following command to mount the new partition /dev/vdb2 on /mnt/test:
+mount /dev/vdb2 /mnt/test
+
If the new partition is mounted on a directory that is not empty, the subdirectories and files in the directory will be hidden. Therefore, you are advised to mount the new partition on an empty directory or a new directory. If the new partition must be mounted on a directory that is not empty, move the subdirectories and files in this directory to another directory temporarily. After the partition is successfully mounted, move the subdirectories and files back.
+df -TH
+[root@ecs-test-0001 ~]# df -TH +Filesystem Type Size Used Avail Use% Mounted on +/dev/vda1 ext4 43G 1.9G 39G 5% / +devtmpfs devtmpfs 2.0G 0 2.0G 0% /dev +tmpfs tmpfs 2.0G 0 2.0G 0% /dev/shm +tmpfs tmpfs 2.0G 9.1M 2.0G 1% /run +tmpfs tmpfs 2.0G 0 2.0G 0% /sys/fs/cgroup +tmpfs tmpfs 398M 0 398M 0% /run/user/0 +/dev/vdb1 ext4 106G 63M 101G 1% /mnt/sdc +/dev/vdb2 ext4 53G 55M 50G 1% /mnt/test+
If the server is restarted, the mounting will become invalid. You can set automatic mounting for partitions at system start by modifying the /etc/fstab file. For details, see Setting Automatic Mounting at System Start.
+
If the additional space is allocated to an existing partition, data on the disk will not be cleared but you must use umount to unmount the existing partition. In this case, services will be affected.
+Originally, data disk /dev/vdb has 150 GB and two partitions (/dev/vdb1 and /dev/vdb2), and then 80 GB is added to the disk. The following procedure shows you how to add this 80 GB to the existing MBR partition /dev/vdb2.
+
During an expansion, the additional space is added to the end of the disk. Therefore, if the disk has multiple partitions, the additional space can only be allocated to the partition at the disk end.
+fdisk -l
+[root@ecs-test-0001 ~]# fdisk -l + +Disk /dev/vda: 42.9 GB, 42949672960 bytes, 83886080 sectors +Units = sectors of 1 * 512 = 512 bytes +Sector size (logical/physical): 512 bytes / 512 bytes +I/O size (minimum/optimal): 512 bytes / 512 bytes +Disk label type: dos +Disk identifier: 0x000bcb4e + + Device Boot Start End Blocks Id System +/dev/vda1 * 2048 83886079 41942016 83 Linux + +Disk /dev/vdb: 247.0 GB, 246960619520 bytes, 482344960 sectors +Units = sectors of 1 * 512 = 512 bytes +Sector size (logical/physical): 512 bytes / 512 bytes +I/O size (minimum/optimal): 512 bytes / 512 bytes +Disk label type: dos +Disk identifier: 0x38717fc1 + + Device Boot Start End Blocks Id System +/dev/vdb1 2048 209715199 104856576 83 Linux +/dev/vdb2 209715200 314572799 52428800 83 Linux+
In the command output, take note of the partition's start and end sectors. In this example, /dev/vdb2's start sector is 209715200, and its end sector is 314572799.
+umount Disk partition
+In this example, run the following command:
+umount /dev/vdb2
+fdisk Disk
+In this example, run the following command:
+fdisk /dev/vdb
+[root@ecs-test-0001 ~]# fdisk /dev/vdb +Welcome to fdisk (util-linux 2.23.2). + +Changes will remain in memory only, until you decide to write them. +Be careful before using the write command. + + +Command (m for help):+
Command (m for help): d +Partition number (1,2, default 2):+
Partition number (1,2, default 2): 2 +Partition 2 is deleted + +Command (m for help):+
After deleting the partition, recreate the partition according to the following steps, and data on this disk will not be lost.
+Command (m for help): n +Partition type: + p primary (1 primary, 0 extended, 3 free) + e extended +Select (default p):+
If the MBR partition style is used, a maximum of 4 primary partitions, or 3 primary partitions and 1 extended partition can be created. The extended partition cannot be used directly and must be divided into logical partitions before use.
+Disk partitions created using GPT are not categorized.
+Select (default p): p +Partition number (2-4, default 2):+
Partition number indicates the serial number of the primary partition.
+Partition number (2-4, default 2): 2 +First sector (209715200-482344959, default 209715200):+
In the command output, First sector specifies the start sector.
+
First sector (209715200-482344959, default 209715200):
+Using default value 209715200
+Last sector, +sectors or +size{K,M,G} (209715200-482344959, default 482344959):
+In the command output, Last sector specifies the end sector.
+Using default value 209715200
+Last sector, +sectors or +size{K,M,G} (209715200-482344959, default 482344959):
+Using default value 482344959
+Partition 2 of type Linux and of size 130 GiB is set
+
+Command (m for help):
+The partition is created.
+Command (m for help): p + +Disk /dev/vdb: 247.0 GB, 246960619520 bytes, 482344960 sectors +Units = sectors of 1 * 512 = 512 bytes +Sector size (logical/physical): 512 bytes / 512 bytes +I/O size (minimum/optimal): 512 bytes / 512 bytes +Disk label type: dos +Disk identifier: 0x38717fc1 + + Device Boot Start End Blocks Id System +/dev/vdb1 2048 209715199 104856576 83 Linux +/dev/vdb2 209715200 482344959 136314880 83 Linux + +Command (m for help):+
Command (m for help): w +The partition table has been altered! + +Calling ioctl() to re-read partition table. + +WARNING: Re-reading the partition table failed with error 16: Device or resource busy. +The kernel still uses the old table. The new table will be used at +the next reboot or after you run partprobe(8) or kpartx(8) +Syncing disks.+
In case that you want to discard the changes made before, you can exit fdisk by entering q.
+partprobe
+In this example, run the following command:
+e2fsck -f /dev/vdb2
+[root@ecs-test-0001 ~]# e2fsck -f /dev/vdb2 +e2fsck 1.42.9 (28-Dec-2013) +Pass 1: Checking inodes, blocks, and sizes +Pass 2: Checking directory structure +Pass 3: Checking directory connectivity +Pass 4: Checking reference counts +Pass 5: Checking group summary information +/dev/vdb2: 11/3276800 files (0.0% non-contiguous), 251790/13107200 blocks+
In this example, run the following command:
+resize2fs /dev/vdb2
+[root@ecs-test-0001 ~]# resize2fs /dev/vdb2 +resize2fs 1.42.9 (28-Dec-2013) +Resizing the filesystem on /dev/vdb2 to 34078720 (4k) blocks. +The filesystem on /dev/vdb2 is now 34078720 blocks long.+
Perform this step if you want to mount the partition on a new mount point.
+mkdir Mount point
+In this example, run the following command to create the /mnt/test mount point:
+mkdir /mnt/test
+mount Disk partition Mount point
+In this example, run the following command to the mount partition /dev/vdb2 on /mnt/test:
+mount /dev/vdb2 /mnt/test
+
If the new partition is mounted on a directory that is not empty, the subdirectories and files in the directory will be hidden. Therefore, you are advised to mount the new partition on an empty directory or a new directory. If the new partition must be mounted on a directory that is not empty, move the subdirectories and files in this directory to another directory temporarily. After the partition is successfully mounted, move the subdirectories and files back.
+Perform this step if you want to mount the partition on a new mount point.
+mkdir Mount point
+In this example, run the following command to create the /mnt/test mount point:
+mkdir /mnt/test
+mount Disk partition Mount point
+In this example, run the following command to the mount partition /dev/vdb2 on /mnt/test:
+mount /dev/vdb2 /mnt/test
+
If the new partition is mounted on a directory that is not empty, the subdirectories and files in the directory will be hidden. Therefore, you are advised to mount the new partition on an empty directory or a new directory. If the new partition must be mounted on a directory that is not empty, move the subdirectories and files in this directory to another directory temporarily. After the partition is successfully mounted, move the subdirectories and files back.
+sudo xfs_growfs Disk partition
+In this example, run the following command:
+sudo xfs_growfs /dev/vdb2
+Information similar to the following is displayed:
+[root@ecs-test-0001 ~]# sudo xfs_growfs /dev/vdb2 +meta-data=/dev/vdb2 isize=512 agcount=4, agsize=3276800 blks + = sectsz=512 attr=2, projid32bit=1 + = crc=1 finobt=0, spinodes=0 +data = bsize=4096 blocks=13107200, imaxpct=25 + = sunit=0 swidth=0 blks +naming =version2 bsize=4096 ascii-ci=0 ftype=1 +log =internal bsize=4096 blocks=6400, version=2 + = sectsz=512 sunit=0 blks, lazy-count=1 +realtime =none extsz=4096 blocks=0, rtextents=0 +data blocks changed from 13107200 to 34078720.+
df -TH
+[root@ecs-test-0001 ~]# df -TH +Filesystem Type Size Used Avail Use% Mounted on +/dev/vda1 ext4 43G 1.9G 39G 5% / +devtmpfs devtmpfs 2.0G 0 2.0G 0% /dev +tmpfs tmpfs 2.0G 0 2.0G 0% /dev/shm +tmpfs tmpfs 2.0G 9.1M 2.0G 1% /run +tmpfs tmpfs 2.0G 0 2.0G 0% /sys/fs/cgroup +tmpfs tmpfs 398M 0 398M 0% /run/user/0 +/dev/vdb1 ext4 106G 63M 101G 1% /mnt/sdc +/dev/vdb2 ext4 138G 63M 131G 1% /mnt/test+
If the server is restarted, the mounting will become invalid. You can set automatic mounting for partitions at system start by modifying the /etc/fstab file. For details, see Setting Automatic Mounting at System Start.
+Originally, data disk /dev/vdb has 100 GB and one partition (/dev/vdb1), and then 50 GB is added to the disk. The following procedure shows you how to create a new GPT partition /dev/vdb2 with this 50 GB.
+lsblk
+[root@ecs-test-0001 ~]# lsblk +NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINT +vda 253:0 0 40G 0 disk +└─vda1 253:1 0 40G 0 part / +vdb 253:16 0 150G 0 disk +└─vdb1 253:17 0 100G 0 part /mnt/sdc+
parted Disk
+In this example, run the following command:
+parted /dev/vdb
+[root@ecs-test-0001 ~]# parted /dev/vdb +GNU Parted 3.1 +Using /dev/vdb +Welcome to GNU Parted! Type 'help' to view a list of commands. +(parted)+
(parted) unit s +(parted) p +Error: The backup GPT table is not at the end of the disk, as it should be. This might mean that another operating system believes the +disk is smaller. Fix, by moving the backup to the end (and removing the old backup)? +Fix/Ignore/Cancel? Fix +Warning: Not all of the space available to /dev/vdb appears to be used, you can fix the GPT to use all of the space (an extra 104857600 +blocks) or continue with the current setting? +Fix/Ignore? Fix +Model: Virtio Block Device (virtblk) +Disk /dev/vdb: 314572800s +Sector size (logical/physical): 512B/512B +Partition Table: gpt +Disk Flags: + +Number Start End Size File system Name Flags + 1 2048s 209713151s 209711104s ext4 test + +(parted)+
Error: The backup GPT table is not at the end of the disk, as it should be. This might mean that another operating system believes the +disk is smaller. Fix, by moving the backup to the end (and removing the old backup)?+
The GPT partition table information is stored at the start of the disk. To reduce the risk of damage, a backup of the information is saved at the end of the disk. When you expand the disk capacity, the end of the disk changes accordingly. In this case, enter Fix to move the backup file of the information to new disk end.
+Warning: Not all of the space available to /dev/vdb appears to be used, you can fix the GPT to use all of the space (an extra 104857600 +blocks) or continue with the current setting? +Fix/Ignore? Fix+
Enter Fix as prompted. The system automatically sets the GPT partition style for the additional space.
+mkpart Partition name Start sector End sector
+In this example, run the following command:
+mkpart data 209713152s 100%
+In this example, the additional space is used to create a new partition. In 4, the end sector of partition dev/vdb1 is 209713151s. Therefore, the start sector of the new partition dev/vdb2 is set to 209713152s and the end sector 100%. This start and end sectors are for reference only. You can plan the number of partitions and partition size based on service requirements.
+(parted) mkpart data 209713152s 100% +(parted)+
(parted) p +Model: Virtio Block Device (virtblk) +Disk /dev/vdb: 314572800s +Sector size (logical/physical): 512B/512B +Partition Table: gpt +Disk Flags: + +Number Start End Size File system Name Flags + 1 2048s 209713151s 209711104s ext4 test + 2 209713152s 314570751s 104857600s data + +(parted)+
(parted) q +Information: You may need to update /etc/fstab.+
You can set automatic disk mounting by updating the /etc/fstab file. Before updating the file, set the file system format for the partition and mount the partition on the mount point.
+mkfs -t File system Disk partition
+Information similar to the following is displayed:
+[root@ecs-test-0001 ~]# mkfs -t ext4 /dev/vdb2 +mke2fs 1.42.9 (28-Dec-2013) +Filesystem label= +OS type: Linux +Block size=4096 (log=2) +Fragment size=4096 (log=2) +Stride=0 blocks, Stripe width=0 blocks +3276800 inodes, 13107200 blocks +655360 blocks (5.00%) reserved for the super user +First data block=0 +Maximum filesystem blocks=2162163712 +400 block groups +32768 blocks per group, 32768 fragments per group +8192 inodes per group +Superblock backups stored on blocks: + 32768, 98304, 163840, 229376, 294912, 819200, 884736, 1605632, 2654208, + 4096000, 7962624, 11239424 + +Allocating group tables: done +Writing inode tables: done +Creating journal (32768 blocks): done +Writing superblocks and filesystem accounting information: done+
Information similar to the following is displayed:
+[root@ecs-test-0001 ~]# mkfs -t xfs /dev/vdb2 +meta-data=/dev/vdb2 isize=512 agcount=4, agsize=3276800 blks + = sectsz=512 attr=2, projid32bit=1 + = crc=1 finobt=0, sparse=0 +data = bsize=4096 blocks=13107200, imaxpct=25 + = sunit=0 swidth=0 blks +naming =version2 bsize=4096 ascii-ci=0 ftype=1 +log =internal log bsize=4096 blocks=6400, version=2 + = sectsz=512 sunit=0 blks, lazy-count=1 +realtime =none extsz=4096 blocks=0, rtextents=0+
The formatting takes a while, and you need to observe the system running status. Once done is displayed in the command output, the formatting is complete.
+Perform this step if you want to mount the partition on a new mount point.
+mkdir Mount point
+In this example, run the following command to create the /mnt/test mount point:
+mkdir /mnt/test
+mount Disk partition Mount point
+In this example, run the following command to mount the new partition /dev/vdb2 on /mnt/test:
+mount /dev/vdb2 /mnt/test
+
If the new partition is mounted on a directory that is not empty, the subdirectories and files in the directory will be hidden. Therefore, you are advised to mount the new partition on an empty directory or a new directory. If the new partition must be mounted on a directory that is not empty, move the subdirectories and files in this directory to another directory temporarily. After the partition is successfully mounted, move the subdirectories and files back.
+df -TH
+[root@ecs-test-0001 ~]# df -TH +Filesystem Type Size Used Avail Use% Mounted on +/dev/vda1 ext4 43G 1.9G 39G 5% / +devtmpfs devtmpfs 2.0G 0 2.0G 0% /dev +tmpfs tmpfs 2.0G 0 2.0G 0% /dev/shm +tmpfs tmpfs 2.0G 9.1M 2.0G 1% /run +tmpfs tmpfs 2.0G 0 2.0G 0% /sys/fs/cgroup +tmpfs tmpfs 398M 0 398M 0% /run/user/0 +/dev/vdb1 ext4 106G 63M 101G 1% /mnt/sdc +/dev/vdb2 ext4 53G 55M 50G 1% /mnt/test+
If the server is restarted, the mounting will become invalid. You can set automatic mounting for partitions at system start by modifying the /etc/fstab file. For details, see Setting Automatic Mounting at System Start.
+
If the additional space is allocated to an existing partition, data on the disk will not be cleared but you must use umount to unmount the existing partition. In this case, services will be affected.
+Originally, data disk /dev/vdb has 150 GB and two partitions (/dev/vdb1 and /dev/vdb2), and then 80 GB is added to the disk. The following procedure shows you how to add this 80 GB to the existing GPT partition /dev/vdb2.
+During an expansion, the additional space is added to the end of the disk. Therefore, if the disk has multiple partitions, the additional space can only be allocated to the partition at the disk end.
+lsblk
+[root@ecs-test-0001 ~]# lsblk +NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINT +vda 253:0 0 40G 0 disk +└─vda1 253:1 0 40G 0 part / +vdb 253:16 0 230G 0 disk +├─vdb1 253:17 0 100G 0 part /mnt/sdc +└─vdb2 253:18 0 50G 0 part /mnt/test+
umount Disk partition
+In this example, run the following command:
+umount /dev/vdb2
+lsblk
+[root@ecs-test-0001 ~]# lsblk +NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINT +vda 253:0 0 40G 0 disk +└─vda1 253:1 0 40G 0 part / +vdb 253:16 0 230G 0 disk +├─vdb1 253:17 0 100G 0 part /mnt/sdc +└─vdb2 253:18 0 50G 0 part+
parted Disk
+In this example, run the following command:
+parted /dev/vdb
+[root@ecs-test-0001 ~]# parted /dev/vdb +GNU Parted 3.1 +Using /dev/vdb +Welcome to GNU Parted! Type 'help' to view a list of commands. +(parted)+
(parted) unit s +(parted) p +Error: The backup GPT table is not at the end of the disk, as it should be. This might mean that another operating system believes the +disk is smaller. Fix, by moving the backup to the end (and removing the old backup)? +Fix/Ignore/Cancel? Fix +Warning: Not all of the space available to /dev/vdb appears to be used, you can fix the GPT to use all of the space (an extra 167772160 +blocks) or continue with the current setting? +Fix/Ignore? Fix +Model: Virtio Block Device (virtblk) +Disk /dev/vdb: 482344960s +Sector size (logical/physical): 512B/512B +Partition Table: gpt +Disk Flags: + +Number Start End Size File system Name Flags + 1 2048s 209713151s 209711104s ext4 test + 2 209713152s 314570751s 104857600s ext4 data + +(parted)+
Error: The backup GPT table is not at the end of the disk, as it should be. This might mean that another operating system believes the +disk is smaller. Fix, by moving the backup to the end (and removing the old backup)?+
The GPT partition table information is stored at the start of the disk. To reduce the risk of damage, a backup of the information is saved at the end of the disk. When you expand the disk capacity, the end of the disk changes accordingly. In this case, enter Fix to move the backup file of the information to new disk end.
+Warning: Not all of the space available to /dev/vdb appears to be used, you can fix the GPT to use all of the space (an extra 104857600 +blocks) or continue with the current setting? +Fix/Ignore? Fix+
Enter Fix as prompted. The system automatically sets the GPT partition style for the additional space.
+(parted) rm +Partition number? 2 +(parted)+
mkpart Partition name Start sector End sector
+In this example, run the following command:
+mkpart data 209713152s 100%
+(parted) mkpart data 209713152s 100% +(parted)+
(parted) p +Model: Virtio Block Device (virtblk) +Disk /dev/vdb: 482344960s +Sector size (logical/physical): 512B/512B +Partition Table: gpt +Disk Flags: + +Number Start End Size File system Name Flags + 1 2048s 209713151s 209711104s ext4 test + 2 209713152s 482342911s 272629760s ext4 data + +(parted)+
(parted) q +Information: You may need to update /etc/fstab.+
You can set automatic disk mounting by updating the /etc/fstab file. Before updating the file, set the file system format for the partition and mount the partition on the mount point.
+In this example, run the following command:
+e2fsck -f /dev/vdb2
+[root@ecs-test-0001 ~]# e2fsck -f /dev/vdb2 +e2fsck 1.42.9 (28-Dec-2013) +Pass 1: Checking inodes, blocks, and sizes +Pass 2: Checking directory structure +Pass 3: Checking directory connectivity +Pass 4: Checking reference counts +Pass 5: Checking group summary information +/dev/vdb2: 11/3276800 files (0.0% non-contiguous), 251790/13107200 blocks+
In this example, run the following command:
+resize2fs /dev/vdb2
+[root@ecs-test-0001 ~]# resize2fs /dev/vdb2 +resize2fs 1.42.9 (28-Dec-2013) +Resizing the filesystem on /dev/vdb2 to 34078720 (4k) blocks. +The filesystem on /dev/vdb2 is now 34078720 blocks long.+
Perform this step if you want to mount the partition on a new mount point.
+mkdir Mount point
+In this example, run the following command to create the /mnt/test mount point:
+mkdir /mnt/test
+mount Disk partition Mount point
+In this example, run the following command to the mount partition /dev/vdb2 on /mnt/test:
+mount /dev/vdb2 /mnt/test
+
If the new partition is mounted on a directory that is not empty, the subdirectories and files in the directory will be hidden. Therefore, you are advised to mount the new partition on an empty directory or a new directory. If the new partition must be mounted on a directory that is not empty, move the subdirectories and files in this directory to another directory temporarily. After the partition is successfully mounted, move the subdirectories and files back.
+Perform this step if you want to mount the partition on a new mount point.
+mkdir Mount point
+In this example, run the following command to create the /mnt/test mount point:
+mkdir /mnt/test
+mount Disk partition Mount point
+In this example, run the following command to the mount partition /dev/vdb2 on /mnt/test:
+mount /dev/vdb2 /mnt/test
+
If the new partition is mounted on a directory that is not empty, the subdirectories and files in the directory will be hidden. Therefore, you are advised to mount the new partition on an empty directory or a new directory. If the new partition must be mounted on a directory that is not empty, move the subdirectories and files in this directory to another directory temporarily. After the partition is successfully mounted, move the subdirectories and files back.
+sudo xfs_growfs Disk partition
+In this example, run the following command:
+sudo xfs_growfs /dev/vdb2
+Information similar to the following is displayed:
+[root@ecs-test-0001 ~]# sudo xfs_growfs /dev/vdb2 +meta-data=/dev/vdb2 isize=512 agcount=4, agsize=3276800 blks + = sectsz=512 attr=2, projid32bit=1 + = crc=1 finobt=0, spinodes=0 +data = bsize=4096 blocks=13107200, imaxpct=25 + = sunit=0 swidth=0 blks +naming =version2 bsize=4096 ascii-ci=0 ftype=1 +log =internal bsize=4096 blocks=6400, version=2 + = sectsz=512 sunit=0 blks, lazy-count=1 +realtime =none extsz=4096 blocks=0, rtextents=0 +data blocks changed from 13107200 to 34078720.+
df -TH
+[root@ecs-test-0001 ~]# df -TH +Filesystem Type Size Used Avail Use% Mounted on +/dev/vda1 ext4 43G 1.9G 39G 5% / +devtmpfs devtmpfs 2.0G 0 2.0G 0% /dev +tmpfs tmpfs 2.0G 0 2.0G 0% /dev/shm +tmpfs tmpfs 2.0G 9.1M 2.0G 1% /run +tmpfs tmpfs 2.0G 0 2.0G 0% /sys/fs/cgroup +tmpfs tmpfs 398M 0 398M 0% /run/user/0 +/dev/vdb1 ext4 106G 63M 101G 1% /mnt/sdc +/dev/vdb2 ext4 138G 63M 131G 1% /mnt/test+
If the server is restarted, the mounting will become invalid. You can set automatic mounting for partitions at system start by modifying the /etc/fstab file. For details, see Setting Automatic Mounting at System Start.
+Modify the fstab file to set automatic disk mounting at server start. You can also set automatic mounting for the servers containing data. This operation will not affect the existing data.
+The following procedure shows how to set automatic disk mounting at server start by using UUIDs to identify disks in the fstab file. You are advised not to use device names to identify disks in the file because a device name may change (for example, from /dev/vdb1 to /dev/vdb2) during the server stop or start, resulting in improper server running after restart.
+
UUID is the unique character string for disk partitions in a Linux system.
+blkid Disk partition
+In this example, run the following command to query the UUID of the /dev/vdb1 partition:
+blkid /dev/vdb1
+Information similar to the following is displayed:
+[root@ecs-test-0001 ~]# blkid /dev/vdb1 +/dev/vdb1: UUID="0b3040e2-1367-4abb-841d-ddb0b92693df" TYPE="ext4"+
The UUID of the /dev/vdb1 partition is displayed.
+vi /etc/fstab
+UUID=0b3040e2-1367-4abb-841d-ddb0b92693df /mnt/sdc ext4 defaults 0 2+
The system saves the configurations and exits the vi editor.
+In this example, run the following command:
+umount /dev/vdb1
+mount -a
+In this example, run the following command:
+mount | grep /mnt/sdc
+If information similar to the following is displayed, the automatic mounting function takes effect:
+root@ecs-test-0001 ~]# mount | grep /mnt/sdc +/dev/vdb1 on /mnt/sdc type ext4 (rw,relatime,data=ordered)+
EVS disk backups are created using the CBR service. For details, see Creating a Disk Backup Vault in the Cloud Backup and Recovery User Guide.
+ +This section describes how to configure a backup policy for disks. With backup policies configured, data on EVS disks can be periodically backed up to improve data security.
+
in the upper left corner and select the desired region and project.
A name must contain 1 to 64 characters including digits, letters, underscores (_), and hyphens (-), for example, vault-612c.
+
You can use the default name, which is in the format of vault_xxxx.
+You can associate disks to the new vault or create backups for disks. For details, see Vault Management in the Cloud Backup and Recovery User Guide.
+Release Date + |
+What's New + |
+
|---|---|
2022-04-15 + |
+Added the following content: +
|
+
2021-12-27 + |
+Modified the following content: +
|
+
2020-08-15 + |
+Added the following content: +
|
+
2019-04-09 + |
+Accepted in OTC-4.0/Agile-04.2019. + |
+
2019-02-15 + |
+Modified the following content: +
Modified the following content:
+
|
+
2018-11-30 + |
+Added the following content: +
|
+
2018-05-14 + |
+Modified the following content: +
|
+
2018-02-28 + |
+Added the following content: +
Modified the following content: +
|
+
2018-02-24 + |
+Modified the following content: +
|
+
2018-01-31 + |
+Added the following content: +
|
+
2018-01-25 + |
+Modified the following content: +
|
+
2018-01-19 + |
+Modified the following content: +
|
+
2017-12-01 + |
+Modified the following content: +
|
+
2017-11-30 + |
+Modified the following content: +
|
+
2017-10-28 + |
+Added the following content: +
|
+
2017-10-25 + |
+Modified the following content: +
|
+
2017-10-20 + |
+Modified the following content: +
|
+
2017-10-13 + |
+Added the following content: +
Modified the following content: +
|
+
2017-09-30 + |
+Added the following content: +
Modified the following content: +
|
+
2017-09-28 + |
+Modified the following content: +
|
+
2017-09-08 + |
+Added the following content: +
Modified the following content: +
|
+
2017-08-22 + |
+Modified the following content: +
|
+
2017-07-30 + |
+Added the following content: +
|
+
2017-06-15 + |
+Added the following content: +
|
+
2017-06-08 + |
+Modified the following content: +
|
+
2017-06-06 + |
+Added the following content: +
|
+
2017-06-05 + |
+Added the following content: +
Modified the following content: +
|
+
2017-06-01 + |
+Added the following content: +
|
+
2017-05-22 + |
+Modified the following content: +
|
+
2017-05-05 + |
+Added the following content: +
|
+
2017-04-30 + |
+Added the following content: +
|
+
2017-03-30 + |
+Added the following content: +
|
+
2017-02-08 + |
+Modified the following content: +
|
+
2017-02-03 + |
+Added the following content: +
Modified the following content: +
|
+
2017-01-23 + |
+Added the following content: +
|
+
2017-01-20 + |
+Added the following content: +
|
+
2016-10-28 + |
+Added the following content: +
Modified the following content: +
Deleted the following content: +
|
+
2016-09-23 + |
+Added the following content: +
Modified the following content: +
Deleted the following content: +
|
+
2016-09-18 + |
+This issue is the first official release. + |
+
For details about the terms involved in this document, see Glossary.
+
It depends on if the disk is encrypted or not.
+Before you detach an EVS disk encrypted by a CMK, check whether the CMK is disabled or scheduled for deletion. If the CMK is unavailable, the disk can still be used, but there is no guarantee how long it will be usable. If the disk is detached, it will not be possible to re-attach it later. In this case, do not detach the disk without a working CMK.
+The restoration method varies depending on the CMK status. For details, see EVS Disk Encryption.
+If the CMK is available, the disk can be detached and re-attached, and data on the disk will not be lost.
+To ensure your data safety, you are advised to follow the instructions described in Disk detachment process.
+Data on a disk will not be lost after the disk is detached, and the disk can be re-attached later if needed.
+To ensure your data safety, you are advised to follow the instructions described in Disk detachment process.
+If an error occurs, the disk may show one of the states listed in the following table. Take the measures described in the table to handle the exceptions.
+ +Error Status + |
+Handling Suggestion + |
+
|---|---|
Error + |
+Delete the disk in the Error state and create another one. +The disk will no longer be charged after an error has occurred. + |
+
Deletion failed + |
+Contact customer service. +The disk will no longer be charged after its status changes to Deletion failed. + |
+
Expansion failed + |
+Our customer service personnel will contact you and help you handle this error. Do not perform any operations on the disk before the customer service personnel contact you. If the issue is urgent, you can contact our customer service personnel directly. +The disk will no longer be charged after its status changes to Expansion failed. + |
+
Restoration failed + |
+Our customer service personnel will contact you and help you handle this error. Do not perform any operations on the disk before the customer service personnel contact you. If the issue is urgent, you can contact our customer service personnel directly. +The disk will no longer be charged after its status changes to Restoration failed. + |
+
Rollback failed + |
+You can roll back the snapshot data to the disk again. +The disk will no longer be charged after its status changes to Rollback failed. + |
+
If the system displays a message indicating insufficient quota during an EVS replication pair creation or a replication consistency group creation or update, contact the administrator to handle this issue.
+
EVS replication APIs have been deprecated. If you need to use the replication function, see Storage Disaster Recovery Service User Guide and Storage Disaster Recovery Service API Reference.
+EVS disks have two device types: VBD and SCSI. WWNs are used as the unique identifiers for SCSI EVS disks, and VBD EVS disks do not have WWNs.
+You can view the WWN of a SCSI EVS disk on the management console. The details are as follows:
+Figure 2 shows the query result.
+ +Symptom: A data disk has been attached to a Windows server on the management console, but the disk cannot be viewed on the server. For example, Volume (D:) was not shown in This PC of a Windows server running Windows Server 2012. Normally, Volume (D:) appears, as shown in Figure 1.
+ +Solution: New data disks are not formatted and partitioned by default. Only formatted and partitioned drives show up in This PC. You must manually initialize the disk before it can be viewed here.
+For details, see Introduction to Data Disk Initialization Scenarios and Partition Styles.
+Symptom: A data disk has been attached to a Linux server on the management console, but the disk cannot be viewed on the server.
+Run df -TH to view the disk information. CentOS 7.4 is used in this example. The normal command output is as follows:
+[root@ecs-test-0001 ~]# df -TH +Filesystem Type Size Used Avail Use% Mounted on +/dev/vda1 ext4 43G 1.9G 39G 5% / +devtmpfs devtmpfs 2.0G 0 2.0G 0% /dev +tmpfs tmpfs 2.0G 0 2.0G 0% /dev/shm +tmpfs tmpfs 2.0G 9.1M 2.0G 1% /run +tmpfs tmpfs 2.0G 0 2.0G 0% /sys/fs/cgroup +tmpfs tmpfs 398M 0 398M 0% /run/user/0 +/dev/vdb1 ext4 106G 63M 101G 1% /mnt/sdc+
Unlike the normal command output, only system disk /dev/vda1 is visible, but data disk /dev/vdb1 is missing from the command output.
+Solution
+For details, see Introduction to Data Disk Initialization Scenarios and Partition Styles.
+mount Disk partition Mount point
+In this example, run the following command:
+mount /dev/vdb1 /mnt/sdc
+Perform the following steps to enable automatic partition mounting at system start:
+In this example, run the following command to query the UUID of the /dev/vdb1 partition:
+blkid /dev/vdb1
+Information similar to the following is displayed:
+[root@ecs-test-0001 ~]# blkid /dev/vdb1 +/dev/vdb1: UUID="0b3040e2-1367-4abb-841d-ddb0b92693df" TYPE="ext4"+
The UUID of the /dev/vdb1 partition is displayed.
+vi /etc/fstab
+Press i to enter editing mode.
+UUID=0b3040e2-1367-4abb-841d-ddb0b92693df /mnt/sdc ext4 defaults 0 2+
When this parameter is set to 1 for the root partition, this parameter for other partitions must start with 2 because the system checks the partitions in the ascending order of the values.
+The system saves the configurations and exits the vi editor.
+In this example, run the following command:
+umount /dev/vdb1
+mount -a
+In this example, run the following command:
+mount | grep /mnt/sdc
+If information similar to the following is displayed, automatic mounting has been configured:
+root@ecs-test-0001 ~]# mount | grep /mnt/sdc +/dev/vdb1 on /mnt/sdc type ext4 (rw,relatime,data=ordered)+
An EVS system disk can be as large as 1 TB (1024 GB). You can expand the capacity of a system disk to up to 1 TB.
+In this case, if you want to expand the disk capacity to over 2 TB, change the partition style from MBR to GPT. Ensure that the disk data has been backed up before changing the partition style because services will be interrupted and data on the disk will be deleted during this change.
+No. The disk capacity can only be expanded, and temporary capacity expansion is not supported.
+After expanding disk capacity on the management console, you must log in to the server and extend the disk partition and file system for the extra capacity to become available. Otherwise, you cannot view the additional space on the server.
+The maximum capacity supported for a system disk is 1024 GB.
+The maximum capacity supported for a data disk is 32768 GB.
+If your disk capacity is greater than 2 TB, do not use fdisk to partition the disk. Or any space in excess of 2 TB will be unable to be displayed after the disk is partitioned.
+In this case, use parted to repartition the disk and choose the GPT partition style because MBR does not support disks over 2 TB.
+For details, see Introduction to Data Disk Initialization Scenarios and Partition Styles.
+No.
+Disks and the servers you attach the disks to must be in the same AZ. The same is true for shared disks. Shared disks can only be attached to the servers in the same AZ.
+A shared disk can be attached to up to 16 servers.
+Yes.
+If you simply attach a shared disk to multiple servers, files cannot be shared between the servers. If the rules for reading and writing data are not mutually agreed upon, the read and write operations may interfere with each other, or other unpredictable errors may occur.
+Shared EVS disks do not have cluster management capabilities. You need to build a cluster system for data sharing, such as Windows MSCS, Veritas VCS, and Veritas CFS clusters.
+An EVS disk can be expanded either in the Available or In-use state. Expanding the disk capacity on the management console enlarges the disk capacity, but you still need to log in to the server and extend the disk partitions and file systems to make that additional space usable. You may need to restart the server during the partition and file system extension. The details are as follows:
+Data disks can be created during or after the server creation. If you create data disks during the server creation, the system will automatically attach the data disks to the server. If you create data disks after the server creation, you need to attach them manually.
+For details, see Introduction to Data Disk Initialization Scenarios and Partition Styles.
+No.
+The AZ of a disk cannot be changed after you have created the disk. If you want to change the AZ, delete the disk and create a new one.
+You can view your disk usages in either of the following ways:
+The details depend on the OS. This FAQ uses Windows Server 2008, Windows Server 2016, and Linux as samples to describe how to view the disk usage.
+ +Some disk monitoring metrics require that the agent to be installed.
+Metric + |
+Parameter + |
+Description + |
+Value Range + |
+Monitored Object + |
+Monitoring Period (Raw Data) + |
+
|---|---|---|---|---|---|
mountPointPrefix_disk_free + |
+(Agent) Available Disk Space + |
+Free space on the disks +Unit: GB +
|
+≥ 0 + |
+ECS + |
+1 minute + |
+
mountPointPrefix_disk_total + |
+(Agent) Disk Storage Capacity + |
+Total space on the disks, including used and free +Unit: GB +
|
+≥ 0 + |
+ECS + |
+1 minute + |
+
mountPointPrefix_disk_used + |
+(Agent) Used Disk Space + |
+Used space on the disks +Unit: GB +
|
+≥ 0 + |
+ECS + |
+1 minute + |
+
mountPointPrefix_disk_usedPercent + |
+(Agent) Disk Usage + |
+Percentage of total disk space that is used, which is calculated as follows: Disk Usage = Used Disk Space/Disk Storage Capacity +Unit: percent +
|
+0-100 + |
+ECS + |
+1 minute + |
+
In this section, Windows Server 2008 R2 Enterprise 64bit is used as an example.
+The Server Manager window is displayed.
+The sizes and available spaces of the volumes on the current disk are displayed in the middle pane.
+
In this section, Windows Server 2016 Standard 64bit is used as an example.
+The Windows Server window is displayed.
+The Server Manager window is displayed.
+
In the middle pane, you can view the sizes and available spaces of the volumes on the disk.
+
In this section, CentOS 7.4 64bit is used as an example. The details depend on if you need to view the available space or not.
+[root@ecs-test-0001 ~]# lsblk +NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINT +vda 253:0 0 40G 0 disk +└─vda1 253:1 0 40G 0 part / +vdb 253:16 0 40G 0 disk +└─vdb1 253:17 0 40G 0 part+
In the command output, the server has two disks, /dev/vda and /dev/vdb. System disk /dev/vda has 40 GB of capacity, as does data disk /dev/vdb.
+Information similar to the following is displayed:
+[root@ecs-0001 ~]# df -TH +Filesystem Type Size Used Avail Use% Mounted on +/dev/vda1 ext4 43G 2.0G 39G 5% / +devtmpfs devtmpfs 509M 0 509M 0% /dev +tmpfs tmpfs 520M 0 520M 0% /dev/shm +tmpfs tmpfs 520M 7.2M 513M 2% /run +tmpfs tmpfs 520M 0 520M 0% /sys/fs/cgroup +tmpfs tmpfs 104M 0 104M 0% /run/user/0 +/dev/vdb1 ext4 43G 51M 40G 1% /mnt/sdc+
In the command output, the server has two partitions, /dev/vda1 and /dev/vdb1. Partition /dev/vda1 is used to deploy the OS, and its total capacity, used capacity, and available capacity are 43 GB, 2 GB, and 39 GB, respectively. Partition /dev/vdb1's total capacity, used capacity, and available capacity are 43 GB, 51 MB, and 40 GB, respectively.
+No.
+EVS disks must be attached to servers before you can use them.
+EVS disks can be used as system disks or data disks, but the way you detach each one is different.
+
In Linux, a system disk is typically mounted on /dev/vda. In Windows, a system disk is normally Volume (C:).
+
In Linux, a data disk is typically mounted on a mount point other than /dev/vda. In Windows, a data disk is normally a volume other than Volume (C:).
+