Browse Source

Remove iinfra URL from API documentation

An error occurred when using the URL interface of Infrastructure
Subnet. After analysis, it is found that the URL does not exist
in the starlingx/config code. See
https://review.opendev.org/#/c/656571/ for details. Therefore,
the Infrastructure Subnet part of the API documentation needs
to be deleted.

Change-Id: Icae1617c4b9c16592cfbd54f46391b9f70de5a19
Closes-Bug: #1888188
Signed-off-by: Xinxin Shen <shenxinxin@inspur.com>
changes/80/741880/4
XinxinShen 1 year ago
parent
commit
b50647b5b9
  1. 317
      api-ref/source/api-ref-sysinv-v1-config.rst

317
api-ref/source/api-ref-sysinv-v1-config.rst

@ -346,16 +346,6 @@ itemNotFound (404)
"rel": "bookmark"
}
],
"iinfra": [
{
"href": "http://10.10.10.2:6385/v1/iinfra/",
"rel": "self"
},
{
"href": "http://10.10.10.2:6385/iinfra/",
"rel": "bookmark"
}
],
"storage_backend": [
{
"href": "http://10.10.10.2:6385/v1/storage_backend/",
@ -4647,313 +4637,6 @@ badMediaType (415)
]
}
----------------------
Infrastructure Subnet
----------------------
The infra is the Infrastructure subnet entity for the system.
*****************************************************************
Shows attributes of the infrastructure network IP subnet object
*****************************************************************
.. rest_method:: GET /v1/iinfra
**Normal response codes**
200
**Error response codes**
computeFault (400, 500, ...), serviceUnavailable (503), badRequest (400),
unauthorized (401), forbidden (403), badMethod (405), overLimit (413),
itemNotFound (404)
**Response parameters**
.. csv-table::
:header: "Parameter", "Style", "Type", "Description"
:widths: 20, 20, 20, 60
"infra_subnet (Optional)", "plain", "xsd:string", "The infrastructure network IP subnet."
"infra_start (Optional)", "plain", "xsd:string", "The infrastructure network start IP address."
"infra_end (Optional)", "plain", "xsd:string", "The infrastructure network end IP address."
"infra_mtu (Optional)", "plain", "xsd:string", "The MTU of the infrastructure interface."
"infra_vlan (Optional)", "plain", "xsd:string", "The VLAN id of the infrastructure interface."
"isystem_uuid (Optional)", "plain", "csapi:UUID", "The System UUID which the infrastructure network IP subnet belongs to."
"uuid (Optional)", "plain", "csapi:UUID", "The universally unique identifier for this object."
"links (Optional)", "plain", "xsd:list", "For convenience, resources contain links to themselves. This allows a client to easily obtain rather than construct resource URIs. The following types of link relations are associated with resources: a self link containing a versioned link to the resource, and a bookmark link containing a permanent link to a resource that is appropriate for long term storage."
"created_at (Optional)", "plain", "xsd:dateTime", "The time when the object was created."
"updated_at (Optional)", "plain", "xsd:dateTime", "The time when the object was last updated."
::
{
"iinfras":[
{
"infra_subnet": "192.168.205.0/24",
"infra_start": "192.168.205.2",
"infra_end": "192.168.205.254",
"infra_mtu": "9216",
"infra_vlan_id": "137",
"links":[
{
"href": "http://10.10.10.2:6385/v1/iinfras/15ba72aa-442f-4b57-a8a1-e3f3cdd5b04c",
"rel": "self"
},
{
"href": "http://10.10.10.2:6385/iinfras/15ba72aa-442f-4b57-a8a1-e3f3cdd5b04c",
"rel": "bookmark"
}
],
"created_at": "2014-12-01T19:35:36.965657+00:00",
"updated_at": "2014-12-02T20:38:51.646902+00:00",
"isystem_uuid": "b7fdc4dd-333d-471b-b21d-ba664ea87714",
"uuid": "15ba72aa-442f-4b57-a8a1-e3f3cdd5b04c"
}
]
}
This operation does not accept a request body.
***************************************************************
Add attributes of the infrastructure network IP subnet object
***************************************************************
.. rest_method:: POST /v1/iinfra
The attributes of the infrastructure network IP subnet object that are
configurable are:
- infra_subnet
- infra_start
- infra_end
- infra_mtu
- infra_vlan_id
**Normal response codes**
200
**Error response codes**
badMediaType (415)
**Request parameters**
.. csv-table::
:header: "Parameter", "Style", "Type", "Description"
:widths: 20, 20, 20, 60
"infra_subnet (Optional)", "plain", "xsd:string", "This parameter specifies the infrastructure network IP subnet."
"infra_start (Optional)", "plain", "xsd:string", "This parameter specifies the infrastructure network start IP address."
"infra_end (Optional)", "plain", "xsd:string", "This parameter specifies the infrastructure network end IP address."
"infra_mtu (Optional)", "plain", "xsd:string", "This parameter specifies the MTU of the infrastructure interface."
"infra_vlan_id (Optional)", "plain", "xsd:string", "This parameter specifies the VLAN ID of the infrastructure interface."
**Response parameters**
.. csv-table::
:header: "Parameter", "Style", "Type", "Description"
:widths: 20, 20, 20, 60
"infra_subnet (Optional)", "plain", "xsd:string", "The infrastructure network IP subnet."
"infra_start (Optional)", "plain", "xsd:string", "The infrastructure network start IP address."
"infra_end (Optional)", "plain", "xsd:string", "The infrastructure network end IP address."
"infra_mtu (Optional)", "plain", "xsd:string", "The MTU of the infrastructure interface."
"infra_vlan (Optional)", "plain", "xsd:string", "The VLAN id of the infrastructure interface."
"isystem_uuid (Optional)", "plain", "csapi:UUID", "The System UUID which the infrastructure network IP subnet belongs to."
"uuid (Optional)", "plain", "csapi:UUID", "The universally unique identifier for this object."
"links (Optional)", "plain", "xsd:list", "For convenience, resources contain links to themselves. This allows a client to easily obtain rather than construct resource URIs. The following types of link relations are associated with resources: a self link containing a versioned link to the resource, and a bookmark link containing a permanent link to a resource that is appropriate for long term storage."
"created_at (Optional)", "plain", "xsd:dateTime", "The time when the object was created."
"updated_at (Optional)", "plain", "xsd:dateTime", "The time when the object was last updated."
::
{
"infra_subnet": "192.168.205.0/24"
"infra_start": "192.168.205.2",
"infra_end": "192.168.205.254",
"infra_mtu": "9216",
"infra_vlan_id": "137",
}
::
{
"iinfras":[
{
"infra_subnet":"192.168.205.0/24",
"infra_start":"192.168.205.2",
"infra_end":"192.168.205.254",
"infra_mtu": "9216",
"infra_vlan_id": "137",
"links":[
{
"href":"http://10.10.10.2:6385/v1/iinfras/15ba72aa-442f-4b57-a8a1-e3f3cdd5b04c",
"rel":"self"
},
{
"href":"http://10.10.10.2:6385/iinfras/15ba72aa-442f-4b57-a8a1-e3f3cdd5b04c",
"rel":"bookmark"
}
],
"created_at": "2014-12-01T19:35:36.965657+00:00",
"updated_at": "2014-12-02T20:38:51.646902+00:00",
"isystem_uuid": "b7fdc4dd-333d-471b-b21d-ba664ea87714",
"uuid": "15ba72aa-442f-4b57-a8a1-e3f3cdd5b04c"
}
]
}
********************************************************************
Modifies attributes of the infrastructure network IP subnet object
********************************************************************
.. rest_method:: PATCH /v1/iinfra/​{infra_id}​
The attributes of the infrastructure network IP subnet object that are
configurable are:
- infra_start
- infra_end
- infra_mtu
- infra_vlan_id
**Normal response codes**
200
**Error response codes**
badMediaType (415)
**Request parameters**
.. csv-table::
:header: "Parameter", "Style", "Type", "Description"
:widths: 20, 20, 20, 60
"infra_id", "URI", "csapi:UUID", "The unique identifier of the infrastructure network subnet configuration for this system."
"infra_subnet (Optional)", "plain", "xsd:string", "This parameter specifies the infrastructure network IP subnet."
**Response parameters**
.. csv-table::
:header: "Parameter", "Style", "Type", "Description"
:widths: 20, 20, 20, 60
"infra_subnet (Optional)", "plain", "xsd:string", "The infrastructure network IP subnet."
"infra_start (Optional)", "plain", "xsd:string", "The infrastructure network start IP address."
"infra_end (Optional)", "plain", "xsd:string", "The infrastructure network end IP address."
"infra_mtu (Optional)", "plain", "xsd:string", "The MTU of the infrastructure interface."
"infra_vlan (Optional)", "plain", "xsd:string", "The VLAN id of the infrastructure interface."
"isystem_uuid (Optional)", "plain", "csapi:UUID", "The System UUID which the infrastructure network IP subnet belongs to."
"uuid (Optional)", "plain", "csapi:UUID", "The universally unique identifier for this object."
"links (Optional)", "plain", "xsd:list", "For convenience, resources contain links to themselves. This allows a client to easily obtain rather than construct resource URIs. The following types of link relations are associated with resources: a self link containing a versioned link to the resource, and a bookmark link containing a permanent link to a resource that is appropriate for long term storage."
"created_at (Optional)", "plain", "xsd:dateTime", "The time when the object was created."
"updated_at (Optional)", "plain", "xsd:dateTime", "The time when the object was last updated."
::
[
{
"path":"/infra_subnet",
"value":"192.168.205.0/24",
"op":"replace"
}
]
::
{
"iinfras":[
{
"infra_subnet":"192.168.205.0/24",
"infra_start":"192.168.205.2",
"infra_end":"192.168.205.254",
"infra_mtu": "9216",
"infra_vlan_id": "137",
"links":[
{
"href":"http://10.10.10.2:6385/v1/iinfras/15ba72aa-442f-4b57-a8a1-e3f3cdd5b04c",
"rel":"self"
},
{
"href":"http://10.10.10.2:6385/iinfras/15ba72aa-442f-4b57-a8a1-e3f3cdd5b04c",
"rel":"bookmark"
}
],
"created_at": "2014-12-01T19:35:36.965657+00:00",
"updated_at": "2014-12-02T20:38:51.646902+00:00",
"isystem_uuid": "b7fdc4dd-333d-471b-b21d-ba664ea87714",
"uuid": "15ba72aa-442f-4b57-a8a1-e3f3cdd5b04c"
}
]
}
*******************************************************************
Applies attributes of the infrastructure network IP subnet object
*******************************************************************
.. rest_method:: PATCH /v1/iinfra/​{infra_id}​
**Normal response codes**
204
**Request parameters**
.. csv-table::
:header: "Parameter", "Style", "Type", "Description"
:widths: 20, 20, 20, 60
"infra_id", "URI", "csapi:UUID", "The unique identifier of the infrastructure network subnet configuration for this system."
::
[
{
"path":"/action",
"value":"apply",
"op":"replace"
}
]
::
{
"iinfras":[
{
"infra_subnet":"192.168.205.0/24",
"infra_start":"192.168.205.2",
"infra_end":"192.168.205.254",
"infra_mtu": "9216",
"infra_vlan_id": "137",
"links":[
{
"href":"http://10.10.10.2:6385/v1/iinfras/15ba72aa-442f-4b57-a8a1-e3f3cdd5b04c",
"rel":"self"
},
{
"href":"http://10.10.10.2:6385/iinfras/15ba72aa-442f-4b57-a8a1-e3f3cdd5b04c",
"rel":"bookmark"
}
],
"created_at": "2014-12-01T19:35:36.965657+00:00",
"updated_at": "2014-12-02T20:38:51.646902+00:00",
"isystem_uuid": "b7fdc4dd-333d-471b-b21d-ba664ea87714",
"uuid": "15ba72aa-442f-4b57-a8a1-e3f3cdd5b04c"
}
]
}
-------------------
DRBD Configuration

Loading…
Cancel
Save