From fdf6843d7ac7df17039cee244ba055dd2b2b508e Mon Sep 17 00:00:00 2001 From: "Zaoxu, Li" Date: Thu, 11 Jan 2024 14:47:14 +0000 Subject: [PATCH] ims_api1226 Reviewed-by: Pristromskaia, Margarita Co-authored-by: Zaoxu, Li Co-committed-by: Zaoxu, Li --- docs/ecs/umn/test1702972479873.txt | 1 + docs/ims/api-ref/ALL_META.TXT.json | 735 ++++++++++++- docs/ims/api-ref/CLASS.TXT.json | 44 +- .../api-ref/en-us_topic_0000001311190309.html | 2 +- docs/ims/api-ref/en-us_topic_0020091553.html | 36 +- docs/ims/api-ref/en-us_topic_0020091554.html | 4 +- docs/ims/api-ref/en-us_topic_0020091555.html | 869 ++++++++-------- docs/ims/api-ref/en-us_topic_0020091556.html | 975 +++++++++--------- docs/ims/api-ref/en-us_topic_0020091562.html | 14 +- docs/ims/api-ref/en-us_topic_0020091565.html | 677 ++++++------ docs/ims/api-ref/en-us_topic_0020091566.html | 501 ++++----- docs/ims/api-ref/en-us_topic_0020091567.html | 565 +++++----- docs/ims/api-ref/en-us_topic_0020092108.html | 66 +- docs/ims/api-ref/en-us_topic_0020092109.html | 366 +++---- docs/ims/api-ref/en-us_topic_0020092111.html | 36 +- docs/ims/api-ref/en-us_topic_0022473688.html | 319 +++--- docs/ims/api-ref/en-us_topic_0022473689.html | 43 +- docs/ims/api-ref/en-us_topic_0024735403.html | 28 +- docs/ims/api-ref/en-us_topic_0031615565.html | 239 ++--- docs/ims/api-ref/en-us_topic_0031615566.html | 33 +- docs/ims/api-ref/en-us_topic_0036994315.html | 84 +- docs/ims/api-ref/en-us_topic_0036994317.html | 133 +-- docs/ims/api-ref/en-us_topic_0036994318.html | 148 +-- docs/ims/api-ref/en-us_topic_0036994319.html | 113 +- docs/ims/api-ref/en-us_topic_0036994320.html | 151 +-- docs/ims/api-ref/en-us_topic_0036994321.html | 38 +- docs/ims/api-ref/en-us_topic_0036994322.html | 109 +- docs/ims/api-ref/en-us_topic_0036994323.html | 180 ++-- docs/ims/api-ref/en-us_topic_0036994324.html | 135 +-- docs/ims/api-ref/en-us_topic_0037131984.html | 71 +- docs/ims/api-ref/en-us_topic_0049147856.html | 87 +- docs/ims/api-ref/en-us_topic_0049147876.html | 199 ++-- docs/ims/api-ref/en-us_topic_0049147877.html | 291 +++--- docs/ims/api-ref/en-us_topic_0060804959.html | 721 ++++++------- docs/ims/api-ref/en-us_topic_0060804960.html | 609 +++++------ docs/ims/api-ref/en-us_topic_0066978719.html | 303 +++--- docs/ims/api-ref/en-us_topic_0066978720.html | 329 +++--- docs/ims/api-ref/en-us_topic_0066978721.html | 233 ++--- docs/ims/api-ref/en-us_topic_0066978722.html | 55 +- docs/ims/api-ref/en-us_topic_0067360381.html | 75 +- docs/ims/api-ref/en-us_topic_0067360382.html | 91 +- docs/ims/api-ref/en-us_topic_0083905788.html | 155 +-- docs/ims/api-ref/en-us_topic_0092380109.html | 242 +++-- docs/ims/api-ref/en-us_topic_0093967372.html | 149 +-- docs/ims/api-ref/en-us_topic_0102682861.html | 542 +++++----- docs/ims/api-ref/en-us_topic_0102682862.html | 161 +-- docs/ims/api-ref/en-us_topic_0102682863.html | 60 +- docs/ims/api-ref/en-us_topic_0102682864.html | 36 +- docs/ims/api-ref/en-us_topic_0102682865.html | 107 +- docs/ims/api-ref/en-us_topic_0102682866.html | 131 +-- docs/ims/api-ref/en-us_topic_0122410336.html | 10 +- docs/ims/api-ref/en-us_topic_0125866390.html | 17 +- docs/ims/api-ref/en-us_topic_0125866391.html | 22 +- docs/ims/api-ref/en-us_topic_0125866392.html | 10 +- docs/ims/api-ref/en-us_topic_0125866393.html | 20 +- docs/ims/api-ref/en-us_topic_0125866394.html | 6 +- docs/ims/api-ref/en-us_topic_0125866395.html | 8 +- docs/ims/api-ref/en-us_topic_0133188204.html | 278 +++-- docs/ims/api-ref/en-us_topic_0135482660.html | 6 +- docs/ims/api-ref/en-us_topic_0170918588.html | 147 +-- docs/ims/api-ref/en-us_topic_0171654733.html | 6 +- 61 files changed, 6277 insertions(+), 5544 deletions(-) create mode 100644 docs/ecs/umn/test1702972479873.txt diff --git a/docs/ecs/umn/test1702972479873.txt b/docs/ecs/umn/test1702972479873.txt new file mode 100644 index 000000000..1614bf75e --- /dev/null +++ b/docs/ecs/umn/test1702972479873.txt @@ -0,0 +1 @@ +D:\02CBR\13gitea\doc-exports\docs\ecs\umn diff --git a/docs/ims/api-ref/ALL_META.TXT.json b/docs/ims/api-ref/ALL_META.TXT.json index 7d6bde523..60c18a669 100644 --- a/docs/ims/api-ref/ALL_META.TXT.json +++ b/docs/ims/api-ref/ALL_META.TXT.json @@ -1,741 +1,1410 @@ [ + { + "dockw":"API Reference" + }, { "uri":"en-us_topic_0020507759.html", + "node_id":"en-us_topic_0020507759.xml", "product_code":"ims", "code":"1", "des":"Public cloud 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 ", "doc_type":"api", "kw":"API Usage Guidelines,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"API Usage Guidelines", "githuburl":"" }, { "uri":"en-us_topic_0122410333.html", + "node_id":"en-us_topic_0122410333.xml", "product_code":"ims", "code":"2", "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":"IMS APIs", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"IMS APIs", "githuburl":"" }, { "uri":"en-us_topic_0135460761.html", + "node_id":"en-us_topic_0135460761.xml", "product_code":"ims", "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":"Image", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Image", "githuburl":"" }, { "uri":"en-us_topic_0020091565.html", + "node_id":"en-us_topic_0020091565.xml", "product_code":"ims", "code":"4", "des":"This API is used to query images using search criteria and to display the images in a list.GET /v2/cloudimages{?__isregistered,__imagetype,__whole_image,__system__cmkid,p", "doc_type":"api", "kw":"Querying Images,Image,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Querying Images", "githuburl":"" }, { "uri":"en-us_topic_0020091567.html", + "node_id":"en-us_topic_0020091567.xml", "product_code":"ims", "code":"5", - "des":"This API is used to modify image attributes and update image information.Only information of images in active status can be changed.PATCH /v2/cloudimages/{image_id}Table ", + "des":"This API is used to update image information.Only active images can be updated.PATCH /v2/cloudimages/{image_id}Table 1 lists the parameters in the URI.Request parametersP", "doc_type":"api", "kw":"Updating Image Information,Image,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Updating Image Information", "githuburl":"" }, { "uri":"en-us_topic_0020092109.html", + "node_id":"en-us_topic_0020092109.xml", "product_code":"ims", "code":"6", "des":"This API is used to create a private image. The following methods are supported:Create a system or data disk image from an ECS.Create a system disk image from an external", "doc_type":"api", "kw":"Creating an Image,Image,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Creating an Image", "githuburl":"" }, { "uri":"en-us_topic_0133188204.html", + "node_id":"en-us_topic_0133188204.xml", "product_code":"ims", "code":"7", "des":"This API is used to quickly create a private image from an oversized external image file that has uploaded to the OBS bucket. Currently, only ZVHD2 and RAW image files ar", "doc_type":"api", "kw":"Importing an Image File Quickly,Image,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Importing an Image File Quickly", "githuburl":"" }, { "uri":"en-us_topic_0083905788.html", + "node_id":"en-us_topic_0083905788.xml", "product_code":"ims", "code":"8", "des":"This API is used to create a data disk image from a data disk image file uploaded to the OBS bucket. The API is an asynchronous one. If it is successfully called, the clo", "doc_type":"api", "kw":"Creating a Data Disk Image Using an External Image File,Image,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Creating a Data Disk Image Using an External Image File", "githuburl":"" }, { "uri":"en-us_topic_0092380109.html", + "node_id":"en-us_topic_0092380109.xml", "product_code":"ims", "code":"9", "des":"This API is used to create a full-ECS image from an ECS, Cloud Server Backup Service (CSBS) backup, or Cloud Backup and Recovery (CBR) backup. The API is an asynchronous ", "doc_type":"api", "kw":"SAN policies,Creating a Full-ECS Image,Image,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Creating a Full-ECS Image", "githuburl":"" }, { "uri":"en-us_topic_0037131984.html", + "node_id":"en-us_topic_0037131984.xml", "product_code":"ims", "code":"10", "des":"This API is used to register an image file as an uninitialized private image on the cloud platform.The following describes how to use this API:Upload the image file to an", "doc_type":"api", "kw":"Registering an Image,Image,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Registering an Image", "githuburl":"" }, { "uri":"en-us_topic_0036994315.html", + "node_id":"en-us_topic_0036994315.xml", "product_code":"ims", "code":"11", - "des":"This is an extension API and used to export a private image to an OBS bucket.Before exporting an image, ensure that you have the Tenant Administrator permission for OBS.T", + "des":"This is an extension API and used to export a private image to an OBS bucket.Before exporting an image, ensure that you have the Tenant Administrator permission for OBS.A", "doc_type":"api", "kw":"Exporting an Image,Image,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Exporting an Image", "githuburl":"" }, { "uri":"en-us_topic_0135481402.html", + "node_id":"en-us_topic_0135481402.xml", "product_code":"ims", "code":"12", "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":"Image Tagging", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Image Tagging", "githuburl":"" }, { "uri":"en-us_topic_0067360381.html", + "node_id":"en-us_topic_0067360381.xml", "product_code":"ims", "code":"13", "des":"This API is used to add a tag to an image or modify a tag of an image. With tags, you can manage easily the images.PUT /v1/cloudimages/tagsRequest parametersParameterMand", "doc_type":"api", "kw":"Adding or Modifying a Tag,Image Tagging,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Adding or Modifying a Tag", "githuburl":"" }, { "uri":"en-us_topic_0067360382.html", + "node_id":"en-us_topic_0067360382.xml", "product_code":"ims", "code":"14", "des":"This API is used to query image tags using search criteria and display them in a list.GET /v1/cloudimages/tags{?__isregistered,__imagetype,__whole_image,__system__cmkid,p", "doc_type":"api", "kw":"Querying Tags,Image Tagging,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Querying Tags", "githuburl":"" }, { "uri":"en-us_topic_0102682861.html", + "node_id":"en-us_topic_0102682861.xml", "product_code":"ims", "code":"15", "des":"This API is used to filter or count images using tags or other conditions.To be compatible with remaining tags, the system will not verify the character set of the tag ke", "doc_type":"api", "kw":"Querying Images by Tag,Image Tagging,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Querying Images by Tag", "githuburl":"" }, { "uri":"en-us_topic_0102682862.html", + "node_id":"en-us_topic_0102682862.xml", "product_code":"ims", "code":"16", "des":"This API is used to add tags to, update tags of, or delete tags from an image in batches.Each tag consists of a key and a value. The key contains at most 36 characters, a", "doc_type":"api", "kw":"Adding or Deleting Image Tags in Batches,Image Tagging,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Adding or Deleting Image Tags in Batches", "githuburl":"" }, { "uri":"en-us_topic_0102682863.html", + "node_id":"en-us_topic_0102682863.xml", "product_code":"ims", "code":"17", "des":"This API is used to add a tag to an image or update a tag.Each tag consists of a key and a value. The key contains at most 36 characters, and the value contains at most 4", "doc_type":"api", "kw":"Adding an Image Tag,Image Tagging,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Adding an Image Tag", "githuburl":"" }, { "uri":"en-us_topic_0102682864.html", + "node_id":"en-us_topic_0102682864.xml", "product_code":"ims", "code":"18", "des":"This API is used to delete a specified tag from an image.To be compatible with remaining tags, the system will not verify the character set and length of the keys and val", "doc_type":"api", "kw":"Deleting an Image Tag,Image Tagging,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Deleting an Image Tag", "githuburl":"" }, { "uri":"en-us_topic_0102682865.html", + "node_id":"en-us_topic_0102682865.xml", "product_code":"ims", "code":"19", "des":"This API is used to query all the tags of a specified image.GET /v2/{project_id}/images/{image_id}/tagsTable 1 lists the parameters in the URI.Parameter descriptionParame", "doc_type":"api", "kw":"Querying Tags of an Image,Image Tagging,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Querying Tags of an Image", "githuburl":"" }, { "uri":"en-us_topic_0102682866.html", + "node_id":"en-us_topic_0102682866.xml", "product_code":"ims", "code":"20", "des":"This API is used to query all the image tags.GET /v2/{project_id}/images/tagsTable 1 lists the parameters in the URI.Parameter descriptionParameterMandatoryTypeDescriptio", "doc_type":"api", "kw":"Querying All Image Tags,Image Tagging,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Querying All Image Tags", "githuburl":"" }, { "uri":"en-us_topic_0135482660.html", + "node_id":"en-us_topic_0135482660.xml", "product_code":"ims", "code":"21", "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":"Image Sharing", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Image Sharing", "githuburl":"" }, { "uri":"en-us_topic_0036994324.html", + "node_id":"en-us_topic_0036994324.xml", "product_code":"ims", "code":"22", - "des":"This API is an extension one and used to stop sharing images by deleting tenants with whom the image is shared in batches.This API is an asynchronous one. If job_id is re", + "des":"This API is an extension one and used to stop sharing images by deleting tenants the image is shared with.This API is an asynchronous one. If job_id is returned, the task", "doc_type":"api", - "kw":"Deleting Image Members in Batches,Image Sharing,API Reference", - "title":"Deleting Image Members in Batches", + "kw":"Deleting Image Sharing Members,Image Sharing,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], + "title":"Deleting Image Sharing Members", "githuburl":"" }, { "uri":"en-us_topic_0036994322.html", + "node_id":"en-us_topic_0036994322.xml", "product_code":"ims", "code":"23", "des":"This API is an extension one and used to share more than one image with multiple tenants.This API is an asynchronous one. If job_id is returned, the task is successfully ", "doc_type":"api", - "kw":"Adding Image Members in Batches,Image Sharing,API Reference", - "title":"Adding Image Members in Batches", + "kw":"Adding Image Sharing Members,Image Sharing,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], + "title":"Adding Image Sharing Members", "githuburl":"" }, { "uri":"en-us_topic_0036994323.html", + "node_id":"en-us_topic_0036994323.xml", "product_code":"ims", "code":"24", "des":"This API is an extension one and used to update the image sharing status after the tenant accepts or rejects the shared images.This API is an asynchronous one. If job_id ", "doc_type":"api", - "kw":"Updating the Status of Image Members in Batches,Image Sharing,API Reference", - "title":"Updating the Status of Image Members in Batches", + "kw":"Updating the Sharing Status for Images,Image Sharing,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], + "title":"Updating the Sharing Status for Images", "githuburl":"" }, { "uri":"en-us_topic_0049147855.html", + "node_id":"en-us_topic_0049147855.xml", "product_code":"ims", "code":"25", "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":"Image Replication", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Image Replication", "githuburl":"" }, { "uri":"en-us_topic_0049147856.html", + "node_id":"en-us_topic_0049147856.xml", "product_code":"ims", "code":"26", "des":"This API is an extension one and is used to copy an existing image to another image. When replicating an image, you can change the image attributes to meet the requiremen", "doc_type":"api", "kw":"Replicating an Image Within a Region,Image Replication,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Replicating an Image Within a Region", "githuburl":"" }, { "uri":"en-us_topic_0093967371.html", + "node_id":"en-us_topic_0093967371.xml", "product_code":"ims", "code":"27", "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":"Image Quota", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Image Quota", "githuburl":"" }, { "uri":"en-us_topic_0093967372.html", + "node_id":"en-us_topic_0093967372.xml", "product_code":"ims", "code":"28", - "des":"This extension API is used to query the quota of private images of a tenant in the current region.GET /v1/cloudimages/quotaRequest parametersNoneNoneExample requestGET ht", + "des":"This extension API is used to query the quota of private images of a tenant in the current region.GET /v1/cloudimages/quotaRequest parametersNoneQuerying the image quotaR", "doc_type":"api", "kw":"Querying the Image Quota,Image Quota,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Querying the Image Quota", "githuburl":"" }, { "uri":"en-us_topic_0000001311190309.html", + "node_id":"en-us_topic_0000001311190309.xml", "product_code":"ims", "code":"29", "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":"Image Jobs", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Image Jobs", "githuburl":"" }, { "uri":"en-us_topic_0022473688.html", + "node_id":"en-us_topic_0022473688.xml", "product_code":"ims", "code":"30", "des":"This is an extension API. It is used to query for the execution status of an asynchronous job, for example, querying for the execution status of an image exporting job.GE", "doc_type":"api", - "kw":"Asynchronous Job Query,Image Jobs,API Reference", - "title":"Asynchronous Job Query", + "kw":"Querying the Status of an Asynchronous Job,Image Jobs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], + "title":"Querying the Status of an Asynchronous Job", "githuburl":"" }, { "uri":"en-us_topic_0160121770.html", + "node_id":"en-us_topic_0160121770.xml", "product_code":"ims", "code":"31", "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":"Native OpenStack APIs", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Native OpenStack APIs", "githuburl":"" }, { "uri":"en-us_topic_0122410334.html", + "node_id":"en-us_topic_0122410334.xml", "product_code":"ims", "code":"32", "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":"Image (Native OpenStack APIs)", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Image (Native OpenStack APIs)", "githuburl":"" }, { "uri":"en-us_topic_0060804959.html", + "node_id":"en-us_topic_0060804959.xml", "product_code":"ims", "code":"33", "des":"This API is used to obtain the image list.This API does not return the complete result at once, but uses pagination.Pagination refers to the function of returning a subse", "doc_type":"api", "kw":"Querying Images (Native OpenStack API),Image (Native OpenStack APIs),API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Querying Images (Native OpenStack API)", "githuburl":"" }, { "uri":"en-us_topic_0020091566.html", + "node_id":"en-us_topic_0020091566.xml", "product_code":"ims", "code":"34", - "des":"This API is used to query details about a public or private image.GET /v2/images/{image_id}Table 1 lists the parameters.Parameter descriptionParameterMandatoryTypeDescrip", + "des":"This API is used to query details about a public or private image.GET /v2/images/{image_id}Table 1 lists the parameters in the URI.Parameter descriptionParameterMandatory", "doc_type":"api", "kw":"Querying Image Details (Native OpenStack API),Image (Native OpenStack APIs),API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Querying Image Details (Native OpenStack API)", "githuburl":"" }, { "uri":"en-us_topic_0060804960.html", + "node_id":"en-us_topic_0060804960.xml", "product_code":"ims", "code":"35", "des":"This API is used to modify image information.Only customized attributes, image name, and image description can be modified.PATCH /v2/images/{image_id}Table 1 lists the pa", "doc_type":"api", "kw":"Updating Image Information (Native OpenStack API),Image (Native OpenStack APIs),API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Updating Image Information (Native OpenStack API)", "githuburl":"" }, { "uri":"en-us_topic_0031615566.html", + "node_id":"en-us_topic_0031615566.xml", "product_code":"ims", "code":"36", "des":"This API is used to upload a local image to the cloud platform. The image to be uploaded must be smaller than 128 GB.For more information about how to use external files ", "doc_type":"api", "kw":"Uploading an Image (Native OpenStack API),Image (Native OpenStack APIs),API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Uploading an Image (Native OpenStack API)", "githuburl":"" }, { "uri":"en-us_topic_0020092108.html", + "node_id":"en-us_topic_0020092108.xml", "product_code":"ims", "code":"37", "des":"This API is used to delete a private image. You can only delete your own private images.DELETE /v2/images/{image_id}Table 1 lists the parameters in the URI.Parameter desc", "doc_type":"api", "kw":"Deleting an Image (Native OpenStack API),Image (Native OpenStack APIs),API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Deleting an Image (Native OpenStack API)", "githuburl":"" }, { "uri":"en-us_topic_0031615565.html", + "node_id":"en-us_topic_0031615565.xml", "product_code":"ims", "code":"38", "des":"This API is used to create image metadata.After the API is successfully invoked, the image metadata is created, but the image file does not exist yet.POST /v2/imagesReque", "doc_type":"api", "kw":"Creating Image Metadata (Native OpenStack API),Image (Native OpenStack APIs),API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Creating Image Metadata (Native OpenStack API)", "githuburl":"" }, { "uri":"en-us_topic_0066978722.html", + "node_id":"en-us_topic_0066978722.xml", "product_code":"ims", "code":"39", "des":"This API is used to delete an image. If you soft delete the image with a specified ID, the image persists in the database, but in the deletedstatus.This API has been disc", "doc_type":"api", "kw":"Deleting an Image (Native OpenStack API v1.1 - Abandoned and Not Recommended),Image (Native OpenStac", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Deleting an Image (Native OpenStack API v1.1 - Abandoned and Not Recommended)", "githuburl":"" }, { "uri":"en-us_topic_0066978721.html", + "node_id":"en-us_topic_0066978721.xml", "product_code":"ims", "code":"40", "des":"This API is used to query image metadata.This API has been discarded. The API for querying image details (Querying Image Details (Native OpenStack API)) is recommended.HE", "doc_type":"api", "kw":"Querying Image Metadata (Native OpenStack API v1 - Abandoned and Not Recommended),Image (Native Open", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Querying Image Metadata (Native OpenStack API v1 - Abandoned and Not Recommended)", "githuburl":"" }, { "uri":"en-us_topic_0066978720.html", + "node_id":"en-us_topic_0066978720.xml", "product_code":"ims", "code":"41", "des":"This API is used to query details of images.This API has been discarded. The image query API (Querying Images (Native OpenStack API)) is recommended.GET /v1.1/images/deta", "doc_type":"api", "kw":"Querying Image Details (Native OpenStack API v1.1 - Abandoned and Not Recommended),Image (Native Ope", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Querying Image Details (Native OpenStack API v1.1 - Abandoned and Not Recommended)", "githuburl":"" }, { "uri":"en-us_topic_0122410335.html", + "node_id":"en-us_topic_0122410335.xml", "product_code":"ims", "code":"42", "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":"Image Tagging (Native OpenStack APIs)", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Image Tagging (Native OpenStack APIs)", "githuburl":"" }, { "uri":"en-us_topic_0020092111.html", + "node_id":"en-us_topic_0020092111.xml", "product_code":"ims", "code":"43", "des":"This API is used to add a custom tag to an image. With tags, you can manage easily the images.PUT /v2/images/{image_id}/tags/{tag}Table 1 lists the parameters in the URI.", "doc_type":"api", "kw":"Adding a Tag (Native OpenStack API),Image Tagging (Native OpenStack APIs),API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Adding a Tag (Native OpenStack API)", "githuburl":"" }, { "uri":"en-us_topic_0020091553.html", + "node_id":"en-us_topic_0020091553.xml", "product_code":"ims", "code":"44", "des":"This API is used to delete a custom tag from a private image.DELETE /v2/images/{image_id}/tags/{tag}Table 1 lists the parameters in the URI.Parameter descriptionParameter", "doc_type":"api", "kw":"Deleting a Tag (Native OpenStack API),Image Tagging (Native OpenStack APIs),API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Deleting a Tag (Native OpenStack API)", "githuburl":"" }, { "uri":"en-us_topic_0020091554.html", + "node_id":"en-us_topic_0020091554.xml", "product_code":"ims", "code":"45", "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":"Image Schema (Native OpenStack APIs)", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Image Schema (Native OpenStack APIs)", "githuburl":"" }, { "uri":"en-us_topic_0020091555.html", + "node_id":"en-us_topic_0020091555.xml", "product_code":"ims", "code":"46", - "des":"This API is used to query the image schema, which allows you to view image attributes and their data types.GET /v2/schemas/imageRequest parametersNoneNoneExample requestG", + "des":"This API is used to query the image schema, which allows you to view image attributes and their data types.GET /v2/schemas/imageRequest parametersNoneQuerying an image sc", "doc_type":"api", "kw":"Querying an Image Schema (Native OpenStack API),Image Schema (Native OpenStack APIs),API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Querying an Image Schema (Native OpenStack API)", "githuburl":"" }, { "uri":"en-us_topic_0020091556.html", + "node_id":"en-us_topic_0020091556.xml", "product_code":"ims", "code":"47", "des":"This API is used to query an image list schema, which allows you to know details about and the data structure of the image list.GET /v2/schemas/imagesRequest parametersNo", "doc_type":"api", "kw":"Querying an Image List Schema (Native OpenStack API),Image Schema (Native OpenStack APIs),API Refere", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Querying an Image List Schema (Native OpenStack API)", "githuburl":"" }, { "uri":"en-us_topic_0049147876.html", + "node_id":"en-us_topic_0049147876.xml", "product_code":"ims", "code":"48", - "des":"This API is used to query an image member schema, which allows you to view image member attributes and their data types.GET /v2/schemas/memberRequest parametersNoneNoneEx", + "des":"This API is used to query an image sharing member schema, which allows you to view image sharing member attributes and their data types.GET /v2/schemas/memberRequest para", "doc_type":"api", - "kw":"Querying an Image Member Schema (Native OpenStack API),Image Schema (Native OpenStack APIs),API Refe", - "title":"Querying an Image Member Schema (Native OpenStack API)", + "kw":"Querying a Schema for an Image Sharing Member (Native OpenStack API),Image Schema (Native OpenStack ", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], + "title":"Querying a Schema for an Image Sharing Member (Native OpenStack API)", "githuburl":"" }, { "uri":"en-us_topic_0049147877.html", + "node_id":"en-us_topic_0049147877.xml", "product_code":"ims", "code":"49", - "des":"This API is used to query an image member list schema, which allows you to view image member attributes and their data types.GET /v2/schemas/membersRequest parametersNone", + "des":"This API is used to query an image sharing member list schema, which allows you to view image sharing member attributes and their data types.GET /v2/schemas/membersReques", "doc_type":"api", - "kw":"Querying an Image Member List Schema (Native OpenStack API),Image Schema (Native OpenStack APIs),API", - "title":"Querying an Image Member List Schema (Native OpenStack API)", + "kw":"Querying a Schema for an Image Sharing Member List (Native OpenStack API),Image Schema (Native OpenS", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], + "title":"Querying a Schema for an Image Sharing Member List (Native OpenStack API)", "githuburl":"" }, { "uri":"en-us_topic_0122410336.html", + "node_id":"en-us_topic_0122410336.xml", "product_code":"ims", "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":"Image Sharing (Native OpenStack APIs)", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Image Sharing (Native OpenStack APIs)", "githuburl":"" }, { "uri":"en-us_topic_0036994317.html", + "node_id":"en-us_topic_0036994317.xml", "product_code":"ims", "code":"51", - "des":"This API is used to add a project ID of a tenant with whom the image is to be shared.For an encrypted image, you need to authorize the key used by the image before adding", + "des":"This API is used to add a project ID of a tenant the image is to be shared with.For an encrypted image, you need to authorize the key used by the image before using this ", "doc_type":"api", - "kw":"Adding an Image Member (Native OpenStack API),Image Sharing (Native OpenStack APIs),API Reference", - "title":"Adding an Image Member (Native OpenStack API)", + "kw":"Adding an Image Sharing Member (Native OpenStack API),Image Sharing (Native OpenStack APIs),API Refe", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], + "title":"Adding an Image Sharing Member (Native OpenStack API)", "githuburl":"" }, { "uri":"en-us_topic_0036994318.html", + "node_id":"en-us_topic_0036994318.xml", "product_code":"ims", "code":"52", "des":"This API is used to update the image sharing status when a tenant accepts or rejects a shared image.PUT /v2/images/{image_id}/members/{member_id}Table 1 lists the paramet", "doc_type":"api", - "kw":"Updating the Image Sharing Status in Batches (Native OpenStack API),Image Sharing (Native OpenStack ", - "title":"Updating the Image Sharing Status in Batches (Native OpenStack API)", + "kw":"Updating the Image Sharing Status (Native OpenStack API),Image Sharing (Native OpenStack APIs),API R", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], + "title":"Updating the Image Sharing Status (Native OpenStack API)", "githuburl":"" }, { "uri":"en-us_topic_0036994319.html", + "node_id":"en-us_topic_0036994319.xml", "product_code":"ims", "code":"53", "des":"This API is used to query details about a tenant with whom the image is shared.GET /v2/images/{image_id}/members/{member_id}Table 1 lists the parameters in the URI.Reques", "doc_type":"api", - "kw":"Querying Image Member Details (Native OpenStack API),Image Sharing (Native OpenStack APIs),API Refer", - "title":"Querying Image Member Details (Native OpenStack API)", + "kw":"Querying Image Sharing Member Details (Native OpenStack API),Image Sharing (Native OpenStack APIs),A", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], + "title":"Querying Image Sharing Member Details (Native OpenStack API)", "githuburl":"" }, { "uri":"en-us_topic_0036994320.html", + "node_id":"en-us_topic_0036994320.xml", "product_code":"ims", "code":"54", "des":"This API is used to query the tenants with whom an image is shared using search criteria and to display the tenants in a list.GET /v2/images/{image_id}/membersTable 1 lis", "doc_type":"api", - "kw":"Querying Image Members (Native OpenStack API),Image Sharing (Native OpenStack APIs),API Reference", - "title":"Querying Image Members (Native OpenStack API)", + "kw":"Querying Image Sharing Members (Native OpenStack API),Image Sharing (Native OpenStack APIs),API Refe", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], + "title":"Querying Image Sharing Members (Native OpenStack API)", "githuburl":"" }, { "uri":"en-us_topic_0036994321.html", + "node_id":"en-us_topic_0036994321.xml", "product_code":"ims", "code":"55", "des":"This API is used to stop image sharing by deleting the tenant with whom the image is shared.DELETE /v2/images/{image_id}/members/{member_id}Table 1 lists the parameters i", "doc_type":"api", - "kw":"Deleting an Image Member (Native OpenStack API),Image Sharing (Native OpenStack APIs),API Reference", - "title":"Deleting an Image Member (Native OpenStack API)", + "kw":"Deleting an Image Sharing Member (Native OpenStack API),Image Sharing (Native OpenStack APIs),API Re", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], + "title":"Deleting an Image Sharing Member (Native OpenStack API)", "githuburl":"" }, { "uri":"en-us_topic_0170918587.html", + "node_id":"en-us_topic_0170918587.xml", "product_code":"ims", "code":"56", "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 (Native OpenStack API)", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"API Version Query (Native OpenStack API)", "githuburl":"" }, { "uri":"en-us_topic_0066978719.html", + "node_id":"en-us_topic_0066978719.xml", "product_code":"ims", "code":"57", - "des":"This API is used to query API versions, such as version compatibility and domain name information of APIs.GET /Request parametersNoneNoneExample requestGET https://{Endpo", + "des":"This API is used to query API versions, such as version compatibility and domain name information of APIs.GET /Request parametersNoneNoneQuerying API versionsResponse par", "doc_type":"api", "kw":"Querying API Versions (Native OpenStack API),API Version Query (Native OpenStack API),API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Querying API Versions (Native OpenStack API)", "githuburl":"" }, { "uri":"en-us_topic_0170918588.html", + "node_id":"en-us_topic_0170918588.xml", "product_code":"ims", "code":"58", "des":"This API is used to query a specified API version, such as version compatibility and domain name information of an API.GET /{api_version}Table 1 lists the parameters in t", "doc_type":"api", "kw":"Querying an API Version (Native OpenStack API),API Version Query (Native OpenStack API),API Referenc", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Querying an API Version (Native OpenStack API)", "githuburl":"" }, { "uri":"en-us_topic_0125866389.html", + "node_id":"en-us_topic_0125866389.xml", "product_code":"ims", "code":"59", "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":"Permission Policies and Supported Actions", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Permission Policies and Supported Actions", "githuburl":"" }, { "uri":"en-us_topic_0171654733.html", + "node_id":"en-us_topic_0171654733.xml", "product_code":"ims", "code":"60", "des":"This section describes fine-grained permissions management for your IMS. If your account does not need individual IAM users, you may skip over this section.By default, ne", "doc_type":"api", "kw":"Introduction,Permission Policies and Supported Actions,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Introduction", "githuburl":"" }, { "uri":"en-us_topic_0125866390.html", + "node_id":"en-us_topic_0125866390.xml", "product_code":"ims", "code":"61", "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":"Image Management,Permission Policies and Supported Actions,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Image Management", "githuburl":"" }, { "uri":"en-us_topic_0125866391.html", + "node_id":"en-us_topic_0125866391.xml", "product_code":"ims", "code":"62", "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":"Image Tagging,Permission Policies and Supported Actions,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Image Tagging", "githuburl":"" }, { "uri":"en-us_topic_0125866392.html", + "node_id":"en-us_topic_0125866392.xml", "product_code":"ims", "code":"63", "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":"Image Schema,Permission Policies and Supported Actions,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Image Schema", "githuburl":"" }, { "uri":"en-us_topic_0125866393.html", + "node_id":"en-us_topic_0125866393.xml", "product_code":"ims", "code":"64", "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":"Image Sharing,Permission Policies and Supported Actions,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Image Sharing", "githuburl":"" }, { "uri":"en-us_topic_0125866394.html", + "node_id":"en-us_topic_0125866394.xml", "product_code":"ims", "code":"65", "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":"Image Replication,Permission Policies and Supported Actions,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Image Replication", "githuburl":"" }, { "uri":"en-us_topic_0125866395.html", + "node_id":"en-us_topic_0125866395.xml", "product_code":"ims", "code":"66", "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":"Image Quota,Permission Policies and Supported Actions,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Image Quota", "githuburl":"" }, { "uri":"en-us_topic_0135481403.html", + "node_id":"en-us_topic_0135481403.xml", "product_code":"ims", "code":"67", "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":"Common Parameters", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Common Parameters", "githuburl":"" }, { "uri":"en-us_topic_0020091562.html", + "node_id":"en-us_topic_0020091562.xml", "product_code":"ims", "code":"68", - "des":"An image is an ECS template containing mandatory software, such as an OS. The template may also contain application software, such as database software, and proprietary s", + "des":"An image is a template containing mandatory software, such as an OS. The template may also contain application software, such as database software, and proprietary softwa", "doc_type":"api", "kw":"Image Attributes,Common Parameters,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Image Attributes", "githuburl":"" }, { "uri":"en-us_topic_0020092110.html", + "node_id":"en-us_topic_0020092110.xml", "product_code":"ims", "code":"69", "des":"You can attach a custom tag to a private image to facilitate private image management.Data format of tagThe data format is key.value. If a key is added, a tag is added. I", "doc_type":"api", "kw":"Image Tag Data Formats,Common Parameters,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Image Tag Data Formats", "githuburl":"" }, { "uri":"en-us_topic_0036994316.html", + "node_id":"en-us_topic_0036994316.xml", "product_code":"ims", "code":"70", "des":"You can use the image sharing function to share your private images with other users.Images can only be shared within a region.A system disk image or data disk image can ", "doc_type":"api", "kw":"Restrictions on Image Sharing,Common Parameters,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Restrictions on Image Sharing", "githuburl":"" }, { "uri":"en-us_topic_0031617666.html", + "node_id":"en-us_topic_0031617666.xml", "product_code":"ims", "code":"71", "des":"For CoreOS, only the 1010.5.0 and 1068.10.0 versions are supported and it must have coreos-cloudinit installed. The automatic system upgrade may make ECSs created using t", "doc_type":"api", "kw":"Values of Related Parameters,Common Parameters,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Values of Related Parameters", "githuburl":"" }, { "uri":"en-us_topic_0121643825.html", + "node_id":"en-us_topic_0121643825.xml", "product_code":"ims", "code":"72", "des":"NormalReturned ValueDescription200 OKThe results of GET and PUT operations are returned as expected.201 CreatedThe results of the POST operation are returned as expected.", "doc_type":"api", "kw":"Status Codes,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Status Codes", "githuburl":"" }, { "uri":"en-us_topic_0022473689.html", + "node_id":"en-us_topic_0022473689.xml", "product_code":"ims", "code":"73", "des":"If the returned status code is 400, a customized error message will be returned. This section describes the meaning of each status code.", "doc_type":"api", "kw":"Error Codes,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Error Codes", "githuburl":"" }, { "uri":"en-us_topic_0024735403.html", + "node_id":"en-us_topic_0024735403.xml", "product_code":"ims", "code":"74", "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Change History", "githuburl":"" } diff --git a/docs/ims/api-ref/CLASS.TXT.json b/docs/ims/api-ref/CLASS.TXT.json index c16a77f73..c7c076f79 100644 --- a/docs/ims/api-ref/CLASS.TXT.json +++ b/docs/ims/api-ref/CLASS.TXT.json @@ -36,7 +36,7 @@ "code":"4" }, { - "desc":"This API is used to modify image attributes and update image information.Only information of images in active status can be changed.PATCH /v2/cloudimages/{image_id}Table ", + "desc":"This API is used to update image information.Only active images can be updated.PATCH /v2/cloudimages/{image_id}Table 1 lists the parameters in the URI.Request parametersP", "product_code":"ims", "title":"Updating Image Information", "uri":"en-us_topic_0020091567.html", @@ -90,7 +90,7 @@ "code":"10" }, { - "desc":"This is an extension API and used to export a private image to an OBS bucket.Before exporting an image, ensure that you have the Tenant Administrator permission for OBS.T", + "desc":"This is an extension API and used to export a private image to an OBS bucket.Before exporting an image, ensure that you have the Tenant Administrator permission for OBS.A", "product_code":"ims", "title":"Exporting an Image", "uri":"en-us_topic_0036994315.html", @@ -189,9 +189,9 @@ "code":"21" }, { - "desc":"This API is an extension one and used to stop sharing images by deleting tenants with whom the image is shared in batches.This API is an asynchronous one. If job_id is re", + "desc":"This API is an extension one and used to stop sharing images by deleting tenants the image is shared with.This API is an asynchronous one. If job_id is returned, the task", "product_code":"ims", - "title":"Deleting Image Members in Batches", + "title":"Deleting Image Sharing Members", "uri":"en-us_topic_0036994324.html", "doc_type":"api", "p_code":"21", @@ -200,7 +200,7 @@ { "desc":"This API is an extension one and used to share more than one image with multiple tenants.This API is an asynchronous one. If job_id is returned, the task is successfully ", "product_code":"ims", - "title":"Adding Image Members in Batches", + "title":"Adding Image Sharing Members", "uri":"en-us_topic_0036994322.html", "doc_type":"api", "p_code":"21", @@ -209,7 +209,7 @@ { "desc":"This API is an extension one and used to update the image sharing status after the tenant accepts or rejects the shared images.This API is an asynchronous one. If job_id ", "product_code":"ims", - "title":"Updating the Status of Image Members in Batches", + "title":"Updating the Sharing Status for Images", "uri":"en-us_topic_0036994323.html", "doc_type":"api", "p_code":"21", @@ -243,7 +243,7 @@ "code":"27" }, { - "desc":"This extension API is used to query the quota of private images of a tenant in the current region.GET /v1/cloudimages/quotaRequest parametersNoneNoneExample requestGET ht", + "desc":"This extension API is used to query the quota of private images of a tenant in the current region.GET /v1/cloudimages/quotaRequest parametersNoneQuerying the image quotaR", "product_code":"ims", "title":"Querying the Image Quota", "uri":"en-us_topic_0093967372.html", @@ -263,7 +263,7 @@ { "desc":"This is an extension API. It is used to query for the execution status of an asynchronous job, for example, querying for the execution status of an image exporting job.GE", "product_code":"ims", - "title":"Asynchronous Job Query", + "title":"Querying the Status of an Asynchronous Job", "uri":"en-us_topic_0022473688.html", "doc_type":"api", "p_code":"29", @@ -297,7 +297,7 @@ "code":"33" }, { - "desc":"This API is used to query details about a public or private image.GET /v2/images/{image_id}Table 1 lists the parameters.Parameter descriptionParameterMandatoryTypeDescrip", + "desc":"This API is used to query details about a public or private image.GET /v2/images/{image_id}Table 1 lists the parameters in the URI.Parameter descriptionParameterMandatory", "product_code":"ims", "title":"Querying Image Details (Native OpenStack API)", "uri":"en-us_topic_0020091566.html", @@ -405,7 +405,7 @@ "code":"45" }, { - "desc":"This API is used to query the image schema, which allows you to view image attributes and their data types.GET /v2/schemas/imageRequest parametersNoneNoneExample requestG", + "desc":"This API is used to query the image schema, which allows you to view image attributes and their data types.GET /v2/schemas/imageRequest parametersNoneQuerying an image sc", "product_code":"ims", "title":"Querying an Image Schema (Native OpenStack API)", "uri":"en-us_topic_0020091555.html", @@ -423,18 +423,18 @@ "code":"47" }, { - "desc":"This API is used to query an image member schema, which allows you to view image member attributes and their data types.GET /v2/schemas/memberRequest parametersNoneNoneEx", + "desc":"This API is used to query an image sharing member schema, which allows you to view image sharing member attributes and their data types.GET /v2/schemas/memberRequest para", "product_code":"ims", - "title":"Querying an Image Member Schema (Native OpenStack API)", + "title":"Querying a Schema for an Image Sharing Member (Native OpenStack API)", "uri":"en-us_topic_0049147876.html", "doc_type":"api", "p_code":"45", "code":"48" }, { - "desc":"This API is used to query an image member list schema, which allows you to view image member attributes and their data types.GET /v2/schemas/membersRequest parametersNone", + "desc":"This API is used to query an image sharing member list schema, which allows you to view image sharing member attributes and their data types.GET /v2/schemas/membersReques", "product_code":"ims", - "title":"Querying an Image Member List Schema (Native OpenStack API)", + "title":"Querying a Schema for an Image Sharing Member List (Native OpenStack API)", "uri":"en-us_topic_0049147877.html", "doc_type":"api", "p_code":"45", @@ -450,9 +450,9 @@ "code":"50" }, { - "desc":"This API is used to add a project ID of a tenant with whom the image is to be shared.For an encrypted image, you need to authorize the key used by the image before adding", + "desc":"This API is used to add a project ID of a tenant the image is to be shared with.For an encrypted image, you need to authorize the key used by the image before using this ", "product_code":"ims", - "title":"Adding an Image Member (Native OpenStack API)", + "title":"Adding an Image Sharing Member (Native OpenStack API)", "uri":"en-us_topic_0036994317.html", "doc_type":"api", "p_code":"50", @@ -461,7 +461,7 @@ { "desc":"This API is used to update the image sharing status when a tenant accepts or rejects a shared image.PUT /v2/images/{image_id}/members/{member_id}Table 1 lists the paramet", "product_code":"ims", - "title":"Updating the Image Sharing Status in Batches (Native OpenStack API)", + "title":"Updating the Image Sharing Status (Native OpenStack API)", "uri":"en-us_topic_0036994318.html", "doc_type":"api", "p_code":"50", @@ -470,7 +470,7 @@ { "desc":"This API is used to query details about a tenant with whom the image is shared.GET /v2/images/{image_id}/members/{member_id}Table 1 lists the parameters in the URI.Reques", "product_code":"ims", - "title":"Querying Image Member Details (Native OpenStack API)", + "title":"Querying Image Sharing Member Details (Native OpenStack API)", "uri":"en-us_topic_0036994319.html", "doc_type":"api", "p_code":"50", @@ -479,7 +479,7 @@ { "desc":"This API is used to query the tenants with whom an image is shared using search criteria and to display the tenants in a list.GET /v2/images/{image_id}/membersTable 1 lis", "product_code":"ims", - "title":"Querying Image Members (Native OpenStack API)", + "title":"Querying Image Sharing Members (Native OpenStack API)", "uri":"en-us_topic_0036994320.html", "doc_type":"api", "p_code":"50", @@ -488,7 +488,7 @@ { "desc":"This API is used to stop image sharing by deleting the tenant with whom the image is shared.DELETE /v2/images/{image_id}/members/{member_id}Table 1 lists the parameters i", "product_code":"ims", - "title":"Deleting an Image Member (Native OpenStack API)", + "title":"Deleting an Image Sharing Member (Native OpenStack API)", "uri":"en-us_topic_0036994321.html", "doc_type":"api", "p_code":"50", @@ -504,7 +504,7 @@ "code":"56" }, { - "desc":"This API is used to query API versions, such as version compatibility and domain name information of APIs.GET /Request parametersNoneNoneExample requestGET https://{Endpo", + "desc":"This API is used to query API versions, such as version compatibility and domain name information of APIs.GET /Request parametersNoneNoneQuerying API versionsResponse par", "product_code":"ims", "title":"Querying API Versions (Native OpenStack API)", "uri":"en-us_topic_0066978719.html", @@ -603,7 +603,7 @@ "code":"67" }, { - "desc":"An image is an ECS template containing mandatory software, such as an OS. The template may also contain application software, such as database software, and proprietary s", + "desc":"An image is a template containing mandatory software, such as an OS. The template may also contain application software, such as database software, and proprietary softwa", "product_code":"ims", "title":"Image Attributes", "uri":"en-us_topic_0020091562.html", diff --git a/docs/ims/api-ref/en-us_topic_0000001311190309.html b/docs/ims/api-ref/en-us_topic_0000001311190309.html index 3e871c6b3..01075ae62 100644 --- a/docs/ims/api-ref/en-us_topic_0000001311190309.html +++ b/docs/ims/api-ref/en-us_topic_0000001311190309.html @@ -8,7 +8,7 @@
diff --git a/docs/ims/api-ref/en-us_topic_0020091553.html b/docs/ims/api-ref/en-us_topic_0020091553.html index dc234b9c4..463ca1c31 100644 --- a/docs/ims/api-ref/en-us_topic_0020091553.html +++ b/docs/ims/api-ref/en-us_topic_0020091553.html @@ -39,9 +39,11 @@
-

Request

  • Request parameters

    None

    -
  • Example request
    DELETE https://{Endpoint}/v2/images/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/tags/aaaa
    -
+

Request

Request parameters

+

None

+
+

Example Request

Deleting an image tag

+
DELETE https://{Endpoint}/v2/images/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/tags/aaaa

Response

  • Response parameters

    None

  • Example response
    STATUS CODE 204
    @@ -49,40 +51,40 @@

Returned Values

  • Normal

    204

  • Abnormal -

    Returned Value

    +
    - - - - - - - - - - - - - diff --git a/docs/ims/api-ref/en-us_topic_0020091554.html b/docs/ims/api-ref/en-us_topic_0020091554.html index 46cda8a2c..5bb4805d9 100644 --- a/docs/ims/api-ref/en-us_topic_0020091554.html +++ b/docs/ims/api-ref/en-us_topic_0020091554.html @@ -8,9 +8,9 @@
  • Querying an Image List Schema (Native OpenStack API)
    • -
  • Querying an Image Member Schema (Native OpenStack API)
    +
  • Querying a Schema for an Image Sharing Member (Native OpenStack API)
    • -
  • Querying an Image Member List Schema (Native OpenStack API)
    +
  • Querying a Schema for an Image Sharing Member List (Native OpenStack API)
    • diff --git a/docs/ims/api-ref/en-us_topic_0020091555.html b/docs/ims/api-ref/en-us_topic_0020091555.html index 44bbfeaae..0dd2872bf 100644 --- a/docs/ims/api-ref/en-us_topic_0020091555.html +++ b/docs/ims/api-ref/en-us_topic_0020091555.html @@ -5,47 +5,49 @@

    URI

    GET /v2/schemas/image

    -

    Request

    • Request parameters

      None

      -
    • Example request
      GET https://{Endpoint}/v2/schemas/image
      -
    +

    Request

    Request parameters

    +

    None

    +
    +

    Example Request

    Querying an image schema

    +
    GET https://{Endpoint}/v2/schemas/image

    Response

    • Response parameters -

    Returned Value

    Description

    +

    Description

    400 Bad Request

    +

    400 Bad Request

    Request error.

    +

    Request error.

    401 Unauthorized

    +

    401 Unauthorized

    Authentication failed.

    +

    Authentication failed.

    403 Forbidden

    +

    403 Forbidden

    You do not have the rights to perform the operation.

    +

    You do not have the rights to perform the operation.

    404 Not Found

    +

    404 Not Found

    The requested resource was not found.

    +

    The requested resource was not found.

    500 Internal Server Error

    +

    500 Internal Server Error

    Internal service error.

    +

    Internal service error.

    503 Service Unavailable

    +

    503 Service Unavailable

    The service is unavailable.

    +

    The service is unavailable.

    Parameter

    +
    - - - - - - - - - - - - - - @@ -53,477 +55,476 @@

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    additionalProperties

    +

    additionalProperties

    Object

    +

    Object

    Specifies the additional attributes.

    +

    Specifies the additional attributes.

    For details, see Table 1.

    name

    +

    name

    String

    +

    String

    Specifies the schema name.

    +

    Specifies the schema name.

    links

    +

    links

    Array of objects

    +

    Array of objects

    Specifies the URL for accessing the schema.

    +

    Specifies the URL for accessing the schema.

    For details, see Table 2.

    properties

    +

    properties

    Object

    +

    Object

    Describes basic image attributes, including the type and usage of each attribute.

    +

    Describes basic image attributes, including the type and usage of each attribute.

    For details about the parameters, see Image Attributes.
    -
    Table 1 Data structure description of the additionalProperties field

    Parameter

    +
    - - - - -
    Table 1 Data structure description of the additionalProperties field

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    type

    +

    type

    String

    +

    String

    Type

    +

    Type
    -
    Table 2 Data structure description of the links field

    Parameter

    +
    - - - - - - - -
    Table 2 Data structure description of the links field

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    href

    +

    href

    String

    +

    String

    Specifies the domain name.

    +

    Specifies the domain name.

    rel

    +

    rel

    String

    +

    String

    Specifies the domain name description.

    +

    Specifies the domain name description.
  • Example response
    STATUS CODE 200
    -
      1
-  2
-  3
-  4
-  5
-  6
-  7
-  8
-  9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
-100
-101
-102
-103
-104
-105
-106
-107
-108
-109
-110
-111
-112
-113
-114
-115
-116
-117
-118
-119
-120
-121
-122
-123
-124
-125
-126
-127
-128
-129
-130
-131
-132
-133
-134
-135
-136
-137
-138
-139
-140
-141
-142
-143
-144
-145
-146
-147
-148
-149
-150
-151
-152
-153
-154
-155
-156
-157
-158
-159
-160
-161
-162
-163
-164
-165
-166
-167
-168
-169
-170
-171
-172
-173
-174
-175
-176
-177
-178
-179
-180
-181
-182
-183
-184
-185
-186
-187
-188
-189
-190
-191
-192
-193
    {
-    "additionalProperties": {
-        "type": "string"
-    },
-    "name": "image",
-    "links": [
-        {
-            "href": "{self}",
-            "rel": "self"
-        },
-        {
-            "href": "{file}",
-            "rel": "enclosure"
-        },
-        {
-            "href": "{schema}",
-            "rel": "describedby"
-        }
-    ],
-    "properties": {
-        "status": {
-            "enum": [
-                "queued",
-                "saving",
-                "active",
-                "killed",
-                "deleted",
-                "pending_delete"
-            ],
-            "type": "string",
-            "description": "Status of the image (READ-ONLY)"
-        },
-        "tags": {
-            "items": {
-                "type": "string",
-                "maxLength": 255
-            },
-            "type": "array",
-            "description": "List of strings related to the image"
-        },
-        "kernel_id": {
-            "pattern": "^([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}$",
-            "type": "string",
-            "description": "ID of image stored in Glance that should be used as the kernel when booting an AMI-style image.",
-            "is_base": false
-        },
-        "container_format": {
-            "enum": [
-                "ami",
-                "ari",
-                "aki",
-                "bare",
-                "ovf",
-                "ova"
-            ],
-            "type": "string",
-            "description": "Format of the container"
-        },
-        "min_ram": {
-            "type": "integer",
-            "description": "Amount of ram (in MB) required to boot image."
-        },
-        "ramdisk_id": {
-            "pattern": "^([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}$",
-            "type": "string",
-            "description": "ID of image stored in Glance that should be used as the ramdisk when booting an AMI-style image.",
-            "is_base": false
-        },
-        "locations": {
-            "items": {
-                "required": [
-                    "url",
-                    "metadata"
-                ],
-                "type": "object",
-                "properties": {
-                    "url": {
-                        "type": "string",
-                        "maxLength": 255
-                    },
-                    "metadata": {
-                        "type": "object"
-                    }
-                }
-            },
-            "type": "array",
-            "description": "A set of URLs to access the image file kept in external store"
-        },
-        "visibility": {
-            "enum": [
-                "public",
-                "private"
-            ],
-            "type": "string",
-            "description": "Scope of image accessibility"
-        },
-        "updated_at": {
-            "type": "string",
-            "description": "Date and time of the last image modification (READ-ONLY)"
-        },
-        "owner": {
-            "type": "string",
-            "description": "Owner of the image",
-            "maxLength": 255
-        },
-        "file": {
-            "type": "string",
-            "description": "(READ-ONLY)"
-        },
-        "min_disk": {
-            "type": "integer",
-            "description": "Amount of disk space (in GB) required to boot image."
-        },
-        "virtual_size": {
-            "type": "integer",
-            "description": "Virtual size of image in bytes (READ-ONLY)"
-        },
-        "id": {
-            "pattern": "^([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}$",
-            "type": "string",
-            "description": "An identifier for the image"
-        },
-        "size": {
-            "type": "integer",
-            "description": "Size of image file in bytes (READ-ONLY)"
-        },
-        "instance_uuid": {
-            "type": "string",
-            "description": "ID of instance used to create this image.",
-            "is_base": false
-        },
-        "os_distro": {
-            "type": "string",
-            "description": "Common name of operating system distribution as specified in http://docs.openstack.org/trunk/openstack-compute/admin/content/adding-images.html",
-            "is_base": false
-        },
-        "name": {
-            "type": "string",
-            "description": "Descriptive name for the image",
-            "maxLength": 255
-        },
-        "checksum": {
-            "type": "string",
-            "description": "md5 hash of image contents. (READ-ONLY)",
-            "maxLength": 32
-        },
-        "created_at": {
-            "type": "string",
-            "description": "Date and time of image registration (READ-ONLY)"
-        },
-        "disk_format": {
-            "enum": [
-                "ami",
-                "ari",
-                "aki",
-                "vhd",
-                "vmdk",
-                "raw",
-                "qcow2",
-                "vdi",
-                "iso"
-            ],
-            "type": "string",
-            "description": "Format of the disk"
-        },
-        "os_version": {
-            "type": "string",
-            "description": "Operating system version as specified by the distributor",
-            "is_base": false
-        },
-        "protected": {
-            "type": "boolean",
-            "description": "If true, image will not be deletable."
-        },
-        "architecture": {
-            "type": "string",
-            "description": "Operating system architecture as specified in http://docs.openstack.org/trunk/openstack-compute/admin/content/adding-images.html",
-            "is_base": false
-        },
-        "direct_url": {
-            "type": "string",
-            "description": "URL to access the image file kept in external store (READ-ONLY)"
-        },
-        "self": {
-            "type": "string",
-            "description": "(READ-ONLY)"
-        },
-        "schema": {
-            "type": "string",
-            "description": "(READ-ONLY)"
-        }
-    }
+
      1
+  2
+  3
+  4
+  5
+  6
+  7
+  8
+  9
+ 10
+ 11
+ 12
+ 13
+ 14
+ 15
+ 16
+ 17
+ 18
+ 19
+ 20
+ 21
+ 22
+ 23
+ 24
+ 25
+ 26
+ 27
+ 28
+ 29
+ 30
+ 31
+ 32
+ 33
+ 34
+ 35
+ 36
+ 37
+ 38
+ 39
+ 40
+ 41
+ 42
+ 43
+ 44
+ 45
+ 46
+ 47
+ 48
+ 49
+ 50
+ 51
+ 52
+ 53
+ 54
+ 55
+ 56
+ 57
+ 58
+ 59
+ 60
+ 61
+ 62
+ 63
+ 64
+ 65
+ 66
+ 67
+ 68
+ 69
+ 70
+ 71
+ 72
+ 73
+ 74
+ 75
+ 76
+ 77
+ 78
+ 79
+ 80
+ 81
+ 82
+ 83
+ 84
+ 85
+ 86
+ 87
+ 88
+ 89
+ 90
+ 91
+ 92
+ 93
+ 94
+ 95
+ 96
+ 97
+ 98
+ 99
+100
+101
+102
+103
+104
+105
+106
+107
+108
+109
+110
+111
+112
+113
+114
+115
+116
+117
+118
+119
+120
+121
+122
+123
+124
+125
+126
+127
+128
+129
+130
+131
+132
+133
+134
+135
+136
+137
+138
+139
+140
+141
+142
+143
+144
+145
+146
+147
+148
+149
+150
+151
+152
+153
+154
+155
+156
+157
+158
+159
+160
+161
+162
+163
+164
+165
+166
+167
+168
+169
+170
+171
+172
+173
+174
+175
+176
+177
+178
+179
+180
+181
+182
+183
+184
+185
+186
+187
+188
+189
+190
+191
+192
+193
    {
+    "additionalProperties": {
+        "type": "string"
+    },
+    "name": "image",
+    "links": [
+        {
+            "href": "{self}",
+            "rel": "self"
+        },
+        {
+            "href": "{file}",
+            "rel": "enclosure"
+        },
+        {
+            "href": "{schema}",
+            "rel": "describedby"
+        }
+    ],
+    "properties": {
+        "status": {
+            "enum": [
+                "queued",
+                "saving",
+                "active",
+                "killed",
+                "deleted",
+                "pending_delete"
+            ],
+            "type": "string",
+            "description": "Status of the image (READ-ONLY)"
+        },
+        "tags": {
+            "items": {
+                "type": "string",
+                "maxLength": 255
+            },
+            "type": "array",
+            "description": "List of strings related to the image"
+        },
+        "kernel_id": {
+            "pattern": "^([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}$",
+            "type": "string",
+            "description": "ID of image stored in Glance that should be used as the kernel when booting an AMI-style image.",
+            "is_base": false
+        },
+        "container_format": {
+            "enum": [
+                "ami",
+                "ari",
+                "aki",
+                "bare",
+                "ovf",
+                "ova"
+            ],
+            "type": "string",
+            "description": "Format of the container"
+        },
+        "min_ram": {
+            "type": "integer",
+            "description": "Amount of ram (in MB) required to boot image."
+        },
+        "ramdisk_id": {
+            "pattern": "^([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}$",
+            "type": "string",
+            "description": "ID of image stored in Glance that should be used as the ramdisk when booting an AMI-style image.",
+            "is_base": false
+        },
+        "locations": {
+            "items": {
+                "required": [
+                    "url",
+                    "metadata"
+                ],
+                "type": "object",
+                "properties": {
+                    "url": {
+                        "type": "string",
+                        "maxLength": 255
+                    },
+                    "metadata": {
+                        "type": "object"
+                    }
+                }
+            },
+            "type": "array",
+            "description": "A set of URLs to access the image file kept in external store"
+        },
+        "visibility": {
+            "enum": [
+                "public",
+                "private"
+            ],
+            "type": "string",
+            "description": "Scope of image accessibility"
+        },
+        "updated_at": {
+            "type": "string",
+            "description": "Date and time of the last image modification (READ-ONLY)"
+        },
+        "owner": {
+            "type": "string",
+            "description": "Owner of the image",
+            "maxLength": 255
+        },
+        "file": {
+            "type": "string",
+            "description": "(READ-ONLY)"
+        },
+        "min_disk": {
+            "type": "integer",
+            "description": "Amount of disk space (in GB) required to boot image."
+        },
+        "virtual_size": {
+            "type": "integer",
+            "description": "Virtual size of image in bytes (READ-ONLY)"
+        },
+        "id": {
+            "pattern": "^([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}$",
+            "type": "string",
+            "description": "An identifier for the image"
+        },
+        "size": {
+            "type": "integer",
+            "description": "Size of image file in bytes (READ-ONLY)"
+        },
+        "instance_uuid": {
+            "type": "string",
+            "description": "ID of instance used to create this image.",
+            "is_base": false
+        },
+        "os_distro": {
+            "type": "string",
+            "description": "Common name of operating system distribution as specified in http://docs.openstack.org/trunk/openstack-compute/admin/content/adding-images.html",
+            "is_base": false
+        },
+        "name": {
+            "type": "string",
+            "description": "Descriptive name for the image",
+            "maxLength": 255
+        },
+        "checksum": {
+            "type": "string",
+            "description": "md5 hash of image contents. (READ-ONLY)",
+            "maxLength": 32
+        },
+        "created_at": {
+            "type": "string",
+            "description": "Date and time of image registration (READ-ONLY)"
+        },
+        "disk_format": {
+            "enum": [
+                "ami",
+                "ari",
+                "aki",
+                "vhd",
+                "vmdk",
+                "raw",
+                "qcow2",
+                "vdi",
+                "iso"
+            ],
+            "type": "string",
+            "description": "Format of the disk"
+        },
+        "os_version": {
+            "type": "string",
+            "description": "Operating system version as specified by the distributor",
+            "is_base": false
+        },
+        "protected": {
+            "type": "boolean",
+            "description": "If true, image will not be deletable."
+        },
+        "architecture": {
+            "type": "string",
+            "description": "Operating system architecture as specified in http://docs.openstack.org/trunk/openstack-compute/admin/content/adding-images.html",
+            "is_base": false
+        },
+        "direct_url": {
+            "type": "string",
+            "description": "URL to access the image file kept in external store (READ-ONLY)"
+        },
+        "self": {
+            "type": "string",
+            "description": "(READ-ONLY)"
+        },
+        "schema": {
+            "type": "string",
+            "description": "(READ-ONLY)"
+        }
+    }
 }
-
    
-
-
    + +

    • Returned Values

    • Normal

      200

    • Abnormal -

      Returned Value

      +
      - - - - - - - - - - - - - diff --git a/docs/ims/api-ref/en-us_topic_0020091556.html b/docs/ims/api-ref/en-us_topic_0020091556.html index 873eff589..a474f6dff 100644 --- a/docs/ims/api-ref/en-us_topic_0020091556.html +++ b/docs/ims/api-ref/en-us_topic_0020091556.html @@ -5,39 +5,41 @@

      URI

      GET /v2/schemas/images

      -

      Request

      • Request parameters

        None

        -
      • Example request
        GET https://{Endpoint}/v2/schemas/images
        -
      +

      Request

      Request parameters

      +

      None

      +
      +

      Example Request

      Querying an image list schema

      +
      GET https://{Endpoint}/v2/schemas/images

      Response

      • Response parameters -

      Returned Value

      Description

      +

      Description

      400 Bad Request

      +

      400 Bad Request

      Request error.

      +

      Request error.

      401 Unauthorized

      +

      401 Unauthorized

      Authentication failed.

      +

      Authentication failed.

      403 Forbidden

      +

      403 Forbidden

      You do not have the rights to perform the operation.

      +

      You do not have the rights to perform the operation.

      404 Not Found

      +

      404 Not Found

      The requested resource was not found.

      +

      The requested resource was not found.

      500 Internal Server Error

      +

      500 Internal Server Error

      Internal service error.

      +

      Internal service error.

      503 Service Unavailable

      +

      503 Service Unavailable

      The service is unavailable.

      +

      The service is unavailable.

      Parameter

      +
      - - - - - - - - - - - @@ -45,520 +47,519 @@

      Parameter

      Type

      +

      Type

      Description

      +

      Description

      name

      +

      name

      String

      +

      String

      Specifies the schema name.

      +

      Specifies the schema name.

      links

      +

      links

      Array of objects

      +

      Array of objects

      Specifies the URL for accessing the schema.

      +

      Specifies the URL for accessing the schema.

      For details, see Table 1.

      properties

      +

      properties

      Object

      +

      Object

      Describes basic image attributes, including the type and usage of each attribute.

      +

      Describes basic image attributes, including the type and usage of each attribute.

      For details about the parameters, see Image Attributes.
      -
      Table 1 Data structure description of the links field

      Parameter

      +
      - - - - - - - -
      Table 1 Data structure description of the links field

      Parameter

      Type

      +

      Type

      Description

      +

      Description

      href

      +

      href

      String

      +

      String

      Specifies the domain name.

      +

      Specifies the domain name.

      rel

      +

      rel

      String

      +

      String

      Specifies the domain name description.

      +

      Specifies the domain name description.
    • Example response
      STATUS CODE 200
      -
        1
-  2
-  3
-  4
-  5
-  6
-  7
-  8
-  9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
-100
-101
-102
-103
-104
-105
-106
-107
-108
-109
-110
-111
-112
-113
-114
-115
-116
-117
-118
-119
-120
-121
-122
-123
-124
-125
-126
-127
-128
-129
-130
-131
-132
-133
-134
-135
-136
-137
-138
-139
-140
-141
-142
-143
-144
-145
-146
-147
-148
-149
-150
-151
-152
-153
-154
-155
-156
-157
-158
-159
-160
-161
-162
-163
-164
-165
-166
-167
-168
-169
-170
-171
-172
-173
-174
-175
-176
-177
-178
-179
-180
-181
-182
-183
-184
-185
-186
-187
-188
-189
-190
-191
-192
-193
-194
-195
-196
-197
-198
-199
-200
-201
-202
-203
-204
-205
-206
-207
-208
-209
-210
-211
-212
-213
-214
-215
-216
-217
-218
-219
-220
-221
-222
-223
-224
      {
-    "name": "images",
-    "links": [
-        {
-            "href": "{first}",
-            "rel": "first"
-        },
-        {
-            "href": "{next}",
-            "rel": "next"
-        },
-        {
-            "href": "{schema}",
-            "rel": "describedby"
-        }
-    ],
-    "properties": {
-        "images": {
-            "items": {
-                "additionalProperties": {
-                    "type": "String"
-                },
-                "name": "image",
-                "links": [
-                    {
-                        "href": "{self}",
-                        "rel": "self"
-                    },
-                    {
-                        "href": "{file}",
-                        "rel": "enclosure"
-                    },
-                    {
-                        "href": "{schema}",
-                        "rel": "describedby"
-                    }
-                ],
-                "properties": {
-                    "status": {
-                        "enum": [
-                            "queued",
-                            "saving",
-                            "active",
-                            "killed",
-                            "deleted",
-                            "pending_delete"
-                        ],
-                        "type": "string",
-                        "description": "Status of the image (READ-ONLY)"
-                    },
-                    "tags": {
-                        "items": {
-                            "type": "string",
-                            "maxLength": 255
-                        },
-                        "type": "array",
-                        "description": "List of strings related to the image"
-                    },
-                    "kernel_id": {
-                        "pattern": "^([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}$",
-                        "type": "string",
-                        "description": "ID of image stored in Glance that should be used as the kernel when booting an AMI-style image.",
-                        "is_base": false
-                    },
-                    "container_format": {
-                        "enum": [
-                            "ami",
-                            "ari",
-                            "aki",
-                            "bare",
-                            "ovf",
-                            "ova"
-                        ],
-                        "type": "string",
-                        "description": "Format of the container"
-                    },
-                    "min_ram": {
-                        "type": "integer",
-                        "description": "Amount of ram (in MB) required to boot image."
-                    },
-                    "ramdisk_id": {
-                        "pattern": "^([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}$",
-                        "type": "string",
-                        "description": "ID of image stored in Glance that should be used as the ramdisk when booting an AMI-style image.",
-                        "is_base": false
-                    },
-                    "locations": {
-                        "items": {
-                            "required": [
-                                "url",
-                                "metadata"
-                            ],
-                            "type": "object",
-                            "properties": {
-                                "url": {
-                                    "type": "string",
-                                    "maxLength": 255
-                                },
-                                "metadata": {
-                                    "type": "object"
-                                }
-                            }
-                        },
-                        "type": "array",
-                        "description": "A set of URLs to access the image file kept in external store"
-                    },
-                    "visibility": {
-                        "enum": [
-                            "public",
-                            "private"
-                        ],
-                        "type": "string",
-                        "description": "Scope of image accessibility"
-                    },
-                    "updated_at": {
-                        "type": "string",
-                        "description": "Date and time of the last image modification (READ-ONLY)"
-                    },
-                    "owner": {
-                        "type": "string",
-                        "description": "Owner of the image",
-                        "maxLength": 255
-                    },
-                    "file": {
-                        "type": "string",
-                        "description": "(READ-ONLY)"
-                    },
-                    "min_disk": {
-                        "type": "integer",
-                        "description": "Amount of disk space (in GB) required to boot image."
-                    },
-                    "virtual_size": {
-                        "type": "integer",
-                        "description": "Virtual size of image in bytes (READ-ONLY)"
-                    },
-                    "id": {
-                        "pattern": "^([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}$",
-                        "type": "string",
-                        "description": "An identifier for the image"
-                    },
-                    "size": {
-                        "type": "integer",
-                        "description": "Size of image file in bytes (READ-ONLY)"
-                    },
-                    "instance_uuid": {
-                        "type": "string",
-                        "description": "ID of instance used to create this image.",
-                        "is_base": false
-                    },
-                    "os_distro": {
-                        "type": "string",
-                        "description": "Common name of operating system distribution as specified in http://docs.openstack.org/trunk/openstack-compute/admin/content/adding-images.html",
-                        "is_base": false
-                    },
-                    "name": {
-                        "type": "string",
-                        "description": "Descriptive name for the image",
-                        "maxLength": 255
-                    },
-                    "checksum": {
-                        "type": "string",
-                        "description": "md5 hash of image contents. (READ-ONLY)",
-                        "maxLength": 32
-                    },
-                    "created_at": {
-                        "type": "string",
-                        "description": "Date and time of image registration (READ-ONLY)"
-                    },
-                    "disk_format": {
-                        "enum": [
-                            "ami",
-                            "ari",
-                            "aki",
-                            "vhd",
-                            "vmdk",
-                            "raw",
-                            "qcow2",
-                            "vdi",
-                            "iso"
-                        ],
-                        "type": "string",
-                        "description": "Format of the disk"
-                    },
-                    "os_version": {
-                        "type": "string",
-                        "description": "Operating system version as specified by the distributor",
-                        "is_base": false
-                    },
-                    "protected": {
-                        "type": "boolean",
-                        "description": "If true, image will not be deletable."
-                    },
-                    "architecture": {
-                        "type": "string",
-                        "description": "Operating system architecture as specified in http://docs.openstack.org/trunk/openstack-compute/admin/content/adding-images.html",
-                        "is_base": false
-                    },
-                    "direct_url": {
-                        "type": "string",
-                        "description": "URL to access the image file kept in external store (READ-ONLY)"
-                    },
-                    "self": {
-                        "type": "string",
-                        "description": "(READ-ONLY)"
-                    },
-                    "schema": {
-                        "type": "string",
-                        "description": "(READ-ONLY)"
-                    }
-                }
-            },
-            "type": "array"
-        },
-        "schema": {
-            "type": "string"
-        },
-        "next": {
-            "type": "string"
-        },
-        "first": {
-            "type": "string"
-        }
-    }
+
        1
+  2
+  3
+  4
+  5
+  6
+  7
+  8
+  9
+ 10
+ 11
+ 12
+ 13
+ 14
+ 15
+ 16
+ 17
+ 18
+ 19
+ 20
+ 21
+ 22
+ 23
+ 24
+ 25
+ 26
+ 27
+ 28
+ 29
+ 30
+ 31
+ 32
+ 33
+ 34
+ 35
+ 36
+ 37
+ 38
+ 39
+ 40
+ 41
+ 42
+ 43
+ 44
+ 45
+ 46
+ 47
+ 48
+ 49
+ 50
+ 51
+ 52
+ 53
+ 54
+ 55
+ 56
+ 57
+ 58
+ 59
+ 60
+ 61
+ 62
+ 63
+ 64
+ 65
+ 66
+ 67
+ 68
+ 69
+ 70
+ 71
+ 72
+ 73
+ 74
+ 75
+ 76
+ 77
+ 78
+ 79
+ 80
+ 81
+ 82
+ 83
+ 84
+ 85
+ 86
+ 87
+ 88
+ 89
+ 90
+ 91
+ 92
+ 93
+ 94
+ 95
+ 96
+ 97
+ 98
+ 99
+100
+101
+102
+103
+104
+105
+106
+107
+108
+109
+110
+111
+112
+113
+114
+115
+116
+117
+118
+119
+120
+121
+122
+123
+124
+125
+126
+127
+128
+129
+130
+131
+132
+133
+134
+135
+136
+137
+138
+139
+140
+141
+142
+143
+144
+145
+146
+147
+148
+149
+150
+151
+152
+153
+154
+155
+156
+157
+158
+159
+160
+161
+162
+163
+164
+165
+166
+167
+168
+169
+170
+171
+172
+173
+174
+175
+176
+177
+178
+179
+180
+181
+182
+183
+184
+185
+186
+187
+188
+189
+190
+191
+192
+193
+194
+195
+196
+197
+198
+199
+200
+201
+202
+203
+204
+205
+206
+207
+208
+209
+210
+211
+212
+213
+214
+215
+216
+217
+218
+219
+220
+221
+222
+223
+224
      {
+    "name": "images",
+    "links": [
+        {
+            "href": "{first}",
+            "rel": "first"
+        },
+        {
+            "href": "{next}",
+            "rel": "next"
+        },
+        {
+            "href": "{schema}",
+            "rel": "describedby"
+        }
+    ],
+    "properties": {
+        "images": {
+            "items": {
+                "additionalProperties": {
+                    "type": "String"
+                },
+                "name": "image",
+                "links": [
+                    {
+                        "href": "{self}",
+                        "rel": "self"
+                    },
+                    {
+                        "href": "{file}",
+                        "rel": "enclosure"
+                    },
+                    {
+                        "href": "{schema}",
+                        "rel": "describedby"
+                    }
+                ],
+                "properties": {
+                    "status": {
+                        "enum": [
+                            "queued",
+                            "saving",
+                            "active",
+                            "killed",
+                            "deleted",
+                            "pending_delete"
+                        ],
+                        "type": "string",
+                        "description": "Status of the image (READ-ONLY)"
+                    },
+                    "tags": {
+                        "items": {
+                            "type": "string",
+                            "maxLength": 255
+                        },
+                        "type": "array",
+                        "description": "List of strings related to the image"
+                    },
+                    "kernel_id": {
+                        "pattern": "^([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}$",
+                        "type": "string",
+                        "description": "ID of image stored in Glance that should be used as the kernel when booting an AMI-style image.",
+                        "is_base": false
+                    },
+                    "container_format": {
+                        "enum": [
+                            "ami",
+                            "ari",
+                            "aki",
+                            "bare",
+                            "ovf",
+                            "ova"
+                        ],
+                        "type": "string",
+                        "description": "Format of the container"
+                    },
+                    "min_ram": {
+                        "type": "integer",
+                        "description": "Amount of ram (in MB) required to boot image."
+                    },
+                    "ramdisk_id": {
+                        "pattern": "^([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}$",
+                        "type": "string",
+                        "description": "ID of image stored in Glance that should be used as the ramdisk when booting an AMI-style image.",
+                        "is_base": false
+                    },
+                    "locations": {
+                        "items": {
+                            "required": [
+                                "url",
+                                "metadata"
+                            ],
+                            "type": "object",
+                            "properties": {
+                                "url": {
+                                    "type": "string",
+                                    "maxLength": 255
+                                },
+                                "metadata": {
+                                    "type": "object"
+                                }
+                            }
+                        },
+                        "type": "array",
+                        "description": "A set of URLs to access the image file kept in external store"
+                    },
+                    "visibility": {
+                        "enum": [
+                            "public",
+                            "private"
+                        ],
+                        "type": "string",
+                        "description": "Scope of image accessibility"
+                    },
+                    "updated_at": {
+                        "type": "string",
+                        "description": "Date and time of the last image modification (READ-ONLY)"
+                    },
+                    "owner": {
+                        "type": "string",
+                        "description": "Owner of the image",
+                        "maxLength": 255
+                    },
+                    "file": {
+                        "type": "string",
+                        "description": "(READ-ONLY)"
+                    },
+                    "min_disk": {
+                        "type": "integer",
+                        "description": "Amount of disk space (in GB) required to boot image."
+                    },
+                    "virtual_size": {
+                        "type": "integer",
+                        "description": "Virtual size of image in bytes (READ-ONLY)"
+                    },
+                    "id": {
+                        "pattern": "^([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}$",
+                        "type": "string",
+                        "description": "An identifier for the image"
+                    },
+                    "size": {
+                        "type": "integer",
+                        "description": "Size of image file in bytes (READ-ONLY)"
+                    },
+                    "instance_uuid": {
+                        "type": "string",
+                        "description": "ID of instance used to create this image.",
+                        "is_base": false
+                    },
+                    "os_distro": {
+                        "type": "string",
+                        "description": "Common name of operating system distribution as specified in http://docs.openstack.org/trunk/openstack-compute/admin/content/adding-images.html",
+                        "is_base": false
+                    },
+                    "name": {
+                        "type": "string",
+                        "description": "Descriptive name for the image",
+                        "maxLength": 255
+                    },
+                    "checksum": {
+                        "type": "string",
+                        "description": "md5 hash of image contents. (READ-ONLY)",
+                        "maxLength": 32
+                    },
+                    "created_at": {
+                        "type": "string",
+                        "description": "Date and time of image registration (READ-ONLY)"
+                    },
+                    "disk_format": {
+                        "enum": [
+                            "ami",
+                            "ari",
+                            "aki",
+                            "vhd",
+                            "vmdk",
+                            "raw",
+                            "qcow2",
+                            "vdi",
+                            "iso"
+                        ],
+                        "type": "string",
+                        "description": "Format of the disk"
+                    },
+                    "os_version": {
+                        "type": "string",
+                        "description": "Operating system version as specified by the distributor",
+                        "is_base": false
+                    },
+                    "protected": {
+                        "type": "boolean",
+                        "description": "If true, image will not be deletable."
+                    },
+                    "architecture": {
+                        "type": "string",
+                        "description": "Operating system architecture as specified in http://docs.openstack.org/trunk/openstack-compute/admin/content/adding-images.html",
+                        "is_base": false
+                    },
+                    "direct_url": {
+                        "type": "string",
+                        "description": "URL to access the image file kept in external store (READ-ONLY)"
+                    },
+                    "self": {
+                        "type": "string",
+                        "description": "(READ-ONLY)"
+                    },
+                    "schema": {
+                        "type": "string",
+                        "description": "(READ-ONLY)"
+                    }
+                }
+            },
+            "type": "array"
+        },
+        "schema": {
+            "type": "string"
+        },
+        "next": {
+            "type": "string"
+        },
+        "first": {
+            "type": "string"
+        }
+    }
 }
-
      
-
-
      + +

      • Returned Values

      • Normal

        200

      • Abnormal -

        Returned Value

        +
        - - - - - - - - - - - - - diff --git a/docs/ims/api-ref/en-us_topic_0020091562.html b/docs/ims/api-ref/en-us_topic_0020091562.html index d576aae58..0d01df4e1 100644 --- a/docs/ims/api-ref/en-us_topic_0020091562.html +++ b/docs/ims/api-ref/en-us_topic_0020091562.html @@ -1,7 +1,7 @@

        Image Attributes

        -

        Description

        An image is an ECS template containing mandatory software, such as an OS. The template may also contain application software, such as database software, and proprietary software. Image is the core object of IMS.

        +

        Description

        An image is a template containing mandatory software, such as an OS. The template may also contain application software, such as database software, and proprietary software. Image is the core object of IMS.

        Image Attributes

        Returned Value

        Description

        +

        Description

        400 Bad Request

        +

        400 Bad Request

        Request error.

        +

        Request error.

        401 Unauthorized

        +

        401 Unauthorized

        Authentication failed.

        +

        Authentication failed.

        403 Forbidden

        +

        403 Forbidden

        You do not have the rights to perform the operation.

        +

        You do not have the rights to perform the operation.

        404 Not Found

        +

        404 Not Found

        The requested resource was not found.

        +

        The requested resource was not found.

        500 Internal Server Error

        +

        500 Internal Server Error

        Internal service error.

        +

        Internal service error.

        503 Service Unavailable

        +

        503 Service Unavailable

        The service is unavailable.

        +

        The service is unavailable.
        - - - - - - - - @@ -267,7 +267,7 @@ - - - - -

        Name

        @@ -290,21 +290,21 @@

        String

        Specifies whether the image supports large-memory ECSs. If the image supports large-memory ECSs, the value is true. Otherwise, this parameter is not required.

        +

        Specifies whether the image supports large-memory ECSs. If the image supports large-memory ECSs, the value is true. Otherwise, this parameter is not required.

        __support_diskintensive

        String

        Specifies whether the image supports disk-intensive ECSs. If the image supports disk-intensive ECSs, the value is true. Otherwise, this parameter is not required.

        +

        Specifies whether the image supports disk-intensive ECSs. If the image supports disk-intensive ECSs, the value is true. Otherwise, this parameter is not required.

        __support_highperformance

        String

        Specifies whether the image supports high-performance ECSs. If the image supports high-performance ECSs, the value is true. Otherwise, this parameter is not required.

        +

        Specifies whether the image supports high-performance ECSs. If the image supports high-performance ECSs, the value is true. Otherwise, this parameter is not required.

        __support_xen_gpu_type

        @@ -327,15 +327,15 @@

        String

        Specifies whether the image supports HANA ECSs on the Xen platform. If yes, the value is true. Otherwise, this parameter is not required.

        -

        This attribute cannot co-exist with __support_xen.

        +

        This attribute cannot co-exist with __support_xen.

        __support_kvm_infiniband

        String

        Specifies whether the image supports ECSs with the InfiniBand NIC on the KVM platform. If yes, the value is true. Otherwise, this parameter is not required.

        -

        This attribute cannot co-exist with __support_xen.

        +

        Specifies whether the image supports ECSs with InfiniBand NICs on the KVM platform. If yes, the value is true. Otherwise, this parameter is not required.

        +

        This attribute cannot co-exist with __support_xen.

        __is_config_init

        diff --git a/docs/ims/api-ref/en-us_topic_0020091565.html b/docs/ims/api-ref/en-us_topic_0020091565.html index d4f7aa29e..02b6e2a6e 100644 --- a/docs/ims/api-ref/en-us_topic_0020091565.html +++ b/docs/ims/api-ref/en-us_topic_0020091565.html @@ -145,7 +145,7 @@

        Integer

        Specifies the minimum disk space (GB) required for running the image. The value ranges from 1 GB to 1024 GB.

        +

        Specifies the minimum disk space (GB) required for running the image. The value ranges from 1 GB to 1,024 GB.

        __os_bit

        @@ -163,7 +163,7 @@

        String

        Specifies the image platform type. The value can be Windows, Ubuntu, Red Hat, SUSE, CentOS, Debian, OpenSUSE, Oracle Linux, Fedora, Other, CoreOS, or EulerOS.

        +

        Specifies the image platform type. The value can be Windows, Ubuntu, Red Hat, SUSE, CentOS, Debian, OpenSUSE, Oracle Linux, Fedora, CoreOS, EulerOS, or Other.

        marker

        @@ -181,7 +181,7 @@

        Integer

        Specifies the number of images to be queried. The value is an integer and is 500 by default.

        +

        Specifies the number of images that will be returned. The value is an integer and is 500 by default.

        sort_key

        @@ -256,7 +256,7 @@

        String

        Specifies whether the image supports large-memory ECSs. If the image supports large-memory ECSs, the value is true. Otherwise, this parameter is not required.

        +

        Specifies whether the image supports large-memory ECSs. If the image supports large-memory ECSs, the value is true. Otherwise, this parameter is not required.

        For the supported OSs, see Table 4.

        String

        Specifies whether the image supports disk-intensive ECSs. If the image supports disk-intensive ECSs, the value is true. Otherwise, this parameter is not required.

        +

        Specifies whether the image supports disk-intensive ECSs. If the image supports disk-intensive ECSs, the value is true. Otherwise, this parameter is not required.

        __support_highperformance

        @@ -276,7 +276,7 @@

        String

        Specifies whether the image supports high-performance ECSs. If the image supports high-performance ECSs, the value is true. Otherwise, this parameter is not required.

        +

        Specifies whether the image supports high-performance ECSs. If the image supports high-performance ECSs, the value is true. Otherwise, this parameter is not required.

        __support_xen_gpu_type

        @@ -294,7 +294,7 @@

        String

        Specifies whether the image supports GPU-accelerated ECSs on the KVM platform. See Table 3 for its value. If the image does not support GPU-accelerated ECSs on the KVM platform, this parameter is not required. This attribute cannot co-exist with __support_xen and __support_kvm.

        +

        Specifies whether the image supports GPU-accelerated ECSs on the KVM platform. See Table 3 for its value. If the image does not support GPU-accelerated ECSs on the KVM platform, this parameter is not required. This attribute cannot co-exist with __support_xen and __support_kvm.

        __support_xen_hana

        @@ -304,7 +304,7 @@

        String

        Specifies whether the image supports HANA ECSs on the Xen platform. If yes, the value is true. Otherwise, this parameter is not required.

        -

        This attribute cannot co-exist with __support_xen and __support_kvm.

        +

        This attribute cannot co-exist with __support_xen and __support_kvm.

        __support_kvm_infiniband

        @@ -313,8 +313,8 @@

        String

        Specifies whether the image supports ECSs with the InfiniBand NIC on the KVM platform. If yes, the value is true. Otherwise, this parameter is not required.

        -

        This attribute cannot co-exist with __support_xen.

        +

        Specifies whether the image supports ECSs with InfiniBand NICs on the KVM platform. If yes, the value is true. Otherwise, this parameter is not required.

        +

        This attribute cannot co-exist with __support_xen.

        virtual_env_type

        @@ -358,7 +358,7 @@

        String

        Specifies the time when the image was modified. Images can be queried by time. The value is in the format of Operator:UTC time.

        +

        Specifies the time when the image was modified. Images can be queried by time. The value is in the format of Operator:UTC time.

        The following operators are supported:

        • gt: greater than
        • gte: greater than or equal to
        • lt: less than
        • lte: less than or equal to
        • eq: equal to
        • neq: not equal to

        The time format is yyyy-MM-ddThh:mm:ssZ or yyyy-MM-dd hh:mm:ss.

        @@ -370,9 +370,11 @@
        -

        Request

        • Request parameters

          None

          -
        • Example request
          GET https://{Endpoint}/v2/cloudimages?__imagetype=gold&sort_key=name&limit=1
          -
        +

        Request

        Request parameters

        +

        None

        +
        +

        Example Request

        Querying public images (the results will be sorted by image name and only one image will be returned)

        +
        GET https://{Endpoint}/v2/cloudimages?__imagetype=gold&sort_key=name&limit=1

        Common Query Methods

        • Public images

          GET /v2/cloudimages?__imagetype=gold&visibility=public&protected=true

        • Private images

          GET /v2/cloudimages?owner={project_id}

          @@ -382,19 +384,19 @@

        Response

        • Response parameters -

          Parameter

          +
          - - - - - @@ -402,581 +404,580 @@

          Parameter

          Type

          +

          Type

          Description

          +

          Description

          images

          +

          images

          Array of objects

          +

          Array of objects

          Specifies image details.

          +

          Specifies image details.

          For details, see Table 2.
          -
          Table 2 Data structure description of the images field

          Parameter

          +
          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
          Table 2 Data structure description of the images field

          Parameter

          Type

          +

          Type

          Description

          +

          Description

          file

          +

          file

          String

          +

          String

          Specifies the URL for uploading and downloading the image file.

          +

          Specifies the URL for uploading and downloading the image file.

          owner

          +

          owner

          String

          +

          String

          Specifies the tenant to which the image belongs.

          +

          Specifies the tenant to which the image belongs.

          id

          +

          id

          String

          +

          String

          Specifies the image ID.

          +

          Specifies the image ID.

          size

          +

          size

          Long

          +

          Long

          This parameter is unavailable currently.

          +

          This parameter is unavailable currently.

          self

          +

          self

          String

          +

          String

          Specifies the image URL.

          +

          Specifies the image URL.

          schema

          +

          schema

          String

          +

          String

          Specifies the image schema.

          +

          Specifies the image schema.

          status

          +

          status

          String

          +

          String

          Specifies the image status. The value can be one of the following:

          -
          • queued: indicates that the image metadata has already been created, and it is ready for the image file to upload.
          • saving: indicates that the image file is being uploaded to the backend storage.
          • deleted: indicates that the image has been deleted.
          • killed: indicates that an error occurs on the image uploading.
          • active: indicates that the image is available for use.
          +

          Specifies the image status. The value can be one of the following:

          +
          • queued: indicates that the image metadata has already been created, and it is ready for the image file to upload.
          • saving: indicates that the image file is being uploaded to the backend storage.
          • deleted: indicates that the image has been deleted.
          • killed: indicates that an error occurs on the image uploading.
          • active: indicates that the image is available for use.

          tags

          +

          tags

          Array of strings

          +

          Array of strings

          Specifies tags of the image, through which you can manage private images in your own way. You can use the image tag API to add different tags to each image and filter images by tag.

          +

          Specifies tags of the image, through which you can manage private images in your own way. You can use the image tag API to add different tags to each image and filter images by tag.

          visibility

          +

          visibility

          String

          +

          String

          Specifies whether the image is available to other tenants. Available values include:

          +

          Specifies whether the image is available to other tenants. Available values include:

          • private: private image
          • public: public image
          • shared: shared image

          name

          +

          name

          String

          +

          String

          Specifies the image name. For detailed description, see Image Attributes.

          +

          Specifies the image name. For detailed description, see Image Attributes.

          checksum

          +

          checksum

          String

          +

          String

          This parameter is unavailable currently.

          +

          This parameter is unavailable currently.

          protected

          +

          protected

          Boolean

          +

          Boolean

          Specifies whether the image is protected. A protected image cannot be deleted. The value can be true or false.

          +

          Specifies whether the image is protected. A protected image cannot be deleted. The value can be true or false.

          container_format

          +

          container_format

          String

          +

          String

          Specifies the container type.

          +

          Specifies the container type.

          min_ram

          +

          min_ram

          Integer

          +

          Integer

          Specifies the minimum memory size (MB) required for running the image. The parameter value depends on the ECS specifications. Generally, the value is 0.

          +

          Specifies the minimum memory size (MB) required for running the image. The parameter value depends on the ECS specifications. Generally, the value is 0.

          max_ram

          +

          max_ram

          String

          +

          String

          Specifies the maximum memory (MB) of the image. You can set this parameter based on the ECS specifications. Generally, you do not need to set this parameter.

          +

          Specifies the maximum memory (MB) of the image. You can set this parameter based on the ECS specifications. Generally, you do not need to set this parameter.

          updated_at

          +

          updated_at

          String

          +

          String

          Specifies the time when the image was updated. The value is in UTC format.

          +

          Specifies the time when the image was updated. The value is in UTC format.

          __os_bit

          +

          __os_bit

          String

          +

          String

          Specifies the OS architecture, 32 bit or 64 bit.

          +

          Specifies the OS architecture, 32 bit or 64 bit.

          __os_version

          +

          __os_version

          String

          +

          String

          Specifies the OS version.

          +

          Specifies the OS version.

          __description

          +

          __description

          String

          +

          String

          Specifies the image description. For detailed description, see Image Attributes.

          +

          Provides supplementary information about the image. For detailed description, see Image Attributes.

          disk_format

          +

          disk_format

          String

          +

          String

          Specifies the image format. The value can be zvhd2, vhd, zvhd, raw, or qcow2. The default value is zvhd2.

          +

          Specifies the image format. The value can be zvhd2, vhd, zvhd, raw, or qcow2. The default value is zvhd2.

          __isregistered

          +

          __isregistered

          String

          +

          String

          Specifies whether the image has been registered. The value can be true or false.

          +

          Specifies whether the image has been registered. The value can be true or false.

          __platform

          +

          __platform

          String

          +

          String

          Specifies the image platform type. The value can be Windows, Ubuntu, Red Hat, SUSE, CentOS, Debian, OpenSUSE, Oracle Linux, Fedora, Other, CoreOS, or EulerOS.

          +

          Specifies the image platform type. The value can be Windows, Ubuntu, Red Hat, SUSE, CentOS, Debian, OpenSUSE, Oracle Linux, Fedora, Other, CoreOS, or EulerOS.

          __os_type

          +

          __os_type

          String

          +

          String

          Specifies the OS type. The value can be Linux, Windows, or Other.

          +

          Specifies the OS type. The value can be Linux, Windows, or Other.

          min_disk

          +

          min_disk

          Integer

          +

          Integer

          Specifies the minimum disk space (GB) required for running the image. The value ranges from 1 GB to 1024 GB.

          +

          Specifies the minimum disk space (GB) required for running the image. The value ranges from 1 GB to 1,024 GB.

          virtual_env_type

          +

          virtual_env_type

          String

          +

          String

          Specifies the environment where the image is used. The value can be FusionCompute, Ironic, DataImage, or IsoImage.

          +

          Specifies the environment where the image is used. The value can be FusionCompute, Ironic, DataImage, or IsoImage.

          • For an ECS image, the value is FusionCompute.
          • For a data disk image, the value is DataImage.
          • For a BMS image, the value is Ironic.
          • For an ISO image, the value is IsoImage.

          __image_source_type

          +

          __image_source_type

          String

          +

          String

          Specifies the image backend storage type. Only UDS is supported currently.

          +

          Specifies the image backend storage type. Only UDS is supported currently.

          __imagetype

          +

          __imagetype

          String

          +

          String

          Specifies the image type. The following types are supported:

          -
          • Public image: The value is gold.
          • Private image: The value is private.
          • Shared image: The value is shared.
          +

          Specifies the image type. The following types are supported:

          +
          • Public image: The value is gold.
          • Private image: The value is private.
          • Shared image: The value is shared.

          created_at

          +

          created_at

          String

          +

          String

          Specifies the time when the image was created. The value is in UTC format.

          +

          Specifies the time when the image was created. The value is in UTC format.

          virtual_size

          +

          virtual_size

          Integer

          +

          Integer

          This parameter is unavailable currently.

          +

          This parameter is unavailable currently.

          __originalimagename

          +

          __originalimagename

          String

          +

          String

          Specifies the parent image ID.

          +

          Specifies the parent image ID.

          If the image is a public image or created from an image file, this value is left empty.

          __backup_id

          +

          __backup_id

          String

          +

          String

          Specifies the backup ID. To create an image using a backup, set the value to the backup ID. Otherwise, this value is left empty.

          +

          Specifies the backup ID. To create an image using a backup, set the value to the backup ID. Otherwise, this value is left empty.

          __image_size

          +

          __image_size

          String

          +

          String

          Specifies the size (bytes) of the image file.

          +

          Specifies the size (bytes) of the image file.

          __data_origin

          +

          __data_origin

          String

          +

          String

          Specifies the image source.

          +

          Specifies the image source.

          If the image is a public image, this parameter is left empty.

          __lazyloading

          +

          __lazyloading

          String

          +

          String

          Specifies whether the image supports lazy loading. The value can be true, false, True, or False.

          +

          Specifies whether the image supports lazy loading. The value can be true, false, True, or False.

          active_at

          +

          active_at

          String

          +

          String

          Specifies the time when the image status became active.

          +

          Specifies the time when the image status became active.

          __os_feature_list

          +

          __os_feature_list

          String

          +

          String

          Specifies additional attributes of the image. The value is a list (in JSON format) of advanced features supported by the image.

          +

          Specifies additional attributes of the image. The value is a list (in JSON format) of advanced features supported by the image.

          __support_kvm

          +

          __support_kvm

          String

          +

          String

          Specifies whether the image supports KVM. If yes, the value is true. Otherwise, this parameter is not required.

          +

          Specifies whether the image supports KVM. If yes, the value is true. Otherwise, this parameter is not required.

          __support_xen

          +

          __support_xen

          String

          +

          String

          Specifies whether the image supports Xen. If yes, the value is true. Otherwise, this parameter is not required.

          +

          Specifies whether the image supports Xen. If yes, the value is true. Otherwise, this parameter is not required.

          __support_largememory

          +

          __support_largememory

          String

          +

          String

          Specifies whether the image supports large-memory ECSs. If the image supports large-memory ECSs, the value is true. Otherwise, this parameter is not required.

          +

          Specifies whether the image supports large-memory ECSs. If the image supports large-memory ECSs, the value is true. Otherwise, this parameter is not required.

          __support_diskintensive

          +

          __support_diskintensive

          String

          +

          String

          Specifies whether the image supports disk-intensive ECSs. If the image supports disk-intensive ECSs, the value is true. Otherwise, this parameter is not required.

          +

          Specifies whether the image supports disk-intensive ECSs. If the image supports disk-intensive ECSs, the value is true. Otherwise, this parameter is not required.

          __support_highperformance

          +

          __support_highperformance

          String

          +

          String

          Specifies whether the image supports high-performance ECSs. If the image supports high-performance ECSs, the value is true. Otherwise, this parameter is not required.

          +

          Specifies whether the image supports high-performance ECSs. If the image supports high-performance ECSs, the value is true. Otherwise, this parameter is not required.

          __support_xen_gpu_type

          +

          __support_xen_gpu_type

          String

          +

          String

          Specifies whether the image supports GPU-accelerated ECSs on the Xen platform. See Table 2 for its value. If the image does not support GPU-accelerated ECSs on the Xen platform, this parameter is not required. This attribute cannot co-exist with __support_xen and __support_kvm.

          +

          Specifies whether the image supports GPU-accelerated ECSs on the Xen platform. See Table 2 for its value. If the image does not support GPU-accelerated ECSs on the Xen platform, this parameter is not required. This attribute cannot co-exist with __support_xen and __support_kvm.

          __support_kvm_gpu_type

          +

          __support_kvm_gpu_type

          String

          +

          String

          Specifies whether the image supports GPU-accelerated ECSs on the KVM platform. See Table 3 for its value.

          -

          If the image does not support GPU-accelerated ECSs on the KVM platform, this parameter is not required. This attribute cannot co-exist with __support_xen and __support_kvm.

          +

          Specifies whether the image supports GPU-accelerated ECSs on the KVM platform. See Table 3 for its value.

          +

          If the image does not support GPU-accelerated ECSs on the KVM platform, this parameter is not required. This attribute cannot co-exist with __support_xen and __support_kvm.

          __support_xen_hana

          +

          __support_xen_hana

          String

          +

          String

          Specifies whether the image supports HANA ECSs on the Xen platform. If yes, the value is true. Otherwise, this parameter is not required.

          -

          This attribute cannot co-exist with __support_xen and __support_kvm.

          +

          Specifies whether the image supports HANA ECSs on the Xen platform. If yes, the value is true. Otherwise, this parameter is not required.

          +

          This attribute cannot co-exist with __support_xen and __support_kvm.

          __support_kvm_infiniband

          +

          __support_kvm_infiniband

          String

          +

          String

          Specifies whether the image supports ECSs with the InfiniBand NIC on the KVM platform. If yes, the value is true. Otherwise, this parameter is not required.

          -

          This attribute cannot co-exist with __support_xen.

          +

          Specifies whether the image supports ECSs with InfiniBand NICs on the KVM platform. If yes, the value is true. Otherwise, this parameter is not required.

          +

          This attribute cannot co-exist with __support_xen.

          enterprise_project_id

          +

          enterprise_project_id

          String

          +

          String

          Specifies the enterprise project that the image belongs to.

          +

          Specifies the enterprise project that the image belongs to.

          • If the value is 0 or left blank, the image belongs to the default enterprise project.
          • If the value is a UUID, the image belongs to the enterprise project corresponding to the UUID.

            For more information about enterprise projects, see Enterprise Management User Guide.

          __root_origin

          +

          __root_origin

          String

          +

          String

          Specifies that the image is created from an external image file. Value: file

          +

          Specifies that the image is created from an external image file. Value: file

          __sequence_num

          +

          __sequence_num

          String

          +

          String

          Specifies the ECS system disk slot number corresponding to the image.

          +

          Specifies the ECS system disk slot number of the image.

          Example value: 0

          __support_fc_inject

          +

          __support_fc_inject

          String

          +

          String

          Specifies whether the image supports password/private key injection using Cloud-Init.

          +

          Specifies whether the image supports password/private key injection using Cloud-Init.

          If the value is set to true, password/private key injection using Cloud-Init is not supported.

          NOTE:

          This parameter is valid only for ECS system disk images.

          hw_firmware_type

          +

          hw_firmware_type

          String

          +

          String

          Specifies the ECS boot mode. Available values include:

          +

          Specifies the ECS boot mode. Available values include:

          • bios indicates the BIOS boot mode.
          • uefi indicates the UEFI boot mode.

          hw_vif_multiqueue_enabled

          +

          hw_vif_multiqueue_enabled

          String

          +

          String

          Specifies whether the image supports NIC multi-queue. The value can be true or false.

          +

          Specifies whether the image supports NIC multi-queue. The value can be true or false.

          __system__cmkid

          +

          __system__cmkid

          String

          +

          String

          Specifies the ID of the key used to encrypt the image.

          +

          Specifies the ID of the key used to encrypt the image.

          __support_amd

          +

          __support_amd

          String

          +

          String

          Specifies whether the image uses AMD's x86 architecture. The value can be true or false.

          +

          Specifies whether the image uses AMD's x86 architecture. The value can be true or false.
        • Example response
          STATUS CODE 200
          -
           1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
-11
-12
-13
-14
-15
-16
-17
-18
-19
-20
-21
-22
-23
-24
-25
-26
-27
-28
-29
-30
-31
-32
-33
-34
-35
-36
-37
-38
-39
-40
-41
-42
-43
-44
-45
-46
-47
-48
-49
-50
-51
-52
-53
-54
-55
-56
-57
-58
-59
-60
-61
-62
-63
-64
-65
-66
-67
-68
          {
-  "images": [
-    {
-      "schema": "/v2/schemas/image",
-      "min_disk": 100,
-      "created_at": "2018-09-06T14:03:27Z",
-      "__image_source_type": "uds",
-      "container_format": "bare",
-      "file": "/v2/images/bc6bed6e-ba3a-4447-afcc-449174a3eb52/file",
-      "updated_at": "2018-09-06T15:17:33Z",
-      "protected": true,
-      "checksum": "d41d8cd98f00b204e9800998ecf8427e",
-      "id": "bc6bed6e-ba3a-4447-afcc-449174a3eb52",
-      "__isregistered": "true",
-      "min_ram": 2048,
-      "__lazyloading": "true",
-      "owner": "1bed856811654c1cb661a6ca845ebc77",
-      "__os_type": "Linux",
-      "__imagetype": "gold",
-      "visibility": "public",
-      "virtual_env_type": "FusionCompute",
-      "tags": [],
-      "__platform": "CentOS",
-      "size": 0,
-      "__os_bit": "64",
-      "__os_version": "CentOS 7.3 64bit",
-      "name": "CentOS 7.3 64bit vivado",
-      "self": "/v2/images/bc6bed6e-ba3a-4447-afcc-449174a3eb52",
-      "disk_format": "zvhd2",
-      "virtual_size": null,
-      "hw_firmware_type": "bios",
-      "status": "active",
-      "__support_fc_inject":"true"
-    },
-    {
-      "schema": "/v2/schemas/image",
-      "min_disk": 100,
-      "created_at": "2018-09-06T14:03:05Z",
-      "__image_source_type": "uds",
-      "container_format": "bare",
-      "file": "/v2/images/0328c25e-c840-4496-81ac-c4e01b214b1f/file",
-      "updated_at": "2018-09-25T14:27:40Z",
-      "protected": true,
-      "checksum": "d41d8cd98f00b204e9800998ecf8427e",
-      "id": "0328c25e-c840-4496-81ac-c4e01b214b1f",
-      "__isregistered": "true",
-      "min_ram": 2048,
-      "__lazyloading": "true",
-      "owner": "1bed856811654c1cb661a6ca845ebc77",
-      "__os_type": "Linux",
-      "__imagetype": "gold",
-      "visibility": "public",
-      "virtual_env_type": "FusionCompute",
-      "tags": [],
-      "__platform": "CentOS",
-      "size": 0,
-      "__os_bit": "64",
-      "__os_version": "CentOS 7.3 64bit",
-      "name": "CentOS 7.3 64bit with sdx",
-      "self": "/v2/images/0328c25e-c840-4496-81ac-c4e01b214b1f",
-      "disk_format": "zvhd2",
-      "virtual_size": null,
-      "hw_firmware_type": "bios",
-      "status": "active",
-      "__support_fc_inject":"true"
-    }
-  ]
+
           1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
+13
+14
+15
+16
+17
+18
+19
+20
+21
+22
+23
+24
+25
+26
+27
+28
+29
+30
+31
+32
+33
+34
+35
+36
+37
+38
+39
+40
+41
+42
+43
+44
+45
+46
+47
+48
+49
+50
+51
+52
+53
+54
+55
+56
+57
+58
+59
+60
+61
+62
+63
+64
+65
+66
+67
+68
          {
+  "images": [
+    {
+      "schema": "/v2/schemas/image",
+      "min_disk": 100,
+      "created_at": "2018-09-06T14:03:27Z",
+      "__image_source_type": "uds",
+      "container_format": "bare",
+      "file": "/v2/images/bc6bed6e-ba3a-4447-afcc-449174a3eb52/file",
+      "updated_at": "2018-09-06T15:17:33Z",
+      "protected": true,
+      "checksum": "d41d8cd98f00b204e9800998ecf8427e",
+      "id": "bc6bed6e-ba3a-4447-afcc-449174a3eb52",
+      "__isregistered": "true",
+      "min_ram": 2048,
+      "__lazyloading": "true",
+      "owner": "1bed856811654c1cb661a6ca845ebc77",
+      "__os_type": "Linux",
+      "__imagetype": "gold",
+      "visibility": "public",
+      "virtual_env_type": "FusionCompute",
+      "tags": [],
+      "__platform": "CentOS",
+      "size": 0,
+      "__os_bit": "64",
+      "__os_version": "CentOS 7.3 64bit",
+      "name": "CentOS 7.3 64bit vivado",
+      "self": "/v2/images/bc6bed6e-ba3a-4447-afcc-449174a3eb52",
+      "disk_format": "zvhd2",
+      "virtual_size": null,
+      "hw_firmware_type": "bios",
+      "status": "active",
+      "__support_fc_inject":"true"
+    },
+    {
+      "schema": "/v2/schemas/image",
+      "min_disk": 100,
+      "created_at": "2018-09-06T14:03:05Z",
+      "__image_source_type": "uds",
+      "container_format": "bare",
+      "file": "/v2/images/0328c25e-c840-4496-81ac-c4e01b214b1f/file",
+      "updated_at": "2018-09-25T14:27:40Z",
+      "protected": true,
+      "checksum": "d41d8cd98f00b204e9800998ecf8427e",
+      "id": "0328c25e-c840-4496-81ac-c4e01b214b1f",
+      "__isregistered": "true",
+      "min_ram": 2048,
+      "__lazyloading": "true",
+      "owner": "1bed856811654c1cb661a6ca845ebc77",
+      "__os_type": "Linux",
+      "__imagetype": "gold",
+      "visibility": "public",
+      "virtual_env_type": "FusionCompute",
+      "tags": [],
+      "__platform": "CentOS",
+      "size": 0,
+      "__os_bit": "64",
+      "__os_version": "CentOS 7.3 64bit",
+      "name": "CentOS 7.3 64bit with sdx",
+      "self": "/v2/images/0328c25e-c840-4496-81ac-c4e01b214b1f",
+      "disk_format": "zvhd2",
+      "virtual_size": null,
+      "hw_firmware_type": "bios",
+      "status": "active",
+      "__support_fc_inject":"true"
+    }
+  ]
 }
-
          
-
-
          + +

          • Returned Values

          • Normal

            200

          • Abnormal -

            Returned Value

            +
            - - - - - - - - - - - - - diff --git a/docs/ims/api-ref/en-us_topic_0020091566.html b/docs/ims/api-ref/en-us_topic_0020091566.html index e4be5f11e..a0fafc2b4 100644 --- a/docs/ims/api-ref/en-us_topic_0020091566.html +++ b/docs/ims/api-ref/en-us_topic_0020091566.html @@ -4,7 +4,7 @@

            Function

            This API is used to query details about a public or private image.

            URI

            GET /v2/images/{image_id}

            -
            Table 1 lists the parameters. +
            Table 1 lists the parameters in the URI.

            Returned Value

            Description

            +

            Description

            400 Bad Request

            +

            400 Bad Request

            Request error. For details about the returned error code, see Error Codes.

            +

            Request error. For details about the returned error code, see Error Codes.

            401 Unauthorized

            +

            401 Unauthorized

            Authentication failed.

            +

            Authentication failed.

            403 Forbidden

            +

            403 Forbidden

            You do not have the rights to perform the operation.

            +

            You do not have the rights to perform the operation.

            404 Not Found

            +

            404 Not Found

            The requested resource was not found.

            +

            The requested resource was not found.

            500 Internal Server Error

            +

            500 Internal Server Error

            Internal service error.

            +

            Internal service error.

            503 Service Unavailable

            +

            503 Service Unavailable

            The service is unavailable.

            +

            The service is unavailable.
            Table 1 Parameter description

            Parameter

            Mandatory

            @@ -29,525 +29,526 @@ -

            Request

            • Request parameters

              None

              -
            • Example request
              GET https://{Endpoint}/v2/images/33ad552d-1149-471c-8190-ff6776174a00
              -
            +

            Request

            Request parameters

            +

            None

            +
            +

            Example Request

            Querying details of an image

            +
            GET https://{Endpoint}/v2/images/33ad552d-1149-471c-8190-ff6776174a00

            Response

            • Response parameters -

              Parameter

              +
              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

              Parameter

              Type

              +

              Type

              Description

              +

              Description

              file

              +

              file

              String

              +

              String

              Specifies the URL for uploading and downloading the image file.

              +

              Specifies the URL for uploading and downloading the image file.

              owner

              +

              owner

              String

              +

              String

              Specifies the tenant to which the image belongs.

              +

              Specifies the tenant to which the image belongs.

              id

              +

              id

              String

              +

              String

              Specifies the image ID.

              +

              Specifies the image ID.

              size

              +

              size

              Long

              +

              Long

              This parameter is unavailable currently.

              +

              This parameter is unavailable currently.

              self

              +

              self

              String

              +

              String

              Specifies the image URL.

              +

              Specifies the image URL.

              schema

              +

              schema

              String

              +

              String

              Specifies the image schema.

              +

              Specifies the image schema.

              status

              +

              status

              String

              +

              String

              Specifies the image status. The value can be one of the following:

              +

              Specifies the image status. The value can be one of the following:

              • queued: indicates that the image metadata has already been created, and it is ready for the image file to upload.
              • saving: indicates that the image file is being uploaded to the backend storage.
              • deleted: indicates that the image has been deleted.
              • killed: indicates that an error occurs on the image uploading.
              • active: indicates that the image is available for use.

              tags

              +

              tags

              Array of strings

              +

              Array of strings

              Specifies tags of the image, through which you can manage private images in your own way. You can use the image tag API to add different tags to each image and filter images by tag.

              +

              Specifies tags of the image, through which you can manage private images in your own way. You can use the image tag API to add different tags to each image and filter images by tag.

              visibility

              +

              visibility

              String

              +

              String

              Specifies whether the image is available to other tenants. Available values include:

              +

              Specifies whether the image is available to other tenants. Available values include:

              • private: private image
              • public: public image
              • shared: shared image

              name

              +

              name

              String

              +

              String

              Specifies the image name. For detailed description, see Image Attributes.

              +

              Specifies the image name. For detailed description, see Image Attributes.

              checksum

              +

              checksum

              String

              +

              String

              This parameter is unavailable currently.

              +

              This parameter is unavailable currently.

              protected

              +

              protected

              Boolean

              +

              Boolean

              Specifies whether the image is protected. A protected image cannot be deleted. The value can be true or false.

              +

              Specifies whether the image is protected. A protected image cannot be deleted. The value can be true or false.

              container_format

              +

              container_format

              String

              +

              String

              Specifies the container type.

              +

              Specifies the container type.

              min_ram

              +

              min_ram

              Integer

              +

              Integer

              Specifies the minimum memory size (MB) required for running the image. The parameter value depends on the ECS specifications. Generally, the value is 0.

              +

              Specifies the minimum memory size (MB) required for running the image. The parameter value depends on the ECS specifications. Generally, the value is 0.

              max_ram

              +

              max_ram

              String

              +

              String

              Specifies the maximum memory (MB) of the image. You can set this parameter based on the ECS specifications. Generally, you do not need to set this parameter.

              +

              Specifies the maximum memory (MB) of the image. You can set this parameter based on the ECS specifications. Generally, you do not need to set this parameter.

              updated_at

              +

              updated_at

              String

              +

              String

              Specifies the time when the image was updated. The value is in UTC format.

              +

              Specifies the time when the image was updated. The value is in UTC format.

              __os_bit

              +

              __os_bit

              String

              +

              String

              Specifies the OS architecture, 32 bit or 64 bit.

              +

              Specifies the OS architecture, 32 bit or 64 bit.

              __os_version

              +

              __os_version

              String

              +

              String

              Specifies the OS version.

              +

              Specifies the OS version.

              __description

              +

              __description

              String

              +

              String

              Specifies the image description. For detailed description, see Image Attributes.

              +

              Specifies the image description. For detailed description, see Image Attributes.

              disk_format

              +

              disk_format

              String

              +

              String

              Specifies the image format. The value can be zvhd2, vhd, zvhd, raw, or qcow2. The default value is zvhd2.

              +

              Specifies the image format. The value can be zvhd2, vhd, zvhd, raw, or qcow2. The default value is zvhd2.

              __isregistered

              +

              __isregistered

              String

              +

              String

              Specifies whether the image has been registered. The value can be true or false.

              +

              Specifies whether the image has been registered. The value can be true or false.

              __platform

              +

              __platform

              String

              +

              String

              Specifies the image platform type. The value can be Windows, Ubuntu, Red Hat, SUSE, CentOS, Debian, OpenSUSE, Oracle Linux, Fedora, Other, CoreOS, or EulerOS.

              +

              Specifies the image platform type. The value can be Windows, Ubuntu, Red Hat, SUSE, CentOS, Debian, OpenSUSE, Oracle Linux, Fedora, Other, CoreOS, or EulerOS.

              __os_type

              +

              __os_type

              String

              +

              String

              Specifies the OS type. The value can be Linux, Windows, or Other.

              +

              Specifies the OS type. The value can be Linux, Windows, or Other.

              __system__cmkid

              +

              __system__cmkid

              String

              +

              String

              Specifies the ID of the key used to encrypt the image.

              +

              Specifies the ID of the key used to encrypt the image.

              min_disk

              +

              min_disk

              Integer

              +

              Integer

              Specifies the minimum disk space (GB) required for running the image. The value ranges from 1 GB to 1024 GB.

              +

              Specifies the minimum disk space (GB) required for running the image. The value ranges from 1 GB to 1,024 GB.

              virtual_env_type

              +

              virtual_env_type

              String

              +

              String

              Specifies the environment where the image is used. The value can be FusionCompute, Ironic, DataImage, or IsoImage.

              +

              Specifies the environment where the image is used. The value can be FusionCompute, Ironic, DataImage, or IsoImage.

              • For an ECS image (system disk image), the value is FusionCompute.
              • For a data disk image, the value is DataImage.
              • For a BMS image, the value is Ironic.
              • For an ISO image, the value is IsoImage.

              __image_source_type

              +

              __image_source_type

              String

              +

              String

              Specifies the backend storage of the image. Only UDS is supported currently.

              +

              Specifies the backend storage of the image. Only UDS is supported currently.

              __imagetype

              +

              __imagetype

              String

              +

              String

              Specifies the image type. The following types are supported:

              +

              Specifies the image type. The following types are supported:

              • Public image: The value is gold.
              • Private image: The value is private.
              • Shared image: The value is shared.

              created_at

              +

              created_at

              String

              +

              String

              Specifies the time when the image was created. The value is in UTC format.

              +

              Specifies the time when the image was created. The value is in UTC format.

              virtual_size

              +

              virtual_size

              Integer

              +

              Integer

              This parameter is unavailable currently.

              +

              This parameter is unavailable currently.

              __originalimagename

              +

              __originalimagename

              String

              +

              String

              Specifies the parent image ID.

              +

              Specifies the parent image ID.

              If the image is a public image or created from an image file, this value is left empty.

              __backup_id

              +

              __backup_id

              String

              +

              String

              Specifies the backup ID. To create an image using a backup, set the value to the backup ID. Otherwise, this value is left empty.

              +

              Specifies the backup ID. To create an image using a backup, set the value to the backup ID. Otherwise, this value is left empty.

              __image_size

              +

              __image_size

              String

              +

              String

              Specifies the size (bytes) of the image file. The value is greater than 0.

              +

              Specifies the size (bytes) of the image file. The value is greater than 0.

              __data_origin

              +

              __data_origin

              String

              +

              String

              Specifies the image source.

              +

              Specifies the image source.

              If the image is a public image, this parameter is left empty.

              __root_origin

              +

              __root_origin

              String

              +

              String

              Specifies that the image is created from an external image file. Value: file

              +

              Specifies that the image is created from an external image file. Value: file

              __lazyloading

              +

              __lazyloading

              String

              +

              String

              Specifies whether the image supports lazy loading. The value can be true, false, True, or False.

              +

              Specifies whether the image supports lazy loading. The value can be true, false, True, or False.

              active_at

              +

              active_at

              String

              +

              String

              Specifies the time when the image status became active.

              +

              Specifies the time when the image status became active.

              __os_feature_list

              +

              __os_feature_list

              String

              +

              String

              Specifies additional attributes of the image. The value is a list (in JSON format) of advanced features supported by the image.

              +

              Specifies additional attributes of the image. The value is a list (in JSON format) of advanced features supported by the image.

              __sequence_num

              +

              __sequence_num

              String

              +

              String

              This parameter is unavailable currently.

              +

              This parameter is unavailable currently.

              __support_kvm

              +

              __support_kvm

              String

              +

              String

              Specifies whether the image supports KVM. If yes, the value is true. Otherwise, this parameter is not required.

              +

              Specifies whether the image supports KVM. If yes, the value is true. Otherwise, this parameter is not required.

              __support_xen

              +

              __support_xen

              String

              +

              String

              Specifies whether the image supports Xen. If yes, the value is true. Otherwise, this parameter is not required.

              +

              Specifies whether the image supports Xen. If yes, the value is true. Otherwise, this parameter is not required.

              __support_largememory

              +

              __support_largememory

              String

              +

              String

              Specifies whether the image supports large-memory ECSs. If the image supports large-memory ECSs, the value is true. Otherwise, this parameter is not required.

              +

              Specifies whether the image supports large-memory ECSs. If the image supports large-memory ECSs, the value is true. Otherwise, this parameter is not required.

              For the supported OSs, see Table 4.

              __support_diskintensive

              +

              __support_diskintensive

              String

              +

              String

              Specifies whether the image supports disk-intensive ECSs. If the image supports disk-intensive ECSs, the value is true. Otherwise, this parameter is not required.

              +

              Specifies whether the image supports disk-intensive ECSs. If the image supports disk-intensive ECSs, the value is true. Otherwise, this parameter is not required.

              __support_highperformance

              +

              __support_highperformance

              String

              +

              String

              Specifies whether the image supports high-performance ECSs. If the image supports high-performance ECSs, the value is true. Otherwise, this parameter is not required.

              +

              Specifies whether the image supports high-performance ECSs. If the image supports high-performance ECSs, the value is true. Otherwise, this parameter is not required.

              __support_xen_gpu_type

              +

              __support_xen_gpu_type

              String

              +

              String

              Specifies whether the image supports GPU-accelerated ECSs on the Xen platform. See Table 2 for its value. If the image does not support GPU-accelerated ECSs on the Xen platform, this parameter is not required. This parameter cannot co-exist with __support_xen and __support_kvm.

              +

              Specifies whether the image supports GPU-accelerated ECSs on the Xen platform. See Table 2 for its value. If the image does not support GPU-accelerated ECSs on the Xen platform, this parameter is not required. This parameter cannot co-exist with __support_xen and __support_kvm.

              __support_kvm_gpu_type

              +

              __support_kvm_gpu_type

              String

              +

              String

              Specifies whether the image supports GPU-accelerated ECSs on the KVM platform. See Table 3 for its value.

              -

              If the image does not support GPU-accelerated ECSs on the KVM platform, this parameter is not required. This attribute cannot co-exist with __support_xen and __support_kvm.

              +

              Specifies whether the image supports GPU-accelerated ECSs on the KVM platform. See Table 3 for its value.

              +

              If the image does not support GPU-accelerated ECSs on the KVM platform, this parameter is not required. This attribute cannot co-exist with __support_xen and __support_kvm.

              __support_xen_hana

              +

              __support_xen_hana

              String

              +

              String

              Specifies whether the image supports HANA ECSs on the Xen platform. If yes, the value is true. Otherwise, this parameter is not required.

              -

              This attribute cannot co-exist with __support_xen and __support_kvm.

              +

              Specifies whether the image supports HANA ECSs on the Xen platform. If yes, the value is true. Otherwise, this parameter is not required.

              +

              This attribute cannot co-exist with __support_xen and __support_kvm.

              __support_kvm_infiniband

              +

              __support_kvm_infiniband

              String

              +

              String

              Specifies whether the image supports ECSs with the InfiniBand NIC on the KVM platform. If yes, the value is true. Otherwise, this parameter is not required.

              -

              This attribute cannot co-exist with __support_xen.

              +

              Specifies whether the image supports ECSs with InfiniBand NICs on the KVM platform. If yes, the value is true. Otherwise, this parameter is not required.

              +

              This attribute cannot co-exist with __support_xen.

              __support_fc_inject

              +

              __support_fc_inject

              String

              +

              String

              Specifies whether the image supports password/private key injection using Cloud-Init. The parameter value can be true or false.

              +

              Specifies whether the image supports password/private key injection using Cloud-Init. The parameter value can be true or false.

              If the value is set to true, password/private key injection using Cloud-Init is not supported.

              NOTE:

              This parameter is valid only for ECS system disk images.

              enterprise_project_id

              +

              enterprise_project_id

              String

              +

              String

              Specifies the enterprise project that the image belongs to.

              +

              Specifies the enterprise project that the image belongs to.

              • If the value is 0 or left blank, the image belongs to the default enterprise project.
              • If the value is a UUID, the image belongs to the enterprise project corresponding to the UUID.

                For more information about enterprise projects and how to obtain enterprise project IDs, see Enterprise Management User Guide.

              hw_firmware_type

              +

              hw_firmware_type

              String

              +

              String

              Specifies the ECS boot mode. Available values include:

              +

              Specifies the ECS boot mode. Available values include:

              • bios indicates the BIOS boot mode.
              • uefi indicates the UEFI boot mode.

              hw_vif_multiqueue_enabled

              +

              hw_vif_multiqueue_enabled

              String

              +

              String

              Specifies whether the image supports NIC multi-queue. The value can be true or false.

              +

              Specifies whether the image supports NIC multi-queue. The value can be true or false.

              __image_location

              +

              __image_location

              String

              +

              String

              Specifies the location where the image is stored.

              +

              Specifies the location where the image is stored.

              __is_config_init

              +

              __is_config_init

              String

              +

              String

              Specifies whether initial configuration is complete. The value can be true or false.

              +

              Specifies whether initial configuration is complete. The value can be true or false.

              __support_amd

              +

              __support_amd

              String

              +

              String

              Specifies whether the image uses AMD's x86 architecture. The value can be true or false.

              +

              Specifies whether the image uses AMD's x86 architecture. The value can be true or false.
            • Example response
              STATUS CODE 200
              -
               1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
-11
-12
-13
-14
-15
-16
-17
-18
-19
-20
-21
-22
-23
-24
-25
-26
-27
-28
-29
-30
              {
-      "schema": "/v2/schemas/image",
-      "min_disk": 100,
-      "created_at": "2018-09-06T14:03:27Z",
-      "__image_source_type": "uds",
-      "container_format": "bare",
-      "file": "/v2/images/bc6bed6e-ba3a-4447-afcc-449174a3eb52/file",
-      "updated_at": "2018-09-06T15:17:33Z",
-      "protected": true,
-      "checksum": "d41d8cd98f00b204e9800998ecf8427e",
-      "id": "bc6bed6e-ba3a-4447-afcc-449174a3eb52",
-      "__isregistered": "true",
-      "min_ram": 2048,
-      "__lazyloading": "true",
-      "owner": "1bed856811654c1cb661a6ca845ebc77",
-      "__os_type": "Linux",
-      "__imagetype": "gold",
-      "visibility": "public",
-      "virtual_env_type": "FusionCompute",
-      "tags": [],
-      "__platform": "CentOS",
-      "size": 0,
-      "__os_bit": "64",
-      "__os_version": "CentOS 7.3 64bit",
-      "name": "CentOS 7.3 64bit vivado",
-      "self": "/v2/images/bc6bed6e-ba3a-4447-afcc-449174a3eb52",
-      "disk_format": "zvhd2",
-      "virtual_size": null,
-      "status": "active"
+
               1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
+13
+14
+15
+16
+17
+18
+19
+20
+21
+22
+23
+24
+25
+26
+27
+28
+29
+30
              {
+      "schema": "/v2/schemas/image",
+      "min_disk": 100,
+      "created_at": "2018-09-06T14:03:27Z",
+      "__image_source_type": "uds",
+      "container_format": "bare",
+      "file": "/v2/images/bc6bed6e-ba3a-4447-afcc-449174a3eb52/file",
+      "updated_at": "2018-09-06T15:17:33Z",
+      "protected": true,
+      "checksum": "d41d8cd98f00b204e9800998ecf8427e",
+      "id": "bc6bed6e-ba3a-4447-afcc-449174a3eb52",
+      "__isregistered": "true",
+      "min_ram": 2048,
+      "__lazyloading": "true",
+      "owner": "1bed856811654c1cb661a6ca845ebc77",
+      "__os_type": "Linux",
+      "__imagetype": "gold",
+      "visibility": "public",
+      "virtual_env_type": "FusionCompute",
+      "tags": [],
+      "__platform": "CentOS",
+      "size": 0,
+      "__os_bit": "64",
+      "__os_version": "CentOS 7.3 64bit",
+      "name": "CentOS 7.3 64bit vivado",
+      "self": "/v2/images/bc6bed6e-ba3a-4447-afcc-449174a3eb52",
+      "disk_format": "zvhd2",
+      "virtual_size": null,
+      "status": "active"
 }
-
              
-
-
              + +

              • Returned Values

              • Normal

                200

              • Abnormal -

                Returned Value

                +
                - - - - - - - - - - - - - diff --git a/docs/ims/api-ref/en-us_topic_0020091567.html b/docs/ims/api-ref/en-us_topic_0020091567.html index ec045582a..578e03ce8 100644 --- a/docs/ims/api-ref/en-us_topic_0020091567.html +++ b/docs/ims/api-ref/en-us_topic_0020091567.html @@ -1,12 +1,12 @@

                Updating Image Information

                -

                Function

                This API is used to modify image attributes and update image information.

                -

                Only information of images in active status can be changed.

                +

                Function

                This API is used to update image information.

                +

                Only active images can be updated.

                URI

                PATCH /v2/cloudimages/{image_id}

                -

                Table 1 describes the parameters in the URI.

                +

                Table 1 lists the parameters in the URI.

                Returned Value

                Description

                +

                Description

                400 Bad Request

                +

                400 Bad Request

                Request error.

                +

                Request error.

                401 Unauthorized

                +

                401 Unauthorized

                Authentication failed.

                +

                Authentication failed.

                403 Forbidden

                +

                403 Forbidden

                You do not have the rights to perform the operation.

                +

                You do not have the rights to perform the operation.

                404 Not Found

                +

                404 Not Found

                The requested resource was not found.

                +

                The requested resource was not found.

                500 Internal Server Error

                +

                500 Internal Server Error

                Internal service error.

                +

                Internal service error.

                503 Service Unavailable

                +

                503 Service Unavailable

                The service is unavailable.

                +

                The service is unavailable.
                @@ -81,8 +81,8 @@ - @@ -98,551 +98,552 @@
                Table 1 Parameter description

                Parameter

                String

                Specifies the name of the attribute to be modified. / needs to be added in front of it.

                -

                You can modify the following attributes:

                +

                Specifies the name of the attribute to be updated. / needs to be added in front of it.

                +

                You can update the following attributes:

                • name: specifies the image name.
                • __description: specifies the image description.
                • __support_xen: Xen is supported.
                • __support_largememory: Ultra-large memory is supported.
                • __support_diskintensive: Intensive storage is supported.
                • __support_highperformance: High-performance computing (HPC) is supported.
                • __support_xen_gpu_type: GPU-accelerated ECSs that use Xen for virtualization are supported.
                • __support_kvm_gpu_type: GPU-accelerated ECSs that use KVM for virtualization are supported.
                • __support_xen_hana: HANA ECSs that use Xen for virtualization are supported.
                • __is_config_init: specifies whether initialization configuration is complete.
                • enterprise_project_id: specifies the enterprise project ID.
                • min_ram: specifies the minimum memory.
                • hw_vif_multiqueue_enabled: The NIC multi-queue feature is supported.
                • hw_firmware_type: specifies the boot mode. The value can be bios or uefi.

                You can add or delete extension attributes.

                -
                -
              • Example request
                PATCH https://{Endpoint}/v2/cloudimages/33ad552d-1149-471c-8190-ff6776174a00
                -
                1
-2
-3
-4
-5
-6
-7
                [
-    {
-        "op": "replace",
-        "path": "/name",
-        "value": "ims_test"
-    }
-]
-
                -
                • +

                Example Request

                Changing an image name to ims_test

                +
                1
+2
+3
+4
+5
+6
+7
+8
                PATCH https://{Endpoint}/v2/cloudimages/33ad552d-1149-471c-8190-ff6776174a00
+[
+    {
+        "op": "replace",
+        "path": "/name",
+        "value": "ims_test"
+    }
+]
+
                +
                +

                Response

                • Response parameters -

                  Parameter

                  +
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  file

                  +

                  file

                  String

                  +

                  String

                  Specifies the URL for uploading and downloading the image file.

                  +

                  Specifies the URL for uploading and downloading the image file.

                  owner

                  +

                  owner

                  String

                  +

                  String

                  Specifies the tenant to which the image belongs.

                  +

                  Specifies the tenant to which the image belongs.

                  id

                  +

                  id

                  String

                  +

                  String

                  Specifies the image ID.

                  +

                  Specifies the image ID.

                  size

                  +

                  size

                  Long

                  +

                  Long

                  This parameter is unavailable currently.

                  +

                  This parameter is unavailable currently.

                  self

                  +

                  self

                  String

                  +

                  String

                  Specifies the image URL.

                  +

                  Specifies the image URL.

                  schema

                  +

                  schema

                  String

                  +

                  String

                  Specifies the image schema.

                  +

                  Specifies the image schema.

                  status

                  +

                  status

                  String

                  +

                  String

                  Specifies the image status. The value can be one of the following:

                  +

                  Specifies the image status. The value can be one of the following:

                  • queued: indicates that the image metadata has already been created, and it is ready for the image file to upload.
                  • saving: indicates that the image file is being uploaded to the backend storage.
                  • deleted: indicates that the image has been deleted.
                  • killed: indicates that an error occurs on the image uploading.
                  • active: indicates that the image is available for use.

                  tags

                  +

                  tags

                  Array of strings

                  +

                  Array of strings

                  Specifies tags of the image, through which you can manage private images in your own way. You can use the image tag API to add different tags to each image and filter images by tag.

                  +

                  Specifies tags of the image, through which you can manage private images in your own way. You can use the image tag API to add different tags to each image and filter images by tag.

                  visibility

                  +

                  visibility

                  String

                  +

                  String

                  Specifies whether the image is available to other tenants. The value can be one of the following:

                  +

                  Specifies whether the image is available to other tenants. The value can be one of the following:

                  • private: private image
                  • public: public image
                  • shared: shared image

                  name

                  +

                  name

                  String

                  +

                  String

                  Specifies the image name. For detailed description, see Image Attributes.

                  +

                  Specifies the image name. For detailed description, see Image Attributes.

                  checksum

                  +

                  checksum

                  String

                  +

                  String

                  This parameter is unavailable currently.

                  +

                  This parameter is unavailable currently.

                  protected

                  +

                  protected

                  Boolean

                  +

                  Boolean

                  Specifies whether the image is protected. A protected image cannot be deleted. The value can be true or false.

                  +

                  Specifies whether the image is protected. A protected image cannot be deleted. The value can be true or false.

                  container_format

                  +

                  container_format

                  String

                  +

                  String

                  Specifies the container type.

                  +

                  Specifies the container type.

                  min_ram

                  +

                  min_ram

                  Integer

                  +

                  Integer

                  Specifies the minimum memory size (MB) required for running the image. The parameter value depends on the ECS specifications. The default value is 0.

                  +

                  Specifies the minimum memory size (MB) required for running the image. The parameter value depends on the ECS specifications. The default value is 0.

                  max_ram

                  +

                  max_ram

                  String

                  +

                  String

                  Specifies the maximum memory (MB) of the image. The parameter value depends on the ECS specifications and is not configured by default.

                  +

                  Specifies the maximum memory (MB) of the image. The parameter value depends on the ECS specifications and is not configured by default.

                  updated_at

                  +

                  updated_at

                  String

                  +

                  String

                  Specifies the time when the image was updated. The value is in UTC format.

                  +

                  Specifies the time when the image was updated. The value is in UTC format.

                  __os_bit

                  +

                  __os_bit

                  String

                  +

                  String

                  Specifies the OS architecture, 32 bit or 64 bit.

                  +

                  Specifies the OS architecture, 32 bit or 64 bit.

                  __os_version

                  +

                  __os_version

                  String

                  +

                  String

                  Specifies the OS version.

                  +

                  Specifies the OS version.

                  __description

                  +

                  __description

                  String

                  +

                  String

                  Provides supplementary information about the image. For detailed description, see Image Attributes.

                  +

                  Provides supplementary information about the image. For detailed description, see Image Attributes.

                  disk_format

                  +

                  disk_format

                  String

                  +

                  String

                  Specifies the image format. The value can be zvhd2, vhd, zvhd, raw, or qcow2. The default value is zvhd2.

                  +

                  Specifies the image format. The value can be zvhd2, vhd, zvhd, raw, or qcow2. The default value is zvhd2.

                  __isregistered

                  +

                  __isregistered

                  String

                  +

                  String

                  Specifies whether the image has been registered. The value can be true or false.

                  +

                  Specifies whether the image has been registered. The value can be true or false.

                  __platform

                  +

                  __platform

                  String

                  +

                  String

                  Specifies the image platform type. The value can be Windows, Ubuntu, Red Hat, SUSE, CentOS, Debian, OpenSUSE, Oracle Linux, Fedora, Other, CoreOS, or EulerOS.

                  +

                  Specifies the image platform type. The value can be Windows, Ubuntu, Red Hat, SUSE, CentOS, Debian, OpenSUSE, Oracle Linux, Fedora, Other, CoreOS, or EulerOS.

                  __os_type

                  +

                  __os_type

                  String

                  +

                  String

                  Specifies the OS type. The value can be Linux, Windows, or Other.

                  +

                  Specifies the OS type. The value can be Linux, Windows, or Other.

                  __system__cmkid

                  +

                  __system__cmkid

                  String

                  +

                  String

                  Specifies the ID of the key used to encrypt the image.

                  +

                  Specifies the ID of the key used to encrypt the image.

                  min_disk

                  +

                  min_disk

                  Integer

                  +

                  Integer

                  Specifies the minimum disk space (GB) required for running the image. The value ranges from 1 GB to 1024 GB.

                  +

                  Specifies the minimum disk space (GB) required for running the image. The value ranges from 1 GB to 1,024 GB.

                  virtual_env_type

                  +

                  virtual_env_type

                  String

                  +

                  String

                  Specifies the environment where the image is used. The value can be FusionCompute, Ironic, DataImage, or IsoImage.

                  -
                  • For an ECS image (system disk image), the value is FusionCompute.
                  • For a data disk image, the value is DataImage.
                  • For a BMS image, the value is Ironic.
                  • For an ISO image, the value is IsoImage.
                  +

                  Specifies the environment where the image is used. The value can be FusionCompute, Ironic, DataImage, or IsoImage.

                  +
                  • For an ECS image (system disk image), the value is FusionCompute.
                  • For a data disk image, the value is DataImage.
                  • For a BMS image, the value is Ironic.
                  • For an ISO image, the value is IsoImage.

                  __image_source_type

                  +

                  __image_source_type

                  String

                  +

                  String

                  Specifies the backend storage of the image. Only UDS is supported currently.

                  +

                  Specifies the backend storage of the image. Only UDS is supported currently.

                  __imagetype

                  +

                  __imagetype

                  String

                  +

                  String

                  Specifies the image type. The following types are supported:

                  +

                  Specifies the image type. The following types are supported:

                  • Public image: The value is gold.
                  • Private image: The value is private.
                  • Shared image: The value is shared.

                  created_at

                  +

                  created_at

                  String

                  +

                  String

                  Specifies the time when the image was created. The value is in UTC format.

                  +

                  Specifies the time when the image was created. The value is in UTC format.

                  virtual_size

                  +

                  virtual_size

                  Integer

                  +

                  Integer

                  This parameter is unavailable currently.

                  +

                  This parameter is unavailable currently.

                  __originalimagename

                  +

                  __originalimagename

                  String

                  +

                  String

                  Specifies the parent image ID.

                  +

                  Specifies the parent image ID.

                  If the image is a public image or created from an image file, this value is left empty.

                  __backup_id

                  +

                  __backup_id

                  String

                  +

                  String

                  Specifies the backup ID. If the image is created from a backup, set the value to the backup ID. Otherwise, this parameter is not required.

                  +

                  Specifies the backup ID. If the image is created from a backup, set the value to the backup ID. Otherwise, this parameter is not required.

                  __image_size

                  +

                  __image_size

                  String

                  +

                  String

                  Specifies the size (bytes) of the image file. The value must be greater than 0.

                  +

                  Specifies the size (bytes) of the image file. The value must be greater than 0.

                  __data_origin

                  +

                  __data_origin

                  String

                  +

                  String

                  Specifies the image source.

                  +

                  Specifies the image source.

                  If the image is a public image, this parameter is left empty.

                  __root_origin

                  +

                  __root_origin

                  String

                  +

                  String

                  Specifies that the image is created from an external image file. Value: file

                  +

                  Specifies that the image is created from an external image file. Value: file

                  __lazyloading

                  +

                  __lazyloading

                  String

                  +

                  String

                  Specifies whether the image supports lazy loading. The value can be true, false, True, or False.

                  +

                  Specifies whether the image supports lazy loading. The value can be true, false, True, or False.

                  active_at

                  +

                  active_at

                  String

                  +

                  String

                  Specifies the time when the image status became active.

                  +

                  Specifies the time when the image status became active.

                  __os_feature_list

                  +

                  __os_feature_list

                  String

                  +

                  String

                  Specifies additional attributes of the image. The value is a list (in JSON format) of advanced features supported by the image.

                  +

                  Specifies additional attributes of the image. The value is a list (in JSON format) of advanced features supported by the image.

                  __account_code

                  +

                  __account_code

                  String

                  +

                  String

                  Specifies the charging identifier for the image.

                  +

                  Specifies the charging identifier for the image.

                  hw_firmware_type

                  +

                  hw_firmware_type

                  String

                  +

                  String

                  Specifies the ECS boot mode. The following values are supported:

                  +

                  Specifies the ECS boot mode. The following values are supported:

                  • bios indicates the BIOS boot mode. This value will be used by fault if this parameter does not exist in the response.
                  • uefi indicates the UEFI boot mode.

                  hw_vif_multiqueue_enabled

                  +

                  hw_vif_multiqueue_enabled

                  String

                  +

                  String

                  Specifies whether the image supports NIC multi-queue. The value can be true or false.

                  +

                  Specifies whether the image supports NIC multi-queue. The value can be true or false.

                  __support_kvm

                  +

                  __support_kvm

                  String

                  +

                  String

                  Specifies whether the image supports KVM. If yes, the value is true. Otherwise, this parameter is not required.

                  +

                  Specifies whether the image supports KVM. If yes, the value is true. Otherwise, this parameter is not required.

                  __support_xen

                  +

                  __support_xen

                  String

                  +

                  String

                  Specifies whether the image supports Xen. If yes, the value is true. Otherwise, this parameter is not required.

                  +

                  Specifies whether the image supports Xen. If yes, the value is true. Otherwise, this parameter is not required.

                  __support_largememory

                  +

                  __support_largememory

                  String

                  +

                  String

                  Specifies whether the image can be used to create large-memory ECSs. If the image supports large-memory ECSs, the value is true. Otherwise, this parameter is not required.

                  +

                  Specifies whether the image can be used to create large-memory ECSs. If the image supports large-memory ECSs, the value is true. Otherwise, this parameter is not required.

                  For the supported OSs, see Table 4.

                  __support_diskintensive

                  +

                  __support_diskintensive

                  String

                  +

                  String

                  Specifies whether the image can be used to create disk-intensive ECSs. If the image supports disk-intensive ECSs, the value is true. Otherwise, this parameter is not required.

                  +

                  Specifies whether the image can be used to create disk-intensive ECSs. If the image supports disk-intensive ECSs, the value is true. Otherwise, this parameter is not required.

                  __support_highperformance

                  +

                  __support_highperformance

                  String

                  +

                  String

                  Specifies whether the image can be used to create high-performance ECSs. If the image supports high-performance ECSs, the value is true. Otherwise, this parameter is not required.

                  +

                  Specifies whether the image can be used to create high-performance ECSs. If the image supports high-performance ECSs, the value is true. Otherwise, this parameter is not required.

                  __support_xen_gpu_type

                  +

                  __support_xen_gpu_type

                  String

                  +

                  String

                  Specifies whether the image supports GPU-accelerated ECSs on the Xen platform. See Table 2 for its value. If the image does not support GPU-accelerated ECSs on the Xen platform, this parameter is not required. This attribute cannot co-exist with __support_xen and __support_kvm.

                  +

                  Specifies whether the image supports GPU-accelerated ECSs on the Xen platform. See Table 2 for its value. If the image does not support GPU-accelerated ECSs on the Xen platform, this parameter is not required. This attribute cannot co-exist with __support_xen and __support_kvm.

                  __support_kvm_gpu_type

                  +

                  __support_kvm_gpu_type

                  String

                  +

                  String

                  Specifies whether the image supports GPU-accelerated ECSs on the KVM platform. See Table 3 for its value.

                  -

                  If the image does not support GPU-accelerated ECSs on the KVM platform, this parameter is not required. This attribute cannot co-exist with __support_xen and __support_kvm.

                  +

                  Specifies whether the image supports GPU-accelerated ECSs on the KVM platform. See Table 3 for its value.

                  +

                  If the image does not support GPU-accelerated ECSs on the KVM platform, this parameter is not required. This attribute cannot co-exist with __support_xen and __support_kvm.

                  __support_xen_hana

                  +

                  __support_xen_hana

                  String

                  +

                  String

                  Specifies whether the image supports HANA ECSs on the Xen platform. If yes, the value is true. Otherwise, this parameter is not required.

                  -

                  This attribute cannot co-exist with __support_xen and __support_kvm.

                  +

                  Specifies whether the image supports HANA ECSs on the Xen platform. If yes, the value is true. Otherwise, this parameter is not required.

                  +

                  This attribute cannot co-exist with __support_xen and __support_kvm.

                  __support_kvm_infiniband

                  +

                  __support_kvm_infiniband

                  String

                  +

                  String

                  Specifies whether the image supports ECSs with the InfiniBand NIC on the KVM platform. If yes, the value is true. Otherwise, this parameter is not required.

                  -

                  This attribute cannot co-exist with __support_xen.

                  +

                  Specifies whether the image supports ECSs with InfiniBand NICs on the KVM platform. If yes, the value is true. Otherwise, this parameter is not required.

                  +

                  This attribute cannot co-exist with __support_xen.

                  enterprise_project_id

                  +

                  enterprise_project_id

                  String

                  +

                  String

                  Specifies the enterprise project that the image belongs to.

                  +

                  Specifies the enterprise project that the image belongs to.

                  • If the value is 0 or left blank, the image belongs to the default enterprise project.
                  • If the value is a UUID, the image belongs to the enterprise project corresponding to the UUID.

                    For more information about enterprise projects, see Enterprise Management User Guide.

                  __sequence_num

                  +

                  __sequence_num

                  String

                  +

                  String

                  Specifies the ECS system disk slot number corresponding to the image.

                  +

                  Specifies the ECS system disk slot number of the image.

                  This parameter is unavailable currently.

                  __support_fc_inject

                  +

                  __support_fc_inject

                  String

                  +

                  String

                  Specifies whether the image supports password/private key injection using Cloud-Init.

                  +

                  Specifies whether the image supports password/private key injection using Cloud-Init.

                  If the value is set to true, password/private key injection using Cloud-Init is not supported.

                  NOTE:

                  This parameter is valid only for ECS system disk images.

                  __support_amd

                  +

                  __support_amd

                  String

                  +

                  String

                  Specifies whether the image uses AMD's x86 architecture. The value can be true or false.

                  +

                  Specifies whether the image uses AMD's x86 architecture. The value can be true or false.
                • Example response
                  STATUS CODE 200
                  -
                   1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
-11
-12
-13
-14
-15
-16
-17
-18
-19
-20
-21
-22
-23
-24
-25
-26
-27
-28
-29
-30
-31
-32
-33
-34
-35
-36
-37
-38
                  {
-    "file": "/v2/images/33ad552d-1149-471c-8190-ff6776174a00/file",
-    "owner": "0b1e494e2660441a957313163095fe5c",
-    "id": "33ad552d-1149-471c-8190-ff6776174a00",
-    "size": 2,
-    "self": "/v2/images/33ad552d-1149-471c-8190-ff6776174a00",
-    "schema": "/v2/schemas/image",
-    "status": "active",
-    "tags": [],
-    "visibility": "private",
-    "name": "ims_test",
-    "checksum": "99914b932bd37a50b983c5e7c90ae93b",
-    "hw_vif_multiqueue_enabled": "true",
-    "protected": false,
-    "container_format": "bare",
-    "min_ram": 0,
-    "updated_at": "2015-12-08T02:30:49Z",
-    "__os_bit": "64",
-    "__os_version": "Ubuntu 14.04 server 64bit",
-    "__description": "ims test",
-    "disk_format": "vhd",
-    "__isregistered": "true",
-    "__platform": "Ubuntu",
-    "__os_type": "Linux",
-    "min_disk": 40,
-    "virtual_env_type": "FusionCompute",
-    "__image_source_type": "uds",
-    "__imagetype": "private",
-    "created_at": "2015-12-04T09:45:33Z",
-    "virtual_size": 0,
-    "__originalimagename": "33ad552d-1149-471c-8190-ff6776174a00",
-    "__backup_id": "",
-    "__productcode": "",
-    "__image_size": "449261568",
-    "__support_fc_inject":"true",
-    "__data_origin": null,
-    "hw_firmware_type": "bios"
+
                   1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
+13
+14
+15
+16
+17
+18
+19
+20
+21
+22
+23
+24
+25
+26
+27
+28
+29
+30
+31
+32
+33
+34
+35
+36
+37
+38
                  {
+    "file": "/v2/images/33ad552d-1149-471c-8190-ff6776174a00/file",
+    "owner": "0b1e494e2660441a957313163095fe5c",
+    "id": "33ad552d-1149-471c-8190-ff6776174a00",
+    "size": 2,
+    "self": "/v2/images/33ad552d-1149-471c-8190-ff6776174a00",
+    "schema": "/v2/schemas/image",
+    "status": "active",
+    "tags": [],
+    "visibility": "private",
+    "name": "ims_test",
+    "checksum": "99914b932bd37a50b983c5e7c90ae93b",
+    "hw_vif_multiqueue_enabled": "true",
+    "protected": false,
+    "container_format": "bare",
+    "min_ram": 0,
+    "updated_at": "2015-12-08T02:30:49Z",
+    "__os_bit": "64",
+    "__os_version": "Ubuntu 14.04 server 64bit",
+    "__description": "ims test",
+    "disk_format": "vhd",
+    "__isregistered": "true",
+    "__platform": "Ubuntu",
+    "__os_type": "Linux",
+    "min_disk": 40,
+    "virtual_env_type": "FusionCompute",
+    "__image_source_type": "uds",
+    "__imagetype": "private",
+    "created_at": "2015-12-04T09:45:33Z",
+    "virtual_size": 0,
+    "__originalimagename": "33ad552d-1149-471c-8190-ff6776174a00",
+    "__backup_id": "",
+    "__productcode": "",
+    "__image_size": "449261568",
+    "__support_fc_inject":"true",
+    "__data_origin": null,
+    "hw_firmware_type": "bios"
 }
-
                  
-
-
                  + +

                  • Returned Values

                  • Normal

                    200

                  • Abnormal -

                    Returned Value

                    +
                    - - - - - - - - - - - - - diff --git a/docs/ims/api-ref/en-us_topic_0020092108.html b/docs/ims/api-ref/en-us_topic_0020092108.html index 132d28fae..ef6d91cb3 100644 --- a/docs/ims/api-ref/en-us_topic_0020092108.html +++ b/docs/ims/api-ref/en-us_topic_0020092108.html @@ -29,40 +29,42 @@ -

                    Request

                    • Request parameters -

                    Returned Value

                    Description

                    +

                    Description

                    400 Bad Request

                    +

                    400 Bad Request

                    Request error. For details about the returned error code, see Error Codes.

                    +

                    Request error. For details about the returned error code, see Error Codes.

                    401 Unauthorized

                    +

                    401 Unauthorized

                    Authentication failed.

                    +

                    Authentication failed.

                    403 Forbidden

                    +

                    403 Forbidden

                    You do not have the rights to perform the operation.

                    +

                    You do not have the rights to perform the operation.

                    404 Not Found

                    +

                    404 Not Found

                    The requested resource was not found.

                    +

                    The requested resource was not found.

                    500 Internal Server Error

                    +

                    500 Internal Server Error

                    Internal service error.

                    +

                    Internal service error.

                    503 Service Unavailable

                    +

                    503 Service Unavailable

                    The service is unavailable.

                    +

                    The service is unavailable.

                    Parameter

                    +

                    Request

                    Request parameters +
                    - - - - - - -

                    Parameter

                    Mandatory

                    +

                    Mandatory

                    Type

                    +

                    Type

                    Description

                    +

                    Description

                    delete_backup

                    +

                    delete_backup

                    No

                    +

                    No

                    Boolean

                    +

                    Boolean

                    Specifies whether to delete the CSBS backups or CBR backups associated with a full-ECS image when the image is deleted. The value can be true or false.

                    +

                    Specifies whether to delete the CSBS backups or CBR backups associated with a full-ECS image when the image is deleted. The value can be true or false.

                    • true: When a full-ECS image is deleted, its CSBS backups or CBR backups are also deleted.
                    • false: When a full-ECS image is deleted, its CSBS backups or CBR backups are not deleted.
                    -
                  • Example request
                    DELETE https://{Endpoint}/v2/images/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90
                    -
                    1
-2
-3
                    {
-    "delete_backup": true
-}
-
                    -
                    -
                    • +
                    +

                    Example Request

                    Deleting an image

                    +
                    1
+2
+3
+4
                    DELETE https://{Endpoint}/v2/images/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90
+{
+    "delete_backup": true
+}
+
                    +

                    Response

                    • Response parameters

                      None

                    • Example response
                      STATUS CODE 204
                      @@ -70,40 +72,40 @@

                    Returned Values

                    • Normal

                      204

                    • Abnormal -

                      Returned Value

                      +
                      - - - - - - - - - - - - - diff --git a/docs/ims/api-ref/en-us_topic_0020092109.html b/docs/ims/api-ref/en-us_topic_0020092109.html index 31193fcca..daf528fc2 100644 --- a/docs/ims/api-ref/en-us_topic_0020092109.html +++ b/docs/ims/api-ref/en-us_topic_0020092109.html @@ -3,10 +3,10 @@

                      Creating an Image

                      Function

                      This API is used to create a private image. The following methods are supported:

                      • Create a system or data disk image from an ECS.
                      • Create a system disk image from an external image file uploaded to an OBS bucket.
                      • Create a system disk image from a data disk.
                      -

                      The API is an asynchronous one. If it is successfully called, the cloud service system receives the request. However, you need to use the asynchronous job query API to query the image creation status. For details, see Asynchronous Job Query.

                      +

                      The API is an asynchronous one. If it is successfully called, the cloud service system receives the request. However, you need to use the asynchronous job query API to query the image creation status. For details, see Querying the Status of an Asynchronous Job.

                      You cannot export public images (such as Windows, SUSE, Red Hat, Oracle Linux, and Ubuntu) or private images created using these public images.

                      -

                      Constraints (Creating a System Disk Image Using a Data Disk)

                      • Before using a data disk to create a system disk image, ensure that an OS has been installed on the data disk and has been optimized. For details about the optimization, see "Optimizing a Windows Private Image" and "Optimizing a Linux Private Image" in the Image Management Service User Guide.
                      • The system cannot verify that an OS has been installed on the data disk. Therefore, ensure that the value of os_version is valid when creating a system disk image from the data disk. For details, see Values of Related Parameters.
                      +

                      Constraints (Creating a System Disk Image Using a Data Disk)

                      • Before using a data disk to create a system disk image, ensure that an OS has been installed on the data disk and has been optimized. For details about the optimization, see "Optimizing a Windows Private Image" and "Optimizing a Linux Private Image" in the Image Management Service User Guide.
                      • The system cannot verify that an OS has been installed on the data disk. Therefore, ensure that the value of os_version is valid when creating a system disk image from the data disk. For details, see Values of Related Parameters.

                      URI

                      POST /v2/cloudimages/action

                      @@ -36,7 +36,7 @@
                      - - @@ -78,8 +78,8 @@ - - - - @@ -279,7 +279,7 @@ - @@ -319,7 +319,7 @@ - - @@ -426,9 +426,9 @@ - - @@ -536,7 +536,7 @@

                      Returned Value

                      Description

                      +

                      Description

                      400 Bad Request

                      +

                      400 Bad Request

                      Request error.

                      +

                      Request error.

                      401 Unauthorized

                      +

                      401 Unauthorized

                      Authentication failed.

                      +

                      Authentication failed.

                      403 Forbidden

                      +

                      403 Forbidden

                      You do not have the rights to perform the operation.

                      +

                      You do not have the rights to perform the operation.

                      404 Not Found

                      +

                      404 Not Found

                      The requested resource was not found.

                      +

                      The requested resource was not found.

                      500 Internal Server Error

                      +

                      500 Internal Server Error

                      Internal service error.

                      +

                      Internal service error.

                      503 Service Unavailable

                      +

                      503 Service Unavailable

                      The service is unavailable.

                      +

                      The service is unavailable.

                      String

                      Specifies the image description. For details, see Image Attributes. The value contains a maximum of 1024 characters and consists of only letters and digits. Carriage returns and angle brackets (< >) are not allowed. This parameter is left blank by default.

                      +

                      Provides supplementary information about the image. For details, see Image Attributes. The value contains a maximum of 1024 characters and consists of only letters and digits. Carriage returns and angle brackets (< >) are not allowed. This parameter is left blank by default.

                      instance_id

                      @@ -68,7 +68,7 @@

                      Array of strings

                      Specifies tags of the image. This parameter is left blank by default.

                      +

                      Lists the image tags. This parameter is left blank by default.

                      Use either tags or image_tags.

                      Array of objects

                      Specifies tags of the image. This parameter is left blank by default.

                      -

                      Use either tags or image_tags.

                      +

                      Lists the image tags. This parameter is left blank by default.

                      +

                      Use either tags or image_tags.

                      enterprise_project_id

                      @@ -190,7 +190,7 @@

                      String

                      Specifies the image description. For detailed description, see Image Attributes. The value contains a maximum of 1024 characters and consists of only letters and digits. Carriage returns and angle brackets (< >) are not allowed. This parameter is left blank by default.

                      +

                      Provides supplementary information about the image. For detailed description, see Image Attributes. The value contains a maximum of 1024 characters and consists of only letters and digits. Carriage returns and angle brackets (< >) are not allowed. This parameter is left blank by default.

                      os_type

                      @@ -239,7 +239,7 @@

                      Integer

                      Specifies the minimum size of the system disk in the unit of GB.

                      -

                      This parameter is mandatory if an external image file in the OBS bucket is used to create an image. The value ranges from 1 GB to 1024 GB.

                      +

                      This parameter is mandatory if an external image file in the OBS bucket is used to create an image. The value ranges from 1 GB to 1,024 GB.

                      is_config

                      @@ -260,7 +260,7 @@

                      String

                      Specifies the master key used for encrypting an image. For its value, see the Key Management Service User Guide.

                      +

                      Specifies a custom key used for encrypting an image. For its value, see the Key Management Service User Guide.

                      tags

                      @@ -269,7 +269,7 @@

                      Array of strings

                      Specifies tags of the image. The value is left blank by default.

                      +

                      Lists the image tags. This parameter is left blank by default.

                      Use either tags or image_tags.

                      Array of objects

                      Specifies tags of the image. This parameter is left blank by default. Use either tags or image_tags.

                      +

                      Lists the image tags. This parameter is left blank by default. Use either tags or image_tags.

                      type

                      @@ -300,7 +300,7 @@

                      String

                      Specifies the enterprise project that the image belongs to.

                      -
                      • If the value is 0 or left blank, the image belongs to the default enterprise project.
                      • If the value is a UUID, the image belongs to the enterprise project corresponding to the UUID.

                        For more information about enterprise projects and how to obtain enterprise project IDs, see Enterprise Management User Guide.

                        +
                        • If the value is 0 or left blank, the image belongs to the default enterprise project.
                        • If the value is a UUID, the image belongs to the enterprise project corresponding to the UUID.

                          For more information about enterprise projects and how to obtain enterprise project IDs, see Enterprise Management User Guide.

                      Integer

                      Specifies the minimum memory required by the image in the unit of MB. The default value is 0, indicating that the memory is not restricted.

                      +

                      Specifies the minimum memory required by the image in the unit of MB. The default value is 0, indicating that the memory is not restricted.

                      data_images

                      @@ -376,7 +376,7 @@

                      String

                      Specifies the image description. The value is left blank by default.

                      +

                      Provides supplementary information about the image. This parameter is left blank by default.

                      The value contains a maximum of 1024 characters and consists of only letters and digits. Carriage returns and angle brackets (< >) are not allowed.

                      For more details, see Image Attributes.

                      Array of strings

                      Specifies tags of the image. The value is left blank by default.

                      +

                      Lists the image tags. This parameter is left blank by default.

                      For detailed parameter descriptions, see Image Tag Data Formats.

                      -

                      Use either tags or image_tags.

                      +

                      Use either tags or image_tags.

                      image_tags

                      @@ -437,7 +437,7 @@

                      Array of objects

                      Specifies tags of the image. The value is left blank by default.

                      +

                      Lists the image tags. This parameter is left blank by default.

                      For detailed parameter descriptions, see Image Tag Data Formats.

                      Use either tags or image_tags.

                      Array of strings

                      Specifies tags of the image. This parameter is left blank by default.

                      -

                      Use either tags or image_tags.

                      +

                      Use either tags or image_tags.

                      image_tags

                      @@ -546,7 +546,7 @@

                      Array of objects

                      Specifies tags of the image. This parameter is left blank by default.

                      -

                      Use either tags or image_tags.

                      +

                      Use either tags or image_tags.

                      enterprise_project_id

                      @@ -556,15 +556,17 @@

                      String

                      Specifies the enterprise project that the image belongs to.

                      -
                      • If the value is 0 or left blank, the image belongs to the default enterprise project.
                      • If the value is a UUID, the image belongs to the enterprise project corresponding to the UUID.

                        For more information about enterprise projects and how to obtain enterprise project IDs, see Enterprise Management User Guide.

                        +
                        • If the value is 0 or left blank, the image belongs to the default enterprise project.
                        • If the value is a UUID, the image belongs to the enterprise project corresponding to the UUID.

                          For more information about enterprise projects and how to obtain enterprise project IDs, see Enterprise Management User Guide.
                      -
                    • Example requests
                      • Request for creating a system disk image with parameter tags using an ECS
                        POST https://{Endpoint}/v2/cloudimages/action
                        -
                        {
+
                      + +

                      Example Request

                      • Creating a system disk image with parameter tags using an ECS (ID: 877a2cda-ba63-4e1e-b95f-e67e48b6129a)
                        POST https://{Endpoint}/v2/cloudimages/action
+{
     "name": "ims_test",
        "description": "Create a system disk image from an ECS",
     "instance_id": "877a2cda-ba63-4e1e-b95f-e67e48b6129a",
@@ -574,61 +576,61 @@
         "ccc.444"
          ]
 }
                        -
                      • Request for creating a data disk image with parameter tags using the data disk of an ECS
                        POST https://{Endpoint}/v2/cloudimages/action
                        -
                         1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
-11
                        {
-       "data_images": [{"name": "ims_data_image_test",
-       "description": "Create a data disk image from the data disk of an ECS",
-       "volume_id": "c5dfbd0c-bf0a-4798-a453-61dc6b54aa30",
-       "tags": [
-                  "aaa.111",
-                  "bbb.333",
-                  "ccc.444"
-              ]
-       }]
+
                      • Creating a data disk image with parameter tags using a data disk (ID: c5dfbd0c-bf0a-4798-a453-61dc6b54aa30) of an ECS
                         1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
                        POST https://{Endpoint}/v2/cloudimages/action
+{
+       "data_images": [{"name": "ims_data_image_test",
+       "description": "Create a data disk image from the data disk of an ECS",
+       "volume_id": "c5dfbd0c-bf0a-4798-a453-61dc6b54aa30",
+       "tags": [
+                  "aaa.111",
+                  "bbb.333",
+                  "ccc.444"
+              ]
+       }]
 }
-
                        
-
-
                        • -
                      • Request for creating an image with parameter tags using an external image file uploaded to the OBS bucket
                        POST https://{Endpoint}/v2/cloudimages/action
                        -
                         1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
-11
-12
                        {
-      "name": "ims_test_file",
-  "description": "Create an image from a file in the OBS bucket",
-      "image_url": "ims-image:centos70.qcow2",
-      "os_version": "CentOS 7.0 64bit",
-      "min_disk": 40,
-      "tags": [  
-            "aaa.111",  
-            "bbb.333",  
-            "ccc.444"  
-      ]     
+
                        +
                        +
                      • Creating an image with parameter tags using a file in an OBS bucket (file address in the bucket: ims-image:centos70.qcow2)
                         1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
+13
                        POST https://{Endpoint}/v2/cloudimages/action
+{
+      "name": "ims_test_file",
+  "description": "Create an image from a file in an OBS bucket",
+      "image_url": "ims-image:centos70.qcow2",
+      "os_version": "CentOS 7.0 64bit",
+      "min_disk": 40,
+      "tags": [  
+            "aaa.111",  
+            "bbb.333",  
+            "ccc.444"  
+      ]     
 }
-
                        - - + +
                      -
                      • Request for creating a system disk image with parameter image_tags using an ECS
                        POST https://{Endpoint}/v2/cloudimages/action
                        -
                        {
+
                        • Creating a system disk image with parameter image_tags using an ECS (ID: 877a2cda-ba63-4e1e-b95f-e67e48b6129a)
                          POST https://{Endpoint}/v2/cloudimages/action
+{
     "name": "ims_test",
     "description": "Create a system disk image from an ECS",
     "instance_id": "877a2cda-ba63-4e1e-b95f-e67e48b6129a",
@@ -643,158 +645,156 @@
 }
          ]
 }
                          
-
                        • Request for creating a data disk image with parameter image_tags using the data disk of an ECS
                          POST /v2/cloudimages/action
                          
-
                          1
-2
-3
-4
-5
-6
-7
                          {
-       "data_images": [{"name": "ims_data_image_test",
-       "description": "Create a data disk image from the data disk of an ECS",
-       "volume_id": "c5dfbd0c-bf0a-4798-a453-61dc6b54aa30",
-       "image_tags": [{"key":"key2","value":"value2"},{"key":"key1","value":"value1"}]
-       }]
+
                        • Creating a data disk image with parameter image_tags using a data disk (ID: c5dfbd0c-bf0a-4798-a453-61dc6b54aa30) of an ECS
                          1
+2
+3
+4
+5
+6
+7
+8
                          POST /v2/cloudimages/action
+{
+       "data_images": [{"name": "ims_data_image_test",
+       "description": "Create a data disk image from the data disk of an ECS",
+       "volume_id": "c5dfbd0c-bf0a-4798-a453-61dc6b54aa30",
+       "image_tags": [{"key":"key2","value":"value2"},{"key":"key1","value":"value1"}]
+       }]
 }
-
                          
-
-
                          • 
-
                        • Request for creating an image with parameter image_tags using an external image file uploaded to the OBS bucket
                          POST https://{Endpoint}/v2/cloudimages/action
                          
-
                          1
-2
-3
-4
-5
-6
-7
-8
                          {
-       "name": "ims_test_file",
-       "description": "Create an image from a file in the OBS bucket",
-       "image_url": "ims-image:centos70.qcow2",
-       "os_version": "CentOS 7.0 64bit",
-       "min_disk": 40,
-       "image_tags": [{"key":"key2","value":"value2"},{"key":"key1","value":"value1"}]    
+
                          
+
                          
+
                        • Creating an image with parameter image_tags using a file in an OBS bucket (file address in the bucket: ims-image:centos70.qcow2)
                          1
+2
+3
+4
+5
+6
+7
+8
+9
                          POST https://{Endpoint}/v2/cloudimages/action
+{
+       "name": "ims_test_file",
+       "description": "Create an image from a file in an OBS bucket",
+       "image_url": "ims-image:centos70.qcow2",
+       "os_version": "CentOS 7.0 64bit",
+       "min_disk": 40,
+       "image_tags": [{"key":"key2","value":"value2"},{"key":"key1","value":"value1"}]    
 }
-
                          
-
-
-
                        • Request for creating a system disk image with parameter tags using a data disk
                          POST https://{Endpoint}/v2/cloudimages/action
                          
-
                           1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
-11
-12
                          {
-        "name": "ims_test",
-        "description": "Create a system disk image from a data disk",
-        "volume_id": "877a2cda-ba63-4e1e-b95f-e67e48b6129a",
-        "type": "ECS",
-        "os_version": "CentOS 7.0 64bit",
-        "tags": [
-                "aaa.111",
-                "bbb.333",
-                "ccc.444" 
-           ]
- } 
-
                          
-
-
                          
-
                        • Request for creating a system disk image with parameter image_tags using a data disk
                          POST https://{Endpoint}/v2/cloudimages/action
                          
-
                          1
-2
-3
-4
-5
-6
-7
-8
                          {
-        "name": "ims_test",
-        "description": "Create a system disk image from a data disk",
-        "volume_id": "877a2cda-ba63-4e1e-b95f-e67e48b6129a",
-        "type": "ECS",
-        "os_version": "CentOS 7.0 64bit",
-        "image_tags": [{"key":"key2","value":"value2"},{"key":"key1","value":"value1"}] 
- } 
-
                          
-
-
                          
-
                          • 
+
+
                          
+
                        • Creating a system disk image with parameter tags using a data disk (ID: 877a2cda-ba63-4e1e-b95f-e67e48b6129a)
                           1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
+13
                          POST https://{Endpoint}/v2/cloudimages/action
+{
+        "name": "ims_test",
+        "description": "Create a system disk image from a data disk",
+        "volume_id": "877a2cda-ba63-4e1e-b95f-e67e48b6129a",
+        "type": "ECS",
+        "os_version": "CentOS 7.0 64bit",
+        "tags": [
+                "aaa.111",
+                "bbb.333",
+                "ccc.444" 
+           ]
+ } 
+
                          
+
                          
+
                        • Creating a system disk image with parameter image_tags using a data disk (ID: 877a2cda-ba63-4e1e-b95f-e67e48b6129a)
                          1
+2
+3
+4
+5
+6
+7
+8
+9
                          POST https://{Endpoint}/v2/cloudimages/action
+{
+        "name": "ims_test",
+        "description": "Create a system disk image from a data disk",
+        "volume_id": "877a2cda-ba63-4e1e-b95f-e67e48b6129a",
+        "type": "ECS",
+        "os_version": "CentOS 7.0 64bit",
+        "image_tags": [{"key":"key2","value":"value2"},{"key":"key1","value":"value1"}] 
+ } 
+
                          
+

                      Response

                      • Response parameters -

                        Parameter

                        +
                        - - - - -

                        Parameter

                        Type

                        +

                        Type

                        Description

                        +

                        Description

                        job_id

                        +

                        job_id

                        String

                        +

                        String

                        Specifies the asynchronous job ID.

                        -

                        For details, see Asynchronous Job Query.

                        +

                        Specifies the asynchronous job ID.

                        +

                        For details, see Querying the Status of an Asynchronous Job.
                      • Example response
                        STATUS CODE 200
                        -
                        1
-2
-3
                        {
-    "job_id": "8a12fc664fb4daa3014fb4e581380005"
+
                        1
+2
+3
                        {
+    "job_id": "8a12fc664fb4daa3014fb4e581380005"
 }
-
                        
-
-
                        + +

                        • Returned Values

                        • Normal

                          200

                        • Abnormal -

                          Returned Value

                          +
                          - - - - - - - - - - - - - diff --git a/docs/ims/api-ref/en-us_topic_0020092111.html b/docs/ims/api-ref/en-us_topic_0020092111.html index 652e0d499..1f831f09b 100644 --- a/docs/ims/api-ref/en-us_topic_0020092111.html +++ b/docs/ims/api-ref/en-us_topic_0020092111.html @@ -41,9 +41,11 @@ -

                          Request

                          • Request parameters

                            None

                            -
                          • Example request
                            PUT https://{Endpoint}/v2/images/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/tags/aaaa
                            -
                          +

                          Request

                          Request parameters

                          +

                          None

                          +
                          +

                          Example Request

                          Adding an image tag

                          +
                          PUT https://{Endpoint}/v2/images/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/tags/aaaa

                          Response

                          • Response parameters

                            None

                          • Example response
                            STATUS CODE 204
                            @@ -51,40 +53,40 @@

                          Returned Values

                          • Normal

                            204

                          • Abnormal -

                          Returned Value

                          Description

                          +

                          Description

                          400 Bad Request

                          +

                          400 Bad Request

                          Request error. For details about the returned error code, see Error Codes.

                          +

                          Request error. For details about the returned error code, see Error Codes.

                          401 Unauthorized

                          +

                          401 Unauthorized

                          Authentication failed.

                          +

                          Authentication failed.

                          403 Forbidden

                          +

                          403 Forbidden

                          You do not have the rights to perform the operation.

                          +

                          You do not have the rights to perform the operation.

                          404 Not Found

                          +

                          404 Not Found

                          The requested resource was not found.

                          +

                          The requested resource was not found.

                          500 Internal Server Error

                          +

                          500 Internal Server Error

                          Internal service error.

                          +

                          Internal service error.

                          503 Service Unavailable

                          +

                          503 Service Unavailable

                          The service is unavailable.

                          +

                          The service is unavailable.

                          Returned Value

                          +
                          - - - - - - - - - - - - - diff --git a/docs/ims/api-ref/en-us_topic_0022473688.html b/docs/ims/api-ref/en-us_topic_0022473688.html index 4d13a5b7b..67f35eb67 100644 --- a/docs/ims/api-ref/en-us_topic_0022473688.html +++ b/docs/ims/api-ref/en-us_topic_0022473688.html @@ -1,6 +1,6 @@ -

                          Asynchronous Job Query

                          +

                          Querying the Status of an Asynchronous Job

                          Function

                          This is an extension API. It is used to query for the execution status of an asynchronous job, for example, querying for the execution status of an image exporting job.

                          URI

                          GET /v1/{project_id}/jobs/{job_id}

                          @@ -32,75 +32,77 @@
                          -

                          Request

                          • Request parameters

                            None

                            -
                          • Example request
                            GET /v1/ac234de25c6741d2b1273da49eea1b9e/jobs/ff8080814dbd65d7014dbe0d84db0013
                            -
                          +

                          Request

                          Request parameters

                          +

                          None

                          +
                          +

                          Example Request

                          Querying the status of an asynchronous job

                          +
                          GET /v1/ac234de25c6741d2b1273da49eea1b9e/jobs/ff8080814dbd65d7014dbe0d84db0013

                          Response

                          • Response parameters -

                          Returned Value

                          Description

                          +

                          Description

                          400 Bad Request

                          +

                          400 Bad Request

                          Request error.

                          +

                          Request error.

                          401 Unauthorized

                          +

                          401 Unauthorized

                          Authentication failed.

                          +

                          Authentication failed.

                          403 Forbidden

                          +

                          403 Forbidden

                          You do not have the rights to perform the operation.

                          +

                          You do not have the rights to perform the operation.

                          404 Not Found

                          +

                          404 Not Found

                          The requested resource was not found.

                          +

                          The requested resource was not found.

                          500 Internal Server Error

                          +

                          500 Internal Server Error

                          Internal service error.

                          +

                          Internal service error.

                          503 Service Unavailable

                          +

                          503 Service Unavailable

                          The service is unavailable.

                          +

                          The service is unavailable.

                          Parameter

                          +
                          - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -109,163 +111,163 @@

                          Parameter

                          Type

                          +

                          Type

                          Description

                          +

                          Description

                          status

                          +

                          status

                          String

                          +

                          String

                          Specifies the job status. The value can be:

                          +

                          Specifies the job status. The value can be:

                          • SUCCESS: The job is successfully executed.
                          • FAIL: The job failed to be executed.
                          • RUNNING: The job is in progress.
                          • INIT: The job is being initialized.

                          job_id

                          +

                          job_id

                          String

                          +

                          String

                          Specifies the job ID.

                          +

                          Specifies the job ID.

                          job_type

                          +

                          job_type

                          String

                          +

                          String

                          Specifies the job type.

                          +

                          Specifies the job type.

                          • imsCreateImageByInstance: Creating a system disk image from a cloud server
                          • imsImportImageJob: Creating a system disk image from an external image file
                          • imsImportOvaImageJob: Creating an image from an OVA image file
                          • imsVolumeCreateImageJob: Creating a data disk image from a cloud server
                          • imsImportDataImageJob: Creating a data disk image from an external image file
                          • imsCreateWholeImageByInstanceJob: Creating a full-ECS image from an ECS
                          • imsCreateWholeImageByBackupJob: Creating a full-ECS image from a CBR or CSBS backup
                          • imsNativeImportImageJob: Registering an image
                          • imsNativeExportImageJob: Exporting image
                          • imsAddImageMembersJob: Adding tenants that can use a shared image
                          • imsDelImageMembersJob: Deleting tenants that can use a shared image
                          • imsUpdateImageMembersJob: Updating status of tenants who will accept or reject shared images
                          • imsCopyImageInRegionJob: Replicating images

                          begin_time

                          +

                          begin_time

                          String

                          +

                          String

                          Specifies the start time of the job. The value is in UTC format.

                          +

                          Specifies the start time of the job. The value is in UTC format.

                          end_time

                          +

                          end_time

                          String

                          +

                          String

                          Specifies the end time of the job. The value is in UTC format.

                          +

                          Specifies the end time of the job. The value is in UTC format.

                          error_code

                          +

                          error_code

                          String

                          +

                          String

                          Specifies the error code.

                          +

                          Specifies the error code.

                          fail_reason

                          +

                          fail_reason

                          String

                          +

                          String

                          Specifies the failure cause.

                          +

                          Specifies the failure cause.

                          entities

                          +

                          entities

                          Object

                          +

                          Object

                          Specifies the custom attributes of the job.

                          +

                          Specifies the custom attributes of the job.

                          If the job status is normal, the image ID will be returned. If the status is abnormal, an error code and details will be returned.

                          For details, see Table 2.

                          -
                          Table 2 Data structure description of the entities field

                          Parameter

                          +
                          - - - - - - - - - - - - - - - - - - - - - - -
                          Table 2 Data structure description of the entities field

                          Parameter

                          Type

                          +

                          Type

                          Description

                          +

                          Description

                          image_id

                          +

                          image_id

                          String

                          +

                          String

                          Specifies the image ID.

                          +

                          Specifies the image ID.

                          current_task

                          +

                          current_task

                          String

                          +

                          String

                          Specifies the job name.

                          +

                          Specifies the job name.

                          image_name

                          +

                          image_name

                          String

                          +

                          String

                          Specifies the image name.

                          +

                          Specifies the image name.

                          process_percent

                          +

                          process_percent

                          Double

                          +

                          Double

                          Specifies the job progress.

                          +

                          Specifies the job progress.

                          results

                          +

                          results

                          Array of result objects

                          +

                          Array of result objects

                          Specifies job execution results. For details, see Table 3.

                          +

                          Specifies job execution results. For details, see Table 3.

                          sub_jobs_result

                          +

                          sub_jobs_result

                          Array of SubJobResult objects

                          +

                          Array of objects

                          Specifies sub-job execution results. For details, see Table 4.

                          +

                          Specifies sub-job execution results. For details, see Table 4.

                          sub_jobs_list

                          +

                          sub_jobs_list

                          Array of string

                          +

                          Array of string

                          Specifies the sub-job IDs.

                          +

                          Specifies the sub-job IDs.
                          -
                          Table 3 Data structure description of the result field

                          Parameter

                          +
                          - - - - - - - - - - -
                          Table 3 Data structure description of the result field

                          Parameter

                          Type

                          +

                          Type

                          Description

                          +

                          Description

                          image_id

                          +

                          image_id

                          String

                          +

                          String

                          Specifies the image ID.

                          +

                          Specifies the image ID.

                          project_id

                          +

                          project_id

                          String

                          +

                          String

                          Specifies the project ID.

                          +

                          Specifies the project ID.

                          status

                          +

                          status

                          String

                          +

                          String

                          Specifies the job status.

                          +

                          Specifies the job status.
                          -
                          Table 4 Data structure description of the SubJobResult field

                          Parameter

                          +
                          - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -273,26 +275,26 @@
                          Table 4 Data structure description of the SubJobResult field

                          Parameter

                          Type

                          +

                          Type

                          Description

                          +

                          Description

                          status

                          +

                          status

                          String

                          +

                          String

                          Specifies the sub-job status. The value can be:

                          -
                          • SUCCESS: The sub-job is successfully executed.
                          • FAIL: The sub-job failed to be executed.
                          • RUNNING: The sub-job is in progress.
                          • INIT: The sub-job is being initialized.
                          +

                          Specifies the sub-job status. The value can be:

                          +
                          • SUCCESS: The sub-job is successfully executed.
                          • FAIL: The sub-job failed to be executed.
                          • RUNNING: The sub-job is in progress.
                          • INIT: The sub-job is being initialized.

                          job_id

                          +

                          job_id

                          String

                          +

                          String

                          Specifies a sub-job ID.

                          +

                          Specifies a sub-job ID.

                          job_type

                          +

                          job_type

                          String

                          +

                          String

                          Specifies the sub-job type.

                          +

                          Specifies the sub-job type.

                          begin_time

                          +

                          begin_time

                          String

                          +

                          String

                          Specifies the start time of the sub-job. The value is in UTC format.

                          +

                          Specifies the start time of the sub-job. The value is in UTC format.

                          end_time

                          +

                          end_time

                          String

                          +

                          String

                          Specifies the end time of the sub-job. The value is in UTC format.

                          +

                          Specifies the end time of the sub-job. The value is in UTC format.

                          error_code

                          +

                          error_code

                          String

                          +

                          String

                          Specifies the error code.

                          +

                          Specifies the error code.

                          fail_reason

                          +

                          fail_reason

                          String

                          +

                          String

                          Specifies the failure cause.

                          +

                          Specifies the failure cause.

                          entities

                          +

                          entities

                          Object SubJobEntities

                          +

                          Object

                          Specifies the custom attributes of the sub-job. For details, see Table 5.

                          +

                          Specifies the custom attributes of the sub-job. For details, see Table 5.

                          • If a sub-job is properly executed, an image ID is returned.
                          • If an exception occurs on the sub-job, an error code and associated information are returned.
                          -
                          Table 5 Data structure description of the SubJobEntities field

                          Parameter

                          +
                          - - - - - - - - @@ -300,83 +302,82 @@
                          • Example response
                            STATUS CODE 200
                            -
                          Table 5 Data structure description of the SubJobEntities field

                          Parameter

                          Type

                          +

                          Type

                          Description

                          +

                          Description

                          image_id

                          +

                          image_id

                          String

                          +

                          String

                          Specifies the image ID.

                          +

                          Specifies the image ID.

                          image_name

                          +

                          image_name

                          String

                          +

                          String

                          Specifies the image name.

                          +

                          Specifies the image name.

                          		 
                           1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
-11
-12
-13
-14
-15
-16
-17
-18
-19
-20
-21
                          {
-    "status": "SUCCESS",
-    "entities": {
-        "image_id": "e9e91bff-14b6-4a0b-8377-4ed0813e3360",
-        "image_name": "asdfasdfasdfas",
-        "process_percent": 0.20,
-        "current_task": "CreateImageByInstanceTask",
-        "results": [{
-                "image_id": "49e9447f-7dff-41e0-8036-f66fe5488c8b",
-                "project_id": "089b2f9a3d80d3062f24c00ca4ed5cbd",
-                "status": "success"
-            }
-        ]
-    },
-    "job_id": "ff8080814dbd65d7014dbe0d84db0013",
-    "job_type": "createImageByInstance",
-    "begin_time": "04-Jun-2015 18:11:06:586",
-    "end_time": "",
-    "error_code": null,
-    "fail_reason": null
+
                           1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
+13
+14
+15
+16
+17
+18
+19
+20
+21
                          {
+    "status": "SUCCESS",
+    "entities": {
+        "image_id": "e9e91bff-14b6-4a0b-8377-4ed0813e3360",
+        "image_name": "asdfasdfasdfas",
+        "process_percent": 0.20,
+        "current_task": "CreateImageByInstanceTask",
+        "results": [{
+                "image_id": "49e9447f-7dff-41e0-8036-f66fe5488c8b",
+                "project_id": "089b2f9a3d80d3062f24c00ca4ed5cbd",
+                "status": "success"
+            }
+        ]
+    },
+    "job_id": "ff8080814dbd65d7014dbe0d84db0013",
+    "job_type": "createImageByInstance",
+    "begin_time": "04-Jun-2015 18:11:06:586",
+    "end_time": "",
+    "error_code": null,
+    "fail_reason": null
 }
-
                          
-
-
                          + +

                          Returned Values

                          • Normal

                            200

                          • Abnormal -

                            Returned Value

                            +
                            - - - - - - - - - - - diff --git a/docs/ims/api-ref/en-us_topic_0022473689.html b/docs/ims/api-ref/en-us_topic_0022473689.html index 7e3f3f48a..c27c13c62 100644 --- a/docs/ims/api-ref/en-us_topic_0022473689.html +++ b/docs/ims/api-ref/en-us_topic_0022473689.html @@ -4,20 +4,19 @@

                            Function Description

                            If the returned status code is 400, a customized error message will be returned. This section describes the meaning of each status code.

                            Response Format

                            STATUS CODE 400
                            -

                            Returned Value

                            Description

                            +

                            Description

                            400 Bad Request

                            +

                            400 Bad Request

                            Request error.

                            +

                            Request error.

                            401 Unauthorized

                            +

                            401 Unauthorized

                            Authentication failed.

                            +

                            Authentication failed.

                            403 Forbidden

                            +

                            403 Forbidden

                            You do not have the rights to perform the operation.

                            +

                            You do not have the rights to perform the operation.

                            500 Internal Server Error

                            +

                            500 Internal Server Error

                            Internal service error.

                            +

                            Internal service error.

                            503 Service Unavailable

                            +

                            503 Service Unavailable

                            The service is unavailable.

                            +

                            The service is unavailable.

                            		 
                            1
-2
-3
-4
-5
-6
                            {
-    "error": {
-        "message": "The imagetype is invalid.",
-        "code": "IMG.0024"
-    }
+
                            1
+2
+3
+4
+5
+6
                            {
+    "error": {
+        "message": "The imagetype is invalid.",
+        "code": "IMG.0024"
+    }
 }
-
                            
-
-
                            + +

                            Error Message Description

                            - @@ -192,7 +191,7 @@ - @@ -307,7 +306,7 @@ - @@ -423,7 +422,7 @@ - @@ -564,9 +563,9 @@ - - @@ -1403,7 +1402,7 @@ - @@ -1920,9 +1919,9 @@ - - - + + + @@ -55,7 +61,7 @@ @@ -86,7 +92,7 @@ - @@ -191,7 +197,7 @@ - - @@ -221,7 +227,7 @@ - diff --git a/docs/ims/api-ref/en-us_topic_0031615565.html b/docs/ims/api-ref/en-us_topic_0031615565.html index 47d1a6949..2935c08d1 100644 --- a/docs/ims/api-ref/en-us_topic_0031615565.html +++ b/docs/ims/api-ref/en-us_topic_0031615565.html @@ -52,7 +52,7 @@ - - - -
                            Table 1 Error codes

                            Status Code

                            @@ -148,7 +147,7 @@

                            forceCreate must be set to true.

                            forceCreate must be set to true.

                            +

                            forceCreate must be set to true.

                            Set forceCreate to true.

                            The number of private images has reached the maximum allowed.

                            The number of private images has reached the quota.

                            +

                            The number of private images has reached the quota limit.

                            Increase the quota or delete existing images.

                            Check whether the user type is valid.

                            400

                            +

                            403

                            IMG.0026

                            An error occurred when the value of asumeToken was obtained.

                            An error occurred when the value of asumeToken was obtained.

                            +

                            An error occurred when the value of asumeToken was obtained.

                            Contact technical support.

                            IMG.0057

                            The image file does not exist, is empty, or in the incorrect format.

                            +

                            The image file is empty, not found, or in incorrect format, or you do not have enough permission to access the file.

                            The image file does not exist, is empty, or in the incorrect format.

                            +

                            Empty or non-existing image file, incorrect file format, or insufficient permissions.

                            Select a valid image file.

                            The value of hw_firmware_type is not uefi or bios.

                            The value of hw_firmware_type is not uefi or bios.

                            +

                            The value of hw_firmware_type is not uefi or bios.

                            Set hw_firmware_type to uefi or bios.

                            The value of Architecture must be x86 or Arm.

                            The value of Architecture must be x86 or Arm.

                            +

                            The value of Architecture must be x86 or Arm.

                            Set Architecture to x86 or arm.

                            +

                            Set Architecture to x86 or arm.

                            400

                            diff --git a/docs/ims/api-ref/en-us_topic_0024735403.html b/docs/ims/api-ref/en-us_topic_0024735403.html index 0f27f89cf..933be6ae4 100644 --- a/docs/ims/api-ref/en-us_topic_0024735403.html +++ b/docs/ims/api-ref/en-us_topic_0024735403.html @@ -8,12 +8,18 @@

                            2023-03-23

                            +

                            2023-12-22

                            +

                            Modified the following content:

                            + +

                            2023-03-23

                            Added the following content:

                            Introduction

                            Modified the following content:

                            - +

                            2023-02-01

                            @@ -25,7 +31,7 @@

                            2022-12-22

                            Modified the following content:

                            - +

                            2022-12-01

                            @@ -40,8 +46,8 @@

                            Modified the following content:

                            - +
                            Deleted the following content:
                            • Asynchronous Job Progress Query

                            2020-08-12

                            Modified the following content:

                            -
                            A CBR backup can be used to create a full-ECS image. The following changes are involved: +
                            A CBR backup can be used to create a full-ECS image. The following changes are involved:

                            2019-01-30

                            Modified the following content:

                            - +

                            2018-09-30

                            @@ -147,7 +153,7 @@

                            2017-10-30

                            Modified the following content:
                            • Changed the maximum value of min_disk to 1024.
                            +
                            Modified the following content:
                            • Changed the maximum value of min_disk to 1024 (GB).

                            2017-02-28

                            Added the following content: +
                            Added the following content:
                            Modified the following content:
                            • Updated the values of __os_version.
                            @@ -199,7 +205,7 @@

                            2017-02-08

                            Modified the following content:
                            • Updated the values of __os_version.
                            +
                            Modified the following content:
                            • Updated the values of __os_version.

                            2016-10-29

                            Added the following content: +
                            Added the following content:

                            Boolean

                            Specifies whether the image is protected. A protected image cannot be deleted. The default value is false.

                            +

                            Specifies whether the image is protected. A protected image cannot be deleted. The default value is false.

                            container_format

                            @@ -62,7 +62,7 @@

                            String

                            Specifies the container format.

                            -

                            The default value is bare.

                            +

                            The default value is bare.

                            disk_format

                            @@ -71,7 +71,7 @@

                            String

                            Specifies the image format. The value can be zvhd2, vhd, zvhd, raw, or qcow2. The default value is zvhd2.

                            +

                            Specifies the image format. The value can be zvhd2, vhd, raw, or qcow2. The default value is zvhd2.

                            tags

                            @@ -92,7 +92,7 @@

                            Integer

                            Specifies the minimum memory size (MB) required for running the image. The parameter value depends on ECS specifications. The default value is 0.

                            +

                            Specifies the minimum memory size (MB) required for running the image. The parameter value depends on ECS specifications. The default value is 0.

                            min_disk

                            @@ -101,19 +101,21 @@

                            Integer

                            Specifies the minimum disk space (GB) required for running the image. The value ranges from 1 GB to 1024 GB.

                            +

                            Specifies the minimum disk space (GB) required for running the image. The value ranges from 1 GB to 1,024 GB.

                            The value of this parameter must be greater than the image system disk capacity. Otherwise, the ECS creation may fail.
                            -
                          • Example request
                            POST https://{Endpoint}/v2/images
                            -
                            {
+
                            • +
                            +

                            Example Request

                            POST https://{Endpoint}/v2/images
+{
     "__os_version": "Ubuntu 14.04 server 64bit",
     "container_format": "bare",
     "disk_format": "vhd",
-    "min_disk": 1,
+    "min_disk": 100,
     "min_ram": 1024,
     "name": "test",
     "tags": [
@@ -123,229 +125,228 @@
     "visibility": "private",
     "protected": false
 }
                            -

                            Response

                            • Response parameters -

                              Parameter

                              +
                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -354,7 +355,7 @@
                            • Example response
                              STATUS CODE 201
                              {
     "schema": "/v2/schemas/image",
-    "min_disk": 1,
+    "min_disk": 100,
     "created_at": "2016-06-02T07:49:48Z",
     "__image_source_type": "uds",
     "container_format": "bare",
@@ -387,40 +388,40 @@
 
 
                              Returned Values
                              • Normal
                                201
                                
 
                              • Abnormal
-

                              • Parameter

                              Type

                              +

                              Type

                              Description

                              +

                              Description

                              visibility

                              +

                              visibility

                              String

                              +

                              String

                              Specifies whether the image is available to other tenants. The value is private.

                              +

                              Specifies whether the image is available to other tenants. The value is private.

                              name

                              +

                              name

                              String

                              +

                              String

                              Specifies the image name. If this parameter is not specified, its value is empty by default. In that case, ECS creation using this image will fail. The name contains 1 to 128 characters. For detailed description, see Image Attributes.

                              +

                              Specifies the image name. If this parameter is not specified, its value is empty by default. In that case, ECS creation using this image will fail. The name contains 1 to 128 characters. For detailed description, see Image Attributes.

                              protected

                              +

                              protected

                              Boolean

                              +

                              Boolean

                              Specifies whether the image is protected. A protected image cannot be deleted. The value is false.

                              +

                              Specifies whether the image is protected. A protected image cannot be deleted. The value is false.

                              container_format

                              +

                              container_format

                              String

                              +

                              String

                              Specifies the container format.

                              -

                              The value is bare.

                              +

                              Specifies the container format.

                              +

                              The value is bare.

                              disk_format

                              +

                              disk_format

                              String

                              +

                              String

                              Specifies the image format. The value can be zvhd2, vhd, zvhd, raw, or qcow2. The default value is zvhd2.

                              +

                              Specifies the image format. The value can be zvhd2, vhd, raw, or qcow2. The default value is zvhd2.

                              tags

                              +

                              tags

                              Array of strings

                              +

                              Array of strings

                              Lists the image tags. The tag contains 1 to 255 characters.

                              +

                              Lists the image tags. The tag contains 1 to 255 characters.

                              min_ram

                              +

                              min_ram

                              Integer

                              +

                              Integer

                              Specifies the minimum memory size (MB) required for running the image. The parameter value depends on the ECS specifications limit. The value is generally set to 0.

                              +

                              Specifies the minimum memory size (MB) required for running the image. The parameter value depends on the ECS specifications limit. The value is generally set to 0.

                              min_disk

                              +

                              min_disk

                              Integer

                              +

                              Integer

                              Specifies the minimum disk space (GB) required for running the image. The value ranges from 1 GB to 1024 GB. It must be greater than the system disk capacity in the image. Otherwise, the ECS creation may fail.

                              +

                              Specifies the minimum disk space (GB) required for running the image. It must be greater than the system disk capacity in the image. Otherwise, the ECS creation will fail. The value ranges from 1 GB to 1,024 GB.

                              status

                              +

                              status

                              String

                              +

                              String

                              Specifies the image status. The value can be one of the following:

                              +

                              Specifies the image status. The value can be one of the following:

                              • queued: indicates that the image metadata has already been created, and it is ready for the image file to upload.
                              • saving: indicates that the image file is being uploaded to the backend storage.
                              • deleted: indicates that the image has been deleted.
                              • killed: indicates that an error occurs on the image uploading.
                              • active: indicates that the image is available for use.

                              created_at

                              +

                              created_at

                              String

                              +

                              String

                              Specifies the time when the image was created. The value is in UTC format.

                              +

                              Specifies the time when the image was created. The value is in UTC format.

                              updated_at

                              +

                              updated_at

                              String

                              +

                              String

                              Specifies the time when the image was updated. The value is in UTC format.

                              +

                              Specifies the time when the image was updated. The value is in UTC format.

                              self

                              +

                              self

                              String

                              +

                              String

                              Specifies the image URL.

                              +

                              Specifies the image URL.

                              id

                              +

                              id

                              String

                              +

                              String

                              Specifies the image ID. After the image creation API is called, the image ID must be saved. The image ID is used to invoke the image uploading API and upload the image.

                              +

                              Specifies the image ID. After the image creation API is called, the image ID must be saved. The image ID is used to invoke the image uploading API and upload the image.

                              file

                              +

                              file

                              String

                              +

                              String

                              Specifies the URL for uploading and downloading the image file.

                              +

                              Specifies the URL for uploading and downloading the image file.

                              schema

                              +

                              schema

                              String

                              +

                              String

                              Specifies the URL for accessing the schema.

                              +

                              Specifies the URL for accessing the schema.

                              __image_source_type

                              +

                              __image_source_type

                              String

                              +

                              String

                              Specifies the image backend storage type. Only UDS is supported currently.

                              +

                              Specifies the image backend storage type. Only UDS is supported currently.

                              __image_size

                              +

                              __image_size

                              String

                              +

                              String

                              Specifies the image size. The unit is byte.

                              +

                              Specifies the image size. The unit is byte.

                              __isregistered

                              +

                              __isregistered

                              String

                              +

                              String

                              Specifies whether the image is registered. Only registered images can be queried on the portal. The value is true.

                              +

                              Specifies whether the image is registered. Only registered images can be queried on the portal. The value is true.

                              __os_version

                              +

                              __os_version

                              String

                              +

                              String

                              Specifies the image OS version. For the value range, see Values of Related Parameters.

                              +

                              Specifies the image OS version. For the value range, see Values of Related Parameters.

                              __os_type

                              +

                              __os_type

                              String

                              +

                              String

                              Specifies the image OS type. The value of this parameter depends on that of __os_version. The value can be Windows, Linux, or other.

                              +

                              Specifies the image OS type. The value of this parameter depends on that of __os_version. The value can be Windows, Linux, or other.

                              __platform

                              +

                              __platform

                              String

                              +

                              String

                              Specifies the OS platform supported by the image. The value of this parameter depends on that of __os_version.

                              +

                              Specifies the OS platform supported by the image. The value of this parameter depends on that of __os_version.

                              __os_bit

                              +

                              __os_bit

                              String

                              +

                              String

                              Specifies the OS bit. The value of this parameter depends on that of __os_version. The value can be 32 or 64.

                              +

                              Specifies the OS bit. The value of this parameter depends on that of __os_version. The value can be 32 or 64.

                              __imagetype

                              +

                              __imagetype

                              String

                              +

                              String

                              Specifies the image type. private indicates a private image.

                              +

                              Specifies the image type. private indicates a private image.

                              virtual_env_type

                              +

                              virtual_env_type

                              String

                              +

                              String

                              Specifies the platform type.

                              +

                              Specifies the platform type.

                              Specifies the environment where the image is used. The value can be FusionCompute, Ironic, DataImage, or IsoImage.

                              -
                              • For an ECS image, the value is FusionCompute.
                              • For a data disk image, the value is DataImage.
                              • For a BMS image, the value is Ironic.
                              • For an ISO image, the value is IsoImage.
                              +
                              • For an ECS image, the value is FusionCompute.
                              • For an ECS data disk image, the value is DataImage.
                              • For a BMS image, the value is Ironic.
                              • For an ISO image, the value is IsoImage.

                              owner

                              +

                              owner

                              String

                              +

                              String

                              Specifies the ID of the project to which the image belongs.

                              +

                              Specifies the ID of the project to which the image belongs.

                              __root_origin

                              +

                              __root_origin

                              String

                              +

                              String

                              Specifies that the image is created from an external image file. Value: file

                              +

                              Specifies that the image is created from an external image file. Value: file

                              checksum

                              +

                              checksum

                              String

                              +

                              String

                              Specifies the MD5 value of the image file.

                              +

                              Specifies the MD5 value of the image file.

                              size

                              +

                              size

                              Long

                              +

                              Long

                              This parameter is unavailable currently.

                              +

                              This parameter is unavailable currently.

                              virtual_size

                              +

                              virtual_size

                              Integer

                              +

                              Integer

                              Specifies the virtual size of the image. The unit is byte.

                              +

                              Specifies the virtual size of the image. The unit is byte.

                              properties

                              +

                              properties

                              Properties object

                              +

                              Properties object

                              Specifies a collection of image attributes instead of a specified attribute.

                              +

                              Specifies a collection of image attributes instead of a specified attribute.

                              Returned Value

                              +
                              - - - - - - - - - - - - - diff --git a/docs/ims/api-ref/en-us_topic_0031615566.html b/docs/ims/api-ref/en-us_topic_0031615566.html index 32564dc70..c8d9fcfa3 100644 --- a/docs/ims/api-ref/en-us_topic_0031615566.html +++ b/docs/ims/api-ref/en-us_topic_0031615566.html @@ -58,11 +58,12 @@

                              Returned Value

                              Description

                              +

                              Description

                              400 Bad Request

                              +

                              400 Bad Request

                              Request error.

                              +

                              Request error.

                              401 Unauthorized

                              +

                              401 Unauthorized

                              Authentication failed.

                              +

                              Authentication failed.

                              403 Forbidden

                              +

                              403 Forbidden

                              You do not have the rights to perform the operation.

                              +

                              You do not have the rights to perform the operation.

                              404 Not Found

                              +

                              404 Not Found

                              The requested resource was not found.

                              +

                              The requested resource was not found.

                              500 Internal Server Error

                              +

                              500 Internal Server Error

                              Internal service error.

                              +

                              Internal service error.

                              503 Service Unavailable

                              +

                              503 Service Unavailable

                              The service is unavailable.

                              +

                              The service is unavailable.
                              -
                            • Example request
                              PUT https://{Endpoint}/v2/images/84ac7f2b-bf19-4efb-86a0-b5be8771b476/file
                              +
                              • + +

                              Example Request

                              PUT https://{Endpoint}/v2/images/84ac7f2b-bf19-4efb-86a0-b5be8771b476/file

                              If you use the curl command to call the API, the example request is as follows:

                              curl -i --insecure 'https://IP/v2/images/84ac7f2b-bf19-4efb-86a0-b5be8771b476/file' -X PUT -H "X-Auth-Token: $mytoken" -H "Content-Type:application/octet-stream" -T /mnt/userdisk/images/suse.zvhd
                              -

                              Response

                              • Response parameters

                                None

                              • Example response
                                HTTP/1.1 204
                                @@ -70,40 +71,40 @@

                              Returned Values

                              • Normal

                                204

                              • Abnormal -

                                Returned Value

                                +
                                - - - - - - - - - - - - - diff --git a/docs/ims/api-ref/en-us_topic_0036994315.html b/docs/ims/api-ref/en-us_topic_0036994315.html index e3a121b48..b673ae8af 100644 --- a/docs/ims/api-ref/en-us_topic_0036994315.html +++ b/docs/ims/api-ref/en-us_topic_0036994315.html @@ -5,7 +5,7 @@

                                Before exporting an image, ensure that you have the Tenant Administrator permission for OBS.

                                -

                                Constraints

                                • The following private images cannot be exported:
                                  • Full-ECS images
                                  • Private images created from a Windows, SUSE, Red Hat, Ubuntu, or Oracle Linux public image
                                  +

                                  Constraints

                                  • An image can only be exported to a Standard bucket that is in the same region as the image.
                                  • The following private images cannot be exported:
                                    • Full-ECS images
                                    • Private images created from a Windows, SUSE, Red Hat, Ubuntu, or Oracle Linux public image
                                  • The image size must be less than 1 TB. Images larger than 128 GB support only fast export.

                                  URI

                                  POST /v1/cloudimages/{image_id}/file

                                  @@ -79,89 +79,89 @@

                                Returned Value

                                Description

                                +

                                Description

                                400 Bad Request

                                +

                                400 Bad Request

                                Request error. For details, see Error Codes.

                                +

                                Request error. For details, see Error Codes.

                                401 Unauthorized

                                +

                                401 Unauthorized

                                Authentication failed.

                                +

                                Authentication failed.

                                403 Forbidden

                                +

                                403 Forbidden

                                You do not have the rights to perform the operation.

                                +

                                You do not have the rights to perform the operation.

                                404 Not Found

                                +

                                404 Not Found

                                The requested resource was not found.

                                +

                                The requested resource was not found.

                                409 Conflict

                                +

                                409 Conflict

                                Request conflict.

                                +

                                Request conflict.

                                500 System Error

                                +

                                500 System Error

                                System error.

                                +

                                System error.
                                -
                                -
                              • Example request
                                POST https://{Endpoint}/v1/cloudimages/d164b5df-1bc3-4c3f-893e-3e471fd16e64/file
                                -
                                1
-2
-3
-4
-5
                                {
-   "bucket_url": "ims-image:centos7_5.qcow2",
-   "file_format": "qcow2",
-   "is_quick_export": false
-}
-
                                -
                                • +

                                Example Request

                                1
+2
+3
+4
+5
+6
                                POST https://{Endpoint}/v1/cloudimages/d164b5df-1bc3-4c3f-893e-3e471fd16e64/file
+{
+   "bucket_url": "ims-image:centos7_5.qcow2",
+   "file_format": "qcow2",
+   "is_quick_export": false
+}
+
                                +
                                +

                                Response

                                • Response parameters -

                                  Parameter

                                  +
                                  - - - - -

                                  Parameter

                                  Type

                                  +

                                  Type

                                  Description

                                  +

                                  Description

                                  job_id

                                  +

                                  job_id

                                  String

                                  +

                                  String

                                  Specifies the asynchronous job ID.

                                  -

                                  For details, see Asynchronous Job Query.

                                  +

                                  Specifies the asynchronous job ID.

                                  +

                                  For details, see Querying the Status of an Asynchronous Job.
                                • Example response
                                  STATUS CODE 200
                                  -
                                  1
-2
-3
                                  {
-    "job_id": "edc89b490d7d4392898e19b2deb34797"
+
                                  1
+2
+3
                                  {
+    "job_id": "edc89b490d7d4392898e19b2deb34797"
 }
-
                                  
-
-
                                  + +

                                  • Returned Values

                                  • Normal

                                    200

                                  • Abnormal -

                                    Returned Value

                                    +
                                    - - - - - - - - - - - - - diff --git a/docs/ims/api-ref/en-us_topic_0036994317.html b/docs/ims/api-ref/en-us_topic_0036994317.html index dd35d4ed1..c126bfa3c 100644 --- a/docs/ims/api-ref/en-us_topic_0036994317.html +++ b/docs/ims/api-ref/en-us_topic_0036994317.html @@ -1,9 +1,9 @@ -

                                    Adding an Image Member (Native OpenStack API)

                                    -

                                    Function

                                    This API is used to add a project ID of a tenant with whom the image is to be shared.

                                    +

                                    Adding an Image Sharing Member (Native OpenStack API)

                                    +

                                    Function

                                    This API is used to add a project ID of a tenant the image is to be shared with.

                                    -

                                    Constraints

                                    For an encrypted image, you need to authorize the key used by the image before adding a member for it. For details, see "How Do I Authorize a Key?" in Image Management Service User Guide.

                                    +

                                    Constraints

                                    For an encrypted image, you need to authorize the key used by the image before using this API. For details, see "How Do I Authorize a Key?" in Image Management Service User Guide.

                                    URI

                                    POST /v2/images/{image_id}/members

                                    @@ -24,135 +24,136 @@
                                    -

                                    Returned Value

                                    Description

                                    +

                                    Description

                                    400 Bad Request

                                    +

                                    400 Bad Request

                                    Request error. For details about the returned error code, see Error Codes.

                                    +

                                    Request error. For details about the returned error code, see Error Codes.

                                    401 Unauthorized

                                    +

                                    401 Unauthorized

                                    Authentication failed.

                                    +

                                    Authentication failed.

                                    403 Forbidden

                                    +

                                    403 Forbidden

                                    You do not have the rights to perform the operation.

                                    +

                                    You do not have the rights to perform the operation.

                                    404 Not Found

                                    +

                                    404 Not Found

                                    The requested resource was not found.

                                    +

                                    The requested resource was not found.

                                    500 Internal Server Error

                                    +

                                    500 Internal Server Error

                                    Internal service error.

                                    +

                                    Internal service error.

                                    503 Service Unavailable

                                    +

                                    503 Service Unavailable

                                    The service is unavailable.

                                    +

                                    The service is unavailable.

                                    String

                                    Specifies the image member.

                                    -

                                    The value is the project ID of a tenant.

                                    +

                                    Specifies a tenant who will be able to use the shared image.

                                    +

                                    The value is the project ID of the tenant.
                                    -
                                    -
                                  • Example request
                                    POST https://{Endpoint}/v2/images/d164b5df-1bc3-4c3f-893e-3e471fd16e64/members
                                    -
                                    1
-2
-3
                                    {
-    "member":"edc89b490d7d4392898e19b2deb34797"
-}
-
                                    -
                                    • +

                                    Example Request

                                    Adding a tenant who can use the shared image (project ID: edc89b490d7d4392898e19b2deb34797)

                                    +
                                    1
+2
+3
+4
                                    POST https://{Endpoint}/v2/images/d164b5df-1bc3-4c3f-893e-3e471fd16e64/members
+{
+    "member":"edc89b490d7d4392898e19b2deb34797"
+}
+
                                    +
                                    +

                                    Response

                                    • Response parameters -

                                      Parameter

                                      +
                                      - - - - - - - - - - - - - - - - - - - -

                                      Parameter

                                      Type

                                      +

                                      Type

                                      Description

                                      +

                                      Description

                                      status

                                      +

                                      status

                                      String

                                      +

                                      String

                                      Specifies the image sharing status.

                                      +

                                      Specifies the image sharing status.

                                      created_at

                                      +

                                      created_at

                                      String

                                      +

                                      String

                                      Specifies the time when a shared image was created. The value is in UTC format.

                                      +

                                      Specifies the time when a shared image was created. The value is in UTC format.

                                      updated_at

                                      +

                                      updated_at

                                      String

                                      +

                                      String

                                      Specifies the time when a shared image was updated. The value is in UTC format.

                                      +

                                      Specifies the time when a shared image was updated. The value is in UTC format.

                                      image_id

                                      +

                                      image_id

                                      String

                                      +

                                      String

                                      Specifies the image ID.

                                      +

                                      Specifies the image ID.

                                      member_id

                                      +

                                      member_id

                                      String

                                      +

                                      String

                                      Specifies the member ID, that is, the project ID of the tenant who is to accept the shared image.

                                      +

                                      Specifies the project ID of the tenant who is to accept the shared image.

                                      schema

                                      +

                                      schema

                                      String

                                      +

                                      String

                                      Specifies the sharing schema.

                                      +

                                      Specifies the sharing schema.
                                    • Example response
                                      STATUS CODE 200
                                      -
                                      1
-2
-3
-4
-5
-6
-7
-8
                                      {
-    "status": "pending",
-    "created_at": "2016-09-01T02:05:14Z",
-    "updated_at": "2016-09-01T02:05:14Z",
-    "image_id": "d164b5df-1bc3-4c3f-893e-3e471fd16e64",
-    "member_id": "edc89b490d7d4392898e19b2deb34797",
-    "schema": "/v2/schemas/member"
+
                                      1
+2
+3
+4
+5
+6
+7
+8
                                      {
+    "status": "pending",
+    "created_at": "2016-09-01T02:05:14Z",
+    "updated_at": "2016-09-01T02:05:14Z",
+    "image_id": "d164b5df-1bc3-4c3f-893e-3e471fd16e64",
+    "member_id": "edc89b490d7d4392898e19b2deb34797",
+    "schema": "/v2/schemas/member"
 }
-
                                      
-
-
                                      + +

                                      • Returned Values

                                      • Normal

                                        200

                                      • Abnormal -

                                        Returned Value

                                        +
                                        - - - - - - - - - - - - - diff --git a/docs/ims/api-ref/en-us_topic_0036994318.html b/docs/ims/api-ref/en-us_topic_0036994318.html index e5c909d0b..6de82fe9f 100644 --- a/docs/ims/api-ref/en-us_topic_0036994318.html +++ b/docs/ims/api-ref/en-us_topic_0036994318.html @@ -1,6 +1,6 @@ -

                                        Updating the Image Sharing Status in Batches (Native OpenStack API)

                                        +

                                        Updating the Image Sharing Status (Native OpenStack API)

                                        Function

                                        This API is used to update the image sharing status when a tenant accepts or rejects a shared image.

                                        URI

                                        PUT /v2/images/{image_id}/members/{member_id}

                                        @@ -30,7 +30,7 @@
                                        - @@ -73,141 +73,141 @@

                                        Returned Value

                                        Description

                                        +

                                        Description

                                        400 Bad Request

                                        +

                                        400 Bad Request

                                        Request error.

                                        +

                                        Request error.

                                        401 Unauthorized

                                        +

                                        401 Unauthorized

                                        Authentication failed.

                                        +

                                        Authentication failed.

                                        403 Forbidden

                                        +

                                        403 Forbidden

                                        You do not have the rights to perform the operation.

                                        +

                                        You do not have the rights to perform the operation.

                                        404 Not Found

                                        +

                                        404 Not Found

                                        The requested resource was not found.

                                        +

                                        The requested resource was not found.

                                        500 Internal Server Error

                                        +

                                        500 Internal Server Error

                                        Internal service error.

                                        +

                                        Internal service error.

                                        503 Service Unavailable

                                        +

                                        503 Service Unavailable

                                        The service is unavailable.

                                        +

                                        The service is unavailable.

                                        String

                                        Specifies the member ID.

                                        +

                                        Specifies the project ID of the tenant who is to accept or reject a shared image.
                                        -
                                        -
                                      • Example request
                                        • If the image is not a full-ECS image:
                                          PUT https://{Endpoint}/v2/images/d164b5df-1bc3-4c3f-893e-3e471fd16e64/members/edc89b490d7d4392898e19b2deb34797
                                          -
                                          1
-2
-3
                                          {
-    "status": "accepted"
-}
-
                                          - -
                                          -
                                        • If the image is a full-ECS image:
                                          PUT https://{Endpoint}/v2/images/d164b5df-1bc3-4c3f-893e-3e471fd16e64/members/edc89b490d7d4392898e19b2deb34797
                                          -
                                          1
-2
-3
-4
                                          {
-    "status": "accepted",
-    "vault_id": "6yhtb5df-1bc3-4c3f-893e-3e4716yhgt61"
-}
-
                                          -
                                        + +

                                        Example Request

                                        • Updating the image sharing status to accepted
                                          1
+2
+3
+4
                                          PUT https://{Endpoint}/v2/images/d164b5df-1bc3-4c3f-893e-3e471fd16e64/members/edc89b490d7d4392898e19b2deb34797
+{
+    "status": "accepted"
+}
+
                                          +
                                          +
                                        • Updating the sharing status of an image created from a CBR backup to accepted (vault ID: 6yhtb5df-1bc3-4c3f-893e-3e4716yhgt61)
                                          1
+2
+3
+4
+5
                                          PUT https://{Endpoint}/v2/images/d164b5df-1bc3-4c3f-893e-3e471fd16e64/members/edc89b490d7d4392898e19b2deb34797
+{
+    "status": "accepted",
+    "vault_id": "6yhtb5df-1bc3-4c3f-893e-3e4716yhgt61"
+}
+
                                          +

                                        Response

                                        • Response parameters -

                                          Parameter

                                          +
                                          - - - - - - - - - - - - - - - - - - - -

                                          Parameter

                                          Type

                                          +

                                          Type

                                          Description

                                          +

                                          Description

                                          status

                                          +

                                          status

                                          String

                                          +

                                          String

                                          Specifies the image sharing status.

                                          +

                                          Specifies the image sharing status.

                                          created_at

                                          +

                                          created_at

                                          String

                                          +

                                          String

                                          Specifies the time when a shared image was created. The value is in UTC format.

                                          +

                                          Specifies the time when a shared image was created. The value is in UTC format.

                                          updated_at

                                          +

                                          updated_at

                                          String

                                          +

                                          String

                                          Specifies the time when a shared image was updated. The value is in UTC format.

                                          +

                                          Specifies the time when a shared image was updated. The value is in UTC format.

                                          image_id

                                          +

                                          image_id

                                          String

                                          +

                                          String

                                          Specifies the image ID.

                                          +

                                          Specifies the image ID.

                                          member_id

                                          +

                                          member_id

                                          String

                                          +

                                          String

                                          Specifies the member ID.

                                          +

                                          Specifies the project ID of the tenant who is to accept or reject a shared image.

                                          schema

                                          +

                                          schema

                                          String

                                          +

                                          String

                                          Specifies the sharing schema.

                                          +

                                          Specifies the sharing schema.
                                        • Example response
                                          STATUS CODE 200
                                          -
                                          1
-2
-3
-4
-5
-6
-7
-8
                                          {
-    "status": "accepted",
-    "created_at": "2016-09-01T02:05:14Z",
-    "updated_at": "2016-09-01T02:37:11Z",
-    "image_id": "d164b5df-1bc3-4c3f-893e-3e471fd16e64",
-    "member_id": "edc89b490d7d4392898e19b2deb34797",
-    "schema": "/v2/schemas/member"
+
                                          1
+2
+3
+4
+5
+6
+7
+8
                                          {
+    "status": "accepted",
+    "created_at": "2016-09-01T02:05:14Z",
+    "updated_at": "2016-09-01T02:37:11Z",
+    "image_id": "d164b5df-1bc3-4c3f-893e-3e471fd16e64",
+    "member_id": "edc89b490d7d4392898e19b2deb34797",
+    "schema": "/v2/schemas/member"
 }
-
                                          
-
-
                                          + +

                                          • Returned Values

                                          • Normal

                                            200

                                          • Abnormal -

                                            Returned Value

                                            +
                                            - - - - - - - - - - - - - diff --git a/docs/ims/api-ref/en-us_topic_0036994319.html b/docs/ims/api-ref/en-us_topic_0036994319.html index 2c3d7eab0..20386dbe6 100644 --- a/docs/ims/api-ref/en-us_topic_0036994319.html +++ b/docs/ims/api-ref/en-us_topic_0036994319.html @@ -1,6 +1,6 @@ -

                                            Querying Image Member Details (Native OpenStack API)

                                            +

                                            Querying Image Sharing Member Details (Native OpenStack API)

                                            Function

                                            This API is used to query details about a tenant with whom the image is shared.

                                            URI

                                            GET /v2/images/{image_id}/members/{member_id}

                                            @@ -38,121 +38,122 @@

                                            Returned Value

                                            Description

                                            +

                                            Description

                                            400 Bad Request

                                            +

                                            400 Bad Request

                                            Request error.

                                            +

                                            Request error.

                                            401 Unauthorized

                                            +

                                            401 Unauthorized

                                            Authentication failed.

                                            +

                                            Authentication failed.

                                            403 Forbidden

                                            +

                                            403 Forbidden

                                            You do not have the rights to perform the operation.

                                            +

                                            You do not have the rights to perform the operation.

                                            404 Not Found

                                            +

                                            404 Not Found

                                            The requested resource was not found.

                                            +

                                            The requested resource was not found.

                                            500 Internal Server Error

                                            +

                                            500 Internal Server Error

                                            Internal service error.

                                            +

                                            Internal service error.

                                            503 Service Unavailable

                                            +

                                            503 Service Unavailable

                                            The service is unavailable.

                                            +

                                            The service is unavailable.
                                            -

                                            Request

                                            • Request parameters

                                              None

                                              -
                                            • Example request
                                              GET https://{Endpoint}/v2/images/d164b5df-1bc3-4c3f-893e-3e471fd16e64/members/edc89b490d7d4392898e19b2deb34797
                                              -
                                            +

                                            Request

                                            Request parameters

                                            +

                                            None

                                            +
                                            +

                                            Example Request

                                            Querying image sharing member details

                                            +
                                            GET https://{Endpoint}/v2/images/d164b5df-1bc3-4c3f-893e-3e471fd16e64/members/edc89b490d7d4392898e19b2deb34797

                                            Response

                                            • Response parameters -

                                              Parameter

                                              +
                                              - - - - - - - - - - - - - - - - - - - -

                                              Parameter

                                              Type

                                              +

                                              Type

                                              Description

                                              +

                                              Description

                                              status

                                              +

                                              status

                                              String

                                              +

                                              String

                                              Specifies the image sharing status.

                                              +

                                              Specifies the image sharing status.

                                              created_at

                                              +

                                              created_at

                                              String

                                              +

                                              String

                                              Specifies the time when a shared image was created. The value is in UTC format.

                                              +

                                              Specifies the time when a shared image was created. The value is in UTC format.

                                              updated_at

                                              +

                                              updated_at

                                              String

                                              +

                                              String

                                              Specifies the time when a shared image was updated. The value is in UTC format.

                                              +

                                              Specifies the time when a shared image was updated. The value is in UTC format.

                                              image_id

                                              +

                                              image_id

                                              String

                                              +

                                              String

                                              Specifies the image ID.

                                              +

                                              Specifies the image ID.

                                              member_id

                                              +

                                              member_id

                                              String

                                              +

                                              String

                                              Specifies the member ID.

                                              +

                                              Specifies the member ID.

                                              schema

                                              +

                                              schema

                                              String

                                              +

                                              String

                                              Specifies the sharing schema.

                                              +

                                              Specifies the sharing schema.
                                            • Example response
                                              STATUS CODE 200
                                              -
                                              1
-2
-3
-4
-5
-6
-7
-8
                                              {
-    "status": "accepted",
-    "created_at": "2016-09-01T02:05:14Z",
-    "updated_at": "2016-09-01T02:37:11Z",
-    "image_id": "d164b5df-1bc3-4c3f-893e-3e471fd16e64",
-    "member_id": "edc89b490d7d4392898e19b2deb34797",
-    "schema": "/v2/schemas/member"
+
                                              1
+2
+3
+4
+5
+6
+7
+8
                                              {
+    "status": "accepted",
+    "created_at": "2016-09-01T02:05:14Z",
+    "updated_at": "2016-09-01T02:37:11Z",
+    "image_id": "d164b5df-1bc3-4c3f-893e-3e471fd16e64",
+    "member_id": "edc89b490d7d4392898e19b2deb34797",
+    "schema": "/v2/schemas/member"
 }
-
                                              
-
-
                                              + +

                                              • Returned Values

                                              • Normal

                                                200

                                              • Abnormal -

                                                Returned Value

                                                +
                                                - - - - - - - - - - - - - diff --git a/docs/ims/api-ref/en-us_topic_0036994320.html b/docs/ims/api-ref/en-us_topic_0036994320.html index 7833660f4..b8deea42c 100644 --- a/docs/ims/api-ref/en-us_topic_0036994320.html +++ b/docs/ims/api-ref/en-us_topic_0036994320.html @@ -1,6 +1,6 @@ -

                                                Querying Image Members (Native OpenStack API)

                                                +

                                                Querying Image Sharing Members (Native OpenStack API)

                                                Function

                                                This API is used to query the tenants with whom an image is shared using search criteria and to display the tenants in a list.

                                                URI

                                                GET /v2/images/{image_id}/members

                                                @@ -29,158 +29,159 @@
                                                -

                                                Request

                                                • Request parameters

                                                  None

                                                  -
                                                • Example request
                                                  GET https://{Endpoint}/v2/images/d164b5df-1bc3-4c3f-893e-3e471fd16e64/members
                                                  -
                                                +

                                                Request

                                                Request parameters

                                                +

                                                None

                                                +
                                                +

                                                Example Request

                                                Querying image sharing members

                                                +
                                                GET https://{Endpoint}/v2/images/d164b5df-1bc3-4c3f-893e-3e471fd16e64/members

                                                Response

                                                • Response parameters -

                                                Returned Value

                                                Description

                                                +

                                                Description

                                                400 Bad Request

                                                +

                                                400 Bad Request

                                                Request error.

                                                +

                                                Request error.

                                                401 Unauthorized

                                                +

                                                401 Unauthorized

                                                Authentication failed.

                                                +

                                                Authentication failed.

                                                403 Forbidden

                                                +

                                                403 Forbidden

                                                You do not have the rights to perform the operation.

                                                +

                                                You do not have the rights to perform the operation.

                                                404 Not Found

                                                +

                                                404 Not Found

                                                The requested resource was not found.

                                                +

                                                The requested resource was not found.

                                                500 Internal Server Error

                                                +

                                                500 Internal Server Error

                                                Internal service error.

                                                +

                                                Internal service error.

                                                503 Service Unavailable

                                                +

                                                503 Service Unavailable

                                                The service is unavailable.

                                                +

                                                The service is unavailable.

                                                Parameter

                                                +
                                                - - - - - - - -

                                                Parameter

                                                Type

                                                +

                                                Type

                                                Description

                                                +

                                                Description

                                                members

                                                +

                                                members

                                                Array of objects

                                                +

                                                Array of objects

                                                Specifies the members.

                                                +

                                                Specifies the members.

                                                For details, see Table 2.

                                                schema

                                                +

                                                schema

                                                String

                                                +

                                                String

                                                Specifies the sharing schema.

                                                +

                                                Specifies the sharing schema.
                                                -
                                                Table 2 Data structure description of the members field

                                                Parameter

                                                +
                                                - - - - - - - - - - - - - - - - - - - -
                                                Table 2 Data structure description of the members field

                                                Parameter

                                                Type

                                                +

                                                Type

                                                Description

                                                +

                                                Description

                                                status

                                                +

                                                status

                                                String

                                                +

                                                String

                                                Specifies the image sharing status.

                                                +

                                                Specifies the image sharing status.

                                                created_at

                                                +

                                                created_at

                                                String

                                                +

                                                String

                                                Specifies the time when a shared image was created. The value is in UTC format.

                                                +

                                                Specifies the time when a shared image was created. The value is in UTC format.

                                                updated_at

                                                +

                                                updated_at

                                                String

                                                +

                                                String

                                                Specifies the time when a shared image was updated. The value is in UTC format.

                                                +

                                                Specifies the time when a shared image was updated. The value is in UTC format.

                                                image_id

                                                +

                                                image_id

                                                String

                                                +

                                                String

                                                Specifies the image ID.

                                                +

                                                Specifies the image ID.

                                                member_id

                                                +

                                                member_id

                                                String

                                                +

                                                String

                                                Specifies the member ID.

                                                +

                                                Specifies the member ID.

                                                schema

                                                +

                                                schema

                                                String

                                                +

                                                String

                                                Specifies the sharing schema.

                                                +

                                                Specifies the sharing schema.
                                              • Example response
                                                STATUS CODE 200
                                                -
                                                 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
-11
-12
-13
                                                {
-    "members": [
-        {
-            "status": "accepted",
-            "created_at": "2016-09-01T02:05:14Z",
-            "updated_at": "2016-09-01T02:37:11Z",
-            "image_id": "d164b5df-1bc3-4c3f-893e-3e471fd16e64",
-            "member_id": "edc89b490d7d4392898e19b2deb34797",
-            "schema": "/v2/schemas/member"
-        }
-    ],
-    "schema": "/v2/schemas/members"
+
                                                 1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
+13
                                                {
+    "members": [
+        {
+            "status": "accepted",
+            "created_at": "2016-09-01T02:05:14Z",
+            "updated_at": "2016-09-01T02:37:11Z",
+            "image_id": "d164b5df-1bc3-4c3f-893e-3e471fd16e64",
+            "member_id": "edc89b490d7d4392898e19b2deb34797",
+            "schema": "/v2/schemas/member"
+        }
+    ],
+    "schema": "/v2/schemas/members"
 }
-
                                                
-
-
                                                + +

                                                • Returned Values

                                                • Normal

                                                  200

                                                • Abnormal -

                                                  Returned Value

                                                  +
                                                  - - - - - - - - - - - - - diff --git a/docs/ims/api-ref/en-us_topic_0036994321.html b/docs/ims/api-ref/en-us_topic_0036994321.html index 6e50b8ff8..891308a40 100644 --- a/docs/ims/api-ref/en-us_topic_0036994321.html +++ b/docs/ims/api-ref/en-us_topic_0036994321.html @@ -1,6 +1,6 @@ -

                                                  Deleting an Image Member (Native OpenStack API)

                                                  +

                                                  Deleting an Image Sharing Member (Native OpenStack API)

                                                  Function

                                                  This API is used to stop image sharing by deleting the tenant with whom the image is shared.

                                                  URI

                                                  DELETE /v2/images/{image_id}/members/{member_id}

                                                  @@ -38,9 +38,11 @@
                                                  -

                                                  Request

                                                  • Request parameters

                                                    None

                                                    -
                                                  • Example request
                                                    DELETE https://{Endpoint}/v2/images/d164b5df-1bc3-4c3f-893e-3e471fd16e64/members/edc89b490d7d4392898e19b2deb34797
                                                    -
                                                  +

                                                  Request

                                                  Request parameters

                                                  +

                                                  None

                                                  +
                                                  +

                                                  Example Request

                                                  Deleting an image sharing member

                                                  +
                                                  DELETE https://{Endpoint}/v2/images/d164b5df-1bc3-4c3f-893e-3e471fd16e64/members/edc89b490d7d4392898e19b2deb34797

                                                  Response

                                                  • Response parameters

                                                    None

                                                  • Example response
                                                    204 No Content
                                                    @@ -48,40 +50,40 @@

                                                  Returned Values

                                                  • Normal

                                                    204

                                                  • Abnormal -

                                                  Returned Value

                                                  Description

                                                  +

                                                  Description

                                                  400 Bad Request

                                                  +

                                                  400 Bad Request

                                                  Request error.

                                                  +

                                                  Request error.

                                                  401 Unauthorized

                                                  +

                                                  401 Unauthorized

                                                  Authentication failed.

                                                  +

                                                  Authentication failed.

                                                  403 Forbidden

                                                  +

                                                  403 Forbidden

                                                  You do not have the rights to perform the operation.

                                                  +

                                                  You do not have the rights to perform the operation.

                                                  404 Not Found

                                                  +

                                                  404 Not Found

                                                  The requested resource was not found.

                                                  +

                                                  The requested resource was not found.

                                                  500 Internal Server Error

                                                  +

                                                  500 Internal Server Error

                                                  Internal service error.

                                                  +

                                                  Internal service error.

                                                  503 Service Unavailable

                                                  +

                                                  503 Service Unavailable

                                                  The service is unavailable.

                                                  +

                                                  The service is unavailable.

                                                  Returned Value

                                                  +
                                                  - - - - - - - - - - - - - diff --git a/docs/ims/api-ref/en-us_topic_0036994322.html b/docs/ims/api-ref/en-us_topic_0036994322.html index 38935dfe2..228a1dfb0 100644 --- a/docs/ims/api-ref/en-us_topic_0036994322.html +++ b/docs/ims/api-ref/en-us_topic_0036994322.html @@ -1,10 +1,10 @@ -

                                                  Adding Image Members in Batches

                                                  +

                                                  Adding Image Sharing Members

                                                  Function

                                                  This API is an extension one and used to share more than one image with multiple tenants.

                                                  -

                                                  This API is an asynchronous one. If job_id is returned, the task is successfully delivered. You need to query the status of the asynchronous task. If the status is success, the task is successfully executed. If the status is failed, the task fails. For details about how to query the status of an asynchronous task, see Asynchronous Job Query.

                                                  +

                                                  This API is an asynchronous one. If job_id is returned, the task is successfully delivered. You need to query the status of the asynchronous task. If the status is success, the task is successfully executed. If the status is failed, the task fails. For details about how to query the status of an asynchronous task, see Querying the Status of an Asynchronous Job.

                                                  -

                                                  Constraints

                                                  For encrypted images, you need to authorize the keys used by the images before adding members for them. For details, see "How Do I Authorize a Key?" in Image Management Service User Guide.

                                                  +

                                                  Constraints

                                                  For encrypted images, you need to authorize the keys used by the images before you use this API. For details, see "How Do I Authorize a Key?" in Image Management Service User Guide.

                                                  URI

                                                  POST /v1/cloudimages/members

                                                  @@ -39,99 +39,100 @@

                                                  Returned Value

                                                  Description

                                                  +

                                                  Description

                                                  400 Bad Request

                                                  +

                                                  400 Bad Request

                                                  Request error.

                                                  +

                                                  Request error.

                                                  401 Unauthorized

                                                  +

                                                  401 Unauthorized

                                                  Authentication failed.

                                                  +

                                                  Authentication failed.

                                                  403 Forbidden

                                                  +

                                                  403 Forbidden

                                                  You do not have the rights to perform the operation.

                                                  +

                                                  You do not have the rights to perform the operation.

                                                  404 Not Found

                                                  +

                                                  404 Not Found

                                                  The requested resource was not found.

                                                  +

                                                  The requested resource was not found.

                                                  500 Internal Server Error

                                                  +

                                                  500 Internal Server Error

                                                  Internal service error.

                                                  +

                                                  Internal service error.

                                                  503 Service Unavailable

                                                  +

                                                  503 Service Unavailable

                                                  The service is unavailable.

                                                  +

                                                  The service is unavailable.
                                                  -
                                                  -
                                                • Example request
                                                  POST https://{Endpoint}/v1/cloudimages/members
                                                  -
                                                   1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
                                                  {
-    "images": [
-        "d164b5df-1bc3-4c3f-893e-3e471fd16e64",
-        "0b680482-acaa-4045-b14c-9a8c7dfe9c70"
-    ],
-    "projects": [
-        "9c61004714024f9586705d090530f9fa",
-        "edc89b490d7d4392898e19b2deb34797"
-    ]
-}
-
                                                  -
                                                  • +

                                                  Example Request

                                                  Adding tenants who can use shared images (image IDs: d164b5df-1bc3-4c3f-893e-3e471fd16e64, 0b680482-acaa-4045-b14c-9a8c7dfe9c70; project IDs: 9c61004714024f9586705d090530f9fa, edc89b490d7d4392898e19b2deb34797)

                                                  +
                                                   1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
                                                  POST https://{Endpoint}/v1/cloudimages/members
+{
+    "images": [
+        "d164b5df-1bc3-4c3f-893e-3e471fd16e64",
+        "0b680482-acaa-4045-b14c-9a8c7dfe9c70"
+    ],
+    "projects": [
+        "9c61004714024f9586705d090530f9fa",
+        "edc89b490d7d4392898e19b2deb34797"
+    ]
+}
+
                                                  +
                                                  +

                                                  Response

                                                  • Response parameters -

                                                    Parameter

                                                    +
                                                    - - - - -

                                                    Parameter

                                                    Type

                                                    +

                                                    Type

                                                    Description

                                                    +

                                                    Description

                                                    job_id

                                                    +

                                                    job_id

                                                    String

                                                    +

                                                    String

                                                    Specifies the asynchronous task ID.

                                                    -

                                                    For details, see Asynchronous Job Query.

                                                    +

                                                    Specifies the asynchronous job ID.

                                                    +

                                                    For details, see Querying the Status of an Asynchronous Job.
                                                  • Example response
                                                    STATUS CODE 200
                                                    -
                                                    1
-2
-3
                                                    {
-    "job_id": "edc89b490d7d4392898e19b2deb34797"
+
                                                    1
+2
+3
                                                    {
+    "job_id": "edc89b490d7d4392898e19b2deb34797"
 }
-
                                                    
-
-
                                                    + +

                                                    • Returned Values

                                                    • Normal

                                                      200

                                                    • Abnormal -

                                                      Returned Value

                                                      +
                                                      - - - - - - - - - - - - - diff --git a/docs/ims/api-ref/en-us_topic_0036994323.html b/docs/ims/api-ref/en-us_topic_0036994323.html index 85cde2fb5..bfeb232ec 100644 --- a/docs/ims/api-ref/en-us_topic_0036994323.html +++ b/docs/ims/api-ref/en-us_topic_0036994323.html @@ -1,58 +1,58 @@ -

                                                      Updating the Status of Image Members in Batches

                                                      +

                                                      Updating the Sharing Status for Images

                                                      Function

                                                      This API is an extension one and used to update the image sharing status after the tenant accepts or rejects the shared images.

                                                      -

                                                      This API is an asynchronous one. If job_id is returned, the task is successfully delivered. You need to query the status of the asynchronous task. If the status is success, the task is successfully executed. If the status is failed, the task fails. For details about how to query the status of an asynchronous task, see Asynchronous Job Query.

                                                      +

                                                      This API is an asynchronous one. If job_id is returned, the task is successfully delivered. You need to query the status of the asynchronous task. If the status is success, the task is successfully executed. If the status is failed, the task fails. For details about how to query the status of an asynchronous task, see Querying the Status of an Asynchronous Job.

                                                      URI

                                                      PUT /v1/cloudimages/members

                                                      -

                                                      Request

                                                      • Request parameters -

                                                      Returned Value

                                                      Description

                                                      +

                                                      Description

                                                      400 Bad Request

                                                      +

                                                      400 Bad Request

                                                      Request error. For details, see Error Codes.

                                                      +

                                                      Request error. For details, see Error Codes.

                                                      401 Unauthorized

                                                      +

                                                      401 Unauthorized

                                                      Authentication failed.

                                                      +

                                                      Authentication failed.

                                                      403 Forbidden

                                                      +

                                                      403 Forbidden

                                                      You do not have the rights to perform the operation.

                                                      +

                                                      You do not have the rights to perform the operation.

                                                      404 Not Found

                                                      +

                                                      404 Not Found

                                                      The requested resource was not found.

                                                      +

                                                      The requested resource was not found.

                                                      500 Internal Server Error

                                                      +

                                                      500 Internal Server Error

                                                      Internal service error.

                                                      +

                                                      Internal service error.

                                                      503 Service Unavailable

                                                      +

                                                      503 Service Unavailable

                                                      The service is unavailable.

                                                      +

                                                      The service is unavailable.

                                                      Parameter

                                                      +

                                                      Request

                                                      Request parameters +
                                                      - - - - - - - - - - - - - - - - - - - @@ -60,116 +60,116 @@

                                                      Parameter

                                                      Mandatory

                                                      +

                                                      Mandatory

                                                      Type

                                                      +

                                                      Type

                                                      Description

                                                      +

                                                      Description

                                                      images

                                                      +

                                                      images

                                                      Yes

                                                      +

                                                      Yes

                                                      Array of strings

                                                      +

                                                      Array of strings

                                                      Specifies the image IDs.

                                                      +

                                                      Specifies the image IDs.

                                                      project_id

                                                      +

                                                      project_id

                                                      Yes

                                                      +

                                                      Yes

                                                      String

                                                      +

                                                      String

                                                      Specifies the project ID.

                                                      +

                                                      Specifies the project ID.

                                                      status

                                                      +

                                                      status

                                                      Yes

                                                      +

                                                      Yes

                                                      String

                                                      +

                                                      String

                                                      Specifies whether a shared image will be accepted or declined.

                                                      +

                                                      Specifies whether a shared image will be accepted or declined.

                                                      The value can be one of the following:

                                                      • accepted: indicates that a shared image is accepted. After an image is accepted, the image is displayed in the image list. You can use the image to create ECSs.
                                                      • rejected: indicates that a shared image is declined. After an image is declined, the image is not displayed in the image list. However, you can still use the image to create ECSs.

                                                      vault_id

                                                      +

                                                      vault_id

                                                      No

                                                      +

                                                      No

                                                      String

                                                      +

                                                      String

                                                      Specifies the ID of a vault.

                                                      +

                                                      Specifies the ID of a vault.

                                                      This parameter is mandatory if you want to accept a shared full-ECS image created from a CBR backup.

                                                      You can obtain the vault ID from the CBR console or section "Querying the Vault List" in Cloud Backup and Recovery API Reference.
                                                      -
                                                    • Example request
                                                      • If the shared images do not include full-ECS images:
                                                        PUT https://{Endpoint}/v1/cloudimages/members
                                                        -
                                                        1
-2
-3
-4
-5
-6
-7
-8
                                                        {
-   "images": [
-          "d164b5df-1bc3-4c3f-893e-3e471fd16e64",
-          "0b680482-acaa-4045-b14c-9a8c7dfe9c70"
-      ],
-      "project_id": "edc89b490d7d4392898e19b2deb34797",
-      "status": "accepted"
-}
-
                                                        -
                                                        -
                                                      • If the shared images include full-ECS images:
                                                        PUT https://{Endpoint}/v1/cloudimages/members
                                                        -
                                                        1
-2
-3
-4
-5
-6
-7
-8
-9
                                                        {
-   "images": [
-          "d164b5df-1bc3-4c3f-893e-3e471fd16e64",
-          "0b680482-acaa-4045-b14c-9a8c7dfe9c70"
-      ],
-      "project_id": "edc89b490d7d4392898e19b2deb34797",
-      "status": "accepted",
-      "vault_id": "d14r5tef-1bc3-4c4f-823e-3e471rg65e65"
-}
-
                                                        -
                                                        -
                                                      +

                                                      Example Request

                                                      • Updating the image sharing status to accepted in batches
                                                        1
+2
+3
+4
+5
+6
+7
+8
+9
                                                        PUT https://{Endpoint}/v1/cloudimages/members
+{
+   "images": [
+          "d164b5df-1bc3-4c3f-893e-3e471fd16e64",
+          "0b680482-acaa-4045-b14c-9a8c7dfe9c70"
+      ],
+      "project_id": "edc89b490d7d4392898e19b2deb34797",
+      "status": "accepted"
+}
+
                                                        +
                                                        +
                                                      • Updating the sharing status of images created from CBR backups to accepted in batches (vault ID: d14r5tef-1bc3-4c4f-823e-3e471rg65e65)
                                                         1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
                                                        PUT https://{Endpoint}/v1/cloudimages/members
+{
+   "images": [
+          "d164b5df-1bc3-4c3f-893e-3e471fd16e64",
+          "0b680482-acaa-4045-b14c-9a8c7dfe9c70"
+      ],
+      "project_id": "edc89b490d7d4392898e19b2deb34797",
+      "status": "accepted",
+      "vault_id": "d14r5tef-1bc3-4c4f-823e-3e471rg65e65"
+}
+
                                                        +

                                                      Response

                                                      • Response parameters -

                                                        Parameter

                                                        +
                                                        - - - - -

                                                        Parameter

                                                        Type

                                                        +

                                                        Type

                                                        Description

                                                        +

                                                        Description

                                                        job_id

                                                        +

                                                        job_id

                                                        String

                                                        +

                                                        String

                                                        Specifies the asynchronous job ID.

                                                        -

                                                        For details, see Asynchronous Job Query.

                                                        +

                                                        Specifies the asynchronous job ID.

                                                        +

                                                        For details, see Querying the Status of an Asynchronous Job.
                                                      • Example response
                                                        STATUS CODE 200
                                                        -
                                                        1
-2
-3
                                                        {
-    "job_id": "edc89b490d7d4392898e19b2deb34797"
+
                                                        1
+2
+3
                                                        {
+    "job_id": "edc89b490d7d4392898e19b2deb34797"
 }
-
                                                        
-
-
                                                        + +

                                                        • Returned Values

                                                        • Normal

                                                          200

                                                        • Abnormal -

                                                          Returned Value

                                                          +
                                                          - - - - - - - - - - - - - diff --git a/docs/ims/api-ref/en-us_topic_0036994324.html b/docs/ims/api-ref/en-us_topic_0036994324.html index 724307c79..fe88d2ef9 100644 --- a/docs/ims/api-ref/en-us_topic_0036994324.html +++ b/docs/ims/api-ref/en-us_topic_0036994324.html @@ -1,135 +1,136 @@ -

                                                          Deleting Image Members in Batches

                                                          -

                                                          Function

                                                          This API is an extension one and used to stop sharing images by deleting tenants with whom the image is shared in batches.

                                                          -

                                                          This API is an asynchronous one. If job_id is returned, the task is successfully delivered. You need to query the status of the asynchronous task. If the status is success, the task is successfully executed. If the status is failed, the task fails. For details about how to query the status of an asynchronous task, see Asynchronous Job Query.

                                                          +

                                                          Deleting Image Sharing Members

                                                          +

                                                          Function

                                                          This API is an extension one and used to stop sharing images by deleting tenants the image is shared with.

                                                          +

                                                          This API is an asynchronous one. If job_id is returned, the task is successfully delivered. You need to query the status of the asynchronous task. If the status is success, the task is successfully executed. If the status is failed, the task fails. For details about how to query the status of an asynchronous task, see Querying the Status of an Asynchronous Job.

                                                          URI

                                                          DELETE /v1/cloudimages/members

                                                          -

                                                          Request

                                                          • Request parameters -

                                                          Returned Value

                                                          Description

                                                          +

                                                          Description

                                                          400 Bad Request

                                                          +

                                                          400 Bad Request

                                                          Request error. For details, see Error Codes.

                                                          +

                                                          Request error. For details, see Error Codes.

                                                          401 Unauthorized

                                                          +

                                                          401 Unauthorized

                                                          Authentication failed.

                                                          +

                                                          Authentication failed.

                                                          403 Forbidden

                                                          +

                                                          403 Forbidden

                                                          You do not have the rights to perform the operation.

                                                          +

                                                          You do not have the rights to perform the operation.

                                                          404 Not Found

                                                          +

                                                          404 Not Found

                                                          The requested resource was not found.

                                                          +

                                                          The requested resource was not found.

                                                          500 Internal Server Error

                                                          +

                                                          500 Internal Server Error

                                                          Internal service error.

                                                          +

                                                          Internal service error.

                                                          503 Service Unavailable

                                                          +

                                                          503 Service Unavailable

                                                          The service is unavailable.

                                                          +

                                                          The service is unavailable.

                                                          Parameter

                                                          +

                                                          Request

                                                          Request parameters +
                                                          - - - - - - - - - - -

                                                          Parameter

                                                          Mandatory

                                                          +

                                                          Mandatory

                                                          Type

                                                          +

                                                          Type

                                                          Description

                                                          +

                                                          Description

                                                          images

                                                          +

                                                          images

                                                          Yes

                                                          +

                                                          Yes

                                                          Array of strings

                                                          +

                                                          Array of strings

                                                          Specifies the image IDs.

                                                          +

                                                          Specifies the image IDs.

                                                          projects

                                                          +

                                                          projects

                                                          Yes

                                                          +

                                                          Yes

                                                          Array of strings

                                                          +

                                                          Array of strings

                                                          Specifies the project IDs.

                                                          +

                                                          Specifies the project IDs.
                                                          -
                                                        • Example request
                                                          DELETE https://{Endpoint}/v1/cloudimages/members
                                                          -
                                                           1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
                                                          {
-  "images": [
-        "d164b5df-1bc3-4c3f-893e-3e471fd16e64",
-        "0b680482-acaa-4045-b14c-9a8c7dfe9c70"
-  ],
-  "projects": [
-        "9c61004714024f9586705d090530f9fa",
-        "edc89b490d7d4392898e19b2deb34797"
-    ]
-}
-
                                                          -
                                                          -
                                                          • +
                                                          +

                                                          Example Request

                                                          Deleting image recipients who can use shared images (image IDs: d164b5df-1bc3-4c3f-893e-3e471fd16e64, 0b680482-acaa-4045-b14c-9a8c7dfe9c70; project IDs: 9c61004714024f9586705d090530f9fa, edc89b490d7d4392898e19b2deb34797)

                                                          +
                                                           1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
                                                          DELETE https://{Endpoint}/v1/cloudimages/members
+{
+  "images": [
+        "d164b5df-1bc3-4c3f-893e-3e471fd16e64",
+        "0b680482-acaa-4045-b14c-9a8c7dfe9c70"
+  ],
+  "projects": [
+        "9c61004714024f9586705d090530f9fa",
+        "edc89b490d7d4392898e19b2deb34797"
+    ]
+}
+
                                                          +

                                                          Response

                                                          • Response parameters -

                                                            Parameter

                                                            +
                                                            - - - - -

                                                            Parameter

                                                            Type

                                                            +

                                                            Type

                                                            Description

                                                            +

                                                            Description

                                                            job_id

                                                            +

                                                            job_id

                                                            String

                                                            +

                                                            String

                                                            Specifies the asynchronous task ID.

                                                            -

                                                            For details, see Asynchronous Job Query.

                                                            +

                                                            Specifies the asynchronous job ID.

                                                            +

                                                            For details, see Querying the Status of an Asynchronous Job.
                                                          • Example response
                                                            STATUS CODE 200
                                                            -
                                                            1
-2
-3
                                                            {
-    "job_id": "edc89b490d7d4392898e19b2deb34797"
+
                                                            1
+2
+3
                                                            {
+    "job_id": "edc89b490d7d4392898e19b2deb34797"
 }
-
                                                            
-
-
                                                            + +

                                                            • Returned Values

                                                            • Normal

                                                              200

                                                            • Abnormal -

                                                              Returned Value

                                                              +
                                                              - - - - - - - - - - - - - diff --git a/docs/ims/api-ref/en-us_topic_0037131984.html b/docs/ims/api-ref/en-us_topic_0037131984.html index 3b3294fd9..df8c82554 100644 --- a/docs/ims/api-ref/en-us_topic_0037131984.html +++ b/docs/ims/api-ref/en-us_topic_0037131984.html @@ -3,7 +3,7 @@

                                                              Registering an Image

                                                              Function

                                                              This API is used to register an image file as an uninitialized private image on the cloud platform.

                                                              The following describes how to use this API:

                                                              -
                                                              1. Upload the image file to an OBS bucket. For details, see "Object Storage Service User Guide".
                                                              2. Use the image metadata creation API to create image metadata. After the API is invoked successfully, save the image ID. For how to create image metadata, see Creating Image Metadata (Native OpenStack API).
                                                              3. Use the API for registering images and the image ID obtained in 2 to register the image file as a private image.
                                                              4. After the API is successfully invoked as an asynchronous one, the cloud service system receives a request. Query the image status using the image ID and check whether the image file is successfully registered. When the image status changes to active, the image file is successfully registered as a private image.

                                                                For details about how to query the status of an asynchronous task, see Asynchronous Job Query.

                                                                +
                                                                1. Upload the image file to an OBS bucket. For details, see "Object Storage Service User Guide".
                                                                2. Use the image metadata creation API to create image metadata. After the API is invoked successfully, save the image ID. For how to create image metadata, see Creating Image Metadata (Native OpenStack API).
                                                                3. Use the API for registering images and the image ID obtained in 2 to register the image file as a private image.
                                                                4. After the API is successfully invoked as an asynchronous one, the cloud service system receives a request. Query the image status using the image ID and check whether the image file is successfully registered. When the image status changes to active, the image file is successfully registered as a private image.

                                                                  For details about how to query the status of an asynchronous task, see Querying the Status of an Asynchronous Job.

                                                                Before registering an image file, ensure that you have the Tenant Administrator permission for OBS.

                                                                @@ -27,7 +27,7 @@
                                                              @@ -60,76 +60,77 @@

                                                              Returned Value

                                                              Description

                                                              +

                                                              Description

                                                              400 Bad Request

                                                              +

                                                              400 Bad Request

                                                              Request error. For details, see Error Codes.

                                                              +

                                                              Request error. For details, see Error Codes.

                                                              401 Unauthorized

                                                              +

                                                              401 Unauthorized

                                                              Authentication failed.

                                                              +

                                                              Authentication failed.

                                                              403 Forbidden

                                                              +

                                                              403 Forbidden

                                                              You do not have the rights to perform the operation.

                                                              +

                                                              You do not have the rights to perform the operation.

                                                              404 Not Found

                                                              +

                                                              404 Not Found

                                                              The requested resource was not found.

                                                              +

                                                              The requested resource was not found.

                                                              500 Internal Server Error

                                                              +

                                                              500 Internal Server Error

                                                              Internal service error.

                                                              +

                                                              Internal service error.

                                                              503 Service Unavailable

                                                              +

                                                              503 Service Unavailable

                                                              The service is unavailable.

                                                              +

                                                              The service is unavailable.

                                                              String

                                                              Specifies the image ID.

                                                              -
                                                              • image_id is the ID of the image you created by invoking the API for creating image metadata. Registration may fail if you use other image IDs.
                                                              • After this API is invoked, you can check the image status with the image ID. When the image status changes to active, the image file is successfully registered. For details, see Querying Image Details (Native OpenStack API).
                                                              +
                                                              • image_id is the ID of the image you created by invoking the API for creating image metadata. Registration may fail if you use other image IDs.
                                                              • After this API is invoked, you can check the image status with the image ID. When the image status changes to active, the image file is successfully registered. For details, see Querying Image Details (Native OpenStack API).
                                                              -
                                                              -
                                                            • Example request
                                                              PUT https://{Endpoint}/v1/cloudimages/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba86/upload
                                                              -
                                                              1
-2
-3
                                                              {
-   "image_url": "bucketname:Centos6.5-disk1.vmdk" 
-}
-
                                                              -
                                                              • +

                                                              Example Request

                                                              Registering an image (URL of the image file: bucketname:Centos6.5-disk1.vmdk)

                                                              +
                                                              1
+2
+3
+4
                                                              PUT https://{Endpoint}/v1/cloudimages/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba86/upload
+{
+   "image_url": "bucketname:Centos6.5-disk1.vmdk" 
+}
+
                                                              +
                                                              +

                                                              Response

                                                              • Response parameters -

                                                                Parameter

                                                                +
                                                                - - - - -

                                                                Parameter

                                                                Type

                                                                +

                                                                Type

                                                                Description

                                                                +

                                                                Description

                                                                job_id

                                                                +

                                                                job_id

                                                                String

                                                                +

                                                                String

                                                                Specifies the asynchronous job ID.

                                                                -

                                                                For details, see Asynchronous Job Query.

                                                                +

                                                                Specifies the asynchronous job ID.

                                                                +

                                                                For details, see Querying the Status of an Asynchronous Job.
                                                              • Example response
                                                                HTTP/1.1 200
                                                                -
                                                                1
-2
-3
                                                                {
-   "job_id":" b912fb4a4c464b568ecfca1071b21b10"
+
                                                                1
+2
+3
                                                                {
+   "job_id":" b912fb4a4c464b568ecfca1071b21b10"
 }
-
                                                                
-
-
                                                                + +

                                                                • Returned Values

                                                                • Normal

                                                                  200

                                                                • Abnormal
                                                                -

                                                                Returned Value

                                                                +
                                                                - - - - - - - - - diff --git a/docs/ims/api-ref/en-us_topic_0049147856.html b/docs/ims/api-ref/en-us_topic_0049147856.html index 66f28c104..54ae84d7b 100644 --- a/docs/ims/api-ref/en-us_topic_0049147856.html +++ b/docs/ims/api-ref/en-us_topic_0049147856.html @@ -2,7 +2,7 @@

                                                                Replicating an Image Within a Region

                                                                Function

                                                                This API is an extension one and is used to copy an existing image to another image. When replicating an image, you can change the image attributes to meet the requirements of different scenarios.

                                                                -

                                                                This API is an asynchronous one. If job_id is returned, the task is successfully delivered. You need to query the status of the asynchronous task. If the status is success, the task is successfully executed. If the status is failed, the task fails. For details about how to query the status of an asynchronous task, see Asynchronous Job Query.

                                                                +

                                                                This API is an asynchronous one. If job_id is returned, the task is successfully delivered. You need to query the status of the asynchronous task. If the status is success, the task is successfully executed. If the status is failed, the task fails. For details about how to query the status of an asynchronous task, see Querying the Status of an Asynchronous Job.

                                                                Constraints

                                                                • Full-ECS images cannot be replicated.
                                                                @@ -77,96 +77,97 @@
                                                                -

                                                                Returned Value

                                                                Description

                                                                +

                                                                Description

                                                                400 Bad Request

                                                                +

                                                                400 Bad Request

                                                                Request error. For details about the returned error code, see Error Codes.

                                                                +

                                                                Request error. For details about the returned error code, see Error Codes.

                                                                401 Unauthorized

                                                                +

                                                                401 Unauthorized

                                                                Authentication failed.

                                                                +

                                                                Authentication failed.

                                                                403 Forbidden

                                                                +

                                                                403 Forbidden

                                                                You do not have the rights to perform the operation.

                                                                +

                                                                You do not have the rights to perform the operation.

                                                                404 Not Found

                                                                +

                                                                404 Not Found

                                                                The requested resource was not found.

                                                                +

                                                                The requested resource was not found.

                                                                String

                                                                Indicates the enterprise project that the image belongs to.

                                                                +

                                                                Specifies the enterprise project that the image belongs to.

                                                                • If the value is 0 or left blank, the image belongs to the default enterprise project.
                                                                • If the value is a UUID, the image belongs to the enterprise project corresponding to the UUID.

                                                                  For more information about enterprise projects and how to obtain enterprise project IDs, see Enterprise Management User Guide.
                                                                -
                                                                -
                                                              • Example request
                                                                POST https://{Endpoint}/v1/cloudimages/465076de-dc36-4aec-80f5-ef9d8009428f/copy
                                                                -
                                                                1
-2
-3
-4
-5
                                                                {
-    "name": "ims_encrypted_copy3",
-    "description": "test copy",
-    "cmk_id": "bd66288c-9081-460a-8227-4cbd0c814cb4"
-}
-
                                                                -
                                                                • +

                                                                Example Request

                                                                Replicating an image (name: ims_encrypted_copy3) within a region

                                                                +
                                                                1
+2
+3
+4
+5
+6
                                                                POST https://{Endpoint}/v1/cloudimages/465076de-dc36-4aec-80f5-ef9d8009428f/copy
+{
+    "name": "ims_encrypted_copy3",
+    "description": "test copy",
+    "cmk_id": "bd66288c-9081-460a-8227-4cbd0c814cb4"
+}
+
                                                                +
                                                                +

                                                                Response

                                                                • Response parameters -

                                                                  Parameter

                                                                  +
                                                                  - - - - -

                                                                  Parameter

                                                                  Type

                                                                  +

                                                                  Type

                                                                  Description

                                                                  +

                                                                  Description

                                                                  job_id

                                                                  +

                                                                  job_id

                                                                  String

                                                                  +

                                                                  String

                                                                  Specifies the asynchronous job ID.

                                                                  -

                                                                  For details, see Asynchronous Job Query.

                                                                  +

                                                                  Specifies the asynchronous job ID.

                                                                  +

                                                                  For details, see Querying the Status of an Asynchronous Job.
                                                                • Example response
                                                                  STATUS CODE 200
                                                                  -
                                                                  1
-2
-3
                                                                  {
-    "job_id": "edc89b490d7d4392898e19b2deb34797"
+
                                                                  1
+2
+3
                                                                  {
+    "job_id": "edc89b490d7d4392898e19b2deb34797"
 }
-
                                                                  
-
-
                                                                  + +

                                                                  • Returned Values

                                                                  • Normal

                                                                    200

                                                                  • Abnormal -

                                                                    Returned Value

                                                                    +
                                                                    - - - - - - - - - - - - - diff --git a/docs/ims/api-ref/en-us_topic_0049147876.html b/docs/ims/api-ref/en-us_topic_0049147876.html index c210dfcfc..17ff0af33 100644 --- a/docs/ims/api-ref/en-us_topic_0049147876.html +++ b/docs/ims/api-ref/en-us_topic_0049147876.html @@ -1,35 +1,37 @@ -

                                                                    Querying an Image Member Schema (Native OpenStack API)

                                                                    -

                                                                    Function

                                                                    This API is used to query an image member schema, which allows you to view image member attributes and their data types.

                                                                    +

                                                                    Querying a Schema for an Image Sharing Member (Native OpenStack API)

                                                                    +

                                                                    Function

                                                                    This API is used to query an image sharing member schema, which allows you to view image sharing member attributes and their data types.

                                                                    URI

                                                                    GET /v2/schemas/member

                                                                    -

                                                                    Request

                                                                    • Request parameters

                                                                      None

                                                                      -
                                                                    • Example request
                                                                      GET https://{Endpoint}/v2/schemas/member
                                                                      -
                                                                    +

                                                                    Request

                                                                    Request parameters

                                                                    +

                                                                    None

                                                                    +
                                                                    +

                                                                    Example Request

                                                                    Querying a schema for an image sharing member

                                                                    +
                                                                    GET https://{Endpoint}/v2/schemas/member

                                                                    Response

                                                                    • Response parameters -

                                                                    Returned Value

                                                                    Description

                                                                    +

                                                                    Description

                                                                    400 Bad Request

                                                                    +

                                                                    400 Bad Request

                                                                    Request error. For details, see Error Codes.

                                                                    +

                                                                    Request error. For details, see Error Codes.

                                                                    401 Unauthorized

                                                                    +

                                                                    401 Unauthorized

                                                                    Authentication failed.

                                                                    +

                                                                    Authentication failed.

                                                                    403 Forbidden

                                                                    +

                                                                    403 Forbidden

                                                                    You do not have the rights to perform the operation.

                                                                    +

                                                                    You do not have the rights to perform the operation.

                                                                    404 Not Found

                                                                    +

                                                                    404 Not Found

                                                                    The requested resource was not found.

                                                                    +

                                                                    The requested resource was not found.

                                                                    500 Internal Server Error

                                                                    +

                                                                    500 Internal Server Error

                                                                    Internal service error.

                                                                    +

                                                                    Internal service error.

                                                                    503 Service Unavailable

                                                                    +

                                                                    503 Service Unavailable

                                                                    The service is unavailable.

                                                                    +

                                                                    The service is unavailable.

                                                                    Parameter

                                                                    +
                                                                    - - - - - - - - @@ -37,116 +39,115 @@

                                                                    Parameter

                                                                    Type

                                                                    +

                                                                    Type

                                                                    Description

                                                                    +

                                                                    Description

                                                                    name

                                                                    +

                                                                    name

                                                                    String

                                                                    +

                                                                    String

                                                                    Specifies the schema name.

                                                                    +

                                                                    Specifies the schema name.

                                                                    properties

                                                                    +

                                                                    properties

                                                                    Object

                                                                    +

                                                                    Object

                                                                    Describes basic image attributes, including the type and usage of each attribute.

                                                                    +

                                                                    Describes basic image attributes, including the type and usage of each attribute.

                                                                    For details about the parameters, see Image Attributes.
                                                                  • Example response
                                                                    STATUS CODE 200
                                                                    -
                                                                     1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
-11
-12
-13
-14
-15
-16
-17
-18
-19
-20
-21
-22
-23
-24
-25
-26
-27
-28
-29
-30
-31
-32
-33
-34
-35
                                                                    {
-    "name": "member",
-    "properties": {
-        "status": {
-            "enum": [
-                "pending",
-                "accepted",
-                "rejected"
-            ],
-            "type": "string",
-            "description": "The status of this image member"
-        },
-        "created_at": {
-            "type": "string",
-            "description": "Date and time of image member creation"
-        },
-        "updated_at": {
-            "type": "string",
-            "description": "Date and time of last modification of image member"
-        },
-        "image_id": {
-            "pattern": "^([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}$",
-            "type": "string",
-            "description": "An identifier for the image"
-        },
-        "member_id": {
-            "type": "string",
-            "description": "An identifier for the image member (tenantId)"
-        },
-        "schema": {
-            "readOnly": true,
-            "type": "string"
-        }
-    }
+
                                                                     1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
+13
+14
+15
+16
+17
+18
+19
+20
+21
+22
+23
+24
+25
+26
+27
+28
+29
+30
+31
+32
+33
+34
+35
                                                                    {
+    "name": "member",
+    "properties": {
+        "status": {
+            "enum": [
+                "pending",
+                "accepted",
+                "rejected"
+            ],
+            "type": "string",
+            "description": "The status of this image member"
+        },
+        "created_at": {
+            "type": "string",
+            "description": "Date and time of image member creation"
+        },
+        "updated_at": {
+            "type": "string",
+            "description": "Date and time of last modification of image member"
+        },
+        "image_id": {
+            "pattern": "^([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}$",
+            "type": "string",
+            "description": "An identifier for the image"
+        },
+        "member_id": {
+            "type": "string",
+            "description": "An identifier for the image member (tenantId)"
+        },
+        "schema": {
+            "readOnly": true,
+            "type": "string"
+        }
+    }
 }
-
                                                                    
-
-
                                                                    + +

                                                                    • Returned Values

                                                                    • Normal

                                                                      200

                                                                    • Abnormal -

                                                                      Returned Value

                                                                      +
                                                                      - - - - - - - - - - - - - diff --git a/docs/ims/api-ref/en-us_topic_0049147877.html b/docs/ims/api-ref/en-us_topic_0049147877.html index e7721602b..0f6539522 100644 --- a/docs/ims/api-ref/en-us_topic_0049147877.html +++ b/docs/ims/api-ref/en-us_topic_0049147877.html @@ -1,43 +1,45 @@ -

                                                                      Querying an Image Member List Schema (Native OpenStack API)

                                                                      -

                                                                      Function

                                                                      This API is used to query an image member list schema, which allows you to view image member attributes and their data types.

                                                                      +

                                                                      Querying a Schema for an Image Sharing Member List (Native OpenStack API)

                                                                      +

                                                                      Function

                                                                      This API is used to query an image sharing member list schema, which allows you to view image sharing member attributes and their data types.

                                                                      URI

                                                                      GET /v2/schemas/members

                                                                      -

                                                                      Request

                                                                      • Request parameters

                                                                        None

                                                                        -
                                                                      • Example request
                                                                        GET https://{Endpoint}/v2/schemas/members
                                                                        -
                                                                      +

                                                                      Request

                                                                      Request parameters

                                                                      +

                                                                      None

                                                                      +
                                                                      +

                                                                      Example Request

                                                                      Querying a schema for an image sharing member list

                                                                      +
                                                                      GET https://{Endpoint}/v2/schemas/members

                                                                      Response

                                                                      • Response parameters -

                                                                      Returned Value

                                                                      Description

                                                                      +

                                                                      Description

                                                                      400 Bad Request

                                                                      +

                                                                      400 Bad Request

                                                                      Request error.

                                                                      +

                                                                      Request error.

                                                                      401 Unauthorized

                                                                      +

                                                                      401 Unauthorized

                                                                      Authentication failed.

                                                                      +

                                                                      Authentication failed.

                                                                      403 Forbidden

                                                                      +

                                                                      403 Forbidden

                                                                      You do not have the rights to perform the operation.

                                                                      +

                                                                      You do not have the rights to perform the operation.

                                                                      404 Not Found

                                                                      +

                                                                      404 Not Found

                                                                      The requested resource was not found.

                                                                      +

                                                                      The requested resource was not found.

                                                                      500 Internal Server Error

                                                                      +

                                                                      500 Internal Server Error

                                                                      Internal service error.

                                                                      +

                                                                      Internal service error.

                                                                      503 Service Unavailable

                                                                      +

                                                                      503 Service Unavailable

                                                                      The service is unavailable.

                                                                      +

                                                                      The service is unavailable.

                                                                      Parameter

                                                                      +
                                                                      - - - - - - - - - - - @@ -45,176 +47,175 @@

                                                                      Parameter

                                                                      Type

                                                                      +

                                                                      Type

                                                                      Description

                                                                      +

                                                                      Description

                                                                      name

                                                                      +

                                                                      name

                                                                      String

                                                                      +

                                                                      String

                                                                      Specifies the schema name.

                                                                      +

                                                                      Specifies the schema name.

                                                                      links

                                                                      +

                                                                      links

                                                                      Array of objects

                                                                      +

                                                                      Array of objects

                                                                      Specifies the URL for accessing the schema.

                                                                      +

                                                                      Specifies the URL for accessing the schema.

                                                                      For details, see Table 1.

                                                                      properties

                                                                      +

                                                                      properties

                                                                      Object

                                                                      +

                                                                      Object

                                                                      Describes basic image attributes, including the type and usage of each attribute.

                                                                      +

                                                                      Describes basic image attributes, including the type and usage of each attribute.

                                                                      For details about the parameters, see Image Attributes.
                                                                      -
                                                                      Table 1 Data structure description of the links field

                                                                      Parameter

                                                                      +
                                                                      - - - - - - - -
                                                                      Table 1 Data structure description of the links field

                                                                      Parameter

                                                                      Type

                                                                      +

                                                                      Type

                                                                      Description

                                                                      +

                                                                      Description

                                                                      href

                                                                      +

                                                                      href

                                                                      String

                                                                      +

                                                                      String

                                                                      Specifies the domain name.

                                                                      +

                                                                      Specifies the domain name.

                                                                      rel

                                                                      +

                                                                      rel

                                                                      String

                                                                      +

                                                                      String

                                                                      Specifies the domain name description.

                                                                      +

                                                                      Specifies the domain name description.
                                                                    • Example response
                                                                      STATUS CODE 200
                                                                      -
                                                                       1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
-11
-12
-13
-14
-15
-16
-17
-18
-19
-20
-21
-22
-23
-24
-25
-26
-27
-28
-29
-30
-31
-32
-33
-34
-35
-36
-37
-38
-39
-40
-41
-42
-43
-44
-45
-46
-47
-48
-49
-50
-51
-52
                                                                      {
-    "name": "members",
-    "links": [
-        {
-            "href": "{schema}",
-            "rel": "describedby"
-        }
-    ],
-    "properties": {
-        "members": {
-            "items": {
-                "name": "member",
-                "properties": {
-                    "status": {
-                        "enum": [
-                            "pending",
-                            "accepted",
-                            "rejected"
-                        ],
-                        "type": "string",
-                        "description": "The status of this image member"
-                    },
-                    "created_at": {
-                        "type": "string",
-                        "description": "Date and time of image member creation"
-                    },
-                    "updated_at": {
-                        "type": "string",
-                        "description": "Date and time of last modification of image member"
-                    },
-                    "image_id": {
-                        "pattern": "^([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}$",
-                        "type": "string",
-                        "description": "An identifier for the image"
-                    },
-                    "member_id": {
-                        "type": "string",
-                        "description": "An identifier for the image member (tenantId)"
-                    },
-                    "schema": {
-                        "readOnly": true,
-                        "type": "string"
-                    }
-                }
-            },
-            "type": "array"
-        },
-        "schema": {
-            "type": "string"
-        }
-    }
+
                                                                       1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
+13
+14
+15
+16
+17
+18
+19
+20
+21
+22
+23
+24
+25
+26
+27
+28
+29
+30
+31
+32
+33
+34
+35
+36
+37
+38
+39
+40
+41
+42
+43
+44
+45
+46
+47
+48
+49
+50
+51
+52
                                                                      {
+    "name": "members",
+    "links": [
+        {
+            "href": "{schema}",
+            "rel": "describedby"
+        }
+    ],
+    "properties": {
+        "members": {
+            "items": {
+                "name": "member",
+                "properties": {
+                    "status": {
+                        "enum": [
+                            "pending",
+                            "accepted",
+                            "rejected"
+                        ],
+                        "type": "string",
+                        "description": "The status of this image member"
+                    },
+                    "created_at": {
+                        "type": "string",
+                        "description": "Date and time of image member creation"
+                    },
+                    "updated_at": {
+                        "type": "string",
+                        "description": "Date and time of last modification of image member"
+                    },
+                    "image_id": {
+                        "pattern": "^([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}$",
+                        "type": "string",
+                        "description": "An identifier for the image"
+                    },
+                    "member_id": {
+                        "type": "string",
+                        "description": "An identifier for the image member (tenantId)"
+                    },
+                    "schema": {
+                        "readOnly": true,
+                        "type": "string"
+                    }
+                }
+            },
+            "type": "array"
+        },
+        "schema": {
+            "type": "string"
+        }
+    }
 }
-
                                                                      
-
-
                                                                      + +

                                                                      • Returned Values

                                                                      • Normal

                                                                        200

                                                                      • Abnormal -

                                                                        Returned Value

                                                                        +
                                                                        - - - - - - - - - - - - - diff --git a/docs/ims/api-ref/en-us_topic_0060804959.html b/docs/ims/api-ref/en-us_topic_0060804959.html index fdd53b785..6f7d108c8 100644 --- a/docs/ims/api-ref/en-us_topic_0060804959.html +++ b/docs/ims/api-ref/en-us_topic_0060804959.html @@ -10,7 +10,7 @@

                                                                        URI

                                                                        GET /v2/images

                                                                        • You can type a question mark (?) and an ampersand (&) at the end of the URI to define multiple search criteria. For details, see the example request.
                                                                        • If you need the API of the OpenStack Queens release, the request header must contain X-Api-Version. If the value of X-Api-Version is any letter after M in the Alphabet, the API of the Queens release is returned. If the value is M or a letter before M, the API of the Mitaka release is returned.
                                                                        -
                                                                        Table 1 lists the parameters. +
                                                                        Table 1 lists the parameters in the URI.

                                                                        Returned Value

                                                                        Description

                                                                        +

                                                                        Description

                                                                        400 Bad Request

                                                                        +

                                                                        400 Bad Request

                                                                        Request error.

                                                                        +

                                                                        Request error.

                                                                        401 Unauthorized

                                                                        +

                                                                        401 Unauthorized

                                                                        Authentication failed.

                                                                        +

                                                                        Authentication failed.

                                                                        403 Forbidden

                                                                        +

                                                                        403 Forbidden

                                                                        You do not have the rights to perform the operation.

                                                                        +

                                                                        You do not have the rights to perform the operation.

                                                                        404 Not Found

                                                                        +

                                                                        404 Not Found

                                                                        The requested resource was not found.

                                                                        +

                                                                        The requested resource was not found.

                                                                        500 Internal Server Error

                                                                        +

                                                                        500 Internal Server Error

                                                                        Internal service error.

                                                                        +

                                                                        Internal service error.

                                                                        503 Service Unavailable

                                                                        +

                                                                        503 Service Unavailable

                                                                        The service is unavailable.

                                                                        +

                                                                        The service is unavailable.
                                                                        - - - - - - - @@ -338,45 +338,47 @@
                                                                      • Unaccepted images

                                                                        GET /v2/images?member_status=pending&visibility=shared&__imagetype=shared

                                                                        • -

                                                                        Request

                                                                        • Request parameters

                                                                          None

                                                                          -
                                                                        • Example request
                                                                          GET https://{Endpoint}/v2/images
                                                                          -
                                                                        +

                                                                        Request

                                                                        Request parameters

                                                                        +

                                                                        None

                                                                        +
                                                                        +

                                                                        Example Request

                                                                        Querying images

                                                                        +
                                                                        GET https://{Endpoint}/v2/images

                                                                        Response

                                                                        • Response parameters -
                                                                        Table 1 Parameter description

                                                                        Parameter

                                                                        Mandatory

                                                                        @@ -131,7 +131,7 @@

                                                                        Integer

                                                                        Specifies the minimum disk space (GB) required for running the image. The value ranges from 1 GB to 1024 GB.

                                                                        +

                                                                        Specifies the minimum disk space (GB) required for running the image. The value ranges from 1 GB to 1,024 GB.

                                                                        __os_bit

                                                                        @@ -241,7 +241,7 @@

                                                                        String

                                                                        Specifies whether the image supports large-memory ECSs. If the image supports large-memory ECSs, the value is true. Otherwise, this parameter is not required. For details about the image OSs supported by large-memory ECSs, see Table 4.

                                                                        +

                                                                        Specifies whether the image supports large-memory ECSs. If the image supports large-memory ECSs, the value is true. Otherwise, this parameter is not required. For details about the image OSs supported by large-memory ECSs, see Table 4.

                                                                        __support_diskintensive

                                                                        @@ -250,7 +250,7 @@

                                                                        String

                                                                        Specifies whether the image supports disk-intensive ECSs. If the image supports disk-intensive ECSs, the value is true. Otherwise, this parameter is not required. For details about the image OSs supported by disk-intensive ECSs, see Table 4.

                                                                        +

                                                                        Specifies whether the image supports disk-intensive ECSs. If the image supports disk-intensive ECSs, the value is true. Otherwise, this parameter is not required. For details about the image OSs supported by disk-intensive ECSs, see Table 4.

                                                                        __support_highperformance

                                                                        @@ -259,7 +259,7 @@

                                                                        String

                                                                        Specifies whether the image supports high-performance ECSs. If the image supports high-performance ECSs, the value is true. Otherwise, this parameter is not required. For details about the image OSs supported by high-performance computing ECSs, see Table 4.

                                                                        +

                                                                        Specifies whether the image supports high-performance ECSs. If the image supports high-performance ECSs, the value is true. Otherwise, this parameter is not required. For details about the image OSs supported by high-performance computing ECSs, see Table 4.

                                                                        __support_xen_gpu_type

                                                                        @@ -277,7 +277,7 @@

                                                                        String

                                                                        Specifies whether the image supports GPU-accelerated ECSs on the KVM platform. See Table 3 for its value. If the image does not support GPU-accelerated ECSs on the KVM platform, this parameter is not required. This attribute cannot co-exist with __support_xen and __support_kvm.

                                                                        +

                                                                        Specifies whether the image supports GPU-accelerated ECSs on the KVM platform. See Table 3 for its value. If the image does not support GPU-accelerated ECSs on the KVM platform, this parameter is not required. This attribute cannot co-exist with __support_xen and __support_kvm.

                                                                        __support_xen_hana

                                                                        @@ -287,7 +287,7 @@

                                                                        String

                                                                        Specifies whether the image supports HANA ECSs on the Xen platform. If yes, the value is true. Otherwise, this parameter is not required.

                                                                        -

                                                                        This attribute cannot co-exist with __support_xen and __support_kvm.

                                                                        +

                                                                        This attribute cannot co-exist with __support_xen and __support_kvm.

                                                                        __support_kvm_infiniband

                                                                        @@ -296,8 +296,8 @@

                                                                        String

                                                                        Specifies whether the image supports ECSs with the InfiniBand NIC on the KVM platform. If yes, the value is true. Otherwise, this parameter is not required.

                                                                        -

                                                                        This attribute cannot co-exist with __support_xen.

                                                                        +

                                                                        Specifies whether the image supports ECSs with InfiniBand NICs on the KVM platform. If yes, the value is true. Otherwise, this parameter is not required.

                                                                        +

                                                                        This attribute cannot co-exist with __support_xen.

                                                                        created_at

                                                                        @@ -319,10 +319,10 @@

                                                                        String

                                                                        Specifies the time when the image was modified. Images can be queried by time. The value is in the format of Operator:UTC time.

                                                                        +

                                                                        Specifies the time when the image was modified. Images can be queried by time. The value is in the format of Operator:UTC time.

                                                                        The following operators are supported:

                                                                        • gt: greater than
                                                                        • gte: greater than or equal to
                                                                        • lt: less than
                                                                        • lte: less than or equal to
                                                                        • eq: equal to
                                                                        • neq: not equal to
                                                                        -

                                                                        The time format is yyyy-MM-ddThh:mm:ssZ or yyyy-MM-dd hh:mm:ss.

                                                                        +

                                                                        The time format is yyyy-MM-ddThh:mm:ssZ or yyyy-MM-dd hh:mm:ss.

                                                                        For example, to query images updated before Oct 28, 2018 10:00:00, set the value of updated_at to lt:2018-10-28T10:00:00Z.

                                                                        Parameter

                                                                        +
                                                                        - - - - - - - - - - - - - - @@ -384,593 +386,600 @@

                                                                        Parameter

                                                                        Type

                                                                        +

                                                                        Type

                                                                        Description

                                                                        +

                                                                        Description

                                                                        first

                                                                        +

                                                                        first

                                                                        String

                                                                        +

                                                                        String

                                                                        Specifies the URL of the first page of images.

                                                                        +

                                                                        Specifies the URL of the first page of images.

                                                                        next

                                                                        +

                                                                        next

                                                                        String

                                                                        +

                                                                        String

                                                                        Specifies the URL of the next page of images. When the last page of images is queried, there is no parameter next.

                                                                        +

                                                                        Specifies the URL of the next page of images. When the last page of images is queried, there is no parameter next.

                                                                        schema

                                                                        +

                                                                        schema

                                                                        String

                                                                        +

                                                                        String

                                                                        Specifies the URL for the schema describing a list of images.

                                                                        +

                                                                        Specifies the URL for the schema describing a list of images.

                                                                        images

                                                                        +

                                                                        images

                                                                        Array of objects

                                                                        +

                                                                        Array of objects

                                                                        Specifies the resource type.

                                                                        +

                                                                        Specifies the resource type.

                                                                        For details, see Table 2.
                                                                        -
                                                                        Table 2 Data structure description of the images field

                                                                        Parameter

                                                                        +
                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + +
                                                                        Table 2 Data structure description of the images field

                                                                        Parameter

                                                                        Type

                                                                        +

                                                                        Type

                                                                        Description

                                                                        +

                                                                        Description

                                                                        __backup_id

                                                                        +

                                                                        __backup_id

                                                                        String

                                                                        +

                                                                        String

                                                                        Specifies the backup ID. If the image is created from a backup, set the value to the backup ID. Otherwise, this parameter is not required.

                                                                        +

                                                                        Specifies the backup ID. If the image is created from a backup, set the value to the backup ID. Otherwise, this parameter is not required.

                                                                        __data_origin

                                                                        +

                                                                        __data_origin

                                                                        String

                                                                        +

                                                                        String

                                                                        Specifies the image source. If the image is a public image, the value is left empty.

                                                                        +

                                                                        Specifies the image source. If the image is a public image, the value is left empty.

                                                                        __description

                                                                        +

                                                                        __description

                                                                        String

                                                                        +

                                                                        String

                                                                        Specifies the image description.

                                                                        +

                                                                        Specifies the image description.

                                                                        __image_location

                                                                        +

                                                                        __image_location

                                                                        String

                                                                        +

                                                                        String

                                                                        Specifies the location where the image is stored.

                                                                        +

                                                                        Specifies the location where the image is stored.

                                                                        __image_size

                                                                        +

                                                                        __image_size

                                                                        String

                                                                        +

                                                                        String

                                                                        Specifies the size (bytes) of the image file. The value is greater than 0.

                                                                        +

                                                                        Specifies the size (bytes) of the image file. The value is greater than 0.

                                                                        __image_source_type

                                                                        +

                                                                        __image_source_type

                                                                        String

                                                                        +

                                                                        String

                                                                        Specifies the backend storage of the image. Only UDS is supported currently.

                                                                        +

                                                                        Specifies the backend storage of the image. Only UDS is supported currently.

                                                                        __is_config_init

                                                                        +

                                                                        __is_config_init

                                                                        String

                                                                        +

                                                                        String

                                                                        Specifies whether initial configuration is complete. The value can be true or false.

                                                                        +

                                                                        Specifies whether initial configuration is complete. The value can be true or false.

                                                                        __isregistered

                                                                        +

                                                                        __isregistered

                                                                        String

                                                                        +

                                                                        String

                                                                        Specifies whether the image is available. The value can be true. The value is true for all extension APIs by default. Common users can query only the images for which the value of this parameter is true.

                                                                        +

                                                                        Specifies whether the image is available. The value can be true. The value is true for all extension APIs by default. Common users can query only the images for which the value of this parameter is true.

                                                                        __lazyloading

                                                                        +

                                                                        __lazyloading

                                                                        String

                                                                        +

                                                                        String

                                                                        Specifies whether the image supports lazy loading. The value can be true, false, True, or False.

                                                                        +

                                                                        Specifies whether the image supports lazy loading. The value can be true, false, True, or False.

                                                                        __originalimagename

                                                                        +

                                                                        __originalimagename

                                                                        String

                                                                        +

                                                                        String

                                                                        Specifies the parent image ID. If the image is a public image or created from an image file, the value is left empty.

                                                                        +

                                                                        Specifies the parent image ID. If the image is a public image or created from an image file, the value is left empty.

                                                                        __imagetype

                                                                        +

                                                                        __imagetype

                                                                        String

                                                                        +

                                                                        String

                                                                        Specifies the image type. The following types are supported:

                                                                        -
                                                                        • Public image: The value is gold.
                                                                        • Private image: The value is private.
                                                                        • Shared image: The value is shared.
                                                                        +

                                                                        Specifies the image type. The following types are supported:

                                                                        +
                                                                        • Public image: The value is gold.
                                                                        • Private image: The value is private.
                                                                        • Shared image: The value is shared.

                                                                        protected

                                                                        +

                                                                        protected

                                                                        Boolean

                                                                        +

                                                                        Boolean

                                                                        Specifies whether the image is protected. Set it to true when you query public images. This parameter is optional when you query private images.

                                                                        +

                                                                        Specifies whether the image is protected. Set it to true when you query public images. This parameter is optional when you query private images.

                                                                        virtual_env_type

                                                                        +

                                                                        virtual_env_type

                                                                        String

                                                                        +

                                                                        String

                                                                        Specifies the environment where the image is used. The value can be FusionCompute, Ironic, DataImage, or IsoImage.

                                                                        +

                                                                        Specifies the environment where the image is used. The value can be FusionCompute, Ironic, DataImage, or IsoImage.

                                                                        • For an ECS image (system disk image), the value is FusionCompute.
                                                                        • For a data disk image, the value is DataImage.
                                                                        • For a BMS image, the value is Ironic.
                                                                        • For an ISO image, the value is IsoImage.

                                                                        virtual_size

                                                                        +

                                                                        virtual_size

                                                                        Integer

                                                                        +

                                                                        Integer

                                                                        This parameter is unavailable currently.

                                                                        +

                                                                        This parameter is unavailable currently.

                                                                        visibility

                                                                        +

                                                                        visibility

                                                                        String

                                                                        +

                                                                        String

                                                                        Specifies whether the image is available to other tenants. The value can be one of the following:

                                                                        +

                                                                        Specifies whether the image is available to other tenants. The value can be one of the following:

                                                                        • public: public image
                                                                        • private: private image
                                                                        • shared: shared image

                                                                        owner

                                                                        +

                                                                        owner

                                                                        String

                                                                        +

                                                                        String

                                                                        Specifies the tenant to which the image belongs.

                                                                        +

                                                                        Specifies the tenant to which the image belongs.

                                                                        id

                                                                        +

                                                                        id

                                                                        String

                                                                        +

                                                                        String

                                                                        Specifies the image ID.

                                                                        +

                                                                        Specifies the image ID.

                                                                        status

                                                                        +

                                                                        status

                                                                        String

                                                                        +

                                                                        String

                                                                        Specifies the image status. The value can be one of the following:

                                                                        -
                                                                        • queued: indicates that the image metadata has already been created, and it is ready for the image file to upload.
                                                                        • saving: indicates that the image file is being uploaded to the backend storage.
                                                                        • deleted: indicates that the image has been deleted.
                                                                        • killed: indicates that an error occurs on the image uploading.
                                                                        • active: indicates that the image is available for use.
                                                                        +

                                                                        Specifies the image status. The value can be one of the following:

                                                                        +
                                                                        • queued: indicates that the image metadata has already been created, and it is ready for the image file to upload.
                                                                        • saving: indicates that the image file is being uploaded to the backend storage.
                                                                        • deleted: indicates that the image has been deleted.
                                                                        • killed: indicates that an error occurs on the image uploading.
                                                                        • active: indicates that the image is available for use.

                                                                        name

                                                                        +

                                                                        name

                                                                        String

                                                                        +

                                                                        String

                                                                        Specifies the image name. For detailed description, see Image Attributes.

                                                                        +

                                                                        Specifies the image name. For detailed description, see Image Attributes.

                                                                        container_format

                                                                        +

                                                                        container_format

                                                                        String

                                                                        +

                                                                        String

                                                                        Specifies the container type.

                                                                        +

                                                                        Specifies the container type.

                                                                        disk_format

                                                                        +

                                                                        disk_format

                                                                        String

                                                                        +

                                                                        String

                                                                        Specifies the image format. The value can be zvhd2, vhd, zvhd, raw, or qcow2. The default value is zvhd2.

                                                                        +

                                                                        Specifies the image format. The value can be zvhd2, vhd, zvhd, raw, or qcow2. The default value is zvhd2.

                                                                        min_ram

                                                                        +

                                                                        min_ram

                                                                        Integer

                                                                        +

                                                                        Integer

                                                                        Specifies the minimum memory size (MB) required for running the image. The parameter value depends on the ECS specifications. Generally, the value is 0.

                                                                        +

                                                                        Specifies the minimum memory size (MB) required for running the image. The parameter value depends on the ECS specifications. Generally, the value is 0.

                                                                        max_ram

                                                                        +

                                                                        max_ram

                                                                        String

                                                                        +

                                                                        String

                                                                        Specifies the maximum memory (MB) of the image.

                                                                        +

                                                                        Specifies the maximum memory (MB) of the image.

                                                                        min_disk

                                                                        +

                                                                        min_disk

                                                                        Integer

                                                                        +

                                                                        Integer

                                                                        Specifies the minimum disk space (GB) required for running the image. The value ranges from 1 GB to 1024 GB.

                                                                        +

                                                                        Specifies the minimum disk space (GB) required for running the image. The value ranges from 1 GB to 1,024 GB.

                                                                        __os_bit

                                                                        +

                                                                        __os_bit

                                                                        String

                                                                        +

                                                                        String

                                                                        Specifies the OS architecture, 32 bit or 64 bit.

                                                                        +

                                                                        Specifies the OS architecture, 32 bit or 64 bit.

                                                                        __os_feature_list

                                                                        +

                                                                        __os_feature_list

                                                                        String

                                                                        +

                                                                        String

                                                                        Specifies additional attributes of the image. The value is a list (in JSON format) of advanced features supported by the image.

                                                                        +

                                                                        Specifies additional attributes of the image. The value is a list (in JSON format) of advanced features supported by the image.

                                                                        __platform

                                                                        +

                                                                        __platform

                                                                        String

                                                                        +

                                                                        String

                                                                        Specifies the image platform type. The value can be Windows, Ubuntu, Red Hat, SUSE, CentOS, Debian, OpenSUSE, Oracle Linux, Fedora, Other, CoreOS, or EulerOS.

                                                                        +

                                                                        Specifies the image platform type. The value can be Windows, Ubuntu, Red Hat, SUSE, CentOS, Debian, OpenSUSE, Oracle Linux, Fedora, Other, CoreOS, or EulerOS.

                                                                        schema

                                                                        +

                                                                        schema

                                                                        String

                                                                        +

                                                                        String

                                                                        Specifies the image schema.

                                                                        +

                                                                        Specifies the image schema.

                                                                        self

                                                                        +

                                                                        self

                                                                        String

                                                                        +

                                                                        String

                                                                        Specifies the image URL.

                                                                        +

                                                                        Specifies the image URL.

                                                                        size

                                                                        +

                                                                        size

                                                                        Integer

                                                                        +

                                                                        Integer

                                                                        This parameter is unavailable currently.

                                                                        +

                                                                        This parameter is unavailable currently.

                                                                        __os_type

                                                                        +

                                                                        __os_type

                                                                        String

                                                                        +

                                                                        String

                                                                        Specifies the image OS type. The value can be Linux, Windows, or Other.

                                                                        +

                                                                        Specifies the image OS type. The value can be Linux, Windows, or Other.

                                                                        __os_version

                                                                        +

                                                                        __os_version

                                                                        String

                                                                        +

                                                                        String

                                                                        Specifies the OS version.

                                                                        +

                                                                        Specifies the OS version.

                                                                        tags

                                                                        +

                                                                        tags

                                                                        Array of strings

                                                                        +

                                                                        Array of strings

                                                                        Specifies tags of the image, through which you can manage private images in your own way.

                                                                        +

                                                                        Specifies tags of the image, through which you can manage private images in your own way.

                                                                        __support_kvm

                                                                        +

                                                                        __support_kvm

                                                                        String

                                                                        +

                                                                        String

                                                                        Specifies whether the image supports KVM. If yes, the value is true. Otherwise, this parameter is not required.

                                                                        +

                                                                        Specifies whether the image supports KVM. If yes, the value is true. Otherwise, this parameter is not required.

                                                                        __support_xen

                                                                        +

                                                                        __support_xen

                                                                        String

                                                                        +

                                                                        String

                                                                        Specifies whether the image supports Xen. If yes, the value is true. Otherwise, this parameter is not required.

                                                                        +

                                                                        Specifies whether the image supports Xen. If yes, the value is true. Otherwise, this parameter is not required.

                                                                        __support_largememory

                                                                        +

                                                                        __support_largememory

                                                                        String

                                                                        +

                                                                        String

                                                                        Specifies whether the image supports large-memory ECSs. If the image supports large-memory ECSs, the value is true. Otherwise, this parameter is not required. For details about the image OSs supported by large-memory ECSs, see Table 4.

                                                                        +

                                                                        Specifies whether the image supports large-memory ECSs. If the image supports large-memory ECSs, the value is true. Otherwise, this parameter is not required. For details about the image OSs supported by large-memory ECSs, see Table 4.

                                                                        __support_diskintensive

                                                                        +

                                                                        __support_diskintensive

                                                                        String

                                                                        +

                                                                        String

                                                                        Specifies whether the image supports disk-intensive ECSs. If the image supports disk-intensive ECSs, the value is true. Otherwise, this parameter is not required. For details about the image OSs supported by disk-intensive ECSs, see Table 4.

                                                                        +

                                                                        Specifies whether the image supports disk-intensive ECSs. If the image supports disk-intensive ECSs, the value is true. Otherwise, this parameter is not required. For details about the image OSs supported by disk-intensive ECSs, see Table 4.

                                                                        __support_highperformance

                                                                        +

                                                                        __support_highperformance

                                                                        String

                                                                        +

                                                                        String

                                                                        Specifies whether the image supports high-performance ECSs. If the image supports high-performance ECSs, the value is true. Otherwise, this parameter is not required. For details about the image OSs supported by high-performance computing ECSs, see Table 4.

                                                                        +

                                                                        Specifies whether the image supports high-performance ECSs. If the image supports high-performance ECSs, the value is true. Otherwise, this parameter is not required. For details about the image OSs supported by high-performance computing ECSs, see Table 4.

                                                                        __support_xen_gpu_type

                                                                        +

                                                                        __support_xen_gpu_type

                                                                        String

                                                                        +

                                                                        String

                                                                        Specifies whether the image supports GPU-accelerated ECSs on the Xen platform. For details about the image OSs supported by GPU-accelerated ECSs, see Table 2. If the image does not support GPU-accelerated ECSs on the Xen platform, this parameter is not required. This attribute cannot co-exist with __support_xen and __support_kvm.

                                                                        +

                                                                        Specifies whether the image supports GPU-accelerated ECSs on the Xen platform. For details about the image OSs supported by GPU-accelerated ECSs, see Table 2. If the image does not support GPU-accelerated ECSs on the Xen platform, this parameter is not required. This attribute cannot co-exist with __support_xen and __support_kvm.

                                                                        __support_kvm_gpu_type

                                                                        +

                                                                        __support_kvm_gpu_type

                                                                        String

                                                                        +

                                                                        String

                                                                        Specifies whether the image supports GPU-accelerated ECSs on the KVM platform. See Table 3 for its value. If the image does not support GPU-accelerated ECSs on the KVM platform, this parameter is not required. This attribute cannot co-exist with __support_xen and __support_kvm.

                                                                        +

                                                                        Specifies whether the image supports GPU-accelerated ECSs on the KVM platform. See Table 3 for its value. If the image does not support GPU-accelerated ECSs on the KVM platform, this parameter is not required. This attribute cannot co-exist with __support_xen and __support_kvm.

                                                                        __support_xen_hana

                                                                        +

                                                                        __support_xen_hana

                                                                        String

                                                                        +

                                                                        String

                                                                        Specifies whether the image supports HANA ECSs on the Xen platform. If yes, the value is true. Otherwise, this parameter is not required.

                                                                        -

                                                                        This attribute cannot co-exist with __support_xen and __support_kvm.

                                                                        +

                                                                        Specifies whether the image supports HANA ECSs on the Xen platform. If yes, the value is true. Otherwise, this parameter is not required.

                                                                        +

                                                                        This attribute cannot co-exist with __support_xen and __support_kvm.

                                                                        __support_kvm_infiniband

                                                                        +

                                                                        __support_kvm_infiniband

                                                                        String

                                                                        +

                                                                        String

                                                                        Specifies whether the image supports ECSs with the InfiniBand NIC on the KVM platform. If yes, the value is true. Otherwise, this parameter is not required.

                                                                        -

                                                                        This attribute cannot co-exist with __support_xen.

                                                                        +

                                                                        Specifies whether the image supports ECSs with InfiniBand NICs on the KVM platform. If yes, the value is true. Otherwise, this parameter is not required.

                                                                        +

                                                                        This attribute cannot co-exist with __support_xen.

                                                                        __root_origin

                                                                        +

                                                                        __root_origin

                                                                        String

                                                                        +

                                                                        String

                                                                        Specifies that the image is created from an external image file. Value: file

                                                                        +

                                                                        Specifies that the image is created from an external image file. Value: file

                                                                        __sequence_num

                                                                        +

                                                                        __sequence_num

                                                                        String

                                                                        +

                                                                        String

                                                                        Specifies the ECS system disk slot number corresponding to the image.

                                                                        -

                                                                        Example value: 0

                                                                        +

                                                                        Specifies the ECS system disk slot number of the image.

                                                                        +

                                                                        Example value: 0

                                                                        __support_fc_inject

                                                                        +

                                                                        __support_fc_inject

                                                                        String

                                                                        +

                                                                        String

                                                                        Specifies whether the image supports password/private key injection using Cloud-Init.

                                                                        +

                                                                        Specifies whether the image supports password/private key injection using Cloud-Init.

                                                                        If the value is set to true, password/private key injection using Cloud-Init is not supported.

                                                                        NOTE:

                                                                        This parameter is valid only for ECS system disk images.

                                                                        created_at

                                                                        +

                                                                        created_at

                                                                        String

                                                                        +

                                                                        String

                                                                        Specifies the time when the image was created. The value is in UTC format.

                                                                        +

                                                                        Specifies the time when the image was created. The value is in UTC format.

                                                                        updated_at

                                                                        +

                                                                        updated_at

                                                                        String

                                                                        +

                                                                        String

                                                                        Specifies the time when the image was updated. The value is in UTC format.

                                                                        +

                                                                        Specifies the time when the image was updated. The value is in UTC format.

                                                                        active_at

                                                                        +

                                                                        active_at

                                                                        String

                                                                        +

                                                                        String

                                                                        Specifies the time when the image status became active.

                                                                        +

                                                                        Specifies the time when the image status became active.

                                                                        checksum

                                                                        +

                                                                        checksum

                                                                        String

                                                                        +

                                                                        String

                                                                        This parameter is unavailable currently.

                                                                        +

                                                                        This parameter is unavailable currently.

                                                                        hw_firmware_type

                                                                        +

                                                                        hw_firmware_type

                                                                        String

                                                                        +

                                                                        String

                                                                        Specifies the ECS boot mode. Available values include:

                                                                        +

                                                                        Specifies the ECS boot mode. Available values include:

                                                                        • bios indicates the BIOS boot mode.
                                                                        • uefi indicates the UEFI boot mode.

                                                                        file

                                                                        +

                                                                        file

                                                                        String

                                                                        +

                                                                        String

                                                                        Specifies the URL for uploading and downloading the image file.

                                                                        +

                                                                        Specifies the URL for uploading and downloading the image file.

                                                                        enterprise_project_id

                                                                        +

                                                                        enterprise_project_id

                                                                        String

                                                                        +

                                                                        String

                                                                        Specifies the enterprise project that the image belongs to.

                                                                        -
                                                                        • If the value is 0 or left blank, the image belongs to the default enterprise project.
                                                                        • If the value is a UUID, the image belongs to the enterprise project corresponding to the UUID.
                                                                        +

                                                                        Specifies the enterprise project that the image belongs to.

                                                                        +
                                                                        • If the value is 0 or left blank, the image belongs to the default enterprise project.
                                                                        • If the value is a UUID, the image belongs to the enterprise project corresponding to the UUID.

                                                                        __support_amd

                                                                        +

                                                                        _sys_enterprise_project_id

                                                                        String

                                                                        +

                                                                        String

                                                                        Specifies whether the image uses AMD's x86 architecture. The value can be true or false.

                                                                        +

                                                                        Specifies the enterprise project that the image belongs to.

                                                                        +
                                                                        • If the value is 0 or left blank, the image belongs to the default enterprise project.
                                                                        • If the value is a UUID, the image belongs to the enterprise project corresponding to the UUID.

                                                                        __system__cmkid

                                                                        +

                                                                        __support_amd

                                                                        String

                                                                        +

                                                                        String

                                                                        Specifies the ID of the key used to encrypt the image.

                                                                        +

                                                                        Specifies whether the image uses AMD's x86 architecture. The value can be true or false.

                                                                        hw_vif_multiqueue_enabled

                                                                        +

                                                                        __system__cmkid

                                                                        String

                                                                        +

                                                                        String

                                                                        Specifies whether the image supports NIC multi-queue. The value can be true or false.

                                                                        +

                                                                        Specifies the ID of the key used to encrypt the image.

                                                                        +

                                                                        hw_vif_multiqueue_enabled

                                                                        +

                                                                        String

                                                                        +

                                                                        Specifies whether the image supports NIC multi-queue. The value can be true or false.
                                                                      • Example response
                                                                        STATUS CODE 200
                                                                        -
                                                                         1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
-11
-12
-13
-14
-15
-16
-17
-18
-19
-20
-21
-22
-23
-24
-25
-26
-27
-28
-29
-30
-31
-32
-33
-34
-35
-36
-37
-38
-39
-40
-41
-42
-43
-44
-45
-46
-47
-48
-49
-50
-51
-52
-53
-54
-55
-56
-57
-58
-59
-60
-61
-62
-63
-64
-65
-66
-67
-68
-69
                                                                        {
-  "schema": "/v2/schemas/images",
-  "next": "/v2/images?__isregistered=true&marker=0328c25e-c840-4496-81ac-c4e01b214b1f&__imagetype=gold&limit=2",
-  "images": [
-    {
-      "schema": "/v2/schemas/image",
-      "min_disk": 100,
-      "created_at": "2018-09-06T14:03:27Z",
-      "__image_source_type": "uds",
-      "container_format": "bare",
-      "file": "/v2/images/bc6bed6e-ba3a-4447-afcc-449174a3eb52/file",
-      "updated_at": "2018-09-06T15:17:33Z",
-      "protected": true,
-      "checksum": "d41d8cd98f00b204e9800998ecf8427e",
-      "id": "bc6bed6e-ba3a-4447-afcc-449174a3eb52",
-      "__isregistered": "true",
-      "min_ram": 2048,
-      "__lazyloading": "true",
-      "owner": "1bed856811654c1cb661a6ca845ebc77",
-      "__os_type": "Linux",
-      "__imagetype": "gold",
-      "visibility": "public",
-      "virtual_env_type": "FusionCompute",
-      "tags": [],
-      "__platform": "CentOS",
-      "size": 0,
-      "__os_bit": "64",
-      "__os_version": "CentOS 7.3 64bit",
-      "name": "CentOS 7.3 64bit vivado",
-      "self": "/v2/images/bc6bed6e-ba3a-4447-afcc-449174a3eb52",
-      "disk_format": "zvhd2",
-      "virtual_size": null,
-      "hw_firmware_type": "bios",
-      "status": "active"
-    },
-    {
-      "schema": "/v2/schemas/image",
-      "min_disk": 100,
-      "created_at": "2018-09-06T14:03:05Z",
-      "__image_source_type": "uds",
-      "container_format": "bare",
-      "file": "/v2/images/0328c25e-c840-4496-81ac-c4e01b214b1f/file",
-      "updated_at": "2018-09-25T14:27:40Z",
-      "protected": true,
-      "checksum": "d41d8cd98f00b204e9800998ecf8427e",
-      "id": "0328c25e-c840-4496-81ac-c4e01b214b1f",
-      "__isregistered": "true",
-      "min_ram": 2048,
-      "__lazyloading": "true",
-      "owner": "1bed856811654c1cb661a6ca845ebc77",
-      "__os_type": "Linux",
-      "__imagetype": "gold",
-      "visibility": "public",
-      "virtual_env_type": "FusionCompute",
-      "tags": [],
-      "__platform": "CentOS",
-      "size": 0,
-      "__os_bit": "64",
-      "__os_version": "CentOS 7.3 64bit",
-      "name": "CentOS 7.3 64bit with sdx",
-      "self": "/v2/images/0328c25e-c840-4496-81ac-c4e01b214b1f",
-      "disk_format": "zvhd2",
-      "virtual_size": null,
-      "hw_firmware_type": "bios",
-      "status": "active"
-    }
-  ],
-  "first": "/v2/images?__isregistered=true&__imagetype=gold&limit=2"
+
                                                                         1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
+13
+14
+15
+16
+17
+18
+19
+20
+21
+22
+23
+24
+25
+26
+27
+28
+29
+30
+31
+32
+33
+34
+35
+36
+37
+38
+39
+40
+41
+42
+43
+44
+45
+46
+47
+48
+49
+50
+51
+52
+53
+54
+55
+56
+57
+58
+59
+60
+61
+62
+63
+64
+65
+66
+67
+68
+69
                                                                        {
+  "schema": "/v2/schemas/images",
+  "next": "/v2/images?__isregistered=true&marker=0328c25e-c840-4496-81ac-c4e01b214b1f&__imagetype=gold&limit=2",
+  "images": [
+    {
+      "schema": "/v2/schemas/image",
+      "min_disk": 100,
+      "created_at": "2018-09-06T14:03:27Z",
+      "__image_source_type": "uds",
+      "container_format": "bare",
+      "file": "/v2/images/bc6bed6e-ba3a-4447-afcc-449174a3eb52/file",
+      "updated_at": "2018-09-06T15:17:33Z",
+      "protected": true,
+      "checksum": "d41d8cd98f00b204e9800998ecf8427e",
+      "id": "bc6bed6e-ba3a-4447-afcc-449174a3eb52",
+      "__isregistered": "true",
+      "min_ram": 2048,
+      "__lazyloading": "true",
+      "owner": "1bed856811654c1cb661a6ca845ebc77",
+      "__os_type": "Linux",
+      "__imagetype": "gold",
+      "visibility": "public",
+      "virtual_env_type": "FusionCompute",
+      "tags": [],
+      "__platform": "CentOS",
+      "size": 0,
+      "__os_bit": "64",
+      "__os_version": "CentOS 7.3 64bit",
+      "name": "CentOS 7.3 64bit vivado",
+      "self": "/v2/images/bc6bed6e-ba3a-4447-afcc-449174a3eb52",
+      "disk_format": "zvhd2",
+      "virtual_size": null,
+      "hw_firmware_type": "bios",
+      "status": "active"
+    },
+    {
+      "schema": "/v2/schemas/image",
+      "min_disk": 100,
+      "created_at": "2018-09-06T14:03:05Z",
+      "__image_source_type": "uds",
+      "container_format": "bare",
+      "file": "/v2/images/0328c25e-c840-4496-81ac-c4e01b214b1f/file",
+      "updated_at": "2018-09-25T14:27:40Z",
+      "protected": true,
+      "checksum": "d41d8cd98f00b204e9800998ecf8427e",
+      "id": "0328c25e-c840-4496-81ac-c4e01b214b1f",
+      "__isregistered": "true",
+      "min_ram": 2048,
+      "__lazyloading": "true",
+      "owner": "1bed856811654c1cb661a6ca845ebc77",
+      "__os_type": "Linux",
+      "__imagetype": "gold",
+      "visibility": "public",
+      "virtual_env_type": "FusionCompute",
+      "tags": [],
+      "__platform": "CentOS",
+      "size": 0,
+      "__os_bit": "64",
+      "__os_version": "CentOS 7.3 64bit",
+      "name": "CentOS 7.3 64bit with sdx",
+      "self": "/v2/images/0328c25e-c840-4496-81ac-c4e01b214b1f",
+      "disk_format": "zvhd2",
+      "virtual_size": null,
+      "hw_firmware_type": "bios",
+      "status": "active"
+    }
+  ],
+  "first": "/v2/images?__isregistered=true&__imagetype=gold&limit=2"
 }
-
                                                                        
-
-
                                                                        + +

                                                                        • Returned Values

                                                                        • Normal

                                                                          200

                                                                        • Abnormal -

                                                                          Returned Value

                                                                          +
                                                                          - - - - - - - - - - - - - diff --git a/docs/ims/api-ref/en-us_topic_0060804960.html b/docs/ims/api-ref/en-us_topic_0060804960.html index 31862a2ec..8c0973b9c 100644 --- a/docs/ims/api-ref/en-us_topic_0060804960.html +++ b/docs/ims/api-ref/en-us_topic_0060804960.html @@ -6,7 +6,7 @@

                                                                          Constraints

                                                                          Only customized attributes, image name, and image description can be modified.

                                                                          URI

                                                                          PATCH /v2/images/{image_id}

                                                                          -

                                                                          Table 1 lists the parameters.

                                                                          +

                                                                          Table 1 lists the parameters in the URI.

                                                                          Returned Value

                                                                          Description

                                                                          +

                                                                          Description

                                                                          400 Bad Request

                                                                          +

                                                                          400 Bad Request

                                                                          Request error. For details about the returned error code, see Error Codes.

                                                                          +

                                                                          Request error. For details about the returned error code, see Error Codes.

                                                                          401 Unauthorized

                                                                          +

                                                                          401 Unauthorized

                                                                          Authentication failed.

                                                                          +

                                                                          Authentication failed.

                                                                          403 Forbidden

                                                                          +

                                                                          403 Forbidden

                                                                          You do not have the rights to perform the operation.

                                                                          +

                                                                          You do not have the rights to perform the operation.

                                                                          404 Not Found

                                                                          +

                                                                          404 Not Found

                                                                          The requested resource was not found.

                                                                          +

                                                                          The requested resource was not found.

                                                                          500 Internal Server Error

                                                                          +

                                                                          500 Internal Server Error

                                                                          Internal service error.

                                                                          +

                                                                          Internal service error.

                                                                          503 Service Unavailable

                                                                          +

                                                                          503 Service Unavailable

                                                                          The service is unavailable.

                                                                          +

                                                                          The service is unavailable.
                                                                          @@ -34,9 +34,9 @@

                                                                          Request

                                                                          • Request parameters

                                                                            Glance has two methods of updating image information. The method is specified by Content-Type in the HTTP header. application/openstack-images-v2.0-json-patch and application/openstack-images-v2.1-json-patch are supported. Content types differ only in the format of the request message body.

                                                                            -
                                                                          Table 1 Parameter description

                                                                          Parameter
                                                                          Table 2 v2.1 request message body

                                                                          Parameter

                                                                          +
                                                                          - @@ -61,7 +61,7 @@ - @@ -101,9 +101,9 @@
                                                                          Table 2 v2.1 request message body

                                                                          Parameter

                                                                          Mandatory

                                                                          +

                                                                          Mandatory

                                                                          Type

                                                                          Type

                                                                          Mandatory

                                                                          +

                                                                          Mandatory

                                                                          Description

                                                                          -
                                                                          Table 4 v2.0 request message body

                                                                          Parameter

                                                                          +
                                                                          - @@ -128,7 +128,7 @@ - @@ -161,476 +161,478 @@ -
                                                                          Table 4 v2.0 request message body

                                                                          Parameter

                                                                          Mandatory

                                                                          +

                                                                          Mandatory

                                                                          Type

                                                                          Type

                                                                          Mandatory

                                                                          +

                                                                          Mandatory

                                                                          Description

                                                                          String

                                                                          Mandatory for replace and add, and not for remove

                                                                          +

                                                                          Mandatory for replace and add, and not for remove

                                                                          Indicates the value of the attribute to be updated or added. For detailed description, see Image Attributes.
                                                                          -
                                                                          -
                                                                        • Example request
                                                                          PATCH https://{Endpoint}/v2/images/33ad552d-1149-471c-8190-ff6776174a00
                                                                          -
                                                                          • v2.1 request body
                                                                            1
-2
-3
-4
-5
-6
-7
-8
                                                                            "Content-Type:application/openstack-images-v2.1-json-patch"   
-[
-     {
-         "op": "replace",
-         "path": "/name",
-         "value": "test01"
-     }
-]
-
                                                                            - -
                                                                            -
                                                                          • v2.0 request body
                                                                            1
-2
-3
-4
-5
-6
-7
                                                                            "Content-Type:application/openstack-images-v2.0-json-patch"
-[
-     {
-         "replace": "/name",
-         "value": "test01"       
-     }
-]     
-
                                                                            -
                                                                          + +

                                                                          Example Request

                                                                          • Changing the name of an image to ims_test01 (V2.1 request)
                                                                            1
+2
+3
+4
+5
+6
+7
+8
+9
                                                                            PATCH https://{Endpoint}/v2/images/33ad552d-1149-471c-8190-ff6776174a00
+"Content-Type:application/openstack-images-v2.1-json-patch"   
+[
+     {
+         "op": "replace",
+         "path": "/name",
+         "value": "test01"
+     }
+]
+
                                                                            +
                                                                            +
                                                                          • Changing the name of an image to ims_test01 (V2.0 request)
                                                                            1
+2
+3
+4
+5
+6
+7
+8
                                                                            PATCH https://{Endpoint}/v2/images/33ad552d-1149-471c-8190-ff6776174a00
+"Content-Type:application/openstack-images-v2.0-json-patch"
+[
+     {
+         "replace": "/name",
+         "value": "test01"       
+     }
+]     
+
                                                                            +

                                                                          Response

                                                                          • Response parameters -

                                                                            Parameter

                                                                            +
                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

                                                                            Parameter

                                                                            Type

                                                                            +

                                                                            Type

                                                                            Description

                                                                            +

                                                                            Description

                                                                            file

                                                                            +

                                                                            file

                                                                            String

                                                                            +

                                                                            String

                                                                            Specifies the URL for uploading and downloading the image file.

                                                                            +

                                                                            Specifies the URL for uploading and downloading the image file.

                                                                            owner

                                                                            +

                                                                            owner

                                                                            String

                                                                            +

                                                                            String

                                                                            Specifies the tenant to which the image belongs.

                                                                            +

                                                                            Specifies the tenant to which the image belongs.

                                                                            id

                                                                            +

                                                                            id

                                                                            String

                                                                            +

                                                                            String

                                                                            Specifies the image ID.

                                                                            +

                                                                            Specifies the image ID.

                                                                            size

                                                                            +

                                                                            size

                                                                            Long

                                                                            +

                                                                            Long

                                                                            This parameter is unavailable currently.

                                                                            +

                                                                            This parameter is unavailable currently.

                                                                            self

                                                                            +

                                                                            self

                                                                            String

                                                                            +

                                                                            String

                                                                            Specifies the image URL.

                                                                            +

                                                                            Specifies the image URL.

                                                                            schema

                                                                            +

                                                                            schema

                                                                            String

                                                                            +

                                                                            String

                                                                            Specifies the image schema.

                                                                            +

                                                                            Specifies the image schema.

                                                                            status

                                                                            +

                                                                            status

                                                                            String

                                                                            +

                                                                            String

                                                                            Specifies the image status. The value can be:

                                                                            +

                                                                            Specifies the image status. The value can be:

                                                                            • queued: indicates that the image metadata has already been created, and it is ready for the image file to upload.
                                                                            • saving: indicates that the image file is being uploaded to the backend storage.
                                                                            • deleted: indicates that the image has been deleted.
                                                                            • killed: indicates that an error occurs on the image uploading.
                                                                            • active: indicates that the image is available for use.

                                                                            tags

                                                                            +

                                                                            tags

                                                                            Array of strings

                                                                            +

                                                                            Array of strings

                                                                            Specifies tags of the image, through which you can manage private images in your own way. You can use the image tag API to add different tags to each image and filter images by tag.

                                                                            +

                                                                            Specifies tags of the image, through which you can manage private images in your own way. You can use the image tag API to add different tags to each image and filter images by tag.

                                                                            visibility

                                                                            +

                                                                            visibility

                                                                            String

                                                                            +

                                                                            String

                                                                            Specifies whether the image is available to other tenants. The value can be:

                                                                            +

                                                                            Specifies whether the image is available to other tenants. The value can be:

                                                                            • private: private image
                                                                            • public: public image
                                                                            • shared: shared image

                                                                            name

                                                                            +

                                                                            name

                                                                            String

                                                                            +

                                                                            String

                                                                            Specifies the image name. For detailed description, see Image Attributes.

                                                                            +

                                                                            Specifies the image name. For detailed description, see Image Attributes.

                                                                            checksum

                                                                            +

                                                                            checksum

                                                                            String

                                                                            +

                                                                            String

                                                                            This parameter is unavailable currently.

                                                                            +

                                                                            This parameter is unavailable currently.

                                                                            protected

                                                                            +

                                                                            protected

                                                                            Boolean

                                                                            +

                                                                            Boolean

                                                                            Specifies whether the image is protected. A protected image cannot be deleted. The value can be true or false.

                                                                            +

                                                                            Specifies whether the image is protected. A protected image cannot be deleted. The value can be true or false.

                                                                            container_format

                                                                            +

                                                                            container_format

                                                                            String

                                                                            +

                                                                            String

                                                                            Specifies the container type.

                                                                            +

                                                                            Specifies the container type.

                                                                            min_ram

                                                                            +

                                                                            min_ram

                                                                            Integer

                                                                            +

                                                                            Integer

                                                                            Specifies the minimum memory size (MB) required for running the image. The parameter value depends on the ECS specifications. The default value is 0.

                                                                            +

                                                                            Specifies the minimum memory size (MB) required for running the image. The parameter value depends on the ECS specifications. The default value is 0.

                                                                            max_ram

                                                                            +

                                                                            max_ram

                                                                            String

                                                                            +

                                                                            String

                                                                            Specifies the maximum memory (MB) of the image. The parameter value depends on the ECS specifications and is not configured by default.

                                                                            +

                                                                            Specifies the maximum memory (MB) of the image. The parameter value depends on the ECS specifications and is not configured by default.

                                                                            updated_at

                                                                            +

                                                                            updated_at

                                                                            String

                                                                            +

                                                                            String

                                                                            Specifies the time when the image was updated. The value is in UTC format.

                                                                            +

                                                                            Specifies the time when the image was updated. The value is in UTC format.

                                                                            __os_bit

                                                                            +

                                                                            __os_bit

                                                                            String

                                                                            +

                                                                            String

                                                                            Specifies the OS architecture, 32 bit or 64 bit.

                                                                            +

                                                                            Specifies the OS architecture, 32 bit or 64 bit.

                                                                            __os_version

                                                                            +

                                                                            __os_version

                                                                            String

                                                                            +

                                                                            String

                                                                            Specifies the OS version.

                                                                            +

                                                                            Specifies the OS version.

                                                                            __description

                                                                            +

                                                                            __description

                                                                            String

                                                                            +

                                                                            String

                                                                            Specifies the image description. For detailed description, see Image Attributes.

                                                                            +

                                                                            Provides supplementary information about the image. For detailed description, see Image Attributes.

                                                                            disk_format

                                                                            +

                                                                            disk_format

                                                                            String

                                                                            +

                                                                            String

                                                                            Specifies the image format. The value can be zvhd2, vhd, zvhd, raw, or qcow2. The default value is zvhd2.

                                                                            +

                                                                            Specifies the image format. The value can be zvhd2, vhd, zvhd, raw, or qcow2. The default value is zvhd2.

                                                                            __isregistered

                                                                            +

                                                                            __isregistered

                                                                            String

                                                                            +

                                                                            String

                                                                            Specifies whether the image has been registered. The value can be true or false.

                                                                            +

                                                                            Specifies whether the image has been registered. The value can be true or false.

                                                                            __platform

                                                                            +

                                                                            __platform

                                                                            String

                                                                            +

                                                                            String

                                                                            Specifies the image platform type. The value can be Windows, Ubuntu, Red Hat, SUSE, CentOS, Debian, OpenSUSE, Oracle Linux, Fedora, Other, CoreOS, or EulerOS.

                                                                            +

                                                                            Specifies the image platform type. The value can be Windows, Ubuntu, Red Hat, SUSE, CentOS, Debian, OpenSUSE, Oracle Linux, Fedora, Other, CoreOS, or EulerOS.

                                                                            __os_type

                                                                            +

                                                                            __os_type

                                                                            String

                                                                            +

                                                                            String

                                                                            Specifies the OS type. The value can be Linux, Windows, or Other.

                                                                            +

                                                                            Specifies the OS type. The value can be Linux, Windows, or Other.

                                                                            __system__cmkid

                                                                            +

                                                                            __system__cmkid

                                                                            String

                                                                            +

                                                                            String

                                                                            Specifies the ID of the key used to encrypt the image.

                                                                            +

                                                                            Specifies the ID of the key used to encrypt the image.

                                                                            min_disk

                                                                            +

                                                                            min_disk

                                                                            Integer

                                                                            +

                                                                            Integer

                                                                            Specifies the minimum disk space (GB) required for running the image. The value ranges from 1 GB to 1024 GB.

                                                                            +

                                                                            Specifies the minimum disk space (GB) required for running the image. The value ranges from 1 GB to 1,024 GB.

                                                                            virtual_env_type

                                                                            +

                                                                            virtual_env_type

                                                                            String

                                                                            +

                                                                            String

                                                                            Specifies the environment where the image is used. The value can be FusionCompute, Ironic, DataImage, or IsoImage.

                                                                            +

                                                                            Specifies the environment where the image is used. The value can be FusionCompute, Ironic, DataImage, or IsoImage.

                                                                            • For an ECS image (system disk image), the value is FusionCompute.
                                                                            • For a data disk image, the value is DataImage.
                                                                            • For a BMS image, the value is Ironic.
                                                                            • For an ISO image, the value is IsoImage.

                                                                            __image_source_type

                                                                            +

                                                                            __image_source_type

                                                                            String

                                                                            +

                                                                            String

                                                                            Specifies the backend storage of the image. Only UDS is supported currently.

                                                                            +

                                                                            Specifies the backend storage of the image. Only UDS is supported currently.

                                                                            __imagetype

                                                                            +

                                                                            __imagetype

                                                                            String

                                                                            +

                                                                            String

                                                                            Specifies the image type. The following types are supported:

                                                                            +

                                                                            Specifies the image type. The following types are supported:

                                                                            • Public image: The value is gold.
                                                                            • Private image: The value is private.
                                                                            • Shared image: The value is shared.

                                                                            created_at

                                                                            +

                                                                            created_at

                                                                            String

                                                                            +

                                                                            String

                                                                            Specifies the time when the image was created. The value is in UTC format.

                                                                            +

                                                                            Specifies the time when the image was created. The value is in UTC format.

                                                                            virtual_size

                                                                            +

                                                                            virtual_size

                                                                            Integer

                                                                            +

                                                                            Integer

                                                                            This parameter is unavailable currently.

                                                                            +

                                                                            This parameter is unavailable currently.

                                                                            __originalimagename

                                                                            +

                                                                            __originalimagename

                                                                            String

                                                                            +

                                                                            String

                                                                            Specifies the parent image ID.

                                                                            +

                                                                            Specifies the parent image ID.

                                                                            If the image is a public image or created from an image file, the value is left empty.

                                                                            __backup_id

                                                                            +

                                                                            __backup_id

                                                                            String

                                                                            +

                                                                            String

                                                                            Specifies the backup ID. If the image is created from a backup, set the value to the backup ID. Otherwise, this parameter is not required.

                                                                            +

                                                                            Specifies the backup ID. If the image is created from a backup, set the value to the backup ID. Otherwise, this parameter is not required.

                                                                            __image_size

                                                                            +

                                                                            __image_size

                                                                            String

                                                                            +

                                                                            String

                                                                            Specifies the size (bytes) of the image file. The value must be greater than 0.

                                                                            +

                                                                            Specifies the size (bytes) of the image file. The value must be greater than 0.

                                                                            __data_origin

                                                                            +

                                                                            __data_origin

                                                                            String

                                                                            +

                                                                            String

                                                                            Specifies the image source.

                                                                            +

                                                                            Specifies the image source.

                                                                            If the image is a public image, the value is left empty.

                                                                            __root_origin

                                                                            +

                                                                            __root_origin

                                                                            String

                                                                            +

                                                                            String

                                                                            Specifies that the image is created from an external image file. Value: file

                                                                            +

                                                                            Specifies that the image is created from an external image file. Value: file

                                                                            __lazyloading

                                                                            +

                                                                            __lazyloading

                                                                            String

                                                                            +

                                                                            String

                                                                            Specifies whether the image supports lazy loading. The value can be true, false, True, or False.

                                                                            +

                                                                            Specifies whether the image supports lazy loading. The value can be true, false, True, or False.

                                                                            active_at

                                                                            +

                                                                            active_at

                                                                            String

                                                                            +

                                                                            String

                                                                            Specifies the time when the image status became active.

                                                                            +

                                                                            Specifies the time when the image status became active.

                                                                            __os_feature_list

                                                                            +

                                                                            __os_feature_list

                                                                            String

                                                                            +

                                                                            String

                                                                            Specifies additional attributes of the image. The value is a list (in JSON format) of advanced features supported by the image.

                                                                            +

                                                                            Specifies additional attributes of the image. The value is a list (in JSON format) of advanced features supported by the image.

                                                                            __account_code

                                                                            +

                                                                            __account_code

                                                                            String

                                                                            +

                                                                            String

                                                                            Specifies the charging identifier for the image.

                                                                            +

                                                                            Specifies the charging identifier for the image.

                                                                            hw_firmware_type

                                                                            +

                                                                            hw_firmware_type

                                                                            String

                                                                            +

                                                                            String

                                                                            Specifies the ECS boot mode. The value can be:

                                                                            +

                                                                            Specifies the ECS boot mode. The value can be:

                                                                            • bios indicates the BIOS boot mode. This value will be used by fault if this parameter does not exist in the response.
                                                                            • uefi indicates the UEFI boot mode.

                                                                            hw_vif_multiqueue_enabled

                                                                            +

                                                                            hw_vif_multiqueue_enabled

                                                                            String

                                                                            +

                                                                            String

                                                                            Specifies whether the image supports NIC multi-queue. The value can be true or false.

                                                                            +

                                                                            Specifies whether the image supports NIC multi-queue. The value can be true or false.

                                                                            __support_kvm

                                                                            +

                                                                            __support_kvm

                                                                            String

                                                                            +

                                                                            String

                                                                            Specifies whether the image supports KVM. If yes, the value is true. Otherwise, this parameter is not required.

                                                                            +

                                                                            Specifies whether the image supports KVM. If yes, the value is true. Otherwise, this parameter is not required.

                                                                            __support_xen

                                                                            +

                                                                            __support_xen

                                                                            String

                                                                            +

                                                                            String

                                                                            Specifies whether the image supports Xen. If yes, the value is true. Otherwise, this parameter is not required.

                                                                            +

                                                                            Specifies whether the image supports Xen. If yes, the value is true. Otherwise, this parameter is not required.

                                                                            __support_largememory

                                                                            +

                                                                            __support_largememory

                                                                            String

                                                                            +

                                                                            String

                                                                            Specifies whether the image can be used to create large-memory ECSs. If the image supports large-memory ECSs, the value is true. Otherwise, this parameter is not required.

                                                                            +

                                                                            Specifies whether the image can be used to create large-memory ECSs. If the image supports large-memory ECSs, the value is true. Otherwise, this parameter is not required.

                                                                            For the supported OSs, see Table 4.

                                                                            __support_diskintensive

                                                                            +

                                                                            __support_diskintensive

                                                                            String

                                                                            +

                                                                            String

                                                                            Specifies whether the image can be used to create disk-intensive ECSs. If the image supports disk-intensive ECSs, the value is true. Otherwise, this parameter is not required.

                                                                            +

                                                                            Specifies whether the image can be used to create disk-intensive ECSs. If the image supports disk-intensive ECSs, the value is true. Otherwise, this parameter is not required.

                                                                            __support_highperformance

                                                                            +

                                                                            __support_highperformance

                                                                            String

                                                                            +

                                                                            String

                                                                            Specifies whether the image can be used to create high-performance ECSs. If the image supports high-performance ECSs, the value is true. Otherwise, this parameter is not required.

                                                                            +

                                                                            Specifies whether the image can be used to create high-performance ECSs. If the image supports high-performance ECSs, the value is true. Otherwise, this parameter is not required.

                                                                            __support_xen_gpu_type

                                                                            +

                                                                            __support_xen_gpu_type

                                                                            String

                                                                            +

                                                                            String

                                                                            Specifies whether the image supports GPU-accelerated ECSs on the Xen platform. See Table 2 for its value. If the image does not support GPU-accelerated ECSs on the Xen platform, this parameter is not required. This parameter cannot co-exist with __support_xen and __support_kvm.

                                                                            +

                                                                            Specifies whether the image supports GPU-accelerated ECSs on the Xen platform. See Table 2 for its value. If the image does not support GPU-accelerated ECSs on the Xen platform, this parameter is not required. This parameter cannot co-exist with __support_xen and __support_kvm.

                                                                            __support_kvm_gpu_type

                                                                            +

                                                                            __support_kvm_gpu_type

                                                                            String

                                                                            +

                                                                            String

                                                                            Specifies whether the image supports GPU-accelerated ECSs on the KVM platform. See Table 3 for its value.

                                                                            +

                                                                            Specifies whether the image supports GPU-accelerated ECSs on the KVM platform. See Table 3 for its value.

                                                                            If the image does not support GPU-accelerated ECSs on the KVM platform, this parameter is not required. This parameter cannot co-exist with __support_xen and __support_kvm.

                                                                            __support_xen_hana

                                                                            +

                                                                            __support_xen_hana

                                                                            String

                                                                            +

                                                                            String

                                                                            Specifies whether the image supports HANA ECSs on the Xen platform. If yes, the value is true. Otherwise, this parameter is not required.

                                                                            +

                                                                            Specifies whether the image supports HANA ECSs on the Xen platform. If yes, the value is true. Otherwise, this parameter is not required.

                                                                            This parameter cannot co-exist with __support_xen and __support_kvm.

                                                                            __support_kvm_infiniband

                                                                            +

                                                                            __support_kvm_infiniband

                                                                            String

                                                                            +

                                                                            String

                                                                            Specifies whether the image supports ECSs with the InfiniBand NIC on the KVM platform. If yes, the value is true. Otherwise, this parameter is not required.

                                                                            +

                                                                            Specifies whether the image supports ECSs with InfiniBand NICs on the KVM platform. If yes, the value is true. Otherwise, this parameter is not required.

                                                                            This parameter cannot co-exist with __support_xen.

                                                                            enterprise_project_id

                                                                            +

                                                                            enterprise_project_id

                                                                            String

                                                                            +

                                                                            String

                                                                            Specifies the enterprise project that the image belongs to.

                                                                            +

                                                                            Specifies the enterprise project that the image belongs to.

                                                                            • If the value is 0 or left blank, the image belongs to the default enterprise project.
                                                                            • If the value is a UUID, the image belongs to the enterprise project corresponding to the UUID.

                                                                              For more information about enterprise projects, see Enterprise Management User Guide.

                                                                            __sequence_num

                                                                            +

                                                                            __sequence_num

                                                                            String

                                                                            +

                                                                            String

                                                                            Specifies the ECS system disk slot number corresponding to the image.

                                                                            +

                                                                            Specifies the ECS system disk slot number of the image.

                                                                            This parameter is unavailable currently.

                                                                            __support_fc_inject

                                                                            +

                                                                            __support_fc_inject

                                                                            String

                                                                            +

                                                                            String

                                                                            Specifies whether the image supports password/private key injection using Cloud-Init.

                                                                            +

                                                                            Specifies whether the image supports password/private key injection using Cloud-Init.

                                                                            If the value is set to true, password/private key injection using Cloud-Init is not supported.

                                                                            NOTE:

                                                                            This parameter is valid only for ECS system disk images.

                                                                            __image_location

                                                                            +

                                                                            __image_location

                                                                            String

                                                                            +

                                                                            String

                                                                            Specifies the location where the image is stored.

                                                                            +

                                                                            Specifies the location where the image is stored.

                                                                            __is_config_init

                                                                            +

                                                                            __is_config_init

                                                                            String

                                                                            +

                                                                            String

                                                                            Specifies whether initial configuration is complete. The value can be true or false.

                                                                            +

                                                                            Specifies whether initial configuration is complete. The value can be true or false.

                                                                            __support_amd

                                                                            +

                                                                            __support_amd

                                                                            String

                                                                            +

                                                                            String

                                                                            Specifies whether the image uses AMD's x86 architecture. The value can be true or false.

                                                                            +

                                                                            Specifies whether the image uses AMD's x86 architecture. The value can be true or false.

                                                                            __support_agent_list

                                                                            +

                                                                            __support_agent_list

                                                                            String

                                                                            +

                                                                            String

                                                                            Specifies the agents configured for the image.

                                                                            +

                                                                            Specifies the agents configured for the image.

                                                                            • hss: The Host Security Service (HSS) agent is configured for the image.

                                                                              Host Security Service (HSS) is designed to improve the overall security for ECSs. It helps you identify and manage the information on your ECSs, eliminate risks, and defend against intrusions and web page tampering.

                                                                            • ces: The host monitoring agent is configured for the image.

                                                                              Monitoring is key for ensuring ECS performance, reliability, and availability. Using monitored data, you can determine ECS resource utilization. The cloud platform provides Cloud Eye to help you obtain the running statuses of your ECSs. You can use Cloud Eye to automatically monitor ECSs in real time and manage alarms and notifications to keep track of ECS performance metrics.

                                                                            @@ -644,118 +646,117 @@
                                                                          • Example response
                                                                            STATUS CODE 200
                                                                            -
                                                                             1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
-11
-12
-13
-14
-15
-16
-17
-18
-19
-20
-21
-22
-23
-24
-25
-26
-27
-28
-29
-30
-31
-32
-33
-34
-35
-36
                                                                            {  
-    "file": "/v2/images/33ad552d-1149-471c-8190-ff6776174a00/file",  
-    "owner": "0b1e494e2660441a957313163095fe5c",  
-    "id": "33ad552d-1149-471c-8190-ff6776174a00",  
-    "size": 2,  
-    "self": "/v2/images/33ad552d-1149-471c-8190-ff6776174a00",  
-    "schema": "/v2/schemas/image",  
-    "status": "active",  
-    "tags": [],  
-    "visibility": "private",  
-    "name": "ims_test",  
-    "checksum": "99914b932bd37a50b983c5e7c90ae93b",  
-    "protected": false,  
-    "container_format": "bare",  
-    "min_ram": 0,  
-    "updated_at": "2015-12-08T02:30:49Z",  
-    "__os_bit": "64",  
-    "__os_version": "Ubuntu 14.04 server 64bit",  
-    "__description": "ims test",  
-    "disk_format": "vhd",  
-    "__isregistered": "true",  
-    "__platform": "Ubuntu",  
-    "__os_type": "Linux",  
-    "min_disk": 40,  
-    "virtual_env_type": "FusionCompute",  
-    "__image_source_type": "uds",  
-    "__imagetype": "private",  
-    "created_at": "2015-12-04T09:45:33Z",  
-    "virtual_size": 0,  
-    "__originalimagename": "33ad552d-1149-471c-8190-ff6776174a00",  
-    "__backup_id": "",  
-    "__productcode": "",  
-    "__image_size": "449261568",  
-    "__data_origin": null,
-    "hw_firmware_type":"bios"
+
                                                                             1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
+13
+14
+15
+16
+17
+18
+19
+20
+21
+22
+23
+24
+25
+26
+27
+28
+29
+30
+31
+32
+33
+34
+35
+36
                                                                            {  
+    "file": "/v2/images/33ad552d-1149-471c-8190-ff6776174a00/file",  
+    "owner": "0b1e494e2660441a957313163095fe5c",  
+    "id": "33ad552d-1149-471c-8190-ff6776174a00",  
+    "size": 2,  
+    "self": "/v2/images/33ad552d-1149-471c-8190-ff6776174a00",  
+    "schema": "/v2/schemas/image",  
+    "status": "active",  
+    "tags": [],  
+    "visibility": "private",  
+    "name": "ims_test",  
+    "checksum": "99914b932bd37a50b983c5e7c90ae93b",  
+    "protected": false,  
+    "container_format": "bare",  
+    "min_ram": 0,  
+    "updated_at": "2015-12-08T02:30:49Z",  
+    "__os_bit": "64",  
+    "__os_version": "Ubuntu 14.04 server 64bit",  
+    "__description": "ims test",  
+    "disk_format": "vhd",  
+    "__isregistered": "true",  
+    "__platform": "Ubuntu",  
+    "__os_type": "Linux",  
+    "min_disk": 40,  
+    "virtual_env_type": "FusionCompute",  
+    "__image_source_type": "uds",  
+    "__imagetype": "private",  
+    "created_at": "2015-12-04T09:45:33Z",  
+    "virtual_size": 0,  
+    "__originalimagename": "33ad552d-1149-471c-8190-ff6776174a00",  
+    "__backup_id": "",  
+    "__productcode": "",  
+    "__image_size": "449261568",  
+    "__data_origin": null,
+    "hw_firmware_type":"bios"
 }
-
                                                                            
-
-
                                                                            + +

                                                                            • Returned Values

                                                                            • Normal

                                                                              200

                                                                            • Abnormal -

                                                                              Returned Value

                                                                              +
                                                                              - - - - - - - - - - - - - diff --git a/docs/ims/api-ref/en-us_topic_0066978719.html b/docs/ims/api-ref/en-us_topic_0066978719.html index 93c20b1fc..4016858f0 100644 --- a/docs/ims/api-ref/en-us_topic_0066978719.html +++ b/docs/ims/api-ref/en-us_topic_0066978719.html @@ -6,23 +6,25 @@

                                                                              URI

                                                                              GET /

                                                                              Request

                                                                              • Request parameters

                                                                                None

                                                                                -
                                                                              • Example request
                                                                                GET https://{Endpoint}/
                                                                              +

                                                                              Example Request

                                                                              Querying API versions

                                                                              +
                                                                              GET https://{Endpoint}/
                                                                              +

                                                                              Response

                                                                              • Response parameters -

                                                                              Returned Value

                                                                              Description

                                                                              +

                                                                              Description

                                                                              400 Bad Request

                                                                              +

                                                                              400 Bad Request

                                                                              Request error. For details, see Error Codes.

                                                                              +

                                                                              Request error. For details, see Error Codes.

                                                                              401 Unauthorized

                                                                              +

                                                                              401 Unauthorized

                                                                              Authentication failed.

                                                                              +

                                                                              Authentication failed.

                                                                              403 Forbidden

                                                                              +

                                                                              403 Forbidden

                                                                              You do not have the rights to perform the operation.

                                                                              +

                                                                              You do not have the rights to perform the operation.

                                                                              404 Not Found

                                                                              +

                                                                              404 Not Found

                                                                              The requested resource was not found.

                                                                              +

                                                                              The requested resource was not found.

                                                                              500 Internal Server Error

                                                                              +

                                                                              500 Internal Server Error

                                                                              Internal service error.

                                                                              +

                                                                              Internal service error.

                                                                              503 Service Unavailable

                                                                              +

                                                                              503 Service Unavailable

                                                                              The service is unavailable.

                                                                              +

                                                                              The service is unavailable.

                                                                              Parameter

                                                                              +
                                                                              - - - - - @@ -30,33 +32,33 @@

                                                                              Parameter

                                                                              Type

                                                                              +

                                                                              Type

                                                                              Description

                                                                              +

                                                                              Description

                                                                              versions

                                                                              +

                                                                              versions

                                                                              Array of objects

                                                                              +

                                                                              Array of objects

                                                                              Specifies the versions.

                                                                              +

                                                                              Specifies the versions.

                                                                              For details, see Table 1.
                                                                              -
                                                                              Table 1 Data structure description of the versions field

                                                                              Parameter

                                                                              +
                                                                              - - - - - - - - - - - @@ -64,180 +66,179 @@
                                                                              Table 1 Data structure description of the versions field

                                                                              Parameter

                                                                              Type

                                                                              +

                                                                              Type

                                                                              Description

                                                                              +

                                                                              Description

                                                                              status

                                                                              +

                                                                              status

                                                                              String

                                                                              +

                                                                              String

                                                                              Specifies the API status.

                                                                              +

                                                                              Specifies the API status.

                                                                              id

                                                                              +

                                                                              id

                                                                              String

                                                                              +

                                                                              String

                                                                              Specifies the API ID.

                                                                              +

                                                                              Specifies the API ID.

                                                                              links

                                                                              +

                                                                              links

                                                                              Array of objects

                                                                              +

                                                                              Array of objects

                                                                              Specifies the description.

                                                                              +

                                                                              Specifies the description.

                                                                              For details, see Table 2.
                                                                              -
                                                                              Table 2 Data structure description of the versions.links field

                                                                              Parameter

                                                                              +
                                                                              - - - - - - - -
                                                                              Table 2 Data structure description of the versions.links field

                                                                              Parameter

                                                                              Type

                                                                              +

                                                                              Type

                                                                              Description

                                                                              +

                                                                              Description

                                                                              href

                                                                              +

                                                                              href

                                                                              String

                                                                              +

                                                                              String

                                                                              Specifies the domain name.

                                                                              +

                                                                              Specifies the domain name.

                                                                              rel

                                                                              +

                                                                              rel

                                                                              String

                                                                              +

                                                                              String

                                                                              Specifies the domain name description.

                                                                              +

                                                                              Specifies the domain name description.
                                                                            • Example response
                                                                              STATUS CODE 300
                                                                              -
                                                                               1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
-11
-12
-13
-14
-15
-16
-17
-18
-19
-20
-21
-22
-23
-24
-25
-26
-27
-28
-29
-30
-31
-32
-33
-34
-35
-36
-37
-38
-39
-40
-41
-42
-43
-44
-45
-46
-47
-48
-49
-50
-51
-52
-53
-54
                                                                              {
-    "versions": [
-        {
-            "status": "CURRENT",
-            "id": "v2.2",
-            "links": [
-                {
-                    "href": "https://image.az1.dc1.domainname.com/v2/",
-                    "rel": "self"
-                }
-            ]
-        },
-        {
-            "status": "SUPPORTED",
-            "id": "v2.1",
-            "links": [
-                {
-                    "href": "https://image.az1.dc1.domainname.com/v2/",
-                    "rel": "self"
-                }
-            ]
-        },
-        {
-            "status": "SUPPORTED",
-            "id": "v2.0",
-            "links": [
-                {
-                    "href": "https://image.az1.dc1.domainname.com/v2/",
-                    "rel": "self"
-                }
-            ]
-        },
-        {
-            "status": "DEPRECATED",
-            "id": "v1.1",
-            "links": [
-                {
-                    "href": "https://image.az1.dc1.domainname.com/v1/",
-                    "rel": "self"
-                }
-            ]
-        },
-        {
-            "status": "DEPRECATED",
-            "id": "v1.0",
-            "links": [
-                {
-                    "href": "https://image.az1.dc1.domainname.com/v1/",
-                    "rel": "self"
-                }
-            ]
-        }
-    ]
+
                                                                               1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
+13
+14
+15
+16
+17
+18
+19
+20
+21
+22
+23
+24
+25
+26
+27
+28
+29
+30
+31
+32
+33
+34
+35
+36
+37
+38
+39
+40
+41
+42
+43
+44
+45
+46
+47
+48
+49
+50
+51
+52
+53
+54
                                                                              {
+    "versions": [
+        {
+            "status": "CURRENT",
+            "id": "v2.2",
+            "links": [
+                {
+                    "href": "https://image.az1.dc1.domainname.com/v2/",
+                    "rel": "self"
+                }
+            ]
+        },
+        {
+            "status": "SUPPORTED",
+            "id": "v2.1",
+            "links": [
+                {
+                    "href": "https://image.az1.dc1.domainname.com/v2/",
+                    "rel": "self"
+                }
+            ]
+        },
+        {
+            "status": "SUPPORTED",
+            "id": "v2.0",
+            "links": [
+                {
+                    "href": "https://image.az1.dc1.domainname.com/v2/",
+                    "rel": "self"
+                }
+            ]
+        },
+        {
+            "status": "DEPRECATED",
+            "id": "v1.1",
+            "links": [
+                {
+                    "href": "https://image.az1.dc1.domainname.com/v1/",
+                    "rel": "self"
+                }
+            ]
+        },
+        {
+            "status": "DEPRECATED",
+            "id": "v1.0",
+            "links": [
+                {
+                    "href": "https://image.az1.dc1.domainname.com/v1/",
+                    "rel": "self"
+                }
+            ]
+        }
+    ]
 }
-
                                                                              
-
-
                                                                              + +

                                                                              • Returned Values

                                                                              • Normal

                                                                                300

                                                                              • Abnormal -

                                                                                Returned Value

                                                                                +
                                                                                - - - - - - - - - - - - - diff --git a/docs/ims/api-ref/en-us_topic_0066978720.html b/docs/ims/api-ref/en-us_topic_0066978720.html index 6e4ce9663..043892114 100644 --- a/docs/ims/api-ref/en-us_topic_0066978720.html +++ b/docs/ims/api-ref/en-us_topic_0066978720.html @@ -6,324 +6,325 @@

                                                                                URI

                                                                                GET /v1.1/images/detail

                                                                                -

                                                                                Request

                                                                                • Request parameters

                                                                                  Parameters name, container_format, disk_format, status, size_min, size_max, and changes-since can be used to filter the query result.

                                                                                  +

                                                                                  Request

                                                                                  Request parameters

                                                                                  +

                                                                                  Parameters name, container_format, disk_format, status, size_min, size_max, and changes-since can be used to filter the query result.

                                                                                  -

                                                                                Returned Value

                                                                                Description

                                                                                +

                                                                                Description

                                                                                400 Bad Request

                                                                                +

                                                                                400 Bad Request

                                                                                Request error.

                                                                                +

                                                                                Request error.

                                                                                401 Unauthorized

                                                                                +

                                                                                401 Unauthorized

                                                                                Authentication failed.

                                                                                +

                                                                                Authentication failed.

                                                                                403 Forbidden

                                                                                +

                                                                                403 Forbidden

                                                                                You do not have the rights to perform the operation.

                                                                                +

                                                                                You do not have the rights to perform the operation.

                                                                                404 Not Found

                                                                                +

                                                                                404 Not Found

                                                                                The requested resource was not found.

                                                                                +

                                                                                The requested resource was not found.

                                                                                500 Internal Server Error

                                                                                +

                                                                                500 Internal Server Error

                                                                                Internal service error.

                                                                                +

                                                                                Internal service error.

                                                                                503 Service Unavailable

                                                                                +

                                                                                503 Service Unavailable

                                                                                The service is unavailable.

                                                                                +

                                                                                The service is unavailable.

                                                                                Parameter

                                                                                +
                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

                                                                                Parameter

                                                                                Mandatory

                                                                                +

                                                                                Mandatory

                                                                                Type

                                                                                +

                                                                                Type

                                                                                Description

                                                                                +

                                                                                Description

                                                                                name

                                                                                +

                                                                                name

                                                                                No

                                                                                +

                                                                                No

                                                                                String

                                                                                +

                                                                                String

                                                                                Specifies the image name. For detailed description, see Image Attributes.

                                                                                +

                                                                                Specifies the image name. For detailed description, see Image Attributes.

                                                                                container_format

                                                                                +

                                                                                container_format

                                                                                No

                                                                                +

                                                                                No

                                                                                String

                                                                                +

                                                                                String

                                                                                Image container type

                                                                                +

                                                                                Image container type

                                                                                disk_format

                                                                                +

                                                                                disk_format

                                                                                No

                                                                                +

                                                                                No

                                                                                String

                                                                                +

                                                                                String

                                                                                Image file format

                                                                                +

                                                                                Image file format

                                                                                status

                                                                                +

                                                                                status

                                                                                No

                                                                                +

                                                                                No

                                                                                String

                                                                                +

                                                                                String

                                                                                Image status

                                                                                +

                                                                                Image status

                                                                                size_min

                                                                                +

                                                                                size_min

                                                                                No

                                                                                +

                                                                                No

                                                                                String

                                                                                +

                                                                                String

                                                                                Minimum size of the image

                                                                                +

                                                                                Minimum size of the image

                                                                                size_max

                                                                                +

                                                                                size_max

                                                                                No

                                                                                +

                                                                                No

                                                                                String

                                                                                +

                                                                                String

                                                                                Maximum size of the image

                                                                                +

                                                                                Maximum size of the image

                                                                                changes-since

                                                                                +

                                                                                changes-since

                                                                                No

                                                                                +

                                                                                No

                                                                                String

                                                                                +

                                                                                String

                                                                                Last update time

                                                                                +

                                                                                Last update time
                                                                                -
                                                                              • Example request
                                                                                GET https://{Endpoint}/v1.1/images/detail?disk_format=qcow2
                                                                                -
                                                                                • + +

                                                                                Example Request

                                                                                Querying image details

                                                                                +
                                                                                GET https://{Endpoint}/v1.1/images/detail?disk_format=qcow2

                                                                                Response

                                                                                • Response parameters -

                                                                                  Parameter

                                                                                  +
                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

                                                                                  Parameter

                                                                                  Type

                                                                                  +

                                                                                  Type

                                                                                  Description

                                                                                  +

                                                                                  Description

                                                                                  status

                                                                                  +

                                                                                  status

                                                                                  String

                                                                                  +

                                                                                  String

                                                                                  Image status

                                                                                  +

                                                                                  Image status

                                                                                  virtual_size

                                                                                  +

                                                                                  virtual_size

                                                                                  Integer

                                                                                  +

                                                                                  Integer

                                                                                  Virtual size of an image

                                                                                  +

                                                                                  Virtual size of an image

                                                                                  name

                                                                                  +

                                                                                  name

                                                                                  String

                                                                                  +

                                                                                  String

                                                                                  Specifies the image name. For detailed description, see Image Attributes.

                                                                                  +

                                                                                  Specifies the image name. For detailed description, see Image Attributes.

                                                                                  deleted

                                                                                  +

                                                                                  deleted

                                                                                  Boolean

                                                                                  +

                                                                                  Boolean

                                                                                  Whether an image has been deleted

                                                                                  +

                                                                                  Whether an image has been deleted

                                                                                  container_format

                                                                                  +

                                                                                  container_format

                                                                                  String

                                                                                  +

                                                                                  String

                                                                                  Image container type

                                                                                  +

                                                                                  Image container type

                                                                                  created_at

                                                                                  +

                                                                                  created_at

                                                                                  String

                                                                                  +

                                                                                  String

                                                                                  Time when an image was created

                                                                                  +

                                                                                  Time when an image was created

                                                                                  disk_format

                                                                                  +

                                                                                  disk_format

                                                                                  String

                                                                                  +

                                                                                  String

                                                                                  Image file type

                                                                                  +

                                                                                  Image file type

                                                                                  updated_at

                                                                                  +

                                                                                  updated_at

                                                                                  String

                                                                                  +

                                                                                  String

                                                                                  Time when an image was updated

                                                                                  +

                                                                                  Time when an image was updated

                                                                                  properties

                                                                                  +

                                                                                  properties

                                                                                  Object

                                                                                  +

                                                                                  Object

                                                                                  Image attribute

                                                                                  +

                                                                                  Image attribute

                                                                                  owner

                                                                                  +

                                                                                  owner

                                                                                  String

                                                                                  +

                                                                                  String

                                                                                  Tenant to which an image belongs

                                                                                  +

                                                                                  Tenant to which an image belongs

                                                                                  protected

                                                                                  +

                                                                                  protected

                                                                                  Boolean

                                                                                  +

                                                                                  Boolean

                                                                                  Whether an image is protected

                                                                                  +

                                                                                  Whether an image is protected

                                                                                  min_ram

                                                                                  +

                                                                                  min_ram

                                                                                  Integer

                                                                                  +

                                                                                  Integer

                                                                                  Minimum memory (MB) required for running an image

                                                                                  +

                                                                                  Minimum memory (MB) required for running an image

                                                                                  checksum

                                                                                  +

                                                                                  checksum

                                                                                  String

                                                                                  +

                                                                                  String

                                                                                  Image verification sum. This parameter is available after an image file is uploaded.

                                                                                  +

                                                                                  Image verification sum. This parameter is available after an image file is uploaded.

                                                                                  min_disk

                                                                                  +

                                                                                  min_disk

                                                                                  Integer

                                                                                  +

                                                                                  Integer

                                                                                  Minimum disk capacity (GB) required for running the image

                                                                                  +

                                                                                  Minimum disk capacity (GB) required for running the image

                                                                                  is_public

                                                                                  +

                                                                                  is_public

                                                                                  Boolean

                                                                                  +

                                                                                  Boolean

                                                                                  Whether an image is a public one

                                                                                  +

                                                                                  Whether an image is a public one

                                                                                  deleted_at

                                                                                  +

                                                                                  deleted_at

                                                                                  String

                                                                                  +

                                                                                  String

                                                                                  Time when an image was deleted

                                                                                  +

                                                                                  Time when an image was deleted

                                                                                  id

                                                                                  +

                                                                                  id

                                                                                  String

                                                                                  +

                                                                                  String

                                                                                  Image UUID

                                                                                  +

                                                                                  Image UUID

                                                                                  size

                                                                                  +

                                                                                  size

                                                                                  Integer

                                                                                  +

                                                                                  Integer

                                                                                  Image size. This parameter is available after an image file is uploaded.

                                                                                  +

                                                                                  Image size. This parameter is available after an image file is uploaded.
                                                                                • Example response
                                                                                  HTTP/1.1 200 OK
                                                                                  -
                                                                                   1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
-11
-12
-13
-14
-15
-16
-17
-18
-19
-20
-21
-22
-23
-24
-25
-26
-27
-28
-29
                                                                                  Content-Type: application/json; charset=UTF-8
-Content-Length: 495
-X-Openstack-Request-Id: req-68327dda-8078-41fe-b091-01a09ec073da
-Date: Mon, 23 May 2016 02:32:28 GMT
+
                                                                                   1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
+13
+14
+15
+16
+17
+18
+19
+20
+21
+22
+23
+24
+25
+26
+27
+28
+29
                                                                                  Content-Type: application/json; charset=UTF-8
+Content-Length: 495
+X-Openstack-Request-Id: req-68327dda-8078-41fe-b091-01a09ec073da
+Date: Mon, 23 May 2016 02:32:28 GMT
 {
-    "images": [
-        {
-            "status": "active",
-            "deleted_at": null,
-            "name": "cirros",
-            "deleted": false,
-            "container_format": "bare",
-            "created_at": "2016-05-22T06:04:20.425843",
-            "disk_format": "qcow2",
-            "updated_at": "2016-05-22T06:04:22.719791",
-            "min_disk": 0,
-            "protected": false,
-            "id": "3c3d1d01-b48a-4639-8a88-08be3b9b5d78",
-            "min_ram": 0,
-            "checksum": "64d7c1cd2b6f60c92c14662941cb7913",
-            "owner": "23f4cb75768d4febb39542ef6fe169f3",
-            "is_public": true,
-            "virtual_size": null,
-            "properties": {
-            },
-            "size": 13167616
-        }
-    ]
+    "images": [
+        {
+            "status": "active",
+            "deleted_at": null,
+            "name": "cirros",
+            "deleted": false,
+            "container_format": "bare",
+            "created_at": "2016-05-22T06:04:20.425843",
+            "disk_format": "qcow2",
+            "updated_at": "2016-05-22T06:04:22.719791",
+            "min_disk": 0,
+            "protected": false,
+            "id": "3c3d1d01-b48a-4639-8a88-08be3b9b5d78",
+            "min_ram": 0,
+            "checksum": "64d7c1cd2b6f60c92c14662941cb7913",
+            "owner": "23f4cb75768d4febb39542ef6fe169f3",
+            "is_public": true,
+            "virtual_size": null,
+            "properties": {
+            },
+            "size": 13167616
+        }
+    ]
 }
-
                                                                                  
-
-
                                                                                  + +

                                                                                  • Returned Values

                                                                                  • Normal

                                                                                    200

                                                                                  • Abnormal -

                                                                                    Returned Values

                                                                                    +
                                                                                    - - - - - - - - - - - - - diff --git a/docs/ims/api-ref/en-us_topic_0066978721.html b/docs/ims/api-ref/en-us_topic_0066978721.html index 84f871656..9695ca447 100644 --- a/docs/ims/api-ref/en-us_topic_0066978721.html +++ b/docs/ims/api-ref/en-us_topic_0066978721.html @@ -30,143 +30,145 @@ -

                                                                                    Request

                                                                                    • Request parameters

                                                                                      None

                                                                                      -
                                                                                    • Example request
                                                                                      HEAD https://{Endpoint}/v1/images/3c3d1d01-b48a-4639-8a88-08be3b9b5d78
                                                                                      -
                                                                                    +

                                                                                    Request

                                                                                    Request parameters

                                                                                    +

                                                                                    None

                                                                                    +
                                                                                    +

                                                                                    Example Request

                                                                                    Querying image metadata

                                                                                    +
                                                                                    HEAD https://{Endpoint}/v1/images/3c3d1d01-b48a-4639-8a88-08be3b9b5d78

                                                                                    Response

                                                                                    • Response parameters -

                                                                                    Returned Values

                                                                                    Description

                                                                                    +

                                                                                    Description

                                                                                    400 Bad Request

                                                                                    +

                                                                                    400 Bad Request

                                                                                    Request error.

                                                                                    +

                                                                                    Request error.

                                                                                    401 Unauthorized

                                                                                    +

                                                                                    401 Unauthorized

                                                                                    Authentication failed.

                                                                                    +

                                                                                    Authentication failed.

                                                                                    403 Forbidden

                                                                                    +

                                                                                    403 Forbidden

                                                                                    You do not have the rights to perform the operation.

                                                                                    +

                                                                                    You do not have the rights to perform the operation.

                                                                                    404 Not Found

                                                                                    +

                                                                                    404 Not Found

                                                                                    The requested resource was not found.

                                                                                    +

                                                                                    The requested resource was not found.

                                                                                    500 Internal Server Error

                                                                                    +

                                                                                    500 Internal Server Error

                                                                                    Internal service error.

                                                                                    +

                                                                                    Internal service error.

                                                                                    503 Service Unavailable

                                                                                    +

                                                                                    503 Service Unavailable

                                                                                    The service is unavailable.

                                                                                    +

                                                                                    The service is unavailable.

                                                                                    Parameter

                                                                                    +
                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -174,86 +176,85 @@

                                                                                    These parameters are contained in the header of the HTTP response message.

                                                                                  • Example response
                                                                                    HTTP/1.1 200 OK
                                                                                    -

                                                                                    • Parameter

                                                                                    Type

                                                                                    +

                                                                                    Type

                                                                                    Description

                                                                                    +

                                                                                    Description

                                                                                    Status

                                                                                    +

                                                                                    Status

                                                                                    String

                                                                                    +

                                                                                    String

                                                                                    Image status

                                                                                    +

                                                                                    Image status

                                                                                    Virtual_size

                                                                                    +

                                                                                    Virtual_size

                                                                                    Integer

                                                                                    +

                                                                                    Integer

                                                                                    Virtual size of an image

                                                                                    +

                                                                                    Virtual size of an image

                                                                                    Name

                                                                                    +

                                                                                    Name

                                                                                    String

                                                                                    +

                                                                                    String

                                                                                    Image name

                                                                                    +

                                                                                    Image name

                                                                                    Deleted

                                                                                    +

                                                                                    Deleted

                                                                                    Boolean

                                                                                    +

                                                                                    Boolean

                                                                                    Whether an image has been deleted

                                                                                    +

                                                                                    Whether an image has been deleted

                                                                                    Container_format

                                                                                    +

                                                                                    Container_format

                                                                                    String

                                                                                    +

                                                                                    String

                                                                                    Image container type

                                                                                    +

                                                                                    Image container type

                                                                                    Created_at

                                                                                    +

                                                                                    Created_at

                                                                                    String

                                                                                    +

                                                                                    String

                                                                                    Time when an image was created

                                                                                    +

                                                                                    Time when an image was created

                                                                                    Disk_format

                                                                                    +

                                                                                    Disk_format

                                                                                    String

                                                                                    +

                                                                                    String

                                                                                    Image file type

                                                                                    +

                                                                                    Image file type

                                                                                    Updated_at

                                                                                    +

                                                                                    Updated_at

                                                                                    String

                                                                                    +

                                                                                    String

                                                                                    Time when an image was updated

                                                                                    +

                                                                                    Time when an image was updated

                                                                                    Property

                                                                                    +

                                                                                    Property

                                                                                    Object

                                                                                    +

                                                                                    Object

                                                                                    Image attribute

                                                                                    +

                                                                                    Image attribute

                                                                                    Owner

                                                                                    +

                                                                                    Owner

                                                                                    String

                                                                                    +

                                                                                    String

                                                                                    Tenant to which an image belongs

                                                                                    +

                                                                                    Tenant to which an image belongs

                                                                                    Protected

                                                                                    +

                                                                                    Protected

                                                                                    Boolean

                                                                                    +

                                                                                    Boolean

                                                                                    Whether an image is protected

                                                                                    +

                                                                                    Whether an image is protected

                                                                                    Min_ram

                                                                                    +

                                                                                    Min_ram

                                                                                    Integer

                                                                                    +

                                                                                    Integer

                                                                                    Minimum memory (MB) required for running an image

                                                                                    +

                                                                                    Minimum memory (MB) required for running an image

                                                                                    Checksum

                                                                                    +

                                                                                    Checksum

                                                                                    String

                                                                                    +

                                                                                    String

                                                                                    Image verification sum. This parameter is available after an image file is uploaded.

                                                                                    +

                                                                                    Image verification sum. This parameter is available after an image file is uploaded.

                                                                                    Min_disk

                                                                                    +

                                                                                    Min_disk

                                                                                    Integer

                                                                                    +

                                                                                    Integer

                                                                                    Minimum disk capacity (GB) required for running the image

                                                                                    +

                                                                                    Minimum disk capacity (GB) required for running the image

                                                                                    Is_public

                                                                                    +

                                                                                    Is_public

                                                                                    Boolean

                                                                                    +

                                                                                    Boolean

                                                                                    Whether an image is a public one

                                                                                    +

                                                                                    Whether an image is a public one

                                                                                    Deleted_at

                                                                                    +

                                                                                    Deleted_at

                                                                                    String

                                                                                    +

                                                                                    String

                                                                                    Time when an image was deleted

                                                                                    +

                                                                                    Time when an image was deleted

                                                                                    Id

                                                                                    +

                                                                                    Id

                                                                                    String

                                                                                    +

                                                                                    String

                                                                                    Image UUID

                                                                                    +

                                                                                    Image UUID

                                                                                    Size

                                                                                    +

                                                                                    Size

                                                                                    Integer

                                                                                    +

                                                                                    Integer

                                                                                    Image size. This parameter is available after an image file is uploaded.

                                                                                    +

                                                                                    Image size. This parameter is available after an image file is uploaded.

                                                                                    		 
                                                                                     1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
-11
-12
-13
-14
-15
-16
-17
-18
-19
-20
                                                                                    Content-Type: text/html; charset=UTF-8
-Content-Length: 0
-X-Image-Meta-Id: 3c3d1d01-b48a-4639-8a88-08be3b9b5d78
-X-Image-Meta-Deleted: False
-X-Image-Meta-Container_format: bare
-X-Image-Meta-Checksum: 64d7c1cd2b6f60c92c14662941cb7913
-X-Image-Meta-Protected: False
-X-Image-Meta-Min_disk: 0
-X-Image-Meta-Created_at: 2016-05-22T06:04:20.425843
-X-Image-Meta-Size: 13167616
-X-Image-Meta-Status: active
-X-Image-Meta-Is_public: True
-X-Image-Meta-Min_ram: 0
-X-Image-Meta-Owner: 23f4cb75768d4febb39542ef6fe169f3
-X-Image-Meta-Updated_at: 2016-05-22T06:04:22.719791
-X-Image-Meta-Disk_format: qcow2
-X-Image-Meta-Name: cirros
-Etag: 64d7c1cd2b6f60c92c14662941cb7913
-X-Openstack-Request-Id: req-7123ca83-da23-4f4e-9ed6-accd3707d333
-Date: Mon, 23 May 2016 02:29:54 GMT
-
                                                                                    - - +
                                                                                     1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
+13
+14
+15
+16
+17
+18
+19
+20
                                                                                    Content-Type: text/html; charset=UTF-8
+Content-Length: 0
+X-Image-Meta-Id: 3c3d1d01-b48a-4639-8a88-08be3b9b5d78
+X-Image-Meta-Deleted: False
+X-Image-Meta-Container_format: bare
+X-Image-Meta-Checksum: 64d7c1cd2b6f60c92c14662941cb7913
+X-Image-Meta-Protected: False
+X-Image-Meta-Min_disk: 0
+X-Image-Meta-Created_at: 2016-05-22T06:04:20.425843
+X-Image-Meta-Size: 13167616
+X-Image-Meta-Status: active
+X-Image-Meta-Is_public: True
+X-Image-Meta-Min_ram: 0
+X-Image-Meta-Owner: 23f4cb75768d4febb39542ef6fe169f3
+X-Image-Meta-Updated_at: 2016-05-22T06:04:22.719791
+X-Image-Meta-Disk_format: qcow2
+X-Image-Meta-Name: cirros
+Etag: 64d7c1cd2b6f60c92c14662941cb7913
+X-Openstack-Request-Id: req-7123ca83-da23-4f4e-9ed6-accd3707d333
+Date: Mon, 23 May 2016 02:29:54 GMT
+
                                                                                    +

                                                                                    Returned Values

                                                                                    • Normal

                                                                                      200

                                                                                    • Abnormal -

                                                                                      Returned Value

                                                                                      +
                                                                                      - - - - - - - - - - - - - diff --git a/docs/ims/api-ref/en-us_topic_0066978722.html b/docs/ims/api-ref/en-us_topic_0066978722.html index 0c849ac68..85144635f 100644 --- a/docs/ims/api-ref/en-us_topic_0066978722.html +++ b/docs/ims/api-ref/en-us_topic_0066978722.html @@ -30,60 +30,61 @@ -

                                                                                      Request

                                                                                      • Request parameters

                                                                                        None

                                                                                        -
                                                                                      • Example request
                                                                                        DELETE https://{Endpoint}/v1.1/images/3c3d1d01-b48a-4639-8a88-08be3b9b5d78
                                                                                        -
                                                                                      +

                                                                                      Request

                                                                                      Request parameters

                                                                                      +

                                                                                      None

                                                                                      +
                                                                                      +

                                                                                      Example Request

                                                                                      Deleting an image

                                                                                      +
                                                                                      DELETE https://{Endpoint}/v1.1/images/3c3d1d01-b48a-4639-8a88-08be3b9b5d78

                                                                                      Response

                                                                                      • Response parameters

                                                                                        None

                                                                                      • Example response
                                                                                        HTTP/1.1 200 OK
                                                                                        -

                                                                                      Returned Value

                                                                                      Description

                                                                                      +

                                                                                      Description

                                                                                      400 Bad Request

                                                                                      +

                                                                                      400 Bad Request

                                                                                      Request error.

                                                                                      +

                                                                                      Request error.

                                                                                      401 Unauthorized

                                                                                      +

                                                                                      401 Unauthorized

                                                                                      Authentication failed.

                                                                                      +

                                                                                      Authentication failed.

                                                                                      403 Forbidden

                                                                                      +

                                                                                      403 Forbidden

                                                                                      You do not have the rights to perform the operation.

                                                                                      +

                                                                                      You do not have the rights to perform the operation.

                                                                                      404 Not Found

                                                                                      +

                                                                                      404 Not Found

                                                                                      The requested resource was not found.

                                                                                      +

                                                                                      The requested resource was not found.

                                                                                      500 Internal Server Error

                                                                                      +

                                                                                      500 Internal Server Error

                                                                                      Internal service error.

                                                                                      +

                                                                                      Internal service error.

                                                                                      503 Service Unavailable

                                                                                      +

                                                                                      503 Service Unavailable

                                                                                      The service is unavailable.

                                                                                      +

                                                                                      The service is unavailable.

                                                                                      		 
                                                                                      1
-2
-3
-4
                                                                                      Content-Type: text/html; charset=UTF-8
-Content-Length: 0
-X-Openstack-Request-Id: req-75e9edca-7b43-47da-bdc5-d39be469b72f
-Date: Mon, 23 May 2016 02:43:34 GMT
-
                                                                                      - - +
                                                                                      1
+2
+3
+4
                                                                                      Content-Type: text/html; charset=UTF-8
+Content-Length: 0
+X-Openstack-Request-Id: req-75e9edca-7b43-47da-bdc5-d39be469b72f
+Date: Mon, 23 May 2016 02:43:34 GMT
+
                                                                                      +

                                                                                      Returned Values

                                                                                      • Normal

                                                                                        204

                                                                                      • Abnormal -

                                                                                        Returned Values

                                                                                        +
                                                                                        - - - - - - - - - - - - - diff --git a/docs/ims/api-ref/en-us_topic_0067360381.html b/docs/ims/api-ref/en-us_topic_0067360381.html index 7bca26667..dcd5e4e0a 100644 --- a/docs/ims/api-ref/en-us_topic_0067360381.html +++ b/docs/ims/api-ref/en-us_topic_0067360381.html @@ -43,7 +43,7 @@ @@ -80,30 +80,31 @@

                                                                                        Returned Values

                                                                                        Description

                                                                                        +

                                                                                        Description

                                                                                        400 Bad Request

                                                                                        +

                                                                                        400 Bad Request

                                                                                        Request error.

                                                                                        +

                                                                                        Request error.

                                                                                        401 Unauthorized

                                                                                        +

                                                                                        401 Unauthorized

                                                                                        Authentication failed.

                                                                                        +

                                                                                        Authentication failed.

                                                                                        403 Forbidden

                                                                                        +

                                                                                        403 Forbidden

                                                                                        You do not have the rights to perform the operation.

                                                                                        +

                                                                                        You do not have the rights to perform the operation.

                                                                                        404 Not Found

                                                                                        +

                                                                                        404 Not Found

                                                                                        The requested resource was not found.

                                                                                        +

                                                                                        The requested resource was not found.

                                                                                        500 Internal Server Error

                                                                                        +

                                                                                        500 Internal Server Error

                                                                                        Internal service error.

                                                                                        +

                                                                                        Internal service error.

                                                                                        503 Service Unavailable

                                                                                        +

                                                                                        503 Service Unavailable

                                                                                        The service is unavailable.

                                                                                        +

                                                                                        The service is unavailable.

                                                                                        Object

                                                                                        Lists the image tags. For detailed description, see Image Tag Data Formats. This parameter is left blank by default.

                                                                                        -

                                                                                        Use either tag or image_tag.

                                                                                        +

                                                                                        Use either tag or image_tag.
                                                                                        -
                                                                                        -
                                                                                      • Example request
                                                                                        • Example request containing parameter tag
                                                                                          PUT https://{Endpoint}/v1/cloudimages/tags
                                                                                          -
                                                                                          1
-2
-3
-4
                                                                                          {
-  "image_id": "62a15f6c-9197-44d2-89c7-708981c1bec1",
-  "tag": "aaaa.1111"
-}
-
                                                                                          - -
                                                                                          -
                                                                                        • Example request containing parameter image_tag
                                                                                          PUT https://{Endpoint}/v1/cloudimages/tags
                                                                                          -
                                                                                          1
-2
-3
-4
                                                                                          {
-  "image_id": "67437ebd-2563-46e0-887e-ad1923977fa1",
-  "image_tag": {"key":"key1","value":"value1"}
-}
-
                                                                                          -
                                                                                        + +

                                                                                        Example Request

                                                                                        • Adding or modifying a tag (parameter: tags)
                                                                                          1
+2
+3
+4
+5
                                                                                          PUT https://{Endpoint}/v1/cloudimages/tags
+{
+  "image_id": "62a15f6c-9197-44d2-89c7-708981c1bec1",
+  "tag": "aaaa.1111"
+}
+
                                                                                          +
                                                                                          +
                                                                                        • Adding or modifying a tag (parameter: image_tag)
                                                                                          1
+2
+3
+4
+5
                                                                                          PUT https://{Endpoint}/v1/cloudimages/tags
+{
+  "image_id": "67437ebd-2563-46e0-887e-ad1923977fa1",
+  "image_tag": {"key":"key1","value":"value1"}
+}
+
                                                                                          +

                                                                                        Response

                                                                                        • Response parameters

                                                                                          None

                                                                                          @@ -112,40 +113,40 @@

                                                                                        Returned Values

                                                                                        • Normal

                                                                                          204

                                                                                        • Abnormal -

                                                                                          Returned Value

                                                                                          +
                                                                                          - - - - - - - - - - - - - diff --git a/docs/ims/api-ref/en-us_topic_0067360382.html b/docs/ims/api-ref/en-us_topic_0067360382.html index c219eb55e..5daf79b2f 100644 --- a/docs/ims/api-ref/en-us_topic_0067360382.html +++ b/docs/ims/api-ref/en-us_topic_0067360382.html @@ -145,7 +145,7 @@ - - @@ -361,7 +361,7 @@ @@ -370,90 +370,91 @@

                                                                                          Returned Value

                                                                                          Description

                                                                                          +

                                                                                          Description

                                                                                          400 Bad Request

                                                                                          +

                                                                                          400 Bad Request

                                                                                          Request error.

                                                                                          +

                                                                                          Request error.

                                                                                          401 Unauthorized

                                                                                          +

                                                                                          401 Unauthorized

                                                                                          Authentication failed.

                                                                                          +

                                                                                          Authentication failed.

                                                                                          403 Forbidden

                                                                                          +

                                                                                          403 Forbidden

                                                                                          You do not have the rights to perform the operation.

                                                                                          +

                                                                                          You do not have the rights to perform the operation.

                                                                                          404 Not Found

                                                                                          +

                                                                                          404 Not Found

                                                                                          The requested resource was not found.

                                                                                          +

                                                                                          The requested resource was not found.

                                                                                          500 Internal Server Error

                                                                                          +

                                                                                          500 Internal Server Error

                                                                                          Internal service error.

                                                                                          +

                                                                                          Internal service error.

                                                                                          503 Service Unavailable

                                                                                          +

                                                                                          503 Service Unavailable

                                                                                          The service is unavailable.

                                                                                          +

                                                                                          The service is unavailable.

                                                                                          Integer

                                                                                          Specifies the minimum disk space (GB) required for running the image. The value ranges from 1 GB to 1024 GB.

                                                                                          +

                                                                                          Specifies the minimum disk space (GB) required for running the image. The value ranges from 1 GB to 1,024 GB.

                                                                                          __os_bit

                                                                                          @@ -313,7 +313,7 @@

                                                                                          String

                                                                                          Specifies whether the image supports ECSs with the InfiniBand NIC on the KVM platform. If yes, the value is true. Otherwise, this parameter is not required.

                                                                                          +

                                                                                          Specifies whether the image supports ECSs with InfiniBand NICs on the KVM platform. If yes, the value is true. Otherwise, this parameter is not required.

                                                                                          This parameter cannot co-exist with __support_xen.

                                                                                          Specifies the time when the image was modified. Images can be queried by time. The value is in the format of Operator:UTC time.

                                                                                          The following operators are supported:

                                                                                          • gt: greater than
                                                                                          • gte: greater than or equal to
                                                                                          • lt: less than
                                                                                          • lte: less than or equal to
                                                                                          • eq: equal to
                                                                                          • neq: not equal to
                                                                                          -

                                                                                          The time format is yyyy-MM-ddThh:mm:ssZ or yyyy-MM-dd hh:mm:ss.

                                                                                          +

                                                                                          The time format is yyyy-MM-ddThh:mm:ssZ or yyyy-MM-dd hh:mm:ss.

                                                                                          For example, to query images updated before Oct 28, 2018 10:00:00, set the value of updated_at as follows:

                                                                                          updated_at=lt:2018-10-28T10:00:00Z

                                                                                          -

                                                                                          Request

                                                                                          • Request parameters

                                                                                            None

                                                                                            -
                                                                                          • Example request
                                                                                            GET https://{Endpoint}/v1/cloudimages/tags?limit=5&page=1
                                                                                            -
                                                                                          +

                                                                                          Request

                                                                                          Request parameters

                                                                                          +

                                                                                          None

                                                                                          +
                                                                                          +

                                                                                          Example Request

                                                                                          Querying image tags

                                                                                          +
                                                                                          GET https://{Endpoint}/v1/cloudimages/tags?limit=5&page=1

                                                                                          Response

                                                                                          • Response parameters -

                                                                                            Parameter

                                                                                            +
                                                                                            - - - - -

                                                                                            Parameter

                                                                                            Type

                                                                                            +

                                                                                            Type

                                                                                            Description

                                                                                            +

                                                                                            Description

                                                                                            tags

                                                                                            +

                                                                                            tags

                                                                                            Array of strings

                                                                                            +

                                                                                            Array of strings

                                                                                            Lists the tags.

                                                                                            +

                                                                                            Lists the tags.
                                                                                          • Example response
                                                                                            STATUS CODE 200
                                                                                            -
                                                                                            1
-2
-3
-4
-5
-6
-7
-8
-9
                                                                                            {
-   "tags": [
-      "jjjj.11111",
-      "uuuu.22222",
-      "234.4",
-      "test",
-      "image"
-   ]
+
                                                                                            1
+2
+3
+4
+5
+6
+7
+8
+9
                                                                                            {
+   "tags": [
+      "jjjj.11111",
+      "uuuu.22222",
+      "234.4",
+      "test",
+      "image"
+   ]
 }
-
                                                                                            
-
-
                                                                                            + +

                                                                                            In the new specification, equal signs are used as separators.

                                                                                            • Returned Values

                                                                                            • Normal

                                                                                              200

                                                                                            • Abnormal -

                                                                                              Returned Value

                                                                                              +
                                                                                              - - - - - - - - - - - - - diff --git a/docs/ims/api-ref/en-us_topic_0083905788.html b/docs/ims/api-ref/en-us_topic_0083905788.html index bac09a507..86493b48e 100644 --- a/docs/ims/api-ref/en-us_topic_0083905788.html +++ b/docs/ims/api-ref/en-us_topic_0083905788.html @@ -1,7 +1,7 @@

                                                                                              Creating a Data Disk Image Using an External Image File

                                                                                              -

                                                                                              Function

                                                                                              This API is used to create a data disk image from a data disk image file uploaded to the OBS bucket. The API is an asynchronous one. If it is successfully called, the cloud service system receives the request. However, you need to use the asynchronous job query API to query the image creation status. For details, see Asynchronous Job Query.

                                                                                              +

                                                                                              Function

                                                                                              This API is used to create a data disk image from a data disk image file uploaded to the OBS bucket. The API is an asynchronous one. If it is successfully called, the cloud service system receives the request. However, you need to use the asynchronous job query API to query the image creation status. For details, see Querying the Status of an Asynchronous Job.

                                                                                              URI

                                                                                              POST /v1/cloudimages/dataimages/action

                                                                                              @@ -31,7 +31,8 @@
                                                                                              - - - @@ -93,7 +94,7 @@

                                                                                              Returned Value

                                                                                              Description

                                                                                              +

                                                                                              Description

                                                                                              400 Bad Request

                                                                                              +

                                                                                              400 Bad Request

                                                                                              Request error. For details about the returned error code, see Error Codes.

                                                                                              +

                                                                                              Request error. For details about the returned error code, see Error Codes.

                                                                                              401 Unauthorized

                                                                                              +

                                                                                              401 Unauthorized

                                                                                              Authentication failed.

                                                                                              +

                                                                                              Authentication failed.

                                                                                              403 Forbidden

                                                                                              +

                                                                                              403 Forbidden

                                                                                              You do not have the rights to perform the operation.

                                                                                              +

                                                                                              You do not have the rights to perform the operation.

                                                                                              404 Not Found

                                                                                              +

                                                                                              404 Not Found

                                                                                              The requested resource was not found.

                                                                                              +

                                                                                              The requested resource was not found.

                                                                                              500 Internal Server Error

                                                                                              +

                                                                                              500 Internal Server Error

                                                                                              Internal service error.

                                                                                              +

                                                                                              Internal service error.

                                                                                              503 Service Unavailable

                                                                                              +

                                                                                              503 Service Unavailable

                                                                                              The service is unavailable.

                                                                                              +

                                                                                              The service is unavailable.

                                                                                              String

                                                                                              Provides supplementary information about the image. For detailed description, see Image Attributes. The value contains a maximum of 1024 characters and consists of only letters and digits. Carriage returns and angle brackets (< >) are not allowed. This parameter is left blank by default.

                                                                                              +

                                                                                              Provides supplementary information about the image.

                                                                                              +

                                                                                              For detailed description, see Image Attributes. The value contains a maximum of 1024 characters and consists of only letters and digits. Carriage returns and angle brackets (< >) are not allowed. This parameter is left blank by default.

                                                                                              os_type

                                                                                              @@ -72,7 +73,7 @@

                                                                                              String

                                                                                              Specifies the master key used for encrypting an image. For its value, see the Key Management Service User Guide.

                                                                                              +

                                                                                              Specifies a custom key used for encrypting an image. For its value, see the Key Management Service User Guide.

                                                                                              tags

                                                                                              @@ -81,7 +82,7 @@

                                                                                              Array of strings

                                                                                              Specifies image tags. This parameter is left blank by default.

                                                                                              +

                                                                                              Lists the image tags. This parameter is left blank by default.

                                                                                              For detailed parameter description, see Image Tag Data Formats.

                                                                                              Use either tags or image_tags.

                                                                                              Array of ImageTag objects

                                                                                              Lists the image tags. This parameter is left blank by default.

                                                                                              -

                                                                                              Use either tags or image_tags.

                                                                                              +

                                                                                              Use either tags or image_tags.

                                                                                              enterprise_project_id

                                                                                              @@ -141,121 +142,121 @@
                                                                                              -
                                                                                              -
                                                                                            • Example requests
                                                                                              • Request for creating an image (tags)
                                                                                                POST https://{Endpoint}/v1/cloudimages/dataimages/action
                                                                                                -
                                                                                                 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
-11
                                                                                                {
-  "name": "fedora-data1",
-  "image_url": "image-test:fedora_data1.qcow2",
-  "description":"Data disk 1 of Fedora",
-  "min_disk": 40,
-  "tags": [
-    "aaa.111",
-    "bbb.222"
-  ],
-  "os_type": "Linux"
-}
-
                                                                                                - -
                                                                                                -
                                                                                              • Request for creating an image (image_tags)
                                                                                                POST https://{Endpoint}/v1/cloudimages/dataimages/action
                                                                                                -
                                                                                                1
-2
-3
-4
-5
-6
-7
-8
                                                                                                {
-  "name": "fedora-data2",
-  "image_url": "image-test:fedora_data1.qcow2",
-  "description":"Data disk 2 of Fedora",
-  "min_disk": 40,
-  "image_tags": [{"key":"aaa","value":"111"},{"key":"bbb","value":"222"}],
-  "os_type": "Linux"
-}
-
                                                                                                -
                                                                                              + +

                                                                                              Example Request

                                                                                              • Creating a data disk image with parameter tags using a file in an OBS bucket (file address in the bucket: image-test:fedora_data1.qcow2; OS: Linux; minimum size of the data disk: 40 GB)
                                                                                                 1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
                                                                                                POST https://{Endpoint}/v1/cloudimages/dataimages/action
+{
+  "name": "fedora-data1",
+  "image_url": "image-test:fedora_data1.qcow2",
+  "description":"Data disk 1 of Fedora",
+  "min_disk": 40,
+  "tags": [
+    "aaa.111",
+    "bbb.222"
+  ],
+  "os_type": "Linux"
+}
+
                                                                                                +
                                                                                                +
                                                                                              • Creating a data disk image with parameter image_tags using a file in an OBS bucket (file address in the bucket: image-test:fedora_data1.qcow2; OS: Linux; minimum size of the data disk: 40 GB)
                                                                                                1
+2
+3
+4
+5
+6
+7
+8
+9
                                                                                                POST https://{Endpoint}/v1/cloudimages/dataimages/action
+{
+  "name": "fedora-data2",
+  "image_url": "image-test:fedora_data1.qcow2",
+  "description":"Data disk 2 of Fedora",
+  "min_disk": 40,
+  "image_tags": [{"key":"aaa","value":"111"},{"key":"bbb","value":"222"}],
+  "os_type": "Linux"
+}
+
                                                                                                +

                                                                                              Response

                                                                                              • Response parameters -

                                                                                                Parameter

                                                                                                +
                                                                                                - - - - -

                                                                                                Parameter

                                                                                                Type

                                                                                                +

                                                                                                Type

                                                                                                Description

                                                                                                +

                                                                                                Description

                                                                                                job_id

                                                                                                +

                                                                                                job_id

                                                                                                String

                                                                                                +

                                                                                                String

                                                                                                Specifies the asynchronous job ID.

                                                                                                -

                                                                                                For details, see Asynchronous Job Query.

                                                                                                +

                                                                                                Specifies the asynchronous job ID.

                                                                                                +

                                                                                                For details, see Querying the Status of an Asynchronous Job.
                                                                                              • Example response
                                                                                                STATUS CODE 200
                                                                                                -
                                                                                                1
-2
-3
                                                                                                {
-    "job_id": "4010a32b5f909853015f90aaa24b0015"
+
                                                                                                1
+2
+3
                                                                                                {
+    "job_id": "4010a32b5f909853015f90aaa24b0015"
 }
-
                                                                                                
-
-
                                                                                                + +

                                                                                                • Returned Values

                                                                                                • Normal

                                                                                                  200

                                                                                                • Abnormal -

                                                                                                  Returned Value

                                                                                                  +
                                                                                                  - - - - - - - - - - - - - diff --git a/docs/ims/api-ref/en-us_topic_0092380109.html b/docs/ims/api-ref/en-us_topic_0092380109.html index 5d8f3f5ff..ec47a7575 100644 --- a/docs/ims/api-ref/en-us_topic_0092380109.html +++ b/docs/ims/api-ref/en-us_topic_0092380109.html @@ -1,7 +1,7 @@

                                                                                                  Creating a Full-ECS Image

                                                                                                  -

                                                                                                  Function

                                                                                                  This API is used to create a full-ECS image from an ECS, Cloud Server Backup Service (CSBS) backup, or Cloud Backup and Recovery (CBR) backup. The API is an asynchronous one. If it is successfully called, the cloud system receives the request to create a full-ECS image. However, you need to use the asynchronous job query API to query the image creation status. For details, see Asynchronous Job Query.

                                                                                                  +

                                                                                                  Function

                                                                                                  This API is used to create a full-ECS image from an ECS, Cloud Server Backup Service (CSBS) backup, or Cloud Backup and Recovery (CBR) backup. The API is an asynchronous one. If it is successfully called, the cloud system receives the request to create a full-ECS image. However, you need to use the asynchronous job query API to query the image creation status. For details, see Querying the Status of an Asynchronous Job.

                                                                                                  Constraints (Creating a Full-ECS Image Using an ECS)

                                                                                                  • When creating a full-ECS image from an ECS, ensure that the ECS has been properly configured, or the image creation may fail.
                                                                                                  • A Windows ECS used to create a full-ECS image cannot have a spanned volume, or data may be lost when ECSs are created from that image.
                                                                                                  • A Linux ECS used to create a full-ECS image cannot have a disk group or logical disk that contains multiple physical disks, or data may be lost when ECSs are created from that image.
                                                                                                  • A full-ECS image cannot be exported or replicated.
                                                                                                  • When creating a full-ECS image from a Windows ECS, you need to change the SAN policy of the ECS to OnlineAll. Otherwise, EVS disks attached to the ECSs created from the image may be offline.

                                                                                                    Windows has three types of SAN policies: OnlineAll, OfflineShared, and OfflineInternal.

                                                                                                    @@ -78,7 +78,7 @@
                                                                                                  - @@ -88,8 +88,8 @@ - - - @@ -234,7 +234,7 @@ -

                                                                                                  Returned Value

                                                                                                  Description

                                                                                                  +

                                                                                                  Description

                                                                                                  400 Bad Request

                                                                                                  +

                                                                                                  400 Bad Request

                                                                                                  Request error. For details about the returned error code, see Error Codes.

                                                                                                  +

                                                                                                  Request error. For details about the returned error code, see Error Codes.

                                                                                                  401 Unauthorized

                                                                                                  +

                                                                                                  401 Unauthorized

                                                                                                  Authentication failed.

                                                                                                  +

                                                                                                  Authentication failed.

                                                                                                  403 Forbidden

                                                                                                  +

                                                                                                  403 Forbidden

                                                                                                  You do not have the rights to perform the operation.

                                                                                                  +

                                                                                                  You do not have the rights to perform the operation.

                                                                                                  404 Not Found

                                                                                                  +

                                                                                                  404 Not Found

                                                                                                  The requested resource was not found.

                                                                                                  +

                                                                                                  The requested resource was not found.

                                                                                                  500 Internal Server Error

                                                                                                  +

                                                                                                  500 Internal Server Error

                                                                                                  Internal service error.

                                                                                                  +

                                                                                                  Internal service error.

                                                                                                  503 Service Unavailable

                                                                                                  +

                                                                                                  503 Service Unavailable

                                                                                                  The service is unavailable.

                                                                                                  +

                                                                                                  The service is unavailable.

                                                                                                  Array of strings

                                                                                                  Lists the image tags. The value is left blank by default.

                                                                                                  +

                                                                                                  Lists the image tags. This parameter is left blank by default.

                                                                                                  Use either tags or image_tags.

                                                                                                  Array of objects

                                                                                                  Lists the image tags. The value is left blank by default.

                                                                                                  -

                                                                                                  Use either tags or image_tags.

                                                                                                  +

                                                                                                  Lists the image tags. This parameter is left blank by default.

                                                                                                  +

                                                                                                  Use either tags or image_tags.

                                                                                                  instance_id

                                                                                                  @@ -181,8 +181,8 @@

                                                                                                  Array of strings

                                                                                                  Lists the image tags. The value is left blank by default.

                                                                                                  -

                                                                                                  Use either tags or image_tags.

                                                                                                  +

                                                                                                  Lists the image tags. This parameter is left blank by default.

                                                                                                  +

                                                                                                  Use either tags or image_tags.

                                                                                                  image_tags

                                                                                                  @@ -191,7 +191,7 @@

                                                                                                  Array of objects

                                                                                                  Lists the image tags. The value is left blank by default.

                                                                                                  +

                                                                                                  Lists the image tags. This parameter is left blank by default.

                                                                                                  Use either tags or image_tags.

                                                                                                  Integer

                                                                                                  Specifies the minimum memory of the image in the unit of MB. The default value is 0, indicating that the memory is not restricted.

                                                                                                  +

                                                                                                  Specifies the minimum memory of the image in the unit of MB. The default value is 0, indicating that the memory is not restricted.

                                                                                                  whole_image_type

                                                                                                  @@ -249,163 +249,161 @@
                                                                                                  -
                                                                                                  -
                                                                                                • Example requests
                                                                                                  • Creating a full-ECS image from an ECS
                                                                                                    POST https://{Endpoint}/v1/cloudimages/wholeimages/action
                                                                                                    -

                                                                                                    If parameter tags is used:

                                                                                                    -
                                                                                                     1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
-11
                                                                                                    {
-       "name": "instance_whole_image",
-       "description": "creating an image from an ECS",
-       "instance_id": "877a2cda-ba63-4e1e-b95f-e67e48b6129a",
-       "vault_id": "de9fcf45-11b2-432c-8562-5c5428574600",
-       "tags": [
-           "aaa.111",
-           "bbb.333",
-           "ccc.444"
-       ]
-}
-
                                                                                                    - -
                                                                                                    -

                                                                                                    If parameter image_tags is used:

                                                                                                    -
                                                                                                    1
-2
-3
-4
-5
-6
-7
                                                                                                    {
-       "name": "instance_whole_image",
-       "description": "creating an image from an ECS",
-       "instance_id": "877a2cda-ba63-4e1e-b95f-e67e48b6129a",
-       "vault_id": "de9fcf45-11b2-432c-8562-5c5428574600",
-       "image_tags": [{"key":"key2","value":"value2"},{"key":"key1","value":"value1"}]
-} 
-
                                                                                                    - -
                                                                                                    -
                                                                                                  • Creating a full-ECS image from a CSBS or CBR backup
                                                                                                    POST https://{Endpoint}/v1/cloudimages/wholeimages/action
                                                                                                    -

                                                                                                    If parameter tags is used:

                                                                                                    -
                                                                                                     1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
-11
                                                                                                    {
-     "name": "backup_whole_image",
-     "description": "Creating a full-ECS image from a CBR backup",
-     "backup_id": "9b27efab-4a17-4c06-bfa2-3e0cf021d3c3",
-     "whole_image_type": "CBR",
-     "tags": [
-           "aaa.111",
-           "bbb.333",
-           "ccc.444"
-      ]
-}
-
                                                                                                    - -
                                                                                                    -

                                                                                                    If parameter image_tags is used:

                                                                                                    -
                                                                                                    1
-2
-3
-4
-5
-6
-7
                                                                                                    {
-     "name": "backup_whole_image",
-     "description": "Creating a full-ECS image from a CBR backup",
-     "backup_id": "9b27efab-4a17-4c06-bfa2-3e0cf021d3c3",
-     "whole_image_type": "CBR",
-     "image_tags": [{"key":"key2","value":"value2"},{"key":"key1","value":"value1"}]
-}
-
                                                                                                    -
                                                                                                  + +

                                                                                                  Example Request

                                                                                                  • Creating a full-ECS image with parameter tags using an ECS (ID: 877a2cda-ba63-4e1e-b95f-e67e48b6129a)
                                                                                                     1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
                                                                                                    POST https://{Endpoint}/v1/cloudimages/wholeimages/action
+{
+       "name": "instance_whole_image",
+       "description": "creating an image from an ECS",
+       "instance_id": "877a2cda-ba63-4e1e-b95f-e67e48b6129a",
+       "vault_id": "de9fcf45-11b2-432c-8562-5c5428574600",
+       "tags": [
+           "aaa.111",
+           "bbb.333",
+           "ccc.444"
+       ]
+}
+
                                                                                                    +
                                                                                                    +
                                                                                                  • Creating a full-ECS image with parameter image_tags using an ECS (ID: 877a2cda-ba63-4e1e-b95f-e67e48b6129a)
                                                                                                    1
+2
+3
+4
+5
+6
+7
+8
                                                                                                    POST https://{Endpoint}/v1/cloudimages/wholeimages/action
+{
+       "name": "instance_whole_image",
+       "description": "creating an image from an ECS",
+       "instance_id": "877a2cda-ba63-4e1e-b95f-e67e48b6129a",
+       "vault_id": "de9fcf45-11b2-432c-8562-5c5428574600",
+       "image_tags": [{"key":"key2","value":"value2"},{"key":"key1","value":"value1"}]
+} 
+
                                                                                                    +
                                                                                                    +
                                                                                                  • Creating a full-ECS image with parameter tags using aCSBS backup or CBR backup (ID: 9b27efab-4a17-4c06-bfa2-3e0cf021d3c3)
                                                                                                     1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
                                                                                                    POST https://{Endpoint}/v1/cloudimages/wholeimages/action
+{
+     "name": "backup_whole_image",
+     "description": "Creating a full-ECS image from a CBR backup",
+     "backup_id": "9b27efab-4a17-4c06-bfa2-3e0cf021d3c3",
+     "whole_image_type": "CBR",
+     "tags": [
+           "aaa.111",
+           "bbb.333",
+           "ccc.444"
+      ]
+}
+
                                                                                                    +
                                                                                                    +
                                                                                                  • Creating a full-ECS image with parameter image_tags using aCSBS backup or CBR backup (ID: 9b27efab-4a17-4c06-bfa2-3e0cf021d3c3)
                                                                                                    1
+2
+3
+4
+5
+6
+7
+8
                                                                                                    POST https://{Endpoint}/v1/cloudimages/wholeimages/action
+{
+     "name": "backup_whole_image",
+     "description": "Creating a full-ECS image from a CBR backup",
+     "backup_id": "9b27efab-4a17-4c06-bfa2-3e0cf021d3c3",
+     "whole_image_type": "CBR",
+     "image_tags": [{"key":"key2","value":"value2"},{"key":"key1","value":"value1"}]
+}
+
                                                                                                    +

                                                                                                  Response

                                                                                                  • Response parameters -

                                                                                                    Parameter

                                                                                                    +
                                                                                                    - - - - -

                                                                                                    Parameter

                                                                                                    Type

                                                                                                    +

                                                                                                    Type

                                                                                                    Description

                                                                                                    +

                                                                                                    Description

                                                                                                    job_id

                                                                                                    +

                                                                                                    job_id

                                                                                                    String

                                                                                                    +

                                                                                                    String

                                                                                                    Specifies the asynchronous job ID.

                                                                                                    -

                                                                                                    For details, see Asynchronous Job Query.

                                                                                                    +

                                                                                                    Specifies the asynchronous job ID.

                                                                                                    +

                                                                                                    For details, see Querying the Status of an Asynchronous Job.
                                                                                                  • Example response
                                                                                                    STATUS CODE 200
                                                                                                    -
                                                                                                    1
-2
-3
                                                                                                    {
-    "job_id": "4010a32b5f909853015f90aaa24b0015"
+
                                                                                                    1
+2
+3
                                                                                                    {
+    "job_id": "4010a32b5f909853015f90aaa24b0015"
 }
-
                                                                                                    
-
-
                                                                                                    + +

                                                                                                    • Returned Values

                                                                                                    • Normal

                                                                                                      200

                                                                                                    • Abnormal -

                                                                                                      Returned Value

                                                                                                      +
                                                                                                      - - - - - - - - - - - - - diff --git a/docs/ims/api-ref/en-us_topic_0093967372.html b/docs/ims/api-ref/en-us_topic_0093967372.html index b3b1bd74e..5c637d08b 100644 --- a/docs/ims/api-ref/en-us_topic_0093967372.html +++ b/docs/ims/api-ref/en-us_topic_0093967372.html @@ -5,24 +5,26 @@

                                                                                                      URI

                                                                                                      GET /v1/cloudimages/quota

                                                                                                      -

                                                                                                      Request

                                                                                                      • Request parameters

                                                                                                        None

                                                                                                        -
                                                                                                      • Example request
                                                                                                        GET https://{Endpoint}/v1/cloudimages/quota
                                                                                                        -
                                                                                                      +

                                                                                                      Request

                                                                                                      Request parameters

                                                                                                      +

                                                                                                      None

                                                                                                      +
                                                                                                      +

                                                                                                      Example Request

                                                                                                      Querying the image quota

                                                                                                      +
                                                                                                      GET https://{Endpoint}/v1/cloudimages/quota

                                                                                                      Response

                                                                                                      • Response parameters -

                                                                                                      Returned Value

                                                                                                      Description

                                                                                                      +

                                                                                                      Description

                                                                                                      400 Bad Request

                                                                                                      +

                                                                                                      400 Bad Request

                                                                                                      Request error. For details about the returned error code, see Error Codes.

                                                                                                      +

                                                                                                      Request error. For details about the returned error code, see Error Codes.

                                                                                                      401 Unauthorized

                                                                                                      +

                                                                                                      401 Unauthorized

                                                                                                      Authentication failed.

                                                                                                      +

                                                                                                      Authentication failed.

                                                                                                      403 Forbidden

                                                                                                      +

                                                                                                      403 Forbidden

                                                                                                      You do not have the rights to perform the operation.

                                                                                                      +

                                                                                                      You do not have the rights to perform the operation.

                                                                                                      404 Not Found

                                                                                                      +

                                                                                                      404 Not Found

                                                                                                      The requested resource was not found.

                                                                                                      +

                                                                                                      The requested resource was not found.

                                                                                                      500 Internal Server Error

                                                                                                      +

                                                                                                      500 Internal Server Error

                                                                                                      Internal service error.

                                                                                                      +

                                                                                                      Internal service error.

                                                                                                      503 Service Unavailable

                                                                                                      +

                                                                                                      503 Service Unavailable

                                                                                                      The service is unavailable.

                                                                                                      +

                                                                                                      The service is unavailable.

                                                                                                      Parameter

                                                                                                      +
                                                                                                      - - - - - @@ -30,19 +32,19 @@

                                                                                                      Parameter

                                                                                                      Type

                                                                                                      +

                                                                                                      Type

                                                                                                      Description

                                                                                                      +

                                                                                                      Description

                                                                                                      quotas

                                                                                                      +

                                                                                                      quotas

                                                                                                      Object

                                                                                                      +

                                                                                                      Object

                                                                                                      Specifies the quota information.

                                                                                                      +

                                                                                                      Specifies the quota information.

                                                                                                      For details, see Table 1.
                                                                                                      -
                                                                                                      Table 1 Data structure description of the quotas field

                                                                                                      Parameter

                                                                                                      +
                                                                                                      - - - - - @@ -50,119 +52,118 @@
                                                                                                      Table 1 Data structure description of the quotas field

                                                                                                      Parameter

                                                                                                      Type

                                                                                                      +

                                                                                                      Type

                                                                                                      Description

                                                                                                      +

                                                                                                      Description

                                                                                                      resources

                                                                                                      +

                                                                                                      resources

                                                                                                      Array of objects

                                                                                                      +

                                                                                                      Array of objects

                                                                                                      Specifies the images included in the quota.

                                                                                                      +

                                                                                                      Specifies the images included in the quota.

                                                                                                      For details, see Table 2.
                                                                                                      -
                                                                                                      Table 2 Data structure description of the quotas.resources field

                                                                                                      Parameter

                                                                                                      +
                                                                                                      - - - - - - - - - - - - - - - - -
                                                                                                      Table 2 Data structure description of the quotas.resources field

                                                                                                      Parameter

                                                                                                      Type

                                                                                                      +

                                                                                                      Type

                                                                                                      Description

                                                                                                      +

                                                                                                      Description

                                                                                                      type

                                                                                                      +

                                                                                                      type

                                                                                                      String

                                                                                                      +

                                                                                                      String

                                                                                                      Specifies the type of the resource to be queried.

                                                                                                      +

                                                                                                      Specifies the type of the resource to be queried.

                                                                                                      used

                                                                                                      +

                                                                                                      used

                                                                                                      Integer

                                                                                                      +

                                                                                                      Integer

                                                                                                      Specifies the used quota.

                                                                                                      +

                                                                                                      Specifies the used quota.

                                                                                                      quota

                                                                                                      +

                                                                                                      quota

                                                                                                      Integer

                                                                                                      +

                                                                                                      Integer

                                                                                                      Specifies the total quota.

                                                                                                      +

                                                                                                      Specifies the total quota.

                                                                                                      min

                                                                                                      +

                                                                                                      min

                                                                                                      Integer

                                                                                                      +

                                                                                                      Integer

                                                                                                      Specifies the minimum quota.

                                                                                                      +

                                                                                                      Specifies the minimum quota.

                                                                                                      max

                                                                                                      +

                                                                                                      max

                                                                                                      Integer

                                                                                                      +

                                                                                                      Integer

                                                                                                      Specifies the maximum quota.

                                                                                                      +

                                                                                                      Specifies the maximum quota.
                                                                                                    • Example response
                                                                                                      STATUS CODE 200
                                                                                                      -
                                                                                                       1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
-11
-12
-13
                                                                                                      {
-  "quotas": {
-    "resources": [
-      {
-        "type": "image",
-        "used": 0,
-        "quota": 20,
-        "min": 1,
-        "max": 1000
-      }
-    ]
-  }
+
                                                                                                       1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
+13
                                                                                                      {
+  "quotas": {
+    "resources": [
+      {
+        "type": "image",
+        "used": 0,
+        "quota": 20,
+        "min": 1,
+        "max": 1000
+      }
+    ]
+  }
 }
-
                                                                                                      
-
-
                                                                                                      + +

                                                                                                      • Returned Values

                                                                                                      • Normal

                                                                                                        200

                                                                                                      • Abnormal -

                                                                                                        Returned Value

                                                                                                        +
                                                                                                        - - - - - - - - - - - - - diff --git a/docs/ims/api-ref/en-us_topic_0102682861.html b/docs/ims/api-ref/en-us_topic_0102682861.html index 19d968c1d..4a327dc1a 100644 --- a/docs/ims/api-ref/en-us_topic_0102682861.html +++ b/docs/ims/api-ref/en-us_topic_0102682861.html @@ -292,234 +292,236 @@

                                                                                                        Returned Value

                                                                                                        Description

                                                                                                        +

                                                                                                        Description

                                                                                                        400 Bad Request

                                                                                                        +

                                                                                                        400 Bad Request

                                                                                                        Request error. For details, see Error Codes.

                                                                                                        +

                                                                                                        Request error. For details, see Error Codes.

                                                                                                        401 Unauthorized

                                                                                                        +

                                                                                                        401 Unauthorized

                                                                                                        Authentication failed.

                                                                                                        +

                                                                                                        Authentication failed.

                                                                                                        403 Forbidden

                                                                                                        +

                                                                                                        403 Forbidden

                                                                                                        You do not have the rights to perform the operation.

                                                                                                        +

                                                                                                        You do not have the rights to perform the operation.

                                                                                                        404 Not Found

                                                                                                        +

                                                                                                        404 Not Found

                                                                                                        The requested resource was not found.

                                                                                                        +

                                                                                                        The requested resource was not found.

                                                                                                        500 Internal Server Error

                                                                                                        +

                                                                                                        500 Internal Server Error

                                                                                                        Internal service error.

                                                                                                        +

                                                                                                        Internal service error.

                                                                                                        503 Service Unavailable

                                                                                                        +

                                                                                                        503 Service Unavailable

                                                                                                        The service is unavailable.

                                                                                                        +

                                                                                                        The service is unavailable.
                                                                                                        -
                                                                                                        -
                                                                                                      • Example requests
                                                                                                        POST https://{Endpoint}/v2/fd73a4a14a4a4dfb9771a8475e5198ea/images/resource_instances/action
                                                                                                        -
                                                                                                        • Request body when action is set to count
                                                                                                           1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
-11
-12
-13
-14
-15
-16
-17
-18
-19
-20
-21
-22
-23
-24
-25
-26
                                                                                                          {
-   "action": "count",
-   "matches": [{
-      "key": "resource_name",
-      "value": "test100"
-   }],
-   "tags": [
-   {
-      "key": "key3",
-      "values": ["valueXX"]
-   }],
-   "tags_any": [
-   {
-      "key": "key0",
-      "values": ["valueXX"]
-   }],
-      "not_tags": [
-   {
-      "key": "key9",
-      "values": ["value9"]
-   }],
-   "not_tags_any": [{
-      "key": "key7",
-      "values": ["value7"]
-   }]
-}
-
                                                                                                          -
                                                                                                        -
                                                                                                        • Request body when action is set to filter
                                                                                                           1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
-11
-12
-13
-14
-15
-16
-17
-18
-19
-20
-21
-22
-23
-24
-25
-26
-27
-28
                                                                                                          {
-   "action": "filter",
-   "limit": "1",
-   "offset": "0",
-   "matches": [{
-      "key": "resource_name",
-      "value": "test100"
-   }],
-   "tags": [
-   {
-      "key": "key3",
-      "values": ["valueXX"]
-   }],
-   "tags_any": [
-   {
-      "key": "key0",
-      "values": ["valueXX"]
-   }],
-   "not_tags": [
-   {
-      "key": "key9",
-      "values": ["value9"]
-   }],
-   "not_tags_any": [{
-      "key": "key7",
-      "values": ["value7"]
-   }]
-}
-
                                                                                                          -
                                                                                                          +

                                                                                                          Example Request

                                                                                                          • Counting the total number of images that meet the conditions specified by tags
                                                                                                             1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
+13
+14
+15
+16
+17
+18
+19
+20
+21
+22
+23
+24
+25
+26
+27
                                                                                                            POST https://{Endpoint}/v2/fd73a4a14a4a4dfb9771a8475e5198ea/images/resource_instances/action
+{
+   "action": "count",
+   "matches": [{
+      "key": "resource_name",
+      "value": "test100"
+   }],
+   "tags": [
+   {
+      "key": "key3",
+      "values": ["valueXX"]
+   }],
+   "tags_any": [
+   {
+      "key": "key0",
+      "values": ["valueXX"]
+   }],
+      "not_tags": [
+   {
+      "key": "key9",
+      "values": ["value9"]
+   }],
+   "not_tags_any": [{
+      "key": "key7",
+      "values": ["value7"]
+   }]
+}
+
                                                                                                            +
                                                                                                          +
                                                                                                          • Filtering images that meet the conditions specified by tags
                                                                                                             1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
+13
+14
+15
+16
+17
+18
+19
+20
+21
+22
+23
+24
+25
+26
+27
+28
+29
                                                                                                            POST https://{Endpoint}/v2/fd73a4a14a4a4dfb9771a8475e5198ea/images/resource_instances/action
+{
+   "action": "filter",
+   "limit": "1",
+   "offset": "0",
+   "matches": [{
+      "key": "resource_name",
+      "value": "test100"
+   }],
+   "tags": [
+   {
+      "key": "key3",
+      "values": ["valueXX"]
+   }],
+   "tags_any": [
+   {
+      "key": "key0",
+      "values": ["valueXX"]
+   }],
+   "not_tags": [
+   {
+      "key": "key9",
+      "values": ["value9"]
+   }],
+   "not_tags_any": [{
+      "key": "key7",
+      "values": ["value7"]
+   }]
+}
+
                                                                                                            +

                                                                                                          Response

                                                                                                          • Response parameters -

                                                                                                            Parameter

                                                                                                            +
                                                                                                            - - - - - - - -

                                                                                                            Parameter

                                                                                                            Type

                                                                                                            +

                                                                                                            Type

                                                                                                            Description

                                                                                                            +

                                                                                                            Description

                                                                                                            resources

                                                                                                            +

                                                                                                            resources

                                                                                                            Array of resource objects

                                                                                                            +

                                                                                                            Array of resource objects

                                                                                                            Lists the images.

                                                                                                            +

                                                                                                            Lists the images.

                                                                                                            total_count

                                                                                                            +

                                                                                                            total_count

                                                                                                            Integer

                                                                                                            +

                                                                                                            Integer

                                                                                                            Specifies the total number of query records.

                                                                                                            +

                                                                                                            Specifies the total number of query records.
                                                                                                            -
                                                                                                            Table 7 Data structure description of the resource field

                                                                                                            Parameter

                                                                                                            +
                                                                                                            - - - - - - - - - - - - - -
                                                                                                            Table 7 Data structure description of the resource field

                                                                                                            Parameter

                                                                                                            Type

                                                                                                            +

                                                                                                            Type

                                                                                                            Description

                                                                                                            +

                                                                                                            Description

                                                                                                            resource_id

                                                                                                            +

                                                                                                            resource_id

                                                                                                            String

                                                                                                            +

                                                                                                            String

                                                                                                            Specifies the image ID.

                                                                                                            +

                                                                                                            Specifies the image ID.

                                                                                                            resource_detail

                                                                                                            +

                                                                                                            resource_detail

                                                                                                            ResourceDetail object

                                                                                                            +

                                                                                                            ResourceDetail object

                                                                                                            Provides image details.

                                                                                                            +

                                                                                                            Provides image details.

                                                                                                            tags

                                                                                                            +

                                                                                                            tags

                                                                                                            Array of Tags objects

                                                                                                            +

                                                                                                            Array of Tags objects

                                                                                                            Lists the image tags.

                                                                                                            +

                                                                                                            Lists the image tags.

                                                                                                            resource_name

                                                                                                            +

                                                                                                            resource_name

                                                                                                            String

                                                                                                            +

                                                                                                            String

                                                                                                            Specifies the image name.

                                                                                                            +

                                                                                                            Specifies the image name.
                                                                                                            -
                                                                                                            Table 8 ResourceDetail object

                                                                                                            Parameter

                                                                                                            +
                                                                                                            - - - - - - -
                                                                                                            Table 8 ResourceDetail object

                                                                                                            Parameter

                                                                                                            Type

                                                                                                            +

                                                                                                            Type

                                                                                                            Mandatory

                                                                                                            +

                                                                                                            Mandatory

                                                                                                            Description

                                                                                                            +

                                                                                                            Description

                                                                                                            status

                                                                                                            +

                                                                                                            status

                                                                                                            string

                                                                                                            +

                                                                                                            string

                                                                                                            Yes

                                                                                                            +

                                                                                                            Yes

                                                                                                            Specifies the image status.

                                                                                                            +

                                                                                                            Specifies the image status.
                                                                                                            -
                                                                                                            Table 9 Data structure description of the resource_tag field

                                                                                                            Parameter

                                                                                                            +
                                                                                                            - - - - - - - - @@ -527,152 +529,150 @@
                                                                                                            • Example response
                                                                                                              • Example response when action is set to count
                                                                                                                STATUS CODE 200
                                                                                                                -
                                                                                                            Table 9 Data structure description of the resource_tag field

                                                                                                            Parameter

                                                                                                            Type

                                                                                                            +

                                                                                                            Type

                                                                                                            Description

                                                                                                            +

                                                                                                            Description

                                                                                                            key

                                                                                                            +

                                                                                                            key

                                                                                                            String

                                                                                                            +

                                                                                                            String

                                                                                                            Specifies the key of the tag.

                                                                                                            +

                                                                                                            Specifies the key of the tag.

                                                                                                            value

                                                                                                            +

                                                                                                            value

                                                                                                            String

                                                                                                            +

                                                                                                            String

                                                                                                            Specifies the value of the tag.

                                                                                                            +

                                                                                                            Specifies the value of the tag.

                                                                                                            		 
                                                                                                            1
-2
-3
                                                                                                            {
-   "total_count": 36
+
                                                                                                            1
+2
+3
                                                                                                            {
+   "total_count": 36
 }
-
                                                                                                            
-
-
                                                                                                            + +
                                                                                                          • Example response when action is set to filter
                                                                                                            STATUS CODE 200
                                                                                                            -
                                                                                                             1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
-11
-12
-13
-14
-15
-16
-17
-18
-19
-20
-21
-22
-23
-24
-25
-26
-27
-28
-29
-30
-31
-32
-33
-34
-35
-36
-37
-38
-39
-40
-41
-42
-43
-44
-45
-46
-47
-48
                                                                                                            {
-   "total_count": 36,
-   "resources": [{
-      "resource_name": "test10002",
-      "resource_detail": {"status": "active"},
-      "tags": [{
-         "value": "value4",
-         "key": "key4"
-      },
-      {
-         "value": "valueXX",
-         "key": "key3"
-      },
-      {
-         "value": "value2",
-         "key": "key2"
-      },
-      {
-         "value": "value5",
-         "key": "key5"
-      },
-      {
-         "value": "value8",
-         "key": "key8"
-      },
-      {
-         "value": "valueXX",
-         "key": "key6"
-      },
-      {
-         "value": "valueXX",
-         "key": "key0"
-      },
-      {
-         "value": "value1",
-         "key": "key1"
-      },
-      {
-         "value": "value7",
-         "key": "key7"
-      },
-      {
-         "value": "valueXX",
-         "key": "key9"
-      }],
-      "resource_id": "8693187d-1590-4f9f-ae34-eb9e3037cf68"
-   }]
+
                                                                                                             1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
+13
+14
+15
+16
+17
+18
+19
+20
+21
+22
+23
+24
+25
+26
+27
+28
+29
+30
+31
+32
+33
+34
+35
+36
+37
+38
+39
+40
+41
+42
+43
+44
+45
+46
+47
+48
                                                                                                            {
+   "total_count": 36,
+   "resources": [{
+      "resource_name": "test10002",
+      "resource_detail": {"status": "active"},
+      "tags": [{
+         "value": "value4",
+         "key": "key4"
+      },
+      {
+         "value": "valueXX",
+         "key": "key3"
+      },
+      {
+         "value": "value2",
+         "key": "key2"
+      },
+      {
+         "value": "value5",
+         "key": "key5"
+      },
+      {
+         "value": "value8",
+         "key": "key8"
+      },
+      {
+         "value": "valueXX",
+         "key": "key6"
+      },
+      {
+         "value": "valueXX",
+         "key": "key0"
+      },
+      {
+         "value": "value1",
+         "key": "key1"
+      },
+      {
+         "value": "value7",
+         "key": "key7"
+      },
+      {
+         "value": "valueXX",
+         "key": "key9"
+      }],
+      "resource_id": "8693187d-1590-4f9f-ae34-eb9e3037cf68"
+   }]
 }
-
                                                                                                            
-
-
                                                                                                            + +

                                                                                                            • Returned Values

                                                                                                            • Normal

                                                                                                              200

                                                                                                            • Abnormal -

                                                                                                              Returned Value

                                                                                                              +
                                                                                                              - - - - - - - - - - - - - diff --git a/docs/ims/api-ref/en-us_topic_0102682862.html b/docs/ims/api-ref/en-us_topic_0102682862.html index 02ab1f197..672605031 100644 --- a/docs/ims/api-ref/en-us_topic_0102682862.html +++ b/docs/ims/api-ref/en-us_topic_0102682862.html @@ -107,74 +107,75 @@

                                                                                                              Returned Value

                                                                                                              Description

                                                                                                              +

                                                                                                              Description

                                                                                                              400 Bad Request

                                                                                                              +

                                                                                                              400 Bad Request

                                                                                                              Request error.

                                                                                                              +

                                                                                                              Request error.

                                                                                                              401 Unauthorized

                                                                                                              +

                                                                                                              401 Unauthorized

                                                                                                              Authentication failed.

                                                                                                              +

                                                                                                              Authentication failed.

                                                                                                              403 Forbidden

                                                                                                              +

                                                                                                              403 Forbidden

                                                                                                              You do not have the rights to perform the operation.

                                                                                                              +

                                                                                                              You do not have the rights to perform the operation.

                                                                                                              404 Not Found

                                                                                                              +

                                                                                                              404 Not Found

                                                                                                              The requested resource was not found.

                                                                                                              +

                                                                                                              The requested resource was not found.

                                                                                                              500 Internal Server Error

                                                                                                              +

                                                                                                              500 Internal Server Error

                                                                                                              Internal service error.

                                                                                                              +

                                                                                                              Internal service error.

                                                                                                              503 Service Unavailable

                                                                                                              +

                                                                                                              503 Service Unavailable

                                                                                                              The service is unavailable.

                                                                                                              +

                                                                                                              The service is unavailable.
                                                                                                              -
                                                                                                              -
                                                                                                            • Example request
                                                                                                              • Adding image tags in batches
                                                                                                                POST https://{Endpoint}/v2/fd73a4a14a4a4dfb9771a8475e5198ea/images/67e17426-359e-49fb-aa12-0bd1756ec240/tags/action
                                                                                                                -
                                                                                                                 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
-11
-12
-13
-14
-15
                                                                                                                {
-   "tags": [{
-      "value": "value1",
-      "key": "key1"
-   },
-   {
-      "value": "value2",
-      "key": "key2"
-   },
-   {
-      "value": "",
-      "key": "key3"
-   }],
-   "action": "create"
-}
-
                                                                                                                - -
                                                                                                                -
                                                                                                              • Deleting image tags in batches
                                                                                                                POST https://{Endpoint}/v2/fd73a4a14a4a4dfb9771a8475e5198ea/images/67e17426-359e-49fb-aa12-0bd1756ec240/tags/action
                                                                                                                -
                                                                                                                 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
-11
-12
-13
-14
-15
                                                                                                                {
-   "tags": [{
-      "value": "value1",
-      "key": "key1"
-   },
-   {
-      "value": "value2",
-      "key": "key2"
-   },
-   {
-      "value": "",
-      "key": "key3"
-   }],
-      "action": "delete"
-}
-
                                                                                                                -
                                                                                                              + +

                                                                                                              Example Request

                                                                                                              • Adding tags for an image (key1:value1, key2:value2)
                                                                                                                 1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
+13
+14
+15
+16
                                                                                                                POST https://{Endpoint}/v2/fd73a4a14a4a4dfb9771a8475e5198ea/images/67e17426-359e-49fb-aa12-0bd1756ec240/tags/action
+{
+   "tags": [{
+      "value": "value1",
+      "key": "key1"
+   },
+   {
+      "value": "value2",
+      "key": "key2"
+   },
+   {
+      "value": "",
+      "key": "key3"
+   }],
+   "action": "create"
+}
+
                                                                                                                +
                                                                                                                +
                                                                                                              • Deleting image tags (key1:value1, key2:value2)
                                                                                                                 1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
+13
+14
+15
+16
                                                                                                                POST https://{Endpoint}/v2/fd73a4a14a4a4dfb9771a8475e5198ea/images/67e17426-359e-49fb-aa12-0bd1756ec240/tags/action
+{
+   "tags": [{
+      "value": "value1",
+      "key": "key1"
+   },
+   {
+      "value": "value2",
+      "key": "key2"
+   },
+   {
+      "value": "",
+      "key": "key3"
+   }],
+      "action": "delete"
+}
+
                                                                                                                +

                                                                                                              Response

                                                                                                              • Response parameters

                                                                                                                None

                                                                                                                @@ -183,40 +184,40 @@

                                                                                                              Returned Values

                                                                                                              • Normal

                                                                                                                204

                                                                                                              • Abnormal -

                                                                                                                Returned Value

                                                                                                                +
                                                                                                                - - - - - - - - - - - - - diff --git a/docs/ims/api-ref/en-us_topic_0102682863.html b/docs/ims/api-ref/en-us_topic_0102682863.html index 4834f773d..a4ce0c722 100644 --- a/docs/ims/api-ref/en-us_topic_0102682863.html +++ b/docs/ims/api-ref/en-us_topic_0102682863.html @@ -94,64 +94,66 @@

                                                                                                                Returned Value

                                                                                                                Description

                                                                                                                +

                                                                                                                Description

                                                                                                                400 Bad Request

                                                                                                                +

                                                                                                                400 Bad Request

                                                                                                                Request error.

                                                                                                                +

                                                                                                                Request error.

                                                                                                                401 Unauthorized

                                                                                                                +

                                                                                                                401 Unauthorized

                                                                                                                Authentication failed.

                                                                                                                +

                                                                                                                Authentication failed.

                                                                                                                403 Forbidden

                                                                                                                +

                                                                                                                403 Forbidden

                                                                                                                You do not have the rights to perform the operation.

                                                                                                                +

                                                                                                                You do not have the rights to perform the operation.

                                                                                                                404 Not Found

                                                                                                                +

                                                                                                                404 Not Found

                                                                                                                The requested resource was not found.

                                                                                                                +

                                                                                                                The requested resource was not found.

                                                                                                                500 Internal Server Error

                                                                                                                +

                                                                                                                500 Internal Server Error

                                                                                                                Internal service error.

                                                                                                                +

                                                                                                                Internal service error.

                                                                                                                503 Service Unavailable

                                                                                                                +

                                                                                                                503 Service Unavailable

                                                                                                                The service is unavailable.

                                                                                                                +

                                                                                                                The service is unavailable.
                                                                                                                -
                                                                                                                -
                                                                                                              • Example request
                                                                                                                POST https://{Endpoint}/v2/fd73a4a14a4a4dfb9771a8475e5198ea/images/67e17426-359e-49fb-aa12-0bd1756ec240/tags
                                                                                                                -
                                                                                                                1
-2
-3
-4
-5
-6
                                                                                                                {
-   "tag": {
-      "value": "value1",
-      "key": "key1"
-   }
-}
-
                                                                                                                -
                                                                                                                • +

                                                                                                                Example Request

                                                                                                                Adding an image tag (key1:value1)

                                                                                                                +
                                                                                                                1
+2
+3
+4
+5
+6
+7
                                                                                                                POST https://{Endpoint}/v2/fd73a4a14a4a4dfb9771a8475e5198ea/images/67e17426-359e-49fb-aa12-0bd1756ec240/tags
+{
+   "tag": {
+      "value": "value1",
+      "key": "key1"
+   }
+}
+
                                                                                                                +
                                                                                                                +

                                                                                                                Response

                                                                                                                • Response parameters

                                                                                                                  None

                                                                                                                • Example response
                                                                                                                  STATUS CODE 204

                                                                                                                Returned Values

                                                                                                                • Normal

                                                                                                                  204

                                                                                                                • Abnormal -

                                                                                                                  Returned Value

                                                                                                                  +
                                                                                                                  - - - - - - - - - - - - - diff --git a/docs/ims/api-ref/en-us_topic_0102682864.html b/docs/ims/api-ref/en-us_topic_0102682864.html index b71b364e9..51f4724a0 100644 --- a/docs/ims/api-ref/en-us_topic_0102682864.html +++ b/docs/ims/api-ref/en-us_topic_0102682864.html @@ -49,9 +49,11 @@ -

                                                                                                                  Request

                                                                                                                  • Request parameters

                                                                                                                    None

                                                                                                                    -
                                                                                                                  • Example request
                                                                                                                    DELETE https://{Endpoint}/v2/fd73a4a14a4a4dfb9771a8475e5198ea/images/67e17426-359e-49fb-aa12-0bd1756ec240/tags/key1
                                                                                                                    -
                                                                                                                  +

                                                                                                                  Request

                                                                                                                  Request parameters

                                                                                                                  +

                                                                                                                  None

                                                                                                                  +
                                                                                                                  +

                                                                                                                  Example Request

                                                                                                                  Deleting an image tag

                                                                                                                  +
                                                                                                                  DELETE https://{Endpoint}/v2/fd73a4a14a4a4dfb9771a8475e5198ea/images/67e17426-359e-49fb-aa12-0bd1756ec240/tags/key1

                                                                                                                  Response

                                                                                                                  • Response parameters

                                                                                                                    None

                                                                                                                  • Example response
                                                                                                                    STATUS CODE 204
                                                                                                                    @@ -59,40 +61,40 @@

                                                                                                                  Returned Values

                                                                                                                  • Normal

                                                                                                                    204

                                                                                                                  • Abnormal -

                                                                                                                  Returned Value

                                                                                                                  Description

                                                                                                                  +

                                                                                                                  Description

                                                                                                                  400 Bad Request

                                                                                                                  +

                                                                                                                  400 Bad Request

                                                                                                                  Request error.

                                                                                                                  +

                                                                                                                  Request error.

                                                                                                                  401 Unauthorized

                                                                                                                  +

                                                                                                                  401 Unauthorized

                                                                                                                  Authentication failed.

                                                                                                                  +

                                                                                                                  Authentication failed.

                                                                                                                  403 Forbidden

                                                                                                                  +

                                                                                                                  403 Forbidden

                                                                                                                  You do not have the rights to perform the operation.

                                                                                                                  +

                                                                                                                  You do not have the rights to perform the operation.

                                                                                                                  404 Not Found

                                                                                                                  +

                                                                                                                  404 Not Found

                                                                                                                  The requested resource was not found.

                                                                                                                  +

                                                                                                                  The requested resource was not found.

                                                                                                                  500 Internal Server Error

                                                                                                                  +

                                                                                                                  500 Internal Server Error

                                                                                                                  Internal service error.

                                                                                                                  +

                                                                                                                  Internal service error.

                                                                                                                  503 Service Unavailable

                                                                                                                  +

                                                                                                                  503 Service Unavailable

                                                                                                                  The service is unavailable.

                                                                                                                  +

                                                                                                                  The service is unavailable.

                                                                                                                  Returned Value

                                                                                                                  +
                                                                                                                  - - - - - - - - - - - - - diff --git a/docs/ims/api-ref/en-us_topic_0102682865.html b/docs/ims/api-ref/en-us_topic_0102682865.html index 08b778667..7e9886f7f 100644 --- a/docs/ims/api-ref/en-us_topic_0102682865.html +++ b/docs/ims/api-ref/en-us_topic_0102682865.html @@ -38,116 +38,117 @@ -

                                                                                                                  Request

                                                                                                                  • Request parameters

                                                                                                                    None

                                                                                                                    -
                                                                                                                  • Example request
                                                                                                                    GET https://{Endpoint}/v2/fd73a4a14a4a4dfb9771a8475e5198ea/images/67e17426-359e-49fb-aa12-0bd1756ec240/tags
                                                                                                                    -
                                                                                                                  +

                                                                                                                  Request

                                                                                                                  Request parameters

                                                                                                                  +

                                                                                                                  None

                                                                                                                  +
                                                                                                                  +

                                                                                                                  Example Request

                                                                                                                  Querying tags of an image

                                                                                                                  +
                                                                                                                  GET https://{Endpoint}/v2/fd73a4a14a4a4dfb9771a8475e5198ea/images/67e17426-359e-49fb-aa12-0bd1756ec240/tags

                                                                                                                  Response

                                                                                                                  • Response parameters -

                                                                                                                  Returned Value

                                                                                                                  Description

                                                                                                                  +

                                                                                                                  Description

                                                                                                                  400 Bad Request

                                                                                                                  +

                                                                                                                  400 Bad Request

                                                                                                                  Request error.

                                                                                                                  +

                                                                                                                  Request error.

                                                                                                                  401 Unauthorized

                                                                                                                  +

                                                                                                                  401 Unauthorized

                                                                                                                  Authentication failed.

                                                                                                                  +

                                                                                                                  Authentication failed.

                                                                                                                  403 Forbidden

                                                                                                                  +

                                                                                                                  403 Forbidden

                                                                                                                  You do not have the rights to perform the operation.

                                                                                                                  +

                                                                                                                  You do not have the rights to perform the operation.

                                                                                                                  404 Not Found

                                                                                                                  +

                                                                                                                  404 Not Found

                                                                                                                  The requested resource was not found.

                                                                                                                  +

                                                                                                                  The requested resource was not found.

                                                                                                                  500 Internal Server Error

                                                                                                                  +

                                                                                                                  500 Internal Server Error

                                                                                                                  Internal service error.

                                                                                                                  +

                                                                                                                  Internal service error.

                                                                                                                  503 Service Unavailable

                                                                                                                  +

                                                                                                                  503 Service Unavailable

                                                                                                                  The service is unavailable.

                                                                                                                  +

                                                                                                                  The service is unavailable.

                                                                                                                  Parameter

                                                                                                                  +
                                                                                                                  - - - - -

                                                                                                                  Parameter

                                                                                                                  Type

                                                                                                                  +

                                                                                                                  Type

                                                                                                                  Description

                                                                                                                  +

                                                                                                                  Description

                                                                                                                  tags

                                                                                                                  +

                                                                                                                  tags

                                                                                                                  Array of objects

                                                                                                                  +

                                                                                                                  Array of objects

                                                                                                                  Lists the returned tags. For details, see Table 2.

                                                                                                                  +

                                                                                                                  Lists the returned tags. For details, see Table 2.
                                                                                                                  -
                                                                                                                  Table 2 Data structure description of the tags field

                                                                                                                  Parameter

                                                                                                                  +
                                                                                                                  - - - - - - - -
                                                                                                                  Table 2 Data structure description of the tags field

                                                                                                                  Parameter

                                                                                                                  Type

                                                                                                                  +

                                                                                                                  Type

                                                                                                                  Description

                                                                                                                  +

                                                                                                                  Description

                                                                                                                  key

                                                                                                                  +

                                                                                                                  key

                                                                                                                  String

                                                                                                                  +

                                                                                                                  String

                                                                                                                  Specifies the tag key.

                                                                                                                  +

                                                                                                                  Specifies the tag key.

                                                                                                                  value

                                                                                                                  +

                                                                                                                  value

                                                                                                                  String

                                                                                                                  +

                                                                                                                  String

                                                                                                                  Specifies the tag value.

                                                                                                                  +

                                                                                                                  Specifies the tag value.
                                                                                                                • Example response
                                                                                                                  STATUS CODE 200
                                                                                                                  -
                                                                                                                   1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
                                                                                                                  {
-   "tags": [{
-      "value": "value0",
-      "key": "key0"
-   },
-   {
-      "value": "value0",
-      "key": "key1"
-   }]
+
                                                                                                                   1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
                                                                                                                  {
+   "tags": [{
+      "value": "value0",
+      "key": "key0"
+   },
+   {
+      "value": "value0",
+      "key": "key1"
+   }]
 }
-
                                                                                                                  
-
-
                                                                                                                  + +

                                                                                                                  • Returned Values

                                                                                                                  • Normal

                                                                                                                    200

                                                                                                                  • Abnormal -

                                                                                                                    Returned Value

                                                                                                                    +
                                                                                                                    - - - - - - - - - - - - - diff --git a/docs/ims/api-ref/en-us_topic_0102682866.html b/docs/ims/api-ref/en-us_topic_0102682866.html index f5adac0e7..d3a3ed9fb 100644 --- a/docs/ims/api-ref/en-us_topic_0102682866.html +++ b/docs/ims/api-ref/en-us_topic_0102682866.html @@ -29,128 +29,129 @@ -

                                                                                                                    Request

                                                                                                                    • Request parameters

                                                                                                                      None

                                                                                                                      -
                                                                                                                    • Example request
                                                                                                                      GET https://{Endpoint}/v2/fd73a4a14a4a4dfb9771a8475e5198ea/images/tags
                                                                                                                      -
                                                                                                                    +

                                                                                                                    Request

                                                                                                                    Request parameters

                                                                                                                    +

                                                                                                                    None

                                                                                                                    +
                                                                                                                    +

                                                                                                                    Example Request

                                                                                                                    Querying all image tags

                                                                                                                    +
                                                                                                                    GET https://{Endpoint}/v2/fd73a4a14a4a4dfb9771a8475e5198ea/images/tags

                                                                                                                    Response

                                                                                                                    • Response parameters -

                                                                                                                    Returned Value

                                                                                                                    Description

                                                                                                                    +

                                                                                                                    Description

                                                                                                                    400 Bad Request

                                                                                                                    +

                                                                                                                    400 Bad Request

                                                                                                                    Request error.

                                                                                                                    +

                                                                                                                    Request error.

                                                                                                                    401 Unauthorized

                                                                                                                    +

                                                                                                                    401 Unauthorized

                                                                                                                    Authentication failed.

                                                                                                                    +

                                                                                                                    Authentication failed.

                                                                                                                    403 Forbidden

                                                                                                                    +

                                                                                                                    403 Forbidden

                                                                                                                    You do not have the rights to perform the operation.

                                                                                                                    +

                                                                                                                    You do not have the rights to perform the operation.

                                                                                                                    404 Not Found

                                                                                                                    +

                                                                                                                    404 Not Found

                                                                                                                    The requested resource was not found.

                                                                                                                    +

                                                                                                                    The requested resource was not found.

                                                                                                                    500 Internal Server Error

                                                                                                                    +

                                                                                                                    500 Internal Server Error

                                                                                                                    Internal service error.

                                                                                                                    +

                                                                                                                    Internal service error.

                                                                                                                    503 Service Unavailable

                                                                                                                    +

                                                                                                                    503 Service Unavailable

                                                                                                                    The service is unavailable.

                                                                                                                    +

                                                                                                                    The service is unavailable.

                                                                                                                    Parameter

                                                                                                                    +
                                                                                                                    - - - - -

                                                                                                                    Parameter

                                                                                                                    Type

                                                                                                                    +

                                                                                                                    Type

                                                                                                                    Description

                                                                                                                    +

                                                                                                                    Description

                                                                                                                    tags

                                                                                                                    +

                                                                                                                    tags

                                                                                                                    Array of objects

                                                                                                                    +

                                                                                                                    Array of objects

                                                                                                                    Lists tags. For details, see Table 2.

                                                                                                                    +

                                                                                                                    Lists tags. For details, see Table 2.
                                                                                                                    -
                                                                                                                    Table 2 Data structure description of the tags field

                                                                                                                    Parameter

                                                                                                                    +
                                                                                                                    - - - - - - - -
                                                                                                                    Table 2 Data structure description of the tags field

                                                                                                                    Parameter

                                                                                                                    Type

                                                                                                                    +

                                                                                                                    Type

                                                                                                                    Description

                                                                                                                    +

                                                                                                                    Description

                                                                                                                    key

                                                                                                                    +

                                                                                                                    key

                                                                                                                    String

                                                                                                                    +

                                                                                                                    String

                                                                                                                    Specifies the tag key.

                                                                                                                    +

                                                                                                                    Specifies the tag key.

                                                                                                                    values

                                                                                                                    +

                                                                                                                    values

                                                                                                                    Array of strings

                                                                                                                    +

                                                                                                                    Array of strings

                                                                                                                    Lists the tag values. If a tag contains the key only, tag values will be empty character strings.

                                                                                                                    +

                                                                                                                    Lists the tag values. If a tag contains the key only, tag values will be empty character strings.
                                                                                                                  • Example response
                                                                                                                    STATUS CODE 200
                                                                                                                    -
                                                                                                                     1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
-11
-12
-13
-14
-15
-16
                                                                                                                    {
-   "tags": [{
-      "values": ["value9"],
-      "key": "key9"
-   },
-   {
-      "values": [""],
-      "key": "key8"
-   },
-   {
-      "values": 
-        ["valueXX",
-        "value3"],
-      "key": "key3"
-   }]
+
                                                                                                                     1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
+13
+14
+15
+16
                                                                                                                    {
+   "tags": [{
+      "values": ["value9"],
+      "key": "key9"
+   },
+   {
+      "values": [""],
+      "key": "key8"
+   },
+   {
+      "values": 
+        ["valueXX",
+        "value3"],
+      "key": "key3"
+   }]
 }
-
                                                                                                                    
-
-
                                                                                                                    + +

                                                                                                                    • Returned Values

                                                                                                                    • Normal

                                                                                                                      200

                                                                                                                    • Abnormal -

                                                                                                                      Returned Value

                                                                                                                      +
                                                                                                                      - - - - - - - - - - - - - diff --git a/docs/ims/api-ref/en-us_topic_0122410336.html b/docs/ims/api-ref/en-us_topic_0122410336.html index 116ce7dc9..b4bd5154e 100644 --- a/docs/ims/api-ref/en-us_topic_0122410336.html +++ b/docs/ims/api-ref/en-us_topic_0122410336.html @@ -4,15 +4,15 @@
                                                                                                                      diff --git a/docs/ims/api-ref/en-us_topic_0125866390.html b/docs/ims/api-ref/en-us_topic_0125866390.html index 6716e6491..a30835d5b 100644 --- a/docs/ims/api-ref/en-us_topic_0125866390.html +++ b/docs/ims/api-ref/en-us_topic_0125866390.html @@ -2,11 +2,11 @@

                                                                                                                      Image Management

                                                                                                                      -

                                                                                                                      Returned Value

                                                                                                                      Description

                                                                                                                      +

                                                                                                                      Description

                                                                                                                      400 Bad Request

                                                                                                                      +

                                                                                                                      400 Bad Request

                                                                                                                      Request error

                                                                                                                      +

                                                                                                                      Request error

                                                                                                                      401 Unauthorized

                                                                                                                      +

                                                                                                                      401 Unauthorized

                                                                                                                      Authentication failed.

                                                                                                                      +

                                                                                                                      Authentication failed.

                                                                                                                      403 Forbidden

                                                                                                                      +

                                                                                                                      403 Forbidden

                                                                                                                      You do not have the rights to perform the operation.

                                                                                                                      +

                                                                                                                      You do not have the rights to perform the operation.

                                                                                                                      404 Not Found

                                                                                                                      +

                                                                                                                      404 Not Found

                                                                                                                      The requested resource was not found.

                                                                                                                      +

                                                                                                                      The requested resource was not found.

                                                                                                                      500 Internal Server Error

                                                                                                                      +

                                                                                                                      500 Internal Server Error

                                                                                                                      Internal service error

                                                                                                                      +

                                                                                                                      Internal service error

                                                                                                                      503 Service Unavailable

                                                                                                                      +

                                                                                                                      503 Service Unavailable

                                                                                                                      The service is unavailable.

                                                                                                                      +

                                                                                                                      The service is unavailable.

                                                                                                                      Permissions

                                                                                                                      +
                                                                                                                      - - @@ -25,6 +25,17 @@ + + + + + +

                                                                                                                      Permission

                                                                                                                      APIs

                                                                                                                      +

                                                                                                                      API

                                                                                                                      Actions

                                                                                                                      +

                                                                                                                      Action

                                                                                                                      IAM Project

                                                                                                                      √

                                                                                                                      Querying Supported Image OSs

                                                                                                                      +

                                                                                                                      GET /v1/cloudimages/os_version

                                                                                                                      +

                                                                                                                      ims:images:list

                                                                                                                      +

                                                                                                                      √

                                                                                                                      +

                                                                                                                      ×

                                                                                                                      +

                                                                                                                      Updating Image Information

                                                                                                                      PATCH /v2/cloudimages/{image_id}

                                                                                                                      diff --git a/docs/ims/api-ref/en-us_topic_0125866391.html b/docs/ims/api-ref/en-us_topic_0125866391.html index 2419cf190..0dcbcdd2a 100644 --- a/docs/ims/api-ref/en-us_topic_0125866391.html +++ b/docs/ims/api-ref/en-us_topic_0125866391.html @@ -2,11 +2,11 @@

                                                                                                                      Image Tagging

                                                                                                                      -

                                                                                                                      Permissions

                                                                                                                      +
                                                                                                                      - - @@ -36,7 +36,7 @@ - @@ -47,7 +47,7 @@ - @@ -58,7 +58,7 @@ - @@ -69,7 +69,7 @@ - @@ -80,7 +80,7 @@ - @@ -91,7 +91,7 @@ - @@ -102,7 +102,7 @@ - @@ -113,7 +113,7 @@ - diff --git a/docs/ims/api-ref/en-us_topic_0125866392.html b/docs/ims/api-ref/en-us_topic_0125866392.html index 02baafd4a..564333b4c 100644 --- a/docs/ims/api-ref/en-us_topic_0125866392.html +++ b/docs/ims/api-ref/en-us_topic_0125866392.html @@ -2,11 +2,11 @@

                                                                                                                      Image Schema

                                                                                                                      -

                                                                                                                      Permission

                                                                                                                      APIs

                                                                                                                      +

                                                                                                                      API

                                                                                                                      Actions

                                                                                                                      +

                                                                                                                      Action

                                                                                                                      IAM Project

                                                                                                                      x

                                                                                                                      Adds or modifies a tag.

                                                                                                                      +

                                                                                                                      Adding or Modifying a Tag

                                                                                                                      PUT /v1/cloudimages/tags

                                                                                                                      x

                                                                                                                      Queries tags.

                                                                                                                      +

                                                                                                                      Querying Tags

                                                                                                                      GET /v1/cloudimages/tags

                                                                                                                      x

                                                                                                                      Queries images by tag.

                                                                                                                      +

                                                                                                                      Querying Images by Tag

                                                                                                                      POST /v2/{project_id}/images/resource_instances/action

                                                                                                                      x

                                                                                                                      Adds or deletes image tags in a batch.

                                                                                                                      +

                                                                                                                      Adding or Deleting Image Tags in a Batch

                                                                                                                      POST /v2/{project_id}/images/{image_id}/tags/action

                                                                                                                      x

                                                                                                                      Adds an image tag.

                                                                                                                      +

                                                                                                                      Adding an Image Tag

                                                                                                                      POST /v2/{project_id}/images/{image_id}/tags

                                                                                                                      x

                                                                                                                      Deletes an image tag.

                                                                                                                      +

                                                                                                                      Deleting an Image Tag

                                                                                                                      DELETE /v2/{project_id}/images/{image_id}/tags/{key}

                                                                                                                      x

                                                                                                                      Queries tags of an image.

                                                                                                                      +

                                                                                                                      Querying Tags of an Image

                                                                                                                      GET /v2/{project_id}/images/{image_id}/tags

                                                                                                                      x

                                                                                                                      Queries all image tags.

                                                                                                                      +

                                                                                                                      Querying All Image Tags

                                                                                                                      GET /v2/{project_id}/images/tags

                                                                                                                      Permissions

                                                                                                                      +
                                                                                                                      - - @@ -36,7 +36,7 @@ - @@ -47,7 +47,7 @@ - diff --git a/docs/ims/api-ref/en-us_topic_0125866393.html b/docs/ims/api-ref/en-us_topic_0125866393.html index 2f080d0ea..74f47cc65 100644 --- a/docs/ims/api-ref/en-us_topic_0125866393.html +++ b/docs/ims/api-ref/en-us_topic_0125866393.html @@ -2,11 +2,11 @@

                                                                                                                      Image Sharing

                                                                                                                      -

                                                                                                                      Permission

                                                                                                                      APIs

                                                                                                                      +

                                                                                                                      API

                                                                                                                      Actions

                                                                                                                      +

                                                                                                                      Action

                                                                                                                      IAM Project

                                                                                                                      x

                                                                                                                      Querying an Image Member Schema (Native OpenStack API)

                                                                                                                      +

                                                                                                                      Querying an Image Sharing Member Schema (Native OpenStack API)

                                                                                                                      GET /v2/schemas/member

                                                                                                                      x

                                                                                                                      Querying an Image Member List Schema (Native OpenStack API)

                                                                                                                      +

                                                                                                                      Querying an Image Sharing Member List Schema (Native OpenStack API)

                                                                                                                      GET /v2/schemas/members

                                                                                                                      Permissions

                                                                                                                      +
                                                                                                                      - - @@ -14,7 +14,7 @@ - @@ -36,7 +36,7 @@ - @@ -47,7 +47,7 @@ - @@ -58,7 +58,7 @@ - @@ -69,7 +69,7 @@ - @@ -80,7 +80,7 @@ - @@ -91,7 +91,7 @@ - diff --git a/docs/ims/api-ref/en-us_topic_0125866394.html b/docs/ims/api-ref/en-us_topic_0125866394.html index 541e191b3..031b4ad3a 100644 --- a/docs/ims/api-ref/en-us_topic_0125866394.html +++ b/docs/ims/api-ref/en-us_topic_0125866394.html @@ -2,11 +2,11 @@

                                                                                                                      Image Replication

                                                                                                                      -

                                                                                                                      Permission

                                                                                                                      APIs

                                                                                                                      +

                                                                                                                      API

                                                                                                                      Actions

                                                                                                                      +

                                                                                                                      Action

                                                                                                                      IAM Project

                                                                                                                      Adding an Image Member (Native OpenStack API)

                                                                                                                      +

                                                                                                                      Adding an Image Sharing Member (Native OpenStack API)

                                                                                                                      POST /v2/images/{image_id}/members

                                                                                                                      x

                                                                                                                      Querying Image Member Details (Native OpenStack API)

                                                                                                                      +

                                                                                                                      Querying Image Sharing Member Details (Native OpenStack API)

                                                                                                                      GET /v2/images/{image_id}/members/{member_id}

                                                                                                                      x

                                                                                                                      Querying Image Members (Native OpenStack API)

                                                                                                                      +

                                                                                                                      Querying Image Sharing Members (Native OpenStack API)

                                                                                                                      GET /v2/images/{image_id}/members

                                                                                                                      x

                                                                                                                      Deleting an Image Member (Native OpenStack API)

                                                                                                                      +

                                                                                                                      Deleting an Image Sharing Member (Native OpenStack API)

                                                                                                                      DELETE /v2/images/{image_id}/members/{member_id}

                                                                                                                      x

                                                                                                                      Adds image members.

                                                                                                                      +

                                                                                                                      Adding Image Sharing Members

                                                                                                                      POST /v1/cloudimages/members

                                                                                                                      x

                                                                                                                      Updates the status of image members in batches.

                                                                                                                      +

                                                                                                                      Updating the Status of Image Sharing Members in Batches

                                                                                                                      PUT /v1/cloudimages/members

                                                                                                                      x

                                                                                                                      Deletes image members in batches.

                                                                                                                      +

                                                                                                                      Deleting Image Sharing Members in Batches

                                                                                                                      DELETE /v1/cloudimages/members

                                                                                                                      Permissions

                                                                                                                      +
                                                                                                                      - - diff --git a/docs/ims/api-ref/en-us_topic_0125866395.html b/docs/ims/api-ref/en-us_topic_0125866395.html index 8319f6445..706fe1925 100644 --- a/docs/ims/api-ref/en-us_topic_0125866395.html +++ b/docs/ims/api-ref/en-us_topic_0125866395.html @@ -2,11 +2,11 @@

                                                                                                                      Image Quota

                                                                                                                      -

                                                                                                                      Permission

                                                                                                                      APIs

                                                                                                                      +

                                                                                                                      API

                                                                                                                      Actions

                                                                                                                      +

                                                                                                                      Action

                                                                                                                      IAM Project

                                                                                                                      Permissions

                                                                                                                      +
                                                                                                                      - - @@ -14,7 +14,7 @@ - diff --git a/docs/ims/api-ref/en-us_topic_0133188204.html b/docs/ims/api-ref/en-us_topic_0133188204.html index 61915ae4e..237ea894c 100644 --- a/docs/ims/api-ref/en-us_topic_0133188204.html +++ b/docs/ims/api-ref/en-us_topic_0133188204.html @@ -3,7 +3,7 @@

                                                                                                                      Importing an Image File Quickly

                                                                                                                      Function

                                                                                                                      This API is used to quickly create a private image from an oversized external image file that has uploaded to the OBS bucket. Currently, only ZVHD2 and RAW image files are supported, and the size of an image file cannot exceed 1 TB.

                                                                                                                      The fast image creation function is only available for image files in RAW or ZVHD2 format. For other formats of image files that are smaller than 128 GB, you are advised to import these files with the common method.

                                                                                                                      -

                                                                                                                      The API is an asynchronous one. If it is successfully called, the cloud service system receives the request. However, you need to use the asynchronous job query API to query the image creation status. For details, see Asynchronous Job Query.

                                                                                                                      +

                                                                                                                      The API is an asynchronous one. If it is successfully called, the cloud service system receives the request. However, you need to use the asynchronous job query API to query the image creation status. For details, see Querying the Status of an Asynchronous Job.

                                                                                                                      Constraints

                                                                                                                      Before importing image files, ensure that the file format is RAW or ZVHD2 and the following have been done:
                                                                                                                      • RAW image files have been optimized, and bitmap files have been generated.
                                                                                                                      • ZVHD2 image files have been optimized as required.
                                                                                                                      @@ -92,7 +92,7 @@
                                                                                                                      - @@ -111,7 +111,7 @@ - @@ -179,7 +179,7 @@ @@ -190,7 +190,7 @@ - @@ -228,188 +228,186 @@ -

                                                                                                                      Permission

                                                                                                                      APIs

                                                                                                                      +

                                                                                                                      API

                                                                                                                      Actions

                                                                                                                      +

                                                                                                                      Action

                                                                                                                      IAM Project

                                                                                                                      Queries the image quota

                                                                                                                      +

                                                                                                                      Querying the Image Quota

                                                                                                                      GET /v1/cloudimages/quota

                                                                                                                      Array of objects

                                                                                                                      Lists the image tags. The value is left blank by default.

                                                                                                                      +

                                                                                                                      Lists the image tags. This parameter is left blank by default.

                                                                                                                      Set either tags or image_tags.

                                                                                                                      String

                                                                                                                      Specifies the enterprise project to which the image belongs.

                                                                                                                      +

                                                                                                                      Specifies the enterprise project that the image belongs to.

                                                                                                                      • If the value is 0 or left blank, the image belongs to the default enterprise project.
                                                                                                                      • If the value is a UUID, the image belongs to the enterprise project corresponding to the UUID.

                                                                                                                        For more information about enterprise projects and how to obtain enterprise project IDs, see Enterprise Management User Guide.

                                                                                                                      Specifies the URL of the external image file in the OBS bucket.

                                                                                                                      This parameter is mandatory if an external image file in the OBS bucket is used to create an image. The format is OBS bucket name:Image file name.

                                                                                                                      -
                                                                                                                      NOTE:

                                                                                                                      The storage class of the OBS bucket must be Standard.

                                                                                                                      +
                                                                                                                      NOTE:

                                                                                                                      The storage class of the OBS bucket must be Standard.

                                                                                                                      Integer

                                                                                                                      Specifies the minimum size of the system disk in the unit of GB.

                                                                                                                      -

                                                                                                                      This parameter is mandatory if an external image file in the OBS bucket is used to create an image. The value ranges from 1 to 1024.

                                                                                                                      +

                                                                                                                      This parameter is mandatory if an external image file in the OBS bucket is used to create an image. The value ranges from 1 to 1024.

                                                                                                                      tags

                                                                                                                      @@ -209,7 +209,7 @@

                                                                                                                      Array of objects

                                                                                                                      Lists the image tags. The value is left blank by default.

                                                                                                                      +

                                                                                                                      Lists the image tags. This parameter is left blank by default.

                                                                                                                      Set either tags or image_tags.

                                                                                                                      String

                                                                                                                      Specifies the enterprise project to which the image belongs.

                                                                                                                      -
                                                                                                                      • If the value is 0 or left blank, the image belongs to the default enterprise project.
                                                                                                                      • If the value is a UUID, the image belongs to the enterprise project corresponding to the UUID.

                                                                                                                        For more information about enterprise projects and how to obtain enterprise project IDs, see Enterprise Management User Guide.

                                                                                                                        +

                                                                                                                      Specifies the enterprise project that the image belongs to.

                                                                                                                      +
                                                                                                                      • If the value is 0 or left blank, the image belongs to the default enterprise project.
                                                                                                                      • If the value is a UUID, the image belongs to the enterprise project corresponding to the UUID.

                                                                                                                        For more information about enterprise projects and how to obtain enterprise project IDs, see Enterprise Management User Guide.
                                                                                                                      -
                                                                                                                      -
                                                                                                                    • Example requests
                                                                                                                      • Creating a system disk image using an external image file
                                                                                                                        POST https://{Endpoint}/v2/cloudimages/quickimport/action
                                                                                                                        -

                                                                                                                        If parameter tags is used:

                                                                                                                        -
                                                                                                                         1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
-11
-12
-13
-14
                                                                                                                        {  
-    "name": "ims_test_file",  
-   "description": "Create an image using a file in the OBS bucket.", 
-    "image_url": "ims-image:centos70.zvhd2",  
-    "os_version": "CentOS 7.0 64bit",  
-    "min_disk": 40,  
-    "type": "ECS", 
-    "tags":
-        [
-            "aaa.111",    
-            "bbb.333",    
-            "ccc.444"    
-        ]
-}
-
                                                                                                                        - -
                                                                                                                        -

                                                                                                                        If parameter image_tags is used:

                                                                                                                        -
                                                                                                                        1
-2
-3
-4
-5
-6
-7
-8
-9
                                                                                                                        {  
-    "name": "ims_test_file",  
-   "description": "Create an image using a file in the OBS bucket.", 
-    "image_url": "ims-image:centos70.zvhd2",  
-    "os_version": "CentOS 7.0 64bit",  
-    "min_disk": 40,  
-    "type": "ECS", 
-    "image_tags": [{"key":"key2","value":"value2"},{"key":"key1","value":"value1"}]  
-}
-
                                                                                                                        - -
                                                                                                                        -
                                                                                                                      • Creating a data disk image using an external image file
                                                                                                                        POST https://{Endpoint}/v2/cloudimages/quickimport/action
                                                                                                                        -

                                                                                                                        If parameter tags is used:

                                                                                                                        -
                                                                                                                         1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
-11
-12
-13
                                                                                                                        {  
-    "name": "ims_test_file",  
-   "description": "Create an image using a file in the OBS bucket.", 
-    "image_url": "ims-image:centos70.qcow2",  
-    "os_type": "Linux",  
-    "min_disk": 40,  
-    "type": "DataImage",  
-    "tags": [    
-        "aaa.111",    
-        "bbb.333",    
-        "ccc.444"    
-    ]
-}
-
                                                                                                                        - -
                                                                                                                        -

                                                                                                                        If parameter image_tags is used:

                                                                                                                        -
                                                                                                                        1
-2
-3
-4
-5
-6
-7
-8
-9
                                                                                                                        {  
-    "name": "ims_test_file",  
-   "description": "Create an image using a file in the OBS bucket.", 
-    "image_url": "ims-image:centos70.qcow2",  
-    "os_type": "Linux",  
-    "min_disk": 40,  
-    "type": "DataImage",
-    "image_tags": [{"key":"key2","value":"value2"},{"key":"key1","value":"value1"}]
-}
-
                                                                                                                        -
                                                                                                                      + +

                                                                                                                      Example Request

                                                                                                                      • Creating a system disk image with parameter tags using a file in an OBS bucket (file address in the bucket: ims-image:centos70.zvhd2)
                                                                                                                         1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
+13
+14
+15
                                                                                                                        POST https://{Endpoint}/v2/cloudimages/quickimport/action
+{  
+    "name": "ims_test_file",  
+   "description": "Create an image using a file in the OBS bucket.", 
+    "image_url": "ims-image:centos70.zvhd2",  
+    "os_version": "CentOS 7.0 64bit",  
+    "min_disk": 40,  
+    "type": "ECS", 
+    "tags":
+        [
+            "aaa.111",    
+            "bbb.333",    
+            "ccc.444"    
+        ]
+}
+
                                                                                                                        +
                                                                                                                        +
                                                                                                                      • Creating a system disk image with parameter image_tags using a file in an OBS bucket (file address in the bucket: ims-image:centos70.zvhd2)
                                                                                                                         1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
                                                                                                                        POST https://{Endpoint}/v2/cloudimages/quickimport/action
+{  
+    "name": "ims_test_file",  
+   "description": "Create an image using a file in the OBS bucket.", 
+    "image_url": "ims-image:centos70.zvhd2",  
+    "os_version": "CentOS 7.0 64bit",  
+    "min_disk": 40,  
+    "type": "ECS", 
+    "image_tags": [{"key":"key2","value":"value2"},{"key":"key1","value":"value1"}]  
+}
+
                                                                                                                        +
                                                                                                                        +
                                                                                                                      • Creating a data disk image with parameter tags using a file in an OBS bucket (file address in the bucket: ims-image:centos70.zvhd2)
                                                                                                                         1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
+13
+14
                                                                                                                        POST https://{Endpoint}/v2/cloudimages/quickimport/action
+{  
+    "name": "ims_test_file",  
+   "description": "Create an image using a file in the OBS bucket.", 
+    "image_url": "ims-image:centos70.zvhd2",  
+    "os_type": "Linux",  
+    "min_disk": 40,  
+    "type": "DataImage",  
+    "tags": [    
+        "aaa.111",    
+        "bbb.333",    
+        "ccc.444"    
+    ]
+}
+
                                                                                                                        +
                                                                                                                        +
                                                                                                                      • Creating a data disk image with parameter image_tags using a file in an OBS bucket (file address in the bucket: ims-image:centos70.zvhd2)
                                                                                                                         1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
                                                                                                                        POST https://{Endpoint}/v2/cloudimages/quickimport/action
+{  
+    "name": "ims_test_file",  
+   "description": "Create an image using a file in the OBS bucket.", 
+    "image_url": "ims-image:centos70.zvhd2",  
+    "os_type": "Linux",  
+    "min_disk": 40,  
+    "type": "DataImage",
+    "image_tags": [{"key":"key2","value":"value2"},{"key":"key1","value":"value1"}]
+}
+
                                                                                                                        +

                                                                                                                      Response

                                                                                                                      • Response parameters -

                                                                                                                        Parameter

                                                                                                                        +
                                                                                                                        - - - - -

                                                                                                                        Parameter

                                                                                                                        Type

                                                                                                                        +

                                                                                                                        Type

                                                                                                                        Description

                                                                                                                        +

                                                                                                                        Description

                                                                                                                        job_id

                                                                                                                        +

                                                                                                                        job_id

                                                                                                                        String

                                                                                                                        +

                                                                                                                        String

                                                                                                                        Specifies the asynchronous job ID.

                                                                                                                        -

                                                                                                                        For details, see Asynchronous Job Query.

                                                                                                                        +

                                                                                                                        Specifies the asynchronous job ID.

                                                                                                                        +

                                                                                                                        For details, see Querying the Status of an Asynchronous Job.
                                                                                                                      • Example response
                                                                                                                        STATUS CODE 200
                                                                                                                        -
                                                                                                                        1
-2
-3
                                                                                                                        {
-     "job_id": "8a12fc664fb4daa3014fb4e581380005"
+
                                                                                                                        1
+2
+3
                                                                                                                        {
+     "job_id": "8a12fc664fb4daa3014fb4e581380005"
 }
-
                                                                                                                        
-
-
                                                                                                                        + +

                                                                                                                        • Returned Values

                                                                                                                        • Normal

                                                                                                                          200

                                                                                                                        • Abnormal -

                                                                                                                          Return Value

                                                                                                                          +
                                                                                                                          - - - - - - - - - - - - - diff --git a/docs/ims/api-ref/en-us_topic_0135482660.html b/docs/ims/api-ref/en-us_topic_0135482660.html index 18456265c..5f251de05 100644 --- a/docs/ims/api-ref/en-us_topic_0135482660.html +++ b/docs/ims/api-ref/en-us_topic_0135482660.html @@ -4,11 +4,11 @@
                                                                                                                          diff --git a/docs/ims/api-ref/en-us_topic_0170918588.html b/docs/ims/api-ref/en-us_topic_0170918588.html index d880f09df..10a2c4b81 100644 --- a/docs/ims/api-ref/en-us_topic_0170918588.html +++ b/docs/ims/api-ref/en-us_topic_0170918588.html @@ -29,24 +29,26 @@

                                                                                                                          Return Value

                                                                                                                          Description

                                                                                                                          +

                                                                                                                          Description

                                                                                                                          400 Bad Request

                                                                                                                          +

                                                                                                                          400 Bad Request

                                                                                                                          Request error. For details about the returned error code, see Error Codes.

                                                                                                                          +

                                                                                                                          Request error. For details about the returned error code, see Error Codes.

                                                                                                                          401 Unauthorized

                                                                                                                          +

                                                                                                                          401 Unauthorized

                                                                                                                          Authentication failed.

                                                                                                                          +

                                                                                                                          Authentication failed.

                                                                                                                          403 Forbidden

                                                                                                                          +

                                                                                                                          403 Forbidden

                                                                                                                          You do not have the rights to perform the operation.

                                                                                                                          +

                                                                                                                          You do not have the rights to perform the operation.

                                                                                                                          404 Not Found

                                                                                                                          +

                                                                                                                          404 Not Found

                                                                                                                          The requested resource was not found.

                                                                                                                          +

                                                                                                                          The requested resource was not found.

                                                                                                                          500 Internal Server Error

                                                                                                                          +

                                                                                                                          500 Internal Server Error

                                                                                                                          Internal service error.

                                                                                                                          +

                                                                                                                          Internal service error.

                                                                                                                          503 Service Unavailable

                                                                                                                          +

                                                                                                                          503 Service Unavailable

                                                                                                                          The service is unavailable.

                                                                                                                          +

                                                                                                                          The service is unavailable.
                                                                                                                          -

                                                                                                                          Request

                                                                                                                          • Request parameters

                                                                                                                            None

                                                                                                                            -
                                                                                                                          • Example request
                                                                                                                            GET https://{Endpoint}/v2.0
                                                                                                                            -
                                                                                                                          +

                                                                                                                          Request

                                                                                                                          Request parameters

                                                                                                                          +

                                                                                                                          None

                                                                                                                          +
                                                                                                                          +

                                                                                                                          Example Request

                                                                                                                          Querying an API version

                                                                                                                          +
                                                                                                                          GET https://{Endpoint}/v2.0

                                                                                                                          Response

                                                                                                                          • Response parameters -

                                                                                                                            Parameter

                                                                                                                            +
                                                                                                                            - - - - - @@ -54,33 +56,33 @@

                                                                                                                            Parameter

                                                                                                                            Type

                                                                                                                            +

                                                                                                                            Type

                                                                                                                            Description

                                                                                                                            +

                                                                                                                            Description

                                                                                                                            versions

                                                                                                                            +

                                                                                                                            versions

                                                                                                                            Array of objects

                                                                                                                            +

                                                                                                                            Array of objects

                                                                                                                            Specifies the version.

                                                                                                                            +

                                                                                                                            Specifies the version.

                                                                                                                            For details, see Table 2.
                                                                                                                            -
                                                                                                                            Table 2 Data structure description of the versions field

                                                                                                                            Parameter

                                                                                                                            +
                                                                                                                            - - - - - - - - - - - @@ -88,100 +90,99 @@
                                                                                                                            Table 2 Data structure description of the versions field

                                                                                                                            Parameter

                                                                                                                            Type

                                                                                                                            +

                                                                                                                            Type

                                                                                                                            Description

                                                                                                                            +

                                                                                                                            Description

                                                                                                                            status

                                                                                                                            +

                                                                                                                            status

                                                                                                                            String

                                                                                                                            +

                                                                                                                            String

                                                                                                                            Specifies the API status.

                                                                                                                            +

                                                                                                                            Specifies the API status.

                                                                                                                            id

                                                                                                                            +

                                                                                                                            id

                                                                                                                            String

                                                                                                                            +

                                                                                                                            String

                                                                                                                            Specifies the API ID.

                                                                                                                            +

                                                                                                                            Specifies the API ID.

                                                                                                                            links

                                                                                                                            +

                                                                                                                            links

                                                                                                                            Array of objects

                                                                                                                            +

                                                                                                                            Array of objects

                                                                                                                            Specifies the description.

                                                                                                                            +

                                                                                                                            Specifies the description.

                                                                                                                            For details, see Table 3.
                                                                                                                            -
                                                                                                                            Table 3 Data structure description of the versions.links field

                                                                                                                            Parameter

                                                                                                                            +
                                                                                                                            - - - - - - - -
                                                                                                                            Table 3 Data structure description of the versions.links field

                                                                                                                            Parameter

                                                                                                                            Type

                                                                                                                            +

                                                                                                                            Type

                                                                                                                            Description

                                                                                                                            +

                                                                                                                            Description

                                                                                                                            href

                                                                                                                            +

                                                                                                                            href

                                                                                                                            String

                                                                                                                            +

                                                                                                                            String

                                                                                                                            Specifies the domain name.

                                                                                                                            +

                                                                                                                            Specifies the domain name.

                                                                                                                            rel

                                                                                                                            +

                                                                                                                            rel

                                                                                                                            String

                                                                                                                            +

                                                                                                                            String

                                                                                                                            Specifies the domain name description.

                                                                                                                            +

                                                                                                                            Specifies the domain name description.
                                                                                                                          • Example response
                                                                                                                            STATUS CODE 300
                                                                                                                            -
                                                                                                                             1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
-11
-12
-13
-14
                                                                                                                            {
-    "versions": [
-        {
-            "status": "SUPPORTED",
-            "id": "v2.0",
-            "links": [
-                {
-                    "href": "https://image.az1.dc1.domainname.com/v2/",
-                    "rel": "self"
-                }
-            ]
-        }
-    ]
+
                                                                                                                             1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
+13
+14
                                                                                                                            {
+    "versions": [
+        {
+            "status": "SUPPORTED",
+            "id": "v2.0",
+            "links": [
+                {
+                    "href": "https://image.az1.dc1.domainname.com/v2/",
+                    "rel": "self"
+                }
+            ]
+        }
+    ]
 }
-
                                                                                                                            
-
-
                                                                                                                            + +

                                                                                                                            • Returned Values

                                                                                                                            • Normal

                                                                                                                              300

                                                                                                                            • Abnormal -

                                                                                                                              Returned Values

                                                                                                                              +
                                                                                                                              - - - - - - - - - - - - - diff --git a/docs/ims/api-ref/en-us_topic_0171654733.html b/docs/ims/api-ref/en-us_topic_0171654733.html index 5967988f9..1b0ab039a 100644 --- a/docs/ims/api-ref/en-us_topic_0171654733.html +++ b/docs/ims/api-ref/en-us_topic_0171654733.html @@ -5,15 +5,15 @@

                                                                                                                              By default, new IAM users do not have any permissions assigned. You need to add a user to one or more groups, and assign policies or roles to these groups. The user then inherits permissions from the groups it is a member of. This process is called authorization. After authorization, the user can perform specified operations on cloud services based on the permissions.

                                                                                                                              You can grant user permissions by using roles and policies.

                                                                                                                              • Roles: A type of coarse-grained authorization mechanism that defines permissions related to user responsibilities. This mechanism provides only a limited number of service-level roles for authorization.
                                                                                                                              • Policies: A type of fine-grained authorization mechanism that defines permissions required to perform operations on specific cloud resources under certain conditions. This mechanism allows for API-level policies for authorization, meeting requirements for secure access control.
                                                                                                                              -

                                                                                                                              Policy-based authorization is useful if you want to allow or deny the access to an API.

                                                                                                                              +

                                                                                                                              Policy-based authorization is useful if you want to allow or deny the access to an API.

                                                                                                                              An account has all of the permissions required to call all APIs, but IAM users must have the required permissions specifically assigned. 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 images using an API, the user must have been granted permissions that allow the ims:images:list action.

                                                                                                                              Supported Actions

                                                                                                                              IMS provides system-defined policies. You can also create custom policies for more specific access control. The following are related concepts:

                                                                                                                              • Permissions: Allow or deny certain operations.
                                                                                                                              • APIs: APIs that will be called for performing certain operations.
                                                                                                                              • Actions: Operations that will be allowed or denied.
                                                                                                                              • Dependent actions: When assigning permissions for an action, you also need to assign permissions for the dependent actions.
                                                                                                                              • IAM projects or enterprise projects: Applicable scope of custom policies. For example, if an action supports both IAM and enterprise projects, the policy that contains this action will take effect for user groups assigned in IAM and Enterprise Management. If an action supports only IAM projects, the policy will take effect only for user groups assigned in IAM.
                                                                                                                              -

                                                                                                                              √: supported; x: not supported

                                                                                                                              +

                                                                                                                              √: supported; x: not supported

                                                                                                                              IMS supports the following actions that can be defined in custom policies:

                                                                                                                              -
                                                                                                                              • Image Management, including actions supported by IMS's image management APIs, such as the APIs for querying images, updating image information, creating images, registering images, and exporting images.
                                                                                                                              • Image Tagging, including actions supported by IMS's tag management APIs, such as the APIs for adding tags, deleting tags, and querying images.
                                                                                                                              • Image Schema, including actions supported by IMS's image schema management APIs, such as the APIs for querying an image schema, querying an image list schema, querying an image member schema, and query an image member list schema.
                                                                                                                              • Image Sharing, including actions supported by IMS's shared image APIs, such as the APIs for adding an image member, updating the status of image members, querying image member details, and deleting an image member.
                                                                                                                              • Image Replication, including actions supported by IMS's image replication APIs, such as the API for replicating an image within a region.
                                                                                                                              • Image Quota, including actions supported by IMS's image quota APIs, such as the API for querying image quotas.
                                                                                                                              +
                                                                                                                              • Image Management, including actions supported by IMS's image management APIs, such as the APIs for querying images, updating image information, creating images, registering images, and exporting images.
                                                                                                                              • Image Tagging, including actions supported by IMS's tag management APIs, such as the APIs for adding tags, deleting tags, and querying images.
                                                                                                                              • Image Schema, including actions supported by IMS's image schema management APIs, such as the APIs for querying an image schema, querying an image list schema, querying an image sharing member schema, and query an image sharing member list schema.
                                                                                                                              • Image Sharing, including actions supported by IMS's shared image APIs, such as the APIs for adding an image sharing member, updating the status of image sharing members, querying image sharing member details, and deleting an image sharing member.
                                                                                                                              • Image Replication, including actions supported by IMS's image replication APIs, such as the API for replicating an image within a region.
                                                                                                                              • Image Quota, including actions supported by IMS's image quota APIs, such as the API for querying image quotas.

                                                                                                                              Error messages returned for native OpenStack APIs are in XML format. JSON format of the fine-grained policy is not supported.

                                                                                                                              Returned Values

                                                                                                                              Description

                                                                                                                              +

                                                                                                                              Description

                                                                                                                              400 Bad Request

                                                                                                                              +

                                                                                                                              400 Bad Request

                                                                                                                              Request error.

                                                                                                                              +

                                                                                                                              Request error.

                                                                                                                              401 Unauthorized

                                                                                                                              +

                                                                                                                              401 Unauthorized

                                                                                                                              Authentication failed.

                                                                                                                              +

                                                                                                                              Authentication failed.

                                                                                                                              403 Forbidden

                                                                                                                              +

                                                                                                                              403 Forbidden

                                                                                                                              You do not have the rights to perform the operation.

                                                                                                                              +

                                                                                                                              You do not have the rights to perform the operation.

                                                                                                                              404 Not Found

                                                                                                                              +

                                                                                                                              404 Not Found

                                                                                                                              The requested resource was not found.

                                                                                                                              +

                                                                                                                              The requested resource was not found.

                                                                                                                              500 Internal Server Error

                                                                                                                              +

                                                                                                                              500 Internal Server Error

                                                                                                                              Internal service error.

                                                                                                                              +

                                                                                                                              Internal service error.

                                                                                                                              503 Service Unavailable

                                                                                                                              +

                                                                                                                              503 Service Unavailable

                                                                                                                              The service is unavailable.

                                                                                                                              +

                                                                                                                              The service is unavailable.