ac4cc65cb5
Contains .inc files which have all the contents of the .rst files but are grouped together for easier editing. Contains parameters.yaml, which has all parameters in one file. Contains request and response samples (JSON and XML) that are pointed to from the .inc files. Change-Id: I42d5451300f95774a3ec4df66bc95cb36795844d
246 lines
3.6 KiB
ReStructuredText
246 lines
3.6 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
==============
|
|
Image registry
|
|
==============
|
|
|
|
Use the image registry tool to manage images, add tags to and
|
|
remove tags from images, and define the user name for an instance
|
|
operating system. Each plugin lists required tags for an image. To
|
|
run remote operations, the Data Processing service requires a user
|
|
name with which to log in to the operating system for an instance.
|
|
|
|
|
|
Add tags to image
|
|
=================
|
|
|
|
.. rest_method:: POST /v1.1/{tenant_id}/images/{image_id}/tag
|
|
|
|
Adds tags to an image.
|
|
|
|
Error response codes:202,
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tags: tags
|
|
- image_id: image_id
|
|
|
|
Request Example
|
|
---------------
|
|
|
|
.. literalinclude:: ../samples/image-registry/image-tags-add-request.json
|
|
:language: javascript
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Show image details
|
|
==================
|
|
|
|
.. rest_method:: GET /v1.1/{tenant_id}/images/{image_id}
|
|
|
|
Shows details for an image.
|
|
|
|
|
|
Normal response codes: 200
|
|
Error response codes:
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- image_id: image_id
|
|
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- status: status
|
|
- username: username
|
|
- updated: updated
|
|
- description: description
|
|
- created: created
|
|
- image: image
|
|
- tags: tags
|
|
- minDisk: minDisk
|
|
- name: name
|
|
- progress: progress
|
|
- minRam: minRam
|
|
- id: id
|
|
- metadata: metadata
|
|
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ../samples/image-registry/image-show-response.json
|
|
:language: javascript
|
|
|
|
|
|
|
|
|
|
Register image
|
|
==============
|
|
|
|
.. rest_method:: POST /v1.1/{tenant_id}/images/{image_id}
|
|
|
|
Registers an image in the registry.
|
|
|
|
Error response codes:202,
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- username: username
|
|
- description: description
|
|
- image_id: image_id
|
|
|
|
Request Example
|
|
---------------
|
|
|
|
.. literalinclude:: ../samples/image-registry/image-register-request.json
|
|
:language: javascript
|
|
|
|
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- status: status
|
|
- username: username
|
|
- updated: updated
|
|
- description: description
|
|
- created: created
|
|
- image: image
|
|
- tags: tags
|
|
- minDisk: minDisk
|
|
- name: name
|
|
- progress: progress
|
|
- minRam: minRam
|
|
- id: id
|
|
- metadata: metadata
|
|
|
|
|
|
|
|
|
|
|
|
Unregister image
|
|
================
|
|
|
|
.. rest_method:: DELETE /v1.1/{tenant_id}/images/{image_id}
|
|
|
|
Removes an image from the registry.
|
|
|
|
Error response codes:204,
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- image_id: image_id
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Remove tags from image
|
|
======================
|
|
|
|
.. rest_method:: POST /v1.1/{tenant_id}/images/{image_id}/untag
|
|
|
|
Removes tags from an image.
|
|
|
|
Error response codes:202,
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tags: tags
|
|
- image_id: image_id
|
|
|
|
Request Example
|
|
---------------
|
|
|
|
.. literalinclude:: ../samples/image-registry/image-tags-delete-request.json
|
|
:language: javascript
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
List images
|
|
===========
|
|
|
|
.. rest_method:: GET /v1.1/{tenant_id}/images
|
|
|
|
Lists all images registered in the registry.
|
|
|
|
|
|
Normal response codes: 200
|
|
Error response codes:
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tags: tags
|
|
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- status: status
|
|
- username: username
|
|
- updated: updated
|
|
- description: description
|
|
- created: created
|
|
- image: image
|
|
- tags: tags
|
|
- minDisk: minDisk
|
|
- name: name
|
|
- images: images
|
|
- progress: progress
|
|
- minRam: minRam
|
|
- id: id
|
|
- metadata: metadata
|
|
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ../samples/image-registry/images-list-response.json
|
|
:language: javascript
|
|
|
|
|
|
|