openstack/nova - nova - OpenDev: Free Software Needs Free Tools

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

.. -*- rst -*-

complete Method Verification of aggregates This complete the Method Verification of aggregates, adjust the sequence of GET/POST, also, clean and correct some error return code. Part of bp:api-ref-in-rst Change-Id: I1536b804fbbd887fa4da2c35282add7e3994727a

2016年04月25日 12:46:22 +08:00

================================

Host aggregates (os-aggregates)

================================

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

Creates and manages host aggregates. An aggregate assigns metadata to

api-ref: mention policy defaults for aggregates Change-Id: I8202e825a7c0870a71a60875a7f42125317ff82b

2019年02月06日 16:18:24 -05:00

groups of compute nodes.

Policy defaults enable only users with the administrative role to perform

operations with aggregates. Cloud providers can change these permissions

through `policy file configuration

<https://docs.openstack.org/nova/latest/configuration/policy.html>`__.

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

complete Method Verification of aggregates This complete the Method Verification of aggregates, adjust the sequence of GET/POST, also, clean and correct some error return code. Part of bp:api-ref-in-rst Change-Id: I1536b804fbbd887fa4da2c35282add7e3994727a

2016年04月25日 12:46:22 +08:00

List Aggregates

===============

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

remove /v2.1/{tenant_id} from all urls As discussed at summit, the version part of the URL is not really relevant, or a thing a user should be filling out themselves, this should instead be set by the service catalog and extracted from the token. This removes it's reference in all documented REST urls, and adds a new section describing how one gets the base URL for all calls. Change-Id: I4306b8c3de0225e54f3909dd8a1fb293c4e5944c

2016年06月02日 08:50:03 -04:00

.. rest_method:: GET /os-aggregates

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

complete Method Verification of aggregates This complete the Method Verification of aggregates, adjust the sequence of GET/POST, also, clean and correct some error return code. Part of bp:api-ref-in-rst Change-Id: I1536b804fbbd887fa4da2c35282add7e3994727a

2016年04月25日 12:46:22 +08:00

Lists all aggregates. Includes the ID, name, and availability zone for each aggregate.

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

Normal response codes: 200

complete Method Verification of aggregates This complete the Method Verification of aggregates, adjust the sequence of GET/POST, also, clean and correct some error return code. Part of bp:api-ref-in-rst Change-Id: I1536b804fbbd887fa4da2c35282add7e3994727a

2016年04月25日 12:46:22 +08:00

Error response codes: unauthorized(401), forbidden(403)

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

Response

move sphinx h3 to '-' instead of '^' In the sphinx document h3 is supposed to be '-' not '^': =, for sections -, for subsections ^, for subsubsections We have to enforce consistency here because we're processing included files which all have to agree, otherwise it's a sphinx error. Part of bp:api-ref-in-rst Change-Id: Ic6eef5cacb07870f161b04b031e332f2b87aeedc

2016年04月14日 13:10:59 -04:00

--------

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

api-ref: parameter verification for os-aggregates checked parameters Part of bp:api-ref-in-rst Change-Id: I8fe3825243f8b94d5c3f382ebc30c342bffafcac

2016年05月12日 20:23:17 +08:00

.. rest_parameters:: parameters.yaml

- aggregates: aggregates

- availability_zone: aggregate_az

- created_at: created

- deleted_at: deleted_at

- deleted: deleted

- hosts: aggregate_host_list

- id: aggregate_id_body

api-ref: warn about changing/unsetting AZ name with instances It is currently possible to rename or unset the availability_zone metadata value on a host aggregate which can adversely impact instances that were created in that specific AZ since later attempts to migrate or unshelve those instances will fail if the AZ with the original name no longer exists. This adds a warning to the API reference for updating the AZ name and also fixes a grammar typo in the 'metadata' response parameter description. Change-Id: Ie9d4a1ff1a23827490fe51350c11292c6efc4eb2 Related-Bug: #1378904

2019年02月06日 16:11:40 -05:00

- metadata: aggregate_metadata_response

api-ref: parameter verification for os-aggregates checked parameters Part of bp:api-ref-in-rst Change-Id: I8fe3825243f8b94d5c3f382ebc30c342bffafcac

2016年05月12日 20:23:17 +08:00

- name: aggregate_name

- updated_at: updated_consider_null

Return uuid attribute for aggregates Adds a Compute API microversion that triggers returning an aggregate's UUID field. This field is necessary for scripts that must populate the placement API with resource provider to aggregate relationships, which rely on UUIDs for global identification. APIImpact blueprint: return-uuid-from-os-aggregates-api Change-Id: I4112ccd508eb85403933fec8b52efd468e866772 Closes-bug: #1652642

2016年12月26日 17:58:44 -05:00

- uuid: aggregate_uuid

api-ref: parameter verification for os-aggregates checked parameters Part of bp:api-ref-in-rst Change-Id: I8fe3825243f8b94d5c3f382ebc30c342bffafcac

2016年05月12日 20:23:17 +08:00

api-ref: Fix parameters and examples in aggregate API - The type of aggegate ID is changed to 'integer' instead of 'string'. - The uuid of aggegate is changed to 'required' because the uuid is always shown in the response after v2.41. - The response examples are replaced with v2.41 examples. Change-Id: Ib106898d32dc67e414f489468e91561ab0a5eb80 Closes-Bug: #1659475

2017年01月25日 23:55:43 +09:00

**Example List Aggregates (v2.41): JSON response**

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

api-ref: Fix parameters and examples in aggregate API - The type of aggegate ID is changed to 'integer' instead of 'string'. - The uuid of aggegate is changed to 'required' because the uuid is always shown in the response after v2.41. - The response examples are replaced with v2.41 examples. Change-Id: Ib106898d32dc67e414f489468e91561ab0a5eb80 Closes-Bug: #1659475

2017年01月25日 23:55:43 +09:00

.. literalinclude:: ../../doc/api_samples/os-aggregates/v2.41/aggregates-list-get-resp.json

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

:language: javascript

complete Method Verification of aggregates This complete the Method Verification of aggregates, adjust the sequence of GET/POST, also, clean and correct some error return code. Part of bp:api-ref-in-rst Change-Id: I1536b804fbbd887fa4da2c35282add7e3994727a

2016年04月25日 12:46:22 +08:00

Create Aggregate

================

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

remove /v2.1/{tenant_id} from all urls As discussed at summit, the version part of the URL is not really relevant, or a thing a user should be filling out themselves, this should instead be set by the service catalog and extracted from the token. This removes it's reference in all documented REST urls, and adds a new section describing how one gets the base URL for all calls. Change-Id: I4306b8c3de0225e54f3909dd8a1fb293c4e5944c

2016年06月02日 08:50:03 -04:00

.. rest_method:: POST /os-aggregates

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

Verify os-aggregates.inc on sample files verified all sample files is correct and adjust some format of the request Json file part of bp:api-ref-in-rst Change-Id: Ie9dd24858056337bcae9b03259d4f84de4fc1ab8

2016年07月05日 16:50:19 +08:00

Creates an aggregate. If specifying an option availability_zone, the aggregate is

created as an availability zone and the availability zone is visible to normal users.

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

Normal response codes: 200

complete Method Verification of aggregates This complete the Method Verification of aggregates, adjust the sequence of GET/POST, also, clean and correct some error return code. Part of bp:api-ref-in-rst Change-Id: I1536b804fbbd887fa4da2c35282add7e3994727a

2016年04月25日 12:46:22 +08:00

Error response codes: badRequest(400), unauthorized(401), forbidden(403), conflict(409)

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

Request

move sphinx h3 to '-' instead of '^' In the sphinx document h3 is supposed to be '-' not '^': =, for sections -, for subsections ^, for subsubsections We have to enforce consistency here because we're processing included files which all have to agree, otherwise it's a sphinx error. Part of bp:api-ref-in-rst Change-Id: Ic6eef5cacb07870f161b04b031e332f2b87aeedc

2016年04月14日 13:10:59 -04:00

-------

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

.. rest_parameters:: parameters.yaml

api-ref: parameter verification for os-aggregates checked parameters Part of bp:api-ref-in-rst Change-Id: I8fe3825243f8b94d5c3f382ebc30c342bffafcac

2016年05月12日 20:23:17 +08:00

- aggregate: aggregate

complete Method Verification of aggregates This complete the Method Verification of aggregates, adjust the sequence of GET/POST, also, clean and correct some error return code. Part of bp:api-ref-in-rst Change-Id: I1536b804fbbd887fa4da2c35282add7e3994727a

2016年04月25日 12:46:22 +08:00

- name: aggregate_name

api-ref: warn about changing/unsetting AZ name with instances It is currently possible to rename or unset the availability_zone metadata value on a host aggregate which can adversely impact instances that were created in that specific AZ since later attempts to migrate or unshelve those instances will fail if the AZ with the original name no longer exists. This adds a warning to the API reference for updating the AZ name and also fixes a grammar typo in the 'metadata' response parameter description. Change-Id: Ie9d4a1ff1a23827490fe51350c11292c6efc4eb2 Related-Bug: #1378904

2019年02月06日 16:11:40 -05:00

- availability_zone: aggregate_az_optional_create

complete Method Verification of aggregates This complete the Method Verification of aggregates, adjust the sequence of GET/POST, also, clean and correct some error return code. Part of bp:api-ref-in-rst Change-Id: I1536b804fbbd887fa4da2c35282add7e3994727a

2016年04月25日 12:46:22 +08:00

**Example Create Aggregate: JSON request**

.. literalinclude:: ../../doc/api_samples/os-aggregates/aggregate-post-req.json

:language: javascript

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

Response

move sphinx h3 to '-' instead of '^' In the sphinx document h3 is supposed to be '-' not '^': =, for sections -, for subsections ^, for subsubsections We have to enforce consistency here because we're processing included files which all have to agree, otherwise it's a sphinx error. Part of bp:api-ref-in-rst Change-Id: Ic6eef5cacb07870f161b04b031e332f2b87aeedc

2016年04月14日 13:10:59 -04:00

--------

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

api-ref: parameter verification for os-aggregates checked parameters Part of bp:api-ref-in-rst Change-Id: I8fe3825243f8b94d5c3f382ebc30c342bffafcac

2016年05月12日 20:23:17 +08:00

.. rest_parameters:: parameters.yaml

- aggregate: aggregate

- availability_zone: aggregate_az

- created_at: created

- deleted_at: deleted_at

- deleted: deleted

- id: aggregate_id_body

- name: aggregate_name

- updated_at: updated_consider_null

Return uuid attribute for aggregates Adds a Compute API microversion that triggers returning an aggregate's UUID field. This field is necessary for scripts that must populate the placement API with resource provider to aggregate relationships, which rely on UUIDs for global identification. APIImpact blueprint: return-uuid-from-os-aggregates-api Change-Id: I4112ccd508eb85403933fec8b52efd468e866772 Closes-bug: #1652642

2016年12月26日 17:58:44 -05:00

- uuid: aggregate_uuid

api-ref: parameter verification for os-aggregates checked parameters Part of bp:api-ref-in-rst Change-Id: I8fe3825243f8b94d5c3f382ebc30c342bffafcac

2016年05月12日 20:23:17 +08:00

api-ref: Fix parameters and examples in aggregate API - The type of aggegate ID is changed to 'integer' instead of 'string'. - The uuid of aggegate is changed to 'required' because the uuid is always shown in the response after v2.41. - The response examples are replaced with v2.41 examples. Change-Id: Ib106898d32dc67e414f489468e91561ab0a5eb80 Closes-Bug: #1659475

2017年01月25日 23:55:43 +09:00

**Example Create Aggregate (v2.41): JSON response**

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

api-ref: Fix parameters and examples in aggregate API - The type of aggegate ID is changed to 'integer' instead of 'string'. - The uuid of aggegate is changed to 'required' because the uuid is always shown in the response after v2.41. - The response examples are replaced with v2.41 examples. Change-Id: Ib106898d32dc67e414f489468e91561ab0a5eb80 Closes-Bug: #1659475

2017年01月25日 23:55:43 +09:00

.. literalinclude:: ../../doc/api_samples/os-aggregates/v2.41/aggregate-post-resp.json

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

:language: javascript

Show Aggregate Details

======================

remove /v2.1/{tenant_id} from all urls As discussed at summit, the version part of the URL is not really relevant, or a thing a user should be filling out themselves, this should instead be set by the service catalog and extracted from the token. This removes it's reference in all documented REST urls, and adds a new section describing how one gets the base URL for all calls. Change-Id: I4306b8c3de0225e54f3909dd8a1fb293c4e5944c

2016年06月02日 08:50:03 -04:00

.. rest_method:: GET /os-aggregates/{aggregate_id}

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

Shows details for an aggregate. Details include hosts and metadata.

Normal response codes: 200

complete Method Verification of aggregates This complete the Method Verification of aggregates, adjust the sequence of GET/POST, also, clean and correct some error return code. Part of bp:api-ref-in-rst Change-Id: I1536b804fbbd887fa4da2c35282add7e3994727a

2016年04月25日 12:46:22 +08:00

Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

Request

move sphinx h3 to '-' instead of '^' In the sphinx document h3 is supposed to be '-' not '^': =, for sections -, for subsections ^, for subsubsections We have to enforce consistency here because we're processing included files which all have to agree, otherwise it's a sphinx error. Part of bp:api-ref-in-rst Change-Id: Ic6eef5cacb07870f161b04b031e332f2b87aeedc

2016年04月14日 13:10:59 -04:00

-------

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

.. rest_parameters:: parameters.yaml

- aggregate_id: aggregate_id

Response

move sphinx h3 to '-' instead of '^' In the sphinx document h3 is supposed to be '-' not '^': =, for sections -, for subsections ^, for subsubsections We have to enforce consistency here because we're processing included files which all have to agree, otherwise it's a sphinx error. Part of bp:api-ref-in-rst Change-Id: Ic6eef5cacb07870f161b04b031e332f2b87aeedc

2016年04月14日 13:10:59 -04:00

--------

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

api-ref: parameter verification for os-aggregates checked parameters Part of bp:api-ref-in-rst Change-Id: I8fe3825243f8b94d5c3f382ebc30c342bffafcac

2016年05月12日 20:23:17 +08:00

.. rest_parameters:: parameters.yaml

- aggregate: aggregate

- availability_zone: aggregate_az

- created_at: created

- deleted_at: deleted_at

- deleted: deleted

- hosts: hosts

- id: aggregate_id_body

api-ref: warn about changing/unsetting AZ name with instances It is currently possible to rename or unset the availability_zone metadata value on a host aggregate which can adversely impact instances that were created in that specific AZ since later attempts to migrate or unshelve those instances will fail if the AZ with the original name no longer exists. This adds a warning to the API reference for updating the AZ name and also fixes a grammar typo in the 'metadata' response parameter description. Change-Id: Ie9d4a1ff1a23827490fe51350c11292c6efc4eb2 Related-Bug: #1378904

2019年02月06日 16:11:40 -05:00

- metadata: aggregate_metadata_response

api-ref: parameter verification for os-aggregates checked parameters Part of bp:api-ref-in-rst Change-Id: I8fe3825243f8b94d5c3f382ebc30c342bffafcac

2016年05月12日 20:23:17 +08:00

- name: aggregate_name

- updated_at: updated_consider_null

Return uuid attribute for aggregates Adds a Compute API microversion that triggers returning an aggregate's UUID field. This field is necessary for scripts that must populate the placement API with resource provider to aggregate relationships, which rely on UUIDs for global identification. APIImpact blueprint: return-uuid-from-os-aggregates-api Change-Id: I4112ccd508eb85403933fec8b52efd468e866772 Closes-bug: #1652642

2016年12月26日 17:58:44 -05:00

- uuid: aggregate_uuid

api-ref: parameter verification for os-aggregates checked parameters Part of bp:api-ref-in-rst Change-Id: I8fe3825243f8b94d5c3f382ebc30c342bffafcac

2016年05月12日 20:23:17 +08:00

api-ref: Fix parameters and examples in aggregate API - The type of aggegate ID is changed to 'integer' instead of 'string'. - The uuid of aggegate is changed to 'required' because the uuid is always shown in the response after v2.41. - The response examples are replaced with v2.41 examples. Change-Id: Ib106898d32dc67e414f489468e91561ab0a5eb80 Closes-Bug: #1659475

2017年01月25日 23:55:43 +09:00

**Example Show Aggregate Details (v2.41): JSON response**

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

api-ref: Fix parameters and examples in aggregate API - The type of aggegate ID is changed to 'integer' instead of 'string'. - The uuid of aggegate is changed to 'required' because the uuid is always shown in the response after v2.41. - The response examples are replaced with v2.41 examples. Change-Id: Ib106898d32dc67e414f489468e91561ab0a5eb80 Closes-Bug: #1659475

2017年01月25日 23:55:43 +09:00

.. literalinclude:: ../../doc/api_samples/os-aggregates/v2.41/aggregates-get-resp.json

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

:language: javascript

complete Method Verification of aggregates This complete the Method Verification of aggregates, adjust the sequence of GET/POST, also, clean and correct some error return code. Part of bp:api-ref-in-rst Change-Id: I1536b804fbbd887fa4da2c35282add7e3994727a

2016年04月25日 12:46:22 +08:00

Update Aggregate

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

================

remove /v2.1/{tenant_id} from all urls As discussed at summit, the version part of the URL is not really relevant, or a thing a user should be filling out themselves, this should instead be set by the service catalog and extracted from the token. This removes it's reference in all documented REST urls, and adds a new section describing how one gets the base URL for all calls. Change-Id: I4306b8c3de0225e54f3909dd8a1fb293c4e5944c

2016年06月02日 08:50:03 -04:00

.. rest_method:: PUT /os-aggregates/{aggregate_id}

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

complete Method Verification of aggregates This complete the Method Verification of aggregates, adjust the sequence of GET/POST, also, clean and correct some error return code. Part of bp:api-ref-in-rst Change-Id: I1536b804fbbd887fa4da2c35282add7e3994727a

2016年04月25日 12:46:22 +08:00

Updates either or both the name and availability zone for an aggregate.

Verify os-aggregates.inc on sample files verified all sample files is correct and adjust some format of the request Json file part of bp:api-ref-in-rst Change-Id: Ie9dd24858056337bcae9b03259d4f84de4fc1ab8

2016年07月05日 16:50:19 +08:00

If the aggregate to be updated has host that already in the given

Fix a few typos in API reference Change-Id: Ib90100f4ec6b4b03f27ed39166caeb9bdf5bc24c

2016年09月28日 14:34:23 +09:00

availability zone, the request will fail with 400 error.

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

Normal response codes: 200

complete Method Verification of aggregates This complete the Method Verification of aggregates, adjust the sequence of GET/POST, also, clean and correct some error return code. Part of bp:api-ref-in-rst Change-Id: I1536b804fbbd887fa4da2c35282add7e3994727a

2016年04月25日 12:46:22 +08:00

Error response codes: badRequest(400), unauthorized(401), forbidden(403),

itemNotFound(404), conflict(409)

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

Request

move sphinx h3 to '-' instead of '^' In the sphinx document h3 is supposed to be '-' not '^': =, for sections -, for subsections ^, for subsubsections We have to enforce consistency here because we're processing included files which all have to agree, otherwise it's a sphinx error. Part of bp:api-ref-in-rst Change-Id: Ic6eef5cacb07870f161b04b031e332f2b87aeedc

2016年04月14日 13:10:59 -04:00

-------

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

.. rest_parameters:: parameters.yaml

- aggregate_id: aggregate_id

api-ref: parameter verification for os-aggregates checked parameters Part of bp:api-ref-in-rst Change-Id: I8fe3825243f8b94d5c3f382ebc30c342bffafcac

2016年05月12日 20:23:17 +08:00

- aggregate: aggregate

- name: aggregate_name_optional

api-ref: warn about changing/unsetting AZ name with instances It is currently possible to rename or unset the availability_zone metadata value on a host aggregate which can adversely impact instances that were created in that specific AZ since later attempts to migrate or unshelve those instances will fail if the AZ with the original name no longer exists. This adds a warning to the API reference for updating the AZ name and also fixes a grammar typo in the 'metadata' response parameter description. Change-Id: Ie9d4a1ff1a23827490fe51350c11292c6efc4eb2 Related-Bug: #1378904

2019年02月06日 16:11:40 -05:00

- availability_zone: aggregate_az_optional_update

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

complete Method Verification of aggregates This complete the Method Verification of aggregates, adjust the sequence of GET/POST, also, clean and correct some error return code. Part of bp:api-ref-in-rst Change-Id: I1536b804fbbd887fa4da2c35282add7e3994727a

2016年04月25日 12:46:22 +08:00

**Example Update Aggregate: JSON request**

.. literalinclude:: ../../doc/api_samples/os-aggregates/aggregate-update-post-req.json

:language: javascript

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

Response

move sphinx h3 to '-' instead of '^' In the sphinx document h3 is supposed to be '-' not '^': =, for sections -, for subsections ^, for subsubsections We have to enforce consistency here because we're processing included files which all have to agree, otherwise it's a sphinx error. Part of bp:api-ref-in-rst Change-Id: Ic6eef5cacb07870f161b04b031e332f2b87aeedc

2016年04月14日 13:10:59 -04:00

--------

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

api-ref: parameter verification for os-aggregates checked parameters Part of bp:api-ref-in-rst Change-Id: I8fe3825243f8b94d5c3f382ebc30c342bffafcac

2016年05月12日 20:23:17 +08:00

.. rest_parameters:: parameters.yaml

- aggregate: aggregate

- availability_zone: aggregate_az

- created_at: created

- deleted_at: deleted_at

- deleted: deleted

- hosts: hosts

- id: aggregate_id_body

api-ref: warn about changing/unsetting AZ name with instances It is currently possible to rename or unset the availability_zone metadata value on a host aggregate which can adversely impact instances that were created in that specific AZ since later attempts to migrate or unshelve those instances will fail if the AZ with the original name no longer exists. This adds a warning to the API reference for updating the AZ name and also fixes a grammar typo in the 'metadata' response parameter description. Change-Id: Ie9d4a1ff1a23827490fe51350c11292c6efc4eb2 Related-Bug: #1378904

2019年02月06日 16:11:40 -05:00

- metadata: aggregate_metadata_response

api-ref: parameter verification for os-aggregates checked parameters Part of bp:api-ref-in-rst Change-Id: I8fe3825243f8b94d5c3f382ebc30c342bffafcac

2016年05月12日 20:23:17 +08:00

- name: aggregate_name

- updated_at: updated_consider_null

Return uuid attribute for aggregates Adds a Compute API microversion that triggers returning an aggregate's UUID field. This field is necessary for scripts that must populate the placement API with resource provider to aggregate relationships, which rely on UUIDs for global identification. APIImpact blueprint: return-uuid-from-os-aggregates-api Change-Id: I4112ccd508eb85403933fec8b52efd468e866772 Closes-bug: #1652642

2016年12月26日 17:58:44 -05:00

- uuid: aggregate_uuid

api-ref: parameter verification for os-aggregates checked parameters Part of bp:api-ref-in-rst Change-Id: I8fe3825243f8b94d5c3f382ebc30c342bffafcac

2016年05月12日 20:23:17 +08:00

api-ref: Fix parameters and examples in aggregate API - The type of aggegate ID is changed to 'integer' instead of 'string'. - The uuid of aggegate is changed to 'required' because the uuid is always shown in the response after v2.41. - The response examples are replaced with v2.41 examples. Change-Id: Ib106898d32dc67e414f489468e91561ab0a5eb80 Closes-Bug: #1659475

2017年01月25日 23:55:43 +09:00

**Example Update Aggregate (v2.41): JSON response**

complete Method Verification of aggregates This complete the Method Verification of aggregates, adjust the sequence of GET/POST, also, clean and correct some error return code. Part of bp:api-ref-in-rst Change-Id: I1536b804fbbd887fa4da2c35282add7e3994727a

2016年04月25日 12:46:22 +08:00

api-ref: Fix parameters and examples in aggregate API - The type of aggegate ID is changed to 'integer' instead of 'string'. - The uuid of aggegate is changed to 'required' because the uuid is always shown in the response after v2.41. - The response examples are replaced with v2.41 examples. Change-Id: Ib106898d32dc67e414f489468e91561ab0a5eb80 Closes-Bug: #1659475

2017年01月25日 23:55:43 +09:00

.. literalinclude:: ../../doc/api_samples/os-aggregates/v2.41/aggregate-update-post-resp.json

complete Method Verification of aggregates This complete the Method Verification of aggregates, adjust the sequence of GET/POST, also, clean and correct some error return code. Part of bp:api-ref-in-rst Change-Id: I1536b804fbbd887fa4da2c35282add7e3994727a

2016年04月25日 12:46:22 +08:00

:language: javascript

Delete Aggregate

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

================

remove /v2.1/{tenant_id} from all urls As discussed at summit, the version part of the URL is not really relevant, or a thing a user should be filling out themselves, this should instead be set by the service catalog and extracted from the token. This removes it's reference in all documented REST urls, and adds a new section describing how one gets the base URL for all calls. Change-Id: I4306b8c3de0225e54f3909dd8a1fb293c4e5944c

2016年06月02日 08:50:03 -04:00

.. rest_method:: DELETE /os-aggregates/{aggregate_id}

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

complete Method Verification of aggregates This complete the Method Verification of aggregates, adjust the sequence of GET/POST, also, clean and correct some error return code. Part of bp:api-ref-in-rst Change-Id: I1536b804fbbd887fa4da2c35282add7e3994727a

2016年04月25日 12:46:22 +08:00

Deletes an aggregate.

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

Normal response codes: 200

complete Method Verification of aggregates This complete the Method Verification of aggregates, adjust the sequence of GET/POST, also, clean and correct some error return code. Part of bp:api-ref-in-rst Change-Id: I1536b804fbbd887fa4da2c35282add7e3994727a

2016年04月25日 12:46:22 +08:00

Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404)

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

Request

move sphinx h3 to '-' instead of '^' In the sphinx document h3 is supposed to be '-' not '^': =, for sections -, for subsections ^, for subsubsections We have to enforce consistency here because we're processing included files which all have to agree, otherwise it's a sphinx error. Part of bp:api-ref-in-rst Change-Id: Ic6eef5cacb07870f161b04b031e332f2b87aeedc

2016年04月14日 13:10:59 -04:00

-------

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

.. rest_parameters:: parameters.yaml

- aggregate_id: aggregate_id

Response

move sphinx h3 to '-' instead of '^' In the sphinx document h3 is supposed to be '-' not '^': =, for sections -, for subsections ^, for subsubsections We have to enforce consistency here because we're processing included files which all have to agree, otherwise it's a sphinx error. Part of bp:api-ref-in-rst Change-Id: Ic6eef5cacb07870f161b04b031e332f2b87aeedc

2016年04月14日 13:10:59 -04:00

--------

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

Body Verification of os-aggregates.inc This patch verifies that the title and introductory description that precedes each rest method clearly reflects the context of the respective rest method. - Correct the Response text for delete API - 'body verification' tag is removed for this commit. part of bp:api-ref-in-rst Change-Id: If189c0f0246969527635879d96daa1ba8f77b7c3

2016年09月06日 18:49:27 +09:00

There is no body content for the response of a successful DELETE action.

Verify os-aggregates.inc on sample files verified all sample files is correct and adjust some format of the request Json file part of bp:api-ref-in-rst Change-Id: Ie9dd24858056337bcae9b03259d4f84de4fc1ab8

2016年07月05日 16:50:19 +08:00

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

Add Host

========

remove /v2.1/{tenant_id} from all urls As discussed at summit, the version part of the URL is not really relevant, or a thing a user should be filling out themselves, this should instead be set by the service catalog and extracted from the token. This removes it's reference in all documented REST urls, and adds a new section describing how one gets the base URL for all calls. Change-Id: I4306b8c3de0225e54f3909dd8a1fb293c4e5944c

2016年06月02日 08:50:03 -04:00

.. rest_method:: POST /os-aggregates/{aggregate_id}/action

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

Adds a host to an aggregate.

api-ref: parameter verification for os-aggregates checked parameters Part of bp:api-ref-in-rst Change-Id: I8fe3825243f8b94d5c3f382ebc30c342bffafcac

2016年05月12日 20:23:17 +08:00

Specify the ``add_host`` action and host name in the request body.

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

Normal response codes: 200

complete Method Verification of aggregates This complete the Method Verification of aggregates, adjust the sequence of GET/POST, also, clean and correct some error return code. Part of bp:api-ref-in-rst Change-Id: I1536b804fbbd887fa4da2c35282add7e3994727a

2016年04月25日 12:46:22 +08:00

Error response codes: badRequest(400), unauthorized(401), forbidden(403),

itemNotFound(404), conflict(409)

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

Request

move sphinx h3 to '-' instead of '^' In the sphinx document h3 is supposed to be '-' not '^': =, for sections -, for subsections ^, for subsubsections We have to enforce consistency here because we're processing included files which all have to agree, otherwise it's a sphinx error. Part of bp:api-ref-in-rst Change-Id: Ic6eef5cacb07870f161b04b031e332f2b87aeedc

2016年04月14日 13:10:59 -04:00

-------

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

.. rest_parameters:: parameters.yaml

- aggregate_id: aggregate_id

api-ref: parameter verification for os-aggregates checked parameters Part of bp:api-ref-in-rst Change-Id: I8fe3825243f8b94d5c3f382ebc30c342bffafcac

2016年05月12日 20:23:17 +08:00

- add_host: aggregate_add_host

- host: host_name_body

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

**Example Add Host: JSON request**

Fix sample path for aggregate, certificate, console This fix all sample file path for -os-aggregates -os-certificates -os-consoles Part of bp:api-ref-in-rst Change-Id: I949f3625b7bad4f316ee4b5723fba8e95a205afd

2016年04月20日 10:35:37 +09:00

.. literalinclude:: ../../doc/api_samples/os-aggregates/aggregate-add-host-post-req.json

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

:language: javascript

Response

move sphinx h3 to '-' instead of '^' In the sphinx document h3 is supposed to be '-' not '^': =, for sections -, for subsections ^, for subsubsections We have to enforce consistency here because we're processing included files which all have to agree, otherwise it's a sphinx error. Part of bp:api-ref-in-rst Change-Id: Ic6eef5cacb07870f161b04b031e332f2b87aeedc

2016年04月14日 13:10:59 -04:00

--------

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

api-ref: parameter verification for os-aggregates checked parameters Part of bp:api-ref-in-rst Change-Id: I8fe3825243f8b94d5c3f382ebc30c342bffafcac

2016年05月12日 20:23:17 +08:00

.. rest_parameters:: parameters.yaml

- aggregate: aggregate

- availability_zone: aggregate_az

- created_at: created

- deleted_at: deleted_at

- deleted: deleted

- hosts: hosts

- id: aggregate_id_body

api-ref: warn about changing/unsetting AZ name with instances It is currently possible to rename or unset the availability_zone metadata value on a host aggregate which can adversely impact instances that were created in that specific AZ since later attempts to migrate or unshelve those instances will fail if the AZ with the original name no longer exists. This adds a warning to the API reference for updating the AZ name and also fixes a grammar typo in the 'metadata' response parameter description. Change-Id: Ie9d4a1ff1a23827490fe51350c11292c6efc4eb2 Related-Bug: #1378904

2019年02月06日 16:11:40 -05:00

- metadata: aggregate_metadata_response

api-ref: parameter verification for os-aggregates checked parameters Part of bp:api-ref-in-rst Change-Id: I8fe3825243f8b94d5c3f382ebc30c342bffafcac

2016年05月12日 20:23:17 +08:00

- name: aggregate_name

- updated_at: updated_consider_null

Return uuid attribute for aggregates Adds a Compute API microversion that triggers returning an aggregate's UUID field. This field is necessary for scripts that must populate the placement API with resource provider to aggregate relationships, which rely on UUIDs for global identification. APIImpact blueprint: return-uuid-from-os-aggregates-api Change-Id: I4112ccd508eb85403933fec8b52efd468e866772 Closes-bug: #1652642

2016年12月26日 17:58:44 -05:00

- uuid: aggregate_uuid

api-ref: parameter verification for os-aggregates checked parameters Part of bp:api-ref-in-rst Change-Id: I8fe3825243f8b94d5c3f382ebc30c342bffafcac

2016年05月12日 20:23:17 +08:00

api-ref: Fix parameters and examples in aggregate API - The type of aggegate ID is changed to 'integer' instead of 'string'. - The uuid of aggegate is changed to 'required' because the uuid is always shown in the response after v2.41. - The response examples are replaced with v2.41 examples. Change-Id: Ib106898d32dc67e414f489468e91561ab0a5eb80 Closes-Bug: #1659475

2017年01月25日 23:55:43 +09:00

**Example Add Host (v2.41): JSON response**

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

api-ref: Fix parameters and examples in aggregate API - The type of aggegate ID is changed to 'integer' instead of 'string'. - The uuid of aggegate is changed to 'required' because the uuid is always shown in the response after v2.41. - The response examples are replaced with v2.41 examples. Change-Id: Ib106898d32dc67e414f489468e91561ab0a5eb80 Closes-Bug: #1659475

2017年01月25日 23:55:43 +09:00

.. literalinclude:: ../../doc/api_samples/os-aggregates/v2.41/aggregates-add-host-post-resp.json

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

:language: javascript

Fix sample path for aggregate, certificate, console This fix all sample file path for -os-aggregates -os-certificates -os-consoles Part of bp:api-ref-in-rst Change-Id: I949f3625b7bad4f316ee4b5723fba8e95a205afd

2016年04月20日 10:35:37 +09:00

Remove Host

===========

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

remove /v2.1/{tenant_id} from all urls As discussed at summit, the version part of the URL is not really relevant, or a thing a user should be filling out themselves, this should instead be set by the service catalog and extracted from the token. This removes it's reference in all documented REST urls, and adds a new section describing how one gets the base URL for all calls. Change-Id: I4306b8c3de0225e54f3909dd8a1fb293c4e5944c

2016年06月02日 08:50:03 -04:00

.. rest_method:: POST /os-aggregates/{aggregate_id}/action

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

Fix sample path for aggregate, certificate, console This fix all sample file path for -os-aggregates -os-certificates -os-consoles Part of bp:api-ref-in-rst Change-Id: I949f3625b7bad4f316ee4b5723fba8e95a205afd

2016年04月20日 10:35:37 +09:00

Removes a host from an aggregate.

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

api-ref: parameter verification for os-aggregates checked parameters Part of bp:api-ref-in-rst Change-Id: I8fe3825243f8b94d5c3f382ebc30c342bffafcac

2016年05月12日 20:23:17 +08:00

Specify the ``remove_host`` action and host name in the request body.

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

Normal response codes: 200

complete Method Verification of aggregates This complete the Method Verification of aggregates, adjust the sequence of GET/POST, also, clean and correct some error return code. Part of bp:api-ref-in-rst Change-Id: I1536b804fbbd887fa4da2c35282add7e3994727a

2016年04月25日 12:46:22 +08:00

Error response codes: badRequest(400), unauthorized(401), forbidden(403),

itemNotFound(404), conflict(409)

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

Request

move sphinx h3 to '-' instead of '^' In the sphinx document h3 is supposed to be '-' not '^': =, for sections -, for subsections ^, for subsubsections We have to enforce consistency here because we're processing included files which all have to agree, otherwise it's a sphinx error. Part of bp:api-ref-in-rst Change-Id: Ic6eef5cacb07870f161b04b031e332f2b87aeedc

2016年04月14日 13:10:59 -04:00

-------

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

.. rest_parameters:: parameters.yaml

- aggregate_id: aggregate_id

api-ref: parameter verification for os-aggregates checked parameters Part of bp:api-ref-in-rst Change-Id: I8fe3825243f8b94d5c3f382ebc30c342bffafcac

2016年05月12日 20:23:17 +08:00

- remove_host: aggregate_remove_host

- host: host_name_body

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

Fix sample path for aggregate, certificate, console This fix all sample file path for -os-aggregates -os-certificates -os-consoles Part of bp:api-ref-in-rst Change-Id: I949f3625b7bad4f316ee4b5723fba8e95a205afd

2016年04月20日 10:35:37 +09:00

**Example Remove Host: JSON request**

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

Fix sample path for aggregate, certificate, console This fix all sample file path for -os-aggregates -os-certificates -os-consoles Part of bp:api-ref-in-rst Change-Id: I949f3625b7bad4f316ee4b5723fba8e95a205afd

2016年04月20日 10:35:37 +09:00

.. literalinclude:: ../../doc/api_samples/os-aggregates/aggregate-remove-host-post-req.json

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

:language: javascript

Response

move sphinx h3 to '-' instead of '^' In the sphinx document h3 is supposed to be '-' not '^': =, for sections -, for subsections ^, for subsubsections We have to enforce consistency here because we're processing included files which all have to agree, otherwise it's a sphinx error. Part of bp:api-ref-in-rst Change-Id: Ic6eef5cacb07870f161b04b031e332f2b87aeedc

2016年04月14日 13:10:59 -04:00

--------

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

api-ref: parameter verification for os-aggregates checked parameters Part of bp:api-ref-in-rst Change-Id: I8fe3825243f8b94d5c3f382ebc30c342bffafcac

2016年05月12日 20:23:17 +08:00

.. rest_parameters:: parameters.yaml

- aggregate: aggregate

- availability_zone: aggregate_az

- created_at: created

- deleted_at: deleted_at

- deleted: deleted

- hosts: hosts

- id: aggregate_id_body

api-ref: warn about changing/unsetting AZ name with instances It is currently possible to rename or unset the availability_zone metadata value on a host aggregate which can adversely impact instances that were created in that specific AZ since later attempts to migrate or unshelve those instances will fail if the AZ with the original name no longer exists. This adds a warning to the API reference for updating the AZ name and also fixes a grammar typo in the 'metadata' response parameter description. Change-Id: Ie9d4a1ff1a23827490fe51350c11292c6efc4eb2 Related-Bug: #1378904

2019年02月06日 16:11:40 -05:00

- metadata: aggregate_metadata_response

api-ref: parameter verification for os-aggregates checked parameters Part of bp:api-ref-in-rst Change-Id: I8fe3825243f8b94d5c3f382ebc30c342bffafcac

2016年05月12日 20:23:17 +08:00

- name: aggregate_name

- updated_at: updated_consider_null

Return uuid attribute for aggregates Adds a Compute API microversion that triggers returning an aggregate's UUID field. This field is necessary for scripts that must populate the placement API with resource provider to aggregate relationships, which rely on UUIDs for global identification. APIImpact blueprint: return-uuid-from-os-aggregates-api Change-Id: I4112ccd508eb85403933fec8b52efd468e866772 Closes-bug: #1652642

2016年12月26日 17:58:44 -05:00

- uuid: aggregate_uuid

api-ref: parameter verification for os-aggregates checked parameters Part of bp:api-ref-in-rst Change-Id: I8fe3825243f8b94d5c3f382ebc30c342bffafcac

2016年05月12日 20:23:17 +08:00

api-ref: Fix parameters and examples in aggregate API - The type of aggegate ID is changed to 'integer' instead of 'string'. - The uuid of aggegate is changed to 'required' because the uuid is always shown in the response after v2.41. - The response examples are replaced with v2.41 examples. Change-Id: Ib106898d32dc67e414f489468e91561ab0a5eb80 Closes-Bug: #1659475

2017年01月25日 23:55:43 +09:00

**Example Remove Host (v2.41): JSON response**

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

api-ref: Fix parameters and examples in aggregate API - The type of aggegate ID is changed to 'integer' instead of 'string'. - The uuid of aggegate is changed to 'required' because the uuid is always shown in the response after v2.41. - The response examples are replaced with v2.41 examples. Change-Id: Ib106898d32dc67e414f489468e91561ab0a5eb80 Closes-Bug: #1659475

2017年01月25日 23:55:43 +09:00

.. literalinclude:: ../../doc/api_samples/os-aggregates/v2.41/aggregates-remove-host-post-resp.json

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

:language: javascript

Fix sample path for aggregate, certificate, console This fix all sample file path for -os-aggregates -os-certificates -os-consoles Part of bp:api-ref-in-rst Change-Id: I949f3625b7bad4f316ee4b5723fba8e95a205afd

2016年04月20日 10:35:37 +09:00

Create Or Update Aggregate Metadata

===================================

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

remove /v2.1/{tenant_id} from all urls As discussed at summit, the version part of the URL is not really relevant, or a thing a user should be filling out themselves, this should instead be set by the service catalog and extracted from the token. This removes it's reference in all documented REST urls, and adds a new section describing how one gets the base URL for all calls. Change-Id: I4306b8c3de0225e54f3909dd8a1fb293c4e5944c

2016年06月02日 08:50:03 -04:00

.. rest_method:: POST /os-aggregates/{aggregate_id}/action

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

Fix sample path for aggregate, certificate, console This fix all sample file path for -os-aggregates -os-certificates -os-consoles Part of bp:api-ref-in-rst Change-Id: I949f3625b7bad4f316ee4b5723fba8e95a205afd

2016年04月20日 10:35:37 +09:00

Creates or replaces metadata for an aggregate.

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

Verify os-aggregates.inc on sample files verified all sample files is correct and adjust some format of the request Json file part of bp:api-ref-in-rst Change-Id: Ie9dd24858056337bcae9b03259d4f84de4fc1ab8

2016年07月05日 16:50:19 +08:00

Specify the ``set_metadata`` action and metadata info in the request body.

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

Normal response codes: 200

complete Method Verification of aggregates This complete the Method Verification of aggregates, adjust the sequence of GET/POST, also, clean and correct some error return code. Part of bp:api-ref-in-rst Change-Id: I1536b804fbbd887fa4da2c35282add7e3994727a

2016年04月25日 12:46:22 +08:00

Error response codes: badRequest(400), unauthorized(401), forbidden(403),

itemNotFound(404)

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

Request

move sphinx h3 to '-' instead of '^' In the sphinx document h3 is supposed to be '-' not '^': =, for sections -, for subsections ^, for subsubsections We have to enforce consistency here because we're processing included files which all have to agree, otherwise it's a sphinx error. Part of bp:api-ref-in-rst Change-Id: Ic6eef5cacb07870f161b04b031e332f2b87aeedc

2016年04月14日 13:10:59 -04:00

-------

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

.. rest_parameters:: parameters.yaml

- aggregate_id: aggregate_id

api-ref: parameter verification for os-aggregates checked parameters Part of bp:api-ref-in-rst Change-Id: I8fe3825243f8b94d5c3f382ebc30c342bffafcac

2016年05月12日 20:23:17 +08:00

- set_metadata: set_metadata

api-ref: warn about changing/unsetting AZ name with instances It is currently possible to rename or unset the availability_zone metadata value on a host aggregate which can adversely impact instances that were created in that specific AZ since later attempts to migrate or unshelve those instances will fail if the AZ with the original name no longer exists. This adds a warning to the API reference for updating the AZ name and also fixes a grammar typo in the 'metadata' response parameter description. Change-Id: Ie9d4a1ff1a23827490fe51350c11292c6efc4eb2 Related-Bug: #1378904

2019年02月06日 16:11:40 -05:00

- metadata: aggregate_metadata_request

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

Fix sample path for aggregate, certificate, console This fix all sample file path for -os-aggregates -os-certificates -os-consoles Part of bp:api-ref-in-rst Change-Id: I949f3625b7bad4f316ee4b5723fba8e95a205afd

2016年04月20日 10:35:37 +09:00

**Example Create Or Update Aggregate Metadata: JSON request**

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

Fix sample path for aggregate, certificate, console This fix all sample file path for -os-aggregates -os-certificates -os-consoles Part of bp:api-ref-in-rst Change-Id: I949f3625b7bad4f316ee4b5723fba8e95a205afd

2016年04月20日 10:35:37 +09:00

.. literalinclude:: ../../doc/api_samples/os-aggregates/aggregate-metadata-post-req.json

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

:language: javascript

Response

move sphinx h3 to '-' instead of '^' In the sphinx document h3 is supposed to be '-' not '^': =, for sections -, for subsections ^, for subsubsections We have to enforce consistency here because we're processing included files which all have to agree, otherwise it's a sphinx error. Part of bp:api-ref-in-rst Change-Id: Ic6eef5cacb07870f161b04b031e332f2b87aeedc

2016年04月14日 13:10:59 -04:00

--------

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

api-ref: parameter verification for os-aggregates checked parameters Part of bp:api-ref-in-rst Change-Id: I8fe3825243f8b94d5c3f382ebc30c342bffafcac

2016年05月12日 20:23:17 +08:00

.. rest_parameters:: parameters.yaml

- aggregate: aggregate

- availability_zone: aggregate_az

- created_at: created

- deleted_at: deleted_at

- deleted: deleted

- hosts: hosts

- id: aggregate_id_body

api-ref: warn about changing/unsetting AZ name with instances It is currently possible to rename or unset the availability_zone metadata value on a host aggregate which can adversely impact instances that were created in that specific AZ since later attempts to migrate or unshelve those instances will fail if the AZ with the original name no longer exists. This adds a warning to the API reference for updating the AZ name and also fixes a grammar typo in the 'metadata' response parameter description. Change-Id: Ie9d4a1ff1a23827490fe51350c11292c6efc4eb2 Related-Bug: #1378904

2019年02月06日 16:11:40 -05:00

- metadata: aggregate_metadata_response

api-ref: parameter verification for os-aggregates checked parameters Part of bp:api-ref-in-rst Change-Id: I8fe3825243f8b94d5c3f382ebc30c342bffafcac

2016年05月12日 20:23:17 +08:00

- name: aggregate_name

- updated_at: updated_consider_null

Return uuid attribute for aggregates Adds a Compute API microversion that triggers returning an aggregate's UUID field. This field is necessary for scripts that must populate the placement API with resource provider to aggregate relationships, which rely on UUIDs for global identification. APIImpact blueprint: return-uuid-from-os-aggregates-api Change-Id: I4112ccd508eb85403933fec8b52efd468e866772 Closes-bug: #1652642

2016年12月26日 17:58:44 -05:00

- uuid: aggregate_uuid

api-ref: parameter verification for os-aggregates checked parameters Part of bp:api-ref-in-rst Change-Id: I8fe3825243f8b94d5c3f382ebc30c342bffafcac

2016年05月12日 20:23:17 +08:00

api-ref: Fix parameters and examples in aggregate API - The type of aggegate ID is changed to 'integer' instead of 'string'. - The uuid of aggegate is changed to 'required' because the uuid is always shown in the response after v2.41. - The response examples are replaced with v2.41 examples. Change-Id: Ib106898d32dc67e414f489468e91561ab0a5eb80 Closes-Bug: #1659475

2017年01月25日 23:55:43 +09:00

**Example Create Or Update Aggregate Metadata (v2.41): JSON response**

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

api-ref: Fix parameters and examples in aggregate API - The type of aggegate ID is changed to 'integer' instead of 'string'. - The uuid of aggegate is changed to 'required' because the uuid is always shown in the response after v2.41. - The response examples are replaced with v2.41 examples. Change-Id: Ib106898d32dc67e414f489468e91561ab0a5eb80 Closes-Bug: #1659475

2017年01月25日 23:55:43 +09:00

.. literalinclude:: ../../doc/api_samples/os-aggregates/v2.41/aggregates-metadata-post-resp.json

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

:language: javascript

Add image caching API for aggregates This adds a new microversion and support for requesting image pre-caching on an aggregate. Related to blueprint image-precache-support Change-Id: I4ab96095106b38737ed355fcad07e758f8b5a9b0

2019年10月14日 08:11:27 -07:00

Request Image Pre-caching for Aggregate

=======================================

.. rest_method:: POST /os-aggregates/{aggregate_id}/images

Requests that a set of images be pre-cached on compute nodes within the referenced aggregate.

This API is available starting with microversion 2.81.

Normal response codes: 202

Error response codes: badRequest(400), unauthorized(401), forbidden(403),

itemNotFound(404)

Request

-------

.. rest_parameters:: parameters.yaml

- aggregate_id: aggregate_id

- cache: cache

- cache.id: image_id_body

**Example Request Image pre-caching for Aggregate (v2.81): JSON request**

.. literalinclude:: ../../doc/api_samples/os-aggregates/v2.81/aggregate-images-post-req.json

:language: javascript

Response

--------

The response body is always empty.

openstack/nova - nova - OpenDev: Free Software Needs Free Tools

390 lines 9.2 KiB PHP Raw Normal View History Unescape Escape

390 lines

9.2 KiB

PHP

Raw Normal View History