From 313c8b6ba0e014f6ecd1244e0413fd1e845438e2 Mon Sep 17 00:00:00 2001 From: guoyanyan Date: Tue, 31 Jan 2023 12:48:42 +0000 Subject: [PATCH] ims_api_1109 Reviewed-by: Hasko, Vladimir Co-authored-by: guoyanyan Co-committed-by: guoyanyan --- docs/ims/api-ref/ALL_META.TXT.json | 294 ++- docs/ims/api-ref/CLASS.TXT.json | 378 ++-- .../api-ref/en-us_topic_0000001311190309.html | 19 + .../api-ref/en-us_topic_0000001360879672.html | 101 - .../api-ref/en-us_topic_0000001360879684.html | 119 - .../api-ref/en-us_topic_0000001360879692.html | 339 --- .../api-ref/en-us_topic_0000001360879704.html | 17 - .../api-ref/en-us_topic_0000001360879708.html | 168 -- .../api-ref/en-us_topic_0000001360879712.html | 166 -- .../api-ref/en-us_topic_0000001360879728.html | 966 -------- .../api-ref/en-us_topic_0000001360879732.html | 539 ----- .../api-ref/en-us_topic_0000001360879736.html | 458 ---- .../api-ref/en-us_topic_0000001360879740.html | 144 -- .../api-ref/en-us_topic_0000001361039228.html | 627 ------ .../api-ref/en-us_topic_0000001361039236.html | 269 --- .../api-ref/en-us_topic_0000001361039248.html | 23 - .../api-ref/en-us_topic_0000001361039252.html | 221 -- .../api-ref/en-us_topic_0000001361039260.html | 163 -- .../api-ref/en-us_topic_0000001361039264.html | 17 - .../api-ref/en-us_topic_0000001361039272.html | 643 ------ .../api-ref/en-us_topic_0000001361039284.html | 183 -- .../api-ref/en-us_topic_0000001361199212.html | 29 - .../api-ref/en-us_topic_0000001361199224.html | 202 -- .../api-ref/en-us_topic_0000001361199228.html | 956 -------- .../api-ref/en-us_topic_0000001361199232.html | 14 - .../api-ref/en-us_topic_0000001361199244.html | 235 -- .../api-ref/en-us_topic_0000001361199252.html | 359 --- .../api-ref/en-us_topic_0000001361199260.html | 98 - .../api-ref/en-us_topic_0000001361199268.html | 15 - .../api-ref/en-us_topic_0000001411119517.html | 436 ---- .../api-ref/en-us_topic_0000001411119529.html | 143 -- .../api-ref/en-us_topic_0000001411119537.html | 8 - .../api-ref/en-us_topic_0000001411119541.html | 19 - .../api-ref/en-us_topic_0000001411119549.html | 165 -- .../api-ref/en-us_topic_0000001411119557.html | 563 ----- .../api-ref/en-us_topic_0000001411119565.html | 162 -- .../api-ref/en-us_topic_0000001411119573.html | 574 ----- .../api-ref/en-us_topic_0000001411119577.html | 144 -- .../api-ref/en-us_topic_0000001411119581.html | 178 -- .../api-ref/en-us_topic_0000001411239209.html | 399 ---- .../api-ref/en-us_topic_0000001411239213.html | 395 ---- .../api-ref/en-us_topic_0000001411239225.html | 227 -- .../api-ref/en-us_topic_0000001411239233.html | 1757 --------------- .../api-ref/en-us_topic_0000001411239237.html | 350 --- .../api-ref/en-us_topic_0000001411239245.html | 231 -- .../api-ref/en-us_topic_0000001411239253.html | 230 -- .../api-ref/en-us_topic_0000001411239269.html | 160 -- .../api-ref/en-us_topic_0000001411399133.html | 116 - .../api-ref/en-us_topic_0000001411399137.html | 19 - .../api-ref/en-us_topic_0000001411399145.html | 99 - .../api-ref/en-us_topic_0000001411399153.html | 17 - .../api-ref/en-us_topic_0000001411399161.html | 729 ------ .../api-ref/en-us_topic_0000001411399165.html | 21 - .../api-ref/en-us_topic_0000001411399169.html | 109 - .../api-ref/en-us_topic_0000001411399181.html | 546 ----- .../api-ref/en-us_topic_0000001411399189.html | 21 - .../api-ref/en-us_topic_0000001411479433.html | 20 - .../api-ref/en-us_topic_0000001411479437.html | 118 - .../api-ref/en-us_topic_0000001411479457.html | 197 -- .../api-ref/en-us_topic_0000001411479461.html | 253 --- .../api-ref/en-us_topic_0000001411479465.html | 176 -- .../api-ref/en-us_topic_0000001411479469.html | 31 - .../api-ref/en-us_topic_0000001411479473.html | 167 -- .../api-ref/en-us_topic_0000001411479477.html | 29 - .../api-ref/en-us_topic_0000001411479493.html | 99 - .../api-ref/en-us_topic_0000001411479497.html | 196 -- .../api-ref/en-us_topic_0000001411479501.html | 15 - .../api-ref/en-us_topic_0000001411479505.html | 170 -- docs/ims/api-ref/en-us_topic_0020091553.html | 99 + docs/ims/api-ref/en-us_topic_0020091554.html | 21 + docs/ims/api-ref/en-us_topic_0020091555.html | 540 +++++ docs/ims/api-ref/en-us_topic_0020091556.html | 575 +++++ docs/ims/api-ref/en-us_topic_0020091562.html | 368 +++ docs/ims/api-ref/en-us_topic_0020091565.html | 993 ++++++++ docs/ims/api-ref/en-us_topic_0020091566.html | 564 +++++ docs/ims/api-ref/en-us_topic_0020091567.html | 659 ++++++ docs/ims/api-ref/en-us_topic_0020092108.html | 120 + docs/ims/api-ref/en-us_topic_0020092109.html | 811 +++++++ docs/ims/api-ref/en-us_topic_0020092110.html | 20 + docs/ims/api-ref/en-us_topic_0020092111.html | 101 + docs/ims/api-ref/en-us_topic_0020507759.html | 8 + docs/ims/api-ref/en-us_topic_0022473688.html | 392 ++++ docs/ims/api-ref/en-us_topic_0022473689.html | 1989 +++++++++++++++++ docs/ims/api-ref/en-us_topic_0024735403.html | 255 +++ docs/ims/api-ref/en-us_topic_0031615565.html | 436 ++++ docs/ims/api-ref/en-us_topic_0031615566.html | 118 + docs/ims/api-ref/en-us_topic_0031617666.html | 349 +++ docs/ims/api-ref/en-us_topic_0036994315.html | 178 ++ docs/ims/api-ref/en-us_topic_0036994316.html | 14 + docs/ims/api-ref/en-us_topic_0036994317.html | 169 ++ docs/ims/api-ref/en-us_topic_0036994318.html | 224 ++ docs/ims/api-ref/en-us_topic_0036994319.html | 169 ++ docs/ims/api-ref/en-us_topic_0036994320.html | 197 ++ docs/ims/api-ref/en-us_topic_0036994321.html | 98 + docs/ims/api-ref/en-us_topic_0036994322.html | 148 ++ docs/ims/api-ref/en-us_topic_0036994323.html | 186 ++ docs/ims/api-ref/en-us_topic_0036994324.html | 146 ++ docs/ims/api-ref/en-us_topic_0037131984.html | 145 ++ docs/ims/api-ref/en-us_topic_0049147855.html | 15 + docs/ims/api-ref/en-us_topic_0049147856.html | 183 ++ docs/ims/api-ref/en-us_topic_0049147876.html | 163 ++ docs/ims/api-ref/en-us_topic_0049147877.html | 231 ++ docs/ims/api-ref/en-us_topic_0060804959.html | 987 ++++++++ docs/ims/api-ref/en-us_topic_0060804960.html | 772 +++++++ docs/ims/api-ref/en-us_topic_0066978719.html | 254 +++ docs/ims/api-ref/en-us_topic_0066978720.html | 340 +++ docs/ims/api-ref/en-us_topic_0066978721.html | 270 +++ docs/ims/api-ref/en-us_topic_0066978722.html | 100 + docs/ims/api-ref/en-us_topic_0067360381.html | 162 ++ docs/ims/api-ref/en-us_topic_0067360382.html | 470 ++++ docs/ims/api-ref/en-us_topic_0083905788.html | 272 +++ docs/ims/api-ref/en-us_topic_0092380109.html | 422 ++++ docs/ims/api-ref/en-us_topic_0093967371.html | 15 + docs/ims/api-ref/en-us_topic_0093967372.html | 179 ++ docs/ims/api-ref/en-us_topic_0102682861.html | 689 ++++++ docs/ims/api-ref/en-us_topic_0102682862.html | 233 ++ docs/ims/api-ref/en-us_topic_0102682863.html | 168 ++ docs/ims/api-ref/en-us_topic_0102682864.html | 109 + docs/ims/api-ref/en-us_topic_0102682865.html | 164 ++ docs/ims/api-ref/en-us_topic_0102682866.html | 167 ++ docs/ims/api-ref/en-us_topic_0121643825.html | 116 + docs/ims/api-ref/en-us_topic_0122410333.html | 21 + docs/ims/api-ref/en-us_topic_0122410334.html | 31 + docs/ims/api-ref/en-us_topic_0122410335.html | 17 + docs/ims/api-ref/en-us_topic_0122410336.html | 23 + docs/ims/api-ref/en-us_topic_0125866389.html | 21 + docs/ims/api-ref/en-us_topic_0125866390.html | 237 ++ docs/ims/api-ref/en-us_topic_0125866391.html | 136 ++ docs/ims/api-ref/en-us_topic_0125866392.html | 70 + docs/ims/api-ref/en-us_topic_0125866393.html | 114 + docs/ims/api-ref/en-us_topic_0125866394.html | 37 + docs/ims/api-ref/en-us_topic_0125866395.html | 37 + docs/ims/api-ref/en-us_topic_0133188204.html | 426 ++++ docs/ims/api-ref/en-us_topic_0135460761.html | 29 + docs/ims/api-ref/en-us_topic_0135481402.html | 29 + docs/ims/api-ref/en-us_topic_0135481403.html | 17 + docs/ims/api-ref/en-us_topic_0135482660.html | 19 + docs/ims/api-ref/en-us_topic_0160121770.html | 19 + docs/ims/api-ref/en-us_topic_0170918587.html | 17 + docs/ims/api-ref/en-us_topic_0170918588.html | 198 ++ .../public_sys-resources/icon-arrowdn.gif | Bin 68 -> 1887 bytes .../public_sys-resources/icon-arrowrt.gif | Bin 70 -> 1890 bytes 142 files changed, 18502 insertions(+), 16620 deletions(-) create mode 100644 docs/ims/api-ref/en-us_topic_0000001311190309.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001360879672.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001360879684.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001360879692.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001360879704.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001360879708.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001360879712.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001360879728.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001360879732.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001360879736.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001360879740.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001361039228.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001361039236.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001361039248.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001361039252.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001361039260.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001361039264.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001361039272.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001361039284.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001361199212.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001361199224.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001361199228.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001361199232.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001361199244.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001361199252.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001361199260.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001361199268.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001411119517.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001411119529.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001411119537.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001411119541.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001411119549.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001411119557.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001411119565.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001411119573.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001411119577.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001411119581.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001411239209.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001411239213.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001411239225.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001411239233.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001411239237.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001411239245.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001411239253.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001411239269.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001411399133.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001411399137.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001411399145.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001411399153.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001411399161.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001411399165.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001411399169.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001411399181.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001411399189.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001411479433.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001411479437.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001411479457.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001411479461.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001411479465.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001411479469.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001411479473.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001411479477.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001411479493.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001411479497.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001411479501.html delete mode 100644 docs/ims/api-ref/en-us_topic_0000001411479505.html create mode 100644 docs/ims/api-ref/en-us_topic_0020091553.html create mode 100644 docs/ims/api-ref/en-us_topic_0020091554.html create mode 100644 docs/ims/api-ref/en-us_topic_0020091555.html create mode 100644 docs/ims/api-ref/en-us_topic_0020091556.html create mode 100644 docs/ims/api-ref/en-us_topic_0020091562.html create mode 100644 docs/ims/api-ref/en-us_topic_0020091565.html create mode 100644 docs/ims/api-ref/en-us_topic_0020091566.html create mode 100644 docs/ims/api-ref/en-us_topic_0020091567.html create mode 100644 docs/ims/api-ref/en-us_topic_0020092108.html create mode 100644 docs/ims/api-ref/en-us_topic_0020092109.html create mode 100644 docs/ims/api-ref/en-us_topic_0020092110.html create mode 100644 docs/ims/api-ref/en-us_topic_0020092111.html create mode 100644 docs/ims/api-ref/en-us_topic_0020507759.html create mode 100644 docs/ims/api-ref/en-us_topic_0022473688.html create mode 100644 docs/ims/api-ref/en-us_topic_0022473689.html create mode 100644 docs/ims/api-ref/en-us_topic_0024735403.html create mode 100644 docs/ims/api-ref/en-us_topic_0031615565.html create mode 100644 docs/ims/api-ref/en-us_topic_0031615566.html create mode 100644 docs/ims/api-ref/en-us_topic_0031617666.html create mode 100644 docs/ims/api-ref/en-us_topic_0036994315.html create mode 100644 docs/ims/api-ref/en-us_topic_0036994316.html create mode 100644 docs/ims/api-ref/en-us_topic_0036994317.html create mode 100644 docs/ims/api-ref/en-us_topic_0036994318.html create mode 100644 docs/ims/api-ref/en-us_topic_0036994319.html create mode 100644 docs/ims/api-ref/en-us_topic_0036994320.html create mode 100644 docs/ims/api-ref/en-us_topic_0036994321.html create mode 100644 docs/ims/api-ref/en-us_topic_0036994322.html create mode 100644 docs/ims/api-ref/en-us_topic_0036994323.html create mode 100644 docs/ims/api-ref/en-us_topic_0036994324.html create mode 100644 docs/ims/api-ref/en-us_topic_0037131984.html create mode 100644 docs/ims/api-ref/en-us_topic_0049147855.html create mode 100644 docs/ims/api-ref/en-us_topic_0049147856.html create mode 100644 docs/ims/api-ref/en-us_topic_0049147876.html create mode 100644 docs/ims/api-ref/en-us_topic_0049147877.html create mode 100644 docs/ims/api-ref/en-us_topic_0060804959.html create mode 100644 docs/ims/api-ref/en-us_topic_0060804960.html create mode 100644 docs/ims/api-ref/en-us_topic_0066978719.html create mode 100644 docs/ims/api-ref/en-us_topic_0066978720.html create mode 100644 docs/ims/api-ref/en-us_topic_0066978721.html create mode 100644 docs/ims/api-ref/en-us_topic_0066978722.html create mode 100644 docs/ims/api-ref/en-us_topic_0067360381.html create mode 100644 docs/ims/api-ref/en-us_topic_0067360382.html create mode 100644 docs/ims/api-ref/en-us_topic_0083905788.html create mode 100644 docs/ims/api-ref/en-us_topic_0092380109.html create mode 100644 docs/ims/api-ref/en-us_topic_0093967371.html create mode 100644 docs/ims/api-ref/en-us_topic_0093967372.html create mode 100644 docs/ims/api-ref/en-us_topic_0102682861.html create mode 100644 docs/ims/api-ref/en-us_topic_0102682862.html create mode 100644 docs/ims/api-ref/en-us_topic_0102682863.html create mode 100644 docs/ims/api-ref/en-us_topic_0102682864.html create mode 100644 docs/ims/api-ref/en-us_topic_0102682865.html create mode 100644 docs/ims/api-ref/en-us_topic_0102682866.html create mode 100644 docs/ims/api-ref/en-us_topic_0121643825.html create mode 100644 docs/ims/api-ref/en-us_topic_0122410333.html create mode 100644 docs/ims/api-ref/en-us_topic_0122410334.html create mode 100644 docs/ims/api-ref/en-us_topic_0122410335.html create mode 100644 docs/ims/api-ref/en-us_topic_0122410336.html create mode 100644 docs/ims/api-ref/en-us_topic_0125866389.html create mode 100644 docs/ims/api-ref/en-us_topic_0125866390.html create mode 100644 docs/ims/api-ref/en-us_topic_0125866391.html create mode 100644 docs/ims/api-ref/en-us_topic_0125866392.html create mode 100644 docs/ims/api-ref/en-us_topic_0125866393.html create mode 100644 docs/ims/api-ref/en-us_topic_0125866394.html create mode 100644 docs/ims/api-ref/en-us_topic_0125866395.html create mode 100644 docs/ims/api-ref/en-us_topic_0133188204.html create mode 100644 docs/ims/api-ref/en-us_topic_0135460761.html create mode 100644 docs/ims/api-ref/en-us_topic_0135481402.html create mode 100644 docs/ims/api-ref/en-us_topic_0135481403.html create mode 100644 docs/ims/api-ref/en-us_topic_0135482660.html create mode 100644 docs/ims/api-ref/en-us_topic_0160121770.html create mode 100644 docs/ims/api-ref/en-us_topic_0170918587.html create mode 100644 docs/ims/api-ref/en-us_topic_0170918588.html diff --git a/docs/ims/api-ref/ALL_META.TXT.json b/docs/ims/api-ref/ALL_META.TXT.json index d2da3b6f0..72971c49f 100644 --- a/docs/ims/api-ref/ALL_META.TXT.json +++ b/docs/ims/api-ref/ALL_META.TXT.json @@ -1,6 +1,6 @@ [ { - "uri":"en-us_topic_0000001411119537.html", + "uri":"en-us_topic_0020507759.html", "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 ", @@ -10,7 +10,7 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000001411399165.html", + "uri":"en-us_topic_0122410333.html", "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.", @@ -20,7 +20,7 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000001361199212.html", + "uri":"en-us_topic_0135460761.html", "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.", @@ -30,7 +30,7 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000001360879728.html", + "uri":"en-us_topic_0020091565.html", "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", @@ -40,7 +40,7 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000001361039272.html", + "uri":"en-us_topic_0020091567.html", "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 ", @@ -50,17 +50,17 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000001361039228.html", + "uri":"en-us_topic_0020092109.html", "product_code":"ims", "code":"6", - "des":"This API is used to create a private image. The following methods are supported:Create a private image from an ECS.Create a private image from an external image file uplo", + "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", "title":"Creating an Image", "githuburl":"" }, { - "uri":"en-us_topic_0000001411239209.html", + "uri":"en-us_topic_0133188204.html", "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", @@ -70,7 +70,7 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000001411239225.html", + "uri":"en-us_topic_0083905788.html", "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", @@ -80,7 +80,7 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000001411239213.html", + "uri":"en-us_topic_0092380109.html", "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 ", @@ -90,7 +90,7 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000001411119529.html", + "uri":"en-us_topic_0037131984.html", "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", @@ -100,17 +100,17 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000001411479465.html", + "uri":"en-us_topic_0036994315.html", "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 of OBS.Th", + "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", "doc_type":"api", "kw":"Exporting an Image,Image,API Reference", "title":"Exporting an Image", "githuburl":"" }, { - "uri":"en-us_topic_0000001411479477.html", + "uri":"en-us_topic_0135481402.html", "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.", @@ -120,7 +120,7 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000001411239269.html", + "uri":"en-us_topic_0067360381.html", "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", @@ -130,7 +130,7 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000001360879736.html", + "uri":"en-us_topic_0067360382.html", "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", @@ -140,7 +140,7 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000001411119557.html", + "uri":"en-us_topic_0102682861.html", "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", @@ -150,7 +150,7 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000001411239245.html", + "uri":"en-us_topic_0102682862.html", "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", @@ -160,7 +160,7 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000001411479473.html", + "uri":"en-us_topic_0102682863.html", "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", @@ -170,7 +170,7 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000001411399169.html", + "uri":"en-us_topic_0102682864.html", "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", @@ -180,7 +180,7 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000001361039260.html", + "uri":"en-us_topic_0102682865.html", "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", @@ -190,7 +190,7 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000001360879712.html", + "uri":"en-us_topic_0102682866.html", "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", @@ -200,7 +200,7 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000001411399137.html", + "uri":"en-us_topic_0135482660.html", "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.", @@ -210,7 +210,7 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000001360879740.html", + "uri":"en-us_topic_0036994324.html", "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", @@ -220,7 +220,7 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000001411119577.html", + "uri":"en-us_topic_0036994322.html", "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 ", @@ -230,7 +230,7 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000001361039284.html", + "uri":"en-us_topic_0036994323.html", "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 ", @@ -240,7 +240,7 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000001361199268.html", + "uri":"en-us_topic_0049147855.html", "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.", @@ -250,7 +250,7 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000001411479505.html", + "uri":"en-us_topic_0049147856.html", "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", @@ -260,7 +260,7 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000001411479501.html", + "uri":"en-us_topic_0093967371.html", "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.", @@ -270,7 +270,7 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000001411119581.html", + "uri":"en-us_topic_0093967372.html", "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", @@ -280,19 +280,29 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000001361199224.html", + "uri":"en-us_topic_0000001311190309.html", "product_code":"ims", "code":"29", - "des":"This API is an extension one. It is used to query the execution status of an asynchronous job, for example, an image exporting job.GET /v1/{project_id}/jobs/{job_id}Table", + "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":"Asynchronous Job Query,IMS APIs,API Reference", + "kw":"Image Jobs", + "title":"Image Jobs", + "githuburl":"" + }, + { + "uri":"en-us_topic_0022473688.html", + "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", "githuburl":"" }, { - "uri":"en-us_topic_0000001411119541.html", + "uri":"en-us_topic_0160121770.html", "product_code":"ims", - "code":"30", + "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", @@ -300,9 +310,9 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000001411479469.html", + "uri":"en-us_topic_0122410334.html", "product_code":"ims", - "code":"31", + "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)", @@ -310,9 +320,9 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000001361199228.html", + "uri":"en-us_topic_0060804959.html", "product_code":"ims", - "code":"32", + "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", @@ -320,9 +330,9 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000001411399181.html", + "uri":"en-us_topic_0020091566.html", "product_code":"ims", - "code":"33", + "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", "doc_type":"api", "kw":"Querying Image Details (Native OpenStack API),Image (Native OpenStack APIs),API Reference", @@ -330,9 +340,9 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000001411399161.html", + "uri":"en-us_topic_0060804960.html", "product_code":"ims", - "code":"34", + "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", @@ -340,9 +350,9 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000001411479437.html", + "uri":"en-us_topic_0031615566.html", "product_code":"ims", - "code":"35", + "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", @@ -350,9 +360,9 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000001360879684.html", + "uri":"en-us_topic_0020092108.html", "product_code":"ims", - "code":"36", + "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", @@ -360,9 +370,9 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000001411119517.html", + "uri":"en-us_topic_0031615565.html", "product_code":"ims", - "code":"37", + "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", @@ -370,9 +380,9 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000001411399145.html", + "uri":"en-us_topic_0066978722.html", "product_code":"ims", - "code":"38", + "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", @@ -380,9 +390,9 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000001361039236.html", + "uri":"en-us_topic_0066978721.html", "product_code":"ims", - "code":"39", + "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", @@ -390,9 +400,9 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000001360879692.html", + "uri":"en-us_topic_0066978720.html", "product_code":"ims", - "code":"40", + "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", @@ -400,9 +410,9 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000001360879704.html", + "uri":"en-us_topic_0122410335.html", "product_code":"ims", - "code":"41", + "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)", @@ -410,9 +420,9 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000001360879672.html", + "uri":"en-us_topic_0020092111.html", "product_code":"ims", - "code":"42", + "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", @@ -420,9 +430,9 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000001411479493.html", + "uri":"en-us_topic_0020091553.html", "product_code":"ims", - "code":"43", + "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", @@ -430,9 +440,9 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000001411399189.html", + "uri":"en-us_topic_0020091554.html", "product_code":"ims", - "code":"44", + "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)", @@ -440,9 +450,9 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000001360879732.html", + "uri":"en-us_topic_0020091555.html", "product_code":"ims", - "code":"45", + "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", "doc_type":"api", "kw":"Querying an Image Schema (Native OpenStack API),Image Schema (Native OpenStack APIs),API Reference", @@ -450,9 +460,9 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000001411119573.html", + "uri":"en-us_topic_0020091556.html", "product_code":"ims", - "code":"46", + "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", @@ -460,9 +470,9 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000001411119565.html", + "uri":"en-us_topic_0049147876.html", "product_code":"ims", - "code":"47", + "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", "doc_type":"api", "kw":"Querying an Image Member Schema (Native OpenStack API),Image Schema (Native OpenStack APIs),API Refe", @@ -470,9 +480,9 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000001411239253.html", + "uri":"en-us_topic_0049147877.html", "product_code":"ims", - "code":"48", + "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", "doc_type":"api", "kw":"Querying an Image Member List Schema (Native OpenStack API),Image Schema (Native OpenStack APIs),API", @@ -480,9 +490,9 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000001361039248.html", + "uri":"en-us_topic_0122410336.html", "product_code":"ims", - "code":"49", + "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)", @@ -490,19 +500,19 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000001411119549.html", + "uri":"en-us_topic_0036994317.html", "product_code":"ims", - "code":"50", - "des":"This API is used to add a project ID of a tenant with whom the image is to be shared.POST /v2/images/{image_id}/membersRequest parametersParameterMandatoryTypeDescription", + "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", "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)", "githuburl":"" }, { - "uri":"en-us_topic_0000001361039252.html", + "uri":"en-us_topic_0036994318.html", "product_code":"ims", - "code":"51", + "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 ", @@ -510,9 +520,9 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000001360879708.html", + "uri":"en-us_topic_0036994319.html", "product_code":"ims", - "code":"52", + "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", @@ -520,9 +530,9 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000001411479497.html", + "uri":"en-us_topic_0036994320.html", "product_code":"ims", - "code":"53", + "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", @@ -530,9 +540,9 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000001361199260.html", + "uri":"en-us_topic_0036994321.html", "product_code":"ims", - "code":"54", + "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", @@ -540,9 +550,9 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000001411399153.html", + "uri":"en-us_topic_0170918587.html", "product_code":"ims", - "code":"55", + "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)", @@ -550,9 +560,9 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000001411479461.html", + "uri":"en-us_topic_0066978719.html", "product_code":"ims", - "code":"56", + "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", "doc_type":"api", "kw":"Querying API Versions (Native OpenStack API),API Version Query (Native OpenStack API),API Reference", @@ -560,9 +570,9 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000001411479457.html", + "uri":"en-us_topic_0170918588.html", "product_code":"ims", - "code":"57", + "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", @@ -570,9 +580,79 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000001361039264.html", + "uri":"en-us_topic_0125866389.html", "product_code":"ims", - "code":"58", + "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", + "title":"Permission Policies and Supported Actions", + "githuburl":"" + }, + { + "uri":"en-us_topic_0125866390.html", + "product_code":"ims", + "code":"60", + "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", + "title":"Image Management", + "githuburl":"" + }, + { + "uri":"en-us_topic_0125866391.html", + "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 Tagging,Permission Policies and Supported Actions,API Reference", + "title":"Image Tagging", + "githuburl":"" + }, + { + "uri":"en-us_topic_0125866392.html", + "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 Schema,Permission Policies and Supported Actions,API Reference", + "title":"Image Schema", + "githuburl":"" + }, + { + "uri":"en-us_topic_0125866393.html", + "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 Sharing,Permission Policies and Supported Actions,API Reference", + "title":"Image Sharing", + "githuburl":"" + }, + { + "uri":"en-us_topic_0125866394.html", + "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 Replication,Permission Policies and Supported Actions,API Reference", + "title":"Image Replication", + "githuburl":"" + }, + { + "uri":"en-us_topic_0125866395.html", + "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 Quota,Permission Policies and Supported Actions,API Reference", + "title":"Image Quota", + "githuburl":"" + }, + { + "uri":"en-us_topic_0135481403.html", + "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":"Common Parameters", @@ -580,9 +660,9 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000001361199252.html", + "uri":"en-us_topic_0020091562.html", "product_code":"ims", - "code":"59", + "code":"67", "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", "doc_type":"api", "kw":"Image Attributes,Common Parameters,API Reference", @@ -590,9 +670,9 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000001411479433.html", + "uri":"en-us_topic_0020092110.html", "product_code":"ims", - "code":"60", + "code":"68", "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", @@ -600,19 +680,19 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000001361199232.html", + "uri":"en-us_topic_0036994316.html", "product_code":"ims", - "code":"61", - "des":"You can use the image sharing function to share your private images with other users.Images can only be shared within a region.Each image can be shared with a maximum of ", + "code":"69", + "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", "title":"Restrictions on Image Sharing", "githuburl":"" }, { - "uri":"en-us_topic_0000001411239237.html", + "uri":"en-us_topic_0031617666.html", "product_code":"ims", - "code":"62", + "code":"70", "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", @@ -620,9 +700,9 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000001411399133.html", + "uri":"en-us_topic_0121643825.html", "product_code":"ims", - "code":"63", + "code":"71", "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", @@ -630,9 +710,9 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000001411239233.html", + "uri":"en-us_topic_0022473689.html", "product_code":"ims", - "code":"64", + "code":"72", "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", @@ -640,9 +720,9 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000001361199244.html", + "uri":"en-us_topic_0024735403.html", "product_code":"ims", - "code":"65", + "code":"73", "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", diff --git a/docs/ims/api-ref/CLASS.TXT.json b/docs/ims/api-ref/CLASS.TXT.json index a1ba8626a..90aa5d9c2 100644 --- a/docs/ims/api-ref/CLASS.TXT.json +++ b/docs/ims/api-ref/CLASS.TXT.json @@ -3,7 +3,7 @@ "desc":"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 ", "product_code":"ims", "title":"API Usage Guidelines", - "uri":"en-us_topic_0000001411119537.html", + "uri":"en-us_topic_0020507759.html", "doc_type":"api", "p_code":"", "code":"1" @@ -12,7 +12,7 @@ "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"ims", "title":"IMS APIs", - "uri":"en-us_topic_0000001411399165.html", + "uri":"en-us_topic_0122410333.html", "doc_type":"api", "p_code":"", "code":"2" @@ -21,7 +21,7 @@ "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"ims", "title":"Image", - "uri":"en-us_topic_0000001361199212.html", + "uri":"en-us_topic_0135460761.html", "doc_type":"api", "p_code":"2", "code":"3" @@ -30,7 +30,7 @@ "desc":"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", "product_code":"ims", "title":"Querying Images", - "uri":"en-us_topic_0000001360879728.html", + "uri":"en-us_topic_0020091565.html", "doc_type":"api", "p_code":"3", "code":"4" @@ -39,16 +39,16 @@ "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 ", "product_code":"ims", "title":"Updating Image Information", - "uri":"en-us_topic_0000001361039272.html", + "uri":"en-us_topic_0020091567.html", "doc_type":"api", "p_code":"3", "code":"5" }, { - "desc":"This API is used to create a private image. The following methods are supported:Create a private image from an ECS.Create a private image from an external image file uplo", + "desc":"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", "product_code":"ims", "title":"Creating an Image", - "uri":"en-us_topic_0000001361039228.html", + "uri":"en-us_topic_0020092109.html", "doc_type":"api", "p_code":"3", "code":"6" @@ -57,7 +57,7 @@ "desc":"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", "product_code":"ims", "title":"Importing an Image File Quickly", - "uri":"en-us_topic_0000001411239209.html", + "uri":"en-us_topic_0133188204.html", "doc_type":"api", "p_code":"3", "code":"7" @@ -66,7 +66,7 @@ "desc":"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", "product_code":"ims", "title":"Creating a Data Disk Image Using an External Image File", - "uri":"en-us_topic_0000001411239225.html", + "uri":"en-us_topic_0083905788.html", "doc_type":"api", "p_code":"3", "code":"8" @@ -75,7 +75,7 @@ "desc":"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 ", "product_code":"ims", "title":"Creating a Full-ECS Image", - "uri":"en-us_topic_0000001411239213.html", + "uri":"en-us_topic_0092380109.html", "doc_type":"api", "p_code":"3", "code":"9" @@ -84,16 +84,16 @@ "desc":"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", "product_code":"ims", "title":"Registering an Image", - "uri":"en-us_topic_0000001411119529.html", + "uri":"en-us_topic_0037131984.html", "doc_type":"api", "p_code":"3", "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 of OBS.Th", + "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", "product_code":"ims", "title":"Exporting an Image", - "uri":"en-us_topic_0000001411479465.html", + "uri":"en-us_topic_0036994315.html", "doc_type":"api", "p_code":"3", "code":"11" @@ -102,7 +102,7 @@ "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"ims", "title":"Image Tagging", - "uri":"en-us_topic_0000001411479477.html", + "uri":"en-us_topic_0135481402.html", "doc_type":"api", "p_code":"2", "code":"12" @@ -111,7 +111,7 @@ "desc":"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", "product_code":"ims", "title":"Adding or Modifying a Tag", - "uri":"en-us_topic_0000001411239269.html", + "uri":"en-us_topic_0067360381.html", "doc_type":"api", "p_code":"12", "code":"13" @@ -120,7 +120,7 @@ "desc":"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", "product_code":"ims", "title":"Querying Tags", - "uri":"en-us_topic_0000001360879736.html", + "uri":"en-us_topic_0067360382.html", "doc_type":"api", "p_code":"12", "code":"14" @@ -129,7 +129,7 @@ "desc":"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", "product_code":"ims", "title":"Querying Images by Tag", - "uri":"en-us_topic_0000001411119557.html", + "uri":"en-us_topic_0102682861.html", "doc_type":"api", "p_code":"12", "code":"15" @@ -138,7 +138,7 @@ "desc":"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", "product_code":"ims", "title":"Adding or Deleting Image Tags in Batches", - "uri":"en-us_topic_0000001411239245.html", + "uri":"en-us_topic_0102682862.html", "doc_type":"api", "p_code":"12", "code":"16" @@ -147,7 +147,7 @@ "desc":"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", "product_code":"ims", "title":"Adding an Image Tag", - "uri":"en-us_topic_0000001411479473.html", + "uri":"en-us_topic_0102682863.html", "doc_type":"api", "p_code":"12", "code":"17" @@ -156,7 +156,7 @@ "desc":"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", "product_code":"ims", "title":"Deleting an Image Tag", - "uri":"en-us_topic_0000001411399169.html", + "uri":"en-us_topic_0102682864.html", "doc_type":"api", "p_code":"12", "code":"18" @@ -165,7 +165,7 @@ "desc":"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", "product_code":"ims", "title":"Querying Tags of an Image", - "uri":"en-us_topic_0000001361039260.html", + "uri":"en-us_topic_0102682865.html", "doc_type":"api", "p_code":"12", "code":"19" @@ -174,7 +174,7 @@ "desc":"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", "product_code":"ims", "title":"Querying All Image Tags", - "uri":"en-us_topic_0000001360879712.html", + "uri":"en-us_topic_0102682866.html", "doc_type":"api", "p_code":"12", "code":"20" @@ -183,7 +183,7 @@ "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"ims", "title":"Image Sharing", - "uri":"en-us_topic_0000001411399137.html", + "uri":"en-us_topic_0135482660.html", "doc_type":"api", "p_code":"2", "code":"21" @@ -192,7 +192,7 @@ "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", "product_code":"ims", "title":"Deleting Image Members in Batches", - "uri":"en-us_topic_0000001360879740.html", + "uri":"en-us_topic_0036994324.html", "doc_type":"api", "p_code":"21", "code":"22" @@ -201,7 +201,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", - "uri":"en-us_topic_0000001411119577.html", + "uri":"en-us_topic_0036994322.html", "doc_type":"api", "p_code":"21", "code":"23" @@ -210,7 +210,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", - "uri":"en-us_topic_0000001361039284.html", + "uri":"en-us_topic_0036994323.html", "doc_type":"api", "p_code":"21", "code":"24" @@ -219,7 +219,7 @@ "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"ims", "title":"Image Replication", - "uri":"en-us_topic_0000001361199268.html", + "uri":"en-us_topic_0049147855.html", "doc_type":"api", "p_code":"2", "code":"25" @@ -228,7 +228,7 @@ "desc":"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", "product_code":"ims", "title":"Replicating an Image Within a Region", - "uri":"en-us_topic_0000001411479505.html", + "uri":"en-us_topic_0049147856.html", "doc_type":"api", "p_code":"25", "code":"26" @@ -237,7 +237,7 @@ "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"ims", "title":"Image Quota", - "uri":"en-us_topic_0000001411479501.html", + "uri":"en-us_topic_0093967371.html", "doc_type":"api", "p_code":"2", "code":"27" @@ -246,342 +246,414 @@ "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", "product_code":"ims", "title":"Querying the Image Quota", - "uri":"en-us_topic_0000001411119581.html", + "uri":"en-us_topic_0093967372.html", "doc_type":"api", "p_code":"27", "code":"28" }, { - "desc":"This API is an extension one. It is used to query the execution status of an asynchronous job, for example, an image exporting job.GET /v1/{project_id}/jobs/{job_id}Table", + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"ims", - "title":"Asynchronous Job Query", - "uri":"en-us_topic_0000001361199224.html", + "title":"Image Jobs", + "uri":"en-us_topic_0000001311190309.html", "doc_type":"api", "p_code":"2", "code":"29" }, { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "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":"Native OpenStack APIs", - "uri":"en-us_topic_0000001411119541.html", + "title":"Asynchronous Job Query", + "uri":"en-us_topic_0022473688.html", "doc_type":"api", - "p_code":"", + "p_code":"29", "code":"30" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"ims", - "title":"Image (Native OpenStack APIs)", - "uri":"en-us_topic_0000001411479469.html", + "title":"Native OpenStack APIs", + "uri":"en-us_topic_0160121770.html", "doc_type":"api", - "p_code":"30", + "p_code":"", "code":"31" }, { - "desc":"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", + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"ims", - "title":"Querying Images (Native OpenStack API)", - "uri":"en-us_topic_0000001361199228.html", + "title":"Image (Native OpenStack APIs)", + "uri":"en-us_topic_0122410334.html", "doc_type":"api", "p_code":"31", "code":"32" }, + { + "desc":"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", + "product_code":"ims", + "title":"Querying Images (Native OpenStack API)", + "uri":"en-us_topic_0060804959.html", + "doc_type":"api", + "p_code":"32", + "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", "product_code":"ims", "title":"Querying Image Details (Native OpenStack API)", - "uri":"en-us_topic_0000001411399181.html", + "uri":"en-us_topic_0020091566.html", "doc_type":"api", - "p_code":"31", - "code":"33" + "p_code":"32", + "code":"34" }, { "desc":"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", "product_code":"ims", "title":"Updating Image Information (Native OpenStack API)", - "uri":"en-us_topic_0000001411399161.html", + "uri":"en-us_topic_0060804960.html", "doc_type":"api", - "p_code":"31", - "code":"34" + "p_code":"32", + "code":"35" }, { "desc":"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 ", "product_code":"ims", "title":"Uploading an Image (Native OpenStack API)", - "uri":"en-us_topic_0000001411479437.html", + "uri":"en-us_topic_0031615566.html", "doc_type":"api", - "p_code":"31", - "code":"35" + "p_code":"32", + "code":"36" }, { "desc":"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", "product_code":"ims", "title":"Deleting an Image (Native OpenStack API)", - "uri":"en-us_topic_0000001360879684.html", + "uri":"en-us_topic_0020092108.html", "doc_type":"api", - "p_code":"31", - "code":"36" + "p_code":"32", + "code":"37" }, { "desc":"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", "product_code":"ims", "title":"Creating Image Metadata (Native OpenStack API)", - "uri":"en-us_topic_0000001411119517.html", + "uri":"en-us_topic_0031615565.html", "doc_type":"api", - "p_code":"31", - "code":"37" + "p_code":"32", + "code":"38" }, { "desc":"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", "product_code":"ims", "title":"Deleting an Image (Native OpenStack API v1.1 - Abandoned and Not Recommended)", - "uri":"en-us_topic_0000001411399145.html", + "uri":"en-us_topic_0066978722.html", "doc_type":"api", - "p_code":"31", - "code":"38" + "p_code":"32", + "code":"39" }, { "desc":"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", "product_code":"ims", "title":"Querying Image Metadata (Native OpenStack API v1 - Abandoned and Not Recommended)", - "uri":"en-us_topic_0000001361039236.html", + "uri":"en-us_topic_0066978721.html", "doc_type":"api", - "p_code":"31", - "code":"39" + "p_code":"32", + "code":"40" }, { "desc":"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", "product_code":"ims", "title":"Querying Image Details (Native OpenStack API v1.1 - Abandoned and Not Recommended)", - "uri":"en-us_topic_0000001360879692.html", + "uri":"en-us_topic_0066978720.html", "doc_type":"api", - "p_code":"31", - "code":"40" + "p_code":"32", + "code":"41" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"ims", "title":"Image Tagging (Native OpenStack APIs)", - "uri":"en-us_topic_0000001360879704.html", + "uri":"en-us_topic_0122410335.html", "doc_type":"api", - "p_code":"30", - "code":"41" + "p_code":"31", + "code":"42" }, { "desc":"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.", "product_code":"ims", "title":"Adding a Tag (Native OpenStack API)", - "uri":"en-us_topic_0000001360879672.html", + "uri":"en-us_topic_0020092111.html", "doc_type":"api", - "p_code":"41", - "code":"42" + "p_code":"42", + "code":"43" }, { "desc":"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", "product_code":"ims", "title":"Deleting a Tag (Native OpenStack API)", - "uri":"en-us_topic_0000001411479493.html", + "uri":"en-us_topic_0020091553.html", "doc_type":"api", - "p_code":"41", - "code":"43" + "p_code":"42", + "code":"44" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"ims", "title":"Image Schema (Native OpenStack APIs)", - "uri":"en-us_topic_0000001411399189.html", + "uri":"en-us_topic_0020091554.html", "doc_type":"api", - "p_code":"30", - "code":"44" + "p_code":"31", + "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", "product_code":"ims", "title":"Querying an Image Schema (Native OpenStack API)", - "uri":"en-us_topic_0000001360879732.html", + "uri":"en-us_topic_0020091555.html", "doc_type":"api", - "p_code":"44", - "code":"45" + "p_code":"45", + "code":"46" }, { "desc":"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", "product_code":"ims", "title":"Querying an Image List Schema (Native OpenStack API)", - "uri":"en-us_topic_0000001411119573.html", + "uri":"en-us_topic_0020091556.html", "doc_type":"api", - "p_code":"44", - "code":"46" + "p_code":"45", + "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", "product_code":"ims", "title":"Querying an Image Member Schema (Native OpenStack API)", - "uri":"en-us_topic_0000001411119565.html", + "uri":"en-us_topic_0049147876.html", "doc_type":"api", - "p_code":"44", - "code":"47" + "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", "product_code":"ims", "title":"Querying an Image Member List Schema (Native OpenStack API)", - "uri":"en-us_topic_0000001411239253.html", + "uri":"en-us_topic_0049147877.html", "doc_type":"api", - "p_code":"44", - "code":"48" + "p_code":"45", + "code":"49" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"ims", "title":"Image Sharing (Native OpenStack APIs)", - "uri":"en-us_topic_0000001361039248.html", + "uri":"en-us_topic_0122410336.html", "doc_type":"api", - "p_code":"30", - "code":"49" + "p_code":"31", + "code":"50" }, { - "desc":"This API is used to add a project ID of a tenant with whom the image is to be shared.POST /v2/images/{image_id}/membersRequest parametersParameterMandatoryTypeDescription", + "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", "product_code":"ims", "title":"Adding an Image Member (Native OpenStack API)", - "uri":"en-us_topic_0000001411119549.html", + "uri":"en-us_topic_0036994317.html", "doc_type":"api", - "p_code":"49", - "code":"50" + "p_code":"50", + "code":"51" }, { "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)", - "uri":"en-us_topic_0000001361039252.html", + "uri":"en-us_topic_0036994318.html", "doc_type":"api", - "p_code":"49", - "code":"51" + "p_code":"50", + "code":"52" }, { "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)", - "uri":"en-us_topic_0000001360879708.html", + "uri":"en-us_topic_0036994319.html", "doc_type":"api", - "p_code":"49", - "code":"52" + "p_code":"50", + "code":"53" }, { "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)", - "uri":"en-us_topic_0000001411479497.html", + "uri":"en-us_topic_0036994320.html", "doc_type":"api", - "p_code":"49", - "code":"53" + "p_code":"50", + "code":"54" }, { "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)", - "uri":"en-us_topic_0000001361199260.html", + "uri":"en-us_topic_0036994321.html", "doc_type":"api", - "p_code":"49", - "code":"54" + "p_code":"50", + "code":"55" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"ims", "title":"API Version Query (Native OpenStack API)", - "uri":"en-us_topic_0000001411399153.html", + "uri":"en-us_topic_0170918587.html", "doc_type":"api", - "p_code":"30", - "code":"55" + "p_code":"31", + "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", "product_code":"ims", "title":"Querying API Versions (Native OpenStack API)", - "uri":"en-us_topic_0000001411479461.html", + "uri":"en-us_topic_0066978719.html", "doc_type":"api", - "p_code":"55", - "code":"56" + "p_code":"56", + "code":"57" }, { "desc":"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", "product_code":"ims", "title":"Querying an API Version (Native OpenStack API)", - "uri":"en-us_topic_0000001411479457.html", + "uri":"en-us_topic_0170918588.html", "doc_type":"api", - "p_code":"55", - "code":"57" + "p_code":"56", + "code":"58" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"ims", - "title":"Common Parameters", - "uri":"en-us_topic_0000001361039264.html", + "title":"Permission Policies and Supported Actions", + "uri":"en-us_topic_0125866389.html", "doc_type":"api", "p_code":"", - "code":"58" - }, - { - "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", - "product_code":"ims", - "title":"Image Attributes", - "uri":"en-us_topic_0000001361199252.html", - "doc_type":"api", - "p_code":"58", "code":"59" }, { - "desc":"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", + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"ims", - "title":"Image Tag Data Formats", - "uri":"en-us_topic_0000001411479433.html", + "title":"Image Management", + "uri":"en-us_topic_0125866390.html", "doc_type":"api", - "p_code":"58", + "p_code":"59", "code":"60" }, { - "desc":"You can use the image sharing function to share your private images with other users.Images can only be shared within a region.Each image can be shared with a maximum of ", + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"ims", - "title":"Restrictions on Image Sharing", - "uri":"en-us_topic_0000001361199232.html", + "title":"Image Tagging", + "uri":"en-us_topic_0125866391.html", "doc_type":"api", - "p_code":"58", + "p_code":"59", "code":"61" }, { - "desc":"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", + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"ims", - "title":"Values of Related Parameters", - "uri":"en-us_topic_0000001411239237.html", + "title":"Image Schema", + "uri":"en-us_topic_0125866392.html", "doc_type":"api", - "p_code":"58", + "p_code":"59", "code":"62" }, { - "desc":"NormalReturned ValueDescription200 OKThe results of GET and PUT operations are returned as expected.201 CreatedThe results of the POST operation are returned as expected.", + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"ims", - "title":"Status Codes", - "uri":"en-us_topic_0000001411399133.html", + "title":"Image Sharing", + "uri":"en-us_topic_0125866393.html", "doc_type":"api", - "p_code":"", + "p_code":"59", "code":"63" }, { - "desc":"If the returned status code is 400, a customized error message will be returned. This section describes the meaning of each status code.", + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"ims", - "title":"Error Codes", - "uri":"en-us_topic_0000001411239233.html", + "title":"Image Replication", + "uri":"en-us_topic_0125866394.html", "doc_type":"api", - "p_code":"", + "p_code":"59", "code":"64" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"ims", - "title":"Change History", - "uri":"en-us_topic_0000001361199244.html", + "title":"Image Quota", + "uri":"en-us_topic_0125866395.html", + "doc_type":"api", + "p_code":"59", + "code":"65" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"ims", + "title":"Common Parameters", + "uri":"en-us_topic_0135481403.html", "doc_type":"api", "p_code":"", - "code":"65" + "code":"66" + }, + { + "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", + "product_code":"ims", + "title":"Image Attributes", + "uri":"en-us_topic_0020091562.html", + "doc_type":"api", + "p_code":"66", + "code":"67" + }, + { + "desc":"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", + "product_code":"ims", + "title":"Image Tag Data Formats", + "uri":"en-us_topic_0020092110.html", + "doc_type":"api", + "p_code":"66", + "code":"68" + }, + { + "desc":"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 ", + "product_code":"ims", + "title":"Restrictions on Image Sharing", + "uri":"en-us_topic_0036994316.html", + "doc_type":"api", + "p_code":"66", + "code":"69" + }, + { + "desc":"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", + "product_code":"ims", + "title":"Values of Related Parameters", + "uri":"en-us_topic_0031617666.html", + "doc_type":"api", + "p_code":"66", + "code":"70" + }, + { + "desc":"NormalReturned ValueDescription200 OKThe results of GET and PUT operations are returned as expected.201 CreatedThe results of the POST operation are returned as expected.", + "product_code":"ims", + "title":"Status Codes", + "uri":"en-us_topic_0121643825.html", + "doc_type":"api", + "p_code":"", + "code":"71" + }, + { + "desc":"If the returned status code is 400, a customized error message will be returned. This section describes the meaning of each status code.", + "product_code":"ims", + "title":"Error Codes", + "uri":"en-us_topic_0022473689.html", + "doc_type":"api", + "p_code":"", + "code":"72" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"ims", + "title":"Change History", + "uri":"en-us_topic_0024735403.html", + "doc_type":"api", + "p_code":"", + "code":"73" } ] \ No newline at end of file diff --git a/docs/ims/api-ref/en-us_topic_0000001311190309.html b/docs/ims/api-ref/en-us_topic_0000001311190309.html new file mode 100644 index 000000000..3e871c6b3 --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0000001311190309.html @@ -0,0 +1,19 @@ + + + +

Image Jobs

+ +

+
+ +
+ + +
+
Parent topic: IMS APIs
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0000001360879672.html b/docs/ims/api-ref/en-us_topic_0000001360879672.html deleted file mode 100644 index 9f9136926..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001360879672.html +++ /dev/null @@ -1,101 +0,0 @@ - - -

Adding a Tag (Native OpenStack API)

-

Function

This API is used to add a custom tag to an image. With tags, you can manage easily the images.

-
-

URI

PUT /v2/images/{image_id}/tags/{tag}

-
Table 1 lists the parameters in the URI. -
- - - - - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

image_id

-

Yes

-

String

-

Specifies the image ID.

-

tag

-

Yes

-

String

-

Specifies the tag to be added.

-

The tag can contain only digits, letters, underscores (_), and hyphens (-).

-
NOTE:

This API can only be used to add a tag key. To add a tag value, use the PUT /v1/cloudimages/tags API. For details, see Adding or Modifying a Tag.

-
-
-
-
-
-

Request

  • Request parameters

    None

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

Response

  • Response parameters

    None

    -
  • Example response
    STATUS CODE 204
    -
-
-

Returned Values

  • Normal

    204

    -
  • Abnormal -
    - - - - - - - - - - - - - - - - - - - - - - -

    Returned Value

    -

    Description

    -

    400 Bad Request

    -

    Request error.

    -

    401 Unauthorized

    -

    Authentication failed.

    -

    403 Forbidden

    -

    You do not have the rights to perform the operation.

    -

    404 Not Found

    -

    The requested resource was not found.

    -

    500 Internal Server Error

    -

    Internal service error.

    -

    503 Service Unavailable

    -

    The service is unavailable.

    -
    -
    -
-
-
-
-
-
Parent topic: Image Tagging (Native OpenStack APIs)
-
-
- diff --git a/docs/ims/api-ref/en-us_topic_0000001360879684.html b/docs/ims/api-ref/en-us_topic_0000001360879684.html deleted file mode 100644 index 820c8e6f7..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001360879684.html +++ /dev/null @@ -1,119 +0,0 @@ - - -

Deleting an Image (Native OpenStack API)

-

Function

This API is used to delete a private image. You can only delete your own private images.

-
-

URI

DELETE /v2/images/{image_id}

-
Table 1 lists the parameters in the URI. -
- - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

image_id

-

Yes

-

String

-

Specifies the image ID.

-
-
-
-
-

Request

  • Request parameters -
    - - - - - - - - - - - -

    Parameter

    -

    Mandatory

    -

    Type

    -

    Description

    -

    delete_backup

    -

    No

    -

    Boolean

    -

    Specifies whether to delete the CSBS 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 are also deleted.
    • false: When a full-ECS image is deleted, its CSBS backups are not deleted.
    -
    -
    -
  • Example request
    DELETE https://{Endpoint}/v2/images/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90
    -
    1
-2
-3
    {
-    "delete_backup": true
-}
-
    -
    -
-
-

Response

  • Response parameters

    None

    -
  • Example response
    STATUS CODE 204
    -
-
-

Returned Values

  • Normal

    204

    -
  • Abnormal -
    - - - - - - - - - - - - - - - - - - - - - - -

    Returned Value

    -

    Description

    -

    400 Bad Request

    -

    Request error.

    -

    401 Unauthorized

    -

    Authentication failed.

    -

    403 Forbidden

    -

    You do not have the rights to perform the operation.

    -

    404 Not Found

    -

    The requested resource was not found.

    -

    500 Internal Server Error

    -

    Internal service error.

    -

    503 Service Unavailable

    -

    The service is unavailable.

    -
    -
    -
-
-
-
-
-
Parent topic: Image (Native OpenStack APIs)
-
-
- diff --git a/docs/ims/api-ref/en-us_topic_0000001360879692.html b/docs/ims/api-ref/en-us_topic_0000001360879692.html deleted file mode 100644 index e570b9678..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001360879692.html +++ /dev/null @@ -1,339 +0,0 @@ - - -

Querying Image Details (Native OpenStack API v1.1 - Abandoned and Not Recommended)

-

Function

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.

-
-

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.

    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

    Parameter

    -

    Mandatory

    -

    Type

    -

    Description

    -

    name

    -

    No

    -

    String

    -

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

    -

    container_format

    -

    No

    -

    String

    -

    Image container type

    -

    disk_format

    -

    No

    -

    String

    -

    Image file format

    -

    status

    -

    No

    -

    String

    -

    Image status

    -

    size_min

    -

    No

    -

    String

    -

    Minimum size of the image

    -

    size_max

    -

    No

    -

    String

    -

    Maximum size of the image

    -

    changes-since

    -

    No

    -

    String

    -

    Last update time

    -
    -
    -
  • Example request
    GET https://{Endpoint}/v1.1/images/detail?disk_format=qcow2
    -
-
-

Response

  • Response parameters -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

    Parameter

    -

    Type

    -

    Description

    -

    status

    -

    String

    -

    Image status

    -

    virtual_size

    -

    Integer

    -

    Virtual size of an image

    -

    name

    -

    String

    -

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

    -

    deleted

    -

    Boolean

    -

    Whether an image has been deleted

    -

    container_format

    -

    String

    -

    Image container type

    -

    created_at

    -

    String

    -

    Time when an image was created

    -

    disk_format

    -

    String

    -

    Image file type

    -

    updated_at

    -

    String

    -

    Time when an image was updated

    -

    properties

    -

    Object

    -

    Image attribute

    -

    owner

    -

    String

    -

    Tenant to which an image belongs

    -

    protected

    -

    Boolean

    -

    Whether an image is protected

    -

    min_ram

    -

    Integer

    -

    Minimum memory (MB) required for running an image

    -

    checksum

    -

    String

    -

    Image verification sum. This parameter is available after an image file is uploaded.

    -

    min_disk

    -

    Integer

    -

    Minimum disk capacity (GB) required for running the image

    -

    is_public

    -

    Boolean

    -

    Whether an image is a public one

    -

    deleted_at

    -

    String

    -

    Time when an image was deleted

    -

    id

    -

    String

    -

    Image UUID

    -

    size

    -

    Integer

    -

    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
-{
-    "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

    -

    Description

    -

    400 Bad Request

    -

    Request error.

    -

    401 Unauthorized

    -

    Authentication failed.

    -

    403 Forbidden

    -

    You do not have the rights to perform the operation.

    -

    404 Not Found

    -

    The requested resource was not found.

    -

    500 Internal Server Error

    -

    Internal service error.

    -

    503 Service Unavailable

    -

    The service is unavailable.

    -
    -
    -
-
-
-
-
-
Parent topic: Image (Native OpenStack APIs)
-
-
- diff --git a/docs/ims/api-ref/en-us_topic_0000001360879704.html b/docs/ims/api-ref/en-us_topic_0000001360879704.html deleted file mode 100644 index bbaffb1ad..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001360879704.html +++ /dev/null @@ -1,17 +0,0 @@ - - -

Image Tagging (Native OpenStack APIs)

-
-
- - -
-
Parent topic: Native OpenStack APIs
-
-
- diff --git a/docs/ims/api-ref/en-us_topic_0000001360879708.html b/docs/ims/api-ref/en-us_topic_0000001360879708.html deleted file mode 100644 index 4e5dc4522..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001360879708.html +++ /dev/null @@ -1,168 +0,0 @@ - - -

Querying Image 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}

-

Table 1 lists the parameters in the URI.

- -
- - - - - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

image_id

-

Yes

-

String

-

Specifies the image ID.

-

member_id

-

Yes

-

String

-

Specifies the member ID.

-
-
-
-

Request

  • Request parameters

    None

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

Response

  • Response parameters -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

    Parameter

    -

    Type

    -

    Description

    -

    status

    -

    String

    -

    Specifies the image sharing status.

    -

    created_at

    -

    String

    -

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

    -

    updated_at

    -

    String

    -

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

    -

    image_id

    -

    String

    -

    Specifies the image ID.

    -

    member_id

    -

    String

    -

    Specifies the member ID.

    -

    schema

    -

    String

    -

    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"
-}
-
    -
    -
-
-

Returned Values

  • Normal

    200

    -
  • Abnormal -
    - - - - - - - - - - - - - - - - - - - - - - -

    Returned Value

    -

    Description

    -

    400 Bad Request

    -

    Request error.

    -

    401 Unauthorized

    -

    Authentication failed.

    -

    403 Forbidden

    -

    You do not have the rights to perform the operation.

    -

    404 Not Found

    -

    The requested resource was not found.

    -

    500 Internal Server Error

    -

    Internal service error.

    -

    503 Service Unavailable

    -

    The service is unavailable.

    -
    -
    -
-
-
-
-
-
Parent topic: Image Sharing (Native OpenStack APIs)
-
-
- diff --git a/docs/ims/api-ref/en-us_topic_0000001360879712.html b/docs/ims/api-ref/en-us_topic_0000001360879712.html deleted file mode 100644 index 052fa0450..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001360879712.html +++ /dev/null @@ -1,166 +0,0 @@ - - -

Querying All Image Tags

-

Function

This API is used to query all the image tags.

-
-

URI

GET /v2/{project_id}/images/tags

-
Table 1 lists the parameters in the URI. -
- - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-
-
-
-
-

Request

  • Request parameters

    None

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

Response

  • Response parameters -
    - - - - - - - - - -

    Parameter

    -

    Type

    -

    Description

    -

    tags

    -

    Array of objects

    -

    Lists tags. For details, see Table 2.

    -
    -
    - -
    - - - - - - - - - - - - - -
    Table 2 Data structure description of the tags field

    Parameter

    -

    Type

    -

    Description

    -

    key

    -

    String

    -

    Specifies the tag key.

    -

    values

    -

    Array of 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"
-   }]
-}
-
    -
    -
-
-

Returned Value

  • Normal

    200

    -
  • Abnormal -
    - - - - - - - - - - - - - - - - - - - - - - -

    Returned Value

    -

    Description

    -

    400 Bad Request

    -

    Request error

    -

    401 Unauthorized

    -

    Authentication failed.

    -

    403 Forbidden

    -

    You do not have the rights to perform the operation.

    -

    404 Not Found

    -

    The requested resource was not found.

    -

    500 Internal Server Error

    -

    Internal service error

    -

    503 Service Unavailable

    -

    The service is unavailable.

    -
    -
    -
-
-
-
-
-
Parent topic: Image Tagging
-
-
- diff --git a/docs/ims/api-ref/en-us_topic_0000001360879728.html b/docs/ims/api-ref/en-us_topic_0000001360879728.html deleted file mode 100644 index fe43d8641..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001360879728.html +++ /dev/null @@ -1,966 +0,0 @@ - - -

Querying Images

-

Function

This API is used to query images using search criteria and to display the images in a list.

-
-

URI

GET /v2/cloudimages{?__isregistered,__imagetype,__whole_image,__system__cmkid,protected,visibility,owner,id,status,name,container_format,disk_format,min_ram,min_disk,__os_bit,__platform,marker,limit,sort_key,sort_dir,__os_type,tag,member_status,__support_kvm,__support_xen,__support_largememory,__support_diskintensive,__support_highperformance,__support_xen_gpu_type,__support_kvm_gpu_type,__support_xen_hana,__support_kvm_infiniband,virtual_env_type,created_at,updated_at}

-

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.

-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

__isregistered

-

No

-

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.

-

__imagetype

-

No

-

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.
-
NOTE:

The __imagetype of images you share with other tenants or those other tenants share with you and you have accepted is shared. You can use field owner to distinguish the two types of shared images. You can use member_status to filter out shared images you have accepted.

-
-

__whole_image

-

No

-

Boolean

-

Specifies whether the image is a full-ECS image. The value can be true or false.

-

__system__cmkid

-

No

-

String

-

Specifies the ID of the key used to encrypt the image. You can obtain the ID from the IMS console or by calling the Querying Image Details (Native OpenStack API) API.

-

protected

-

No

-

Boolean

-

Specifies whether the image is protected. The value can be true or false. Set it to true when you query public images. This parameter is optional when you query private images.

-

visibility

-

No

-

String

-

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

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

owner

-

No

-

String

-

Specifies the tenant to which the image belongs.

-

id

-

No

-

String

-

Specifies the image ID.

-

status

-

No

-

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.
-

name

-

No

-

String

-

Specifies the image name. Exact matching is used. For detailed description, see Image Attributes.

-

container_format

-

No

-

String

-

Specifies the container type. The value is bare.

-

disk_format

-

No

-

String

-

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

-

min_ram

-

No

-

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.

-

min_disk

-

No

-

Integer

-

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

-

__os_bit

-

No

-

String

-

Specifies the OS architecture, 32 bit or 64 bit.

-

__platform

-

No

-

String

-

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

-

marker

-

No

-

String

-

Specifies the start number from which images are queried. The value is the image ID.

-

limit

-

No

-

Integer

-

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

-

sort_key

-

No

-

String

-

Specifies the field for sorting the query results. The value can be an attribute of the image: name, container_format, disk_format, status, id, size, or created_at. The default value is created_at.

-

sort_dir

-

No

-

String

-

Specifies whether the query results are sorted in ascending or descending order. Its value can be desc (default) or asc. This parameter is used together with parameter sort_key. The default value is desc.

-

__os_type

-

No

-

String

-

Specifies the image OS type. Available values include:

-
  • Linux
  • Windows
  • Other
-

tag

-

No

-

String

-

Specifies a tag added to an image. Tags can be used as a filter to query images.

-
NOTE:

The tagging function has been upgraded. If the tags added before the function upgrade are in the format of "Key.Value", query tags using "Key=Value". For example, an existing tag is a.b. After the tag function upgrade, query the tag using "tag=a=b".

-
-

member_status

-

No

-

String

-

Specifies the member status. The value can be accepted, rejected, or pending. accepted: indicates that the shared image is accepted. rejected indicates that the image shared by others is rejected. pending indicates that the image shared by others needs to be confirmed. To use this parameter, set visibility to shared during the query.

-

__support_kvm

-

No

-

String

-

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

-

__support_xen

-

No

-

String

-

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

-

__support_largememory

-

No

-

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 the supported OSs, see Table 4.

-

-

__support_diskintensive

-

No

-

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.

-

__support_highperformance

-

No

-

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.

-

__support_xen_gpu_type

-

No

-

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.

-

__support_kvm_gpu_type

-

No

-

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.

-

__support_xen_hana

-

No

-

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.

-

__support_kvm_infiniband

-

No

-

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.

-

virtual_env_type

-

No

-

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.
-

created_at

-

No

-

String

-

Specifies the time when the image was created. 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.

-

For example, to query images created before Oct 28, 2018 10:00:00, set the value of created_at as follows:

-

created_at=lt:2018-10-28T10:00:00Z

-

updated_at

-

No

-

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.

-

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.

-

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}/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}

    -
  • Available shared images

    GET /v2/cloudimages?member_status=accepted&visibility=shared&__imagetype=shared

    -
  • Rejected images

    GET /v2/cloudimages?member_status=rejected&visibility=shared&__imagetype=shared

    -
  • Unaccepted images

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

    -
-
-

Response

  • Response parameters -
    - - - - - - - - - -

    Parameter

    -

    Type

    -

    Description

    -

    images

    -

    Array of objects

    -

    Specifies image details.

    -

    For details, see Table 2.

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

    Parameter

    -

    Type

    -

    Description

    -

    file

    -

    String

    -

    Specifies the URL for uploading and downloading the image file.

    -

    owner

    -

    String

    -

    Specifies the tenant to which the image belongs.

    -

    id

    -

    String

    -

    Specifies the image ID.

    -

    size

    -

    Long

    -

    This parameter is unavailable currently.

    -

    self

    -

    String

    -

    Specifies the image URL.

    -

    schema

    -

    String

    -

    Specifies the image schema.

    -

    status

    -

    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.
    -

    tags

    -

    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.

    -

    visibility

    -

    String

    -

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

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

    name

    -

    String

    -

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

    -

    checksum

    -

    String

    -

    This parameter is unavailable currently.

    -

    protected

    -

    Boolean

    -

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

    -

    container_format

    -

    String

    -

    Specifies the container type.

    -

    min_ram

    -

    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.

    -

    max_ram

    -

    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.

    -

    updated_at

    -

    String

    -

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

    -

    __os_bit

    -

    String

    -

    Specifies the OS architecture, 32 bit or 64 bit.

    -

    __os_version

    -

    String

    -

    Specifies the OS version.

    -

    __description

    -

    String

    -

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

    -

    disk_format

    -

    String

    -

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

    -

    __isregistered

    -

    String

    -

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

    -

    __platform

    -

    String

    -

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

    -

    __os_type

    -

    String

    -

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

    -

    min_disk

    -

    Integer

    -

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

    -

    virtual_env_type

    -

    String

    -

    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

    -

    String

    -

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

    -

    __imagetype

    -

    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.
    -

    created_at

    -

    String

    -

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

    -

    virtual_size

    -

    Integer

    -

    This parameter is unavailable currently.

    -

    __originalimagename

    -

    String

    -

    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

    -

    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.

    -

    __image_size

    -

    String

    -

    Specifies the size (bytes) of the image file.

    -

    __data_origin

    -

    String

    -

    Specifies the image source.

    -

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

    -

    __lazyloading

    -

    Boolean

    -

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

    -

    active_at

    -

    String

    -

    Specifies the time when the image status became active.

    -

    __os_feature_list

    -

    String

    -

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

    -

    __support_kvm

    -

    String

    -

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

    -

    __support_xen

    -

    String

    -

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

    -

    __support_largememory

    -

    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.

    -

    __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.

    -

    __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.

    -

    __support_xen_gpu_type

    -

    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.

    -

    __support_kvm_gpu_type

    -

    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.

    -

    __support_xen_hana

    -

    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.

    -

    __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.

    -

    __root_origin

    -

    String

    -

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

    -

    __sequence_num

    -

    String

    -

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

    -

    Example value: 0

    -

    hw_firmware_type

    -

    String

    -

    Specifies the ECS boot mode. Available values include:

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

    hw_vif_multiqueue_enabled

    -

    String

    -

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

    -

    __system__cmkid

    -

    String

    -

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

    -

    __support_amd

    -

    String

    -

    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
-69
-70
    {
-  "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",
-      "__support_kvm_fpga_type": "VU9P",
-      "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",
-      "__support_kvm_fpga_type": "VU9P_COMMON",
-      "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

    -

    Description

    -

    400 Bad Request

    -

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

    -

    401 Unauthorized

    -

    Authentication failed.

    -

    403 Forbidden

    -

    You do not have the rights to perform the operation.

    -

    404 Not Found

    -

    The requested resource was not found.

    -

    500 Internal Server Error

    -

    Internal service error.

    -

    503 Service Unavailable

    -

    The service is unavailable.

    -
    -
    -
-
-
-
-
-
Parent topic: Image
-
-
- diff --git a/docs/ims/api-ref/en-us_topic_0000001360879732.html b/docs/ims/api-ref/en-us_topic_0000001360879732.html deleted file mode 100644 index 5ac665c41..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001360879732.html +++ /dev/null @@ -1,539 +0,0 @@ - - -

Querying an Image Schema (Native OpenStack API)

-

Function

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

-
-

URI

GET /v2/schemas/image

-
-

Request

  • Request parameters

    None

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

Response

  • Response parameters -
    - - - - - - - - - - - - - - - - - - - - - -

    Parameter

    -

    Type

    -

    Description

    -

    additionalProperties

    -

    Object

    -

    Specifies the additional attributes.

    -

    For details, see Table 1.

    -

    name

    -

    String

    -

    Specifies the schema name.

    -

    links

    -

    Array of objects

    -

    Specifies the URL for accessing the schema.

    -

    For details, see Table 2.

    -

    properties

    -

    Object

    -

    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

    -

    Type

    -

    Description

    -

    type

    -

    String

    -

    Type

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

    Parameter

    -

    Type

    -

    Description

    -

    href

    -

    String

    -

    Specifies the domain name.

    -

    rel

    -

    String

    -

    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)"
-        }
-    }
-}
-
    -
    -
-
-

Returned Values

  • Normal

    200

    -
  • Abnormal -
    - - - - - - - - - - - - - - - - - - - - - - -

    Returned Value

    -

    Description

    -

    400 Bad Request

    -

    Request error.

    -

    401 Unauthorized

    -

    Authentication failed.

    -

    403 Forbidden

    -

    You do not have the rights to perform the operation.

    -

    404 Not Found

    -

    The requested resource was not found.

    -

    500 Internal Server Error

    -

    Internal service error.

    -

    503 Service Unavailable

    -

    The service is unavailable.

    -
    -
    -
-
-
-
-
-
Parent topic: Image Schema (Native OpenStack APIs)
-
-
- diff --git a/docs/ims/api-ref/en-us_topic_0000001360879736.html b/docs/ims/api-ref/en-us_topic_0000001360879736.html deleted file mode 100644 index 2df26ae4d..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001360879736.html +++ /dev/null @@ -1,458 +0,0 @@ - - -

Querying Tags

-

Function

This API is used to query image tags using search criteria and display them in a list.

-
-

URI

GET /v1/cloudimages/tags{?__isregistered,__imagetype,__whole_image,__system__cmkid,protected,visibility,owner,id,status,name,container_format,disk_format,min_ram,min_disk,__os_bit,__platform,marker,limit,sort_key,sort_dir,__os_type,tag,member_status,__support_kvm,__support_xen,__support_largememory,__support_diskintensive,__support_highperformance,__support_xen_gpu_type,__support_kvm_gpu_type,__support_xen_hana,__support_kvm_infiniband,virtual_env_type,created_at,updated_at}

-

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.

-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

__isregistered

-

No

-

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.

-

__imagetype

-

No

-

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.
-
NOTE:

The __imagetype of images you share with other tenants or those other tenants share with you and you have accepted is shared. You can use field owner to distinguish the two types of shared images. You can use member_status to filter out shared images you have accepted.

-
-

__whole_image

-

No

-

Boolean

-

Specifies whether the image is a full-ECS image. The value can be true or false.

-

__system__cmkid

-

No

-

String

-

Specifies the ID of the key used to encrypt the image. You can obtain the ID from the IMS console or by calling the Querying Image Details (Native OpenStack API) API.

-

protected

-

No

-

Boolean

-

Specifies whether the image is protected. The value can be true or false. Set it to true when you query public images. This parameter is optional when you query private images.

-

visibility

-

No

-

String

-

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

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

owner

-

No

-

String

-

Specifies the tenant to which the image belongs.

-

id

-

No

-

String

-

Specifies the image ID.

-

status

-

No

-

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.
-

name

-

No

-

String

-

Specifies the image name. Exact matching is used. For detailed description, see Image Attributes.

-

container_format

-

No

-

String

-

Specifies the container type. The value is bare.

-

disk_format

-

No

-

String

-

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

-

min_ram

-

No

-

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.

-

min_disk

-

No

-

Integer

-

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

-

__os_bit

-

No

-

String

-

Specifies the OS architecture, 32 bit or 64 bit.

-

__platform

-

No

-

String

-

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

-

marker

-

No

-

String

-

Specifies the start number from which images are queried. The value is the image ID.

-

limit

-

No

-

Integer

-

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

-

sort_key

-

No

-

String

-

Specifies the field for sorting the query results. The value can be an attribute of the image: name, container_format, disk_format, status, id, size, or created_at. The default value is created_at.

-

sort_dir

-

No

-

String

-

Specifies whether the query results are sorted in ascending or descending order. Its value can be desc (default) or asc. This parameter is used together with parameter sort_key. The default value is desc.

-

__os_type

-

No

-

String

-

Specifies the image OS type. Available values include:

-
  • Linux
  • Windows
  • Other
-

tag

-

No

-

String

-

Specifies a tag added to an image. Tags can be used as a filter to query images.

-
NOTE:

The tagging function has been upgraded. If the tags added before the function upgrade are in the format of "Key.Value", query tags using "Key=Value". For example, an existing tag is a.b. After the tag function upgrade, query the tag using "tag=a=b".

-
-

member_status

-

No

-

String

-

Specifies the member status. The value can be accepted, rejected, or pending. accepted: indicates that the shared image is accepted. rejected indicates that the image shared by others is rejected. pending indicates that the image shared by others needs to be confirmed. To use this parameter, set visibility to shared during the query.

-

__support_kvm

-

No

-

String

-

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

-

__support_xen

-

No

-

String

-

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

-

__support_largememory

-

No

-

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 the supported OSs, see Table 4.

-

-

__support_diskintensive

-

No

-

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.

-

__support_highperformance

-

No

-

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.

-

__support_xen_gpu_type

-

No

-

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.

-

__support_kvm_gpu_type

-

No

-

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.

-

__support_xen_hana

-

No

-

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.

-

__support_kvm_infiniband

-

No

-

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.

-

virtual_env_type

-

No

-

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.
-

created_at

-

No

-

String

-

Specifies the time when the image was created. 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.

-

For example, to query images created before Oct 28, 2018 10:00:00, set the value of created_at as follows:

-

created_at=lt:2018-10-28T10:00:00Z

-

updated_at

-

No

-

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.

-

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.

-

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
    -
-
-

Response

  • Response parameters -
    - - - - - - - - - -

    Parameter

    -

    Type

    -

    Description

    -

    tags

    -

    Array of strings

    -

    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"
-   ]
-}
-
    -
    -

    In the new specification, equal signs are used as separators.

    -
    -
-
-

Returned Value

  • Normal

    200

    -
  • Abnormal -
    - - - - - - - - - - - - - - - - - - - - - - -

    Returned Value

    -

    Description

    -

    400 Bad Request

    -

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

    -

    401 Unauthorized

    -

    Authentication failed.

    -

    403 Forbidden

    -

    You do not have the rights to perform the operation.

    -

    404 Not Found

    -

    The requested resource was not found.

    -

    500 Internal Server Error

    -

    Internal service error.

    -

    503 Service Unavailable

    -

    The service is unavailable.

    -
    -
    -
-
-
-
-
-
Parent topic: Image Tagging
-
-
- diff --git a/docs/ims/api-ref/en-us_topic_0000001360879740.html b/docs/ims/api-ref/en-us_topic_0000001360879740.html deleted file mode 100644 index 0fb345943..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001360879740.html +++ /dev/null @@ -1,144 +0,0 @@ - - -

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.

-
-

URI

DELETE /v1/cloudimages/members

-
-

Request

  • Request parameters -
    - - - - - - - - - - - - - - - - -

    Parameter

    -

    Mandatory

    -

    Type

    -

    Description

    -

    images

    -

    Yes

    -

    Array of strings

    -

    Specifies the image IDs.

    -

    projects

    -

    Yes

    -

    Array of strings

    -

    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"
-    ]
-}
-
    -
    -
-
-

Response

  • Response parameters -
    - - - - - - - - - -

    Parameter

    -

    Type

    -

    Description

    -

    job_id

    -

    String

    -

    Specifies the asynchronous task ID.

    -

    For details, see Asynchronous Job Query.

    -
    -
    -
  • Example response
    STATUS CODE 200
    -
    1
-2
-3
    {
-    "job_id": "edc89b490d7d4392898e19b2deb34797"
-}
-
    -
    -
-
-

Returned Value

  • Normal

    200

    -
  • Abnormal -
    - - - - - - - - - - - - - - - - - - - - - - -

    Returned Value

    -

    Description

    -

    400 Bad Request

    -

    Request error. For details, see Error Codes.

    -

    401 Unauthorized

    -

    Authentication failed.

    -

    403 Forbidden

    -

    You do not have the rights to perform the operation.

    -

    404 Not Found

    -

    The requested resource was not found.

    -

    500 Internal Server Error

    -

    Internal service error.

    -

    503 Service Unavailable

    -

    The service is unavailable.

    -
    -
    -
-
-
-
-
-
Parent topic: Image Sharing
-
-
- diff --git a/docs/ims/api-ref/en-us_topic_0000001361039228.html b/docs/ims/api-ref/en-us_topic_0000001361039228.html deleted file mode 100644 index c7ae38497..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001361039228.html +++ /dev/null @@ -1,627 +0,0 @@ - - -

Creating an Image

-

Function

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

-
  • Create a private image from an ECS.
  • Create a private image from an external image file uploaded to an 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.

-

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

-
-

URI

POST /v2/cloudimages/action

-
-

Request

  • Parameters for creating an image from an ECS -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

    Parameter

    -

    Mandatory

    -

    Type

    -

    Description

    -

    name

    -

    Yes

    -

    String

    -

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

    -

    description

    -

    No

    -

    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.

    -

    instance_id

    -

    Yes

    -

    String

    -

    Specifies the ID of the ECS used to create the image.

    -

    To obtain the ECS ID, perform the following operations:

    -
    1. Log in to management console.
    2. Under Computing, click Elastic Cloud Server.
    3. In the ECS list, click the name of the ECS and view its ID.
    -

    data_images

    -

    No

    -

    Array of objects

    -

    Specifies the data disk information to be converted. This parameter is mandatory when the data disk of an ECS is used to create a private data disk image. For details, see Table 1.

    -

    If the ECS data disk is not used to create a data disk image, the parameter is empty by default.

    -
    NOTE:

    When you create a data disk image using a data disk, if other parameters (such as name, description, and tags) in this table have values, the system uses the value of data_images. You cannot specify instance_id.

    -
    -

    tags

    -

    No

    -

    Array of strings

    -

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

    -

    Use either tags or image_tags.

    -

    image_tags

    -

    No

    -

    Array of objects

    -

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

    -

    Use either tags or image_tags.

    -

    max_ram

    -

    No

    -

    Integer

    -

    Specifies the maximum memory of the image in the unit of MB.

    -

    min_ram

    -

    No

    -

    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.

    -
    -
    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 1 Data structure description of the data_images field

    Parameter

    -

    Mandatory

    -

    Type

    -

    Description

    -

    name

    -

    Yes

    -

    String

    -

    Specifies the name of a data disk image.

    -

    volume_id

    -

    Yes

    -

    String

    -

    Specifies the data disk ID.

    -

    description

    -

    No

    -

    String

    -

    Specifies the data disk description.

    -

    tags

    -

    No

    -

    Array of strings

    -

    Specifies the data disk image tag.

    -
    -
    -
  • Parameters for creating an image using an image file uploaded to the OBS bucket -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

    Parameter

    -

    Mandatory

    -

    Type

    -

    Description

    -

    name

    -

    Yes

    -

    String

    -

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

    -

    description

    -

    No

    -

    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.

    -

    os_type

    -

    No

    -

    String

    -

    Specifies the OS type.

    -

    The value can be Linux, Windows, or Other.

    -

    os_version

    -

    No

    -

    String

    -

    Specifies the OS version.

    -

    This parameter is valid if an external image file uploaded to the OBS bucket is used to create an image. For its value, see Values of Related Parameters.

    -
    NOTE:

    This parameter is mandatory when the value of is_quick_import is true, that is, a system disk image is imported using the quick import method.

    -
    -

    image_url

    -

    Yes

    -

    String

    -

    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.

    -
    • To obtain an OBS bucket name:
      1. Log in to the management console and choose Storage > Object Storage Service.

        All OBS buckets are displayed in the list.

        -
      2. Filter the OBS buckets by region and locate the target bucket in the current region.
      -
    • To obtain an OBS image file name:
      1. Log in to the management console and choose Storage > Object Storage Service.

        All OBS buckets are displayed in the list.

        -
      2. Filter the OBS buckets by region and check the OBS buckets in the current region.
      3. Click the name of the target bucket to go to the bucket details page.
      4. In the navigation pane on the left, choose Objects to display objects in the OBS bucket and then locate the external image file used to create an image.
      -
    -
    NOTE:

    The storage class of the OBS bucket must be Standard.

    -
    -

    min_disk

    -

    Yes

    -

    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.

    -

    is_config

    -

    No

    -

    Boolean

    -

    Specifies whether automatic configuration is enabled.

    -

    The value can be true or false.

    -

    If automatic configuration is required, set the value to true. Otherwise, set the value to false The default value is false.

    -

    For details about automatic configuration, see Creating a Linux System Disk Image from an External Image File > Registering an External Image File as a Private Image (Linux) in Image Management Service User Guide.

    -

    cmk_id

    -

    No

    -

    String

    -

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

    -

    tags

    -

    No

    -

    Array of strings

    -

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

    -

    Use either tags or image_tags.

    -

    image_tags

    -

    No

    -

    Array of objects

    -

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

    -

    type

    -

    No

    -

    String

    -

    Specifies the image type.

    -

    The value can be ECS, BMS, FusionCompute, or Ironic. The default value is ECS.

    -
    • ECS and FusionCompute: indicate an ECS image.
    • BMS and Ironic: indicate a BMS image.
    -

    max_ram

    -

    No

    -

    Integer

    -

    Specifies the maximum memory of the image in the unit of MB.

    -

    min_ram

    -

    No

    -

    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.

    -

    data_images

    -

    No

    -

    Array of objects

    -

    Specifies the data disk information to be imported.

    -

    An external image file can contain a maximum of three data disks. In this case, one system disk and three data disks will be created.

    -

    For details, see Table 2.

    -
    NOTE:
    • If a data disk image file is used to create a data disk image, the OS type of the data disk image must be the same as that of the system disk image.
    • If other parameters (such as name, description, and tags) in Table 2 are set, the system uses the values in data_images.
    -
    -

    is_quick_import

    -

    No

    -

    Boolean

    -

    Specifies whether to use the quick import method to import a system disk image.

    -
    • If yes, set the value to true.
    • If no, set the value to false.
    -

    For details about the restrictions on quick import of image files, see Importing an Image File Quickly.

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

    Parameter

    -

    Mandatory

    -

    Type

    -

    Description

    -

    name

    -

    No

    -

    String

    -

    Specifies the image name.

    -

    For more details, see Image Attributes.

    -

    description

    -

    No

    -

    String

    -

    Specifies the enterprise project that the image belongs to. The value 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.

    -

    image_url

    -

    Yes

    -

    String

    -

    Specifies the URL of the external image file in the OBS bucket.

    -

    The format is OBS bucket name:Image file name.

    -
    • To obtain an OBS bucket name:
      1. Log in to the management console and choose Storage > Object Storage Service.

        All OBS buckets are displayed in the list.

        -
      2. Filter the OBS buckets by region and locate the target bucket in the current region.
      -
    • To obtain an OBS image file name:
      1. Log in to the management console and choose Storage > Object Storage Service.

        All OBS buckets are displayed in the list.

        -
      2. Filter the OBS buckets by region and check the OBS buckets in the current region.
      3. Click the name of the target bucket to go to the bucket details page.
      4. In the navigation pane on the left, choose Objects to display objects in the OBS bucket and then locate the external image file used to create an image.
      -
    -
    NOTE:

    The storage class of the OBS bucket must be Standard.

    -
    -

    min_disk

    -

    Yes

    -

    Integer

    -

    Specifies the minimum size of the data disk.

    -

    Unit: GB

    -

    Value range: 1–2048

    -

    is_quick_import

    -

    No

    -

    Boolean

    -

    Specifies whether an image file is imported quickly to create a data disk image.

    -
    • If yes, set the value to true.
    • If no, set the value to false.
    -

    For details about the restrictions on quick import of image files, see Importing an Image File Quickly.

    -

    tags

    -

    No

    -

    Array of strings

    -

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

    -

    For detailed parameter descriptions, see Image Tag Data Formats.

    -

    Use either tags or image_tags.

    -

    image_tags

    -

    No

    -

    Array of objects

    -

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

    -

    For detailed parameter descriptions, see Image Tag Data Formats.

    -

    Use either tags or image_tags.

    -
    -
    -
  • Example requests
    • Request for creating a system disk image with parameter tags using an ECS
      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",
-    "tags": [
-        "aaa.111",
-        "bbb.333",
-        "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"
-              ]
-       }]
-}
-
      -
      -
    • 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
-13
-14
      {
-      "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",
-      "is_config_init": true,
-      "min_disk": 40,
-      "is_config": true,
-      "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
      -
      {
-    "name": "ims_test",
-    "description": "Create a system disk image from an ECS",
-    "instance_id": "877a2cda-ba63-4e1e-b95f-e67e48b6129a",
-    "image_tags": [
-{
-            "key": "key2",
-            "value": "value2"
-        },
-{
-            "key": "key1",
-            "value": "value1"
-}
-         ]
-}
      -
    • 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"}]
-       }]
-}
-
      -
      -
    • 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
- 9
-10
      {
-       "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",
-       "is_config_init": true,
-       "min_disk": 40,
-       
-       "image_tags": [{"key":"key2","value":"value2"},{"key":"key1","value":"value1"}]    
-}
-
      -
      -
    -
-
-

Response

  • Response parameters -
    - - - - - - - - - -

    Parameter

    -

    Type

    -

    Description

    -

    job_id

    -

    String

    -

    Specifies the asynchronous job ID.

    -

    For details, see Asynchronous Job Query.

    -
    -
    -
  • Example response
    STATUS CODE 200
    -
    1
-2
-3
    {
-    "job_id": "8a12fc664fb4daa3014fb4e581380005"
-}
-
    -
    -
-
-

Returned Values

  • Normal

    200

    -
  • Abnormal -
    - - - - - - - - - - - - - - - - - - - - - - -

    Returned Value

    -

    Description

    -

    400 Bad Request

    -

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

    -

    401 Unauthorized

    -

    Authentication failed.

    -

    403 Forbidden

    -

    You do not have the rights to perform the operation.

    -

    404 Not Found

    -

    The requested resource was not found.

    -

    500 Internal Server Error

    -

    Internal service error.

    -

    503 Service Unavailable

    -

    The service is unavailable.

    -
    -
    -
-
-
-
-
-
Parent topic: Image
-
-
- diff --git a/docs/ims/api-ref/en-us_topic_0000001361039236.html b/docs/ims/api-ref/en-us_topic_0000001361039236.html deleted file mode 100644 index 40bce4f78..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001361039236.html +++ /dev/null @@ -1,269 +0,0 @@ - - -

Querying Image Metadata (Native OpenStack API v1 - Abandoned and Not Recommended)

-

Function

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.

-
-

URI

HEAD /v1/images/{image_id}

-
Table 1 lists the parameters in the URI. -
- - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

image_id

-

Yes

-

String

-

Specifies the image ID.

-
-
-
-
-

Request

  • Request parameters

    None

    -
  • Example request
    HEAD https://{Endpoint}/v1/images/3c3d1d01-b48a-4639-8a88-08be3b9b5d78
    -
-
-

Response

  • Response parameters -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

    Parameter

    -

    Type

    -

    Description

    -

    Status

    -

    String

    -

    Image status

    -

    Virtual_size

    -

    Integer

    -

    Virtual size of an image

    -

    Name

    -

    String

    -

    Image name

    -

    Deleted

    -

    Boolean

    -

    Whether an image has been deleted

    -

    Container_format

    -

    String

    -

    Image container type

    -

    Created_at

    -

    String

    -

    Time when an image was created

    -

    Disk_format

    -

    String

    -

    Image file type

    -

    Updated_at

    -

    String

    -

    Time when an image was updated

    -

    Property

    -

    Object

    -

    Image attribute

    -

    Owner

    -

    String

    -

    Tenant to which an image belongs

    -

    Protected

    -

    Boolean

    -

    Whether an image is protected

    -

    Min_ram

    -

    Integer

    -

    Minimum memory (MB) required for running an image

    -

    Checksum

    -

    String

    -

    Image verification sum. This parameter is available after an image file is uploaded.

    -

    Min_disk

    -

    Integer

    -

    Minimum disk capacity (GB) required for running the image

    -

    Is_public

    -

    Boolean

    -

    Whether an image is a public one

    -

    Deleted_at

    -

    String

    -

    Time when an image was deleted

    -

    Id

    -

    String

    -

    Image UUID

    -

    Size

    -

    Integer

    -

    Image size. This parameter is available after an image file is uploaded.

    -
    -
    -

    These parameters are contained in the header of the HTTP response message.

    -
  • 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
    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

    -

    Description

    -

    400 Bad Request

    -

    Request error.

    -

    401 Unauthorized

    -

    Authentication failed.

    -

    403 Forbidden

    -

    You do not have the rights to perform the operation.

    -

    404 Not Found

    -

    The requested resource was not found.

    -

    500 Internal Server Error

    -

    Internal service error.

    -

    503 Service Unavailable

    -

    The service is unavailable.

    -
    -
    -
-
-
-
-
-
Parent topic: Image (Native OpenStack APIs)
-
-
- diff --git a/docs/ims/api-ref/en-us_topic_0000001361039248.html b/docs/ims/api-ref/en-us_topic_0000001361039248.html deleted file mode 100644 index afadcf13d..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001361039248.html +++ /dev/null @@ -1,23 +0,0 @@ - - -

Image Sharing (Native OpenStack APIs)

-
-
- - -
-
Parent topic: Native OpenStack APIs
-
-
- diff --git a/docs/ims/api-ref/en-us_topic_0000001361039252.html b/docs/ims/api-ref/en-us_topic_0000001361039252.html deleted file mode 100644 index 715c3b6b6..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001361039252.html +++ /dev/null @@ -1,221 +0,0 @@ - - -

Updating the Image Sharing Status in Batches (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}

-
Table 1 lists the parameters in the URI. -
- - - - - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

image_id

-

Yes

-

String

-

Specifies the image ID.

-

member_id

-

Yes

-

String

-

Specifies the member ID.

-
-
-
-
-

Request

  • Request parameters -
    - - - - - - - - - - - - - - - - -

    Parameter

    -

    Mandatory

    -

    Type

    -

    Description

    -

    status

    -

    Yes

    -

    String

    -

    Specifies whether a shared image will be accepted or declined.

    -

    Available values include:

    -
    • 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 rejected, the image is not displayed in the image list. However, you can still use the image to create ECSs.
    -

    vault_id

    -

    No

    -

    String

    -

    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 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"
-}
-
      -
      -
    -
-
-

Response

  • Response parameters -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

    Parameter

    -

    Type

    -

    Description

    -

    status

    -

    String

    -

    Specifies the image sharing status.

    -

    created_at

    -

    String

    -

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

    -

    updated_at

    -

    String

    -

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

    -

    image_id

    -

    String

    -

    Specifies the image ID.

    -

    member_id

    -

    String

    -

    Specifies the member ID.

    -

    schema

    -

    String

    -

    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"
-}
-
    -
    -
-
-

Returned Values

  • Normal

    200

    -
  • Abnormal -
    - - - - - - - - - - - - - - - - - - - - - - -

    Returned Value

    -

    Description

    -

    400 Bad Request

    -

    Request error.

    -

    401 Unauthorized

    -

    Authentication failed.

    -

    403 Forbidden

    -

    You do not have the rights to perform the operation.

    -

    404 Not Found

    -

    The requested resource was not found.

    -

    500 Internal Server Error

    -

    Internal service error.

    -

    503 Service Unavailable

    -

    The service is unavailable.

    -
    -
    -
-
-
-
-
-
Parent topic: Image Sharing (Native OpenStack APIs)
-
-
- diff --git a/docs/ims/api-ref/en-us_topic_0000001361039260.html b/docs/ims/api-ref/en-us_topic_0000001361039260.html deleted file mode 100644 index 15f159f4c..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001361039260.html +++ /dev/null @@ -1,163 +0,0 @@ - - -

Querying Tags of an Image

-

Function

This API is used to query all the tags of a specified image.

-
-

URI

GET /v2/{project_id}/images/{image_id}/tags

-
Table 1 lists the parameters in the URI. -
- - - - - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-

image_id

-

Yes

-

String

-

Specifies the image ID.

-
-
-
-
-

Request

  • Request parameters

    None

    -
  • Example request
    GET https://{Endpoint}/v2/fd73a4a14a4a4dfb9771a8475e5198ea/images/67e17426-359e-49fb-aa12-0bd1756ec240/tags
    -
-
-

Response

  • Response parameters -
    - - - - - - - - - -

    Parameter

    -

    Type

    -

    Description

    -

    tags

    -

    Array of objects

    -

    Lists the returned tags. For details, see Table 2.

    -
    -
    - -
    - - - - - - - - - - - - - -
    Table 2 Data structure description of the tags field

    Parameter

    -

    Type

    -

    Description

    -

    key

    -

    String

    -

    Specifies the tag key.

    -

    value

    -

    String

    -

    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"
-   }]
-}
-
    -
    -
-
-

Returned Value

  • Normal

    200

    -
  • Abnormal -
    - - - - - - - - - - - - - - - - - - - - - - -

    Returned Value

    -

    Description

    -

    400 Bad Request

    -

    Request error.

    -

    401 Unauthorized

    -

    Authentication failed.

    -

    403 Forbidden

    -

    You do not have the rights to perform the operation.

    -

    404 Not Found

    -

    The requested resource was not found.

    -

    500 Internal Server Error

    -

    Internal service error.

    -

    503 Service Unavailable

    -

    The service is unavailable.

    -
    -
    -
-
-
-
-
-
Parent topic: Image Tagging
-
-
- diff --git a/docs/ims/api-ref/en-us_topic_0000001361039264.html b/docs/ims/api-ref/en-us_topic_0000001361039264.html deleted file mode 100644 index 22b6f2be1..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001361039264.html +++ /dev/null @@ -1,17 +0,0 @@ - - -

Common Parameters

-
-
- -
- diff --git a/docs/ims/api-ref/en-us_topic_0000001361039272.html b/docs/ims/api-ref/en-us_topic_0000001361039272.html deleted file mode 100644 index ce8f2817d..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001361039272.html +++ /dev/null @@ -1,643 +0,0 @@ - - -

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.

-
-
-

URI

PATCH /v2/cloudimages/{image_id}

-

Table 1 describes the parameters in the URI.

- -
- - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

image_id

-

Yes

-

String

-

Specifies the image ID.

-

For details about how to obtain the image ID, see Querying Images.

-
-
-
-

Request

  • Request parameters -
    - - - - - - - - - - - -

    Parameter

    -

    Mandatory

    -

    Type

    -

    Description

    -

    [Array]

    -

    Yes

    -

    Array of objects

    -

    For details, see Table 2.

    -
    -
    - -
    - - - - - - - - - - - - - - - - - - - - - -
    Table 2 Data structure description of the [Array] field

    Parameter

    -

    Mandatory

    -

    Type

    -

    Description

    -

    op

    -

    Yes

    -

    String

    -

    Specifies the operation. The value can be add, replace, or remove.

    -

    path

    -

    Yes

    -

    String

    -

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

    -

    You can modify 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.
    • 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.

    -

    value

    -

    Yes

    -

    String

    -

    Specifies the new value of the attribute. For detailed description, see Image 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"
-    }
-]
-
    -
    -
-
-

Response

  • Response parameters -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

    Parameter

    -

    Type

    -

    Description

    -

    file

    -

    String

    -

    Specifies the URL for uploading and downloading the image file.

    -

    owner

    -

    String

    -

    Specifies the tenant to which the image belongs.

    -

    id

    -

    String

    -

    Specifies the image ID.

    -

    size

    -

    Long

    -

    This parameter is unavailable currently.

    -

    self

    -

    String

    -

    Specifies the image URL.

    -

    schema

    -

    String

    -

    Specifies the image schema.

    -

    status

    -

    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.
    -

    tags

    -

    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.

    -

    visibility

    -

    String

    -

    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

    -

    String

    -

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

    -

    checksum

    -

    String

    -

    This parameter is unavailable currently.

    -

    protected

    -

    Boolean

    -

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

    -

    container_format

    -

    String

    -

    Specifies the container type.

    -

    min_ram

    -

    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.

    -

    max_ram

    -

    String

    -

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

    -

    updated_at

    -

    String

    -

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

    -

    __os_bit

    -

    String

    -

    Specifies the OS architecture, 32 bit or 64 bit.

    -

    __os_version

    -

    String

    -

    Specifies the OS version.

    -

    __description

    -

    String

    -

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

    -

    disk_format

    -

    String

    -

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

    -

    __isregistered

    -

    String

    -

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

    -

    __platform

    -

    String

    -

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

    -

    __os_type

    -

    String

    -

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

    -

    __system__cmkid

    -

    String

    -

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

    -

    min_disk

    -

    Integer

    -

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

    -

    virtual_env_type

    -

    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.
    -

    __image_source_type

    -

    String

    -

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

    -

    __imagetype

    -

    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.
    -

    created_at

    -

    String

    -

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

    -

    virtual_size

    -

    Integer

    -

    This parameter is unavailable currently.

    -

    __originalimagename

    -

    String

    -

    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

    -

    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.

    -

    __image_size

    -

    String

    -

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

    -

    __data_origin

    -

    String

    -

    Specifies the image source.

    -

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

    -

    __root_origin

    -

    String

    -

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

    -

    __lazyloading

    -

    Boolean

    -

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

    -

    active_at

    -

    String

    -

    Specifies the time when the image status became active.

    -

    __os_feature_list

    -

    String

    -

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

    -

    __account_code

    -

    String

    -

    Specifies the charging identifier for the image.

    -

    hw_firmware_type

    -

    String

    -

    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

    -

    String

    -

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

    -

    __support_kvm

    -

    String

    -

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

    -

    __support_xen

    -

    String

    -

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

    -

    __support_largememory

    -

    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.

    -

    For the supported OSs, see Table 4.

    -

    -

    __support_diskintensive

    -

    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.

    -

    __support_highperformance

    -

    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.

    -

    __support_xen_gpu_type

    -

    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.

    -

    __support_kvm_gpu_type

    -

    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.

    -

    __support_xen_hana

    -

    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.

    -

    __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.

    -

    __sequence_num

    -

    String

    -

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

    -

    This parameter is unavailable currently.

    -

    images.__system__cmkid

    -

    String

    -

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

    -

    __support_amd

    -

    String

    -

    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
    {
-    "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",
-    "__data_origin": null,
-    "hw_firmware_type": "bios"
-}
-
    -
    -
-
-

Returned Value

  • Normal

    200

    -
  • Abnormal -
    - - - - - - - - - - - - - - - - - - - - - - -

    Returned Value

    -

    Description

    -

    400 Bad Request

    -

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

    -

    401 Unauthorized

    -

    Authentication failed.

    -

    403 Forbidden

    -

    You do not have the rights to perform the operation.

    -

    404 Not Found

    -

    The requested resource was not found.

    -

    500 Internal Server Error

    -

    Internal service error.

    -

    503 Service Unavailable

    -

    The service is unavailable.

    -
    -
    -
-
-
-
-
-
Parent topic: Image
-
-
- diff --git a/docs/ims/api-ref/en-us_topic_0000001361039284.html b/docs/ims/api-ref/en-us_topic_0000001361039284.html deleted file mode 100644 index d52996283..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001361039284.html +++ /dev/null @@ -1,183 +0,0 @@ - - -

Updating the Status of Image Members in Batches

-

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.

-
-

URI

PUT /v1/cloudimages/members

-
-

Request

  • Request parameters -
    - - - - - - - - - - - - - - - - - - - - - - - - - - -

    Parameter

    -

    Mandatory

    -

    Type

    -

    Description

    -

    images

    -

    Yes

    -

    Array of strings

    -

    Specifies the image IDs.

    -

    project_id

    -

    Yes

    -

    String

    -

    Specifies the project ID.

    -

    status

    -

    Yes

    -

    String

    -

    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

    -

    No

    -

    String

    -

    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"
-}
-
      -
      -
    -
-
-

Response

  • Response parameters -
    - - - - - - - - - -

    Parameter

    -

    Type

    -

    Description

    -

    job_id

    -

    String

    -

    Specifies the asynchronous job ID.

    -

    For details, see Asynchronous Job Query.

    -
    -
    -
  • Example response
    STATUS CODE 200
    -
    1
-2
-3
    {
-    "job_id": "edc89b490d7d4392898e19b2deb34797"
-}
-
    -
    -
-
-

Returned Value

  • Normal

    200

    -
  • Abnormal -
    - - - - - - - - - - - - - - - - - - - - - - -

    Returned Value

    -

    Description

    -

    400 Bad Request

    -

    Request error. For details, see Error Codes.

    -

    401 Unauthorized

    -

    Authentication failed.

    -

    403 Forbidden

    -

    You do not have the rights to perform the operation.

    -

    404 Not Found

    -

    The requested resource was not found.

    -

    500 Internal Server Error

    -

    Internal service error.

    -

    503 Service Unavailable

    -

    The service is unavailable.

    -
    -
    -
-
-
-
-
-
Parent topic: Image Sharing
-
-
- diff --git a/docs/ims/api-ref/en-us_topic_0000001361199212.html b/docs/ims/api-ref/en-us_topic_0000001361199212.html deleted file mode 100644 index 40d482017..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001361199212.html +++ /dev/null @@ -1,29 +0,0 @@ - - -

Image

-
-
- - -
-
Parent topic: IMS APIs
-
-
- diff --git a/docs/ims/api-ref/en-us_topic_0000001361199224.html b/docs/ims/api-ref/en-us_topic_0000001361199224.html deleted file mode 100644 index 90431fff4..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001361199224.html +++ /dev/null @@ -1,202 +0,0 @@ - - -

Asynchronous Job Query

-

Function

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

-
-

URI

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

-
Table 1 lists the parameters in the URI. -
- - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Description

-

project_id

-

Yes

-

Specifies the project ID.

-

job_id

-

Yes

-

Specifies the asynchronous job ID.

-
-
-
-
-

Request

  • Request parameters

    None

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

Response

  • Response parameters -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

    Parameter

    -

    Type

    -

    Description

    -

    status

    -

    String

    -

    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

    -

    String

    -

    Specifies the task ID.

    -

    job_type

    -

    String

    -

    Specifies the job type.

    -

    begin_time

    -

    String

    -

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

    -

    end_time

    -

    String

    -

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

    -

    error_code

    -

    String

    -

    Specifies the error code.

    -

    fail_reason

    -

    String

    -

    Specifies the cause of the failure.

    -

    entities

    -

    Object

    -

    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

    -

    Type

    -

    Description

    -

    image_id

    -

    String

    -

    Specifies the image ID.

    -
    -
    -
-
  • Example response
    STATUS CODE 200
    -
     1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
-11
-12
    {
-    "status": "SUCCESS",
-    "entities": {
-        "image_id": "e9e91bff-14b6-4a0b-8377-4ed0813e3360"
-    },
-    "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

    -

    Description

    -

    400 Bad Request

    -

    Request error.

    -

    401 Unauthorized

    -

    Authentication failed.

    -

    403 Forbidden

    -

    You do not have the rights to perform the operation.

    -

    500 Internal Server Error

    -

    Internal service error.

    -

    503 Service Unavailable

    -

    The service is unavailable.

    -
    -
    -
-
-
-
-
-
Parent topic: IMS APIs
-
-
- diff --git a/docs/ims/api-ref/en-us_topic_0000001361199228.html b/docs/ims/api-ref/en-us_topic_0000001361199228.html deleted file mode 100644 index 457b4b295..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001361199228.html +++ /dev/null @@ -1,956 +0,0 @@ - - -

Querying Images (Native OpenStack API)

-

Function

This API is used to obtain the image list.

-

This API does not return the complete result at once, but uses pagination.

-
-

Pagination

Pagination refers to the function of returning a subset of a group of images, a link to obtain the next set of images, and a link of the set of images. By default, a set contains 25 images. You can also use the limit and marker parameters to paginate through images manually and specify the number of images that can be returned.

-

The parameter first in the response indicates the URL of the first page of images, and parameter next indicates the URL of the next page of images. When the last page of images is queried, there is no parameter next.

-
-

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.
-
-
Table 1 lists the parameters. -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

__isregistered

-

No

-

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.

-

__imagetype

-

No

-

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.
-

protected

-

No

-

Boolean

-

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

-

visibility

-

No

-

String

-

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

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

owner

-

No

-

String

-

Specifies the tenant to which the image belongs.

-

id

-

No

-

String

-

Specifies the image ID.

-

status

-

No

-

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.
-

name

-

No

-

String

-

Specifies the image name. Exact matching is used. For detailed description, see Image Attributes.

-

container_format

-

No

-

String

-

Specifies the container type. The default value is bare.

-

disk_format

-

No

-

String

-

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

-

min_ram

-

No

-

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.

-

min_disk

-

No

-

Integer

-

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

-

__os_bit

-

No

-

String

-

Specifies the OS architecture, 32 bit or 64 bit.

-

__platform

-

No

-

String

-

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

-

marker

-

No

-

String

-

Specifies the start number from which images are queried. The value is the image ID.

-

limit

-

No

-

Integer

-

Specifies the number of images to be queried. The value is an integer. By default, 25 images can be queried.

-

sort_key

-

No

-

String

-

Specifies the field for sorting the query results. The value can be an attribute of the image: name, container_format, disk_format, status, id, size, or create_at. The default value is create_at.

-

sort_dir

-

No

-

String

-

Specifies whether the query results are sorted in ascending or descending order. Its value can be desc (default) or asc. This parameter is used together with parameter sort_key. The default value is desc.

-

__os_type

-

No

-

String

-

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

-

tag

-

No

-

String

-

Specifies a tag added to an image. Tags can be used as a filter to query images.

-
NOTE:

The tagging function has been upgraded. If the tags added before the function upgrade are in the format of "Key.Value", query tags using "Key=Value". For example, an existing tag is a.b. After the tag function upgrade, query the tag using "tag=a=b".

-
-

member_status

-

No

-

String

-

Specifies the member status. The value can be accepted, rejected, or pending. accepted: indicates that the shared image is accepted. rejected indicates that the image shared by others is rejected. pending indicates that the image shared by others needs to be confirmed. To use this parameter, set visibility to shared during the query.

-

__support_kvm

-

No

-

String

-

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

-

__support_xen

-

No

-

String

-

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

-

__support_largememory

-

No

-

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.

-

__support_diskintensive

-

No

-

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.

-

__support_highperformance

-

No

-

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.

-

__support_xen_gpu_type

-

No

-

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.

-

__support_kvm_gpu_type

-

No

-

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.

-

__support_xen_hana

-

No

-

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.

-

__support_kvm_infiniband

-

No

-

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.

-

created_at

-

No

-

String

-

Specifies the time when the image was created. 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.

-

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

-

updated_at

-

No

-

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.

-

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.

-

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.

-
-
-
-
-

Common Query Methods

  • Public images

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

    -
  • Private images

    GET /v2/images?owner={project_id}

    -
  • Available shared images

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

    -
  • Rejected images

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

    -
  • Unaccepted images

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

    -
-
-

Request

  • Request parameters

    None

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

Response

  • Response parameters -
    - - - - - - - - - - - - - - - - - - - - - -

    Parameter

    -

    Type

    -

    Description

    -

    first

    -

    String

    -

    Specifies the URL of the first page of images.

    -

    next

    -

    String

    -

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

    -

    schema

    -

    String

    -

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

    -

    images

    -

    Array of objects

    -

    Specifies the resource type.

    -

    For details, see Table 2.

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

    Parameter

    -

    Type

    -

    Description

    -

    __backup_id

    -

    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.

    -

    __data_origin

    -

    String

    -

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

    -

    __description

    -

    String

    -

    Specifies the image description.

    -

    __image_location

    -

    String

    -

    Specifies the location where the image is stored.

    -

    __image_size

    -

    String

    -

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

    -

    __image_source_type

    -

    String

    -

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

    -

    __is_config_init

    -

    String

    -

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

    -

    __isregistered

    -

    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.

    -

    __lazyloading

    -

    Boolean

    -

    Specifies whether the image supports lazy loading.

    -

    __originalimagename

    -

    String

    -

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

    -

    __imagetype

    -

    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.
    -

    protected

    -

    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.

    -

    virtual_env_type

    -

    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.
    -

    virtual_size

    -

    Integer

    -

    This parameter is unavailable currently.

    -

    visibility

    -

    String

    -

    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

    -

    String

    -

    Specifies the tenant to which the image belongs.

    -

    id

    -

    String

    -

    Specifies the image ID.

    -

    status

    -

    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.
    -

    name

    -

    String

    -

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

    -

    container_format

    -

    String

    -

    Specifies the container type.

    -

    disk_format

    -

    String

    -

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

    -

    min_ram

    -

    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.

    -

    max_ram

    -

    String

    -

    Specifies the maximum memory (MB) of the image.

    -

    min_disk

    -

    Integer

    -

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

    -

    __os_bit

    -

    String

    -

    Specifies the OS architecture, 32 bit or 64 bit.

    -

    __os_feature_list

    -

    String

    -

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

    -

    __platform

    -

    String

    -

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

    -

    schema

    -

    String

    -

    Specifies the image schema.

    -

    self

    -

    String

    -

    Specifies the image URL.

    -

    size

    -

    String

    -

    This parameter is unavailable currently.

    -

    __os_type

    -

    String

    -

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

    -

    __os_version

    -

    String

    -

    Specifies the OS version.

    -

    tags

    -

    Array of strings

    -

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

    -

    __support_kvm

    -

    String

    -

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

    -

    __support_xen

    -

    String

    -

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

    -

    __support_largememory

    -

    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.

    -

    __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. For details about the image OSs supported by disk-intensive ECSs, see Table 4.

    -

    __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. For details about the image OSs supported by high-performance computing ECSs, see Table 4.

    -

    __support_xen_gpu_type

    -

    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.

    -

    __support_kvm_gpu_type

    -

    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.

    -

    __support_xen_hana

    -

    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.

    -

    __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.

    -

    __root_origin

    -

    String

    -

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

    -

    __sequence_num

    -

    String

    -

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

    -

    Example value: 0

    -

    created_at

    -

    String

    -

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

    -

    updated_at

    -

    String

    -

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

    -

    active_at

    -

    String

    -

    Specifies the time when the image status became active.

    -

    checksum

    -

    String

    -

    This parameter is unavailable currently.

    -

    hw_firmware_type

    -

    String

    -

    Specifies the ECS boot mode. Available values include:

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

    file

    -

    String

    -

    Specifies the URL for uploading and downloading the image file.

    -

    __support_amd

    -

    String

    -

    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
-69
-70
-71
    {
-  "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",
-      "__support_kvm_fpga_type": "VU9P",
-      "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",
-      "__support_kvm_fpga_type": "VU9P_COMMON",
-      "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

    -

    Description

    -

    400 Bad Request

    -

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

    -

    401 Unauthorized

    -

    Authentication failed.

    -

    403 Forbidden

    -

    You do not have the rights to perform the operation.

    -

    404 Not Found

    -

    The requested resource was not found.

    -

    500 Internal Server Error

    -

    Internal service error.

    -

    503 Service Unavailable

    -

    The service is unavailable.

    -
    -
    -
-
-
-
-
-
Parent topic: Image (Native OpenStack APIs)
-
-
- diff --git a/docs/ims/api-ref/en-us_topic_0000001361199232.html b/docs/ims/api-ref/en-us_topic_0000001361199232.html deleted file mode 100644 index ce9ebae16..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001361199232.html +++ /dev/null @@ -1,14 +0,0 @@ - - -

Restrictions on Image Sharing

-

Description

You can use the image sharing function to share your private images with other users.

-
-

Constraints

  • Images can only be shared within a region.
  • Each image can be shared with a maximum of 128 tenants.
  • You can stop sharing images anytime without notifying the recipient.
  • You can delete shared image anytime without notifying the recipient.
  • Encrypted images cannot be shared.
  • Full-ECS images cannot be shared.
-
-
-
-
-
Parent topic: Common Parameters
-
-
- diff --git a/docs/ims/api-ref/en-us_topic_0000001361199244.html b/docs/ims/api-ref/en-us_topic_0000001361199244.html deleted file mode 100644 index 3882f6570..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001361199244.html +++ /dev/null @@ -1,235 +0,0 @@ - - -

Change History

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Released On

-

Description

-

2021-08-15

-

Modified the following content:

-
  • Added the methods of querying OBS bucket names and OBS bucket object names in the description of the image_url parameter in Creating an Image.
-

Deleted the following content:

-
  • Marketplace images
-

2020-08-12

-

Modified the following content:

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

2020-07-20

-

Modified the following content:

- -

2019-11-15

-

Modified the following content:

- -

2019-03-13

-

Modified the following content:

-

Added Native OpenStack APIs.

-

2019-02-13

-

Modified the following content:

- -

2019-01-30

-

Modified the following content:

- -

2018-09-30

-

Added the following content:

- -
Modified the following content: -
-

2018-08-30

-
Added the following content: -
-

2018-07-30

-
Modified the following content:
  • Adjusted the outline.
  • Adjusted the sequences of extension APIs and native APIs.
-
-

2018-06-30

-

Added the following content:

-
  • Added section "Asynchronous Job Progress Query."
-

2018-04-30

-

Modified the following content:

- -

2018-03-30

-

Added the following content:

- -

2018-01-30

-
Added the following content: -
-

2017-12-30

-

Added the following content:

-
  • Supported the upload of images in VHDX format.
-

2017-11-30

-
Added the following content: -
-

2017-10-30

-
Modified the following content:
  • Changed the maximum value of min_disk to 1024.
-
-

2017-09-30

-
Added the following content:
  • Supported the upload of images in RAW format.
-
-
Modified the following content: -
-

2017-08-30

-
Added the following content:
  • Supported image creation from a BMS.
-
-

2017-07-29

-
Added the following content: -
-

2017-06-30

-
Modified the following content: -
-

2017-05-30

-
Added the following content: -
-

2017-03-30

-

Added the following content:

-
  • Added response parameter __system_support_market in Querying Images. (This parameter specifies whether an image can be published in the Marketplace).
-
Modified the following content:
  • Updated the values of __os_version and image types.
-
-

2017-02-28

-
Added the following content: -
-
Modified the following content:
  • Updated the values of __os_version.
-
-

2017-02-08

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

2017-01-20

-
Added the following content:
  • Added support for image encryption and parameter cmk_id during image creation using an external image file in Creating an Image.
-
-
Modified the following content: -
-

2016-11-24

-
Added the following content:
  • Added the Anti-DDoS and KMS services in "Regions and Endpoints."
  • Supported the upload of image files in format of QCOW2, VMDK, VHD, and ZVHD.
  • Added the file_format parameter in Exporting an Image.
-
-
Modified the following content:
  • Modified the operation for generating the AK and SK.
  • Optimized descriptions about parameters min_disk, min_ram, status, created_at, and updated_at in multiple sections.
-
-

2016-10-29

-
Added the following content: -
-

2016-09-30

-
Modified the following content: -
-

2016-09-18

-
Added the following content:
  • Added "Registering an Image File as a Private Image".
  • Added "Exporting an Image".
  • Added "Sharing an Image".
-
-
Modified the following content:
  • Modified the function description and example request in "Uploading an Image".
-
-

2016-08-25

-
Added the following content:
  • Added the Cloud Container Engine (CCE), Relational Database Service (RDS), and Domain Name Service (DNS) services in "Regions and Endpoints."
-
-

2016-06-16

-
Added the following content: -
-

2016-04-14

-
Modified the following content:
  • Modified the URL parameter description in "Service Usage".
  • Modified the procedure for making API calls for token authentication.
  • Added the Identity and Access Management (IAM) service in Regions and Endpoints.
-
-

2016-03-09

-

This issue is the first official release.

-
-
-
- diff --git a/docs/ims/api-ref/en-us_topic_0000001361199252.html b/docs/ims/api-ref/en-us_topic_0000001361199252.html deleted file mode 100644 index d8e16716f..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001361199252.html +++ /dev/null @@ -1,359 +0,0 @@ - - -

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.

-
-

Image Attributes

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Name

-

Type

-

Description

-

file

-

String

-

Specifies the URL for uploading and downloading the image file.

-

owner

-

String

-

Specifies the tenant to which the image belongs.

-

id

-

String

-

Specifies the image ID.

-

size

-

Long

-

This parameter is unavailable currently.

-

self

-

String

-

Specifies the image URL.

-

schema

-

String

-

Specifies the image schema.

-

status

-

String

-

Specifies the image status. The value can be active, queued, saving, deleted, or killed. An image can be used only when it is in the active state.

-

tags

-

Array of strings

-

Lists the image tags.

-

visibility

-

String

-

Specifies whether the image can be seen by other tenants. The value can be private, public, or shared.

-

name

-

String

-

Specifies the image name.

-
  • The name cannot start or end with space.
  • The name contains 1 to 128 characters.
  • The name contains the following four types of characters:
    • Uppercase letters
    • Lowercase letters
    • Numerals
    • Special characters include hyphens (-), periods (.), underscores (_), and space.
    -
-

checksum

-

String

-

This parameter is unavailable currently.

-

deleted

-

Boolean

-

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

-

protected

-

Boolean

-

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

-

container_format

-

String

-

Specifies the container type.

-

min_ram

-

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.

-

update_at

-

String

-

Specifies the time when the image was updated.

-

__os_bit

-

String

-

Specifies the OS architecture, 32 bit or 64 bit.

-

__os_version

-

String

-

Specifies the OS version.

-

__description

-

String

-

Provides supplementary information about the image.

-

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

-

disk_format

-

String

-

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

-

__isregistered

-

String

-

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

-

__platform

-

String

-

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

-

__os_type

-

String

-

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

-

min_disk

-

Integer

-

Specifies the minimum disk space (GB) required for running the image.

-

virtual_env_type

-

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.
-

__image_source_type

-

String

-

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

-

__imagetype

-

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.
-

__whole_image

-

Boolean

-

Specifies whether the image is a full-ECS image. The value can be true or false.

-

create_at

-

String

-

Specifies the time when the image was created.

-

virtual_size

-

Integer

-

This parameter is unavailable currently.

-

deleted_at

-

String

-

Specifies the time when the image was deleted.

-

__originalimagename

-

String

-

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

-

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.

-

__image_location

-

String

-

Specifies the location where the image is stored.

-

__image_size

-

String

-

Specifies the size (bytes) of the image file.

-

__data_origin

-

String

-

Specifies the image source.

-

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

-

hw_frimware_type

-

String

-

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

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

__support_xen

-

String

-

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

-

__support_largememory

-

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.

-

__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.

-

__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.

-

__support_xen_gpu_type

-

String

-

Specifies whether the image supports GPU-accelerated ECSs on the Xen platform. For the supported OSs, see Table 2. 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

-

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.

-

__support_xen_hana

-

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.

-

__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.

-

__is_config_init

-

String

-

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

-

If initial configuration is complete, the value is set to true. Otherwise, the value is set to false. The default value is false.

-
-
-
-
-
-
-
Parent topic: Common Parameters
-
-
- diff --git a/docs/ims/api-ref/en-us_topic_0000001361199260.html b/docs/ims/api-ref/en-us_topic_0000001361199260.html deleted file mode 100644 index 950eec58e..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001361199260.html +++ /dev/null @@ -1,98 +0,0 @@ - - -

Deleting an Image 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}

-
Table 1 lists the parameters in the URI. -
- - - - - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

image_id

-

Yes

-

String

-

Specifies the image ID.

-

member_id

-

Yes

-

String

-

Specifies the member ID.

-
-
-
-
-

Request

  • Request parameters

    None

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

Response

  • Response parameters

    None

    -
  • Example response
    204 No Content
    -
-
-

Returned Values

  • Normal

    204

    -
  • Abnormal -
    - - - - - - - - - - - - - - - - - - - - - - -

    Returned Value

    -

    Description

    -

    400 Bad Request

    -

    Request error.

    -

    401 Unauthorized

    -

    Authentication failed.

    -

    403 Forbidden

    -

    You do not have the rights to perform the operation.

    -

    404 Not Found

    -

    The requested resource was not found.

    -

    500 Internal Server Error

    -

    Internal service error.

    -

    503 Service Unavailable

    -

    The service is unavailable.

    -
    -
    -
-
-
-
-
-
Parent topic: Image Sharing (Native OpenStack APIs)
-
-
- diff --git a/docs/ims/api-ref/en-us_topic_0000001361199268.html b/docs/ims/api-ref/en-us_topic_0000001361199268.html deleted file mode 100644 index 468eaeb0d..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001361199268.html +++ /dev/null @@ -1,15 +0,0 @@ - - -

Image Replication

-
-
- - -
-
Parent topic: IMS APIs
-
-
- diff --git a/docs/ims/api-ref/en-us_topic_0000001411119517.html b/docs/ims/api-ref/en-us_topic_0000001411119517.html deleted file mode 100644 index abec06787..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001411119517.html +++ /dev/null @@ -1,436 +0,0 @@ - - -

Creating Image Metadata (Native OpenStack API)

-

Function

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.

-
-

URI

POST /v2/images

-
-

Request

  • Request parameters -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

    Parameter

    -

    Mandatory

    -

    Type

    -

    Description

    -

    __os_version

    -

    No

    -

    String

    -

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

    -

    If this parameter is not specified, the value Other Linux(64 bit) will be used. In that case, the ECS creation using this image may fail, and the ECS created using this image may fail to run properly.

    -

    visibility

    -

    No

    -

    String

    -

    Specifies whether the image is available to other tenants.

    -

    The default value is private. When creating image metadata, the value of visibility can be set to private only.

    -

    name

    -

    No

    -

    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 255 characters. For detailed description, see Image Attributes. This parameter is left blank by default.

    -

    protected

    -

    No

    -

    Boolean

    -

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

    -

    container_format

    -

    No

    -

    String

    -

    Specifies the container format.

    -

    The default value is bare.

    -

    disk_format

    -

    No

    -

    String

    -

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

    -

    tags

    -

    No

    -

    Array of strings

    -

    Lists the image tags. The tag contains 1 to 255 characters. The value is left blank by default.

    -

    min_ram

    -

    No

    -

    Integer

    -

    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

    -

    No

    -

    Integer

    -

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

    -

    The value of this parameter must be greater than the image system disk capacity. Otherwise, the ECS creation may fail.

    -
    -
    -

    Parameters in the request body are strings of no more than 255 characters, and their values can be left blank. Example:

    -
    "key": "value"
    -
    -
  • Example request
    POST https://{Endpoint}/v2/images
    -
    {
-    "__os_version": "Ubuntu 14.04 server 64bit",
-    "container_format": "bare",
-    "disk_format": "vhd",
-    "min_disk": 1,
-    "min_ram": 1024,
-    "name": "test",
-    "tags": [
-        "test",
-        "image"
-    ],
-    "visibility": "private",
-    "protected": false
-}
    -
-
-

Response

  • Response parameters -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

    Parameter

    -

    Type

    -

    Description

    -

    visibility

    -

    String

    -

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

    -

    name

    -

    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.

    -

    protected

    -

    Boolean

    -

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

    -

    container_format

    -

    String

    -

    Specifies the container format.

    -

    The value is bare.

    -

    disk_format

    -

    String

    -

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

    -

    tags

    -

    Array of strings

    -

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

    -

    min_ram

    -

    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.

    -

    min_disk

    -

    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.

    -

    status

    -

    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.
    -

    created_at

    -

    String

    -

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

    -

    updated_at

    -

    String

    -

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

    -

    self

    -

    String

    -

    Specifies the image URL.

    -

    id

    -

    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.

    -

    file

    -

    String

    -

    Specifies the URL for uploading and downloading the image file.

    -

    schema

    -

    String

    -

    Specifies the URL for accessing the schema.

    -

    __image_source_type

    -

    String

    -

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

    -

    __image_size

    -

    String

    -

    Specifies the image size. The unit is byte.

    -

    __isregistered

    -

    String

    -

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

    -

    __os_version

    -

    String

    -

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

    -

    __os_type

    -

    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.

    -

    __platform

    -

    String

    -

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

    -

    __os_bit

    -

    String

    -

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

    -

    __imagetype

    -

    String

    -

    Specifies the image type. private indicates a private image.

    -

    virtual_env_type

    -

    String

    -

    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.
    -

    owner

    -

    String

    -

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

    -

    __root_origin

    -

    String

    -

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

    -

    checksum

    -

    String

    -

    Specifies the MD5 value of the image file.

    -

    size

    -

    Long

    -

    This parameter is unavailable currently.

    -

    virtual_size

    -

    Integer

    -

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

    -

    properties

    -

    Properties object

    -

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

    -
    -
    -
  • Example response
    STATUS CODE 201
    -
    {
-    "schema": "/v2/schemas/image",
-    "min_disk": 1,
-    "created_at": "2016-06-02T07:49:48Z",
-    "__image_source_type": "uds",
-    "container_format": "bare",
-    "__image_size": "0",
-    "file": "/v2/images/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba86/file",
-    "updated_at": "2016-06-02T07:49:49Z",
-    "protected": false,
-    "id": "4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba86",
-    "__isregistered": "true",
-    "min_ram": 1024,
-    "owner": "b912fb4a4c464b568ecfca1071b21b10",
-    "__os_type": "Linux",
-    "__imagetype": "private",
-    "visibility": "private",
-    "virtual_env_type": "FusionCompute",
-    "tags": [
-        "test",
-        "image"
-    ],
-    "__platform": "Ubuntu",
-    "__os_bit": "64",
-    "__os_version": "Ubuntu 14.04 server 64bit",
-    "name": "test",
-    "self": "/v2/images/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba86",
-    "disk_format": "vhd",
-    "status": "queued"
-}
    -
-
-

Returned Values

  • Normal

    201

    -
  • Abnormal -
    - - - - - - - - - - - - - - - - - - - - - - -

    Returned Value

    -

    Description

    -

    400 Bad Request

    -

    Request error.

    -

    401 Unauthorized

    -

    Authentication failed.

    -

    403 Forbidden

    -

    You do not have the rights to perform the operation.

    -

    404 Not Found

    -

    The requested resource was not found.

    -

    500 Internal Server Error

    -

    Internal service error.

    -

    503 Service Unavailable

    -

    The service is unavailable.

    -
    -
    -
-
-
-
-
-
Parent topic: Image (Native OpenStack APIs)
-
-
- diff --git a/docs/ims/api-ref/en-us_topic_0000001411119529.html b/docs/ims/api-ref/en-us_topic_0000001411119529.html deleted file mode 100644 index 2825a187d..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001411119529.html +++ /dev/null @@ -1,143 +0,0 @@ - - -

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.

    -
-

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

-
-
-

URI

PUT /v1/cloudimages/{image_id}/upload

-
Table 1 lists the parameters in the URI. -
- - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

image_id

-

Yes

-

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).
-
-
-
-
-

Request

  • Request parameters -
    - - - - - - - - - - - -

    Parameter

    -

    Mandatory

    -

    Type

    -

    Description

    -

    image_url

    -

    Yes

    -

    String

    -

    Specifies the URL of the image file in the format of Bucket name:File name.

    -

    Image files in the bucket can be in ZVHD, QCOW2, VHD, RAW, VHDX, QED, VDI, QCOW, ZVHD2, or VMDK format.

    -
    NOTE:

    The storage class of the OBS bucket must be Standard.

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

Response

  • Response parameters -
    - - - - - - - - - -

    Parameter

    -

    Type

    -

    Description

    -

    job_id

    -

    String

    -

    Specifies the asynchronous task ID.

    -

    For details, see Asynchronous Job Query.

    -
    -
    -
  • Example response
    HTTP/1.1 200
    -
    1
-2
-3
    {
-   "job_id":" b912fb4a4c464b568ecfca1071b21b10"
-}
-
    -
    -
-
-

Returned Value

  • Normal

    200

    -
  • Abnormal
- -
- - - - - - - - - - - - - - - - -

Returned Value

-

Description

-

400 Bad Request

-

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

-

401 Unauthorized

-

Authentication failed.

-

403 Forbidden

-

You do not have the rights to perform the operation.

-

404 Not Found

-

The requested resource was not found.

-
-
-
-
-
-
-
Parent topic: Image
-
-
- diff --git a/docs/ims/api-ref/en-us_topic_0000001411119537.html b/docs/ims/api-ref/en-us_topic_0000001411119537.html deleted file mode 100644 index fae98534b..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001411119537.html +++ /dev/null @@ -1,8 +0,0 @@ - - -

API Usage Guidelines

-

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 Resource Identifiers (URIs). An application accesses a resource based on the resource's Unified Resource Locator (URL). A URL is usually in the following format: https://Endpoint/uri. In the URL, uri indicates the resource path, that is, the API access path.

-

Public cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted using JSON messages, with the media type represented by Application/json.

-

For details about how to use APIs, see API Usage Guidelines.

-
- diff --git a/docs/ims/api-ref/en-us_topic_0000001411119541.html b/docs/ims/api-ref/en-us_topic_0000001411119541.html deleted file mode 100644 index 2c31cc6eb..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001411119541.html +++ /dev/null @@ -1,19 +0,0 @@ - - -

Native OpenStack APIs

-
-
- -
- diff --git a/docs/ims/api-ref/en-us_topic_0000001411119549.html b/docs/ims/api-ref/en-us_topic_0000001411119549.html deleted file mode 100644 index 3f519047c..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001411119549.html +++ /dev/null @@ -1,165 +0,0 @@ - - -

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.

-
-

URI

POST /v2/images/{image_id}/members

-
-

Request

  • Request parameters -
    - - - - - - - - - - - -

    Parameter

    -

    Mandatory

    -

    Type

    -

    Description

    -

    member

    -

    Yes

    -

    String

    -

    Specifies the image member.

    -

    The value is the project ID of a tenant.

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

Response

  • Response parameters -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

    Parameter

    -

    Type

    -

    Description

    -

    status

    -

    String

    -

    Specifies the image sharing status.

    -

    created_at

    -

    String

    -

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

    -

    updated_at

    -

    String

    -

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

    -

    image_id

    -

    String

    -

    Specifies the image ID.

    -

    member_id

    -

    String

    -

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

    -

    schema

    -

    String

    -

    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"
-}
-
    -
    -
-
-

Returned Values

  • Normal

    200

    -
  • Abnormal -
    - - - - - - - - - - - - - - - - - - - - - - -

    Returned Value

    -

    Description

    -

    400 Bad Request

    -

    Request error.

    -

    401 Unauthorized

    -

    Authentication failed.

    -

    403 Forbidden

    -

    You do not have the rights to perform the operation.

    -

    404 Not Found

    -

    The requested resource was not found.

    -

    500 Internal Server Error

    -

    Internal service error.

    -

    503 Service Unavailable

    -

    The service is unavailable.

    -
    -
    -
-
-
-
-
-
Parent topic: Image Sharing (Native OpenStack APIs)
-
-
- diff --git a/docs/ims/api-ref/en-us_topic_0000001411119557.html b/docs/ims/api-ref/en-us_topic_0000001411119557.html deleted file mode 100644 index eff0a33b9..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001411119557.html +++ /dev/null @@ -1,563 +0,0 @@ - - -

Querying Images by Tag

-

Function

This API is used to filter or count images using tags or other conditions.

-
-

Constraints

To be compatible with remaining tags, the system will not verify the character set of the tag keys and values in the query condition when parameters tags not_tags, tags_any, and not_tags_any are used.

-
-

URI

POST /v2/{project_id}/images/resource_instances/action

-
Table 1 lists the parameters in the URI. -
- - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-
-
-
-
-

Request

  • Request parameters -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

    Parameter

    -

    Mandatory

    -

    Type

    -

    Description

    -

    action

    -

    Yes

    -

    String

    -

    Identifies the operation. This parameter is case sensitive and its value can be filter or count.

    -
    • The value filter indicates pagination query.
    • The value count indicates that the total number of query results meeting the search criteria will be returned.
    -

    tags

    -

    No

    -

    Array of objects

    -

    Includes all specified tags. A maximum of 10 tag keys are allowed for each query operation. Each tag key can contain a maximum of 10 tag values. Both tag keys and values must be unique. The tag keys cannot be left blank.

    -

    For details, see Table 2.

    -

    tags_any

    -

    No

    -

    Array of objects

    -

    Includes any of specified tags. A maximum of 10 tag keys are allowed for each query operation. Each tag key can contain a maximum of 10 tag values. Both tag keys and values must be unique. The tag keys cannot be left blank and set to an empty string.

    -

    not_tags

    -

    No

    -

    Array of objects

    -

    Excludes all specified tags. A maximum of 10 tag keys are allowed for each query operation. Each tag key can contain a maximum of 10 tag values. Both tag keys and values must be unique. The tag keys cannot be left blank.

    -

    not_tags_any

    -

    No

    -

    Array of objects

    -

    Excludes any of specified tags. A maximum of 10 tag keys are allowed for each query operation. Each tag key can contain a maximum of 10 tag values. Both tag keys and values must be unique. The tag keys cannot be left blank.

    -

    without_any_tag

    -

    No

    -

    Boolean

    -

    If this parameter is set to true, all resources without tags are queried. In this case, the tag, not_tags, tags_any, and not_tags_any fields are ignored.

    -

    limit

    -

    No

    -

    String

    -

    Specifies the maximum number of query records. This parameter is invalid when action is set to count. If action is set to filter, the parameter limit takes effect and its default value is 10. The value of limit ranges from 1 to 1000.

    -

    offset

    -

    No

    -

    String

    -

    Specifies the index position. The query starts from the next image indexed by this parameter. This parameter is not required when data on the first page is queried, and it is invalid when action is set to count. If action is set to filter, the default value of offset is 0. The value of offset cannot be a negative number.

    -

    matches

    -

    No

    -

    Array of objects

    -

    Specifies the search criteria. The tag key is the field to match, for example, resource_name or resource_id. value indicates the matched value. Keys in this list must be unique. The parameter cannot be left blank and may not be transferred.

    -

    For details, see Table 3.

    -
    -
    - -
    - - - - - - - - - - - - - - - - -
    Table 2 Data structure description of the tags field

    Parameter

    -

    Mandatory

    -

    Type

    -

    Description

    -

    key

    -

    Yes

    -

    String

    -

    Specifies the tag key. The tag key contains a maximum of 127 Unicode characters and cannot be left blank.

    -

    values

    -

    Yes

    -

    Array of strings

    -

    Lists the tag values. Each value can contain a maximum of 255 Unicode characters. If this parameter is left blank, any value is matched. When multiple values are specified and the key requirements are met, images that have any of the specified values are queried.

    -
    -
    - -
    - - - - - - - - - - - - - - - - -
    Table 3 Data structure description of the matches field

    Parameter

    -

    Mandatory

    -

    Type

    -

    Description

    -

    key

    -

    Yes

    -

    String

    -

    Specifies the tag key, that is to say, the field name for the query operation. Valid values include resource_name and resource_id.

    -

    If the field name is resource_name and the value is an empty string, exact query is performed. Otherwise, fuzzy query is performed based on the image name. If the field name is resource_id, exact query is performed based on the image ID.

    -

    value

    -

    Yes

    -

    String

    -

    Specifies the tag value. It cannot be left blank. Each value can contain a maximum of 255 Unicode characters.

    -
    -
    -
  • 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"]
-   }]
-}
-
      -
      -
    -
-
-

Response

  • Response parameters -
    - - - - - - - - - - - - - -

    Parameter

    -

    Type

    -

    Description

    -

    resources

    -

    Array of objects

    -

    Lists the images.

    -

    total_count

    -

    Integer

    -

    Specifies the total number of query records.

    -
    -
    - -
    - - - - - - - - - - - - - - - - - - - - - -
    Table 4 Data structure description of the resource field

    Parameter

    -

    Type

    -

    Description

    -

    resource_id

    -

    String

    -

    Specifies the image ID.

    -

    resource_detail

    -

    object

    -

    Provides image details.

    -

    tags

    -

    Array of objects

    -

    Lists the image tags.

    -

    resource_name

    -

    String

    -

    Specifies the image name.

    -
    -
    - -
    - - - - - - - - - - - - - -
    Table 5 Data structure description of the resource_tag field

    Parameter

    -

    Type

    -

    Description

    -

    key

    -

    String

    -

    Specifies the key of the tag.

    -

    value

    -

    String

    -

    Specifies the value of the tag.

    -
    -
    -
-
  • Example response
    • Example response when action is set to count
      STATUS CODE 200
      -
      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"
-   }]
-}
-
      -
      -
    -
-
-

Returned Value

  • Normal

    200

    -
  • Abnormal -
    - - - - - - - - - - - - - - - - - - - - - - -

    Returned Value

    -

    Description

    -

    400 Bad Request

    -

    Request error.

    -

    401 Unauthorized

    -

    Authentication failed.

    -

    403 Forbidden

    -

    You do not have the rights to perform the operation.

    -

    404 Not Found

    -

    The requested resource was not found.

    -

    500 Internal Server Error

    -

    Internal service error.

    -

    503 Service Unavailable

    -

    The service is unavailable.

    -
    -
    -
-
-
-
-
-
Parent topic: Image Tagging
-
-
- diff --git a/docs/ims/api-ref/en-us_topic_0000001411119565.html b/docs/ims/api-ref/en-us_topic_0000001411119565.html deleted file mode 100644 index 134a509db..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001411119565.html +++ /dev/null @@ -1,162 +0,0 @@ - - -

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.

-
-

URI

GET /v2/schemas/member

-
-

Request

  • Request parameters

    None

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

Response

  • Response parameters -
    - - - - - - - - - - - - - -

    Parameter

    -

    Type

    -

    Description

    -

    name

    -

    String

    -

    Specifies the schema name.

    -

    properties

    -

    Object

    -

    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"
-        }
-    }
-}
-
    -
    -
-
-

Returned Value

  • Normal

    200

    -
  • Abnormal -
    - - - - - - - - - - - - - - - - - - - - - - -

    Returned Value

    -

    Description

    -

    400 Bad Request

    -

    Request error.

    -

    401 Unauthorized

    -

    Authentication failed.

    -

    403 Forbidden

    -

    You do not have the rights to perform the operation.

    -

    404 Not Found

    -

    The requested resource was not found.

    -

    500 Internal Server Error

    -

    Internal service error.

    -

    503 Service Unavailable

    -

    The service is unavailable.

    -
    -
    -
-
-
-
-
-
Parent topic: Image Schema (Native OpenStack APIs)
-
-
- diff --git a/docs/ims/api-ref/en-us_topic_0000001411119573.html b/docs/ims/api-ref/en-us_topic_0000001411119573.html deleted file mode 100644 index 64b374d40..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001411119573.html +++ /dev/null @@ -1,574 +0,0 @@ - - -

Querying an Image List Schema (Native OpenStack API)

-

Function

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.

-
-

URI

GET /v2/schemas/images

-
-

Request

  • Request parameters

    None

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

Response

  • Response parameters -
    - - - - - - - - - - - - - - - - - -

    Parameter

    -

    Type

    -

    Description

    -

    name

    -

    String

    -

    Specifies the schema name.

    -

    links

    -

    Array of objects

    -

    Specifies the URL for accessing the schema.

    -

    For details, see Table 1.

    -

    properties

    -

    Object

    -

    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

    -

    Type

    -

    Description

    -

    href

    -

    String

    -

    Specifies the domain name.

    -

    rel

    -

    String

    -

    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"
-        }
-    }
-}
-
    -
    -
-
-

Returned Values

  • Normal

    200

    -
  • Abnormal -
    - - - - - - - - - - - - - - - - - - - - - - -

    Returned Value

    -

    Description

    -

    400 Bad Request

    -

    Request error.

    -

    401 Unauthorized

    -

    Authentication failed.

    -

    403 Forbidden

    -

    You do not have the rights to perform the operation.

    -

    404 Not Found

    -

    The requested resource was not found.

    -

    500 Internal Server Error

    -

    Internal service error.

    -

    503 Service Unavailable

    -

    The service is unavailable.

    -
    -
    -
-
-
-
-
-
Parent topic: Image Schema (Native OpenStack APIs)
-
-
- diff --git a/docs/ims/api-ref/en-us_topic_0000001411119577.html b/docs/ims/api-ref/en-us_topic_0000001411119577.html deleted file mode 100644 index c320449a1..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001411119577.html +++ /dev/null @@ -1,144 +0,0 @@ - - -

Adding Image Members in Batches

-

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.

-
-

URI

POST /v1/cloudimages/members

-
-

Request

  • Request parameters -
    - - - - - - - - - - - - - - - - -

    Parameter

    -

    Mandatory

    -

    Type

    -

    Description

    -

    images

    -

    Yes

    -

    Array of strings

    -

    Specifies the image IDs.

    -

    projects

    -

    Yes

    -

    Array of strings

    -

    Specifies the project IDs.

    -
    -
    -
  • 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"
-    ]
-}
-
    -
    -
-
-

Response

  • Response parameters -
    - - - - - - - - - -

    Parameter

    -

    Type

    -

    Description

    -

    job_id

    -

    String

    -

    Specifies the asynchronous task ID.

    -

    For details, see Asynchronous Job Query.

    -
    -
    -
  • Example response
    STATUS CODE 200
    -
    1
-2
-3
    {
-    "job_id": "edc89b490d7d4392898e19b2deb34797"
-}
-
    -
    -
-
-

Returned Value

  • Normal

    200

    -
  • Abnormal -
    - - - - - - - - - - - - - - - - - - - - - - -

    Returned Value

    -

    Description

    -

    400 Bad Request

    -

    Request error. For details, see Error Codes.

    -

    401 Unauthorized

    -

    Authentication failed.

    -

    403 Forbidden

    -

    You do not have the rights to perform the operation.

    -

    404 Not Found

    -

    The requested resource was not found.

    -

    500 Internal Server Error

    -

    Internal service error.

    -

    503 Service Unavailable

    -

    The service is unavailable.

    -
    -
    -
-
-
-
-
-
Parent topic: Image Sharing
-
-
- diff --git a/docs/ims/api-ref/en-us_topic_0000001411119581.html b/docs/ims/api-ref/en-us_topic_0000001411119581.html deleted file mode 100644 index 1efeba7bd..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001411119581.html +++ /dev/null @@ -1,178 +0,0 @@ - - -

Querying the Image Quota

-

Function

This extension API is used to query the quota of private images of a tenant in the current region.

-
-

URI

GET /v1/cloudimages/quota

-
-

Request

  • Request parameters

    None

    -
  • Example request
    GET https://{Endpoint}/v1/cloudimages/quota
    -
-
-

Response

  • Response parameters -
    - - - - - - - - - -

    Parameter

    -

    Type

    -

    Description

    -

    quotas

    -

    Object

    -

    Specifies the quota information.

    -

    For details, see Table 1.

    -
    -
    - -
    - - - - - - - - - -
    Table 1 Data structure description of the quotas field

    Parameter

    -

    Type

    -

    Description

    -

    resources

    -

    Array of objects

    -

    Specifies the resources to be queried.

    -

    For details, see Table 2.

    -
    -
    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 2 Data structure description of the quotas.resources field

    Parameter

    -

    Type

    -

    Description

    -

    type

    -

    String

    -

    Specifies the type of the resource to be queried.

    -

    used

    -

    Integer

    -

    Specifies the used quota.

    -

    quota

    -

    Integer

    -

    Specifies the total quota.

    -

    min

    -

    Integer

    -

    Specifies the minimum quota.

    -

    max

    -

    Integer

    -

    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
-      }
-    ]
-  }
-}
-
    -
    -
-
-

Returned Value

  • Normal

    200

    -
  • Abnormal -
    - - - - - - - - - - - - - - - - - - - - - - -

    Returned Value

    -

    Description

    -

    400 Bad Request

    -

    Request error. For details, see Error Codes.

    -

    401 Unauthorized

    -

    Authentication failed.

    -

    403 Forbidden

    -

    You do not have the rights to perform the operation.

    -

    404 Not Found

    -

    The requested resource was not found.

    -

    500 Internal Server Error

    -

    Internal service error.

    -

    503 Service Unavailable

    -

    The service is unavailable.

    -
    -
    -
-
-
-
-
-
Parent topic: Image Quota
-
-
- diff --git a/docs/ims/api-ref/en-us_topic_0000001411239209.html b/docs/ims/api-ref/en-us_topic_0000001411239209.html deleted file mode 100644 index c9d6e4272..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001411239209.html +++ /dev/null @@ -1,399 +0,0 @@ - - -

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.

-
-

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.
-
-

For how to convert image file formats and generate a bitmap file, see section "Quickly Importing an Image File" in the Image Management Service User Guide.

-
-
-

URI

POST /v2/cloudimages/quickimport/action

-
-

Request

  • Parameters in the request body when an image file is used to create a system disk image -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

    Parameter

    -

    Mandatory

    -

    Type

    -

    Description

    -

    name

    -

    Yes

    -

    String

    -

    Specifies the image name.

    -

    For detailed description, see Image Attributes.

    -

    description

    -

    No

    -

    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.

    -

    os_version

    -

    Yes

    -

    String

    -

    Specifies the OS version.

    -

    This parameter is valid if an external image file uploaded to the OBS bucket is used to create an image. For its value, see Values of Related Parameters.

    -

    image_url

    -

    Yes

    -

    String

    -

    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.

    -
    -

    min_disk

    -

    Yes

    -

    Integer

    -

    Specifies the minimum size (GB) of the system disk.

    -
    • 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 and must be greater than the size of the selected image file.
    -

    tags

    -

    No

    -

    Array of strings

    -

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

    -

    Set either tags or image_tags.

    -

    image_tags

    -

    No

    -

    Array of objects

    -

    Lists the image tags. The value is left blank by default.

    -

    Set either tags or image_tags.

    -

    type

    -

    No

    -

    String

    -

    Specifies the image type. The parameter value is ECS/BMS for system disk images. The default value is ECS.

    -

    architecture

    -

    No

    -

    String

    -

    Specifies the image architecture type. Available values include:

    -
    • x86
    • arm
    -

    The default value is x86.

    -
    NOTE:

    If the image architecture is ARM, the boot mode is automatically changed to UEFI.

    -
    -
    -
    -
  • Parameters description when an image file uploaded to the OBS bucket is used to create an image -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

    Parameter

    -

    Mandatory

    -

    Type

    -

    Description

    -

    name

    -

    Yes

    -

    String

    -

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

    -

    description

    -

    No

    -

    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.

    -

    os_type

    -

    Yes

    -

    String

    -

    Specifies the OS version.

    -

    This parameter is used when a data disk image is to be created. The value can be Linux or Windows.

    -

    image_url

    -

    Yes

    -

    String

    -

    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.

    -
    -

    min_disk

    -

    Yes

    -

    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.

    -

    tags

    -

    No

    -

    Array of strings

    -

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

    -

    Set either tags or image_tags.

    -

    image_tags

    -

    No

    -

    Array of objects

    -

    Lists the image tags. The value is left blank by default.

    -

    Set either tags or image_tags.

    -

    type

    -

    Yes

    -

    String

    -

    Specifies the image type. The parameter value is DataImage for data disk images.

    -
    -
    -
  • 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"}]
-}
-
      -
      -
    -
-
-

Response

  • Response parameters -
    - - - - - - - - - -

    Parameter

    -

    Type

    -

    Description

    -

    job_id

    -

    String

    -

    Specifies the asynchronous job ID.

    -

    For details, see Asynchronous Job Query.

    -
    -
    -
  • Example response
    STATUS CODE 200
    -
    1
-2
-3
    {
-     "job_id": "8a12fc664fb4daa3014fb4e581380005"
-}
-
    -
    -
-
-

Returned Values

  • Normal

    200

    -
  • Abnormal -
    - - - - - - - - - - - - - - - - - - - - - - -

    Return Value

    -

    Description

    -

    400 Bad Request

    -

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

    -

    401 Unauthorized

    -

    Authentication failed.

    -

    403 Forbidden

    -

    You do not have the rights to perform the operation.

    -

    404 Not Found

    -

    The requested resource was not found.

    -

    500 Internal Server Error

    -

    Internal service error.

    -

    503 Service Unavailable

    -

    The service is unavailable.

    -
    -
    -
-
-
-
-
-
Parent topic: Image
-
-
- diff --git a/docs/ims/api-ref/en-us_topic_0000001411239213.html b/docs/ims/api-ref/en-us_topic_0000001411239213.html deleted file mode 100644 index 62cef5871..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001411239213.html +++ /dev/null @@ -1,395 +0,0 @@ - - -

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.

-
-

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.

    - -
    - - - - - - - - - - - - - -
    Table 1 SAN policies in Windows

    Type

    -

    Description

    -

    OnlineAll

    -

    All newly detected disks are automatically brought online.

    -

    OfflineShared

    -

    All disks on sharable buses, such as iSCSI and FC, are left offline by default, while disks on non-sharable buses are kept online.

    -

    OfflineInternal

    -

    All newly detected disks are left offline.

    -
    -
    -
    1. Execute cmd.exe and run the following command to query the current SAN policy of the ECS:

      diskpart

      -
    2. Run the following command to view the SAN policy of the ECS:
      san
      • If the SAN policy is OnlineAll, run the exit command to exit DiskPart.
      -
      -
      • If the SAN policy is not OnlineAll, go to 3.
      -
    3. Run the following command to change the SAN policy of the ECS to OnlineAll:

      san policy=onlineall

      -
    -
-
-

Constraints (Creating a Full-ECS Image Using a CSBS Backup)

  • When creating a full-ECS image from a CSBS backup, ensure that the source ECS of the CSBS backup has been properly configured, or the image creation may fail.
  • A CSBS backup used to create a full-ECS image cannot have shared disks.
  • Only an available CSBS backup can be used to create a full-ECS image. A CSBS backup can be used to create only one full-ECS image.
  • A full-ECS image cannot be exported or replicated.
-
-

Constraints (Creating a Full-ECS Image Using a CBR Backup)

  • When creating a full-ECS image from a CBR backup, ensure that the source ECS of the CBR backup has been properly configured, or the image creation may fail.
  • A CBR backup can be used to create only one full-ECS image.
  • A full-ECS image created from a CBR backup can be shared with other tenants. However, if it is a shared CBR backup, the full-ECS image created from it cannot be shared.
  • A full-ECS image cannot be exported or replicated.
-
-

URI

POST /v1/cloudimages/wholeimages/action

-
-

Request

  • Parameters for creating a full-ECS image using an ECS -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

    Parameter

    -

    Mandatory

    -

    Type

    -

    Description

    -

    name

    -

    Yes

    -

    String

    -

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

    -

    description

    -

    No

    -

    String

    -

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

    -

    tags

    -

    No

    -

    Array of strings

    -

    Lists the image tags. The value is left blank by default.

    -

    Use either tags or image_tags.

    -

    image_tags

    -

    No

    -

    Array of objects

    -

    Lists the image tags. The value is left blank by default.

    -

    Use either tags or image_tags.

    -

    instance_id

    -

    Yes

    -

    String

    -

    Specifies the ECS ID. This parameter is required when an ECS is used to create a full-ECS image.

    -

    To obtain the ECS ID, perform the following operations:

    -
    1. Log in to management console.
    2. Under Computing, click Elastic Cloud Server.
    3. In the ECS list, click the name of the ECS and view its ID.
    -

    max_ram

    -

    No

    -

    Integer

    -

    Specifies the maximum memory of the image in the unit of MB. This parameter is not configured by default.

    -

    min_ram

    -

    No

    -

    Integer

    -

    Specifies the minimum memory of the image in the unit of MB. The default value is 0.

    -

    vault_id

    -

    No

    -

    String

    -

    Specifies the ID of the vault to which an ECS is to be added or has been added.

    -

    To create a full-ECS image from an ECS, create a backup from the ECS and then use the backup to create a full-ECS image. If a CBR backup is created, vault_id is mandatory. If a CSBS backup is created, vault_id is optional.

    -

    You can obtain the vault ID from the CBR console or section "Querying the Vault List" in Cloud Backup and Recovery API Reference.

    -
    -
    -
  • Parameters in the request body when a CSBS backup or CBR backup is used to create a full-ECS image -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

    Parameter

    -

    Mandatory

    -

    Type

    -

    Description

    -

    name

    -

    Yes

    -

    String

    -

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

    -

    description

    -

    No

    -

    String

    -

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

    -

    tags

    -

    No

    -

    Array of strings

    -

    Lists the image tags. The value is left blank by default.

    -

    Use either tags or image_tags.

    -

    image_tags

    -

    No

    -

    Array of objects

    -

    Lists the image tags. The value is left blank by default.

    -

    Use either tags or image_tags.

    -

    backup_id

    -

    Yes

    -

    String

    -

    Specifies the CSBS backup ID or CBR backup ID.

    -
    To obtain the CSBS backup ID, perform the following operations:
    1. Log in to the management console.
    2. Under Storage, click Cloud Server Backup Service.
    3. In the backup list, expand details of the backup to obtain its ID.
    -
    -
    To obtain the CBR backup ID, perform the following operations:
    1. Log in to the management console.
    2. Under Storage, click Cloud Backup and Recovery.
    3. On the displayed Cloud Server Backup page, click the Backups tab and obtain the backup ID from the backup list.
    -
    -

    max_ram

    -

    No

    -

    Integer

    -

    Specifies the maximum memory of the image in the unit of MB. This parameter is not configured by default.

    -

    min_ram

    -

    No

    -

    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.

    -

    whole_image_type

    -

    No

    -

    String

    -

    Specifies the method of creating a full-ECS image.

    -
    • If the value is CBR, a CBR backup is used to create a full-ECS image. In this case, backup_id is the CBR backup ID.
    • If the value is CSBS, a CSBS backup is used to create a full-ECS image. In this case, backup_id is the CSBS backup ID.
    • If you do not specify this parameter, value CSBS is used by default.
    -
    -
    -
  • 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 backup 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"}]
-}
-
      -
      -
    -
-
-

Response

  • Response parameters -
    - - - - - - - - - -

    Parameter

    -

    Type

    -

    Description

    -

    job_id

    -

    String

    -

    Specifies the asynchronous job ID.

    -

    For details, see Asynchronous Job Query.

    -
    -
    -
  • Example response
    STATUS CODE 200
    -
    1
-2
-3
    {
-    "job_id": "4010a32b5f909853015f90aaa24b0015"
-}
-
    -
    -
-
-

Returned Values

  • Normal

    200

    -
  • Abnormal -
    - - - - - - - - - - - - - - - - - - - - - - -

    Returned Value

    -

    Description

    -

    400 Bad Request

    -

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

    -

    401 Unauthorized

    -

    Authentication failed.

    -

    403 Forbidden

    -

    You do not have the rights to perform the operation.

    -

    404 Not Found

    -

    The requested resource was not found.

    -

    500 Internal Server Error

    -

    Internal service error.

    -

    503 Service Unavailable

    -

    The service is unavailable.

    -
    -
    -
-
-
-
-
-
Parent topic: Image
-
-
- diff --git a/docs/ims/api-ref/en-us_topic_0000001411239225.html b/docs/ims/api-ref/en-us_topic_0000001411239225.html deleted file mode 100644 index 3d9f8086d..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001411239225.html +++ /dev/null @@ -1,227 +0,0 @@ - - -

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.

-
-

URI

POST /v1/cloudimages/dataimages/action

-
-

Request

  • Request parameters -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

    Parameter

    -

    Mandatory

    -

    Type

    -

    Description

    -

    name

    -

    Yes

    -

    String

    -

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

    -

    description

    -

    No

    -

    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.

    -

    os_type

    -

    Yes

    -

    String

    -

    Specifies the OS type.

    -

    It can only be Windows or Linux.

    -

    image_url

    -

    Yes

    -

    String

    -

    Specifies the URL of the external image file in the OBS bucket.

    -

    The format is OBS bucket name:Image file name.

    -
    NOTE:

    The storage class of the OBS bucket must be Standard.

    -
    -

    min_disk

    -

    Yes

    -

    Integer

    -

    Specifies the minimum size of the data disk.

    -

    Value range: 40 GB to 2048 GB

    -

    cmk_id

    -

    No

    -

    String

    -

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

    -

    tags

    -

    No

    -

    Array of strings

    -

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

    -

    For detailed parameter description, see Image Tag Data Formats.

    -

    Use either tags or image_tags.

    -

    image_tags

    -

    No

    -

    Array of objects

    -

    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.

    -
    -
    -
  • 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"
-}
-
      -
      -
    -
-
-

Response

  • Response parameters -
    - - - - - - - - - -

    Parameter

    -

    Type

    -

    Description

    -

    job_id

    -

    String

    -

    Specifies the asynchronous job ID.

    -

    For details, see Asynchronous Job Query.

    -
    -
    -
  • Example response
    STATUS CODE 200
    -
    1
-2
-3
    {
-    "job_id": "4010a32b5f909853015f90aaa24b0015"
-}
-
    -
    -
-
-

Returned Value

  • Normal

    200

    -
  • Abnormal -
    - - - - - - - - - - - - - - - - - - - - - - -

    Returned Value

    -

    Description

    -

    400 Bad Request

    -

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

    -

    401 Unauthorized

    -

    Authentication failed.

    -

    403 Forbidden

    -

    You do not have the rights to perform the operation.

    -

    404 Not Found

    -

    The requested resource was not found.

    -

    500 Internal Server Error

    -

    Internal service error.

    -

    503 Service Unavailable

    -

    The service is unavailable.

    -
    -
    -
-
-
-
-
-
Parent topic: Image
-
-
- diff --git a/docs/ims/api-ref/en-us_topic_0000001411239233.html b/docs/ims/api-ref/en-us_topic_0000001411239233.html deleted file mode 100644 index ffd135326..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001411239233.html +++ /dev/null @@ -1,1757 +0,0 @@ - - -

Error Codes

-

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
-
1
-2
-3
-4
-5
-6
{
-    "error": {
-        "message": "The imagetype is invalid.",
-        "code": "IMG.0024"
-    }
-}
-
-
-
-

Error Message Description

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 1 Error codes

Status Code

-

Error Code

-

Message

-

Description

-

Handling Measure

-

400

-

IMG.0001

-

The request message format is invalid.

-

The request message format is invalid.

-

Use the correct format.

-

400

-

IMG.0002

-

The image name contains more than 128 characters.

-

The image name contains more than 128 characters.

-

Reduce the length of the image name.

-

400

-

IMG.0003

-

The image name format is invalid.

-

The image name format is invalid.

-

Check whether the image name is valid.

-

400

-

IMG.0004

-

The description contains more than 1024 characters.

-

The image name contains more than 1024 characters.

-

Reduce the length of the image description to within 1024 characters.

-

400

-

IMG.0005

-

The ECS does not exist.

-

The ECS does not exist.

-

Check whether the ECS exists.

-

400

-

IMG.0006

-

The ECS system disk cannot be used to create an image.

-

The system disk of the ECS cannot be used to create an image.

-

Check the system disk status of the ECS.

-

400

-

IMG.0007

-

The request body is empty.

-

The message body is empty.

-

Check whether the message body is valid.

-

400

-

IMG.0008

-

The ECS cannot be used to create images because it is not in stopped state.

-

The ECS cannot be used to create an image because it is not in the Stopped state.

-

Stop the ECS and try again.

-

400

-

IMG.0009

-

The image name already exists.

-

The image name already exists.

-

Change another image name.

-

400

-

IMG.0010

-

The ECS cannot be used to create an image because it has in-progress tasks.

-

The ECS cannot be used to create an image because it has in-progress tasks.

-

Try again after the tasks are complete.

-

400

-

IMG.0011

-

forceCreate must be set to true.

-

forceCreate must be set to true.

-

Set forceCreate to true.

-

400

-

IMG.0012

-

The ECS ID is not specified.

-

The ECS ID is invalid.

-

Enter a valid ECS ID.

-

400

-

IMG.0013

-

The image name is not specified.

-

The image name is not specified.

-

Enter a valid image name.

-

400

-

IMG.0014

-

An exception occurred when IaaS OpenStack was executing the task.

-

An exception occurred when IaaS OpenStack was executing the task.

-

Contact technical support.

-

400

-

IMG.0015

-

The number of private images has reached the maximum allowed.

-

The number of private images has reached the quota.

-

Increase the quota or delete existing images.

-

400

-

IMG.0016

-

An error occurred when the request body was deleted.

-

An error occurred when the request body was deleted.

-

Contact technical support.

-

400

-

IMG.0017

-

The URL format is incorrect.

-

The URL format is incorrect.

-

Check whether the URL format is valid.

-

400

-

IMG.0018

-

An error occurred when the job was submitted.

-

An error occurred when the job was submitted.

-

Contact technical support.

-

400

-

IMG.0019

-

The backup ID is not specified.

-

The backup ID is not specified.

-

Check whether the current backup ID is valid.

-

400

-

IMG.0020

-

The backup does not exist.

-

The backup does not exist.

-

Check whether the backup file exists.

-

400

-

IMG.0021

-

The resource type is unknown.

-

The source type is unknown.

-

Select a correct source type.

-

400

-

IMG.0022

-

The disk in the current state cannot be used to create images.

-

A disk in the current state cannot be used to create images.

-

Check the disk status.

-

400

-

IMG.0023

-

An exception occurred during task query.

-

An exception occurred during job query.

-

Contact technical support.

-

400

-

IMG.0024

-

The image type in the request is incorrect.

-

The image type in the request is incorrect.

-

Select either BMS or ECS.

-

400

-

IMG.0025

-

The user type in the request is incorrect.

-

The user type in the request is incorrect.

-

Check whether the user type is valid.

-

400

-

IMG.0026

-

The role is invalid. You need to apply for the required permissions or pass the real-name authentication.

-

You do not have the rights to perform the operation.

-

Contact technical support.

-

400

-

IMG.0027

-

The image ID in the request does not exist.

-

The image ID in the request does not exist.

-

Use a valid image ID.

-

400

-

IMG.0028

-

The image in the request is protected.

-

The image in the request is protected.

-

Contact technical support.

-

400

-

IMG.0029

-

The backup in the request has already been used to create an image.

-

The backup in the request has already been used to create an image.

-

Select another backup that has not been used.

-

400

-

IMG.0030

-

The project ID and token in the request are invalid.

-

The project ID and token in the request are invalid.

-

Enter a correct project ID and token.

-

400

-

IMG.0031

-

The resource ID in the request is incorrect.

-

The resource ID in the request is incorrect.

-

Use a valid image ID.

-

400

-

IMG.0032

-

The backup is unavailable.

-

The backup is unavailable.

-

Check whether the backup is available.

-

400

-

IMG.0033

-

The backup is not a system disk backup.

-

The backup is not a system disk backup.

-

Check whether the backup is a system disk backup.

-

400

-

IMG.0034

-

The number of images cannot be modified.

-

The number of images cannot be modified.

-

Contact technical support.

-

400

-

IMG.0035

-

An attribute conflict occurred during the modification.

-

An attribute conflict occurred during the modification.

-

Contact technical support.

-

400

-

IMG.0036

-

An error occurred when the value of asumeToken was obtained.

-

An error occurred when the value of asumeToken was obtained.

-

Contact technical support.

-

400

-

IMG.0037

-

An error occurred in the AK/SK was obtained.

-

An error occurred in the AK/SK was obtained.

-

Contact technical support.

-

400

-

IMG.0038

-

An error occurred when the bucket was created.

-

An error occurred when the bucket was created.

-

Contact technical support.

-

400

-

IMG.0039

-

An error occurred when read and write permissions of the bucket were granted to a specified user.

-

An error occurred when read and write permissions of the bucket were granted to a specified user.

-

Contact technical support.

-

400

-

IMG.0040

-

An error occurred in the object storage address was obtained.

-

An error occurred in the object storage address was obtained.

-

Contact technical support.

-

400

-

IMG.0041

-

The authorized account is empty.

-

The authorized account is empty.

-

Use a valid account.

-

400

-

IMG.0045

-

Failed to generate the image product code.

-

Failed to generate the image product code.

-

Contact technical support.

-

400

-

IMG.0046

-

The image is unavailable.

-

The image is unavailable.

-

Check the image status.

-

400

-

IMG.0047

-

This operation can be performed only by the image owner.

-

This operation can be performed only by the image owner.

-

Check whether you have the permission to operate the image.

-

400

-

IMG.0053

-

An error occurred when the domain information of the shadow account was obtained.

-

An error occurred when the domain information of the shadow account was obtained.

-

Contact technical support.

-

400

-

IMG.0054

-

The image description format is invalid.

-

The image description format is invalid.

-

Check the image description. It can contain no more than 1024 characters that consist of only letters and digits. Spaces and angle brackets (< >) are not allowed.

-

400

-

IMG.0055

-

The memory or disk size is invalid.

-

The memory or disk size is invalid.

-

Check the memory (MB) or disk size (GB) supported by the image.

-

400

-

IMG.0056

-

The OS type is invalid.

-

The OS type is invalid.

-

Select Windows or Linux.

-

400

-

IMG.0057

-

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

-

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

-

Select a valid image file.

-

400

-

IMG.0058

-

The region of the bucket where the image file is stored is inconsistent with that of the user.

-

The region of the bucket where the image file is stored is inconsistent with that of the user.

-

Ensure that the bucket where the image is stored is in region as the user.

-

400

-

IMG.0059

-

The size of the image file exceeds the maximum allowed.

-

The size of the image file exceeds the maximum allowed.

-

Check whether the size of the image file is less than or equal to 128 GB.

-

400

-

IMG.0060

-

The number of tasks exceeds the flow control limit.

-

The number of tasks exceeds the flow control limit.

-

Wait for a while and then try again.

-

400

-

IMG.0061

-

Unknown system error.

-

Unknown system error.

-

Contact technical support.

-

400

-

IMG.0062

-

The image name is incorrect.

-

The image name is incorrect.

-

Check whether the image name is valid.

-

400

-

IMG.0063

-

The VM type does not support image creation.

-

The ECS type does not support image creation.

-

Select an ECS that supports image creation.

-

400

-

IMG.0064

-

Failed to obtain tenant information from IAM.

-

Failed to obtain tenant information from IAM.

-

Contact technical support.

-

400

-

IMG.0065

-

Failed to obtain the tenant domain from IAM.

-

Failed to obtain the tenant domain from IAM.

-

Contact technical support.

-

400

-

IMG.0066

-

The image ID is incorrect.

-

The image ID is incorrect.

-

Enter a correct image ID.

-

400

-

IMG.0067

-

The project ID is incorrect.

-

The project ID is incorrect.

-

Enter a correct project ID.

-

400

-

IMG.0068

-

The specified bucket name is empty.

-

The specified bucket name is empty.

-

Check whether the specified bucket name is empty and enter a correct bucket name.

-

400

-

IMG.0069

-

The specified bucket cannot be accessed.

-

The specified bucket cannot be accessed.

-

Contact technical support.

-

400

-

IMG.0070

-

The image file already exists. Confirm the file in the corresponding directory of the OBS bucket or in the OBS bucket.

-

The image file already exists.

-

Check whether the file exists in the corresponding directory of the OBS bucket or in the OBS bucket.

-

400

-

IMG.0071

-

The image cannot be exported.

-

The image cannot be exported.

-

Select another image.

-

400

-

IMG.0072

-

The specified image format is not supported.

-

The specified image format is not supported.

-

Check the image format. Only VHD, RAW, ZVHD, and QCOW2 are supported. The default format is VHD.

-

400

-

IMG.0073

-

The name of the exported file is empty.

-

The name of the exported file is empty.

-

Enter a correct file name.

-

400

-

IMG.0074

-

The file name length exceeds the limit.

-

The file name length exceeds the limit.

-

Reduce the length of the file name.

-

400

-

IMG.0075

-

The file name contains invalid characters.

-

The file name contains invalid characters.

-

Ensure that the image file name meets the following requirements:

-
  • The name cannot start or end with space.
  • The name contains 1 to 128 characters.
  • The name contains the following four types of characters:
  • Uppercase letters
  • Lowercase letters
  • Digits
  • Special characters, including hyphens (-), periods (.), underscores (_), and space
-

400

-

IMG.0076

-

You cannot share an image with yourself.

-

You cannot share an image with yourself.

-

Do not share images with yourself.

-

400

-

IMG.0077

-

The public image cannot be exported.

-

The public image cannot be exported.

-

Select another image.

-

400

-

IMG.0079

-

The system disk image created from a charged image cannot be exported.

-

A system disk image created from a charged image cannot be exported.

-

Select another image.

-

400

-

IMG.0080

-

The image created from a CSBS backup cannot be exported.

-

The image created from a CSBS backup cannot be exported.

-

Export the image after the backup is created.

-

400

-

IMG.0081

-

The image cannot be exported because it is created from an image file.

-

The image cannot be exported because it is created from an image file.

-

Select another image.

-

400

-

IMG.0083

-

The image is a public image.

-

The image is a public image.

-

-

-

400

-

IMG.0084

-

The image is a private image.

-

The image is a private image.

-

-

-

400

-

IMG.0085

-

The publishing mode is incorrect.

-

The publishing mode is incorrect.

-

-

-

400

-

IMG.0086

-

No image was found.

-

No image was found.

-

Check whether the image exists.

-

400

-

IMG.0087

-

The token is incorrect.

-

The token is incorrect.

-

Enter a correct token.

-

400

-

IMG.0088

-

The number of shared images has reached the maximum allowed.

-

The number of shared images has reached the quota.

-

Increase the quota.

-

400

-

IMG.0089

-

The public image or Marketplace image cannot be shared.

-

A public image or marketplace image cannot be shared.

-

Check the constraints of image sharing.

-

400

-

IMG.0090

-

The image being created cannot be deleted.

-

An image being created cannot be deleted.

-

Delete the image after the image is created.

-

400

-

IMG.0092

-

The image can only be deleted by the owner.

-

The image can only be deleted by the owner.

-

Ask the image owner to delete the image.

-

400

-

IMG.0094

-

The public image cannot be deleted.

-

The public image cannot be deleted.

-

Do not delete public images.

-

400

-

IMG.0095

-

The KMS key does not exist.

-

The key does not exist.

-

Check whether the key exists.

-

400

-

IMG.0096

-

The specified KMS key ID must be different from the image key ID.

-

The specified KMS key ID must be different from the image key ID.

-

Check whether the specified KMS key ID is the same as the image key ID.

-

400

-

IMG.0097

-

The key is not enabled.

-

The key is not enabled.

-

Enable the key.

-

400

-

IMG.0098

-

The encrypted image cannot be shared or published in Marketplace.

-

The encrypted image cannot be shared or published in the Marketplace.

-

Copy the image to a non-encrypted image and then share or release the non-encrypted image.

-

400

-

IMG.0099

-

You do not have the permission to access the key.

-

You do not have the permission to access the key.

-

Check whether you have the permission to access the key.

-

400

-

IMG.0100

-

You do not have OBT permission for KMS.

-

You do not have OBT permission for KMS.

-

Check whether you have the OBT permission for KMS.

-

400

-

IMG.0101

-

The original key does not exist.

-

The original key does not exist.

-

Check whether the key is valid.

-

400

-

IMG.0102

-

The original key is not enabled.

-

The original key is not enabled.

-

Enable the original key.

-

400

-

IMG.0103

-

You do not have the permission to access the original key.

-

You do not have the permission to access the original key.

-

Check whether you have the permission to access the key.

-

400

-

IMG.0104

-

Enter the project name if there are multiple projects in the same region.

-

Enter the project name if there are multiple projects in the same region.

-

Enter the project name.

-

400

-

IMG.0105

-

The operation is not supported.

-

The operation is not supported.

-

Contact technical support.

-

400

-

IMG.0106

-

The image owner is another tenant.

-

The image owner is another tenant.

-

Confirm the image owner.

-

400

-

IMG.0108

-

The tenant ID was not found in the current region.

-

The tenant ID was not found in the current region.

-

Contact technical support.

-

400

-

IMG.0109

-

The bucket name contains invalid characters.

-

The bucket name contains invalid characters.

-

Check whether the bucket name is valid.

-

400

-

IMG.0110

-

The system disk is unavailable and cannot be used to create images.

-

The system disk is unavailable and cannot be used to create images.

-

Create an image when the system disk is available.

-

400

-

IMG.0111

-

The size of the system disk exceeds the maximum allowed.

-

The size of the system disk exceeds the maximum allowed.

-

Ensure that the ECS system disk size is greater than or equal to the system disk size of the image and smaller than 1024 GB.

-

400

-

IMG.0112

-

Failed to add the tenant.

-

Failed to add the tenant.

-

Contact technical support.

-

400

-

IMG.0113

-

Failed to delete the tenant.

-

Failed to delete the tenant.

-

Contact technical support.

-

400

-

IMG.0114

-

Failed to query the tenant details.

-

Failed to query the tenant details.

-

Contact technical support.

-

400

-

IMG.0115

-

The image tag is invalid.

-

The image tag is invalid.

-

Check the validity of the image tag.

-

400

-

IMG.0116

-

The number of image tags exceeds the quota.

-

The number of image tags exceeds the quota.

-

Delete tags that are unnecessary or not in use.

-

400

-

IMG.0117

-

The image source can only be BMS or ECS.

-

The image type can only be BMS or ECS.

-

Select a BMS or ECS as the image source.

-

400

-

IMG.0118

-

The BMS image does not support KMS encryption.

-

The BMS image does not support KMS encryption.

-

Modify the BMS image configuration.

-

400

-

IMG.0119

-

The VM does not have a system disk.

-

The ECS does not have a system disk.

-

Attach a system disk to the ECS.

-

400

-

IMG.0120

-

The specified data disk ID is unavailable.

-

The specified data disk ID is unavailable.

-

Check whether the current data disk ID is valid.

-

400

-

IMG.0121

-

The object cannot be found.

-

The object cannot be found.

-

Check whether the object exists.

-

400

-

IMG.0122

-

The OS type is invalid.

-

The OS type is invalid.

-

Select an OS supported by IMS.

-

400

-

IMG.0123

-

The image file address in the request is duplicate.

-

The image file address in the request is duplicate.

-

Delete the duplicate image file address.

-

400

-

IMG.0125

-

The data disk image cannot be converted to a public image.

-

The data disk image cannot be published as a public image.

-

Check the constraints on data disk images.

-

400

-

IMG.0126

-

The VM in the current stage cannot be used to create a full-ECS image.

-

The ECS in the current status cannot be used to create a full-ECS image.

-

Check the ECS status. Ensure that the ECS is in the Running or Stopped state.

-

400

-

IMG.0127

-

The CSBS backup does not exist.

-

The CSBS backup does not exist.

-

Check whether the CSBS backup exists.

-

400

-

IMG.0128

-

The full-ECS image cannot be exported.

-

A full-ECS image cannot be exported.

-

Check the constraints on image export.

-

400

-

IMG.0130

-

The full-ECS image cannot be exported or replicated.

-

A full-ECS image cannot be exported or replicated.

-

Check the constraints on full-ECS images.

-

400

-

IMG.0132

-

The CSBS backup in the current state cannot be used to create a full-ECS image.

-

A CSBS backup in the current state cannot be used to create a full-ECS image.

-

Wait until the CSBS backup becomes available.

-

400

-

IMG.0133

-

You are not allowed to access the CSBS backup.

-

You are not allowed to access the CSBS backup.

-

Apply for the permissions.

-

400

-

IMG.0134

-

The CSBS backup has been registered as an image.

-

The CSBS backup has been registered as an image.

-

A CSBS backup can be used to create only one full-ECS image. Select another CSBS backup.

-

400

-

IMG.0135

-

The full-ECS image cannot be shared.

-

A full-ECS image cannot be shared.

-

Check the constraints of image sharing.

-

400

-

IMG.0136

-

Failed to create a full-ECS image because the ECS is being backed up.

-

Failed to create a full-ECS image because a backup is being created for the ECS.

-

Wait until the CSBS backup becomes available.

-

400

-

IMG.0137

-

Failed to obtain the VM information.

-

Failed to obtain the ECS information.

-

Check whether the ECS ID is correct and whether you have the permission to perform operations on the ECS.

-

400

-

IMG.0138

-

Failed to obtain the OS type information.

-

Failed to obtain the OS type information.

-

Contact technical support.

-

400

-

IMG.0139

-

Other disks on the VM are being used to created VMs.

-

Other disks on the ECS are being used to create ECSs.

-

Contact technical support.

-

400

-

IMG.0140

-

The disks in the request come from different ECSs.

-

The disks in the request are from different ECSs.

-

Ensure that the ECS to which the disks are attached is the same.

-

400

-

IMG.0141

-

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.

-

400

-

IMG.0144

-

The image does not exist.

-

The image does not exist.

-

Check whether the image exists.

-

400

-

IMG.0145

-

The project name is incorrect.

-

The project name is incorrect.

-

Enter a correct project name.

-

400

-

IMG.0148

-

The image is being exported.

-

The image is being exported.

-

Wait until the image is exported.

-

400

-

IMG.0153

-

DESS or DSS disks cannot be used to create images.

-

DESS or DSS disks cannot be used to create images.

-

Select another ECS.

-

400

-

IMG.0154

-

Failed to communicate with Enterprise Project Management Service (EPS).

-

Failed to communicate with EPS.

-

Contact technical support.

-

400

-

IMG.0160

-

Only images less than 128 GB can be exported.

-

Only images smaller than 128 GB can be exported.

-

Images larger than 128 GB cannot be exported.

-

400

-

IMG.0165

-

You do not have permission to access the CSBS backup.

-

You do not have permission to access the CSBS backup.

-

Contact technical support.

-

400

-

IMG.0166

-

OS information must be contained in the ISO files used to create images.

-

OS version information must be contained when an ISO file is used to create an image.

-

OS version information must be contained when an ISO file is used to create an image.

-

400

-

IMG.0167

-

This operation cannot be performed for ISO images.

-

The ISO image does not support this function.

-

Contact technical support.

-

400

-

IMG.0168

-

Data disk images cannot be updated.

-

Data disk images cannot be updated.

-

Contact technical support.

-

400

-

IMG.0169

-

Failed to update the image because the OS versions are different.

-

Failed to update the image because the OS versions are different.

-

Contact technical support.

-

400

-

IMG.0170

-

Failed to update the image because the image formats are different.

-

Failed to update the image because the image formats are different.

-

Contact technical support.

-

400

-

IMG.0171

-

Failed to update the image because the minimum disk space is less than that of the source image.

-

Failed to update the image because the minimum disk space is less than that of the source image.

-

Contact technical support.

-

400

-

IMG.0172

-

Failed to update the image because the minimum memory is less than that of the source image.

-

Failed to update the image because the minimum memory is less than that of the source image.

-

Contact technical support.

-

400

-

IMG.0173

-

Failed to update the image because the image environment types are different.

-

Failed to update the image because the image environment types are different.

-

Contact technical support.

-

400

-

IMG.0174

-

Failed to update the image because the name of the source image is different from that of the target image.

-

Failed to update the image because the name of the source image is different from that of the target image.

-

Contact technical support.

-

400

-

IMG.0175

-

The folder name and image file name cannot contain spaces.

-

The folder name and image file name cannot contain spaces.

-

Check whether the file name is valid.

-

400

-

IMG.0176

-

Failed to delete the full-ECS backup.

-

Failed to delete the full-ECS backup.

-

Contact technical support.

-

400

-

IMG.0177

-

The source and target tenants reside in different regions.

-

The source and target tenants reside in different regions.

-

Check whether the source and target tenants reside in the same region.

-

400

-

IMG.0178

-

The target tenant is the same as the source tenant.

-

The target tenant is the same as the source tenant.

-

The target tenant cannot be the same as the source tenant. Please check.

-

400

-

IMG.0179

-

The token of the source image agency is invalid.

-

The token of the source image agency is invalid.

-

Contact technical support.

-

400

-

IMG.0181

-

Failed to obtain ECSs that can be protected.

-

Failed to obtain ECSs that can be protected.

-

Contact technical support.

-

400

-

IMG.0186

-

The ECS is associated with the CSBS service.

-

The ECS is associated with the CSBS service.

-

Contact technical support.

-

400

-

IMG.0187

-

KMS access traffic has reached the upper limit.

-

KMS access traffic has reached the upper limit.

-

Contact technical support.

-

400

-

IMG.0191

-

Failed to query ECS flavors.

-

Failed to query ECS flavors.

-

Contact technical support.

-

400

-

IMG.0192

-

The flavor used to query images is invalid.

-

The flavor used to query images is invalid.

-

Contact technical support.

-

400

-

IMG.0194

-

The maximum number of images that can be imported at one time has been reached.

-

The maximum number of images that can be imported at one time has been reached.

-

Contact technical support.

-

400

-

IMG.0195

-

Full-ECS images created from CBR backups must contain an OS.

-

Full-ECS images created from CBR backups must contain the OS version.

-

Specify the OS version.

-

400

-

IMG.0196

-

The image cannot be replicated because it is not accepted by the recipient.

-

The image cannot be replicated because it is not accepted by the recipient.

-

Accept the shared image.

-

400

-

IMG.0197

-

Failed to replicate the shared image because it is encrypted using KMS.

-

Failed to replicate the shared image because it is encrypted using KMS.

-

Shared encrypted images cannot be replicated.

-

400

-

IMG.0198

-

Backup ID does not match the backup type or does not exist.

-

Backup ID does not match the backup type or the backup does not exist.

-

Check whether the backup ID matches the backup type.

-
-
-
-
-
- diff --git a/docs/ims/api-ref/en-us_topic_0000001411239237.html b/docs/ims/api-ref/en-us_topic_0000001411239237.html deleted file mode 100644 index 34e63db2a..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001411239237.html +++ /dev/null @@ -1,350 +0,0 @@ - - -

Values of Related Parameters

-

__os_version Values

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 1 __os_version values

OS Type

-

OS Version (__os_version)

-

Windows

-

Windows 10 64bit

-

Windows 7 Enterprise 64bit

-

Windows Server 2016 Standard 64bit

-

Windows Server 2016 Datacenter 64bit

-

Windows Server 2012 R2 Standard 64bit

-

Windows Server 2012 Essentials R2 64bit

-

Windows Server 2012 R2 Datacenter 64bit

-

Windows Server 2012 Datacenter 64bit

-

Windows Server 2012 Standard 64bit

-

Windows Server 2008 R2 WEB 64bit

-

Windows Server 2008 R2 Standard 64bit

-

Windows Server 2008 R2 Enterprise 64bit

-

Windows Server 2008 R2 Datacenter 64bit

-

SUSE

-

SUSE Linux Enterprise Server 15 SP1 64bit

-

SUSE Linux Enterprise Server 15 64bit

-

SUSE Linux Enterprise Server 12 SP5 64bit

-

SUSE Linux Enterprise Server 12 SP3 64bit

-

SUSE Linux Enterprise Server 12 SP2 64bit

-

SUSE Linux Enterprise Server 12 SP1 64bit

-

SUSE Linux Enterprise Server 12 64bit

-

SUSE Linux Enterprise Server 11 SP4 64bit

-

SUSE Linux Enterprise Server 11 SP3 64bit

-

SUSE Linux Enterprise Server 11 SP3 32bit

-

SUSE Linux Enterprise Server 11 SP1 64bit

-

Oracle Linux

-

Oracle Linux Server release 7.6 64bit

-

Oracle Linux Server release 7.5 64bit

-

Oracle Linux Server release 7.4 64bit

-

Oracle Linux Server release 7.3 64bit

-

Oracle Linux Server release 7.2 64bit

-

Oracle Linux Server release 7.1 64bit

-

Oracle Linux Server release 7.0 64bit

-

Oracle Linux Server release 6.10 64bit

-

Oracle Linux Server release 6.9 64bit

-

Oracle Linux Server release 6.8 64bit

-

Oracle Linux Server release 6.7 64bit

-

Oracle Linux Server release 6.5 64bit

-

Red Hat

-

Redhat Linux Enterprise 8.0 64bit

-

Redhat Linux Enterprise 7.6 64bit

-

Redhat Linux Enterprise 7.5 64bit

-

Redhat Linux Enterprise 7.4 64bit

-

Redhat Linux Enterprise 7.3 64bit

-

Redhat Linux Enterprise 7.2 64bit

-

Redhat Linux Enterprise 7.1 64bit

-

Redhat Linux Enterprise 7.0 64bit

-

Redhat Linux Enterprise 6.10 64bit

-

Redhat Linux Enterprise 6.9 64bit

-

Redhat Linux Enterprise 6.8 64bit

-

Redhat Linux Enterprise 6.7 64bit

-

Redhat Linux Enterprise 6.6 64bit

-

Redhat Linux Enterprise 6.6 32bit

-

Redhat Linux Enterprise 6.5 64bit

-

Redhat Linux Enterprise 6.4 64bit

-

Redhat Linux Enterprise 6.4 32bit

-

Ubuntu

-

Ubuntu 19.04 server 64bit

-

Ubuntu 18.04 server 64bit

-

Ubuntu 16.04.3 Server 64bit

-

Ubuntu 16.04.2 Server 64bit

-

Ubuntu 16.04 server 64bit

-

Ubuntu 14.04.5 server 64bit

-

Ubuntu 14.04.4 server 64bit

-

Ubuntu 14.04.4 server 32bit

-

Ubuntu 14.04.3 server 64bit

-

Ubuntu 14.04.3 server 32bit

-

Ubuntu 14.04.1 server 64bit

-

Ubuntu 14.04.1 server 32bit

-

Ubuntu 14.04 server 64bit

-

Ubuntu 14.04 server 32bit

-

openSUSE

-

openSUSE 42.3 64bit

-

openSUSE 42.2 64bit

-

openSUSE 42.1 64bit

-

openSUSE 15.1 64bit

-

openSUSE 15.0 64bit

-

openSUSE 13.2 64bit

-

openSUSE 11.3 64bit

-

CentOS

-

CentOS 8.0 64bit

-

CentOS 7.7 64bit

-

CentOS 7.6 64bit

-

CentOS 7.5 64bit

-

CentOS 7.4 64bit

-

CentOS 7.3 64bit

-

CentOS 7.2 64bit

-

CentOS 7.1 64bit

-

CentOS 7.0 64bit

-

CentOS 7.0 32bit

-

CentOS 6.10 64bit

-

CentOS 6.10 32bit

-

CentOS 6.9 64bit

-

CentOS 6.9 32bit

-

CentOS 6.8 64bit

-

CentOS 6.7 64bit

-

CentOS 6.7 32bit

-

CentOS 6.6 64bit

-

CentOS 6.6 32bit

-

CentOS 6.5 64bit

-

CentOS 6.5 32bit

-

CentOS 6.4 64bit

-

CentOS 6.4 32bit

-

CentOS 6.3 64bit

-

CentOS 6.3 32bit

-

Debian

-

Debian GNU/Linux 10.0.0 64bit

-

Debian GNU/Linux 9.3.0 64bit

-

Debian GNU/Linux 9.0.0 64bit

-

Debian GNU/Linux 8.8.0 64bit

-

Debian GNU/Linux 8.7.0 64bit

-

Debian GNU/Linux 8.6.0 64bit

-

Debian GNU/Linux 8.5.0 64bit

-

Debian GNU/Linux 8.4.0 64bit

-

Debian GNU/Linux 8.2.0 64bit

-

Debian GNU/Linux 8.1.0 64bit

-

Fedora

-

Fedora 30 64bit

-

Fedora 29 64bit

-

Fedora 28 64bit

-

Fedora 27 64bit

-

Fedora 26 64bit

-

Fedora 25 64bit

-

Fedora 24 64bit

-

Fedora 23 64bit

-

Fedora 22 64bit

-

EulerOS

-

EulerOS 2.9 64bit

-

EulerOS 2.5 64bit

-

EulerOS 2.3 64bit

-

EulerOS 2.2 64bit

-

EulerOS 2.1 64bit

-

CoreOS

-

CoreOS 1068.10.0

-

CoreOS 1010.5.0

-

CoreOS 1298.6.0

-

openEuler

-

openEuler 20.03 64bit

-
-
-

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 this image unavailable and needs to be disabled.

-
-
-

__support_xen_gpu_type Values

-
- - - - - - - -
Table 2 Supported GPU types

Supported GPU (__support_xen_gpu_type)

-

Description

-

M60_vGPU

-

The image has a hardware virtualization drive with the M60 video card installed and supports g1.xlarge and g1.2xlarge ECSs.

-
-
-
-

__support_kvm_gpu_type Values

-
- - - - - - - - - - - - - - - - - - - - - - -
Table 3 Supported GPU types

Supported GPU (__support_kvm_gpu_type)

-

Description

-

P4

-

The image has a hardware virtualization driver with the P4 video card installed and supports pi1.2xlarge.4 and pi1.4xlarge.4 ECSs.

-

M60

-

The image has a hardware virtualization drive with the M60 video card installed and supports g1.xlarge, g1.2xlarge, and g3.4xlarge.4 ECSs.

-

V100_vGPU

-

The image has a hardware virtualization drive with the V100 video card installed and supports g5.8xlarge.4 ECSs.

-

P2V_V100

-

The image has a hardware virtualization drive with the V100 video card installed and supports p2v.2xlarge.8 ECSs.

-

P100

-

The image has a hardware virtualization drive with the P100 video card installed and supports p1.2xlarge.8 and p1.4xlarge.8 ECSs.

-

V100

-

The image has a hardware virtualization drive with the V100 video card installed and supports p2.2xlarge.8 and p2.4xlarge.8 ECSs.

-
-
-
-

Special Images and Supported OSs

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 Special image types and supported OSs

Image Type

-

Supported OS

-

Memory-optimized generation II (m2)

-

CentOS 7.2 64bit

-

CentOS 6.5 64bit

-

SUSE SLES 11 SP4 64bit

-

Redhat 7.2 64bit

-

Windows 2012DC edition

-

Large-memory

-

CentOS 6.6 64bit

-

CentOS 6.7 64bit

-

CentOS 6.8 64bit

-

CentOS 7.1 64bit

-

CentOS 7.2 64bit

-

CentOS 7.3 64bit

-

SUSE Enterprise Linux Server 11 SP3 64bit

-

SUSE Enterprise Linux Server 11 SP4 64bit

-

SUSE Enterprise Linux Server 12 SP1 64bit

-

SUSE Enterprise Linux Server 12 SP2 64bit

-

Redhat Linux Enterprise 6.8 64bit

-

Redhat Linux Enterprise 7.3 64bit

-

GPU-accelerated (G1)

-

Windows Server 2008

-

Windows Server 2012

-

Windows Server 2016

-

GPU-accelerated (G2)

-

Windows Server 2008

-

Windows Server 2012

-

Disk-intensive

-

CentOS 7.2 64bit

-

CentOS 7.3 64bit

-

CentOS 6.8 64bit

-

SUSE Enterprise Linux Server 11 SP3 64bit

-

SUSE Enterprise Linux Server 11 SP4 64bit

-

SUSE Enterprise Linux Server 12 SP1 64bit

-

SUSE Enterprise Linux Server 12 SP2 64bit

-

Redhat Linux Enterprise 6.8 64bit

-

Redhat Linux Enterprise 7.3 64bit

-

High-performance generation I (H1)

-

CentOS 6.8 64bit

-

CentOS 7.2 64bit

-

CentOS 7.3 64bit

-

Windows Server 2008

-

Windows Server 2012

-

Windows Server 2016

-

SUSE Enterprise Linux Server 11 SP3 64bit

-

SUSE Enterprise Linux Server 11 SP4 64bit

-

SUSE Enterprise Linux Server 12 SP1 64bit

-

SUSE Enterprise Linux Server 12 SP2 64bit

-

Redhat Linux Enterprise 6.8 64bit

-

Redhat Linux Enterprise 7.3 64bit

-

High-performance generation II (H2)

-

CentOS 6.5 64bit

-

CentOS 7.2 64bit

-

SUSE SLES 11 SP4 64bit

-

Redhat 7.2 64bit

-

Memory-optimized generation II (m2)

-

CentOS 7.2 64bit

-

CentOS 6.5 64bit

-

SUSE SLES 11 SP4 64bit

-

Redhat 7.2 64bit

-

Windows 2012DC edition

-
-
-
-
-
-
-
Parent topic: Common Parameters
-
-
- diff --git a/docs/ims/api-ref/en-us_topic_0000001411239245.html b/docs/ims/api-ref/en-us_topic_0000001411239245.html deleted file mode 100644 index f78b026fb..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001411239245.html +++ /dev/null @@ -1,231 +0,0 @@ - - -

Adding or Deleting Image Tags in Batches

-

Function

This API is used to add tags to, update tags of, or delete tags from an image in batches.

-
-

Constraints

  • Each tag consists of a key and a value. The key contains at most 36 characters, and the value contains at most 43 characters. The key cannot be left blank or an empty character string. The value cannot be left blank but can be an empty character string.
  • An image can have a maximum of 10 tags.
  • The keys of multiple tags in the request body must be unique.
  • This API is an idempotent one.

    If a tag to be added has the same key as an existing tag, but the tag values are different, this tag will be added and overwrite the existing one. If a tag to be added has the same key and value as an existing tag, this tag will not be added.

    -

    If the specified tag does not exist, the deletion is considered successful by default.

    -
-
  • Restrictions on tag keys and values during batch deletion

    During the deletion, the system will not verify the character set range of the key and value. The key cannot be left blank or an empty character string. The value is optional and will not be not verified. If the tag to be deleted does not exist, the deletion is considered successful and no error is reported. Also, the system will not verify the length of both the key and value. The key can contain a maximum of 127 characters, and the value contains a maximum of 255 characters.

    -
-
-

URI

POST /v2/{project_id}/images/{image_id}/tags/action

-
Table 1 lists the parameters in the URI. -
- - - - - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-

image_id

-

Yes

-

String

-

Specifies the image ID.

-
-
-
-
-

Request

  • Request parameters -
    - - - - - - - - - - - - - - - - -

    Parameter

    -

    Mandatory

    -

    Type

    -

    Description

    -

    tags

    -

    Yes

    -

    Array of objects

    -

    Lists the tags to be added or deleted. For details, see Table 2.

    -

    action

    -

    Yes

    -

    String

    -

    Specifies the tag operation to be performed. The value is case sensitive and can be create or delete. create indicates that tags will be added or updated, while delete indicates that tags will be deleted.

    -
    -
    - -
    - - - - - - - - - - - - - - - - -
    Table 2 Data structure description of the tags field

    Parameter

    -

    Mandatory

    -

    Type

    -

    Description

    -

    key

    -

    Yes

    -

    String

    -

    Specifies the tag key. The tag key cannot be left blank.

    -

    value

    -

    Yes

    -

    String

    -

    Specifies the tag value.This parameter is optional.

    -
    -
    -
  • 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"
-}
-
      -
      -
    -
-
-

Response

  • Response parameters

    None

    -
  • Example response
    STATUS CODE 204
    -
-
-

Returned Values

  • Normal

    204

    -
  • Abnormal -
    - - - - - - - - - - - - - - - - - - - - - - -

    Returned Value

    -

    Description

    -

    400 Bad Request

    -

    Request error.

    -

    401 Unauthorized

    -

    Authentication failed.

    -

    403 Forbidden

    -

    You do not have the rights to perform the operation.

    -

    404 Not Found

    -

    The requested resource was not found.

    -

    500 Internal Server Error

    -

    Internal service error.

    -

    503 Service Unavailable

    -

    The service is unavailable.

    -
    -
    -
-
-
-
-
-
Parent topic: Image Tagging
-
-
- diff --git a/docs/ims/api-ref/en-us_topic_0000001411239253.html b/docs/ims/api-ref/en-us_topic_0000001411239253.html deleted file mode 100644 index 33e7cefa9..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001411239253.html +++ /dev/null @@ -1,230 +0,0 @@ - - -

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.

-
-

URI

GET /v2/schemas/members

-
-

Request

  • Request parameters

    None

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

Response

  • Response parameters -
    - - - - - - - - - - - - - - - - - -

    Parameter

    -

    Type

    -

    Description

    -

    name

    -

    String

    -

    Specifies the schema name.

    -

    links

    -

    Array of objects

    -

    Specifies the URL for accessing the schema.

    -

    For details, see Table 1.

    -

    properties

    -

    Object

    -

    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

    -

    Type

    -

    Description

    -

    href

    -

    String

    -

    Specifies the domain name.

    -

    rel

    -

    String

    -

    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"
-        }
-    }
-}
-
    -
    -
-
-

Returned Value

  • Normal

    200

    -
  • Abnormal -
    - - - - - - - - - - - - - - - - - - - - - - -

    Returned Value

    -

    Description

    -

    400 Bad Request

    -

    Request error.

    -

    401 Unauthorized

    -

    Authentication failed.

    -

    403 Forbidden

    -

    You do not have the rights to perform the operation.

    -

    404 Not Found

    -

    The requested resource was not found.

    -

    500 Internal Server Error

    -

    Internal service error.

    -

    503 Service Unavailable

    -

    The service is unavailable.

    -
    -
    -
-
-
-
-
-
Parent topic: Image Schema (Native OpenStack APIs)
-
-
- diff --git a/docs/ims/api-ref/en-us_topic_0000001411239269.html b/docs/ims/api-ref/en-us_topic_0000001411239269.html deleted file mode 100644 index fca7d6643..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001411239269.html +++ /dev/null @@ -1,160 +0,0 @@ - - -

Adding or Modifying a Tag

-

Function

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.

-
-

URI

PUT /v1/cloudimages/tags

-
-

Request

  • Request parameters -
    - - - - - - - - - - - - - - - - - - - - - -

    Parameter

    -

    Mandatory

    -

    Type

    -

    Description

    -

    image_id

    -

    Yes

    -

    String

    -

    Specifies the image ID.

    -

    For details about how to obtain the image ID, see Querying Images.

    -

    tag

    -

    No

    -

    String

    -

    Specifies the tag.

    -

    Use either tag or image_tag.

    -

    image_tag

    -

    No

    -

    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.

    -
    -
    - -
    - - - - - - - - - - - - - - - - -
    Table 1 Data structure description of the image_tag field

    Parameter

    -

    Mandatory

    -

    Type

    -

    Description

    -

    key

    -

    Yes

    -

    String

    -

    Specifies the tag key.

    -

    value

    -

    Yes

    -

    String

    -

    Specifies the tag value.

    -
    -
    -
  • 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"}
-}
-
      -
      -
    -
-
-

Response

  • Response parameters

    None

    -
  • Example response
    STATUS CODE 204
    -
-
-

Returned Value

  • Normal

    204

    -
  • Abnormal -
    - - - - - - - - - - - - - - - - - - - - - - -

    Returned Value

    -

    Description

    -

    400 Bad Request

    -

    Request error.

    -

    401 Unauthorized

    -

    Authentication failed.

    -

    403 Forbidden

    -

    You do not have the rights to perform the operation.

    -

    404 Not Found

    -

    The requested resource was not found.

    -

    500 Internal Server Error

    -

    Internal service error.

    -

    503 Service Unavailable

    -

    The service is unavailable.

    -
    -
    -
-
-
-
-
-
Parent topic: Image Tagging
-
-
- diff --git a/docs/ims/api-ref/en-us_topic_0000001411399133.html b/docs/ims/api-ref/en-us_topic_0000001411399133.html deleted file mode 100644 index f39eb947e..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001411399133.html +++ /dev/null @@ -1,116 +0,0 @@ - - -

Status Codes

-
  • Normal -
    - - - - - - - - - - - - - - - - -

    Returned Value

    -

    Description

    -

    200 OK

    -

    The results of GET and PUT operations are returned as expected.

    -

    201 Created

    -

    The results of the POST operation are returned as expected.

    -

    202 Accepted

    -

    The request has been accepted for processing.

    -

    204 No Content

    -

    The results of the DELETE operation are returned as expected.

    -
    -
    -
  • Abnormal -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

    Returned Value

    -

    Description

    -

    400 Bad Request

    -

    The server failed to process the request.

    -

    401 Unauthorized

    -

    You must enter a username and password to access the requested page.

    -

    403 Forbidden

    -

    You are forbidden to access the requested page.

    -

    404 Not Found

    -

    The server cannot find the requested page.

    -

    405 Method Not Allowed

    -

    You are not allowed to use the method specified in the request.

    -

    406 Not Acceptable

    -

    The response generated by the server cannot be accepted by the client.

    -

    407 Proxy Authentication Required

    -

    You must use the proxy server for authentication so that the request can be processed.

    -

    408 Request Timeout

    -

    The request timed out.

    -

    409 Conflict

    -

    The request could not be processed due to a conflict.

    -

    500 Internal Server Error

    -

    Failed to complete the request because of a service error.

    -

    501 Not Implemented

    -

    Failed to complete the request because the server does not support the requested function.

    -

    502 Bad Gateway

    -

    Failed to complete the request because the request is invalid.

    -

    503 Service Unavailable

    -

    Failed to complete the request. The service is unavailable.

    -

    504 Gateway Timeout

    -

    A gateway timeout error occurred.

    -
    -
    -
-
- diff --git a/docs/ims/api-ref/en-us_topic_0000001411399137.html b/docs/ims/api-ref/en-us_topic_0000001411399137.html deleted file mode 100644 index 144144d1c..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001411399137.html +++ /dev/null @@ -1,19 +0,0 @@ - - -

Image Sharing

-
-
- - -
-
Parent topic: IMS APIs
-
-
- diff --git a/docs/ims/api-ref/en-us_topic_0000001411399145.html b/docs/ims/api-ref/en-us_topic_0000001411399145.html deleted file mode 100644 index e1f05b3df..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001411399145.html +++ /dev/null @@ -1,99 +0,0 @@ - - -

Deleting an Image (Native OpenStack API v1.1 - Abandoned and Not Recommended)

-

Function

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 deleted status.

-

This API has been discarded. Deleting an Image (Native OpenStack API) is recommended.

-
-

URI

DELETE /v1.1/images/{image_id}

-
Table 1 lists the parameters in the URI. -
- - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

image_id

-

Yes

-

String

-

Specifies the image ID.

-
-
-
-
-

Request

  • Request parameters

    None

    -
  • Example request
    DELETE https://{Endpoint}/v1.1/images/3c3d1d01-b48a-4639-8a88-08be3b9b5d78
    -
-
-

Response

  • Response parameters

    None

    -
  • Example response
    HTTP/1.1 200 OK
    -
    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

    -

    Description

    -

    400 Bad Request

    -

    Request error.

    -

    401 Unauthorized

    -

    Authentication failed.

    -

    403 Forbidden

    -

    You do not have the rights to perform the operation.

    -

    404 Not Found

    -

    The requested resource was not found.

    -

    500 Internal Server Error

    -

    Internal service error.

    -

    503 Service Unavailable

    -

    The service is unavailable.

    -
    -
    -
-
-
-
-
-
Parent topic: Image (Native OpenStack APIs)
-
-
- diff --git a/docs/ims/api-ref/en-us_topic_0000001411399153.html b/docs/ims/api-ref/en-us_topic_0000001411399153.html deleted file mode 100644 index ba0c208c3..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001411399153.html +++ /dev/null @@ -1,17 +0,0 @@ - - -

API Version Query (Native OpenStack API)

-
-
- - -
-
Parent topic: Native OpenStack APIs
-
-
- diff --git a/docs/ims/api-ref/en-us_topic_0000001411399161.html b/docs/ims/api-ref/en-us_topic_0000001411399161.html deleted file mode 100644 index c6a4ed7d3..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001411399161.html +++ /dev/null @@ -1,729 +0,0 @@ - - -

Updating Image Information (Native OpenStack API)

-

Function

This API is used to modify image information.

-
-

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 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

image_id

-

Yes

-

String

-

Specifies the image ID.

-

For details about how to obtain the image ID, see Querying Images.

-
-
-
-

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 2 v2.1 request message body

    Parameter

    -

    Mandatory

    -

    Type

    -

    Description

    -

    [Array]

    -

    Yes

    -

    Array of objects

    -

    For details, see Table 3.

    -
    -
    - -
    - - - - - - - - - - - - - - - - - - - - - -
    Table 3 Data structure description of the [Array] field

    Parameter

    -

    Type

    -

    Mandatory

    -

    Description

    -

    op

    -

    String

    -

    Yes

    -

    Indicates the type of the update operation, including replacing, adding, and deleting an attribute.

    -

    The value can be replace, add, or remove.

    -

    path

    -

    String

    -

    Yes

    -

    Indicates the name of the target attribute.

    -

    For replace and remove, the value can only be an existing attribute of the image. For add, the value can be an existing or a new attribute. If the value is an existing attribute, add takes the same effect as replace. If the value is a new attribute, the add operation is performed. Add a slash (/) before the attribute name.

    -

    value

    -

    String

    -

    No

    -

    Indicates the value of the attribute to be updated or added.

    -

    Mandatory for replace and add, and not for remove

    -
    -
    - -
    - - - - - - - - - - - -
    Table 4 v2.0 request message body

    Parameter

    -

    Mandatory

    -

    Type

    -

    Description

    -

    [Array]

    -

    Yes

    -

    Array of objects

    -

    For details, see Table 5.

    -
    -
    - -
    - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 5 Data structure description of the [Array] field

    Parameter

    -

    Type

    -

    Mandatory

    -

    Description

    -

    replace

    -

    String

    -

    Mandatory for any of the three values

    -

    Indicates that an image attribute will be replaced. The value is the attribute to be replaced and a slash (/) must be added in front of the attribute name.

    -

    add

    -

    String

    -

    Indicates that an image attribute will be added. The value is the attribute to be added and a slash (/) must be added in front of the attribute name.

    -

    remove

    -

    String

    -

    Indicates that an image attribute will be deleted. The value is the attribute to be deleted and a slash (/) must be added in front of the attribute name.

    -

    value

    -

    String

    -

    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"       
-     }
-]     
-
      -
      -
    -
-
-

Response

  • Response parameters -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

    Parameter

    -

    Type

    -

    Description

    -

    file

    -

    String

    -

    Specifies the URL for uploading and downloading the image file.

    -

    owner

    -

    String

    -

    Specifies the tenant to which the image belongs.

    -

    id

    -

    String

    -

    Specifies the image ID.

    -

    size

    -

    Long

    -

    This parameter is unavailable currently.

    -

    self

    -

    String

    -

    Specifies the image URL.

    -

    schema

    -

    String

    -

    Specifies the image schema.

    -

    status

    -

    String

    -

    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

    -

    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.

    -

    visibility

    -

    String

    -

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

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

    name

    -

    String

    -

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

    -

    checksum

    -

    String

    -

    This parameter is unavailable currently.

    -

    protected

    -

    Boolean

    -

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

    -

    container_format

    -

    String

    -

    Specifies the container type.

    -

    min_ram

    -

    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.

    -

    max_ram

    -

    String

    -

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

    -

    updated_at

    -

    String

    -

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

    -

    __os_bit

    -

    String

    -

    Specifies the OS architecture, 32 bit or 64 bit.

    -

    __os_version

    -

    String

    -

    Specifies the OS version.

    -

    __description

    -

    String

    -

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

    -

    disk_format

    -

    String

    -

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

    -

    __isregistered

    -

    String

    -

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

    -

    __platform

    -

    String

    -

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

    -

    __os_type

    -

    String

    -

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

    -

    __system__cmkid

    -

    String

    -

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

    -

    min_disk

    -

    Integer

    -

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

    -

    virtual_env_type

    -

    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.
    -

    __image_source_type

    -

    String

    -

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

    -

    __imagetype

    -

    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.
    -

    created_at

    -

    String

    -

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

    -

    virtual_size

    -

    Integer

    -

    This parameter is unavailable currently.

    -

    __originalimagename

    -

    String

    -

    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

    -

    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.

    -

    __image_size

    -

    String

    -

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

    -

    __data_origin

    -

    String

    -

    Specifies the image source.

    -

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

    -

    __root_origin

    -

    String

    -

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

    -

    __lazyloading

    -

    Boolean

    -

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

    -

    active_at

    -

    String

    -

    Specifies the time when the image status became active.

    -

    __os_feature_list

    -

    String

    -

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

    -

    __account_code

    -

    String

    -

    Specifies the charging identifier for the image.

    -

    hw_firmware_type

    -

    String

    -

    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

    -

    String

    -

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

    -

    __support_kvm

    -

    String

    -

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

    -

    __support_xen

    -

    String

    -

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

    -

    __support_largememory

    -

    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.

    -

    For the supported OSs, see Table 4.

    -

    -

    __support_diskintensive

    -

    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.

    -

    __support_highperformance

    -

    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.

    -

    __support_xen_gpu_type

    -

    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.

    -

    __support_kvm_gpu_type

    -

    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 parameter cannot co-exist with __support_xen and __support_kvm.

    -

    __support_xen_hana

    -

    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 parameter cannot co-exist with __support_xen and __support_kvm.

    -

    __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 parameter cannot co-exist with __support_xen.

    -

    __sequence_num

    -

    String

    -

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

    -

    This parameter is unavailable currently.

    -

    __image_location

    -

    String

    -

    Specifies the location where the image is stored.

    -

    __is_config_init

    -

    String

    -

    Specifies whether initial configuration is complete. 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
    {  
-    "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

    -

    Description

    -

    400 Bad Request

    -

    Request error. For details, see Error Codes.

    -

    401 Unauthorized

    -

    Authentication failed.

    -

    403 Forbidden

    -

    You do not have the rights to perform the operation.

    -

    404 Not Found

    -

    The requested resource was not found.

    -

    500 Internal Server Error

    -

    Internal service error.

    -

    503 Service Unavailable

    -

    The service is unavailable.

    -
    -
    -
-
-
-
-
-
Parent topic: Image (Native OpenStack APIs)
-
-
- diff --git a/docs/ims/api-ref/en-us_topic_0000001411399165.html b/docs/ims/api-ref/en-us_topic_0000001411399165.html deleted file mode 100644 index f4190d6ee..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001411399165.html +++ /dev/null @@ -1,21 +0,0 @@ - - -

IMS APIs

-
-
- -
- diff --git a/docs/ims/api-ref/en-us_topic_0000001411399169.html b/docs/ims/api-ref/en-us_topic_0000001411399169.html deleted file mode 100644 index 79f0aa67a..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001411399169.html +++ /dev/null @@ -1,109 +0,0 @@ - - -

Deleting an Image Tag

-

Function

This API is used to delete a specified tag from an image.

-
-

Constraints

  • To be compatible with remaining tags, the system will not verify the character set and length of the keys and values in the query condition.
  • This API is a non-idempotent one. If the key to be deleted does not exist, status code 404 is returned.
-
-

URI

DELETE /v2/{project_id}/images/{image_id}/tags/{key}

-
Table 1 lists the parameters in the URI. -
- - - - - - - - - - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-

image_id

-

Yes

-

String

-

Specifies the image ID.

-

key

-

Yes

-

String

-

Specifies the key of the tag to be deleted.

-
-
-
-
-

Request

  • Request parameters

    None

    -
  • Example request
    DELETE https://{Endpoint}/v2/fd73a4a14a4a4dfb9771a8475e5198ea/images/67e17426-359e-49fb-aa12-0bd1756ec240/tags/key1
    -
-
-

Response

  • Response parameters

    None

    -
  • Example response
    STATUS CODE 204
    -
-
-

Returned Value

  • Normal

    204

    -
  • Abnormal -
    - - - - - - - - - - - - - - - - - - - - - - -

    Returned Value

    -

    Description

    -

    400 Bad Request

    -

    Request error.

    -

    401 Unauthorized

    -

    Authentication failed.

    -

    403 Forbidden

    -

    You do not have the rights to perform the operation.

    -

    404 Not Found

    -

    The requested resource was not found.

    -

    500 Internal Server Error

    -

    Internal service error.

    -

    503 Service Unavailable

    -

    The service is unavailable.

    -
    -
    -
-
-
-
-
-
Parent topic: Image Tagging
-
-
- diff --git a/docs/ims/api-ref/en-us_topic_0000001411399181.html b/docs/ims/api-ref/en-us_topic_0000001411399181.html deleted file mode 100644 index 2a52ae3f0..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001411399181.html +++ /dev/null @@ -1,546 +0,0 @@ - - -

Querying Image Details (Native OpenStack API)

-

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 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

image_id

-

Yes

-

String

-

Specifies the image ID.

-
-
-
-
-

Request

  • Request parameters

    None

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

Response

  • Response parameters -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

    Parameter

    -

    Type

    -

    Description

    -

    file

    -

    String

    -

    Specifies the URL for uploading and downloading the image file.

    -

    owner

    -

    String

    -

    Specifies the tenant to which the image belongs.

    -

    id

    -

    String

    -

    Specifies the image ID.

    -

    size

    -

    Long

    -

    This parameter is unavailable currently.

    -

    self

    -

    String

    -

    Specifies the image URL.

    -

    schema

    -

    String

    -

    Specifies the image schema.

    -

    status

    -

    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.
    -

    tags

    -

    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.

    -

    visibility

    -

    String

    -

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

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

    name

    -

    String

    -

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

    -

    checksum

    -

    String

    -

    This parameter is unavailable currently.

    -

    protected

    -

    Boolean

    -

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

    -

    container_format

    -

    String

    -

    Specifies the container type.

    -

    min_ram

    -

    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.

    -

    max_ram

    -

    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.

    -

    updated_at

    -

    String

    -

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

    -

    __os_bit

    -

    String

    -

    Specifies the OS architecture, 32 bit or 64 bit.

    -

    __os_version

    -

    String

    -

    Specifies the OS version.

    -

    __description

    -

    String

    -

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

    -

    disk_format

    -

    String

    -

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

    -

    __isregistered

    -

    String

    -

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

    -

    __platform

    -

    String

    -

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

    -

    __os_type

    -

    String

    -

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

    -

    __system__cmkid

    -

    String

    -

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

    -

    min_disk

    -

    Integer

    -

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

    -

    virtual_env_type

    -

    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.
    -

    __image_source_type

    -

    String

    -

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

    -

    __imagetype

    -

    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.
    -

    created_at

    -

    String

    -

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

    -

    virtual_size

    -

    Integer

    -

    This parameter is unavailable currently.

    -

    __originalimagename

    -

    String

    -

    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

    -

    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.

    -

    __image_size

    -

    String

    -

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

    -

    __data_origin

    -

    String

    -

    Specifies the image source.

    -

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

    -

    __root_origin

    -

    String

    -

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

    -

    __lazyloading

    -

    Boolean

    -

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

    -

    active_at

    -

    String

    -

    Specifies the time when the image status became active.

    -

    __os_feature_list

    -

    String

    -

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

    -

    __sequence_num

    -

    String

    -

    This parameter is unavailable currently.

    -

    __support_kvm

    -

    String

    -

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

    -

    __support_xen

    -

    String

    -

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

    -

    __support_largememory

    -

    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 the supported OSs, see Table 4.

    -

    -

    __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.

    -

    __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.

    -

    __support_xen_gpu_type

    -

    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.

    -

    __support_kvm_gpu_type

    -

    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.

    -

    __support_xen_hana

    -

    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.

    -

    __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.

    -

    hw_firmware_type

    -

    String

    -

    Specifies the ECS boot mode. Available values include:

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

    hw_vif_multiqueue_enabled

    -

    String

    -

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

    -

    __image_location

    -

    String

    -

    Specifies the location where the image is stored.

    -

    __is_config_init

    -

    String

    -

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

    -

    __support_amd

    -

    String

    -

    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
    {
-      "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",
-      "__support_kvm_fpga_type": "VU9P",
-      "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

    -

    Description

    -

    400 Bad Request

    -

    Request error.

    -

    401 Unauthorized

    -

    Authentication failed.

    -

    403 Forbidden

    -

    You do not have the rights to perform the operation.

    -

    404 Not Found

    -

    The requested resource was not found.

    -

    500 Internal Server Error

    -

    Internal service error.

    -

    503 Service Unavailable

    -

    The service is unavailable.

    -
    -
    -
-
-
-
-
-
Parent topic: Image (Native OpenStack APIs)
-
-
- diff --git a/docs/ims/api-ref/en-us_topic_0000001411399189.html b/docs/ims/api-ref/en-us_topic_0000001411399189.html deleted file mode 100644 index a936e55bc..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001411399189.html +++ /dev/null @@ -1,21 +0,0 @@ - - -

Image Schema (Native OpenStack APIs)

-
-
- - -
-
Parent topic: Native OpenStack APIs
-
-
- diff --git a/docs/ims/api-ref/en-us_topic_0000001411479433.html b/docs/ims/api-ref/en-us_topic_0000001411479433.html deleted file mode 100644 index 9adb5414e..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001411479433.html +++ /dev/null @@ -1,20 +0,0 @@ - - -

Image Tag Data Formats

-

Description

You can attach a custom tag to a private image to facilitate private image management.

-
-

Data Formats

Data format of tag
  • The data format is key.value. If a key is added, a tag is added. In other cases, the tag is modified.
  • The tag key can contain a maximum of 36 characters, and the tag value can contain a maximum of 43 characters. The tag value can be an empty character string.
  • The tag can contain only digits, letters, underscores (_), and hyphens (-).
-
-
Data format of image_tags
  • The data format is {"key": "keyA", "value": "valueA"}. If the added key A exists, the tag is updated.
  • The tag key can contain a maximum of 36 characters, and the tag value can contain a maximum of 43 characters. The tag value can be an empty character string.
  • If the first and last characters of the tag key and value are spaces, the system deletes the space by default.
-
-
-

Data Formats (Native OpenStack)

Data format of tag
  • The data format is key. If a key is added, a tag is added. In other cases, the tag is modified.
  • The tag key can contain a maximum of 255 characters.
  • The tag can contain only digits, letters, underscores (_), and hyphens (-).
-
-
-
-
-
-
Parent topic: Common Parameters
-
-
- diff --git a/docs/ims/api-ref/en-us_topic_0000001411479437.html b/docs/ims/api-ref/en-us_topic_0000001411479437.html deleted file mode 100644 index 373b48748..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001411479437.html +++ /dev/null @@ -1,118 +0,0 @@ - - -

Uploading an Image (Native OpenStack API)

-

Function

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 to create images, see sections "Creating a Private Windows Image Using an External Image File" and "Creating a Private Linux Image Using an External Image File" in Image Management Service User Guide.

-

The following describes how to use this API:

-
  1. Prepare the image to be uploaded. The image can be in QCOW2, VMDK, VHD, RAW, VHDX, QED, VDI, QCOW, ZVHD2, or ZVHD format.
  2. Create metadata for the image by performing the operations in Creating Image Metadata (Native OpenStack API). After the API is invoked successfully, save the image ID.
  3. Upload the image file with the image ID obtained in 2.
-
-

URI

PUT /v2/images/{image_id}/file

-
Table 1 lists the parameters in the URI. -
- - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

image_id

-

Yes

-

String

-

Specifies the image ID.

-
  • image_id is the ID of the image you created by invoking the API for creating image metadata. Image upload 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 is uploaded successfully.
-
-
-
-
-

Request

  • Request parameters -
    - - - - - - - - - - - -

    Parameter

    -

    Mandatory

    -

    Type

    -

    Description

    -

    image_file

    -

    Yes

    -

    file

    -

    Specifies the local file to be uploaded.

    -
    -
    -
  • 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
    -
-
-

Returned Values

  • Normal

    204

    -
  • Abnormal -
    - - - - - - - - - - - - - - - - - - - - - - -

    Returned Value

    -

    Description

    -

    400 Bad Request

    -

    Request error. For details, see Error Codes.

    -

    401 Unauthorized

    -

    Authentication failed.

    -

    403 Forbidden

    -

    You do not have the rights to perform the operation.

    -

    404 Not Found

    -

    The requested resource was not found.

    -

    409 Conflict

    -

    Request conflict.

    -

    500 System Error

    -

    System error.

    -
    -
    -
-
-
-
-
-
Parent topic: Image (Native OpenStack APIs)
-
-
- diff --git a/docs/ims/api-ref/en-us_topic_0000001411479457.html b/docs/ims/api-ref/en-us_topic_0000001411479457.html deleted file mode 100644 index d914ce93a..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001411479457.html +++ /dev/null @@ -1,197 +0,0 @@ - - -

Querying an API Version (Native OpenStack API)

-

Function

This API is used to query a specified API version, such as version compatibility and domain name information of an API.

-
-

URI

GET /{api_version}

-

Table 1 lists the parameters in the URI.

- -
- - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

api_version

-

Yes

-

String

-

Specifies the API version, for example v2.0.

-
-
-
-

Request

  • Request parameters

    None

    -
  • Example request
    GET https://{Endpoint}/v2.0
    -
-
-

Response

  • Response parameters -
    - - - - - - - - - -

    Parameter

    -

    Type

    -

    Description

    -

    versions

    -

    Array of objects

    -

    Specifies the version.

    -

    For details, see Table 2.

    -
    -
    - -
    - - - - - - - - - - - - - - - - - -
    Table 2 Data structure description of the versions field

    Parameter

    -

    Type

    -

    Description

    -

    status

    -

    String

    -

    Specifies the API status.

    -

    id

    -

    String

    -

    Specifies the API ID.

    -

    links

    -

    Array of objects

    -

    Specifies the description.

    -

    For details, see Table 3.

    -
    -
    - -
    - - - - - - - - - - - - - -
    Table 3 Data structure description of the versions.links field

    Parameter

    -

    Type

    -

    Description

    -

    href

    -

    String

    -

    Specifies the domain name.

    -

    rel

    -

    String

    -

    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"
-                }
-            ]
-        }
-    ]
-}
-
    -
    -
-
-

Returned Values

  • Normal

    200

    -
  • Abnormal -
    - - - - - - - - - - - - - - - - - - - - - - -

    Returned Values

    -

    Description

    -

    400 Bad Request

    -

    Request error.

    -

    401 Unauthorized

    -

    Authentication failed.

    -

    403 Forbidden

    -

    You do not have the rights to perform the operation.

    -

    404 Not Found

    -

    The requested resource was not found.

    -

    500 Internal Server Error

    -

    Internal service error.

    -

    503 Service Unavailable

    -

    The service is unavailable.

    -
    -
    -
-
-
-
-
-
Parent topic: API Version Query (Native OpenStack API)
-
-
- diff --git a/docs/ims/api-ref/en-us_topic_0000001411479461.html b/docs/ims/api-ref/en-us_topic_0000001411479461.html deleted file mode 100644 index be4542976..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001411479461.html +++ /dev/null @@ -1,253 +0,0 @@ - - -

Querying API Versions (Native OpenStack API)

-

Function

This API is used to query API versions, such as version compatibility and domain name information of APIs.

-
-

URI

GET /

-
-

Request

  • Request parameters

    None

    -
  • Example request
    GET https://{Endpoint}/
    -
-
-

Response

  • Response parameters -
    - - - - - - - - - -

    Parameter

    -

    Type

    -

    Description

    -

    versions

    -

    Array of objects

    -

    Specifies the versions.

    -

    For details, see Table 1.

    -
    -
    - -
    - - - - - - - - - - - - - - - - - -
    Table 1 Data structure description of the versions field

    Parameter

    -

    Type

    -

    Description

    -

    status

    -

    String

    -

    Specifies the API status.

    -

    id

    -

    String

    -

    Specifies the API ID.

    -

    links

    -

    Array of objects

    -

    Specifies the description.

    -

    For details, see Table 2.

    -
    -
    - -
    - - - - - - - - - - - - - -
    Table 2 Data structure description of the versions.links field

    Parameter

    -

    Type

    -

    Description

    -

    href

    -

    String

    -

    Specifies the domain name.

    -

    rel

    -

    String

    -

    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"
-                }
-            ]
-        }
-    ]
-}
-
    -
    -
-
-

Returned Values

  • Normal

    200

    -
  • Abnormal -
    - - - - - - - - - - - - - - - - - - - - - - -

    Returned Value

    -

    Description

    -

    400 Bad Request

    -

    Request error.

    -

    401 Unauthorized

    -

    Authentication failed.

    -

    403 Forbidden

    -

    You do not have the rights to perform the operation.

    -

    404 Not Found

    -

    The requested resource was not found.

    -

    500 Internal Server Error

    -

    Internal service error.

    -

    503 Service Unavailable

    -

    The service is unavailable.

    -
    -
    -
-
-
-
-
-
Parent topic: API Version Query (Native OpenStack API)
-
-
- diff --git a/docs/ims/api-ref/en-us_topic_0000001411479465.html b/docs/ims/api-ref/en-us_topic_0000001411479465.html deleted file mode 100644 index f3b2a4852..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001411479465.html +++ /dev/null @@ -1,176 +0,0 @@ - - -

Exporting an Image

-

Function

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 of OBS.

-
-
-

Constraints

  • The following private images cannot be exported:
    • Full-ECS images
    • Private images created from a Windows or SUSE 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

-
Table 1 lists the parameters in the URI. -
- - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

image_id

-

Yes

-

String

-

Specifies the image ID.

-

For details about how to obtain the image ID, see Querying Images.

-
-
-
-
-

Request

  • Request parameters -
    - - - - - - - - - - - - - - - - - - - - - -

    Parameter

    -

    Mandatory

    -

    Type

    -

    Description

    -

    bucket_url

    -

    Yes

    -

    String

    -

    Specifies the URL of the image file in the format of Bucket name:File name.

    -
    NOTE:

    The storage class of the OBS bucket must be Standard.

    -
    -

    file_format

    -

    Yes

    -

    String

    -

    Specifies the file format. The value can be qcow2, vhd, zvhd, or vmdk.

    -

    is_quick_export

    -

    No

    -

    Boolean

    -

    Whether to enable fast export. The value can be true or false.

    -
    NOTE:

    If fast export is enabled, file_format cannot be specified.

    -
    -
    -
    -
  • 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
-}
-
    -
    -
-
-

Response

  • Response parameters -
    - - - - - - - - - -

    Parameter

    -

    Type

    -

    Description

    -

    job_id

    -

    String

    -

    Specifies the asynchronous job ID.

    -

    For details, see Asynchronous Job Query.

    -
    -
    -
  • Example response
    STATUS CODE 200
    -
    1
-2
-3
    {
-    "job_id": "edc89b490d7d4392898e19b2deb34797"
-}
-
    -
    -
-
-

Returned Value

  • Normal

    200

    -
  • Abnormal -
    - - - - - - - - - - - - - - - - - - - - - - -

    Returned Value

    -

    Description

    -

    400 Bad Request

    -

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

    -

    401 Unauthorized

    -

    Authentication failed.

    -

    403 Forbidden

    -

    You do not have the rights to perform the operation.

    -

    404 Not Found

    -

    The requested resource was not found.

    -

    500 Internal Server Error

    -

    Internal service error.

    -

    503 Service Unavailable

    -

    The service is unavailable.

    -
    -
    -
-
-
-
-
-
Parent topic: Image
-
-
- diff --git a/docs/ims/api-ref/en-us_topic_0000001411479469.html b/docs/ims/api-ref/en-us_topic_0000001411479469.html deleted file mode 100644 index b5a08dd08..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001411479469.html +++ /dev/null @@ -1,31 +0,0 @@ - - -

Image (Native OpenStack APIs)

-
-
- - -
-
Parent topic: Native OpenStack APIs
-
-
- diff --git a/docs/ims/api-ref/en-us_topic_0000001411479473.html b/docs/ims/api-ref/en-us_topic_0000001411479473.html deleted file mode 100644 index 698f83ea9..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001411479473.html +++ /dev/null @@ -1,167 +0,0 @@ - - -

Adding an Image Tag

-

Function

This API is used to add a tag to an image or update a tag.

-
-

Constraints

  • Each tag consists of a key and a value. The key contains at most 36 characters, and the value contains at most 43 characters. The key cannot be left blank or an empty character string. The value cannot be left blank but can be an empty character string.
  • An image can have a maximum of 10 tags.
  • This API is an idempotent API. If a tag to be added has the same key as an existing tag, but the tag values are different, this tag will be added and overwrite the existing one. If a tag to be added has the same key and value as an existing tag, this tag will not be added.
-
-

URI

POST /v2/{project_id}/images/{image_id}/tags

-
Table 1 lists the parameters in the URI. -
- - - - - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-

image_id

-

Yes

-

String

-

Specifies the image ID.

-
-
-
-
-

Request

  • Request parameters -
    - - - - - - - - - - - -

    Parameter

    -

    Mandatory

    -

    Type

    -

    Description

    -

    tag

    -

    Yes

    -

    Object

    -

    Specifies the tag to be added or updated. For details, see Table 2.

    -
    -
    - -
    - - - - - - - - - - - - - - - - -
    Table 2 Data structure description of the tag field

    Parameter

    -

    Mandatory

    -

    Type

    -

    Description

    -

    key

    -

    Yes

    -

    String

    -

    Specifies the tag key. The tag key cannot be left blank.

    -

    value

    -

    Yes

    -

    String

    -

    Specifies the tag value.

    -
    -
    -
  • 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"
-   }
-}
-
    -
    -
-
-

Response

  • Response parameters

    None

    -
  • Example response
    STATUS CODE 204
    -
-
-

Returned Value

  • Normal

    204

    -
  • Abnormal -
    - - - - - - - - - - - - - - - - - - - - - - -

    Returned Value

    -

    Description

    -

    400 Bad Request

    -

    Request error.

    -

    401 Unauthorized

    -

    Authentication failed.

    -

    403 Forbidden

    -

    You do not have the rights to perform the operation.

    -

    404 Not Found

    -

    The requested resource was not found.

    -

    500 Internal Server Error

    -

    Internal service error.

    -

    503 Service Unavailable

    -

    The service is unavailable.

    -
    -
    -
-
-
-
-
-
Parent topic: Image Tagging
-
-
- diff --git a/docs/ims/api-ref/en-us_topic_0000001411479477.html b/docs/ims/api-ref/en-us_topic_0000001411479477.html deleted file mode 100644 index dabe21304..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001411479477.html +++ /dev/null @@ -1,29 +0,0 @@ - - -

Image Tagging

-
-
- - -
-
Parent topic: IMS APIs
-
-
- diff --git a/docs/ims/api-ref/en-us_topic_0000001411479493.html b/docs/ims/api-ref/en-us_topic_0000001411479493.html deleted file mode 100644 index 13ffb868c..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001411479493.html +++ /dev/null @@ -1,99 +0,0 @@ - - -

Deleting a Tag (Native OpenStack API)

-

Function

This API is used to delete a custom tag from a private image.

-
-

URI

DELETE /v2/images/{image_id}/tags/{tag}

-
Table 1 lists the parameters in the URI. -
- - - - - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

image_id

-

Yes

-

String

-

Specifies the image ID.

-

tag

-

Yes

-

String

-

Specifies the image tag.

-

The tag can contain only digits, letters, underscores (_), and hyphens (-).

-
-
-
-
-

Request

  • Request parameters

    None

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

Response

  • Response parameters

    None

    -
  • Example response
    STATUS CODE 204
    -
-
-

Returned Values

  • Normal

    204

    -
  • Abnormal -
    - - - - - - - - - - - - - - - - - - - - - - -

    Returned Value

    -

    Description

    -

    400 Bad Request

    -

    Request error.

    -

    401 Unauthorized

    -

    Authentication failed.

    -

    403 Forbidden

    -

    You do not have the rights to perform the operation.

    -

    404 Not Found

    -

    The requested resource was not found.

    -

    500 Internal Server Error

    -

    Internal service error.

    -

    503 Service Unavailable

    -

    The service is unavailable.

    -
    -
    -
-
-
-
-
-
Parent topic: Image Tagging (Native OpenStack APIs)
-
-
- diff --git a/docs/ims/api-ref/en-us_topic_0000001411479497.html b/docs/ims/api-ref/en-us_topic_0000001411479497.html deleted file mode 100644 index 3bb7342d8..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001411479497.html +++ /dev/null @@ -1,196 +0,0 @@ - - -

Querying Image 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

-
Table 1 lists the parameters in the URI. -
- - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

image_id

-

Yes

-

String

-

Specifies the image ID.

-
-
-
-
-

Request

  • Request parameters

    None

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

Response

  • Response parameters -
    - - - - - - - - - - - - - -

    Parameter

    -

    Type

    -

    Description

    -

    members

    -

    Array of objects

    -

    Specifies the members.

    -

    For details, see Table 2.

    -

    schema

    -

    String

    -

    Specifies the sharing schema.

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

    Parameter

    -

    Type

    -

    Description

    -

    status

    -

    String

    -

    Specifies the image sharing status.

    -

    created_at

    -

    String

    -

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

    -

    updated_at

    -

    String

    -

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

    -

    image_id

    -

    String

    -

    Specifies the image ID.

    -

    member_id

    -

    String

    -

    Specifies the member ID.

    -

    schema

    -

    String

    -

    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"
-}
-
    -
    -
-
-

Returned Values

  • Normal

    200

    -
  • Abnormal -
    - - - - - - - - - - - - - - - - - - - - - - -

    Returned Value

    -

    Description

    -

    400 Bad Request

    -

    Request error.

    -

    401 Unauthorized

    -

    Authentication failed.

    -

    403 Forbidden

    -

    You do not have the rights to perform the operation.

    -

    404 Not Found

    -

    The requested resource was not found.

    -

    500 Internal Server Error

    -

    Internal service error.

    -

    503 Service Unavailable

    -

    The service is unavailable.

    -
    -
    -
-
-
-
-
-
Parent topic: Image Sharing (Native OpenStack APIs)
-
-
- diff --git a/docs/ims/api-ref/en-us_topic_0000001411479501.html b/docs/ims/api-ref/en-us_topic_0000001411479501.html deleted file mode 100644 index f076ca121..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001411479501.html +++ /dev/null @@ -1,15 +0,0 @@ - - -

Image Quota

-
-
- - -
-
Parent topic: IMS APIs
-
-
- diff --git a/docs/ims/api-ref/en-us_topic_0000001411479505.html b/docs/ims/api-ref/en-us_topic_0000001411479505.html deleted file mode 100644 index 34dc92e90..000000000 --- a/docs/ims/api-ref/en-us_topic_0000001411479505.html +++ /dev/null @@ -1,170 +0,0 @@ - - -

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.

-
-

Constraints

  • Full-ECS images cannot be replicated.
-
-

URI

POST /v1/cloudimages/{image_id}/copy

-
Table 1 lists the parameters in the URI. -
- - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

image_id

-

Yes

-

String

-

Specifies the image ID.

-

For details about how to obtain the image ID, see Querying Images.

-
-
-
-
-

Request

  • Request parameters -
    - - - - - - - - - - - - - - - - - - - - - -

    Parameter

    -

    Mandatory

    -

    Type

    -

    Description

    -

    name

    -

    Yes

    -

    String

    -

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

    -

    description

    -

    No

    -

    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.

    -

    cmk_id

    -

    No

    -

    String

    -

    Specifies the encryption key. This parameter is left blank by default.

    -
    -
    -
  • 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"
-}
-
    -
    -
-
-

Response

  • Response parameters -
    - - - - - - - - - -

    Parameter

    -

    Type

    -

    Description

    -

    job_id

    -

    String

    -

    Specifies the asynchronous job ID.

    -

    For details, see Asynchronous Job Query.

    -
    -
    -
  • Example response
    STATUS CODE 200
    -
    1
-2
-3
    {
-    "job_id": "edc89b490d7d4392898e19b2deb34797"
-}
-
    -
    -
-
-

Returned Value

  • Normal

    200

    -
  • Abnormal -
    - - - - - - - - - - - - - - - - - - - - - - -

    Returned Value

    -

    Description

    -

    400 Bad Request

    -

    Request error. For details, see Error Codes.

    -

    401 Unauthorized

    -

    Authentication failed.

    -

    403 Forbidden

    -

    You do not have the rights to perform the operation.

    -

    404 Not Found

    -

    The requested resource was not found.

    -

    500 Internal Server Error

    -

    Internal service error.

    -

    503 Service Unavailable

    -

    The service is unavailable.

    -
    -
    -
-
-
-
-
-
Parent topic: Image Replication
-
-
- diff --git a/docs/ims/api-ref/en-us_topic_0020091553.html b/docs/ims/api-ref/en-us_topic_0020091553.html new file mode 100644 index 000000000..dc234b9c4 --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0020091553.html @@ -0,0 +1,99 @@ + + +

Deleting a Tag (Native OpenStack API)

+

Function

This API is used to delete a custom tag from a private image.

+
+

URI

DELETE /v2/images/{image_id}/tags/{tag}

+
Table 1 lists the parameters in the URI. +
+ + + + + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

image_id

+

Yes

+

String

+

Specifies the image ID.

+

tag

+

Yes

+

String

+

Specifies the image tag.

+

The tag can contain only digits, letters, underscores (_), and hyphens (-).

+
+
+
+
+

Request

  • Request parameters

    None

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

Response

  • Response parameters

    None

    +
  • Example response
    STATUS CODE 204
    +
+
+

Returned Values

  • Normal

    204

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    Request error.

    +

    401 Unauthorized

    +

    Authentication failed.

    +

    403 Forbidden

    +

    You do not have the rights to perform the operation.

    +

    404 Not Found

    +

    The requested resource was not found.

    +

    500 Internal Server Error

    +

    Internal service error.

    +

    503 Service Unavailable

    +

    The service is unavailable.

    +
    +
    +
+
+
+
+
+
Parent topic: Image Tagging (Native OpenStack APIs)
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0020091554.html b/docs/ims/api-ref/en-us_topic_0020091554.html new file mode 100644 index 000000000..46cda8a2c --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0020091554.html @@ -0,0 +1,21 @@ + + +

Image Schema (Native OpenStack APIs)

+
+
+ + +
+
Parent topic: Native OpenStack APIs
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0020091555.html b/docs/ims/api-ref/en-us_topic_0020091555.html new file mode 100644 index 000000000..44bbfeaae --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0020091555.html @@ -0,0 +1,540 @@ + + +

Querying an Image Schema (Native OpenStack API)

+

Function

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

+
+

URI

GET /v2/schemas/image

+
+

Request

  • Request parameters

    None

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

Response

  • Response parameters +
    + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    additionalProperties

    +

    Object

    +

    Specifies the additional attributes.

    +

    For details, see Table 1.

    +

    name

    +

    String

    +

    Specifies the schema name.

    +

    links

    +

    Array of objects

    +

    Specifies the URL for accessing the schema.

    +

    For details, see Table 2.

    +

    properties

    +

    Object

    +

    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

    +

    Type

    +

    Description

    +

    type

    +

    String

    +

    Type

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

    Parameter

    +

    Type

    +

    Description

    +

    href

    +

    String

    +

    Specifies the domain name.

    +

    rel

    +

    String

    +

    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)"
+        }
+    }
+}
+
    + +
    +
+
+

Returned Values

  • Normal

    200

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    Request error.

    +

    401 Unauthorized

    +

    Authentication failed.

    +

    403 Forbidden

    +

    You do not have the rights to perform the operation.

    +

    404 Not Found

    +

    The requested resource was not found.

    +

    500 Internal Server Error

    +

    Internal service error.

    +

    503 Service Unavailable

    +

    The service is unavailable.

    +
    +
    +
+
+
+
+
+
Parent topic: Image Schema (Native OpenStack APIs)
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0020091556.html b/docs/ims/api-ref/en-us_topic_0020091556.html new file mode 100644 index 000000000..873eff589 --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0020091556.html @@ -0,0 +1,575 @@ + + +

Querying an Image List Schema (Native OpenStack API)

+

Function

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.

+
+

URI

GET /v2/schemas/images

+
+

Request

  • Request parameters

    None

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

Response

  • Response parameters +
    + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    name

    +

    String

    +

    Specifies the schema name.

    +

    links

    +

    Array of objects

    +

    Specifies the URL for accessing the schema.

    +

    For details, see Table 1.

    +

    properties

    +

    Object

    +

    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

    +

    Type

    +

    Description

    +

    href

    +

    String

    +

    Specifies the domain name.

    +

    rel

    +

    String

    +

    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"
+        }
+    }
+}
+
    + +
    +
+
+

Returned Values

  • Normal

    200

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    Request error.

    +

    401 Unauthorized

    +

    Authentication failed.

    +

    403 Forbidden

    +

    You do not have the rights to perform the operation.

    +

    404 Not Found

    +

    The requested resource was not found.

    +

    500 Internal Server Error

    +

    Internal service error.

    +

    503 Service Unavailable

    +

    The service is unavailable.

    +
    +
    +
+
+
+
+
+
Parent topic: Image Schema (Native OpenStack APIs)
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0020091562.html b/docs/ims/api-ref/en-us_topic_0020091562.html new file mode 100644 index 000000000..859a2e371 --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0020091562.html @@ -0,0 +1,368 @@ + + +

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.

+
+

Image Attributes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Name

+

Type

+

Description

+

file

+

String

+

Specifies the URL for uploading and downloading the image file.

+

owner

+

String

+

Specifies the tenant to which the image belongs.

+

id

+

String

+

Specifies the image ID.

+

size

+

Long

+

This parameter is unavailable currently.

+

self

+

String

+

Specifies the image URL.

+

schema

+

String

+

Specifies the image schema.

+

status

+

String

+

Specifies the image status. The value can be active, queued, saving, deleted, or killed. An image can be used only when it is in the active state.

+

tags

+

Array of strings

+

Lists the image tags.

+

visibility

+

String

+

Specifies whether the image can be seen by other tenants. The value can be private, public, or shared.

+

name

+

String

+

Specifies the image name.

+
  • The name cannot start or end with a space.
  • The name contains 1 to 128 characters.
  • The name contains the following characters:
    • Uppercase letters
    • Lowercase letters
    • Digits
    • Special characters, including hyphens (-), periods (.), underscores (_), and space
    +
+

checksum

+

String

+

This parameter is unavailable currently.

+

deleted

+

Boolean

+

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

+

protected

+

Boolean

+

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

+

container_format

+

String

+

Specifies the container type.

+

min_ram

+

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.

+

update_at

+

String

+

Specifies the time when the image was updated.

+

__os_bit

+

String

+

Specifies the OS architecture, 32 bit or 64 bit.

+

__os_version

+

String

+

Specifies the OS version.

+

__description

+

String

+

Provides supplementary information about the image.

+

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

+

disk_format

+

String

+

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

+

__isregistered

+

String

+

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

+

__platform

+

String

+

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

+

__os_type

+

String

+

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

+

min_disk

+

Integer

+

Specifies the minimum disk space (GB) required for running the image.

+

virtual_env_type

+

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.
+

__image_source_type

+

String

+

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

+

__imagetype

+

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.
+

__whole_image

+

Boolean

+

Specifies whether the image is a full-ECS image. The value can be true or false.

+

create_at

+

String

+

Specifies the time when the image was created.

+

virtual_size

+

Integer

+

This parameter is unavailable currently.

+

deleted_at

+

String

+

Specifies the time when the image was deleted.

+

__originalimagename

+

String

+

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

+

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.

+

__image_location

+

String

+

Specifies the location where the image is stored.

+

__image_size

+

String

+

Specifies the size (bytes) of the image file.

+

__data_origin

+

String

+

Specifies the image source.

+

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

+

hw_firmware_type

+

String

+

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

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

__support_xen

+

String

+

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

+

__support_largememory

+

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.

+

__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.

+

__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.

+

__support_xen_gpu_type

+

String

+

Specifies whether the image supports GPU-accelerated ECSs on the Xen platform. For the supported OSs, see Table 2. 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

+

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.

+

__support_xen_hana

+

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.

+

__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.

+

__is_config_init

+

String

+

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

+

If initial configuration is complete, the value is set to true. Otherwise, the value is set to false. The default value is false.

+

enterprise_project_id

+

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.

    +
+
+
+
+
+
+
+
Parent topic: Common Parameters
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0020091565.html b/docs/ims/api-ref/en-us_topic_0020091565.html new file mode 100644 index 000000000..4196cb755 --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0020091565.html @@ -0,0 +1,993 @@ + + +

Querying Images

+

Function

This API is used to query images using search criteria and to display the images in a list.

+
+

URI

GET /v2/cloudimages{?__isregistered,__imagetype,__whole_image,__system__cmkid,protected,visibility,owner,id,status,name,container_format,disk_format,min_ram,min_disk,__os_bit,__platform,marker,limit,sort_key,sort_dir,__os_type,tag,member_status,__support_kvm,__support_xen,__support_largememory,__support_diskintensive,__support_highperformance,__support_xen_gpu_type,__support_kvm_gpu_type,__support_xen_hana,__support_kvm_infiniband,virtual_env_type,enterprise_project_id,created_at,updated_at}

+

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.

+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

__isregistered

+

No

+

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.

+

__imagetype

+

No

+

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.
+
NOTE:

The __imagetype of images you share with other tenants or those other tenants share with you and you have accepted is shared. You can use field owner to distinguish the two types of shared images. You can use member_status to filter out shared images you have accepted.

+
+

__whole_image

+

No

+

Boolean

+

Specifies whether the image is a full-ECS image. The value can be true or false.

+

__system__cmkid

+

No

+

String

+

Specifies the ID of the key used to encrypt the image. You can obtain the ID from the IMS console or by calling the Querying Image Details (Native OpenStack API) API.

+

protected

+

No

+

Boolean

+

Specifies whether the image is protected. The value can be true or false. Set it to true when you query public images. This parameter is optional when you query private images.

+

visibility

+

No

+

String

+

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

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

owner

+

No

+

String

+

Specifies the tenant to which the image belongs.

+

id

+

No

+

String

+

Specifies the image ID.

+

status

+

No

+

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.
+

name

+

No

+

String

+

Specifies the image name. Exact matching is used. For detailed description, see Image Attributes.

+

container_format

+

No

+

String

+

Specifies the container type. The value is bare.

+

disk_format

+

No

+

String

+

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

+

min_ram

+

No

+

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.

+

min_disk

+

No

+

Integer

+

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

+

__os_bit

+

No

+

String

+

Specifies the OS architecture, 32 bit or 64 bit.

+

__platform

+

No

+

String

+

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

+

marker

+

No

+

String

+

Specifies the start number from which images are queried. The value is the image ID.

+

limit

+

No

+

Integer

+

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

+

sort_key

+

No

+

String

+

Specifies the field for sorting the query results. The value can be an attribute of the image: name, container_format, disk_format, status, id, size, or created_at. The default value is created_at.

+

sort_dir

+

No

+

String

+

Specifies whether the query results are sorted in ascending or descending order. Its value can be desc (default) or asc. This parameter is used together with parameter sort_key. The default value is desc.

+

__os_type

+

No

+

String

+

Specifies the image OS type. Available values include:

+
  • Linux
  • Windows
  • Other
+

tag

+

No

+

String

+

Specifies a tag added to an image. Tags can be used as a filter to query images.

+
NOTE:

The tagging function has been upgraded. If the tags added before the function upgrade are in the format of "Key.Value", query tags using "Key=Value". For example, an existing tag is a.b. After the tag function upgrade, query the tag using "tag=a=b".

+
+

member_status

+

No

+

String

+

Specifies the member status. The value can be accepted, rejected, or pending. accepted: indicates that the shared image is accepted. rejected indicates that the image shared by others is rejected. pending indicates that the image shared by others needs to be confirmed. To use this parameter, set visibility to shared during the query.

+

__support_kvm

+

No

+

String

+

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

+

__support_xen

+

No

+

String

+

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

+

__support_largememory

+

No

+

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 the supported OSs, see Table 4.

+

+

__support_diskintensive

+

No

+

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.

+

__support_highperformance

+

No

+

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.

+

__support_xen_gpu_type

+

No

+

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.

+

__support_kvm_gpu_type

+

No

+

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.

+

__support_xen_hana

+

No

+

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.

+

__support_kvm_infiniband

+

No

+

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.

+

virtual_env_type

+

No

+

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.
+

enterprise_project_id

+

No

+

String

+
Specifies the enterprise project to which the images to be queried belong.
  • If the value is 0, images of enterprise project default are to be queried.
  • If the value is UUID, images of the enterprise project corresponding to the UUID are to be queried.
  • If the value is all_granted_eps, images of all enterprise projects are to be queried.

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

    +
+
+

created_at

+

No

+

String

+

Specifies the time when the image was created. 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.

+

For example, to query images created before Oct 28, 2018 10:00:00, set the value of created_at as follows:

+

created_at=lt:2018-10-28T10:00:00Z

+

updated_at

+

No

+

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.

+

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.

+

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}/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}

    +
  • Available shared images

    GET /v2/cloudimages?member_status=accepted&visibility=shared&__imagetype=shared

    +
  • Rejected images

    GET /v2/cloudimages?member_status=rejected&visibility=shared&__imagetype=shared

    +
  • Unaccepted images

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

    +
+
+

Response

  • Response parameters +
    + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    images

    +

    Array of objects

    +

    Specifies image details.

    +

    For details, see Table 2.

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

    Parameter

    +

    Type

    +

    Description

    +

    file

    +

    String

    +

    Specifies the URL for uploading and downloading the image file.

    +

    owner

    +

    String

    +

    Specifies the tenant to which the image belongs.

    +

    id

    +

    String

    +

    Specifies the image ID.

    +

    size

    +

    Long

    +

    This parameter is unavailable currently.

    +

    self

    +

    String

    +

    Specifies the image URL.

    +

    schema

    +

    String

    +

    Specifies the image schema.

    +

    status

    +

    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.
    +

    tags

    +

    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.

    +

    visibility

    +

    String

    +

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

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

    name

    +

    String

    +

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

    +

    checksum

    +

    String

    +

    This parameter is unavailable currently.

    +

    protected

    +

    Boolean

    +

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

    +

    container_format

    +

    String

    +

    Specifies the container type.

    +

    min_ram

    +

    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.

    +

    max_ram

    +

    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.

    +

    updated_at

    +

    String

    +

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

    +

    __os_bit

    +

    String

    +

    Specifies the OS architecture, 32 bit or 64 bit.

    +

    __os_version

    +

    String

    +

    Specifies the OS version.

    +

    __description

    +

    String

    +

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

    +

    disk_format

    +

    String

    +

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

    +

    __isregistered

    +

    String

    +

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

    +

    __platform

    +

    String

    +

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

    +

    __os_type

    +

    String

    +

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

    +

    min_disk

    +

    Integer

    +

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

    +

    virtual_env_type

    +

    String

    +

    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

    +

    String

    +

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

    +

    __imagetype

    +

    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.
    +

    created_at

    +

    String

    +

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

    +

    virtual_size

    +

    Integer

    +

    This parameter is unavailable currently.

    +

    __originalimagename

    +

    String

    +

    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

    +

    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.

    +

    __image_size

    +

    String

    +

    Specifies the size (bytes) of the image file.

    +

    __data_origin

    +

    String

    +

    Specifies the image source.

    +

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

    +

    __lazyloading

    +

    String

    +

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

    +

    active_at

    +

    String

    +

    Specifies the time when the image status became active.

    +

    __os_feature_list

    +

    String

    +

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

    +

    __support_kvm

    +

    String

    +

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

    +

    __support_xen

    +

    String

    +

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

    +

    __support_largememory

    +

    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.

    +

    __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.

    +

    __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.

    +

    __support_xen_gpu_type

    +

    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.

    +

    __support_kvm_gpu_type

    +

    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.

    +

    __support_xen_hana

    +

    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.

    +

    __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.

    +

    enterprise_project_id

    +

    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, see Enterprise Management User Guide.

      +
    +

    __root_origin

    +

    String

    +

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

    +

    __sequence_num

    +

    String

    +

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

    +

    Example value: 0

    +

    __support_fc_inject

    +

    String

    +

    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

    +

    String

    +

    Specifies the ECS boot mode. Available values include:

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

    hw_vif_multiqueue_enabled

    +

    String

    +

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

    +

    __system__cmkid

    +

    String

    +

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

    +

    __support_amd

    +

    String

    +

    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"
+    }
+  ]
+}
+
    + +
    +
+
+

Returned Values

  • Normal

    200

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

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

    +

    401 Unauthorized

    +

    Authentication failed.

    +

    403 Forbidden

    +

    You do not have the rights to perform the operation.

    +

    404 Not Found

    +

    The requested resource was not found.

    +

    500 Internal Server Error

    +

    Internal service error.

    +

    503 Service Unavailable

    +

    The service is unavailable.

    +
    +
    +
+
+
+
+
+
Parent topic: Image
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0020091566.html b/docs/ims/api-ref/en-us_topic_0020091566.html new file mode 100644 index 000000000..270bf4370 --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0020091566.html @@ -0,0 +1,564 @@ + + +

Querying Image Details (Native OpenStack API)

+

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 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

image_id

+

Yes

+

String

+

Specifies the image ID.

+
+
+
+
+

Request

  • Request parameters

    None

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

Response

  • Response parameters +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    file

    +

    String

    +

    Specifies the URL for uploading and downloading the image file.

    +

    owner

    +

    String

    +

    Specifies the tenant to which the image belongs.

    +

    id

    +

    String

    +

    Specifies the image ID.

    +

    size

    +

    Long

    +

    This parameter is unavailable currently.

    +

    self

    +

    String

    +

    Specifies the image URL.

    +

    schema

    +

    String

    +

    Specifies the image schema.

    +

    status

    +

    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.
    +

    tags

    +

    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.

    +

    visibility

    +

    String

    +

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

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

    name

    +

    String

    +

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

    +

    checksum

    +

    String

    +

    This parameter is unavailable currently.

    +

    protected

    +

    Boolean

    +

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

    +

    container_format

    +

    String

    +

    Specifies the container type.

    +

    min_ram

    +

    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.

    +

    max_ram

    +

    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.

    +

    updated_at

    +

    String

    +

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

    +

    __os_bit

    +

    String

    +

    Specifies the OS architecture, 32 bit or 64 bit.

    +

    __os_version

    +

    String

    +

    Specifies the OS version.

    +

    __description

    +

    String

    +

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

    +

    disk_format

    +

    String

    +

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

    +

    __isregistered

    +

    String

    +

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

    +

    __platform

    +

    String

    +

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

    +

    __os_type

    +

    String

    +

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

    +

    __system__cmkid

    +

    String

    +

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

    +

    min_disk

    +

    Integer

    +

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

    +

    virtual_env_type

    +

    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.
    +

    __image_source_type

    +

    String

    +

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

    +

    __imagetype

    +

    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.
    +

    created_at

    +

    String

    +

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

    +

    virtual_size

    +

    Integer

    +

    This parameter is unavailable currently.

    +

    __originalimagename

    +

    String

    +

    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

    +

    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.

    +

    __image_size

    +

    String

    +

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

    +

    __data_origin

    +

    String

    +

    Specifies the image source.

    +

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

    +

    __root_origin

    +

    String

    +

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

    +

    __lazyloading

    +

    String

    +

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

    +

    active_at

    +

    String

    +

    Specifies the time when the image status became active.

    +

    __os_feature_list

    +

    String

    +

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

    +

    __sequence_num

    +

    String

    +

    This parameter is unavailable currently.

    +

    __support_kvm

    +

    String

    +

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

    +

    __support_xen

    +

    String

    +

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

    +

    __support_largememory

    +

    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 the supported OSs, see Table 4.

    +

    +

    __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.

    +

    __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.

    +

    __support_xen_gpu_type

    +

    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.

    +

    __support_kvm_gpu_type

    +

    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.

    +

    __support_xen_hana

    +

    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.

    +

    __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.

    +

    __support_fc_inject

    +

    String

    +

    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

    +

    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.

      +
    +

    hw_firmware_type

    +

    String

    +

    Specifies the ECS boot mode. Available values include:

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

    hw_vif_multiqueue_enabled

    +

    String

    +

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

    +

    __image_location

    +

    String

    +

    Specifies the location where the image is stored.

    +

    __is_config_init

    +

    String

    +

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

    +

    __support_amd

    +

    String

    +

    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"
+}
+
    + +
    +
+
+

Returned Values

  • Normal

    200

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    Request error.

    +

    401 Unauthorized

    +

    Authentication failed.

    +

    403 Forbidden

    +

    You do not have the rights to perform the operation.

    +

    404 Not Found

    +

    The requested resource was not found.

    +

    500 Internal Server Error

    +

    Internal service error.

    +

    503 Service Unavailable

    +

    The service is unavailable.

    +
    +
    +
+
+
+
+
+
Parent topic: Image (Native OpenStack APIs)
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0020091567.html b/docs/ims/api-ref/en-us_topic_0020091567.html new file mode 100644 index 000000000..b7c53e08b --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0020091567.html @@ -0,0 +1,659 @@ + + +

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.

+
+
+

URI

PATCH /v2/cloudimages/{image_id}

+

Table 1 describes the parameters in the URI.

+ +
+ + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

image_id

+

Yes

+

String

+

Private image ID

+

For details about how to obtain the image ID, see Querying Images.

+
+
+
+

Request

  • Request parameters +
    + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    [Array]

    +

    Yes

    +

    Array of objects

    +

    For details, see Table 2.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 2 Data structure description of the [Array] field

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    op

    +

    Yes

    +

    String

    +

    Specifies the operation. The value can be add, replace, or remove.

    +

    path

    +

    Yes

    +

    String

    +

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

    +

    You can modify 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.

    +

    value

    +

    Yes

    +

    String

    +

    Specifies the new value of the attribute. For detailed description, see Image 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"
+    }
+]
+
    + +
    +
+
+

Response

  • Response parameters +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    file

    +

    String

    +

    Specifies the URL for uploading and downloading the image file.

    +

    owner

    +

    String

    +

    Specifies the tenant to which the image belongs.

    +

    id

    +

    String

    +

    Specifies the image ID.

    +

    size

    +

    Long

    +

    This parameter is unavailable currently.

    +

    self

    +

    String

    +

    Specifies the image URL.

    +

    schema

    +

    String

    +

    Specifies the image schema.

    +

    status

    +

    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.
    +

    tags

    +

    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.

    +

    visibility

    +

    String

    +

    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

    +

    String

    +

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

    +

    checksum

    +

    String

    +

    This parameter is unavailable currently.

    +

    protected

    +

    Boolean

    +

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

    +

    container_format

    +

    String

    +

    Specifies the container type.

    +

    min_ram

    +

    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.

    +

    max_ram

    +

    String

    +

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

    +

    updated_at

    +

    String

    +

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

    +

    __os_bit

    +

    String

    +

    Specifies the OS architecture, 32 bit or 64 bit.

    +

    __os_version

    +

    String

    +

    Specifies the OS version.

    +

    __description

    +

    String

    +

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

    +

    disk_format

    +

    String

    +

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

    +

    __isregistered

    +

    String

    +

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

    +

    __platform

    +

    String

    +

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

    +

    __os_type

    +

    String

    +

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

    +

    __system__cmkid

    +

    String

    +

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

    +

    min_disk

    +

    Integer

    +

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

    +

    virtual_env_type

    +

    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.
    +

    __image_source_type

    +

    String

    +

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

    +

    __imagetype

    +

    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.
    +

    created_at

    +

    String

    +

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

    +

    virtual_size

    +

    Integer

    +

    This parameter is unavailable currently.

    +

    __originalimagename

    +

    String

    +

    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

    +

    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.

    +

    __image_size

    +

    String

    +

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

    +

    __data_origin

    +

    String

    +

    Specifies the image source.

    +

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

    +

    __root_origin

    +

    String

    +

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

    +

    __lazyloading

    +

    String

    +

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

    +

    active_at

    +

    String

    +

    Specifies the time when the image status became active.

    +

    __os_feature_list

    +

    String

    +

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

    +

    __account_code

    +

    String

    +

    Specifies the charging identifier for the image.

    +

    hw_firmware_type

    +

    String

    +

    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

    +

    String

    +

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

    +

    __support_kvm

    +

    String

    +

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

    +

    __support_xen

    +

    String

    +

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

    +

    __support_largememory

    +

    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.

    +

    For the supported OSs, see Table 4.

    +

    +

    __support_diskintensive

    +

    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.

    +

    __support_highperformance

    +

    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.

    +

    __support_xen_gpu_type

    +

    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.

    +

    __support_kvm_gpu_type

    +

    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.

    +

    __support_xen_hana

    +

    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.

    +

    __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.

    +

    enterprise_project_id

    +

    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, see Enterprise Management User Guide.

      +
    +

    __sequence_num

    +

    String

    +

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

    +

    This parameter is unavailable currently.

    +

    __support_fc_inject

    +

    String

    +

    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

    +

    String

    +

    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"
+}
+
    + +
    +
+
+

Returned Values

  • Normal

    200

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

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

    +

    401 Unauthorized

    +

    Authentication failed.

    +

    403 Forbidden

    +

    You do not have the rights to perform the operation.

    +

    404 Not Found

    +

    The requested resource was not found.

    +

    500 Internal Server Error

    +

    Internal service error.

    +

    503 Service Unavailable

    +

    The service is unavailable.

    +
    +
    +
+
+
+
+
+
Parent topic: Image
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0020092108.html b/docs/ims/api-ref/en-us_topic_0020092108.html new file mode 100644 index 000000000..132d28fae --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0020092108.html @@ -0,0 +1,120 @@ + + +

Deleting an Image (Native OpenStack API)

+

Function

This API is used to delete a private image. You can only delete your own private images.

+
+

URI

DELETE /v2/images/{image_id}

+
Table 1 lists the parameters in the URI. +
+ + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

image_id

+

Yes

+

String

+

Specifies the image ID.

+
+
+
+
+

Request

  • Request parameters +
    + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    delete_backup

    +

    No

    +

    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.

    +
    • 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
+}
+
    + +
    +
+
+

Response

  • Response parameters

    None

    +
  • Example response
    STATUS CODE 204
    +
+
+

Returned Values

  • Normal

    204

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    Request error.

    +

    401 Unauthorized

    +

    Authentication failed.

    +

    403 Forbidden

    +

    You do not have the rights to perform the operation.

    +

    404 Not Found

    +

    The requested resource was not found.

    +

    500 Internal Server Error

    +

    Internal service error.

    +

    503 Service Unavailable

    +

    The service is unavailable.

    +
    +
    +
+
+
+
+
+
Parent topic: Image (Native OpenStack APIs)
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0020092109.html b/docs/ims/api-ref/en-us_topic_0020092109.html new file mode 100644 index 000000000..0fbc19d52 --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0020092109.html @@ -0,0 +1,811 @@ + + +

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.

+

You cannot export public images (such as Windows, SUSE Linux, Red Hat Linux, 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.
+
+

URI

POST /v2/cloudimages/action

+
+

Request

  • Parameters for creating a system or data disk image from an ECS +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    name

    +

    Yes

    +

    String

    +

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

    +

    description

    +

    No

    +

    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.

    +

    instance_id

    +

    Yes

    +

    String

    +

    Specifies the ID of the ECS used to create the image.

    +

    To obtain the ECS ID, perform the following operations:

    +
    1. Log in to management console.
    2. Under Computing, click Elastic Cloud Server.
    3. In the ECS list, click the name of the ECS and view its ID.
    +

    data_images

    +

    No

    +

    Array of objects

    +

    Specifies the data disk information to be converted. This parameter is mandatory when the data disk of an ECS is used to create a private data disk image. For details, see Table 1.

    +

    If the ECS data disk is not used to create a data disk image, the parameter is empty by default.

    +
    NOTE:

    When you create a data disk image using a data disk, if other parameters (such as name, description, and tags) in this table have values, the system uses the value of data_images. You cannot specify instance_id.

    +
    +

    tags

    +

    No

    +

    Array of strings

    +

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

    +

    Use either tags or image_tags.

    +

    image_tags

    +

    No

    +

    Array of objects

    +

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

    +

    Use either tags or image_tags.

    +

    enterprise_project_id

    +

    No

    +

    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.

      +
    +

    max_ram

    +

    No

    +

    Integer

    +

    Specifies the maximum memory of the image in the unit of MB.

    +

    min_ram

    +

    No

    +

    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.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 1 Data structure description of the data_images field

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    name

    +

    Yes

    +

    String

    +

    Specifies the name of a data disk image.

    +

    volume_id

    +

    Yes

    +

    String

    +

    Specifies the data disk ID.

    +

    description

    +

    No

    +

    String

    +

    Specifies the data disk description.

    +

    tags

    +

    No

    +

    Array of strings

    +

    Specifies the data disk image tag.

    +
    +
    +
  • Parameters for creating an image using an image file uploaded to the OBS bucket +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    name

    +

    Yes

    +

    String

    +

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

    +

    description

    +

    No

    +

    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.

    +

    os_type

    +

    No

    +

    String

    +

    Specifies the OS type.

    +

    The value can be Linux, Windows, or Other.

    +

    os_version

    +

    No

    +

    String

    +

    Specifies the OS version.

    +

    This parameter is valid if an external image file uploaded to the OBS bucket is used to create an image. For its value, see Values of Related Parameters.

    +
    NOTE:

    This parameter is mandatory when the value of is_quick_import is true, that is, a system disk image is imported using the quick import method.

    +
    +

    image_url

    +

    Yes

    +

    String

    +

    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.

    +
    • To obtain an OBS bucket name:
      1. Log in to the management console and choose Storage > Object Storage Service.

        All OBS buckets are displayed in the list.

        +
      2. Filter the OBS buckets by region and locate the target bucket in the current region.
      +
    • To obtain an OBS image file name:
      1. Log in to the management console and choose Storage > Object Storage Service.

        All OBS buckets are displayed in the list.

        +
      2. Filter the OBS buckets by region and locate the target bucket in the current region.
      3. Click the name of the target bucket to go to the bucket details page.
      4. In the navigation pane on the left, choose Objects to display objects in the OBS bucket and then locate the external image file used to create an image.
      +
    +
    NOTE:

    The storage class of the OBS bucket must be Standard.

    +
    +

    min_disk

    +

    Yes

    +

    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.

    +

    is_config

    +

    No

    +

    Boolean

    +

    Specifies whether automatic configuration is enabled.

    +

    The value can be true or false.

    +

    If automatic configuration is required, set the value to true. Otherwise, set the value to false The default value is false.

    +

    For details about automatic configuration, see Creating a Linux System Disk Image from an External Image File > Registering an External Image File as a Private Image (Linux) in Image Management Service User Guide.

    +

    cmk_id

    +

    No

    +

    String

    +

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

    +

    tags

    +

    No

    +

    Array of strings

    +

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

    +

    Use either tags or image_tags.

    +

    image_tags

    +

    No

    +

    Array of objects

    +

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

    +

    type

    +

    No

    +

    String

    +

    Specifies the image type.

    +

    The value can be ECS, BMS, FusionCompute, or Ironic. The default value is ECS.

    +
    • ECS and FusionCompute: indicate an ECS image.
    • BMS and Ironic: indicate a BMS image.
    +

    enterprise_project_id

    +

    No

    +

    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.

      +
    +

    max_ram

    +

    No

    +

    Integer

    +

    Specifies the maximum memory of the image in the unit of MB.

    +

    min_ram

    +

    No

    +

    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.

    +

    data_images

    +

    No

    +

    Array of objects

    +

    Specifies the data disk information to be imported.

    +

    An external image file can contain a maximum of three data disks. In this case, one system disk and three data disks will be created.

    +

    For details, see Table 2.

    +
    NOTE:
    • If a data disk image file is used to create a data disk image, the OS type of the data disk image must be the same as that of the system disk image.
    • If other parameters (such as name, description, and tags) in Table 2 are set, the system uses the values in data_images.
    +
    +

    is_quick_import

    +

    No

    +

    Boolean

    +

    Specifies whether to use the quick import method to import a system disk image.

    +
    • If yes, set the value to true.
    • If no, set the value to false.
    +

    For details about the restrictions on quick import of image files, see Importing an Image File Quickly.

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

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    name

    +

    No

    +

    String

    +

    Specifies the image name.

    +

    For more details, see Image Attributes.

    +

    description

    +

    No

    +

    String

    +

    Specifies the image description. The value 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.

    +

    image_url

    +

    Yes

    +

    String

    +

    Specifies the URL of the external image file in the OBS bucket.

    +

    The format is OBS bucket name:Image file name.

    +
    • To obtain an OBS bucket name:
      1. Log in to the management console and choose Storage > Object Storage Service.

        All OBS buckets are displayed in the list.

        +
      2. Filter the OBS buckets by region and locate the target bucket in the current region.
      +
    • To obtain an OBS image file name:
      1. Log in to the management console and choose Storage > Object Storage Service.

        All OBS buckets are displayed in the list.

        +
      2. Filter the OBS buckets by region and locate the target bucket in the current region.
      3. Click the name of the target bucket to go to the bucket details page.
      4. In the navigation pane on the left, choose Objects to display objects in the OBS bucket and then locate the external image file used to create an image.
      +
    +
    NOTE:

    The storage class of the OBS bucket must be Standard.

    +
    +

    min_disk

    +

    Yes

    +

    Integer

    +

    Specifies the minimum size of the data disk.

    +

    Unit: GB

    +

    Value range: 1–2048

    +

    is_quick_import

    +

    No

    +

    Boolean

    +

    Specifies whether an image file is imported quickly to create a data disk image.

    +
    • If yes, set the value to true.
    • If no, set the value to false.
    +

    For details about the restrictions on quick import of image files, see Importing an Image File Quickly.

    +

    tags

    +

    No

    +

    Array of strings

    +

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

    +

    For detailed parameter descriptions, see Image Tag Data Formats.

    +

    Use either tags or image_tags.

    +

    image_tags

    +

    No

    +

    Array of objects

    +

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

    +

    For detailed parameter descriptions, see Image Tag Data Formats.

    +

    Use either tags or image_tags.

    +
    +
    +
  • Parameters for creating a system disk image using a data disk +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    name

    +

    Yes

    +

    String

    +

    Specifies the name of the system disk image.

    +

    For more details, see Image Attributes.

    +

    volume_id

    +

    Yes

    +

    String

    +

    Specifies the data disk ID.

    +

    os_version

    +

    Yes

    +

    String

    +

    Specifies the OS version.

    +

    Set the parameter value based on Values of Related Parameters. Otherwise, the created system disk image may be unavailable.

    +

    During the creation of a system disk image, if the OS can be detected from the data disk, the OS version in the data disk is used. In this case, the os_version value is invalid. If the OS can be detected from the data disk, the os_version value is used.

    +

    type

    +

    No

    +

    Sting

    +

    Specifies the image type.

    +

    The value can be ECS, BMS, FusionCompute, or Ironic.

    +
    • ECS and FusionCompute: indicates an ECS image.
    • BMS and Ironic: indicates a BMS image.
    +

    The default value is ECS.

    +

    description

    +

    No

    +

    String

    +

    Specifies the image description. This parameter is left blank by default. For details, see Image Attributes.

    +

    The image description must meet the following requirements:

    +
    • Contains only letters and digits.
    • Cannot contain carriage returns and angle brackets (< >).
    • Cannot exceed 1024 characters.
    +

    min_ram

    +

    No

    +

    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.

    +

    max_ram

    +

    No

    +

    Integer

    +

    Specifies the maximum memory size (MB) required for running the image.

    +

    The parameter value depends on the ECS specifications. The default value is 0.

    +

    tags

    +

    No

    +

    Array of strings

    +

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

    +

    Use either tags or image_tags.

    +

    image_tags

    +

    No

    +

    Array of objects

    +

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

    +

    Use either tags or image_tags.

    +

    enterprise_project_id

    +

    No

    +

    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.

      +
    +
    +
    +
  • Example requests
    • Request for creating a system disk image with parameter tags using an ECS
      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",
+    "tags": [
+        "aaa.111",
+        "bbb.333",
+        "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"
+              ]
+       }]
+}
+
      + +
      +
    • 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"  
+      ]     
+}
+
      + +
      +
    +
    • Request for creating a system disk image with parameter image_tags using an ECS
      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",
+    "image_tags": [
+{
+            "key": "key2",
+            "value": "value2"
+        },
+{
+            "key": "key1",
+            "value": "value1"
+}
+         ]
+}
      +
    • 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"}]
+       }]
+}
+
      + +
      +
    • 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"}]    
+}
+
      + +
      +
    • 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"}] 
+ } 
+
      + +
      +
    +
+
+

Response

  • Response parameters +
    + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    job_id

    +

    String

    +

    Specifies the asynchronous job ID.

    +

    For details, see Asynchronous Job Query.

    +
    +
    +
  • Example response
    STATUS CODE 200
    +
    1
+2
+3
    {
+    "job_id": "8a12fc664fb4daa3014fb4e581380005"
+}
+
    + +
    +
+
+

Returned Values

  • Normal

    200

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

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

    +

    401 Unauthorized

    +

    Authentication failed.

    +

    403 Forbidden

    +

    You do not have the rights to perform the operation.

    +

    404 Not Found

    +

    The requested resource was not found.

    +

    500 Internal Server Error

    +

    Internal service error.

    +

    503 Service Unavailable

    +

    The service is unavailable.

    +
    +
    +
+
+
+
+
+
Parent topic: Image
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0020092110.html b/docs/ims/api-ref/en-us_topic_0020092110.html new file mode 100644 index 000000000..77e2d2eeb --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0020092110.html @@ -0,0 +1,20 @@ + + +

Image Tag Data Formats

+

Description

You can attach a custom tag to a private image to facilitate private image management.

+
+

Data Formats

Data format of tag
  • The data format is key.value. If a key is added, a tag is added. In other cases, the tag is modified.
  • The tag key can contain a maximum of 36 characters, and the tag value can contain a maximum of 43 characters. The tag value can be an empty character string.
  • The tag can contain only digits, letters, underscores (_), and hyphens (-).
+
+
Data format of image_tags
  • The data format is {"key": "keyA", "value": "valueA"}. If the added key A exists, the tag is updated.
  • The tag key can contain a maximum of 36 characters, and the tag value can contain a maximum of 43 characters. The tag value can be an empty character string.
  • If the first and last characters of the tag key and value are spaces, the system deletes the space by default.
+
+
+

Data Formats (Native OpenStack)

Data format of tag
  • The data format is key. If a key is added, a tag is added. In other cases, the tag is modified.
  • The tag key can contain a maximum of 255 characters.
  • The tag can contain only digits, letters, underscores (_), and hyphens (-).
+
+
+
+
+
+
Parent topic: Common Parameters
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0020092111.html b/docs/ims/api-ref/en-us_topic_0020092111.html new file mode 100644 index 000000000..652e0d499 --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0020092111.html @@ -0,0 +1,101 @@ + + +

Adding a Tag (Native OpenStack API)

+

Function

This API is used to add a custom tag to an image. With tags, you can manage easily the images.

+
+

URI

PUT /v2/images/{image_id}/tags/{tag}

+
Table 1 lists the parameters in the URI. +
+ + + + + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

image_id

+

Yes

+

String

+

Specifies the image ID.

+

tag

+

Yes

+

String

+

Specifies the tag to be added.

+

The tag can contain only digits, letters, underscores (_), and hyphens (-).

+
NOTE:

This API can only be used to add a tag key. To add a tag value, use the PUT /v1/cloudimages/tags API. For details, see Adding or Modifying a Tag.

+
+
+
+
+
+

Request

  • Request parameters

    None

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

Response

  • Response parameters

    None

    +
  • Example response
    STATUS CODE 204
    +
+
+

Returned Values

  • Normal

    204

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    Request error.

    +

    401 Unauthorized

    +

    Authentication failed.

    +

    403 Forbidden

    +

    You do not have the rights to perform the operation.

    +

    404 Not Found

    +

    The requested resource was not found.

    +

    500 Internal Server Error

    +

    Internal service error.

    +

    503 Service Unavailable

    +

    The service is unavailable.

    +
    +
    +
+
+
+
+
+
Parent topic: Image Tagging (Native OpenStack APIs)
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0020507759.html b/docs/ims/api-ref/en-us_topic_0020507759.html new file mode 100644 index 000000000..a5b3af318 --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0020507759.html @@ -0,0 +1,8 @@ + + +

API Usage Guidelines

+

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 Resource Identifiers (URIs). An application accesses a resource based on the resource's Unified Resource Locator (URL). A URL is usually in the following format: https://Endpoint/uri. In the URL, uri indicates the resource path, that is, the API access path.

+

Public cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted using JSON messages, with the media type represented by Application/json.

+

For details about how to use APIs, see API Usage Guidelines.

+
+ diff --git a/docs/ims/api-ref/en-us_topic_0022473688.html b/docs/ims/api-ref/en-us_topic_0022473688.html new file mode 100644 index 000000000..d6d103b27 --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0022473688.html @@ -0,0 +1,392 @@ + + +

Asynchronous Job Query

+

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}

+
Table 1 lists the parameters in the URI. +
+ + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID.

+

job_id

+

Yes

+

Specifies the asynchronous job ID.

+
+
+
+
+

Request

  • Request parameters

    None

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

Response

  • Response parameters +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    status

    +

    String

    +

    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

    +

    String

    +

    Specifies the job ID.

    +

    job_type

    +

    String

    +

    Specifies the job type.

    +

    begin_time

    +

    String

    +

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

    +

    end_time

    +

    String

    +

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

    +

    error_code

    +

    String

    +

    Specifies the error code.

    +

    fail_reason

    +

    String

    +

    Specifies the failure cause.

    +

    entities

    +

    Object

    +

    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

    +

    Type

    +

    Description

    +

    image_id

    +

    String

    +

    Specifies the image ID.

    +

    current_task

    +

    String

    +

    Specifies the job name.

    +

    image_name

    +

    String

    +

    Specifies the image name.

    +

    process_percent

    +

    Double

    +

    Specifies the job progress.

    +

    results

    +

    Array of result objects

    +

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

    +

    sub_jobs_result

    +

    Array of SubJobResult objects

    +

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

    +

    sub_jobs_list

    +

    Array of string

    +

    Specifies the sub-job IDs.

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

    Parameter

    +

    Type

    +

    Description

    +

    image_id

    +

    String

    +

    Specifies the image ID.

    +

    project_id

    +

    String

    +

    Specifies the project ID.

    +

    status

    +

    String

    +

    Specifies the job status.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 4 Data structure description of the SubJobResult field

    Parameter

    +

    Type

    +

    Description

    +

    status

    +

    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.
    +

    job_id

    +

    String

    +

    Specifies a sub-job ID.

    +

    job_type

    +

    String

    +

    Specifies the sub-job type.

    +

    begin_time

    +

    String

    +

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

    +

    end_time

    +

    String

    +

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

    +

    error_code

    +

    String

    +

    Specifies the error code.

    +

    fail_reason

    +

    String

    +

    Specifies the failure cause.

    +

    entities

    +

    Object SubJobEntities

    +

    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

    +

    Type

    +

    Description

    +

    image_id

    +

    String

    +

    Specifies the image ID.

    +

    image_name

    +

    String

    +

    Specifies the image name.

    +
    +
    +
+
  • 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
    {
+    "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

    +

    Description

    +

    400 Bad Request

    +

    Request error.

    +

    401 Unauthorized

    +

    Authentication failed.

    +

    403 Forbidden

    +

    You do not have the rights to perform the operation.

    +

    500 Internal Server Error

    +

    Internal service error.

    +

    503 Service Unavailable

    +

    The service is unavailable.

    +
    +
    +
+
+
+
+
+
Parent topic: Image Jobs
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0022473689.html b/docs/ims/api-ref/en-us_topic_0022473689.html new file mode 100644 index 000000000..35bdb8bee --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0022473689.html @@ -0,0 +1,1989 @@ + + +

Error Codes

+

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
+
1
+2
+3
+4
+5
+6
{
+    "error": {
+        "message": "The imagetype is invalid.",
+        "code": "IMG.0024"
+    }
+}
+
+ +
+
+

Error Message Description

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Error codes

Status Code

+

Error Code

+

Message

+

Description

+

Handling Measure

+

400

+

IMG.0001

+

The request message format is invalid.

+

The request message format is invalid.

+

Use the correct format.

+

400

+

IMG.0002

+

The image name contains more than 128 characters.

+

The image name contains more than 128 characters.

+

Reduce the length of the image name.

+

400

+

IMG.0003

+

The image name format is invalid.

+

The image name format is invalid.

+

Check whether the image name is valid.

+

400

+

IMG.0004

+

The description contains more than 1024 characters.

+

The image name contains more than 1024 characters.

+

Reduce the length of the image description to within 1024 characters.

+

400

+

IMG.0005

+

The ECS does not exist.

+

The ECS does not exist.

+

Check whether the ECS exists.

+

400

+

IMG.0006

+

The ECS system disk cannot be used to create an image.

+

The system disk of the ECS cannot be used to create an image.

+

Check the system disk status of the ECS.

+

400

+

IMG.0007

+

The request body is empty.

+

The message body is empty.

+

Check whether the message body is valid.

+

400

+

IMG.0008

+

The ECS cannot be used to create images because it is not in stopped state.

+

The ECS cannot be used to create an image because it is not in the Stopped state.

+

Stop the ECS and try again.

+

400

+

IMG.0009

+

The image name already exists.

+

The image name already exists.

+

Change another image name.

+

400

+

IMG.0010

+

The ECS cannot be used to create an image because it has in-progress tasks.

+

The ECS cannot be used to create an image because it has in-progress tasks.

+

Try again after the tasks are complete.

+

400

+

IMG.0011

+

forceCreate must be set to true.

+

forceCreate must be set to true.

+

Set forceCreate to true.

+

400

+

IMG.0012

+

The ECS ID is not specified.

+

The ECS ID is invalid.

+

Enter a valid ECS ID.

+

400

+

IMG.0013

+

The image name is not specified.

+

The image name is not specified.

+

Enter a valid image name.

+

400

+

IMG.0014

+

An exception occurred when IaaS OpenStack was executing the task.

+

An exception occurred when IaaS OpenStack was executing the task.

+

Contact technical support.

+

400

+

IMG.0015

+

The number of private images has reached the maximum allowed.

+

The number of private images has reached the quota.

+

Increase the quota or delete existing images.

+

400

+

IMG.0016

+

An error occurred when the request body was deleted.

+

An error occurred when the request body was deleted.

+

Contact technical support.

+

400

+

IMG.0017

+

The URL format is incorrect.

+

The URL format is incorrect.

+

Check whether the URL format is valid.

+

400

+

IMG.0018

+

An error occurred when the job was submitted.

+

An error occurred when the job was submitted.

+

Contact technical support.

+

400

+

IMG.0019

+

The backup ID is not specified.

+

The backup ID is not specified.

+

Check whether the current backup ID is valid.

+

400

+

IMG.0020

+

The backup does not exist.

+

The backup does not exist.

+

Check whether the backup file exists.

+

400

+

IMG.0021

+

The resource type is unknown.

+

The source type is unknown.

+

Select a correct source type.

+

400

+

IMG.0022

+

The disk in the current state cannot be used to create images.

+

A disk in the current state cannot be used to create images.

+

Check the disk status.

+

400

+

IMG.0023

+

An exception occurred during task query.

+

An exception occurred during job query.

+

Contact technical support.

+

400

+

IMG.0024

+

The image type in the request is incorrect.

+

The image type in the request is incorrect.

+

Select either BMS or ECS.

+

400

+

IMG.0025

+

The user type in the request is incorrect.

+

The user type in the request is incorrect.

+

Check whether the user type is valid.

+

400

+

IMG.0026

+

The role is invalid. You need to apply for the required permissions or pass the real-name authentication.

+

You do not have the rights to perform the operation.

+

Contact technical support.

+

400

+

IMG.0027

+

The image ID in the request does not exist.

+

The image ID in the request does not exist.

+

Use a valid image ID.

+

400

+

IMG.0028

+

The image in the request is protected.

+

The image in the request is protected.

+

Contact technical support.

+

400

+

IMG.0029

+

The backup in the request has already been used to create an image.

+

The backup in the request has already been used to create an image.

+

Select another backup that has not been used.

+

400

+

IMG.0030

+

The project ID and token in the request are invalid.

+

The project ID and token in the request are invalid.

+

Enter a correct project ID and token.

+

400

+

IMG.0031

+

The resource ID in the request is incorrect.

+

The resource ID in the request is incorrect.

+

Use a valid image ID.

+

400

+

IMG.0032

+

The backup is unavailable.

+

The backup is unavailable.

+

Check whether the backup is available.

+

400

+

IMG.0033

+

The backup is not a system disk backup.

+

The backup is not a system disk backup.

+

Check whether the backup is a system disk backup.

+

400

+

IMG.0034

+

The number of images cannot be modified.

+

The number of images cannot be modified.

+

Contact technical support.

+

400

+

IMG.0035

+

An attribute conflict occurred during the modification.

+

An attribute conflict occurred during the modification.

+

Contact technical support.

+

400

+

IMG.0036

+

An error occurred when the value of asumeToken was obtained.

+

An error occurred when the value of asumeToken was obtained.

+

Contact technical support.

+

400

+

IMG.0037

+

An error occurred in the AK/SK was obtained.

+

An error occurred in the AK/SK was obtained.

+

Contact technical support.

+

400

+

IMG.0038

+

An error occurred when the bucket was created.

+

An error occurred when the bucket was created.

+

Contact technical support.

+

400

+

IMG.0039

+

An error occurred when read and write permissions of the bucket were granted to a specified user.

+

An error occurred when read and write permissions of the bucket were granted to a specified user.

+

Contact technical support.

+

400

+

IMG.0040

+

An error occurred in the object storage address was obtained.

+

An error occurred in the object storage address was obtained.

+

Contact technical support.

+

400

+

IMG.0041

+

The authorized account is empty.

+

The authorized account is empty.

+

Use a valid account.

+

400

+

IMG.0045

+

Failed to generate the image product code.

+

Failed to generate the image product code.

+

Contact technical support.

+

400

+

IMG.0046

+

The image is unavailable.

+

The image is unavailable.

+

Check the image status.

+

400

+

IMG.0047

+

This operation can be performed only by the image owner.

+

This operation can be performed only by the image owner.

+

Check whether you have the permission to operate the image.

+

400

+

IMG.0053

+

An error occurred when the domain information of the shadow account was obtained.

+

An error occurred when the domain information of the shadow account was obtained.

+

Contact technical support.

+

400

+

IMG.0054

+

The image description format is invalid.

+

The image description format is invalid.

+

Check the image description. It can contain no more than 1024 characters that consist of only letters and digits. Spaces and angle brackets (< >) are not allowed.

+

400

+

IMG.0055

+

The memory or disk size is invalid.

+

The memory or disk size is invalid.

+

Check the memory (MB) or disk size (GB) supported by the image.

+

400

+

IMG.0056

+

The OS type is invalid.

+

The OS type is invalid.

+

Select Windows or Linux.

+

400

+

IMG.0057

+

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

+

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

+

Select a valid image file.

+

400

+

IMG.0058

+

The region of the bucket where the image file is stored is inconsistent with that of the user.

+

The region of the bucket where the image file is stored is inconsistent with that of the user.

+

Ensure that the bucket where the image is stored is in region as the user.

+

400

+

IMG.0059

+

The size of the image file exceeds the maximum allowed.

+

The size of the image file exceeds the maximum allowed.

+

Check whether the size of the image file is less than or equal to 128 GB.

+

400

+

IMG.0060

+

The number of tasks exceeds the flow control limit.

+

The number of tasks exceeds the flow control limit.

+

Wait for a while and then try again.

+

400

+

IMG.0061

+

Unknown system error.

+

Unknown system error.

+

Contact technical support.

+

400

+

IMG.0062

+

The image name is incorrect.

+

The image name is incorrect.

+

Check whether the image name is valid.

+

400

+

IMG.0063

+

The VM type does not support image creation.

+

The ECS type does not support image creation.

+

Select an ECS that supports image creation.

+

400

+

IMG.0064

+

Failed to obtain tenant information from IAM.

+

Failed to obtain tenant information from IAM.

+

Contact technical support.

+

400

+

IMG.0065

+

Failed to obtain the tenant domain from IAM.

+

Failed to obtain the tenant domain from IAM.

+

Contact technical support.

+

400

+

IMG.0066

+

The image ID is incorrect.

+

The image ID is incorrect.

+

Enter a correct image ID.

+

400

+

IMG.0067

+

The project ID is incorrect.

+

The project ID is incorrect.

+

Enter a correct project ID.

+

400

+

IMG.0068

+

The specified bucket name is empty.

+

The specified bucket name is empty.

+

Check whether the specified bucket name is empty and enter a correct bucket name.

+

400

+

IMG.0069

+

The specified bucket cannot be accessed.

+

The specified bucket cannot be accessed.

+

Contact technical support.

+

400

+

IMG.0070

+

The image file already exists. Confirm the file in the corresponding directory of the OBS bucket or in the OBS bucket.

+

The image file already exists.

+

Check whether the file exists in the corresponding directory of the OBS bucket or in the OBS bucket.

+

400

+

IMG.0071

+

The image cannot be exported.

+

The image cannot be exported.

+

Select another image.

+

400

+

IMG.0072

+

The specified image format is not supported.

+

The specified image format is not supported.

+

Check the image format. Only VHD, RAW, ZVHD, and QCOW2 are supported. The default format is VHD.

+

400

+

IMG.0073

+

The name of the exported file is empty.

+

The name of the exported file is empty.

+

Enter a correct file name.

+

400

+

IMG.0074

+

The file name length exceeds the limit.

+

The file name length exceeds the limit.

+

Reduce the length of the file name.

+

400

+

IMG.0075

+

The file name contains invalid characters.

+

The file name contains invalid characters.

+

Ensure that the image file name meets the following requirements:

+
  • The name cannot start or end with space.
  • The name contains 1 to 128 characters.
  • The name contains the following four types of characters:
  • Uppercase letters
  • Lowercase letters
  • Digits
  • Special characters, including hyphens (-), periods (.), underscores (_), and space
+

400

+

IMG.0076

+

You cannot share an image with yourself.

+

You cannot share an image with yourself.

+

Do not share images with yourself.

+

400

+

IMG.0077

+

The public image cannot be exported.

+

The public image cannot be exported.

+

Select another image.

+

400

+

IMG.0079

+

The system disk image created from a charged image cannot be exported.

+

A system disk image created from a charged image cannot be exported.

+

Select another image.

+

400

+

IMG.0080

+

The image created from a CSBS or CBR backup cannot be exported.

+

The image created from a CSBS backup cannot be exported.

+

Export the image after the backup is created.

+

400

+

IMG.0081

+

The image cannot be exported because it is created from an image file.

+

The image cannot be exported because it is created from an image file.

+

Select another image.

+

400

+

IMG.0083

+

The image is a public image.

+

The image is a public image.

+

-

+

400

+

IMG.0084

+

The image is a private image.

+

The image is a private image.

+

-

+

400

+

IMG.0085

+

The publishing mode is incorrect.

+

The publishing mode is incorrect.

+

-

+

400

+

IMG.0086

+

No image was found.

+

No image was found.

+

Check whether the image exists.

+

400

+

IMG.0087

+

The token is incorrect.

+

The token is incorrect.

+

Enter a correct token.

+

400

+

IMG.0088

+

The number of shared images has reached the maximum allowed.

+

The number of shared images has reached the quota.

+

Increase the quota.

+

400

+

IMG.0089

+

The public image cannot be shared.

+

A public image cannot be shared.

+

Check the constraints of image sharing.

+

400

+

IMG.0090

+

The image being created cannot be deleted.

+

An image being created cannot be deleted.

+

Delete the image after the image is created.

+

400

+

IMG.0092

+

The image can only be deleted by the owner.

+

The image can only be deleted by the owner.

+

Ask the image owner to delete the image.

+

400

+

IMG.0094

+

The public image cannot be deleted.

+

The public image cannot be deleted.

+

Do not delete public images.

+

400

+

IMG.0095

+

The KMS key does not exist.

+

The key does not exist.

+

Check whether the key exists.

+

400

+

IMG.0096

+

The specified KMS key ID must be different from the image key ID.

+

The specified KMS key ID must be different from the image key ID.

+

Check whether the specified KMS key ID is the same as the image key ID.

+

400

+

IMG.0097

+

The key is not enabled.

+

The key is not enabled.

+

Enable the key.

+

400

+

IMG.0098

+

The encrypted image cannot be shared.

+

An encrypted image cannot be shared.

+

Copy the image to a non-encrypted image and then share the non-encrypted image.

+

400

+

IMG.0099

+

You do not have the permission to access the key.

+

You do not have the permission to access the key.

+

Check whether you have the permission to access the key.

+

400

+

IMG.0100

+

You do not have OBT permission for KMS.

+

You do not have OBT permission for KMS.

+

Check whether you have the OBT permission for KMS.

+

400

+

IMG.0101

+

The original key does not exist.

+

The original key does not exist.

+

Check whether the key is valid.

+

400

+

IMG.0102

+

The original key is not enabled.

+

The original key is not enabled.

+

Enable the original key.

+

400

+

IMG.0103

+

You do not have the permission to access the original key.

+

You do not have the permission to access the original key.

+

Check whether you have the permission to access the key.

+

400

+

IMG.0104

+

Enter the project name if there are multiple projects in the same region.

+

Enter the project name if there are multiple projects in the same region.

+

Enter the project name.

+

400

+

IMG.0105

+

The operation is not supported.

+

The operation is not supported.

+

Contact technical support.

+

400

+

IMG.0106

+

The image owner is another tenant.

+

The image owner is another tenant.

+

Confirm the image owner.

+

400

+

IMG.0108

+

The tenant ID was not found in the current region.

+

The tenant ID was not found in the current region.

+

Contact technical support.

+

400

+

IMG.0109

+

The bucket name contains invalid characters.

+

The bucket name contains invalid characters.

+

Check whether the bucket name is valid.

+

400

+

IMG.0110

+

The system disk is unavailable and cannot be used to create images.

+

The system disk is unavailable and cannot be used to create images.

+

Create an image when the system disk is available.

+

400

+

IMG.0111

+

The size of the system disk exceeds the maximum allowed.

+

The size of the system disk exceeds the maximum allowed.

+

Ensure that the ECS system disk size is greater than or equal to the system disk size of the image and smaller than 1024 GB.

+

400

+

IMG.0112

+

Failed to add the tenant.

+

Failed to add the tenant.

+

Contact technical support.

+

400

+

IMG.0113

+

Failed to delete the tenant.

+

Failed to delete the tenant.

+

Contact technical support.

+

400

+

IMG.0114

+

Failed to query the tenant details.

+

Failed to query the tenant details.

+

Contact technical support.

+

400

+

IMG.0115

+

The image tag is invalid.

+

The image tag is invalid.

+

Check the validity of the image tag.

+

400

+

IMG.0116

+

The number of image tags exceeds the quota.

+

The number of image tags exceeds the quota.

+

Delete tags that are unnecessary or not in use.

+

400

+

IMG.0117

+

The image source can only be BMS or ECS.

+

The image type can only be BMS or ECS.

+

Select a BMS or ECS as the image source.

+

400

+

IMG.0118

+

The BMS image does not support KMS encryption.

+

The BMS image does not support KMS encryption.

+

Modify the BMS image configuration.

+

400

+

IMG.0119

+

The VM does not have a system disk.

+

The ECS does not have a system disk.

+

Attach a system disk to the ECS.

+

400

+

IMG.0120

+

The specified data disk ID is unavailable.

+

The specified data disk ID is unavailable.

+

Check whether the current data disk ID is valid.

+

400

+

IMG.0121

+

The object cannot be found.

+

The object cannot be found.

+

Check whether the object exists.

+

400

+

IMG.0122

+

The OS type is invalid.

+

The OS type is invalid.

+

Select an OS supported by IMS.

+

400

+

IMG.0123

+

The image file address in the request is duplicate.

+

The image file address in the request is duplicate.

+

Delete the duplicate image file address.

+

400

+

IMG.0125

+

The data disk image cannot be converted to a public image.

+

The data disk image cannot be published as a public image.

+

Check the constraints on data disk images.

+

400

+

IMG.0126

+

The VM in the current stage cannot be used to create a full-ECS image.

+

The ECS in the current status cannot be used to create a full-ECS image.

+

Check the ECS status. Ensure that the ECS is in the Running or Stopped state.

+

400

+

IMG.0127

+

The CSBS backup does not exist.

+

The CSBS backup does not exist.

+

Check whether the CSBS backup exists.

+

400

+

IMG.0128

+

The full-ECS image cannot be exported.

+

A full-ECS image cannot be exported.

+

Check the constraints on image export.

+

400

+

IMG.0130

+

The full-ECS image cannot be exported or replicated.

+

A full-ECS image cannot be exported or replicated.

+

Check the constraints on full-ECS images.

+

400

+

IMG.0132

+

The CSBS backup in the current state cannot be used to create a full-ECS image.

+

A CSBS backup in the current state cannot be used to create a full-ECS image.

+

Wait until the CSBS backup becomes available.

+

400

+

IMG.0133

+

You are not allowed to access the CSBS backup.

+

You are not allowed to access the CSBS backup.

+

Apply for the permissions.

+

400

+

IMG.0134

+

The CSBS backup has been registered as an image.

+

The CSBS backup has been registered as an image.

+

A CSBS backup can be used to create only one full-ECS image. Select another CSBS backup.

+

400

+

IMG.0135

+

The full-ECS image cannot be shared.

+

A full-ECS image cannot be shared.

+

Check the constraints of image sharing.

+

400

+

IMG.0136

+

Failed to create a full-ECS image because the ECS is being backed up.

+

Failed to create a full-ECS image because a backup is being created for the ECS.

+

Wait until the CSBS backup or CBR backup becomes available.

+

400

+

IMG.0137

+

Failed to obtain the VM information.

+

Failed to obtain the ECS information.

+

Check whether the ECS ID is correct and whether you have the permission to perform operations on the ECS.

+

400

+

IMG.0138

+

Failed to obtain the OS type information.

+

Failed to obtain the OS type information.

+

Contact technical support.

+

400

+

IMG.0139

+

Other disks on the VM are being used to created VMs.

+

Other disks on the ECS are being used to create ECSs.

+

Contact technical support.

+

400

+

IMG.0140

+

The disks in the request come from different ECSs.

+

The disks in the request are from different ECSs.

+

Ensure that the ECS to which the disks are attached is the same.

+

400

+

IMG.0141

+

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.

+

400

+

IMG.0144

+

The image does not exist.

+

The image does not exist.

+

Check whether the image exists.

+

400

+

IMG.0145

+

The project name is incorrect.

+

The project name is incorrect.

+

Enter a correct project name.

+

400

+

IMG.0148

+

The image is being exported.

+

The image is being exported.

+

Wait until the image is exported.

+

400

+

IMG.0153

+

DESS or DSS disks cannot be used to create images.

+

DESS or DSS disks cannot be used to create images.

+

Select another ECS.

+

400

+

IMG.0154

+

Failed to communicate with Enterprise Project Management Service (EPS).

+

Failed to communicate with EPS.

+

Contact technical support.

+

400

+

IMG.0155

+

Failed to check the enterprise project ID validity.

+

Failed to check the enterprise project ID validity.

+

Contact technical support.

+

400

+

IMG.0156

+

Failed to associate the image with the enterprise project ID.

+

Failed to associate the image with the enterprise project ID.

+

Contact technical support.

+

400

+

IMG.0160

+

Only images less than 128 GB can be exported.

+

Only images smaller than 128 GB can be exported.

+

Images larger than 128 GB cannot be exported.

+

400

+

IMG.0161

+

You do not have permission.

+

No OBT permissions for displaying the vendor name.

+

Contact technical support.

+

400

+

IMG.0162

+

The value contains a maximum of 12 characters that consist of letters and spaces, and cannot start or end with a space

+

The value contains a maximum of 12 characters that consist of letters and spaces, and cannot start or end with a space.

+

Check whether the vendor name is valid.

+

400

+

IMG.0163

+

This image cannot be titled by vendors. Only images running a Windows OS booted in BIOS mode can be titled by vendors.

+

This image cannot be titled by vendors.

+

Contact technical support.

+

400

+

IMG.0164

+

Failed to create an image because the spot ECS is being reclaimed.

+

Failed to create an image because the spot ECS is being reclaimed.

+

Failed to create an image because the spot ECS is being reclaimed.

+

400

+

IMG.0165

+

You do not have permission to access the CSBS backup.

+

You do not have permission to access the CSBS backup.

+

Contact technical support.

+

400

+

IMG.0166

+

OS information must be contained in the ISO files used to create images.

+

OS version information must be contained when an ISO file is used to create an image.

+

OS version information must be contained when an ISO file is used to create an image.

+

400

+

IMG.0167

+

This operation cannot be performed for ISO images.

+

The ISO image does not support this function.

+

Contact technical support.

+

400

+

IMG.0168

+

Data disk images cannot be updated.

+

Data disk images cannot be updated.

+

Contact technical support.

+

400

+

IMG.0169

+

Failed to update the image because the OS versions are different.

+

Failed to update the image because the OS versions are different.

+

Contact technical support.

+

400

+

IMG.0170

+

Failed to update the image because the image formats are different.

+

Failed to update the image because the image formats are different.

+

Contact technical support.

+

400

+

IMG.0171

+

Failed to update the image because the minimum disk space is less than that of the source image.

+

Failed to update the image because the minimum disk space is less than that of the source image.

+

Contact technical support.

+

400

+

IMG.0172

+

Failed to update the image because the minimum memory is less than that of the source image.

+

Failed to update the image because the minimum memory is less than that of the source image.

+

Contact technical support.

+

400

+

IMG.0173

+

Failed to update the image because the image environment types are different.

+

Failed to update the image because the image environment types are different.

+

Contact technical support.

+

400

+

IMG.0174

+

Failed to update the image because the name of the source image is different from that of the target image.

+

Failed to update the image because the name of the source image is different from that of the target image.

+

Contact technical support.

+

400

+

IMG.0175

+

The folder name and image file name cannot contain spaces.

+

The folder name and image file name cannot contain spaces.

+

Check whether the file name is valid.

+

400

+

IMG.0176

+

Failed to delete the full-ECS backup.

+

Failed to delete the full-ECS backup.

+

Contact technical support.

+

400

+

IMG.0177

+

The source and target tenants reside in different regions.

+

The source and target tenants reside in different regions.

+

Check whether the source and target tenants reside in the same region.

+

400

+

IMG.0178

+

The target tenant is the same as the source tenant.

+

The target tenant is the same as the source tenant.

+

The target tenant cannot be the same as the source tenant. Please check.

+

400

+

IMG.0179

+

The token of the source image agency is invalid.

+

The token of the source image agency is invalid.

+

Contact technical support.

+

400

+

IMG.0180

+

CBR does not support full-ECS image creation.

+

CBR does not support full-ECS image creation.

+

Contact technical support.

+

400

+

IMG.0181

+

Failed to obtain ECSs that can be protected.

+

Failed to obtain ECSs that can be protected.

+

Contact technical support.

+

400

+

IMG.0182

+

Insufficient vault capacity. Please expand the capacity.

+

Insufficient vault capacity. Please expand the capacity.

+

Check whether the vault capacity is sufficient.

+

400

+

IMG.0183

+

The ECS can only be associated with one vault.

+

The ECS can only be associated with one vault.

+

Ensure that the resource is not associated with any other vault.

+

400

+

IMG.0184

+

Failed to obtain the vault.

+

Failed to obtain the vault.

+

Check whether the vault exists.

+

400

+

IMG.0185

+

The number of ECSs associated with the vault has reached the upper limit.

+

The number of ECSs associated with the vault has reached the upper limit.

+

Create another vault or delete unused resources.

+

400

+

IMG.0186

+

The ECS is associated with the CSBS service.

+

The ECS is associated with the CSBS service.

+

Contact technical support.

+

400

+

IMG.0187

+

KMS access traffic has reached the upper limit.

+

KMS access traffic has reached the upper limit.

+

Contact technical support.

+

400

+

IMG.0188

+

Vault is unavailable.

+

Vault is unavailable.

+

Contact technical support.

+

400

+

IMG.0189

+

The target CBR vault does not support image replication.

+

The target CSBS vault does not support image replication.

+

Contact technical support.

+

400

+

IMG.0190

+

Full-ECS images can be created only from CBR backups.

+

Full-ECS images can be created only from CBR backups.

+

Contact technical support.

+

400

+

IMG.0191

+

Failed to query ECS flavors.

+

Failed to query ECS flavors.

+

Contact technical support.

+

400

+

IMG.0192

+

The flavor used to query images is invalid.

+

The flavor used to query images is invalid.

+

Contact technical support.

+

400

+

IMG.0193

+

The vault is not a cloud server backup vault.

+

The vault is not a CBR backup vault.

+

Check that the vault is a CBR backup vault.

+

400

+

IMG.0194

+

The maximum number of images that can be imported at one time has been reached.

+

The maximum number of images that can be imported at one time has been reached.

+

Contact technical support.

+

400

+

IMG.0195

+

Full-ECS images created from CBR backups must contain an OS.

+

Full-ECS images created from CBR backups must contain the OS version.

+

Specify the OS version.

+

400

+

IMG.0196

+

The image cannot be replicated because it is not accepted by the recipient.

+

The image cannot be replicated because it is not accepted by the recipient.

+

Accept the shared image.

+

400

+

IMG.0197

+

Failed to replicate the shared image because it is encrypted using KMS.

+

Failed to replicate the shared image because it is encrypted using KMS.

+

Shared encrypted images cannot be replicated.

+

400

+

IMG.0198

+

Backup ID does not match the backup type or does not exist.

+

Backup ID does not match the backup type or the backup does not exist.

+

Check whether the backup ID matches the backup type.

+

400

+

IMG.0212

+

The value of architecture is not x86 or arm.

+

The value of architecture is not x86 or arm.

+

Set architecture to x86 or arm.

+

400

+

IMG.0238

+

Not real-name authentication.

+

Real-name authentication is not performed.

+

Perform real-name authentication.

+

400

+

IMG.0239

+

Insufficient balance.

+

The account balance is insufficient.

+

Check the balance and top up the account if needed.

+

400

+

IMG.0241

+

Incomplete payment information.

+

The payment information is incomplete.

+

Complete the payment information.

+

400

+

IMG.0242

+

Insufficient budget of enterprise department.

+

The department budget is insufficient.

+

Increase the budget.

+

400

+

IMG.1075

+

Failed to register the image file.

+

Failed to register the image file.

+

Contact technical support.

+
+
+
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0024735403.html b/docs/ims/api-ref/en-us_topic_0024735403.html new file mode 100644 index 000000000..77bd11e82 --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0024735403.html @@ -0,0 +1,255 @@ + + +

Change History

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Released On

+

Description

+

2022-12-22

+

Modified the following content:

+ +

2022-12-01

+

Modified the following content:

+ +

2022-10-31

+

Added the following content:

+ +

Modified the following content:

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

2021-08-15

+

Modified the following content:

+
  • Added the methods of querying OBS bucket names and OBS bucket object names in the description of the image_url parameter in Creating an Image.
+

2020-08-12

+

Modified the following content:

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

2020-07-20

+

Modified the following content:

+ +

2019-11-15

+

Modified the following content:

+ +

2019-03-13

+

Modified the following content:

+

Added Native OpenStack APIs.

+

2019-02-13

+

Modified the following content:

+ +

2019-01-30

+

Modified the following content:

+ +

2018-09-30

+

Added the following content:

+ +
Modified the following content: +
+

2018-08-30

+
Added the following content: +
+

2018-07-30

+
Modified the following content:
  • Adjusted the outline.
  • Adjusted the sequences of extension APIs and native APIs.
+
+

2018-06-30

+

Added the following content:

+
  • Added section "Asynchronous Job Progress Query."
+

2018-04-30

+

Modified the following content:

+ +

2018-03-30

+

Added the following content:

+ +

2018-01-30

+
Added the following content: +
+

2017-12-30

+

Added the following content:

+
  • Supported the upload of images in VHDX format.
+

2017-11-30

+
Added the following content: +
+

2017-10-30

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

2017-09-30

+
Added the following content:
  • Supported the upload of images in RAW format.
+
+
Modified the following content: +
+

2017-08-30

+
Added the following content:
  • Supported image creation from a BMS.
+
+

2017-07-29

+
Added the following content: +
+

2017-06-30

+
Modified the following content: +
+

2017-05-30

+
Added the following content: +
+

2017-03-30

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

2017-02-28

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

2017-02-08

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

2017-01-20

+
Added the following content:
  • Added support for image encryption and parameter cmk_id during image creation using an external image file in Creating an Image.
+
+
Modified the following content: +
+

2016-11-24

+
Added the following content:
  • Added the Anti-DDoS and KMS services in "Regions and Endpoints."
  • Supported the upload of image files in format of QCOW2, VMDK, VHD, and ZVHD.
  • Added the file_format parameter in Exporting an Image.
+
+
Modified the following content:
  • Modified the operation for generating the AK and SK.
  • Optimized descriptions about parameters min_disk, min_ram, status, created_at, and updated_at in multiple sections.
+
+

2016-10-29

+
Added the following content: +
+

2016-09-30

+
Modified the following content: +
+

2016-09-18

+
Added the following content:
  • Added "Registering an Image File as a Private Image".
  • Added "Exporting an Image".
  • Added "Sharing an Image".
+
+
Modified the following content:
  • Modified the function description and example request in "Uploading an Image".
+
+

2016-08-25

+
Added the following content:
  • Added the Cloud Container Engine (CCE), Relational Database Service (RDS), and Domain Name Service (DNS) services in "Regions and Endpoints."
+
+

2016-06-16

+
Added the following content: +
+

2016-04-14

+
Modified the following content:
  • Modified the URL parameter description in "Service Usage".
  • Modified the procedure for making API calls for token authentication.
  • Added the Identity and Access Management (IAM) service in Regions and Endpoints.
+
+

2016-03-09

+

This issue is the first official release.

+
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0031615565.html b/docs/ims/api-ref/en-us_topic_0031615565.html new file mode 100644 index 000000000..234ad7608 --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0031615565.html @@ -0,0 +1,436 @@ + + +

Creating Image Metadata (Native OpenStack API)

+

Function

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.

+
+

URI

POST /v2/images

+
+

Request

  • Request parameters +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    __os_version

    +

    No

    +

    String

    +

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

    +

    If this parameter is not specified, the value Other Linux(64 bit) will be used. In that case, the ECS creation using this image may fail, and the ECS created using this image may fail to run properly.

    +

    visibility

    +

    No

    +

    String

    +

    Specifies whether the image is available to other tenants.

    +

    The default value is private. When creating image metadata, the value of visibility can be set to private only.

    +

    name

    +

    No

    +

    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 255 characters. For detailed description, see Image Attributes. This parameter is left blank by default.

    +

    protected

    +

    No

    +

    Boolean

    +

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

    +

    container_format

    +

    No

    +

    String

    +

    Specifies the container format.

    +

    The default value is bare.

    +

    disk_format

    +

    No

    +

    String

    +

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

    +

    tags

    +

    No

    +

    Array of strings

    +

    Lists the image tags. The tag contains 1 to 255 characters. The value is left blank by default.

    +

    min_ram

    +

    No

    +

    Integer

    +

    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

    +

    No

    +

    Integer

    +

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

    +

    The value of this parameter must be greater than the image system disk capacity. Otherwise, the ECS creation may fail.

    +
    +
    +

    Parameters in the request body are strings of no more than 255 characters, and their values can be left blank. Example:

    +
    "key": "value"
    +
    +
  • Example request
    POST https://{Endpoint}/v2/images
    +
    {
+    "__os_version": "Ubuntu 14.04 server 64bit",
+    "container_format": "bare",
+    "disk_format": "vhd",
+    "min_disk": 1,
+    "min_ram": 1024,
+    "name": "test",
+    "tags": [
+        "test",
+        "image"
+    ],
+    "visibility": "private",
+    "protected": false
+}
    +
+
+

Response

  • Response parameters +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    visibility

    +

    String

    +

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

    +

    name

    +

    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.

    +

    protected

    +

    Boolean

    +

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

    +

    container_format

    +

    String

    +

    Specifies the container format.

    +

    The value is bare.

    +

    disk_format

    +

    String

    +

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

    +

    tags

    +

    Array of strings

    +

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

    +

    min_ram

    +

    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.

    +

    min_disk

    +

    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.

    +

    status

    +

    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.
    +

    created_at

    +

    String

    +

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

    +

    updated_at

    +

    String

    +

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

    +

    self

    +

    String

    +

    Specifies the image URL.

    +

    id

    +

    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.

    +

    file

    +

    String

    +

    Specifies the URL for uploading and downloading the image file.

    +

    schema

    +

    String

    +

    Specifies the URL for accessing the schema.

    +

    __image_source_type

    +

    String

    +

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

    +

    __image_size

    +

    String

    +

    Specifies the image size. The unit is byte.

    +

    __isregistered

    +

    String

    +

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

    +

    __os_version

    +

    String

    +

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

    +

    __os_type

    +

    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.

    +

    __platform

    +

    String

    +

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

    +

    __os_bit

    +

    String

    +

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

    +

    __imagetype

    +

    String

    +

    Specifies the image type. private indicates a private image.

    +

    virtual_env_type

    +

    String

    +

    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.
    +

    owner

    +

    String

    +

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

    +

    __root_origin

    +

    String

    +

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

    +

    checksum

    +

    String

    +

    Specifies the MD5 value of the image file.

    +

    size

    +

    Long

    +

    This parameter is unavailable currently.

    +

    virtual_size

    +

    Integer

    +

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

    +

    properties

    +

    Properties object

    +

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

    +
    +
    +
  • Example response
    STATUS CODE 201
    +
    {
+    "schema": "/v2/schemas/image",
+    "min_disk": 1,
+    "created_at": "2016-06-02T07:49:48Z",
+    "__image_source_type": "uds",
+    "container_format": "bare",
+    "__image_size": "0",
+    "file": "/v2/images/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba86/file",
+    "updated_at": "2016-06-02T07:49:49Z",
+    "protected": false,
+    "id": "4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba86",
+    "__isregistered": "true",
+    "min_ram": 1024,
+    "owner": "b912fb4a4c464b568ecfca1071b21b10",
+    "__os_type": "Linux",
+    "__imagetype": "private",
+    "visibility": "private",
+    "virtual_env_type": "FusionCompute",
+    "tags": [
+        "test",
+        "image"
+    ],
+    "__platform": "Ubuntu",
+    "__os_bit": "64",
+    "__os_version": "Ubuntu 14.04 server 64bit",
+    "name": "test",
+    "self": "/v2/images/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba86",
+    "disk_format": "vhd",
+    "status": "queued"
+}
    +
+
+

Returned Values

  • Normal

    201

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    Request error.

    +

    401 Unauthorized

    +

    Authentication failed.

    +

    403 Forbidden

    +

    You do not have the rights to perform the operation.

    +

    404 Not Found

    +

    The requested resource was not found.

    +

    500 Internal Server Error

    +

    Internal service error.

    +

    503 Service Unavailable

    +

    The service is unavailable.

    +
    +
    +
+
+
+
+
+
Parent topic: Image (Native OpenStack APIs)
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0031615566.html b/docs/ims/api-ref/en-us_topic_0031615566.html new file mode 100644 index 000000000..4109cabfc --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0031615566.html @@ -0,0 +1,118 @@ + + +

Uploading an Image (Native OpenStack API)

+

Function

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 to create images, see sections "Creating a Private Windows Image Using an External Image File" and "Creating a Private Linux Image Using an External Image File" in Image Management Service User Guide.

+

The following describes how to use this API:

+
  1. Prepare the image to be uploaded. The image can be in QCOW2, VMDK, VHD, RAW, VHDX, QED, VDI, QCOW, ZVHD2, or ZVHD format.
  2. Create metadata for the image by performing the operations in Creating Image Metadata (Native OpenStack API). After the API is invoked successfully, save the image ID.
  3. Upload the image file with the image ID obtained in 2.
+
+

URI

PUT /v2/images/{image_id}/file

+
Table 1 lists the parameters in the URI. +
+ + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

image_id

+

Yes

+

String

+

Specifies the image ID.

+
  • image_id is the ID of the image you created by invoking the API for creating image metadata. Image upload 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 is uploaded successfully.
+
+
+
+
+

Request

  • Request parameters +
    + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    image_file

    +

    Yes

    +

    file

    +

    Specifies the local file to be uploaded.

    +
    +
    +
  • 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
    +
+
+

Returned Values

  • Normal

    204

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    Request error. For details, see Error Codes.

    +

    401 Unauthorized

    +

    Authentication failed.

    +

    403 Forbidden

    +

    You do not have the rights to perform the operation.

    +

    404 Not Found

    +

    The requested resource was not found.

    +

    409 Conflict

    +

    Request conflict.

    +

    500 System Error

    +

    System error.

    +
    +
    +
+
+
+
+
+
Parent topic: Image (Native OpenStack APIs)
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0031617666.html b/docs/ims/api-ref/en-us_topic_0031617666.html new file mode 100644 index 000000000..bae2a5d30 --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0031617666.html @@ -0,0 +1,349 @@ + + +

Values of Related Parameters

+

__os_version Values

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 __os_version values

OS Type

+

OS Version (__os_version)

+

Windows

+

Windows 10 64bit

+

Windows 7 Enterprise 64bit

+

Windows 7 Professional 64bit

+

Windows 7 Professional 32bit

+

Windows Server 2016 Standard 64bit

+

Windows Server 2016 Datacenter 64bit

+

Windows Server 2012 R2 Standard 64bit

+

Windows Server 2012 Essentials R2 64bit

+

Windows Server 2012 R2 Datacenter 64bit

+

Windows Server 2012 Datacenter 64bit

+

Windows Server 2012 Standard 64bit

+

Windows Server 2008 R2 WEB 64bit

+

Windows Server 2008 R2 Standard 64bit

+

Windows Server 2008 R2 Enterprise 64bit

+

Windows Server 2008 R2 Datacenter 64bit

+

SUSE

+

SUSE Linux Enterprise Server 15 SP1 64bit

+

SUSE Linux Enterprise Server 15 64bit

+

SUSE Linux Enterprise Server 12 SP5 64bit

+

SUSE Linux Enterprise Server 12 SP4 64bit

+

SUSE Linux Enterprise Server 12 SP3 64bit

+

SUSE Linux Enterprise Server 12 SP2 64bit

+

SUSE Linux Enterprise Server 12 SP1 64bit

+

SUSE Linux Enterprise Server 12 64bit

+

SUSE Linux Enterprise Server 11 SP4 64bit

+

SUSE Linux Enterprise Server 11 SP3 64bit

+

SUSE Linux Enterprise Server 11 SP3 32bit

+

SUSE Linux Enterprise Server 11 SP1 64bit

+

Oracle Linux

+

Oracle Linux Server release 7.6 64bit

+

Oracle Linux Server release 7.5 64bit

+

Oracle Linux Server release 7.4 64bit

+

Oracle Linux Server release 7.3 64bit

+

Oracle Linux Server release 7.2 64bit

+

Oracle Linux Server release 7.1 64bit

+

Oracle Linux Server release 7.0 64bit

+

Oracle Linux Server release 6.10 64bit

+

Oracle Linux Server release 6.9 64bit

+

Oracle Linux Server release 6.8 64bit

+

Oracle Linux Server release 6.7 64bit

+

Oracle Linux Server release 6.5 64bit

+

Red Hat

+

Redhat Linux Enterprise 8.0 64bit

+

Redhat Linux Enterprise 7.6 64bit

+

Redhat Linux Enterprise 7.5 64bit

+

Redhat Linux Enterprise 7.4 64bit

+

Redhat Linux Enterprise 7.3 64bit

+

Redhat Linux Enterprise 7.2 64bit

+

Redhat Linux Enterprise 7.1 64bit

+

Redhat Linux Enterprise 7.0 64bit

+

Redhat Linux Enterprise 6.10 64bit

+

Redhat Linux Enterprise 6.9 64bit

+

Redhat Linux Enterprise 6.8 64bit

+

Redhat Linux Enterprise 6.7 64bit

+

Redhat Linux Enterprise 6.6 64bit

+

Redhat Linux Enterprise 6.6 32bit

+

Redhat Linux Enterprise 6.5 64bit

+

Redhat Linux Enterprise 6.4 64bit

+

Redhat Linux Enterprise 6.4 32bit

+

Ubuntu

+

Ubuntu 19.04 server 64bit

+

Ubuntu 18.04 server 64bit

+

Ubuntu 16.04.3 Server 64bit

+

Ubuntu 16.04.2 Server 64bit

+

Ubuntu 16.04 server 64bit

+

Ubuntu 14.04.5 server 64bit

+

Ubuntu 14.04.4 server 64bit

+

Ubuntu 14.04.4 server 32bit

+

Ubuntu 14.04.3 server 64bit

+

Ubuntu 14.04.3 server 32bit

+

Ubuntu 14.04.1 server 64bit

+

Ubuntu 14.04.1 server 32bit

+

Ubuntu 14.04 server 64bit

+

Ubuntu 14.04 server 32bit

+

openSUSE

+

openSUSE 42.3 64bit

+

openSUSE 42.2 64bit

+

openSUSE 42.1 64bit

+

openSUSE 15.1 64bit

+

openSUSE 15.0 64bit

+

openSUSE 13.2 64bit

+

openSUSE 11.3 64bit

+

CentOS

+

CentOS 8.0 64bit

+

CentOS 7.7 64bit

+

CentOS 7.6 64bit

+

CentOS 7.5 64bit

+

CentOS 7.4 64bit

+

CentOS 7.3 64bit

+

CentOS 7.2 64bit

+

CentOS 7.1 64bit

+

CentOS 7.0 64bit

+

CentOS 7.0 32bit

+

CentOS 6.10 64bit

+

CentOS 6.10 32bit

+

CentOS 6.9 64bit

+

CentOS 6.9 32bit

+

CentOS 6.8 64bit

+

CentOS 6.7 64bit

+

CentOS 6.7 32bit

+

CentOS 6.6 64bit

+

CentOS 6.6 32bit

+

CentOS 6.5 64bit

+

CentOS 6.5 32bit

+

CentOS 6.4 64bit

+

CentOS 6.4 32bit

+

CentOS 6.3 64bit

+

CentOS 6.3 32bit

+

Debian

+

Debian GNU/Linux 10.0.0 64bit

+

Debian GNU/Linux 9.3.0 64bit

+

Debian GNU/Linux 9.0.0 64bit

+

Debian GNU/Linux 8.10.0 64bit

+

Debian GNU/Linux 8.8.0 64bit

+

Debian GNU/Linux 8.7.0 64bit

+

Debian GNU/Linux 8.6.0 64bit

+

Debian GNU/Linux 8.5.0 64bit

+

Debian GNU/Linux 8.4.0 64bit

+

Debian GNU/Linux 8.2.0 64bit

+

Debian GNU/Linux 8.1.0 64bit

+

Fedora

+

Fedora 30 64bit

+

Fedora 29 64bit

+

Fedora 28 64bit

+

Fedora 27 64bit

+

Fedora 26 64bit

+

Fedora 25 64bit

+

Fedora 24 64bit

+

Fedora 23 64bit

+

Fedora 22 64bit

+

EulerOS

+

EulerOS 2.9 64bit

+

EulerOS 2.5 64bit

+

EulerOS 2.3 64bit

+

EulerOS 2.2 64bit

+

EulerOS 2.1 64bit

+

CoreOS

+

CoreOS 1068.10.0

+

CoreOS 1010.5.0

+

CoreOS 1298.6.0

+

openEuler

+

openEuler 20.03 64bit

+
+
+

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 this image unavailable and needs to be disabled.

+
+
+

__support_xen_gpu_type Values

+
+ + + + + + + +
Table 2 Supported GPU types

Supported GPU (__support_xen_gpu_type)

+

Description

+

M60_vGPU

+

The image has a hardware virtualization drive with the M60 video card installed and supports g1.xlarge and g1.2xlarge ECSs.

+
+
+
+

__support_kvm_gpu_type Values

+
+ + + + + + + + + + + + + + + + + + + +
Table 3 Supported GPU types

Supported GPU (__support_kvm_gpu_type)

+

Description

+

M60

+

The image has a hardware virtualization drive with the M60 video card installed and supports g1.xlarge, g1.2xlarge, and g3.4xlarge.4 ECSs.

+

V100_vGPU

+

The image has a hardware virtualization drive with the V100 video card installed and supports g5.8xlarge.4 ECSs.

+

P2V_V100

+

The image has a hardware virtualization drive with the V100 video card installed and supports p2v.2xlarge.8 ECSs.

+

P100

+

The image has a hardware virtualization drive with the P100 video card installed and supports p1.2xlarge.8 and p1.4xlarge.8 ECSs.

+

V100

+

The image has a hardware virtualization drive with the V100 video card installed and supports p2.2xlarge.8 and p2.4xlarge.8 ECSs.

+
+
+
+

Special Images and Supported OSs

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 Special image types and supported OSs

Image Type

+

Supported OS

+

Memory-optimized generation II (m2)

+

CentOS 7.2 64bit

+

CentOS 6.5 64bit

+

SUSE SLES 11 SP4 64bit

+

Redhat 7.2 64bit

+

Windows 2012DC edition

+

Large-memory

+

CentOS 6.6 64bit

+

CentOS 6.7 64bit

+

CentOS 6.8 64bit

+

CentOS 7.1 64bit

+

CentOS 7.2 64bit

+

CentOS 7.3 64bit

+

SUSE Enterprise Linux Server 11 SP3 64bit

+

SUSE Enterprise Linux Server 11 SP4 64bit

+

SUSE Enterprise Linux Server 12 SP1 64bit

+

SUSE Enterprise Linux Server 12 SP2 64bit

+

Redhat Linux Enterprise 6.8 64bit

+

Redhat Linux Enterprise 7.3 64bit

+

GPU-accelerated (G1)

+

Windows Server 2008

+

Windows Server 2012

+

Windows Server 2016

+

GPU-accelerated (G2)

+

Windows Server 2008

+

Windows Server 2012

+

Disk-intensive

+

CentOS 7.2 64bit

+

CentOS 7.3 64bit

+

CentOS 6.8 64bit

+

SUSE Enterprise Linux Server 11 SP3 64bit

+

SUSE Enterprise Linux Server 11 SP4 64bit

+

SUSE Enterprise Linux Server 12 SP1 64bit

+

SUSE Enterprise Linux Server 12 SP2 64bit

+

Redhat Linux Enterprise 6.8 64bit

+

Redhat Linux Enterprise 7.3 64bit

+

High-performance generation I (H1)

+

CentOS 6.8 64bit

+

CentOS 7.2 64bit

+

CentOS 7.3 64bit

+

Windows Server 2008

+

Windows Server 2012

+

Windows Server 2016

+

SUSE Enterprise Linux Server 11 SP3 64bit

+

SUSE Enterprise Linux Server 11 SP4 64bit

+

SUSE Enterprise Linux Server 12 SP1 64bit

+

SUSE Enterprise Linux Server 12 SP2 64bit

+

Redhat Linux Enterprise 6.8 64bit

+

Redhat Linux Enterprise 7.3 64bit

+

High-performance generation II (H2)

+

CentOS 6.5 64bit

+

CentOS 7.2 64bit

+

SUSE SLES 11 SP4 64bit

+

Redhat 7.2 64bit

+

Memory-optimized generation II (m2)

+

CentOS 7.2 64bit

+

CentOS 6.5 64bit

+

SUSE SLES 11 SP4 64bit

+

Redhat 7.2 64bit

+

Windows 2012DC edition

+
+
+
+
+
+
+
Parent topic: Common Parameters
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0036994315.html b/docs/ims/api-ref/en-us_topic_0036994315.html new file mode 100644 index 000000000..10c734269 --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0036994315.html @@ -0,0 +1,178 @@ + + +

Exporting an Image

+

Function

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.

+
+
+

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
    +
  • 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

+
Table 1 lists the parameters in the URI. +
+ + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

image_id

+

Yes

+

String

+

Specifies the image ID.

+

For details about how to obtain the image ID, see Querying Images.

+
+
+
+
+

Request

  • Request parameters +
    + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    bucket_url

    +

    Yes

    +

    String

    +

    Specifies the URL of the image file in the format of Bucket name:File name.

    +
    NOTE:

    The storage class of the OBS bucket must be Standard.

    +
    +

    file_format

    +

    Yes

    +

    String

    +

    Specifies the file format. The value can be qcow2, vhd, zvhd, or vmdk.

    +

    is_quick_export

    +

    No

    +

    Boolean

    +

    Whether to enable fast export. The value can be true or false.

    +
    NOTE:

    If fast export is enabled, file_format cannot be specified.

    +
    +
    +
    +
  • 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
+}
+
    + +
    +
+
+

Response

  • Response parameters +
    + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    job_id

    +

    String

    +

    Specifies the asynchronous job ID.

    +

    For details, see Asynchronous Job Query.

    +
    +
    +
  • Example response
    STATUS CODE 200
    +
    1
+2
+3
    {
+    "job_id": "edc89b490d7d4392898e19b2deb34797"
+}
+
    + +
    +
+
+

Returned Values

  • Normal

    200

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

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

    +

    401 Unauthorized

    +

    Authentication failed.

    +

    403 Forbidden

    +

    You do not have the rights to perform the operation.

    +

    404 Not Found

    +

    The requested resource was not found.

    +

    500 Internal Server Error

    +

    Internal service error.

    +

    503 Service Unavailable

    +

    The service is unavailable.

    +
    +
    +
+
+
+
+
+
Parent topic: Image
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0036994316.html b/docs/ims/api-ref/en-us_topic_0036994316.html new file mode 100644 index 000000000..03d613970 --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0036994316.html @@ -0,0 +1,14 @@ + + +

Restrictions on Image Sharing

+

Description

You can use the image sharing function to share your private images with other users.

+
+

Constraints

  • Images can only be shared within a region.
  • A system disk image or data disk image can be shared with a maximum of 256 tenants, and a full-ECS image can be shared with a maximum of 10 tenants.
  • You can stop sharing images anytime without notifying the recipient.
  • You can delete shared image anytime without notifying the recipient.
  • Encrypted images cannot be shared.
  • Only full-ECS images created from CBR backups can be shared. Full-ECS images created using other methods cannot be shared.
+
+
+
+
+
Parent topic: Common Parameters
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0036994317.html b/docs/ims/api-ref/en-us_topic_0036994317.html new file mode 100644 index 000000000..dd35d4ed1 --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0036994317.html @@ -0,0 +1,169 @@ + + +

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.

+
+

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.

+
+

URI

POST /v2/images/{image_id}/members

+
+

Request

  • Request parameters +
    + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    member

    +

    Yes

    +

    String

    +

    Specifies the image member.

    +

    The value is the project ID of a tenant.

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

Response

  • Response parameters +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    status

    +

    String

    +

    Specifies the image sharing status.

    +

    created_at

    +

    String

    +

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

    +

    updated_at

    +

    String

    +

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

    +

    image_id

    +

    String

    +

    Specifies the image ID.

    +

    member_id

    +

    String

    +

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

    +

    schema

    +

    String

    +

    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"
+}
+
    + +
    +
+
+

Returned Values

  • Normal

    200

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    Request error.

    +

    401 Unauthorized

    +

    Authentication failed.

    +

    403 Forbidden

    +

    You do not have the rights to perform the operation.

    +

    404 Not Found

    +

    The requested resource was not found.

    +

    500 Internal Server Error

    +

    Internal service error.

    +

    503 Service Unavailable

    +

    The service is unavailable.

    +
    +
    +
+
+
+
+
+
Parent topic: Image Sharing (Native OpenStack APIs)
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0036994318.html b/docs/ims/api-ref/en-us_topic_0036994318.html new file mode 100644 index 000000000..e5c909d0b --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0036994318.html @@ -0,0 +1,224 @@ + + +

Updating the Image Sharing Status in Batches (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}

+
Table 1 lists the parameters in the URI. +
+ + + + + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

image_id

+

Yes

+

String

+

Specifies the image ID.

+

member_id

+

Yes

+

String

+

Specifies the member ID.

+
+
+
+
+

Request

  • Request parameters +
    + + + + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    status

    +

    Yes

    +

    String

    +

    Specifies whether a shared image will be accepted or declined.

    +

    Available values include:

    +
    • 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 rejected, the image is not displayed in the image list. However, you can still use the image to create ECSs.
    +

    vault_id

    +

    No

    +

    String

    +

    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 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"
+}
+
      + +
      +
    +
+
+

Response

  • Response parameters +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    status

    +

    String

    +

    Specifies the image sharing status.

    +

    created_at

    +

    String

    +

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

    +

    updated_at

    +

    String

    +

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

    +

    image_id

    +

    String

    +

    Specifies the image ID.

    +

    member_id

    +

    String

    +

    Specifies the member ID.

    +

    schema

    +

    String

    +

    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"
+}
+
    + +
    +
+
+

Returned Values

  • Normal

    200

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    Request error.

    +

    401 Unauthorized

    +

    Authentication failed.

    +

    403 Forbidden

    +

    You do not have the rights to perform the operation.

    +

    404 Not Found

    +

    The requested resource was not found.

    +

    500 Internal Server Error

    +

    Internal service error.

    +

    503 Service Unavailable

    +

    The service is unavailable.

    +
    +
    +
+
+
+
+
+
Parent topic: Image Sharing (Native OpenStack APIs)
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0036994319.html b/docs/ims/api-ref/en-us_topic_0036994319.html new file mode 100644 index 000000000..2c3d7eab0 --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0036994319.html @@ -0,0 +1,169 @@ + + +

Querying Image 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}

+

Table 1 lists the parameters in the URI.

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

image_id

+

Yes

+

String

+

Specifies the image ID.

+

member_id

+

Yes

+

String

+

Specifies the member ID.

+
+
+
+

Request

  • Request parameters

    None

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

Response

  • Response parameters +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    status

    +

    String

    +

    Specifies the image sharing status.

    +

    created_at

    +

    String

    +

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

    +

    updated_at

    +

    String

    +

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

    +

    image_id

    +

    String

    +

    Specifies the image ID.

    +

    member_id

    +

    String

    +

    Specifies the member ID.

    +

    schema

    +

    String

    +

    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"
+}
+
    + +
    +
+
+

Returned Values

  • Normal

    200

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    Request error.

    +

    401 Unauthorized

    +

    Authentication failed.

    +

    403 Forbidden

    +

    You do not have the rights to perform the operation.

    +

    404 Not Found

    +

    The requested resource was not found.

    +

    500 Internal Server Error

    +

    Internal service error.

    +

    503 Service Unavailable

    +

    The service is unavailable.

    +
    +
    +
+
+
+
+
+
Parent topic: Image Sharing (Native OpenStack APIs)
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0036994320.html b/docs/ims/api-ref/en-us_topic_0036994320.html new file mode 100644 index 000000000..7833660f4 --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0036994320.html @@ -0,0 +1,197 @@ + + +

Querying Image 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

+
Table 1 lists the parameters in the URI. +
+ + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

image_id

+

Yes

+

String

+

Specifies the image ID.

+
+
+
+
+

Request

  • Request parameters

    None

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

Response

  • Response parameters +
    + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    members

    +

    Array of objects

    +

    Specifies the members.

    +

    For details, see Table 2.

    +

    schema

    +

    String

    +

    Specifies the sharing schema.

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

    Parameter

    +

    Type

    +

    Description

    +

    status

    +

    String

    +

    Specifies the image sharing status.

    +

    created_at

    +

    String

    +

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

    +

    updated_at

    +

    String

    +

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

    +

    image_id

    +

    String

    +

    Specifies the image ID.

    +

    member_id

    +

    String

    +

    Specifies the member ID.

    +

    schema

    +

    String

    +

    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"
+}
+
    + +
    +
+
+

Returned Values

  • Normal

    200

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    Request error.

    +

    401 Unauthorized

    +

    Authentication failed.

    +

    403 Forbidden

    +

    You do not have the rights to perform the operation.

    +

    404 Not Found

    +

    The requested resource was not found.

    +

    500 Internal Server Error

    +

    Internal service error.

    +

    503 Service Unavailable

    +

    The service is unavailable.

    +
    +
    +
+
+
+
+
+
Parent topic: Image Sharing (Native OpenStack APIs)
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0036994321.html b/docs/ims/api-ref/en-us_topic_0036994321.html new file mode 100644 index 000000000..6e50b8ff8 --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0036994321.html @@ -0,0 +1,98 @@ + + +

Deleting an Image 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}

+
Table 1 lists the parameters in the URI. +
+ + + + + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

image_id

+

Yes

+

String

+

Specifies the image ID.

+

member_id

+

Yes

+

String

+

Specifies the member ID.

+
+
+
+
+

Request

  • Request parameters

    None

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

Response

  • Response parameters

    None

    +
  • Example response
    204 No Content
    +
+
+

Returned Values

  • Normal

    204

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    Request error.

    +

    401 Unauthorized

    +

    Authentication failed.

    +

    403 Forbidden

    +

    You do not have the rights to perform the operation.

    +

    404 Not Found

    +

    The requested resource was not found.

    +

    500 Internal Server Error

    +

    Internal service error.

    +

    503 Service Unavailable

    +

    The service is unavailable.

    +
    +
    +
+
+
+
+
+
Parent topic: Image Sharing (Native OpenStack APIs)
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0036994322.html b/docs/ims/api-ref/en-us_topic_0036994322.html new file mode 100644 index 000000000..38935dfe2 --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0036994322.html @@ -0,0 +1,148 @@ + + +

Adding Image Members in Batches

+

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.

+
+

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.

+
+

URI

POST /v1/cloudimages/members

+
+

Request

  • Request parameters +
    + + + + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    images

    +

    Yes

    +

    Array of strings

    +

    Specifies the image IDs.

    +

    projects

    +

    Yes

    +

    Array of strings

    +

    Specifies the project IDs.

    +
    +
    +
  • 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"
+    ]
+}
+
    + +
    +
+
+

Response

  • Response parameters +
    + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    job_id

    +

    String

    +

    Specifies the asynchronous task ID.

    +

    For details, see Asynchronous Job Query.

    +
    +
    +
  • Example response
    STATUS CODE 200
    +
    1
+2
+3
    {
+    "job_id": "edc89b490d7d4392898e19b2deb34797"
+}
+
    + +
    +
+
+

Returned Values

  • Normal

    200

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    Request error. For details, see Error Codes.

    +

    401 Unauthorized

    +

    Authentication failed.

    +

    403 Forbidden

    +

    You do not have the rights to perform the operation.

    +

    404 Not Found

    +

    The requested resource was not found.

    +

    500 Internal Server Error

    +

    Internal service error.

    +

    503 Service Unavailable

    +

    The service is unavailable.

    +
    +
    +
+
+
+
+
+
Parent topic: Image Sharing
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0036994323.html b/docs/ims/api-ref/en-us_topic_0036994323.html new file mode 100644 index 000000000..85cde2fb5 --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0036994323.html @@ -0,0 +1,186 @@ + + +

Updating the Status of Image Members in Batches

+

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.

+
+

URI

PUT /v1/cloudimages/members

+
+

Request

  • Request parameters +
    + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    images

    +

    Yes

    +

    Array of strings

    +

    Specifies the image IDs.

    +

    project_id

    +

    Yes

    +

    String

    +

    Specifies the project ID.

    +

    status

    +

    Yes

    +

    String

    +

    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

    +

    No

    +

    String

    +

    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"
+}
+
      + +
      +
    +
+
+

Response

  • Response parameters +
    + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    job_id

    +

    String

    +

    Specifies the asynchronous job ID.

    +

    For details, see Asynchronous Job Query.

    +
    +
    +
  • Example response
    STATUS CODE 200
    +
    1
+2
+3
    {
+    "job_id": "edc89b490d7d4392898e19b2deb34797"
+}
+
    + +
    +
+
+

Returned Values

  • Normal

    200

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    Request error. For details, see Error Codes.

    +

    401 Unauthorized

    +

    Authentication failed.

    +

    403 Forbidden

    +

    You do not have the rights to perform the operation.

    +

    404 Not Found

    +

    The requested resource was not found.

    +

    500 Internal Server Error

    +

    Internal service error.

    +

    503 Service Unavailable

    +

    The service is unavailable.

    +
    +
    +
+
+
+
+
+
Parent topic: Image Sharing
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0036994324.html b/docs/ims/api-ref/en-us_topic_0036994324.html new file mode 100644 index 000000000..724307c79 --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0036994324.html @@ -0,0 +1,146 @@ + + +

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.

+
+

URI

DELETE /v1/cloudimages/members

+
+

Request

  • Request parameters +
    + + + + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    images

    +

    Yes

    +

    Array of strings

    +

    Specifies the image IDs.

    +

    projects

    +

    Yes

    +

    Array of strings

    +

    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"
+    ]
+}
+
    + +
    +
+
+

Response

  • Response parameters +
    + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    job_id

    +

    String

    +

    Specifies the asynchronous task ID.

    +

    For details, see Asynchronous Job Query.

    +
    +
    +
  • Example response
    STATUS CODE 200
    +
    1
+2
+3
    {
+    "job_id": "edc89b490d7d4392898e19b2deb34797"
+}
+
    + +
    +
+
+

Returned Values

  • Normal

    200

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    Request error. For details, see Error Codes.

    +

    401 Unauthorized

    +

    Authentication failed.

    +

    403 Forbidden

    +

    You do not have the rights to perform the operation.

    +

    404 Not Found

    +

    The requested resource was not found.

    +

    500 Internal Server Error

    +

    Internal service error.

    +

    503 Service Unavailable

    +

    The service is unavailable.

    +
    +
    +
+
+
+
+
+
Parent topic: Image Sharing
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0037131984.html b/docs/ims/api-ref/en-us_topic_0037131984.html new file mode 100644 index 000000000..3b3294fd9 --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0037131984.html @@ -0,0 +1,145 @@ + + +

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.

    +
+

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

+
+
+

URI

PUT /v1/cloudimages/{image_id}/upload

+
Table 1 lists the parameters in the URI. +
+ + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

image_id

+

Yes

+

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).
+
+
+
+
+

Request

  • Request parameters +
    + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    image_url

    +

    Yes

    +

    String

    +

    Specifies the URL of the image file in the format of Bucket name:File name.

    +

    Image files in the bucket can be in ZVHD, QCOW2, VHD, RAW, VHDX, QED, VDI, QCOW, ZVHD2, or VMDK format.

    +
    NOTE:

    The storage class of the OBS bucket must be Standard.

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

Response

  • Response parameters +
    + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    job_id

    +

    String

    +

    Specifies the asynchronous job ID.

    +

    For details, see Asynchronous Job Query.

    +
    +
    +
  • Example response
    HTTP/1.1 200
    +
    1
+2
+3
    {
+   "job_id":" b912fb4a4c464b568ecfca1071b21b10"
+}
+
    + +
    +
+
+

Returned Values

  • Normal

    200

    +
  • Abnormal
+ +
+ + + + + + + + + + + + + + + + +

Returned Value

+

Description

+

400 Bad Request

+

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

+

401 Unauthorized

+

Authentication failed.

+

403 Forbidden

+

You do not have the rights to perform the operation.

+

404 Not Found

+

The requested resource was not found.

+
+
+
+
+
+
+
Parent topic: Image
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0049147855.html b/docs/ims/api-ref/en-us_topic_0049147855.html new file mode 100644 index 000000000..b0b2ce0e9 --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0049147855.html @@ -0,0 +1,15 @@ + + +

Image Replication

+
+
+ + +
+
Parent topic: IMS APIs
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0049147856.html b/docs/ims/api-ref/en-us_topic_0049147856.html new file mode 100644 index 000000000..66f28c104 --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0049147856.html @@ -0,0 +1,183 @@ + + +

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.

+
+

Constraints

  • Full-ECS images cannot be replicated.
+
+

URI

POST /v1/cloudimages/{image_id}/copy

+
Table 1 lists the parameters in the URI. +
+ + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

image_id

+

Yes

+

String

+

Specifies the image ID.

+

For details about how to obtain the image ID, see Querying Images.

+
+
+
+
+

Request

  • Request parameters +
    + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    name

    +

    Yes

    +

    String

    +

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

    +

    description

    +

    No

    +

    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.

    +

    cmk_id

    +

    No

    +

    String

    +

    Specifies the encryption key. This parameter is left blank by default.

    +

    enterprise_project_id

    +

    No

    +

    String

    +

    Indicates 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"
+}
+
    + +
    +
+
+

Response

  • Response parameters +
    + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    job_id

    +

    String

    +

    Specifies the asynchronous job ID.

    +

    For details, see Asynchronous Job Query.

    +
    +
    +
  • Example response
    STATUS CODE 200
    +
    1
+2
+3
    {
+    "job_id": "edc89b490d7d4392898e19b2deb34797"
+}
+
    + +
    +
+
+

Returned Values

  • Normal

    200

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    Request error. For details, see Error Codes.

    +

    401 Unauthorized

    +

    Authentication failed.

    +

    403 Forbidden

    +

    You do not have the rights to perform the operation.

    +

    404 Not Found

    +

    The requested resource was not found.

    +

    500 Internal Server Error

    +

    Internal service error.

    +

    503 Service Unavailable

    +

    The service is unavailable.

    +
    +
    +
+
+
+
+
+
Parent topic: Image Replication
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0049147876.html b/docs/ims/api-ref/en-us_topic_0049147876.html new file mode 100644 index 000000000..c210dfcfc --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0049147876.html @@ -0,0 +1,163 @@ + + +

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.

+
+

URI

GET /v2/schemas/member

+
+

Request

  • Request parameters

    None

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

Response

  • Response parameters +
    + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    name

    +

    String

    +

    Specifies the schema name.

    +

    properties

    +

    Object

    +

    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"
+        }
+    }
+}
+
    + +
    +
+
+

Returned Values

  • Normal

    200

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    Request error.

    +

    401 Unauthorized

    +

    Authentication failed.

    +

    403 Forbidden

    +

    You do not have the rights to perform the operation.

    +

    404 Not Found

    +

    The requested resource was not found.

    +

    500 Internal Server Error

    +

    Internal service error.

    +

    503 Service Unavailable

    +

    The service is unavailable.

    +
    +
    +
+
+
+
+
+
Parent topic: Image Schema (Native OpenStack APIs)
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0049147877.html b/docs/ims/api-ref/en-us_topic_0049147877.html new file mode 100644 index 000000000..e7721602b --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0049147877.html @@ -0,0 +1,231 @@ + + +

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.

+
+

URI

GET /v2/schemas/members

+
+

Request

  • Request parameters

    None

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

Response

  • Response parameters +
    + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    name

    +

    String

    +

    Specifies the schema name.

    +

    links

    +

    Array of objects

    +

    Specifies the URL for accessing the schema.

    +

    For details, see Table 1.

    +

    properties

    +

    Object

    +

    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

    +

    Type

    +

    Description

    +

    href

    +

    String

    +

    Specifies the domain name.

    +

    rel

    +

    String

    +

    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"
+        }
+    }
+}
+
    + +
    +
+
+

Returned Values

  • Normal

    200

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    Request error.

    +

    401 Unauthorized

    +

    Authentication failed.

    +

    403 Forbidden

    +

    You do not have the rights to perform the operation.

    +

    404 Not Found

    +

    The requested resource was not found.

    +

    500 Internal Server Error

    +

    Internal service error.

    +

    503 Service Unavailable

    +

    The service is unavailable.

    +
    +
    +
+
+
+
+
+
Parent topic: Image Schema (Native OpenStack APIs)
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0060804959.html b/docs/ims/api-ref/en-us_topic_0060804959.html new file mode 100644 index 000000000..e55424278 --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0060804959.html @@ -0,0 +1,987 @@ + + +

Querying Images (Native OpenStack API)

+

Function

This API is used to obtain the image list.

+

This API does not return the complete result at once, but uses pagination.

+
+

Pagination

Pagination refers to the function of returning a subset of a group of images, a link to obtain the next set of images, and a link of the set of images. By default, a set contains 25 images. You can also use the limit and marker parameters to paginate through images manually and specify the number of images that can be returned.

+

The parameter first in the response indicates the URL of the first page of images, and parameter next indicates the URL of the next page of images. When the last page of images is queried, there is no parameter next.

+
+

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 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

__isregistered

+

No

+

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.

+

__imagetype

+

No

+

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.
+

protected

+

No

+

Boolean

+

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

+

visibility

+

No

+

String

+

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

+
  • public: public image
  • private: private image
  • shared: shared image
+
NOTE:

When the visibility value is private, private images that have shared with others are not queried.

+
+

owner

+

No

+

String

+

Specifies the tenant to which the image belongs.

+

id

+

No

+

String

+

Specifies the image ID.

+

status

+

No

+

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.
+

name

+

No

+

String

+

Specifies the image name. Exact matching is used. For detailed description, see Image Attributes.

+

container_format

+

No

+

String

+

Specifies the container type. The default value is bare.

+

disk_format

+

No

+

String

+

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

+

min_ram

+

No

+

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.

+

min_disk

+

No

+

Integer

+

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

+

__os_bit

+

No

+

String

+

Specifies the OS architecture, 32 bit or 64 bit.

+

__platform

+

No

+

String

+

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

+

marker

+

No

+

String

+

Specifies the start number from which images are queried. The value is the image ID.

+

limit

+

No

+

Integer

+

Specifies the number of images to be queried. The value is an integer. By default, 25 images can be queried.

+

sort_key

+

No

+

String

+

Specifies the field for sorting the query results. The value can be an attribute of the image: name, container_format, disk_format, status, id, size, or create_at. The default value is create_at.

+

sort_dir

+

No

+

String

+

Specifies whether the query results are sorted in ascending or descending order. Its value can be desc (default) or asc. This parameter is used together with parameter sort_key. The default value is desc.

+

__os_type

+

No

+

String

+

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

+

tag

+

No

+

String

+

Specifies a tag added to an image. Tags can be used as a filter to query images.

+
NOTE:

The tagging function has been upgraded. If the tags added before the function upgrade are in the format of "Key.Value", query tags using "Key=Value". For example, an existing tag is a.b. After the tag function upgrade, query the tag using "tag=a=b".

+
+

member_status

+

No

+

String

+

Specifies the member status. The value can be accepted, rejected, or pending. accepted: indicates that the shared image is accepted. rejected indicates that the image shared by others is rejected. pending indicates that the image shared by others needs to be confirmed. To use this parameter, set visibility to shared during the query.

+

__support_kvm

+

No

+

String

+

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

+

__support_xen

+

No

+

String

+

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

+

__support_largememory

+

No

+

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.

+

__support_diskintensive

+

No

+

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.

+

__support_highperformance

+

No

+

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.

+

__support_xen_gpu_type

+

No

+

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.

+

__support_kvm_gpu_type

+

No

+

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.

+

__support_xen_hana

+

No

+

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.

+

__support_kvm_infiniband

+

No

+

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.

+

created_at

+

No

+

String

+

Specifies the time when the image was created. 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.

+

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

+

updated_at

+

No

+

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.

+

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.

+

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.

+
+
+
+
+

Common Query Methods

  • Public images

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

    +
  • Private images

    GET /v2/images?owner={project_id}

    +
  • Available shared images

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

    +
  • Rejected images

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

    +
  • Unaccepted images

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

    +
+
+

Request

  • Request parameters

    None

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

Response

  • Response parameters +
    + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    first

    +

    String

    +

    Specifies the URL of the first page of images.

    +

    next

    +

    String

    +

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

    +

    schema

    +

    String

    +

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

    +

    images

    +

    Array of objects

    +

    Specifies the resource type.

    +

    For details, see Table 2.

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

    Parameter

    +

    Type

    +

    Description

    +

    __backup_id

    +

    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.

    +

    __data_origin

    +

    String

    +

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

    +

    __description

    +

    String

    +

    Specifies the image description.

    +

    __image_location

    +

    String

    +

    Specifies the location where the image is stored.

    +

    __image_size

    +

    String

    +

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

    +

    __image_source_type

    +

    String

    +

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

    +

    __is_config_init

    +

    String

    +

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

    +

    __isregistered

    +

    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.

    +

    __lazyloading

    +

    String

    +

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

    +

    __originalimagename

    +

    String

    +

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

    +

    __imagetype

    +

    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.
    +

    protected

    +

    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.

    +

    virtual_env_type

    +

    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.
    +

    virtual_size

    +

    Integer

    +

    This parameter is unavailable currently.

    +

    visibility

    +

    String

    +

    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

    +

    String

    +

    Specifies the tenant to which the image belongs.

    +

    id

    +

    String

    +

    Specifies the image ID.

    +

    status

    +

    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.
    +

    name

    +

    String

    +

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

    +

    container_format

    +

    String

    +

    Specifies the container type.

    +

    disk_format

    +

    String

    +

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

    +

    min_ram

    +

    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.

    +

    max_ram

    +

    String

    +

    Specifies the maximum memory (MB) of the image.

    +

    min_disk

    +

    Integer

    +

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

    +

    __os_bit

    +

    String

    +

    Specifies the OS architecture, 32 bit or 64 bit.

    +

    __os_feature_list

    +

    String

    +

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

    +

    __platform

    +

    String

    +

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

    +

    schema

    +

    String

    +

    Specifies the image schema.

    +

    self

    +

    String

    +

    Specifies the image URL.

    +

    size

    +

    Integer

    +

    This parameter is unavailable currently.

    +

    __os_type

    +

    String

    +

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

    +

    __os_version

    +

    String

    +

    Specifies the OS version.

    +

    tags

    +

    Array of strings

    +

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

    +

    __support_kvm

    +

    String

    +

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

    +

    __support_xen

    +

    String

    +

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

    +

    __support_largememory

    +

    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.

    +

    __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. For details about the image OSs supported by disk-intensive ECSs, see Table 4.

    +

    __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. For details about the image OSs supported by high-performance computing ECSs, see Table 4.

    +

    __support_xen_gpu_type

    +

    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.

    +

    __support_kvm_gpu_type

    +

    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.

    +

    __support_xen_hana

    +

    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.

    +

    __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.

    +

    __root_origin

    +

    String

    +

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

    +

    __sequence_num

    +

    String

    +

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

    +

    Example value: 0

    +

    __support_fc_inject

    +

    String

    +

    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

    +

    String

    +

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

    +

    updated_at

    +

    String

    +

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

    +

    active_at

    +

    String

    +

    Specifies the time when the image status became active.

    +

    checksum

    +

    String

    +

    This parameter is unavailable currently.

    +

    hw_firmware_type

    +

    String

    +

    Specifies the ECS boot mode. Available values include:

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

    file

    +

    String

    +

    Specifies the URL for uploading and downloading the image file.

    +

    enterprise_project_id

    +

    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.
    +

    __support_amd

    +

    String

    +

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

    +

    __system__cmkid

    +

    String

    +

    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"
+}
+
    + +
    +
+
+

Returned Values

  • Normal

    200

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

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

    +

    401 Unauthorized

    +

    Authentication failed.

    +

    403 Forbidden

    +

    You do not have the rights to perform the operation.

    +

    404 Not Found

    +

    The requested resource was not found.

    +

    500 Internal Server Error

    +

    Internal service error.

    +

    503 Service Unavailable

    +

    The service is unavailable.

    +
    +
    +
+
+
+
+
+
Parent topic: Image (Native OpenStack APIs)
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0060804960.html b/docs/ims/api-ref/en-us_topic_0060804960.html new file mode 100644 index 000000000..12eeebe3e --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0060804960.html @@ -0,0 +1,772 @@ + + +

Updating Image Information (Native OpenStack API)

+

Function

This API is used to modify image information.

+
+

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 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

image_id

+

Yes

+

String

+

Specifies the image ID.

+

For details about how to obtain the image ID, see Querying Images.

+
+
+
+

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 2 v2.1 request message body

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    [Array]

    +

    Yes

    +

    Array of objects

    +

    For details, see Table 3.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 3 Data structure description of the [Array] field

    Parameter

    +

    Type

    +

    Mandatory

    +

    Description

    +

    op

    +

    String

    +

    Yes

    +

    Indicates the type of the update operation, including replacing, adding, and deleting an attribute.

    +

    The value can be replace, add, or remove.

    +

    path

    +

    String

    +

    Yes

    +

    Indicates the name of the target attribute.

    +

    For replace and remove, the value can only be an existing attribute of the image. For add, the value can be an existing or a new attribute. If the value is an existing attribute, add takes the same effect as replace. If the value is a new attribute, the add operation is performed. Add a slash (/) before the attribute name.

    +

    value

    +

    String

    +

    No

    +

    Indicates the value of the attribute to be updated or added.

    +

    Mandatory for replace and add, and not for remove

    +
    +
    + +
    + + + + + + + + + + + +
    Table 4 v2.0 request message body

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    [Array]

    +

    Yes

    +

    Array of objects

    +

    For details, see Table 5.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 5 Data structure description of the [Array] field

    Parameter

    +

    Type

    +

    Mandatory

    +

    Description

    +

    replace

    +

    String

    +

    Mandatory for any of the three values

    +

    Indicates that an image attribute will be replaced. The value is the attribute to be replaced and a slash (/) must be added in front of the attribute name.

    +

    add

    +

    String

    +

    Indicates that an image attribute will be added. The value is the attribute to be added and a slash (/) must be added in front of the attribute name.

    +

    remove

    +

    String

    +

    Indicates that an image attribute will be deleted. The value is the attribute to be deleted and a slash (/) must be added in front of the attribute name.

    +

    value

    +

    String

    +

    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"       
+     }
+]     
+
      + +
      +
    +
+
+

Response

  • Response parameters +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    file

    +

    String

    +

    Specifies the URL for uploading and downloading the image file.

    +

    owner

    +

    String

    +

    Specifies the tenant to which the image belongs.

    +

    id

    +

    String

    +

    Specifies the image ID.

    +

    size

    +

    Long

    +

    This parameter is unavailable currently.

    +

    self

    +

    String

    +

    Specifies the image URL.

    +

    schema

    +

    String

    +

    Specifies the image schema.

    +

    status

    +

    String

    +

    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

    +

    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.

    +

    visibility

    +

    String

    +

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

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

    name

    +

    String

    +

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

    +

    checksum

    +

    String

    +

    This parameter is unavailable currently.

    +

    protected

    +

    Boolean

    +

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

    +

    container_format

    +

    String

    +

    Specifies the container type.

    +

    min_ram

    +

    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.

    +

    max_ram

    +

    String

    +

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

    +

    updated_at

    +

    String

    +

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

    +

    __os_bit

    +

    String

    +

    Specifies the OS architecture, 32 bit or 64 bit.

    +

    __os_version

    +

    String

    +

    Specifies the OS version.

    +

    __description

    +

    String

    +

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

    +

    disk_format

    +

    String

    +

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

    +

    __isregistered

    +

    String

    +

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

    +

    __platform

    +

    String

    +

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

    +

    __os_type

    +

    String

    +

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

    +

    __system__cmkid

    +

    String

    +

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

    +

    min_disk

    +

    Integer

    +

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

    +

    virtual_env_type

    +

    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.
    +

    __image_source_type

    +

    String

    +

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

    +

    __imagetype

    +

    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.
    +

    created_at

    +

    String

    +

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

    +

    virtual_size

    +

    Integer

    +

    This parameter is unavailable currently.

    +

    __originalimagename

    +

    String

    +

    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

    +

    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.

    +

    __image_size

    +

    String

    +

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

    +

    __data_origin

    +

    String

    +

    Specifies the image source.

    +

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

    +

    __root_origin

    +

    String

    +

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

    +

    __lazyloading

    +

    String

    +

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

    +

    active_at

    +

    String

    +

    Specifies the time when the image status became active.

    +

    __os_feature_list

    +

    String

    +

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

    +

    __account_code

    +

    String

    +

    Specifies the charging identifier for the image.

    +

    hw_firmware_type

    +

    String

    +

    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

    +

    String

    +

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

    +

    __support_kvm

    +

    String

    +

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

    +

    __support_xen

    +

    String

    +

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

    +

    __support_largememory

    +

    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.

    +

    For the supported OSs, see Table 4.

    +

    +

    __support_diskintensive

    +

    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.

    +

    __support_highperformance

    +

    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.

    +

    __support_xen_gpu_type

    +

    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.

    +

    __support_kvm_gpu_type

    +

    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 parameter cannot co-exist with __support_xen and __support_kvm.

    +

    __support_xen_hana

    +

    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 parameter cannot co-exist with __support_xen and __support_kvm.

    +

    __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 parameter cannot co-exist with __support_xen.

    +

    enterprise_project_id

    +

    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, see Enterprise Management User Guide.

      +
    +

    __sequence_num

    +

    String

    +

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

    +

    This parameter is unavailable currently.

    +

    __support_fc_inject

    +

    String

    +

    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

    +

    String

    +

    Specifies the location where the image is stored.

    +

    __is_config_init

    +

    String

    +

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

    +

    __support_amd

    +

    String

    +

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

    +

    __support_agent_list

    +

    String

    +

    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.

      +
    +

    Example:

    +

    "__support_agent_list": "hss,ces"

    +
    NOTE:
    • If the response does not contain this field, the HSS and host monitoring agents are not configured for the image.
    • HSS has not been available on the cloud platform. So, you only need to focus on the value ces.
    +
    +
    +
    +
  • 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"
+}
+
    + +
    +
+
+

Returned Values

  • Normal

    200

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    Request error. For details, see Error Codes.

    +

    401 Unauthorized

    +

    Authentication failed.

    +

    403 Forbidden

    +

    You do not have the rights to perform the operation.

    +

    404 Not Found

    +

    The requested resource was not found.

    +

    500 Internal Server Error

    +

    Internal service error.

    +

    503 Service Unavailable

    +

    The service is unavailable.

    +
    +
    +
+
+
+
+
+
Parent topic: Image (Native OpenStack APIs)
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0066978719.html b/docs/ims/api-ref/en-us_topic_0066978719.html new file mode 100644 index 000000000..93c20b1fc --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0066978719.html @@ -0,0 +1,254 @@ + + +

Querying API Versions (Native OpenStack API)

+

Function

This API is used to query API versions, such as version compatibility and domain name information of APIs.

+
+

URI

GET /

+
+

Request

  • Request parameters

    None

    +
  • Example request
    GET https://{Endpoint}/
    +
+
+

Response

  • Response parameters +
    + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    versions

    +

    Array of objects

    +

    Specifies the versions.

    +

    For details, see Table 1.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + +
    Table 1 Data structure description of the versions field

    Parameter

    +

    Type

    +

    Description

    +

    status

    +

    String

    +

    Specifies the API status.

    +

    id

    +

    String

    +

    Specifies the API ID.

    +

    links

    +

    Array of objects

    +

    Specifies the description.

    +

    For details, see Table 2.

    +
    +
    + +
    + + + + + + + + + + + + + +
    Table 2 Data structure description of the versions.links field

    Parameter

    +

    Type

    +

    Description

    +

    href

    +

    String

    +

    Specifies the domain name.

    +

    rel

    +

    String

    +

    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"
+                }
+            ]
+        }
+    ]
+}
+
    + +
    +
+
+

Returned Values

  • Normal

    300

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    Request error.

    +

    401 Unauthorized

    +

    Authentication failed.

    +

    403 Forbidden

    +

    You do not have the rights to perform the operation.

    +

    404 Not Found

    +

    The requested resource was not found.

    +

    500 Internal Server Error

    +

    Internal service error.

    +

    503 Service Unavailable

    +

    The service is unavailable.

    +
    +
    +
+
+
+
+
+
Parent topic: API Version Query (Native OpenStack API)
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0066978720.html b/docs/ims/api-ref/en-us_topic_0066978720.html new file mode 100644 index 000000000..6e4ce9663 --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0066978720.html @@ -0,0 +1,340 @@ + + +

Querying Image Details (Native OpenStack API v1.1 - Abandoned and Not Recommended)

+

Function

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.

+
+

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.

    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    name

    +

    No

    +

    String

    +

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

    +

    container_format

    +

    No

    +

    String

    +

    Image container type

    +

    disk_format

    +

    No

    +

    String

    +

    Image file format

    +

    status

    +

    No

    +

    String

    +

    Image status

    +

    size_min

    +

    No

    +

    String

    +

    Minimum size of the image

    +

    size_max

    +

    No

    +

    String

    +

    Maximum size of the image

    +

    changes-since

    +

    No

    +

    String

    +

    Last update time

    +
    +
    +
  • Example request
    GET https://{Endpoint}/v1.1/images/detail?disk_format=qcow2
    +
+
+

Response

  • Response parameters +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    status

    +

    String

    +

    Image status

    +

    virtual_size

    +

    Integer

    +

    Virtual size of an image

    +

    name

    +

    String

    +

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

    +

    deleted

    +

    Boolean

    +

    Whether an image has been deleted

    +

    container_format

    +

    String

    +

    Image container type

    +

    created_at

    +

    String

    +

    Time when an image was created

    +

    disk_format

    +

    String

    +

    Image file type

    +

    updated_at

    +

    String

    +

    Time when an image was updated

    +

    properties

    +

    Object

    +

    Image attribute

    +

    owner

    +

    String

    +

    Tenant to which an image belongs

    +

    protected

    +

    Boolean

    +

    Whether an image is protected

    +

    min_ram

    +

    Integer

    +

    Minimum memory (MB) required for running an image

    +

    checksum

    +

    String

    +

    Image verification sum. This parameter is available after an image file is uploaded.

    +

    min_disk

    +

    Integer

    +

    Minimum disk capacity (GB) required for running the image

    +

    is_public

    +

    Boolean

    +

    Whether an image is a public one

    +

    deleted_at

    +

    String

    +

    Time when an image was deleted

    +

    id

    +

    String

    +

    Image UUID

    +

    size

    +

    Integer

    +

    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
+{
+    "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

    +

    Description

    +

    400 Bad Request

    +

    Request error.

    +

    401 Unauthorized

    +

    Authentication failed.

    +

    403 Forbidden

    +

    You do not have the rights to perform the operation.

    +

    404 Not Found

    +

    The requested resource was not found.

    +

    500 Internal Server Error

    +

    Internal service error.

    +

    503 Service Unavailable

    +

    The service is unavailable.

    +
    +
    +
+
+
+
+
+
Parent topic: Image (Native OpenStack APIs)
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0066978721.html b/docs/ims/api-ref/en-us_topic_0066978721.html new file mode 100644 index 000000000..84f871656 --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0066978721.html @@ -0,0 +1,270 @@ + + +

Querying Image Metadata (Native OpenStack API v1 - Abandoned and Not Recommended)

+

Function

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.

+
+

URI

HEAD /v1/images/{image_id}

+
Table 1 lists the parameters in the URI. +
+ + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

image_id

+

Yes

+

String

+

Specifies the image ID.

+
+
+
+
+

Request

  • Request parameters

    None

    +
  • Example request
    HEAD https://{Endpoint}/v1/images/3c3d1d01-b48a-4639-8a88-08be3b9b5d78
    +
+
+

Response

  • Response parameters +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    Status

    +

    String

    +

    Image status

    +

    Virtual_size

    +

    Integer

    +

    Virtual size of an image

    +

    Name

    +

    String

    +

    Image name

    +

    Deleted

    +

    Boolean

    +

    Whether an image has been deleted

    +

    Container_format

    +

    String

    +

    Image container type

    +

    Created_at

    +

    String

    +

    Time when an image was created

    +

    Disk_format

    +

    String

    +

    Image file type

    +

    Updated_at

    +

    String

    +

    Time when an image was updated

    +

    Property

    +

    Object

    +

    Image attribute

    +

    Owner

    +

    String

    +

    Tenant to which an image belongs

    +

    Protected

    +

    Boolean

    +

    Whether an image is protected

    +

    Min_ram

    +

    Integer

    +

    Minimum memory (MB) required for running an image

    +

    Checksum

    +

    String

    +

    Image verification sum. This parameter is available after an image file is uploaded.

    +

    Min_disk

    +

    Integer

    +

    Minimum disk capacity (GB) required for running the image

    +

    Is_public

    +

    Boolean

    +

    Whether an image is a public one

    +

    Deleted_at

    +

    String

    +

    Time when an image was deleted

    +

    Id

    +

    String

    +

    Image UUID

    +

    Size

    +

    Integer

    +

    Image size. This parameter is available after an image file is uploaded.

    +
    +
    +

    These parameters are contained in the header of the HTTP response message.

    +
  • 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
    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

    +

    Description

    +

    400 Bad Request

    +

    Request error.

    +

    401 Unauthorized

    +

    Authentication failed.

    +

    403 Forbidden

    +

    You do not have the rights to perform the operation.

    +

    404 Not Found

    +

    The requested resource was not found.

    +

    500 Internal Server Error

    +

    Internal service error.

    +

    503 Service Unavailable

    +

    The service is unavailable.

    +
    +
    +
+
+
+
+
+
Parent topic: Image (Native OpenStack APIs)
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0066978722.html b/docs/ims/api-ref/en-us_topic_0066978722.html new file mode 100644 index 000000000..0c849ac68 --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0066978722.html @@ -0,0 +1,100 @@ + + +

Deleting an Image (Native OpenStack API v1.1 - Abandoned and Not Recommended)

+

Function

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 deleted status.

+

This API has been discarded. Deleting an Image (Native OpenStack API) is recommended.

+
+

URI

DELETE /v1.1/images/{image_id}

+
Table 1 lists the parameters in the URI. +
+ + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

image_id

+

Yes

+

String

+

Specifies the image ID.

+
+
+
+
+

Request

  • Request parameters

    None

    +
  • Example request
    DELETE https://{Endpoint}/v1.1/images/3c3d1d01-b48a-4639-8a88-08be3b9b5d78
    +
+
+

Response

  • Response parameters

    None

    +
  • Example response
    HTTP/1.1 200 OK
    +
    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

    +

    Description

    +

    400 Bad Request

    +

    Request error.

    +

    401 Unauthorized

    +

    Authentication failed.

    +

    403 Forbidden

    +

    You do not have the rights to perform the operation.

    +

    404 Not Found

    +

    The requested resource was not found.

    +

    500 Internal Server Error

    +

    Internal service error.

    +

    503 Service Unavailable

    +

    The service is unavailable.

    +
    +
    +
+
+
+
+
+
Parent topic: Image (Native OpenStack APIs)
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0067360381.html b/docs/ims/api-ref/en-us_topic_0067360381.html new file mode 100644 index 000000000..7bca26667 --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0067360381.html @@ -0,0 +1,162 @@ + + +

Adding or Modifying a Tag

+

Function

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.

+
+

URI

PUT /v1/cloudimages/tags

+
+

Request

  • Request parameters +
    + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    image_id

    +

    Yes

    +

    String

    +

    Specifies the image ID.

    +

    For details about how to obtain the image ID, see Querying Images.

    +

    tag

    +

    No

    +

    String

    +

    Specifies the tag.

    +

    Use either tag or image_tag.

    +

    image_tag

    +

    No

    +

    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.

    +
    +
    + +
    + + + + + + + + + + + + + + + + +
    Table 1 Data structure description of the image_tag field

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    key

    +

    Yes

    +

    String

    +

    Specifies the tag key.

    +

    value

    +

    Yes

    +

    String

    +

    Specifies the tag value.

    +
    +
    +
  • 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"}
+}
+
      + +
      +
    +
+
+

Response

  • Response parameters

    None

    +
  • Example response
    STATUS CODE 204
    +
+
+

Returned Values

  • Normal

    204

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    Request error.

    +

    401 Unauthorized

    +

    Authentication failed.

    +

    403 Forbidden

    +

    You do not have the rights to perform the operation.

    +

    404 Not Found

    +

    The requested resource was not found.

    +

    500 Internal Server Error

    +

    Internal service error.

    +

    503 Service Unavailable

    +

    The service is unavailable.

    +
    +
    +
+
+
+
+
+
Parent topic: Image Tagging
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0067360382.html b/docs/ims/api-ref/en-us_topic_0067360382.html new file mode 100644 index 000000000..fd616ee65 --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0067360382.html @@ -0,0 +1,470 @@ + + +

Querying Tags

+

Function

This API is used to query image tags using search criteria and display them in a list.

+
+

URI

GET /v1/cloudimages/tags{?__isregistered,__imagetype,__whole_image,__system__cmkid,protected,visibility,owner,id,status,name,container_format,disk_format,min_ram,min_disk,__os_bit,__platform,marker,limit,sort_key,sort_dir,__os_type,tag,member_status,__support_kvm,__support_xen,__support_largememory,__support_diskintensive,__support_highperformance,__support_xen_gpu_type,__support_kvm_gpu_type,__support_xen_hana,__support_kvm_infiniband,virtual_env_type,enterprise_project_id,created_at,updated_at}

+

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.

+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

__isregistered

+

No

+

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.

+

__imagetype

+

No

+

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.
+
NOTE:

The __imagetype of images you share with other tenants or those other tenants share with you and you have accepted is shared. You can use field owner to distinguish the two types of shared images. You can use member_status to filter out shared images you have accepted.

+
+

__whole_image

+

No

+

Boolean

+

Specifies whether the image is a full-ECS image. The value can be true or false.

+

__system__cmkid

+

No

+

String

+

Specifies the ID of the key used to encrypt the image. You can obtain the ID from the IMS console or by calling the Querying Image Details (Native OpenStack API) API.

+

protected

+

No

+

Boolean

+

Specifies whether the image is protected. The value can be true or false. Set it to true when you query public images. This parameter is optional when you query private images.

+

visibility

+

No

+

String

+

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

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

owner

+

No

+

String

+

Specifies the tenant to which the image belongs.

+

id

+

No

+

String

+

Specifies the image ID.

+

status

+

No

+

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.
+

name

+

No

+

String

+

Specifies the image name. Exact matching is used. For detailed description, see Image Attributes.

+

container_format

+

No

+

String

+

Specifies the container type. The value is bare.

+

disk_format

+

No

+

String

+

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

+

min_ram

+

No

+

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.

+

min_disk

+

No

+

Integer

+

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

+

__os_bit

+

No

+

String

+

Specifies the OS architecture, 32 bit or 64 bit.

+

__platform

+

No

+

String

+

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

+

marker

+

No

+

String

+

Specifies the start number from which images are queried. The value is the image ID.

+

limit

+

No

+

Integer

+

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

+

sort_key

+

No

+

String

+

Specifies the field for sorting the query results. The value can be an attribute of the image: name, container_format, disk_format, status, id, size, or created_at. The default value is created_at.

+

sort_dir

+

No

+

String

+

Specifies whether the query results are sorted in ascending or descending order. Its value can be desc (default) or asc. This parameter is used together with parameter sort_key. The default value is desc.

+

__os_type

+

No

+

String

+

Specifies the image OS type. Available values include:

+
  • Linux
  • Windows
  • Other
+

tag

+

No

+

String

+

Specifies a tag added to an image. Tags can be used as a filter to query images.

+
NOTE:

The tagging function has been upgraded. If the tags added before the function upgrade are in the format of "Key.Value", query tags using "Key=Value". For example, an existing tag is a.b. After the tag function upgrade, query the tag using "tag=a=b".

+
+

member_status

+

No

+

String

+

Specifies the member status. The value can be accepted, rejected, or pending. accepted: indicates that the shared image is accepted. rejected indicates that the image shared by others is rejected. pending indicates that the image shared by others needs to be confirmed. To use this parameter, set visibility to shared during the query.

+

__support_kvm

+

No

+

String

+

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

+

__support_xen

+

No

+

String

+

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

+

__support_largememory

+

No

+

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 the supported OSs, see Table 4.

+

+

__support_diskintensive

+

No

+

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.

+

__support_highperformance

+

No

+

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.

+

__support_xen_gpu_type

+

No

+

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.

+

__support_kvm_gpu_type

+

No

+

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.

+

__support_xen_hana

+

No

+

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.

+

__support_kvm_infiniband

+

No

+

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.

+

virtual_env_type

+

No

+

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.
+

enterprise_project_id

+

No

+

String

+
Specifies the enterprise project to which the images to be queried belong.
  • If the value is 0, images of enterprise project default are to be queried.
  • If the value is UUID, images of the enterprise project corresponding to the UUID are to be queried.
  • If the value is all_granted_eps, images of all enterprise projects are to be queried.

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

    +
+
+

created_at

+

No

+

String

+

Specifies the time when the image was created. 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.

+

For example, to query images created before Oct 28, 2018 10:00:00, set the value of created_at as follows:

+

created_at=lt:2018-10-28T10:00:00Z

+

updated_at

+

No

+

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.

+

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.

+

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
    +
+
+

Response

  • Response parameters +
    + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    tags

    +

    Array of strings

    +

    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"
+   ]
+}
+
    + +
    +

    In the new specification, equal signs are used as separators.

    +
    +
+
+

Returned Values

  • Normal

    200

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

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

    +

    401 Unauthorized

    +

    Authentication failed.

    +

    403 Forbidden

    +

    You do not have the rights to perform the operation.

    +

    404 Not Found

    +

    The requested resource was not found.

    +

    500 Internal Server Error

    +

    Internal service error.

    +

    503 Service Unavailable

    +

    The service is unavailable.

    +
    +
    +
+
+
+
+
+
Parent topic: Image Tagging
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0083905788.html b/docs/ims/api-ref/en-us_topic_0083905788.html new file mode 100644 index 000000000..bac09a507 --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0083905788.html @@ -0,0 +1,272 @@ + + +

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.

+
+

URI

POST /v1/cloudimages/dataimages/action

+
+

Request

  • Request parameters +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    name

    +

    Yes

    +

    String

    +

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

    +

    description

    +

    No

    +

    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.

    +

    os_type

    +

    No

    +

    String

    +

    Specifies the OS type.

    +

    It can only be Windows or Linux. The default is Linux.

    +

    image_url

    +

    Yes

    +

    String

    +

    Specifies the URL of the external image file in the OBS bucket.

    +

    The format is OBS bucket name:Image file name.

    +
    NOTE:

    The storage class of the OBS bucket must be Standard.

    +
    +

    min_disk

    +

    Yes

    +

    Integer

    +

    Specifies the minimum size of the data disk.

    +

    Value range: 40 GB to 2048 GB

    +

    cmk_id

    +

    No

    +

    String

    +

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

    +

    tags

    +

    No

    +

    Array of strings

    +

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

    +

    For detailed parameter description, see Image Tag Data Formats.

    +

    Use either tags or image_tags.

    +

    image_tags

    +

    No

    +

    Array of ImageTag objects

    +

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

    +

    Use either tags or image_tags.

    +

    enterprise_project_id

    +

    No

    +

    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.

      +
    +
    +
    + +
    + + + + + + + + + + + + + + + + +
    Table 1 Data structure description of the image_tags field

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    key

    +

    No

    +

    string

    +

    Specifies the tag key.

    +

    value

    +

    No

    +

    string

    +

    Specifies the tag value.

    +
    +
    +
  • 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"
+}
+
      + +
      +
    +
+
+

Response

  • Response parameters +
    + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    job_id

    +

    String

    +

    Specifies the asynchronous job ID.

    +

    For details, see Asynchronous Job Query.

    +
    +
    +
  • Example response
    STATUS CODE 200
    +
    1
+2
+3
    {
+    "job_id": "4010a32b5f909853015f90aaa24b0015"
+}
+
    + +
    +
+
+

Returned Values

  • Normal

    200

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

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

    +

    401 Unauthorized

    +

    Authentication failed.

    +

    403 Forbidden

    +

    You do not have the rights to perform the operation.

    +

    404 Not Found

    +

    The requested resource was not found.

    +

    500 Internal Server Error

    +

    Internal service error.

    +

    503 Service Unavailable

    +

    The service is unavailable.

    +
    +
    +
+
+
+
+
+
Parent topic: Image
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0092380109.html b/docs/ims/api-ref/en-us_topic_0092380109.html new file mode 100644 index 000000000..5d8f3f5ff --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0092380109.html @@ -0,0 +1,422 @@ + + +

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.

+
+

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.

    + +
    + + + + + + + + + + + + + +
    Table 1 SAN policies in Windows

    Type

    +

    Description

    +

    OnlineAll

    +

    All newly detected disks are automatically brought online.

    +

    OfflineShared

    +

    All disks on sharable buses, such as iSCSI and FC, are left offline by default, while disks on non-sharable buses are kept online.

    +

    OfflineInternal

    +

    All newly detected disks are left offline.

    +
    +
    +
    1. Execute cmd.exe and run the following command to query the current SAN policy of the ECS:

      diskpart

      +
    2. Run the following command to view the SAN policy of the ECS:
      san
      • If the SAN policy is OnlineAll, run the exit command to exit DiskPart.
      +
      +
      • If the SAN policy is not OnlineAll, go to 3.
      +
    3. Run the following command to change the SAN policy of the ECS to OnlineAll:

      san policy=onlineall

      +
    +
+
+

Constraints (Creating a Full-ECS Image Using a CSBS Backup)

  • When creating a full-ECS image from a CSBS backup, ensure that the source ECS of the CSBS backup has been properly configured, or the image creation may fail.
  • If an ECS is in Stopped state, do not start it when you are using it to create a full-ECS image.
  • A CSBS backup used to create a full-ECS image cannot have shared disks.
  • Only an available CSBS backup can be used to create a full-ECS image. A CSBS backup can be used to create only one full-ECS image.
  • A full-ECS image cannot be exported or replicated.
+
+

Constraints (Creating a Full-ECS Image Using a CBR Backup)

  • When creating a full-ECS image from a CBR backup, ensure that the source ECS of the CBR backup has been properly configured, or the image creation may fail.
  • A CBR backup can be used to create only one full-ECS image.
  • If an ECS is in Stopped state, do not start it when you are using it to create a full-ECS image.
  • A full-ECS image created from a CBR backup can be shared with other tenants. However, if it is a shared CBR backup, the full-ECS image created from it cannot be shared.
  • A full-ECS image cannot be exported or replicated.
+
+

URI

POST /v1/cloudimages/wholeimages/action

+
+

Request

  • Parameters for creating a full-ECS image using an ECS +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    name

    +

    Yes

    +

    String

    +

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

    +

    description

    +

    No

    +

    String

    +

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

    +

    tags

    +

    No

    +

    Array of strings

    +

    Lists the image tags. The value is left blank by default.

    +

    Use either tags or image_tags.

    +

    image_tags

    +

    No

    +

    Array of objects

    +

    Lists the image tags. The value is left blank by default.

    +

    Use either tags or image_tags.

    +

    instance_id

    +

    Yes

    +

    String

    +

    Specifies the ECS ID. This parameter is required when an ECS is used to create a full-ECS image.

    +

    To obtain the ECS ID, perform the following operations:

    +
    1. Log in to management console.
    2. Under Computing, click Elastic Cloud Server.
    3. In the ECS list, click the name of the ECS and view its ID.
    +

    enterprise_project_id

    +

    No

    +

    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.

      +
    +

    max_ram

    +

    No

    +

    Integer

    +

    Specifies the maximum memory of the image in the unit of MB. This parameter is not configured by default.

    +

    min_ram

    +

    No

    +

    Integer

    +

    Specifies the minimum memory of the image in the unit of MB. The default value is 0.

    +

    vault_id

    +

    No

    +

    String

    +

    Specifies the ID of the vault to which an ECS is to be added or has been added.

    +

    To create a full-ECS image from an ECS, create a backup from the ECS and then use the backup to create a full-ECS image. If a CBR backup is created, vault_id is mandatory. If a CSBS backup is created, vault_id is optional.

    +

    You can obtain the vault ID from the CBR console or section "Querying the Vault List" in Cloud Backup and Recovery API Reference.

    +
    +
    +
  • Parameters in the request body when a CSBS backup or CBR backup is used to create a full-ECS image +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    name

    +

    Yes

    +

    String

    +

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

    +

    description

    +

    No

    +

    String

    +

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

    +

    tags

    +

    No

    +

    Array of strings

    +

    Lists the image tags. The value is left blank by default.

    +

    Use either tags or image_tags.

    +

    image_tags

    +

    No

    +

    Array of objects

    +

    Lists the image tags. The value is left blank by default.

    +

    Use either tags or image_tags.

    +

    backup_id

    +

    Yes

    +

    String

    +

    Specifies the CSBS backup ID or CBR backup ID.

    +
    To obtain the CSBS backup ID, perform the following operations:
    1. Log in to the management console.
    2. Under Storage, click Cloud Server Backup Service.
    3. In the backup list, expand details of the backup to obtain its ID.
    +
    +
    To obtain the CBR backup ID, perform the following operations:
    1. Log in to the management console.
    2. Under Storage, click Cloud Backup and Recovery.
    3. On the displayed Cloud Server Backup page, click the Backups tab and obtain the backup ID from the backup list.
    +
    +

    enterprise_project_id

    +

    No

    +

    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.

      +
    +

    max_ram

    +

    No

    +

    Integer

    +

    Specifies the maximum memory of the image in the unit of MB. This parameter is not configured by default.

    +

    min_ram

    +

    No

    +

    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.

    +

    whole_image_type

    +

    No

    +

    String

    +

    Specifies the method of creating a full-ECS image.

    +
    • If a CBR backup is used to create a full-ECS image, this parameter is mandatory and the value must be CBR. In this case, backup_id is the CBR backup ID.
    • If a CSBS backup is used to create a full-ECS image, this parameter can be left blank and the default value CSBS will be used. In this case, backup_id is the CSBS backup ID.
    +
    +
    +
  • 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"}]
+}
+
      + +
      +
    +
+
+

Response

  • Response parameters +
    + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    job_id

    +

    String

    +

    Specifies the asynchronous job ID.

    +

    For details, see Asynchronous Job Query.

    +
    +
    +
  • Example response
    STATUS CODE 200
    +
    1
+2
+3
    {
+    "job_id": "4010a32b5f909853015f90aaa24b0015"
+}
+
    + +
    +
+
+

Returned Values

  • Normal

    200

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

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

    +

    401 Unauthorized

    +

    Authentication failed.

    +

    403 Forbidden

    +

    You do not have the rights to perform the operation.

    +

    404 Not Found

    +

    The requested resource was not found.

    +

    500 Internal Server Error

    +

    Internal service error.

    +

    503 Service Unavailable

    +

    The service is unavailable.

    +
    +
    +
+
+
+
+
+
Parent topic: Image
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0093967371.html b/docs/ims/api-ref/en-us_topic_0093967371.html new file mode 100644 index 000000000..3ecdf3421 --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0093967371.html @@ -0,0 +1,15 @@ + + +

Image Quota

+
+
+ + +
+
Parent topic: IMS APIs
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0093967372.html b/docs/ims/api-ref/en-us_topic_0093967372.html new file mode 100644 index 000000000..b3b1bd74e --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0093967372.html @@ -0,0 +1,179 @@ + + +

Querying the Image Quota

+

Function

This extension API is used to query the quota of private images of a tenant in the current region.

+
+

URI

GET /v1/cloudimages/quota

+
+

Request

  • Request parameters

    None

    +
  • Example request
    GET https://{Endpoint}/v1/cloudimages/quota
    +
+
+

Response

  • Response parameters +
    + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    quotas

    +

    Object

    +

    Specifies the quota information.

    +

    For details, see Table 1.

    +
    +
    + +
    + + + + + + + + + +
    Table 1 Data structure description of the quotas field

    Parameter

    +

    Type

    +

    Description

    +

    resources

    +

    Array of objects

    +

    Specifies the images included in the quota.

    +

    For details, see Table 2.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 2 Data structure description of the quotas.resources field

    Parameter

    +

    Type

    +

    Description

    +

    type

    +

    String

    +

    Specifies the type of the resource to be queried.

    +

    used

    +

    Integer

    +

    Specifies the used quota.

    +

    quota

    +

    Integer

    +

    Specifies the total quota.

    +

    min

    +

    Integer

    +

    Specifies the minimum quota.

    +

    max

    +

    Integer

    +

    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
+      }
+    ]
+  }
+}
+
    + +
    +
+
+

Returned Values

  • Normal

    200

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    Request error. For details, see Error Codes.

    +

    401 Unauthorized

    +

    Authentication failed.

    +

    403 Forbidden

    +

    You do not have the rights to perform the operation.

    +

    404 Not Found

    +

    The requested resource was not found.

    +

    500 Internal Server Error

    +

    Internal service error.

    +

    503 Service Unavailable

    +

    The service is unavailable.

    +
    +
    +
+
+
+
+
+
Parent topic: Image Quota
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0102682861.html b/docs/ims/api-ref/en-us_topic_0102682861.html new file mode 100644 index 000000000..19d968c1d --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0102682861.html @@ -0,0 +1,689 @@ + + +

Querying Images by Tag

+

Function

This API is used to filter or count images using tags or other conditions.

+
+

Constraints

To be compatible with remaining tags, the system will not verify the character set of the tag keys and values in the query condition when parameters tags not_tags, tags_any, and not_tags_any are used.

+
+

URI

POST /v2/{project_id}/images/resource_instances/action

+
Table 1 lists the parameters in the URI. +
+ + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+
+
+
+
+

Request

  • Request parameters +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    action

    +

    Yes

    +

    String

    +

    Identifies the operation. This parameter is case sensitive and its value can be filter or count.

    +
    • The value filter indicates pagination query.
    • The value count indicates that the total number of query results meeting the search criteria will be returned.
    +

    tags

    +

    No

    +

    Array of objects

    +

    Includes all specified tags. A maximum of 10 tag keys are allowed for each query operation. Each tag key can contain a maximum of 10 tag values. Both tag keys and values must be unique. The tag keys cannot be left blank.

    +

    For details, see Table 2.

    +

    tags_any

    +

    No

    +

    Array of objects

    +

    Includes any of specified tags. A maximum of 10 tag keys are allowed for each query operation. Each tag key can contain a maximum of 10 tag values. Both tag keys and values must be unique. The tag keys cannot be left blank and set to an empty string.

    +

    For details, see Table 3.

    +

    not_tags

    +

    No

    +

    Array of objects

    +

    Excludes all specified tags. A maximum of 10 tag keys are allowed for each query operation. Each tag key can contain a maximum of 10 tag values. Both tag keys and values must be unique. The tag keys cannot be left blank.

    +

    For details, see Table 4.

    +

    not_tags_any

    +

    No

    +

    Array of objects

    +

    Excludes any of specified tags. A maximum of 10 tag keys are allowed for each query operation. Each tag key can contain a maximum of 10 tag values. Both tag keys and values must be unique. The tag keys cannot be left blank.

    +

    For details, see Table 5.

    +

    without_any_tag

    +

    No

    +

    Boolean

    +

    If this parameter is set to true, all resources without tags are queried. In this case, the tag, not_tags, tags_any, and not_tags_any fields are ignored.

    +

    limit

    +

    No

    +

    String

    +

    Specifies the maximum number of query records. This parameter is invalid when action is set to count. If action is set to filter, the parameter limit takes effect and its default value is 10. The value of limit ranges from 1 to 1000.

    +

    offset

    +

    No

    +

    String

    +

    Specifies the index position. The query starts from the next image indexed by this parameter. This parameter is not required when data on the first page is queried, and it is invalid when action is set to count. If action is set to filter, the default value of offset is 0. The value of offset cannot be a negative number.

    +

    matches

    +

    No

    +

    Array of objects

    +

    Specifies the search criteria. The tag key is the field to match, for example, resource_name or resource_id. value indicates the matched value. Keys in this list must be unique. The parameter cannot be left blank and may not be transferred.

    +

    For details, see Table 6.

    +
    +
    + +
    + + + + + + + + + + + + + + + + +
    Table 2 Data structure description of the tags field

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    key

    +

    Yes

    +

    String

    +

    Specifies the tag key. The tag key contains a maximum of 127 Unicode characters and cannot be left blank.

    +

    values

    +

    Yes

    +

    Array of strings

    +

    Lists the tag values. Each value can contain a maximum of 255 Unicode characters. If this parameter is left blank, any value is matched. If multiple values are listed, images that have any of the values will be returned.

    +
    +
    + +
    + + + + + + + + + + + + + + + + +
    Table 3 Data structure description of the tags_any field

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    key

    +

    Yes

    +

    String

    +

    Specifies the tag key. The tag key contains a maximum of 127 Unicode characters and cannot be left blank.

    +

    values

    +

    Yes

    +

    Array of strings

    +

    Lists the tag values. Each value can contain a maximum of 255 Unicode characters. If this parameter is left blank, any value is matched. If multiple values are listed, images that have any of the values will be returned.

    +
    +
    + +
    + + + + + + + + + + + + + + + + +
    Table 4 Data structure description of the not_tags field

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    key

    +

    Yes

    +

    String

    +

    Specifies the tag key. The tag key contains a maximum of 127 Unicode characters and cannot be left blank.

    +

    values

    +

    Yes

    +

    Array of strings

    +

    Lists the tag values. Each value can contain a maximum of 255 Unicode characters. If this parameter is left blank, any value is matched. If multiple values are listed, images that have any of the values will be returned.

    +
    +
    + +
    + + + + + + + + + + + + + + + + +
    Table 5 Data structure description of the not_tags_any field

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    key

    +

    Yes

    +

    String

    +

    Specifies the tag key. The tag key contains a maximum of 127 Unicode characters and cannot be left blank.

    +

    values

    +

    Yes

    +

    Array of strings

    +

    Lists the tag values. Each value can contain a maximum of 255 Unicode characters. If this parameter is left blank, any value is matched. When multiple values are specified and the key requirements are met, images that have any of the specified values are queried.

    +
    +
    + +
    + + + + + + + + + + + + + + + + +
    Table 6 Data structure description of the matches field

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    key

    +

    Yes

    +

    String

    +

    Specifies the tag key, that is to say, the field name for the query operation. Valid values include resource_name and resource_id.

    +

    If the field name is resource_name and the value is an empty string, exact query is performed. Otherwise, fuzzy query is performed based on the image name. If the field name is resource_id, exact query is performed based on the image ID.

    +

    value

    +

    Yes

    +

    String

    +

    Specifies the tag value. It cannot be left blank. Each value can contain a maximum of 255 Unicode characters.

    +
    +
    +
  • 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"]
+   }]
+}
+
      + +
      +
    +
+
+

Response

  • Response parameters +
    + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    resources

    +

    Array of resource objects

    +

    Lists the images.

    +

    total_count

    +

    Integer

    +

    Specifies the total number of query records.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 7 Data structure description of the resource field

    Parameter

    +

    Type

    +

    Description

    +

    resource_id

    +

    String

    +

    Specifies the image ID.

    +

    resource_detail

    +

    ResourceDetail object

    +

    Provides image details.

    +

    tags

    +

    Array of Tags objects

    +

    Lists the image tags.

    +

    resource_name

    +

    String

    +

    Specifies the image name.

    +
    +
    + +
    + + + + + + + + + + + +
    Table 8 ResourceDetail object

    Parameter

    +

    Type

    +

    Mandatory

    +

    Description

    +

    status

    +

    string

    +

    Yes

    +

    Specifies the image status.

    +
    +
    + +
    + + + + + + + + + + + + + +
    Table 9 Data structure description of the resource_tag field

    Parameter

    +

    Type

    +

    Description

    +

    key

    +

    String

    +

    Specifies the key of the tag.

    +

    value

    +

    String

    +

    Specifies the value of the tag.

    +
    +
    +
+
  • Example response
    • Example response when action is set to count
      STATUS CODE 200
      +
      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"
+   }]
+}
+
      + +
      +
    +
+
+

Returned Values

  • Normal

    200

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    Request error.

    +

    401 Unauthorized

    +

    Authentication failed.

    +

    403 Forbidden

    +

    You do not have the rights to perform the operation.

    +

    404 Not Found

    +

    The requested resource was not found.

    +

    500 Internal Server Error

    +

    Internal service error.

    +

    503 Service Unavailable

    +

    The service is unavailable.

    +
    +
    +
+
+
+
+
+
Parent topic: Image Tagging
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0102682862.html b/docs/ims/api-ref/en-us_topic_0102682862.html new file mode 100644 index 000000000..02ab1f197 --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0102682862.html @@ -0,0 +1,233 @@ + + +

Adding or Deleting Image Tags in Batches

+

Function

This API is used to add tags to, update tags of, or delete tags from an image in batches.

+
+

Constraints

  • Each tag consists of a key and a value. The key contains at most 36 characters, and the value contains at most 43 characters. The key cannot be left blank or an empty character string. The value cannot be left blank but can be an empty character string.
  • An image can have a maximum of 10 tags.
  • The keys of multiple tags in the request body must be unique.
  • This API is an idempotent one.

    If a tag to be added has the same key as an existing tag, but the tag values are different, this tag will be added and overwrite the existing one. If a tag to be added has the same key and value as an existing tag, this tag will not be added.

    +

    If the specified tag does not exist, the deletion is considered successful by default.

    +
+
  • Restrictions on tag keys and values during batch deletion

    During the deletion, the system will not verify the character set range of the key and value. The key cannot be left blank or an empty character string. The value is optional and will not be not verified. If the tag to be deleted does not exist, the deletion is considered successful and no error is reported. Also, the system will not verify the length of both the key and value. The key can contain a maximum of 127 characters, and the value contains a maximum of 255 characters.

    +
+
+

URI

POST /v2/{project_id}/images/{image_id}/tags/action

+
Table 1 lists the parameters in the URI. +
+ + + + + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+

image_id

+

Yes

+

String

+

Specifies the image ID.

+
+
+
+
+

Request

  • Request parameters +
    + + + + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    tags

    +

    Yes

    +

    Array of objects

    +

    Lists the tags to be added or deleted. For details, see Table 2.

    +

    action

    +

    Yes

    +

    String

    +

    Specifies the tag operation to be performed. The value is case sensitive and can be create or delete. create indicates that tags will be added or updated, while delete indicates that tags will be deleted.

    +
    +
    + +
    + + + + + + + + + + + + + + + + +
    Table 2 Data structure description of the tags field

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    key

    +

    Yes

    +

    String

    +

    Specifies the tag key. The tag key cannot be left blank.

    +

    value

    +

    Yes

    +

    String

    +

    Specifies the tag value.

    +
    +
    +
  • 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"
+}
+
      + +
      +
    +
+
+

Response

  • Response parameters

    None

    +
  • Example response
    STATUS CODE 204
    +
+
+

Returned Values

  • Normal

    204

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    Request error.

    +

    401 Unauthorized

    +

    Authentication failed.

    +

    403 Forbidden

    +

    You do not have the rights to perform the operation.

    +

    404 Not Found

    +

    The requested resource was not found.

    +

    500 Internal Server Error

    +

    Internal service error.

    +

    503 Service Unavailable

    +

    The service is unavailable.

    +
    +
    +
+
+
+
+
+
Parent topic: Image Tagging
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0102682863.html b/docs/ims/api-ref/en-us_topic_0102682863.html new file mode 100644 index 000000000..4834f773d --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0102682863.html @@ -0,0 +1,168 @@ + + +

Adding an Image Tag

+

Function

This API is used to add a tag to an image or update a tag.

+
+

Constraints

  • Each tag consists of a key and a value. The key contains at most 36 characters, and the value contains at most 43 characters. The key cannot be left blank or an empty character string. The value cannot be left blank but can be an empty character string.
  • An image can have a maximum of 10 tags.
  • This API is an idempotent API. If a tag to be added has the same key as an existing tag, but the tag values are different, this tag will be added and overwrite the existing one. If a tag to be added has the same key and value as an existing tag, this tag will not be added.
+
+

URI

POST /v2/{project_id}/images/{image_id}/tags

+
Table 1 lists the parameters in the URI. +
+ + + + + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+

image_id

+

Yes

+

String

+

Specifies the image ID.

+
+
+
+
+

Request

  • Request parameters +
    + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    tag

    +

    Yes

    +

    Object

    +

    Specifies the tag to be added or updated. For details, see Table 2.

    +
    +
    + +
    + + + + + + + + + + + + + + + + +
    Table 2 Data structure description of the tag field

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    key

    +

    Yes

    +

    String

    +

    Specifies the tag key. The tag key cannot be left blank.

    +

    value

    +

    Yes

    +

    String

    +

    Specifies the tag value.

    +
    +
    +
  • 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"
+   }
+}
+
    + +
    +
+
+

Response

  • Response parameters

    None

    +
  • Example response
    STATUS CODE 204
    +
+
+

Returned Values

  • Normal

    204

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    Request error.

    +

    401 Unauthorized

    +

    Authentication failed.

    +

    403 Forbidden

    +

    You do not have the rights to perform the operation.

    +

    404 Not Found

    +

    The requested resource was not found.

    +

    500 Internal Server Error

    +

    Internal service error.

    +

    503 Service Unavailable

    +

    The service is unavailable.

    +
    +
    +
+
+
+
+
+
Parent topic: Image Tagging
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0102682864.html b/docs/ims/api-ref/en-us_topic_0102682864.html new file mode 100644 index 000000000..b71b364e9 --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0102682864.html @@ -0,0 +1,109 @@ + + +

Deleting an Image Tag

+

Function

This API is used to delete a specified tag from an image.

+
+

Constraints

  • To be compatible with remaining tags, the system will not verify the character set and length of the keys and values in the query condition.
  • This API is a non-idempotent one. If the key to be deleted does not exist, status code 404 is returned.
+
+

URI

DELETE /v2/{project_id}/images/{image_id}/tags/{key}

+
Table 1 lists the parameters in the URI. +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+

image_id

+

Yes

+

String

+

Specifies the image ID.

+

key

+

Yes

+

String

+

Specifies the key of the tag to be deleted.

+
+
+
+
+

Request

  • Request parameters

    None

    +
  • Example request
    DELETE https://{Endpoint}/v2/fd73a4a14a4a4dfb9771a8475e5198ea/images/67e17426-359e-49fb-aa12-0bd1756ec240/tags/key1
    +
+
+

Response

  • Response parameters

    None

    +
  • Example response
    STATUS CODE 204
    +
+
+

Returned Values

  • Normal

    204

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    Request error.

    +

    401 Unauthorized

    +

    Authentication failed.

    +

    403 Forbidden

    +

    You do not have the rights to perform the operation.

    +

    404 Not Found

    +

    The requested resource was not found.

    +

    500 Internal Server Error

    +

    Internal service error.

    +

    503 Service Unavailable

    +

    The service is unavailable.

    +
    +
    +
+
+
+
+
+
Parent topic: Image Tagging
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0102682865.html b/docs/ims/api-ref/en-us_topic_0102682865.html new file mode 100644 index 000000000..08b778667 --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0102682865.html @@ -0,0 +1,164 @@ + + +

Querying Tags of an Image

+

Function

This API is used to query all the tags of a specified image.

+
+

URI

GET /v2/{project_id}/images/{image_id}/tags

+
Table 1 lists the parameters in the URI. +
+ + + + + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+

image_id

+

Yes

+

String

+

Specifies the image ID.

+
+
+
+
+

Request

  • Request parameters

    None

    +
  • Example request
    GET https://{Endpoint}/v2/fd73a4a14a4a4dfb9771a8475e5198ea/images/67e17426-359e-49fb-aa12-0bd1756ec240/tags
    +
+
+

Response

  • Response parameters +
    + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    tags

    +

    Array of objects

    +

    Lists the returned tags. For details, see Table 2.

    +
    +
    + +
    + + + + + + + + + + + + + +
    Table 2 Data structure description of the tags field

    Parameter

    +

    Type

    +

    Description

    +

    key

    +

    String

    +

    Specifies the tag key.

    +

    value

    +

    String

    +

    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"
+   }]
+}
+
    + +
    +
+
+

Returned Values

  • Normal

    200

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    Request error.

    +

    401 Unauthorized

    +

    Authentication failed.

    +

    403 Forbidden

    +

    You do not have the rights to perform the operation.

    +

    404 Not Found

    +

    The requested resource was not found.

    +

    500 Internal Server Error

    +

    Internal service error.

    +

    503 Service Unavailable

    +

    The service is unavailable.

    +
    +
    +
+
+
+
+
+
Parent topic: Image Tagging
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0102682866.html b/docs/ims/api-ref/en-us_topic_0102682866.html new file mode 100644 index 000000000..f5adac0e7 --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0102682866.html @@ -0,0 +1,167 @@ + + +

Querying All Image Tags

+

Function

This API is used to query all the image tags.

+
+

URI

GET /v2/{project_id}/images/tags

+
Table 1 lists the parameters in the URI. +
+ + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+
+
+
+
+

Request

  • Request parameters

    None

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

Response

  • Response parameters +
    + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    tags

    +

    Array of objects

    +

    Lists tags. For details, see Table 2.

    +
    +
    + +
    + + + + + + + + + + + + + +
    Table 2 Data structure description of the tags field

    Parameter

    +

    Type

    +

    Description

    +

    key

    +

    String

    +

    Specifies the tag key.

    +

    values

    +

    Array of 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"
+   }]
+}
+
    + +
    +
+
+

Returned Values

  • Normal

    200

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    Request error

    +

    401 Unauthorized

    +

    Authentication failed.

    +

    403 Forbidden

    +

    You do not have the rights to perform the operation.

    +

    404 Not Found

    +

    The requested resource was not found.

    +

    500 Internal Server Error

    +

    Internal service error

    +

    503 Service Unavailable

    +

    The service is unavailable.

    +
    +
    +
+
+
+
+
+
Parent topic: Image Tagging
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0121643825.html b/docs/ims/api-ref/en-us_topic_0121643825.html new file mode 100644 index 000000000..d7b3a8ef2 --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0121643825.html @@ -0,0 +1,116 @@ + + +

Status Codes

+
  • Normal +
    + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    200 OK

    +

    The results of GET and PUT operations are returned as expected.

    +

    201 Created

    +

    The results of the POST operation are returned as expected.

    +

    202 Accepted

    +

    The request has been accepted for processing.

    +

    204 No Content

    +

    The results of the DELETE operation are returned as expected.

    +
    +
    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    The server failed to process the request.

    +

    401 Unauthorized

    +

    You must enter a username and password to access the requested page.

    +

    403 Forbidden

    +

    You are forbidden to access the requested page.

    +

    404 Not Found

    +

    The server cannot find the requested page.

    +

    405 Method Not Allowed

    +

    You are not allowed to use the method specified in the request.

    +

    406 Not Acceptable

    +

    The response generated by the server cannot be accepted by the client.

    +

    407 Proxy Authentication Required

    +

    You must use the proxy server for authentication so that the request can be processed.

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of a service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request. The service is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0122410333.html b/docs/ims/api-ref/en-us_topic_0122410333.html new file mode 100644 index 000000000..db3b50928 --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0122410333.html @@ -0,0 +1,21 @@ + + +

IMS APIs

+
+
+ +
+ diff --git a/docs/ims/api-ref/en-us_topic_0122410334.html b/docs/ims/api-ref/en-us_topic_0122410334.html new file mode 100644 index 000000000..62f88d126 --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0122410334.html @@ -0,0 +1,31 @@ + + +

Image (Native OpenStack APIs)

+
+
+ + +
+
Parent topic: Native OpenStack APIs
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0122410335.html b/docs/ims/api-ref/en-us_topic_0122410335.html new file mode 100644 index 000000000..3c5559cbb --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0122410335.html @@ -0,0 +1,17 @@ + + +

Image Tagging (Native OpenStack APIs)

+
+
+ + +
+
Parent topic: Native OpenStack APIs
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0122410336.html b/docs/ims/api-ref/en-us_topic_0122410336.html new file mode 100644 index 000000000..116ce7dc9 --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0122410336.html @@ -0,0 +1,23 @@ + + +

Image Sharing (Native OpenStack APIs)

+
+
+ + +
+
Parent topic: Native OpenStack APIs
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0125866389.html b/docs/ims/api-ref/en-us_topic_0125866389.html new file mode 100644 index 000000000..c2660d614 --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0125866389.html @@ -0,0 +1,21 @@ + + +

Permission Policies and Supported Actions

+
+
+ +
+ diff --git a/docs/ims/api-ref/en-us_topic_0125866390.html b/docs/ims/api-ref/en-us_topic_0125866390.html new file mode 100644 index 000000000..eed86ae3d --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0125866390.html @@ -0,0 +1,237 @@ + + +

Image Management

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Permissions

+

APIs

+

Actions

+

IAM Project

+

Enterprise Project

+

Querying Images

+

GET /v2/cloudimages

+

ims:images:list

+

√

+

√

+

Updating Image Information

+

PATCH /v2/cloudimages/{image_id}

+
  • ims:images:update
  • ims:serverImages:create (only for migration to enterprise projects)
+

√

+

√

+

Creating an Image

+

POST /v2/cloudimages/action

+
NOTE:

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

+
+

ims:serverImages:create

+

√

+

√

+

Importing an Image File Quickly

+

POST /v2/cloudimages/quickimport/action

+
NOTE:

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

+
+
  • ims:serverImages:create (required only for quickly importing system disk images)
  • ims:dataImages:create (required only for quickly importing data disk images)
+

√

+

√

+

Creating a Data Disk Image Using an External Image File

+

POST /v1/cloudimages/dataimages/action

+
NOTE:

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

+
+

ims:dataImages:create

+

√

+

√

+

Creating a Full-ECS Image

+

POST /v1/cloudimages/wholeimages/action

+
NOTE:

Before creating a full-ECS image, ensure that you have the CSBS Administrator permission of the CSBS service or the CBR Admin permission of the CBR service.

+
+

ims:wholeImages:create

+

√

+

√

+

Registering an Image

+

PUT /v1/cloudimages/{image_id}/upload

+
NOTE:

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

+
+

ims:images:upload

+

√

+

√

+

Exporting an Image

+

POST /v1/cloudimages/{image_id}/file

+
NOTE:

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

+
+

ims:images:export

+

√

+

√

+

Querying Images (Native OpenStack API)

+

GET /v2/images

+

ims:images:list

+

√

+

x

+

Querying Image Details (Native OpenStack API)

+

GET /v2/images/{image_id}

+

ims:images:get

+

√

+

√

+

Updating Image Information (Native OpenStack API)

+

PATCH /v2/images/{image_id}

+

ims:images:update

+

√

+

√

+

Deleting an Image (Native OpenStack API)

+

DELETE /v2/images/{image_id}

+

ims:images:delete

+

√

+

√

+

Creating Image Metadata (Native OpenStack API)

+

POST /v2/images

+

ims:images:create

+

√

+

x

+

Uploading an Image (Native OpenStack API)

+

PUT /v2/images/{image_id}/file

+
  • ims:images:get
  • ims:images:update
  • ims:images:upload
+

√

+

x

+

Querying the API Version (Native OpenStack API)

+

GET /

+

N/A

+

√

+

x

+

Querying Image Details (Native OpenStack API v1.1 - Abandoned and Not Recommended)

+

GET /v1.1/images/detail

+

ims:images:list

+

√

+

x

+

Querying Image Metadata (Native OpenStack API v1 - Abandoned and Not Recommended)

+

HEAD /v1/images/{image_id}

+

ims:images:get

+

√

+

x

+

Deleting an Image (Native OpenStack API V1.1, Abandoned and Not Recommended)

+

DELETE /v1.1/images/{image_id}

+

ims:images:delete

+

√

+

x

+
+
+

+
+
+
+
Parent topic: Permission Policies and Supported Actions
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0125866391.html b/docs/ims/api-ref/en-us_topic_0125866391.html new file mode 100644 index 000000000..2419cf190 --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0125866391.html @@ -0,0 +1,136 @@ + + +

Image Tagging

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Permissions

+

APIs

+

Actions

+

IAM Project

+

Enterprise Project

+

Adding a Tag (Native OpenStack API)

+

PUT /v2/images/{image_id}/tags/{tag}

+
  • ims:images:get
  • ims:images:update
+

√

+

x

+

Deleting a Tag (Native OpenStack API)

+

DELETE /v2/images/{image_id}/tags/{tag}

+
  • ims:images:get
  • ims:images:update
+

√

+

x

+

Adds or modifies a tag.

+

PUT /v1/cloudimages/tags

+
  • ims:images:get
  • ims:images:update
+

√

+

x

+

Queries tags.

+

GET /v1/cloudimages/tags

+

ims:images:list

+

√

+

x

+

Queries images by tag.

+

POST /v2/{project_id}/images/resource_instances/action

+

ims:images:list

+

√

+

x

+

Adds or deletes image tags in a batch.

+

POST /v2/{project_id}/images/{image_id}/tags/action

+

ims:images:update

+

√

+

x

+

Adds an image tag.

+

POST /v2/{project_id}/images/{image_id}/tags

+

ims:images:update

+

√

+

x

+

Deletes an image tag.

+

DELETE /v2/{project_id}/images/{image_id}/tags/{key}

+

ims:images:update

+

√

+

x

+

Queries tags of an image.

+

GET /v2/{project_id}/images/{image_id}/tags

+

ims:images:list

+

√

+

x

+

Queries all image tags.

+

GET /v2/{project_id}/images/tags

+

ims:images:list

+

√

+

x

+
+
+
+
+
+
Parent topic: Permission Policies and Supported Actions
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0125866392.html b/docs/ims/api-ref/en-us_topic_0125866392.html new file mode 100644 index 000000000..02baafd4a --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0125866392.html @@ -0,0 +1,70 @@ + + +

Image Schema

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Permissions

+

APIs

+

Actions

+

IAM Project

+

Enterprise Project

+

Querying an Image Schema (Native OpenStack API)

+

GET /v2/schemas/image

+

N/A

+

√

+

x

+

Querying an Image List Schema (Native OpenStack API)

+

GET /v2/schemas/images

+

N/A

+

√

+

x

+

Querying an Image Member Schema (Native OpenStack API)

+

GET /v2/schemas/member

+

N/A

+

√

+

x

+

Querying an Image Member List Schema (Native OpenStack API)

+

GET /v2/schemas/members

+

N/A

+

√

+

x

+
+
+
+
+
+
Parent topic: Permission Policies and Supported Actions
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0125866393.html b/docs/ims/api-ref/en-us_topic_0125866393.html new file mode 100644 index 000000000..2f080d0ea --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0125866393.html @@ -0,0 +1,114 @@ + + +

Image Sharing

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Permissions

+

APIs

+

Actions

+

IAM Project

+

Enterprise Project

+

Adding an Image Member (Native OpenStack API)

+

POST /v2/images/{image_id}/members

+
  • ims:images:get
  • ims:images:share
+

√

+

x

+

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

+

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

+
  • ims:images:get
  • ims:images:share
+

√

+

x

+

Querying Image Member Details (Native OpenStack API)

+

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

+
  • ims:images:get
  • ims:images:share
+

√

+

x

+

Querying Image Members (Native OpenStack API)

+

GET /v2/images/{image_id}/members

+
  • ims:images:get
  • ims:images:share
+

√

+

x

+

Deleting an Image Member (Native OpenStack API)

+

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

+
  • ims:images:get
  • ims:images:share
+

√

+

x

+

Adds image members.

+

POST /v1/cloudimages/members

+

ims:images:share

+

√

+

x

+

Updates the status of image members in batches.

+

PUT /v1/cloudimages/members

+

ims:images:share

+

√

+

x

+

Deletes image members in batches.

+

DELETE /v1/cloudimages/members

+

ims:images:share

+

√

+

x

+
+
+
+
+
+
Parent topic: Permission Policies and Supported Actions
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0125866394.html b/docs/ims/api-ref/en-us_topic_0125866394.html new file mode 100644 index 000000000..541e191b3 --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0125866394.html @@ -0,0 +1,37 @@ + + +

Image Replication

+
+
+ + + + + + + + + + + + + +

Permissions

+

APIs

+

Actions

+

IAM Project

+

Enterprise Project

+

Replicating an Image Within a Region

+

POST /v1/cloudimages/{image_id}/copy

+
  • ims:images:copy
  • ims:serverImages:create (required only for users who have enabled the enterprise project)
+

√

+

√

+
+
+
+
+
+
Parent topic: Permission Policies and Supported Actions
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0125866395.html b/docs/ims/api-ref/en-us_topic_0125866395.html new file mode 100644 index 000000000..8319f6445 --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0125866395.html @@ -0,0 +1,37 @@ + + +

Image Quota

+
+
+ + + + + + + + + + + + + +

Permissions

+

APIs

+

Actions

+

IAM Project

+

Enterprise Project

+

Queries the image quota

+

GET /v1/cloudimages/quota

+

ims:quotas:get

+

√

+

√

+
+
+
+
+
+
Parent topic: Permission Policies and Supported Actions
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0133188204.html b/docs/ims/api-ref/en-us_topic_0133188204.html new file mode 100644 index 000000000..f44e3d781 --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0133188204.html @@ -0,0 +1,426 @@ + + +

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.

+
+

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.
+
+

For how to convert image file formats and generate a bitmap file, see section "Quickly Importing an Image File" in the Image Management Service User Guide.

+
+
+

URI

POST /v2/cloudimages/quickimport/action

+
+

Request

  • Parameters in the request body when an image file is used to create a system disk image +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    name

    +

    Yes

    +

    String

    +

    Specifies the image name.

    +

    For detailed description, see Image Attributes.

    +

    description

    +

    No

    +

    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.

    +

    os_version

    +

    Yes

    +

    String

    +

    Specifies the OS version.

    +

    This parameter is valid if an external image file uploaded to the OBS bucket is used to create an image. For its value, see Values of Related Parameters.

    +

    image_url

    +

    Yes

    +

    String

    +

    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.

    +
    +

    min_disk

    +

    Yes

    +

    Integer

    +

    Specifies the minimum size (GB) of the system disk.

    +
    • 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 and must be greater than the size of the selected image file.
    +

    tags

    +

    No

    +

    Array of strings

    +

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

    +

    Set either tags or image_tags.

    +

    image_tags

    +

    No

    +

    Array of objects

    +

    Lists the image tags. The value is left blank by default.

    +

    Set either tags or image_tags.

    +

    type

    +

    No

    +

    String

    +

    Specifies the image type. The parameter value is ECS/BMS for system disk images. The default value is ECS.

    +

    enterprise_project_id

    +

    No

    +

    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.

      +
    +

    architecture

    +

    No

    +

    String

    +

    Specifies the image architecture type. Available values include:

    +
    • x86
    • arm
    +

    The default value is x86.

    +
    NOTE:

    If the image architecture is ARM, the boot mode is automatically changed to UEFI.

    +
    +
    +
    +
  • Parameters description when an image file uploaded to the OBS bucket is used to create an image +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    name

    +

    Yes

    +

    String

    +

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

    +

    description

    +

    No

    +

    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.

    +

    os_type

    +

    No

    +

    String

    +

    Specifies the OS version.

    +

    When a data disk image created, the value can be Linux or Windows. The default is Linux.

    +

    image_url

    +

    Yes

    +

    String

    +

    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.

    +
    +

    min_disk

    +

    Yes

    +

    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.

    +

    tags

    +

    No

    +

    Array of strings

    +

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

    +

    Set either tags or image_tags.

    +

    image_tags

    +

    No

    +

    Array of objects

    +

    Lists the image tags. The value is left blank by default.

    +

    Set either tags or image_tags.

    +

    type

    +

    Yes

    +

    String

    +

    Specifies the image type. The parameter value is DataImage for data disk images.

    +

    enterprise_project_id

    +

    No

    +

    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.

      +
    +
    +
    +
  • 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"}]
+}
+
      + +
      +
    +
+
+

Response

  • Response parameters +
    + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    job_id

    +

    String

    +

    Specifies the asynchronous job ID.

    +

    For details, see Asynchronous Job Query.

    +
    +
    +
  • Example response
    STATUS CODE 200
    +
    1
+2
+3
    {
+     "job_id": "8a12fc664fb4daa3014fb4e581380005"
+}
+
    + +
    +
+
+

Returned Values

  • Normal

    200

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + +

    Return Value

    +

    Description

    +

    400 Bad Request

    +

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

    +

    401 Unauthorized

    +

    Authentication failed.

    +

    403 Forbidden

    +

    You do not have the rights to perform the operation.

    +

    404 Not Found

    +

    The requested resource was not found.

    +

    500 Internal Server Error

    +

    Internal service error.

    +

    503 Service Unavailable

    +

    The service is unavailable.

    +
    +
    +
+
+
+
+
+
Parent topic: Image
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0135460761.html b/docs/ims/api-ref/en-us_topic_0135460761.html new file mode 100644 index 000000000..9093ed3d3 --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0135460761.html @@ -0,0 +1,29 @@ + + +

Image

+
+
+ + +
+
Parent topic: IMS APIs
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0135481402.html b/docs/ims/api-ref/en-us_topic_0135481402.html new file mode 100644 index 000000000..9bf6297c8 --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0135481402.html @@ -0,0 +1,29 @@ + + +

Image Tagging

+
+
+ + +
+
Parent topic: IMS APIs
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0135481403.html b/docs/ims/api-ref/en-us_topic_0135481403.html new file mode 100644 index 000000000..e49e80b33 --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0135481403.html @@ -0,0 +1,17 @@ + + +

Common Parameters

+
+
+ +
+ diff --git a/docs/ims/api-ref/en-us_topic_0135482660.html b/docs/ims/api-ref/en-us_topic_0135482660.html new file mode 100644 index 000000000..18456265c --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0135482660.html @@ -0,0 +1,19 @@ + + +

Image Sharing

+
+
+ + +
+
Parent topic: IMS APIs
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0160121770.html b/docs/ims/api-ref/en-us_topic_0160121770.html new file mode 100644 index 000000000..512907eb1 --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0160121770.html @@ -0,0 +1,19 @@ + + +

Native OpenStack APIs

+
+
+ +
+ diff --git a/docs/ims/api-ref/en-us_topic_0170918587.html b/docs/ims/api-ref/en-us_topic_0170918587.html new file mode 100644 index 000000000..4def4681b --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0170918587.html @@ -0,0 +1,17 @@ + + +

API Version Query (Native OpenStack API)

+
+
+ + +
+
Parent topic: Native OpenStack APIs
+
+
+ diff --git a/docs/ims/api-ref/en-us_topic_0170918588.html b/docs/ims/api-ref/en-us_topic_0170918588.html new file mode 100644 index 000000000..d880f09df --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0170918588.html @@ -0,0 +1,198 @@ + + +

Querying an API Version (Native OpenStack API)

+

Function

This API is used to query a specified API version, such as version compatibility and domain name information of an API.

+
+

URI

GET /{api_version}

+

Table 1 lists the parameters in the URI.

+ +
+ + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

api_version

+

Yes

+

String

+

Specifies the API version, for example v2.0.

+
+
+
+

Request

  • Request parameters

    None

    +
  • Example request
    GET https://{Endpoint}/v2.0
    +
+
+

Response

  • Response parameters +
    + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    versions

    +

    Array of objects

    +

    Specifies the version.

    +

    For details, see Table 2.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + +
    Table 2 Data structure description of the versions field

    Parameter

    +

    Type

    +

    Description

    +

    status

    +

    String

    +

    Specifies the API status.

    +

    id

    +

    String

    +

    Specifies the API ID.

    +

    links

    +

    Array of objects

    +

    Specifies the description.

    +

    For details, see Table 3.

    +
    +
    + +
    + + + + + + + + + + + + + +
    Table 3 Data structure description of the versions.links field

    Parameter

    +

    Type

    +

    Description

    +

    href

    +

    String

    +

    Specifies the domain name.

    +

    rel

    +

    String

    +

    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"
+                }
+            ]
+        }
+    ]
+}
+
    + +
    +
+
+

Returned Values

  • Normal

    300

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + +

    Returned Values

    +

    Description

    +

    400 Bad Request

    +

    Request error.

    +

    401 Unauthorized

    +

    Authentication failed.

    +

    403 Forbidden

    +

    You do not have the rights to perform the operation.

    +

    404 Not Found

    +

    The requested resource was not found.

    +

    500 Internal Server Error

    +

    Internal service error.

    +

    503 Service Unavailable

    +

    The service is unavailable.

    +
    +
    +
+
+
+
+
+
Parent topic: API Version Query (Native OpenStack API)
+
+
+ diff --git a/docs/ims/api-ref/public_sys-resources/icon-arrowdn.gif b/docs/ims/api-ref/public_sys-resources/icon-arrowdn.gif index 84eec9be2f2ce458e888f8a9b803f9387247726a..379428032932289326e52c2772bd90ba3d88b906 100644 GIT binary patch literal 1887 zcmZ?wbhEHbCgqow z*eU^C3h_d20o>TUVm+{T^pf*)^(zt!^bPe4Kwg3=^!3HBG&dKny0|1L72#g21{a4^ z7NqJ2r55Lx7A2Jm>Ih`8X1|p zSh~8p7&*iAy5uL9=BDPA!1Sgd^t#~G3rY&P1wfl!Qj0RnQd8WD@^clyUbf1_?G{Iz z=0WwQ;C71>PQCg-$LND17Ac}(Lcr7mV#1RxkONQnsd>QEUIa|mjQ{`r{qy_R&mZ5v zef{$J)5j0*-@SeF`qj%9&!0Vg^7zri2lwyYy>t84%^TORUA=Po(!~qs&z(JU`qar2 z$B!L7a`@1}1N-;w-Lrew&K=vgZQZhY)5ZeMTG_VdAT{+S(zE> zX{jm6Nr?&Zaj`McQIQehVWA3>*p!%p5Wn0u7E$th{n6D>ft^YU5&dnB%c=(a~-RV>2EO25SIA CZ-yWM literal 68 zcmZ?wbhEHbzkByxQ$u Mo$o?7J5~m305MV#!~g&Q diff --git a/docs/ims/api-ref/public_sys-resources/icon-arrowrt.gif b/docs/ims/api-ref/public_sys-resources/icon-arrowrt.gif index 39583d168d6db303b366b5b8c1780698a6bb6017..6aaaa11c23e919c4798d7dcd2b1ae98dd35dd316 100644 GIT binary patch literal 1890 zcmZ?wbhEHb7yetOgf{ zR2HP_2c;J0mlh?b0+lO+tSYc_E=o--$uA1Y&(DE{Vn9ZINq%ugeu08>u$h8JcxGNo zetEGbSiP^Wm1kaYNn&1ds;7&s63_&_%*+%k11Cod14Ab>6ALqQLqk^=3j-5FHzP|& zBUd9gQwvj9m|mCsATTyHM;rzL?XHK6w zdE)r7qel)OI(T6JzP)>P@7lRz`?jrHHgDRvVg0(bYgVsXxnlXUrArnsTDV~Tyt#8` z&zd=7`n0K2CQq6;p}()Ur@O1OqrI)QrMaoGp}wxRrn;)KqP(oMq`0WCAU`iRCp#-M zBRwrOB{?ZEAwDiPCORrIB0MZKBseHAz~9f;$J@)(!`;o*#o5Wx!QRf+#@fo#!raW% z#MsEtKwnQ+M_Wr%LtRZ(MOjHvL0(Q)Mp{ZzLR?H#L|8~rfS-?-hntI&gPo0)g_((w zfkE*n3y@@B&;b#k`jUY|nSq%>!ec`MLnAA%oR7zc2TpB#@>)|YCO&lN;uMU!b7Eqm H1A{dHTIz>f literal 70 zcmZ?wbhEHb