From 027c49944612a234a726feee526b4483396df7fd Mon Sep 17 00:00:00 2001 From: Outscale Bot Date: Mon, 21 Jul 2025 15:13:02 +0000 Subject: [PATCH] osc-sdk-go v1.35.4 Signed-off-by: Outscale Bot --- outscale-c.yaml | 8069 ++++++++++++++++++++++++---------------------- outscale-go.yaml | 8069 ++++++++++++++++++++++++---------------------- outscale.yaml | 8069 ++++++++++++++++++++++++---------------------- 3 files changed, 12504 insertions(+), 11703 deletions(-) diff --git a/outscale-c.yaml b/outscale-c.yaml index ad0d09e..8d37239 100644 --- a/outscale-c.yaml +++ b/outscale-c.yaml @@ -158,6 +158,10 @@ components: MobileNumber: description: The mobile phone number of the account owner. type: string + OutscaleLoginAllowed: + description: Whether the account is allowed to log in to Cockpit v2 using + its Outscale credentials when identity federation is activated. + type: boolean PhoneNumber: description: The landline phone number of the account owner. type: string @@ -351,7 +355,7 @@ components: type: string type: object BootMode: - description: Information about the boot mode of the OMI (`legacy` and/or `uefi`). + description: Information about the boot mode of the VM. enum: - uefi - legacy @@ -382,8 +386,8 @@ components: properties: DeleteOnVmDeletion: default: true - description: By default or if set to true, the volume is deleted when terminating - the VM. If false, the volume is not deleted when terminating the VM. + description: If set to true, the volume is deleted when terminating the + VM. If false, the volume is not deleted when terminating the VM. type: boolean Iops: description: The number of I/O operations per second (IOPS). This parameter @@ -490,7 +494,7 @@ components: format: date-time type: string State: - description: The state of the catalog (`CURRENT` \| `OBSOLETE`). + description: The state of the catalog. enum: - CURRENT - OBSOLETE @@ -1013,7 +1017,7 @@ components: "$ref": "#/components/schemas/BlockDeviceMappingImage" type: array BootModes: - description: The boot modes compatible with the OMI (`legacy` and/or `uefi`). + description: The boot modes compatible with the OMI. items: type: string type: array @@ -1984,12 +1988,11 @@ components: type: boolean PositioningStrategy: default: no-strategy - description: The positioning strategy of VMs on hypervisors. By default, - or if set to `no-strategy` our orchestrator determines the most adequate - position for your VMs. If set to `attract`, your VMs are deployed on the - same hypervisor, which improves network performance. If set to `repulse`, - your VMs are deployed on a different hypervisor, which improves fault - tolerance. + description: The positioning strategy of VMs on hypervisors. If set to `no-strategy`, + our orchestrator determines the most adequate position for your VMs. If + set to `attract`, your VMs are deployed on the same hypervisor, which + improves network performance. If set to `repulse`, your VMs are deployed + on a different hypervisor, which improves fault tolerance. enum: - attract - no-strategy @@ -2043,7 +2046,7 @@ components: type: string CpuPerformance: default: high - description: The performance of the VMs (`medium` \| `high` \| `highest`). + description: The performance of the VMs. enum: - medium - high @@ -2103,8 +2106,8 @@ components: "$ref": "#/components/schemas/BootMode" BootOnCreation: default: true - description: By default or if true, the VM is started on creation. If false, - the VM is stopped on creation. + description: If true, the VM is started on creation. If false, the VM is + stopped on creation. type: boolean BsuOptimized: description: This parameter is not available. It is present in our API for @@ -2152,9 +2155,8 @@ components: type: array Performance: default: high - description: The performance of the VM (`medium` \| `high` \| `highest`). - By default, `high`. This parameter is ignored if you specify a performance - flag directly in the `VmType` parameter. + description: The performance of the VM. This parameter is ignored if you + specify a performance flag directly in the `VmType` parameter. enum: - medium - high @@ -2189,8 +2191,8 @@ components: type: string VmInitiatedShutdownBehavior: default: stop - description: The VM behavior when you stop it. By default or if set to `stop`, - the VM stops. If set to `restart`, the VM stops then automatically restarts. + description: The VM behavior when you stop it. If set to `stop`, the VM + stops. If set to `restart`, the VM stops then automatically restarts. If set to `terminate`, the VM stops and is terminated. type: string VmType: @@ -3511,7 +3513,7 @@ components: type: string Mtu: description: The maximum transmission unit (MTU) of the DirectLink interface, - in bytes (always `1500`). + in bytes. type: integer OutscalePrivateIp: description: The IP on the OUTSCALE side of the DirectLink interface. @@ -3527,6 +3529,102 @@ components: description: The VLAN number associated with the DirectLink interface. type: integer type: object + DisableOutscaleLoginForUsersRequest: + additionalProperties: false + properties: + DryRun: + description: If true, checks whether you have the required permissions to + perform the action. + type: boolean + type: object + DisableOutscaleLoginForUsersResponse: + additionalProperties: false + properties: + ResponseContext: + "$ref": "#/components/schemas/ResponseContext" + type: object + DisableOutscaleLoginPerUsersRequest: + additionalProperties: false + properties: + DryRun: + description: If true, checks whether you have the required permissions to + perform the action. + type: boolean + UserNames: + description: The usernames of the EIM users you want to disable the Outscale + login for. + items: + type: string + type: array + type: object + DisableOutscaleLoginPerUsersResponse: + additionalProperties: false + properties: + ResponseContext: + "$ref": "#/components/schemas/ResponseContext" + type: object + DisableOutscaleLoginRequest: + additionalProperties: false + properties: + DryRun: + description: If true, checks whether you have the required permissions to + perform the action. + type: boolean + type: object + DisableOutscaleLoginResponse: + additionalProperties: false + properties: + ResponseContext: + "$ref": "#/components/schemas/ResponseContext" + type: object + EnableOutscaleLoginForUsersRequest: + additionalProperties: false + properties: + DryRun: + description: If true, checks whether you have the required permissions to + perform the action. + type: boolean + type: object + EnableOutscaleLoginForUsersResponse: + additionalProperties: false + properties: + ResponseContext: + "$ref": "#/components/schemas/ResponseContext" + type: object + EnableOutscaleLoginPerUsersRequest: + additionalProperties: false + properties: + DryRun: + description: If true, checks whether you have the required permissions to + perform the action. + type: boolean + UserNames: + description: The usernames of the EIM users you want to enable the Outscale + login for. + items: + type: string + type: array + type: object + EnableOutscaleLoginPerUsersResponse: + additionalProperties: false + properties: + ResponseContext: + "$ref": "#/components/schemas/ResponseContext" + type: object + EnableOutscaleLoginRequest: + additionalProperties: false + properties: + DryRun: + description: If true, checks whether you have the required permissions to + perform the action. + type: boolean + type: object + EnableOutscaleLoginResponse: + additionalProperties: false + properties: + ResponseContext: + "$ref": "#/components/schemas/ResponseContext" + type: object ErrorResponse: additionalProperties: false properties: @@ -3950,7 +4048,7 @@ components: type: string type: array BootModes: - description: The boot modes compatible with the OMIs (`legacy` and/or `uefi`). + description: The boot modes compatible with the OMIs. items: type: string type: array @@ -5139,7 +5237,7 @@ components: type: string type: array BootModes: - description: The boot modes of the VMs (`legacy` \| `uefi`). + description: The boot modes of the VMs. items: type: string type: array @@ -5753,7 +5851,7 @@ components: type: array VolumeStates: description: The states of the volumes (`creating` \| `available` \| `in-use` - \| `updating` \| `deleting` \| `error`). + \| `deleting` \| `error`). items: type: string type: array @@ -5938,7 +6036,7 @@ components: "$ref": "#/components/schemas/BlockDeviceMappingImage" type: array BootModes: - description: The boot modes compatible with the OMI (`legacy` and/or `uefi`). + description: The boot modes compatible with the OMI. items: type: string type: array @@ -6633,9 +6731,9 @@ components: description: The routing protocol (`HTTP` \| `HTTPS` \| `TCP` \| `SSL`). type: string ServerCertificateId: - description: The OUTSCALE Resource Name (ORN) of the server certificate. - For more information, see [Resource Identifiers > OUTSCALE Resource Names - (ORNs)](https://docs.outscale.com/en/userguide/Resource-Identifiers.html#_outscale_resource_names_orns). + description: |- + The OUTSCALE Resource Name (ORN) of the server certificate. For more information, see [Resource Identifiers > OUTSCALE Resource Names (ORNs)](https://docs.outscale.com/en/userguide/Resource-Identifiers.html#_outscale_resource_names_orns).
+ This parameter is required for `HTTPS` and `SSL` protocols. type: string required: - BackendPort @@ -7458,10 +7556,12 @@ components: description: Information about the policy entities. properties: Accounts: + description: The accounts linked to the specified policy. items: "$ref": "#/components/schemas/MinimalPolicy" type: array Groups: + description: The groups linked to the specified policy. items: "$ref": "#/components/schemas/MinimalPolicy" type: array @@ -7480,6 +7580,7 @@ components: allowed. type: boolean Users: + description: The users linked to the specified policy. items: "$ref": "#/components/schemas/MinimalPolicy" type: array @@ -7834,7 +7935,7 @@ components: ResultsPerPage: default: 100 description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer With: "$ref": "#/components/schemas/With" @@ -7928,7 +8029,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadClientGatewaysResponse: @@ -7992,11 +8093,11 @@ components: type: string Overall: default: false - description: By default or if false, returns only the consumption of the - specific account that sends this request. If true, returns either the - overall consumption of your paying account and all linked accounts (if - the account that sends this request is a paying account) or returns nothing - (if the account that sends this request is a linked account). + description: If false, returns only the consumption of the specific account + that sends this request. If true, returns either the overall consumption + of your paying account and all linked accounts (if the account that sends + this request is a paying account) or returns nothing (if the account that + sends this request is a linked account). type: boolean ShowPrice: description: If true, the response also includes the unit price of the consumed @@ -8051,7 +8152,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadDedicatedGroupsResponse: @@ -8086,7 +8187,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadDhcpOptionsResponse: @@ -8121,7 +8222,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadDirectLinkInterfacesResponse: @@ -8156,7 +8257,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadDirectLinksResponse: @@ -8179,8 +8280,8 @@ components: additionalProperties: false properties: EntitiesType: - description: The type of entity linked to the policy (`ACCOUNT` \| `USER` - \| `GROUP`) you want to get information about. + description: The type of entity linked to the policy you want to get information + about. items: enum: - ACCOUNT @@ -8266,7 +8367,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadImageExportTasksResponse: @@ -8301,7 +8402,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadImagesResponse: @@ -8336,7 +8437,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadInternetServicesResponse: @@ -8525,7 +8626,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadLocationsResponse: @@ -8604,7 +8705,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadNatServicesResponse: @@ -8639,7 +8740,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadNetAccessPointServicesResponse: @@ -8674,7 +8775,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadNetAccessPointsResponse: @@ -8709,7 +8810,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadNetPeeringsResponse: @@ -8744,7 +8845,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadNetsResponse: @@ -8779,7 +8880,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadNicsResponse: @@ -8951,7 +9052,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadProductTypesResponse: @@ -9000,7 +9101,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadPublicIpRangesResponse: @@ -9036,7 +9137,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadPublicIpsResponse: @@ -9071,7 +9172,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadQuotasResponse: @@ -9125,7 +9226,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadRouteTablesResponse: @@ -9160,7 +9261,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadSecurityGroupsResponse: @@ -9216,7 +9317,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadSnapshotExportTasksResponse: @@ -9251,7 +9352,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadSnapshotsResponse: @@ -9286,7 +9387,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadSubnetsResponse: @@ -9321,7 +9422,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadSubregionsResponse: @@ -9356,7 +9457,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadTagsResponse: @@ -9681,7 +9782,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadVirtualGatewaysResponse: @@ -9716,6 +9817,7 @@ components: ResponseContext: "$ref": "#/components/schemas/ResponseContext" VmGroups: + description: Information about one or more VM groups. items: "$ref": "#/components/schemas/VmGroup" type: array @@ -9757,7 +9859,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadVmTypesResponse: @@ -9821,7 +9923,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadVmsResponse: @@ -9845,8 +9947,8 @@ components: properties: AllVms: default: false - description: If true, includes the status of all VMs. By default or if set - to false, only includes the status of running VMs. + description: If true, includes the status of all VMs. If false, only includes + the status of running VMs. type: boolean DryRun: description: If true, checks whether you have the required permissions to @@ -9861,7 +9963,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadVmsStateResponse: @@ -9896,7 +9998,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadVolumesResponse: @@ -9931,7 +10033,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadVpnConnectionsResponse: @@ -10232,8 +10334,8 @@ components: "$ref": "#/components/schemas/ResponseContext" type: object SecureBootAction: - description: One action to perform on the next boot of the VM (`enable` | `disable` - | `setup-mode` |`none`). + description: One action to perform on the next boot of the VM. For more information, + see [About Secure Boot](https://docs.outscale.com/en/userguide/About-Secure-Boot.html#_secure_boot_actions). enum: - enable - disable @@ -10465,7 +10567,7 @@ components: type: string State: description: The state of the snapshot export task (`pending` \| `active` - \| `completed` \| `failed`). + \| `completed` \| `cancelled` \| `failed`). type: string Tags: description: One or more tags associated with the snapshot export task. @@ -11161,7 +11263,7 @@ components: type: boolean Mtu: description: The maximum transmission unit (MTU) of the DirectLink interface, - in bytes (always `1500`). + in bytes. enum: - 1500 type: integer @@ -11733,7 +11835,7 @@ components: enabled. If false, it is disabled." type: boolean Performance: - description: The performance of the VM (`medium` \| `high` \| `highest`). + description: The performance of the VM. enum: - medium - high @@ -11881,6 +11983,10 @@ components: user. format: date-time type: string + OutscaleLoginAllowed: + description: Whether the user is allowed to log in to Cockpit v2 using its + Outscale credentials when identity federation is activated. + type: boolean Path: description: The path to the EIM user. type: string @@ -12034,7 +12140,7 @@ components: description: Indicates the operating system (OS) of the VM. type: string Performance: - description: The performance of the VM (`medium` \| `high` \| `highest`). + description: The performance of the VM. type: string Placement: "$ref": "#/components/schemas/Placement" @@ -12112,10 +12218,10 @@ components: description: The description of the VM group. type: string PositioningStrategy: - description: The positioning strategy of the VMs on hypervisors. By default, - or if set to `no-strategy`, TINA determines the most adequate position - for the VMs. If set to `attract`, the VMs are deployed on the same hypervisor, - which improves network performance. If set to `repulse`, the VMs are deployed + description: The positioning strategy of the VMs on hypervisors. If set + to `no-strategy`, TINA determines the most adequate position for the VMs. + If set to `attract`, the VMs are deployed on the same hypervisor, which + improves network performance. If set to `repulse`, the VMs are deployed on a different hypervisor, which improves fault tolerance. enum: - attract @@ -12128,8 +12234,7 @@ components: type: string type: array State: - description: The state of the VM group (`pending` \| `available` \| `scaling - up` \| `scaling down` \| `deleting` \| `deleted`). + description: The state of the VM group. enum: - available - deleted @@ -12142,7 +12247,7 @@ components: description: The ID of the Subnet for the VM group. type: string Tags: - description: One or more tags associated with the VM. + description: One or more tags associated with the VM group. items: "$ref": "#/components/schemas/ResourceTag" type: array @@ -12320,7 +12425,7 @@ components: type: string State: description: The state of the volume (`creating` \| `available` \| `in-use` - \| `updating` \| `deleting` \| `error`). + \| `deleting` \| `error`). type: string SubregionName: description: The Subregion in which the volume was created. @@ -12407,73 +12512,69 @@ components: properties: AccountId: default: true - description: By default or if set to true, the account ID is displayed. + description: If true, the account ID is displayed. type: boolean CallDuration: default: true - description: By default or if set to true, the duration of the call is displayed. + description: If true, the duration of the call is displayed. type: boolean QueryAccessKey: default: true - description: By default or if set to true, the access key is displayed. + description: If true, the access key is displayed. type: boolean QueryApiName: default: true - description: By default or if set to true, the name of the API is displayed. + description: If true, the name of the API is displayed. type: boolean QueryApiVersion: default: true - description: By default or if set to true, the version of the API is displayed. + description: If true, the version of the API is displayed. type: boolean QueryCallName: default: true - description: By default or if set to true, the name of the call is displayed. + description: If true, the name of the call is displayed. type: boolean QueryDate: default: true - description: By default or if set to true, the date of the call is displayed. + description: If true, the date of the call is displayed. type: boolean QueryHeaderRaw: default: true - description: By default or if set to true, the raw header of the HTTP request - is displayed. + description: If true, the raw header of the HTTP request is displayed. type: boolean QueryHeaderSize: default: true - description: By default or if set to true, the size of the raw header of - the HTTP request is displayed. + description: If true, the size of the raw header of the HTTP request is + displayed. type: boolean QueryIpAddress: default: true - description: By default or if set to true, the IP is displayed. + description: If true, the IP is displayed. type: boolean QueryPayloadRaw: default: true - description: By default or if set to true, the raw payload of the HTTP request - is displayed. + description: If true, the raw payload of the HTTP request is displayed. type: boolean QueryPayloadSize: default: true - description: By default or if set to true, the size of the raw payload of - the HTTP request is displayed. + description: If true, the size of the raw payload of the HTTP request is + displayed. type: boolean QueryUserAgent: default: true - description: By default or if set to true, the user agent of the HTTP request - is displayed. + description: If true, the user agent of the HTTP request is displayed. type: boolean RequestId: default: true - description: By default or if set to true, the request ID is displayed. + description: If true, the request ID is displayed. type: boolean ResponseSize: default: true - description: By default or if set to true, the size of the response is displayed. + description: If true, the size of the response is displayed. type: boolean ResponseStatusCode: default: true - description: By default or if set to true, the HTTP status code of the response - is displayed. + description: If true, the HTTP status code of the response is displayed. type: boolean type: object securitySchemes: @@ -12555,57 +12656,57 @@ info: url: https://opensource.org/licenses/BSD-3-Clause termsOfService: https://en.outscale.com/terms-of-service/ title: 3DS OUTSCALE API - version: 1.35.3 + version: 1.35.4 x-osc-api-osc-billing: 1.35.0 x-osc-api-osc-cloud-vision: 1.35.0 - x-osc-api-osc-core-iaas: 1.35.3 + x-osc-api-osc-core-iaas: 1.35.4 x-osc-api-type: external openapi: 3.0.0 paths: "/AcceptNetPeering": - description: |- - Accepts a Net peering request.
- To accept this request, you must be the owner of the peer Net. If you do not accept the request within 7 days, the state of the Net peering becomes `expired`.

- - **[NOTE]**
- A peering connection between two Nets works both ways. Therefore, when an A-to-B peering connection is accepted, any pending B-to-A peering connection is automatically rejected as redundant. post: + description: |- + Accepts a Net peering request.
+ To accept this request, you must be the owner of the peer Net. If you do not accept the request within 7 days, the state of the Net peering becomes `expired`.

+ + **[NOTE]**
+ A peering connection between two Nets works both ways. Therefore, when an A-to-B peering connection is accepted, any pending B-to-A peering connection is automatically rejected as redundant. operationId: AcceptNetPeering requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/AcceptNetPeeringRequest" examples: ex1: value: NetPeeringId: pcx-12345678 - schema: - "$ref": "#/components/schemas/AcceptNetPeeringRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/AcceptNetPeeringResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 NetPeering: + Tags: [] + State: + Name: active + Message: Active AccepterNet: - AccountId: '123456789012' - IpRange: 172.16.0.0/16 NetId: vpc-12345678 + IpRange: 172.16.0.0/16 + AccountId: '123456789012' ExpirationDate: '2063-04-05T00:00:00.000Z' - NetPeeringId: pcx-12345678 SourceNet: - AccountId: '123456789012' - IpRange: 10.0.0.0/16 NetId: vpc-12345678 - State: - Message: Active - Name: active - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/AcceptNetPeeringResponse" + IpRange: 10.0.0.0/16 + AccountId: '123456789012' + NetPeeringId: pcx-12345678 description: The HTTP 200 response (OK). '400': content: @@ -12634,12 +12735,14 @@ paths: tags: - NetPeering "/AddUserToUserGroup": - description: Adds a user to a specified group. post: + description: Adds a user to a specified group. operationId: AddUserToUserGroup requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/AddUserToUserGroupRequest" examples: ex1: value: @@ -12647,86 +12750,84 @@ paths: UserGroupPath: "/example/" UserName: example-user UserPath: "/example/" - schema: - "$ref": "#/components/schemas/AddUserToUserGroupRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/AddUserToUserGroupResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/AddUserToUserGroupResponse" description: The HTTP 200 response (OK). tags: - UserGroup "/CheckAuthentication": - description: Validates the authenticity of the account. post: + description: Validates the authenticity of the account. operationId: CheckAuthentication requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CheckAuthenticationRequest" examples: ex1: value: Login: example@example.com Password: "$OSC_PASSWORD" - schema: - "$ref": "#/components/schemas/CheckAuthenticationRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CheckAuthenticationResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CheckAuthenticationResponse" description: The HTTP 200 response (OK). tags: - Account "/CreateAccessKey": - description: |- - Creates an access key for either your root account or an EIM user. The new key is automatically set to `ACTIVE`.

- For more information, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). post: + description: |- + Creates an access key for either your root account or an EIM user. The new key is automatically set to `ACTIVE`.

+ For more information, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). operationId: CreateAccessKey requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateAccessKeyRequest" examples: ex1: value: ExpirationDate: '2063-04-05' Tag: Group1 UserName: example-user - schema: - "$ref": "#/components/schemas/CreateAccessKeyRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateAccessKeyResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 AccessKey: + State: ACTIVE AccessKeyId: ABCDEFGHIJ0123456789 CreationDate: 2010-10-01 12:34:56.789000000 +00:00 ExpirationDate: 2063-04-05 00:00:00.000000000 +00:00 - LastModificationDate: 2010-10-01 12:34:56.789000000 +00:00 SecretKey: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - State: ACTIVE + LastModificationDate: 2010-10-01 12:34:56.789000000 +00:00 Tag: Group1 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateAccessKeyResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -12734,19 +12835,21 @@ paths: tags: - AccessKey "/CreateAccount": - description: |- - Creates an OUTSCALE account.

+ post: + description: |- + Creates an OUTSCALE account.

- **[IMPORTANT]**
- * You need OUTSCALE credentials and the appropriate quotas to create an account via API. To get quotas, you can send an email to sales@outscale.com.
- * If you want to pass a numeral value as a string instead of an integer, you must wrap your string in additional quotes (for example, `'"92000"'`). + **[IMPORTANT]**
+ * You need OUTSCALE credentials and the appropriate quotas to create an account via API. To get quotas, you can send an email to sales@outscale.com.
+ * If you want to pass a numeral value as a string instead of an integer, you must wrap your string in additional quotes (for example, `'"92000"'`). - For more information, see [About Your Account](https://docs.outscale.com/en/userguide/About-Your-Account.html). - post: + For more information, see [About Your Account](https://docs.outscale.com/en/userguide/About-Your-Account.html). operationId: CreateAccount requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateAccountRequest" examples: ex1: value: @@ -12758,99 +12861,97 @@ paths: FirstName: JEAN LastName: DUPONT ZipCode: '92210' - schema: - "$ref": "#/components/schemas/CreateAccountRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateAccountResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Account: - AccountId: '123456789012' - City: SAINT-CLOUD + ZipCode: '92210' CompanyName: EXAMPLE SAS - Country: FRANCE - Email: example@example.com FirstName: JEAN + City: SAINT-CLOUD + Country: FRANCE LastName: DUPONT - ZipCode: '92210' - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateAccountResponse" + AccountId: '123456789012' + Email: example@example.com description: The HTTP 200 response (OK). tags: - Account "/CreateApiAccessRule": - description: |- - Creates a rule to allow access to the API from your account.
- You need to specify at least the `CaIds` or the `IpRanges` parameter.

- - **[NOTE]**
- By default, your account has a set of rules allowing global access, that you can delete.

- For more information, see [About API Access Rules](https://docs.outscale.com/en/userguide/About-API-Access-Rules.html). post: + description: |- + Creates a rule to allow access to the API from your account.
+ You need to specify at least the `CaIds` or the `IpRanges` parameter.

+ + **[NOTE]**
+ By default, your account has a set of rules allowing global access, that you can delete.

+ For more information, see [About API Access Rules](https://docs.outscale.com/en/userguide/About-API-Access-Rules.html). operationId: CreateApiAccessRule requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateApiAccessRuleRequest" examples: ex1: summary: Creating an API access rule based on IPs value: - Description: Basic API Access Rule with IPs IpRanges: - 192.0.2.0 - 198.51.100.0/24 + Description: Basic API Access Rule with IPs ex2: summary: Creating an API access rule based on IPs and Certificate Authority (CA) value: - CaIds: - - ca-fedcba0987654321fedcba0987654321 - Description: API Access Rule with IPs and CA IpRanges: - 192.0.2.0 - 198.51.100.0/24 - schema: - "$ref": "#/components/schemas/CreateApiAccessRuleRequest" + CaIds: + - ca-fedcba0987654321fedcba0987654321 + Description: API Access Rule with IPs and CA responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateApiAccessRuleResponse" examples: ex1: summary: Creating an API access rule based on IPs value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ApiAccessRule: + IpRanges: + - 192.0.2.0 + - 198.51.100.0/24 ApiAccessRuleId: aar-fedcba0987654321fedcba0987654321 CaIds: [] Cns: [] Description: Basic API Access Rule with IPs - IpRanges: - - 192.0.2.0 - - 198.51.100.0/24 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Creating an API access rule based on IPs and Certificate Authority (CA) value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ApiAccessRule: + IpRanges: + - 192.0.2.0 + - 198.51.100.0/24 ApiAccessRuleId: aar-fedcba0987654321fedcba0987654321 CaIds: - ca-fedcba0987654321fedcba0987654321 Cns: [] Description: API Access Rule with IPs and CA - IpRanges: - - 192.0.2.0 - - 198.51.100.0/24 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateApiAccessRuleResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -12858,36 +12959,36 @@ paths: tags: - ApiAccessRule "/CreateCa": - description: |- - Creates a Client Certificate Authority (CA).

- For more information, see [About API Access Rules](https://docs.outscale.com/en/userguide/About-API-Access-Rules.html). post: + description: |- + Creates a Client Certificate Authority (CA).

+ For more information, see [About API Access Rules](https://docs.outscale.com/en/userguide/About-API-Access-Rules.html). operationId: CreateCa requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateCaRequest" examples: ex1: value: CaPem: XXXX Description: CA example - schema: - "$ref": "#/components/schemas/CreateCaRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateCaResponse" examples: ex1: value: - Ca: - CaFingerprint: 1234567890abcdef1234567890abcdef12345678 - CaId: ca-fedcba0987654321fedcba0987654321 - Description: CA example ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateCaResponse" + Ca: + Description: CA example + CaId: ca-fedcba0987654321fedcba0987654321 + CaFingerprint: 1234567890abcdef1234567890abcdef12345678 description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -12895,84 +12996,84 @@ paths: tags: - Ca "/CreateClientGateway": - description: |- - Provides information about your client gateway.
- This action registers information to identify the client gateway that you deployed in your network.
- To open a tunnel to the client gateway, you must provide the communication protocol type, the fixed public IP of the gateway, and an Autonomous System Number (ASN).

- For more information, see [About Client Gateways](https://docs.outscale.com/en/userguide/About-Client-Gateways.html). post: + description: |- + Provides information about your client gateway.
+ This action registers information to identify the client gateway that you deployed in your network.
+ To open a tunnel to the client gateway, you must provide the communication protocol type, the fixed public IP of the gateway, and an Autonomous System Number (ASN).

+ For more information, see [About Client Gateways](https://docs.outscale.com/en/userguide/About-Client-Gateways.html). operationId: CreateClientGateway requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateClientGatewayRequest" examples: ex1: value: - BgpAsn: 65000 ConnectionType: ipsec.1 PublicIp: 192.0.2.0 - schema: - "$ref": "#/components/schemas/CreateClientGatewayRequest" + BgpAsn: 65000 responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateClientGatewayResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ClientGateway: + State: available BgpAsn: 65000 + Tags: [] ClientGatewayId: cgw-12345678 ConnectionType: ipsec.1 PublicIp: 192.0.2.0 - State: available - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateClientGatewayResponse" description: The HTTP 200 response (OK). tags: - ClientGateway "/CreateDedicatedGroup": - description: |- - > [WARNING]
- > This feature is currently in beta.
- - Creates a dedicated group for virtual machines (VMs).

- For more information, see [About Dedicated Groups](https://docs.outscale.com/en/userguide/About-Dedicated-Groups.html). post: + description: |- + > [WARNING]
+ > This feature is currently in beta.
+ + Creates a dedicated group for virtual machines (VMs).

+ For more information, see [About Dedicated Groups](https://docs.outscale.com/en/userguide/About-Dedicated-Groups.html). operationId: CreateDedicatedGroup requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateDedicatedGroupRequest" examples: ex1: value: CpuGeneration: 4 Name: dedicated-group-example SubregionName: eu-west-2a - schema: - "$ref": "#/components/schemas/CreateDedicatedGroupRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateDedicatedGroupResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 DedicatedGroup: + VmIds: [] + NetIds: [] AccountId: '123456789012' CpuGeneration: 4 - DedicatedGroupId: ded-12345678 Name: dedicated-group-example - NetIds: [] SubregionName: eu-west-2a - VmIds: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateDedicatedGroupResponse" + DedicatedGroupId: ded-12345678 description: The HTTP 200 response (OK). '400': content: @@ -12995,14 +13096,16 @@ paths: tags: - DedicatedGroup "/CreateDhcpOptions": - description: |- - Creates a set of DHCP options, that you can then associate with a Net using the [UpdateNet](#updatenet) method.

- For more information, see [About DHCP Options](https://docs.outscale.com/en/userguide/About-DHCP-Options.html). post: + description: |- + Creates a set of DHCP options, that you can then associate with a Net using the [UpdateNet](#updatenet) method.

+ For more information, see [About DHCP Options](https://docs.outscale.com/en/userguide/About-DHCP-Options.html). operationId: CreateDhcpOptions requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateDhcpOptionsRequest" examples: ex1: value: @@ -13013,57 +13116,59 @@ paths: NtpServers: - 203.0.113.0 - 203.0.113.1 - schema: - "$ref": "#/components/schemas/CreateDhcpOptionsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateDhcpOptionsResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 DhcpOptionsSet: + Tags: [] + NtpServers: + - 203.0.113.0 + - 203.0.113.1 Default: false DhcpOptionsSetId: dopt-12345678 DomainName: example.com DomainNameServers: - 192.0.2.0 - 198.51.100.0 - NtpServers: - - 203.0.113.0 - - 203.0.113.1 - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateDhcpOptionsResponse" description: The HTTP 200 response (OK). tags: - DhcpOption "/CreateDirectLink": - description: |- - Creates a DirectLink between a customer network and a specified DirectLink location.

- For more information, see [About DirectLink](https://docs.outscale.com/en/userguide/About-DirectLink.html). post: + description: |- + Creates a DirectLink between a customer network and a specified DirectLink location.

+ For more information, see [About DirectLink](https://docs.outscale.com/en/userguide/About-DirectLink.html). operationId: CreateDirectLink requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateDirectLinkRequest" examples: ex1: value: + Location: PAR1 Bandwidth: 1Gbps DirectLinkName: Connection to Outscale - Location: PAR1 - schema: - "$ref": "#/components/schemas/CreateDirectLinkRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateDirectLinkResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 DirectLink: AccountId: '123456789012' Bandwidth: 1Gbps @@ -13072,130 +13177,128 @@ paths: Location: PAR1 RegionName: eu-west-2 State: requested - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateDirectLinkResponse" description: The HTTP 200 response (OK). tags: - DirectLink "/CreateDirectLinkInterface": - description: |- - Creates a DirectLink interface.
- DirectLink interfaces enable you to reach one of your Nets through a virtual gateway.

- For more information, see [About DirectLink](https://docs.outscale.com/en/userguide/About-DirectLink.html). post: + description: |- + Creates a DirectLink interface.
+ DirectLink interfaces enable you to reach one of your Nets through a virtual gateway.

+ For more information, see [About DirectLink](https://docs.outscale.com/en/userguide/About-DirectLink.html). operationId: CreateDirectLinkInterface requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateDirectLinkInterfaceRequest" examples: ex1: value: DirectLinkId: dxcon-12345678 DirectLinkInterface: + DirectLinkInterfaceName: MyDirectLinkInterface + Vlan: 101 BgpAsn: 65000 BgpKey: tgyn26example - ClientPrivateIp: 172.16.0.5/30 - DirectLinkInterfaceName: MyDirectLinkInterface OutscalePrivateIp: 172.16.0.4/30 + ClientPrivateIp: 172.16.0.5/30 VirtualGatewayId: vgw-12345678 - Vlan: 101 - schema: - "$ref": "#/components/schemas/CreateDirectLinkInterfaceRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateDirectLinkInterfaceResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 DirectLinkInterface: - AccountId: '123456789012' + Vlan: 101 + OutscalePrivateIp: 172.16.0.4/30 + DirectLinkInterfaceId: dxvif-12345678 BgpAsn: 65000 + AccountId: '123456789012' ClientPrivateIp: 172.16.0.5/30 - DirectLinkId: dxcon-12345678 - DirectLinkInterfaceId: dxvif-12345678 + VirtualGatewayId: vgw-12345678 DirectLinkInterfaceName: MyDirectLinkInterface - InterfaceType: private - Location: PAR1 + DirectLinkId: dxcon-12345678 Mtu: 1500 - OutscalePrivateIp: 172.16.0.4/30 State: pending - VirtualGatewayId: vgw-12345678 - Vlan: 101 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateDirectLinkInterfaceResponse" + InterfaceType: private + Location: PAR1 description: The HTTP 200 response (OK). tags: - DirectLinkInterface "/CreateFlexibleGpu": - description: |- - Allocates a flexible GPU (fGPU) to your account.
- You can then attach this fGPU to a virtual machine (VM).

- For more information, see [About Flexible GPUs](https://docs.outscale.com/en/userguide/About-Flexible-GPUs.html). post: + description: |- + Allocates a flexible GPU (fGPU) to your account.
+ You can then attach this fGPU to a virtual machine (VM).

+ For more information, see [About Flexible GPUs](https://docs.outscale.com/en/userguide/About-Flexible-GPUs.html). operationId: CreateFlexibleGpu requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateFlexibleGpuRequest" examples: ex1: value: - DeleteOnVmDeletion: true - Generation: v5 ModelName: nvidia-p100 + Generation: v5 SubregionName: eu-west-2a - schema: - "$ref": "#/components/schemas/CreateFlexibleGpuRequest" + DeleteOnVmDeletion: true responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateFlexibleGpuResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 FlexibleGpu: + SubregionName: eu-west-2a DeleteOnVmDeletion: true - FlexibleGpuId: fgpu-12345678 Generation: v5 ModelName: nvidia-p100 State: allocated - SubregionName: eu-west-2a - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateFlexibleGpuResponse" + FlexibleGpuId: fgpu-12345678 description: The HTTP 200 response (OK). tags: - FlexibleGpu "/CreateImage": - description: |- - Creates an OUTSCALE machine image (OMI).
- You can use this method for different use cases: - * **Creating from a VM**: You create an OMI from one of your virtual machines (VMs).
- * **Copying an OMI**: You copy an existing OMI. The source OMI can be one of your own OMIs, or an OMI owned by another account that has granted you permission via the [UpdateImage](#updateimage) method.
- * **Registering from a snapshot**: You register an OMI from an existing snapshot. The source snapshot can be one of your own snapshots, or a snapshot owned by another account that has granted you permission via the [UpdateSnapshot](#updatesnapshot) method.
- * **Registering from a bucket by using a manifest file**: You register an OMI from the manifest file of an OMI that was exported to an OUTSCALE Object Storage (OOS) bucket. First, the owner of the source OMI must export it to the bucket by using the [CreateImageExportTask](#createimageexporttask) method. Then, they must grant you permission to read the manifest file via a pre-signed URL. For more information, see [Creating a Pre-Signed URL](https://docs.outscale.com/en/userguide/Creating-a-Pre-Signed-URL.html). + post: + description: |- + Creates an OUTSCALE machine image (OMI).
+ You can use this method for different use cases: + * **Creating from a VM**: You create an OMI from one of your virtual machines (VMs).
+ * **Copying an OMI**: You copy an existing OMI. The source OMI can be one of your own OMIs, or an OMI owned by another account that has granted you permission via the [UpdateImage](#updateimage) method.
+ * **Registering from a snapshot**: You register an OMI from an existing snapshot. The source snapshot can be one of your own snapshots, or a snapshot owned by another account that has granted you permission via the [UpdateSnapshot](#updatesnapshot) method.
+ * **Registering from a bucket by using a manifest file**: You register an OMI from the manifest file of an OMI that was exported to an OUTSCALE Object Storage (OOS) bucket. First, the owner of the source OMI must export it to the bucket by using the [CreateImageExportTask](#createimageexporttask) method. Then, they must grant you permission to read the manifest file via a pre-signed URL. For more information, see [Creating a Pre-Signed URL](https://docs.outscale.com/en/userguide/Creating-a-Pre-Signed-URL.html). - **[TIP]**
- Registering from a bucket enables you to copy an OMI across Regions. + **[TIP]**
+ Registering from a bucket enables you to copy an OMI across Regions. - For more information, see [About OMIs](https://docs.outscale.com/en/userguide/About-OMIs.html). - post: + For more information, see [About OMIs](https://docs.outscale.com/en/userguide/About-OMIs.html). operationId: CreateImage requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateImageRequest" examples: ex1: summary: Creating from a VM value: ImageName: create-image-example - NoReboot: true VmId: i-12345678 + NoReboot: true ex2: summary: Copying an OMI value: @@ -13205,163 +13308,161 @@ paths: ex3: summary: Registering from a snapshot value: + ImageName: register-image-from-snapshot-example BlockDeviceMappings: - - Bsu: - DeleteOnVmDeletion: true - Iops: 150 + - DeviceName: "/dev/sda1" + Bsu: SnapshotId: snap-12345678 VolumeSize: 120 VolumeType: io1 - DeviceName: "/dev/sda1" - ImageName: register-image-from-snapshot-example + Iops: 150 + DeleteOnVmDeletion: true RootDeviceName: "/dev/sda1" ex4: summary: Registering from a bucket by using a manifest file value: - FileLocation: https://oos.eu-west-2.outscale.com/BUCKET/KEY?AWSAccessKeyId=ABCDEFGHIJ0123456789&Expires=1493372309&Signature=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX ImageName: register-image-from-bucket-example - schema: - "$ref": "#/components/schemas/CreateImageRequest" + FileLocation: https://oos.eu-west-2.outscale.com/BUCKET/KEY?AWSAccessKeyId=ABCDEFGHIJ0123456789&Expires=1493372309&Signature=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateImageResponse" examples: ex1: summary: Creating from a VM value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Image: + StateComment: {} + State: pending + RootDeviceType: bsu + RootDeviceName: "/dev/sda1" + ProductCodes: + - '0001' + PermissionsToLaunch: + GlobalPermission: false + AccountIds: [] AccountId: '123456789012' - Architecture: x86_64 + Tags: [] + Description: '' + ImageId: ami-12345678 BlockDeviceMappings: - - Bsu: + - DeviceName: "/dev/sda1" + Bsu: + VolumeType: standard DeleteOnVmDeletion: true - SnapshotId: snap-12345678 VolumeSize: 50 - VolumeType: standard - DeviceName: "/dev/sda1" + SnapshotId: snap-12345678 BootModes: - legacy + ImageType: machine CreationDate: '2010-10-01T12:34:56.789Z' - Description: '' FileLocation: 123456789012/create-image-example - ImageId: ami-12345678 + Architecture: x86_64 ImageName: create-image-example - ImageType: machine - PermissionsToLaunch: - AccountIds: [] - GlobalPermission: false - ProductCodes: - - '0001' - RootDeviceName: "/dev/sda1" - RootDeviceType: bsu - State: pending - StateComment: {} - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Copying an OMI value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Image: + StateComment: {} + State: available + RootDeviceType: bsu + RootDeviceName: "/dev/sda1" + ProductCodes: + - '0001' + PermissionsToLaunch: + GlobalPermission: false + AccountIds: [] AccountId: '123456789012' - Architecture: x86_64 + Tags: [] + Description: '' + ImageId: ami-12345678 BlockDeviceMappings: - - Bsu: + - DeviceName: "/dev/sda1" + Bsu: + VolumeType: standard DeleteOnVmDeletion: true - SnapshotId: snap-12345678 VolumeSize: 50 - VolumeType: standard - DeviceName: "/dev/sda1" + SnapshotId: snap-12345678 BootModes: - legacy + ImageType: machine CreationDate: '2010-10-01T12:34:56.789Z' - Description: '' FileLocation: 123456789012/copy-image-example - ImageId: ami-12345678 + Architecture: x86_64 ImageName: copy-image-example - ImageType: machine - PermissionsToLaunch: - AccountIds: [] - GlobalPermission: false - ProductCodes: - - '0001' - RootDeviceName: "/dev/sda1" - RootDeviceType: bsu - State: available - StateComment: {} - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex3: summary: Registering from a snapshot value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Image: + StateComment: {} + State: available + RootDeviceType: bsu + RootDeviceName: "/dev/sda1" + ProductCodes: + - '0001' + PermissionsToLaunch: + GlobalPermission: false + AccountIds: [] AccountId: '123456789012' - Architecture: x86_64 + Tags: [] + Description: '' + ImageId: ami-12345678 BlockDeviceMappings: - - Bsu: + - DeviceName: "/dev/sda1" + Bsu: + VolumeType: io1 DeleteOnVmDeletion: true + VolumeSize: 120 Iops: 150 SnapshotId: snap-12345678 - VolumeSize: 120 - VolumeType: io1 - DeviceName: "/dev/sda1" BootModes: - legacy + ImageType: machine CreationDate: '2010-10-01T12:34:56.789Z' - Description: '' FileLocation: 123456789012/register-image-from-snapshot-example - ImageId: ami-12345678 + Architecture: x86_64 ImageName: register-image-from-snapshot-example - ImageType: machine - PermissionsToLaunch: - AccountIds: [] - GlobalPermission: false - ProductCodes: - - '0001' - RootDeviceName: "/dev/sda1" - RootDeviceType: bsu - State: available - StateComment: {} - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex4: summary: Registering from a bucket by using a manifest file value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Image: + StateComment: {} + State: pending + RootDeviceType: bsu + RootDeviceName: "/dev/sda1" + ProductCodes: + - '0001' + PermissionsToLaunch: + GlobalPermission: false + AccountIds: [] AccountId: '123456789012' - Architecture: x86_64 + Tags: [] + Description: '' + ImageId: ami-12345678 BlockDeviceMappings: - - Bsu: + - DeviceName: "/dev/sda1" + Bsu: + VolumeType: standard DeleteOnVmDeletion: true - SnapshotId: snap-12345678 VolumeSize: 50 - VolumeType: standard - DeviceName: "/dev/sda1" + SnapshotId: snap-12345678 BootModes: - legacy + ImageType: machine CreationDate: '2010-10-01T12:34:56.789Z' - Description: '' FileLocation: https://oos.eu-west-2.outscale.com/BUCKET/KEY?AWSAccessKeyId=ABCDEFGHIJ0123456789&Expires=1493372309&Signature=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - ImageId: ami-12345678 + Architecture: x86_64 ImageName: register-image-from-bucket-example - ImageType: machine - PermissionsToLaunch: - AccountIds: [] - GlobalPermission: false - ProductCodes: - - '0001' - RootDeviceName: "/dev/sda1" - RootDeviceType: bsu - State: pending - StateComment: {} - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateImageResponse" description: The HTTP 200 response (OK). '400': content: @@ -13384,20 +13485,22 @@ paths: tags: - Image "/CreateImageExportTask": - description: |- - Exports an OUTSCALE machine image (OMI) to an OUTSCALE Object Storage (OOS) bucket.
- This enables you to copy an OMI between accounts in different Regions.

- This action creates the necessary snapshots and manifest file in the bucket. The OMI can then be imported to another account using a pre-signed URL of its manifest file. For more information, see [Creating a Pre-Signed URL](https://docs.outscale.com/en/userguide/Creating-a-Pre-Signed-URL.html).

- To copy an OMI in the same Region, you can also use the [CreateImage](#createimage) method.
- - **[IMPORTANT]**
- You cannot export a shared or public OMI, as they do not belong to you. To do so, you must first copy it to your account. The copy then belongs to you and you can export it.

- For more information, see [About OMIs](https://docs.outscale.com/en/userguide/About-OMIs.html). post: + description: |- + Exports an OUTSCALE machine image (OMI) to an OUTSCALE Object Storage (OOS) bucket.
+ This enables you to copy an OMI between accounts in different Regions.

+ This action creates the necessary snapshots and manifest file in the bucket. The OMI can then be imported to another account using a pre-signed URL of its manifest file. For more information, see [Creating a Pre-Signed URL](https://docs.outscale.com/en/userguide/Creating-a-Pre-Signed-URL.html).

+ To copy an OMI in the same Region, you can also use the [CreateImage](#createimage) method.
+ + **[IMPORTANT]**
+ You cannot export a shared or public OMI, as they do not belong to you. To do so, you must first copy it to your account. The copy then belongs to you and you can export it.

+ For more information, see [About OMIs](https://docs.outscale.com/en/userguide/About-OMIs.html). operationId: CreateImageExportTask requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateImageExportTaskRequest" examples: ex1: value: @@ -13406,62 +13509,60 @@ paths: DiskImageFormat: qcow2 OsuBucket: BUCKET OsuPrefix: PREFIX - schema: - "$ref": "#/components/schemas/CreateImageExportTaskRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateImageExportTaskResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ImageExportTask: - Comment: Export of image ami-12345678 + Tags: [] ImageId: ami-12345678 + TaskId: image-export-12345678 + Comment: Export of image ami-12345678 OsuExport: - DiskImageFormat: qcow2 - OsuBucket: BUCKET OsuPrefix: PREFIX/ami-12345678/ - Progress: 0 + OsuBucket: BUCKET + DiskImageFormat: qcow2 State: pending/queued - Tags: [] - TaskId: image-export-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateImageExportTaskResponse" + Progress: 0 description: The HTTP 200 response (OK). tags: - Image "/CreateInternetService": - description: |- - Creates an internet service you can use with a Net.
- An internet service enables virtual machines (VMs) launched in a Net to connect to the Internet. It allows routing of incoming and outgoing Internet traffic and management of public IP addresses.

- For more information, see [About Internet Services](https://docs.outscale.com/en/userguide/About-Internet-Services.html). post: + description: |- + Creates an internet service you can use with a Net.
+ An internet service enables virtual machines (VMs) launched in a Net to connect to the Internet. It allows routing of incoming and outgoing Internet traffic and management of public IP addresses.

+ For more information, see [About Internet Services](https://docs.outscale.com/en/userguide/About-Internet-Services.html). operationId: CreateInternetService requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateInternetServiceRequest" examples: ex1: value: {} - schema: - "$ref": "#/components/schemas/CreateInternetServiceRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateInternetServiceResponse" examples: ex1: value: - InternetService: - InternetServiceId: igw-12345678 - Tags: [] ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateInternetServiceResponse" + InternetService: + Tags: [] + InternetServiceId: igw-12345678 description: The HTTP 200 response (OK). '400': content: @@ -13484,19 +13585,21 @@ paths: tags: - InternetService "/CreateKeypair": - description: |- - Creates a keypair to use with your virtual machines (VMs).
- You can use this method in two different ways: - * **Creating a keypair**: In that case, 3DS OUTSCALE creates a 2048-bit RSA keypair, stores its public key in your account, and returns its private key in the response of the call so that you can save it in a file.
- When you save the returned private key, make sure you replace the `\n` escape sequences with real line breaks. - * **Importing a keypair created locally**: If you already have a keypair that you have created locally with a third-party tool, you can import its public key in your account. The following types of key can be imported: RSA (2048 bits or preferably 4096 bits), Ed25519, and ECDSA (256 bits, 384 bits, or 521 bits). The following formats can be used: PEM, PKCS8, RFC4716, and OpenSSH. - - For more information, see [About Keypairs](https://docs.outscale.com/en/userguide/About-Keypairs.html). post: + description: |- + Creates a keypair to use with your virtual machines (VMs).
+ You can use this method in two different ways: + * **Creating a keypair**: In that case, 3DS OUTSCALE creates a 2048-bit RSA keypair, stores its public key in your account, and returns its private key in the response of the call so that you can save it in a file.
+ When you save the returned private key, make sure you replace the `\n` escape sequences with real line breaks. + * **Importing a keypair created locally**: If you already have a keypair that you have created locally with a third-party tool, you can import its public key in your account. The following types of key can be imported: RSA (2048 bits or preferably 4096 bits), Ed25519, and ECDSA (256 bits, 384 bits, or 521 bits). The following formats can be used: PEM, PKCS8, RFC4716, and OpenSSH. + + For more information, see [About Keypairs](https://docs.outscale.com/en/userguide/About-Keypairs.html). operationId: CreateKeypair requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateKeypairRequest" examples: ex1: summary: Creating a keypair @@ -13507,39 +13610,37 @@ paths: value: KeypairName: import-keypair-example PublicKey: "..." - schema: - "$ref": "#/components/schemas/CreateKeypairRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateKeypairResponse" examples: ex1: summary: Creating a keypair value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Keypair: - KeypairFingerprint: 11:22:33:44:55:66:77:88:99:00:aa:bb:cc:dd:ee:ff - KeypairId: key-abcdef1234567890abcdef1234567890 - KeypairName: create-keypair-example - KeypairType: ssh-rsa PrivateKey: |- -----BEGIN RSA PRIVATE KEY----- ... -----END RSA PRIVATE KEY----- - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + KeypairType: ssh-rsa + KeypairName: create-keypair-example + KeypairId: key-abcdef1234567890abcdef1234567890 + KeypairFingerprint: 11:22:33:44:55:66:77:88:99:00:aa:bb:cc:dd:ee:ff ex2: summary: Importing a keypair created locally value: - Keypair: - KeypairFingerprint: 11:22:33:44:55:66:77:88:99:00:aa:bb:cc:dd:ee:ff - KeypairId: key-abcdef1234567890abcdef1234567890 - KeypairName: create-keypair-example - KeypairType: ssh-rsa ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateKeypairResponse" + Keypair: + KeypairType: ssh-rsa + KeypairName: create-keypair-example + KeypairId: key-abcdef1234567890abcdef1234567890 + KeypairFingerprint: 11:22:33:44:55:66:77:88:99:00:aa:bb:cc:dd:ee:ff description: The HTTP 200 response (OK). '400': content: @@ -13568,15 +13669,17 @@ paths: tags: - Keypair "/CreateListenerRule": - description: |- - Creates a rule for traffic redirection for the specified listener. Each rule must have either the `HostNamePattern` or `PathPattern` parameter specified. Rules are treated in priority order, from the highest value to the lowest value.
- Once the rule is created, you need to register backend VMs with it. For more information, see the [RegisterVmsInLoadBalancer](#registervmsinloadbalancer) method.

- For more information, see [About Load Balancers](https://docs.outscale.com/en/userguide/About-Load-Balancers.html). post: + description: |- + Creates a rule for traffic redirection for the specified listener. Each rule must have either the `HostNamePattern` or `PathPattern` parameter specified. Rules are treated in priority order, from the highest value to the lowest value.
+ Once the rule is created, you need to register backend VMs with it. For more information, see the [RegisterVmsInLoadBalancer](#registervmsinloadbalancer) method.

+ For more information, see [About Load Balancers](https://docs.outscale.com/en/userguide/About-Load-Balancers.html). operationId: CreateListenerRule requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateListenerRuleRequest" examples: ex1: summary: Creating a listener rule based on a host pattern @@ -13599,274 +13702,290 @@ paths: LoadBalancerPort: 80 ListenerRule: Action: forward - ListenerRuleName: example-listener-rule PathPattern: "/docs/*" + ListenerRuleName: example-listener-rule Priority: 100 VmIds: - i-12345678 - schema: - "$ref": "#/components/schemas/CreateListenerRuleRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateListenerRuleResponse" examples: ex1: summary: Creating a listener rule based on a host pattern value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ListenerRule: - Action: forward - HostNamePattern: "*.example.com" - ListenerId: 123456 - ListenerRuleId: 1234 - ListenerRuleName: example-listener-rule Priority: 10 VmIds: - i-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ListenerRuleName: example-listener-rule + Action: forward + ListenerId: 123456 + HostNamePattern: "*.example.com" + ListenerRuleId: 1234 ex2: summary: Creating a listener rule based on a path pattern value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ListenerRule: - Action: forward - ListenerId: 123456 - ListenerRuleId: 1234 - ListenerRuleName: example-listener-rule - PathPattern: "/docs/*" Priority: 100 VmIds: - i-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateListenerRuleResponse" + ListenerRuleName: example-listener-rule + Action: forward + ListenerId: 123456 + PathPattern: "/docs/*" + ListenerRuleId: 1234 description: The HTTP 200 response (OK). tags: - Listener "/CreateLoadBalancer": - description: |- - Creates a load balancer.
- The load balancer is created with a unique Domain Name Service (DNS) name. It receives the incoming traffic and routes it to its registered virtual machines (VMs).
- By default, this action creates an Internet-facing load balancer, resolving to public IPs. To create an internal load balancer in a Net, resolving to private IPs, use the `LoadBalancerType` parameter.
- You must specify either the `Subnets` or the `SubregionNames` parameters.

- For more information, see [About Load Balancers](https://docs.outscale.com/en/userguide/About-Load-Balancers.html). post: + description: |- + Creates a load balancer.
+ The load balancer is created with a unique Domain Name Service (DNS) name. It receives the incoming traffic and routes it to its registered virtual machines (VMs).
+ By default, this action creates an Internet-facing load balancer, resolving to public IPs. To create an internal load balancer in a Net, resolving to private IPs, use the `LoadBalancerType` parameter.
+ You must specify either the `Subnets` or the `SubregionNames` parameters.

+ For more information, see [About Load Balancers](https://docs.outscale.com/en/userguide/About-Load-Balancers.html). operationId: CreateLoadBalancer requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateLoadBalancerRequest" examples: ex1: summary: Creating an internal load balancer in a Net value: + LoadBalancerName: private-lb-example Listeners: - BackendPort: 80 BackendProtocol: TCP LoadBalancerPort: 80 LoadBalancerProtocol: TCP - LoadBalancerName: private-lb-example - LoadBalancerType: internal - SecurityGroups: - - sg-12345678 Subnets: - subnet-12345678 + SecurityGroups: + - sg-12345678 + LoadBalancerType: internal ex2: summary: Creating an internet-facing load balancer in a Net value: + LoadBalancerName: private-lb-example Listeners: - BackendPort: 80 BackendProtocol: HTTP LoadBalancerPort: 443 LoadBalancerProtocol: HTTPS ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate - LoadBalancerName: private-lb-example - LoadBalancerType: internet-facing - PublicIp: 192.0.2.0 - SecurityGroups: - - sg-12345678 Subnets: - subnet-12345678 + SecurityGroups: + - sg-12345678 + LoadBalancerType: internet-facing + PublicIp: 192.0.2.0 ex3: summary: Creating an internet-facing load balancer in the public Cloud value: + LoadBalancerName: public-lb-example + SubregionNames: + - eu-west-2a Listeners: - BackendPort: 8080 BackendProtocol: HTTP LoadBalancerPort: 8080 LoadBalancerProtocol: HTTP - LoadBalancerName: public-lb-example - SubregionNames: - - eu-west-2a - schema: - "$ref": "#/components/schemas/CreateLoadBalancerRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateLoadBalancerResponse" examples: ex1: summary: Creating an internal load balancer in a Net value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 LoadBalancer: + Tags: [] + SourceSecurityGroup: + SecurityGroupName: security-group-example + SecurityGroupAccountId: '123456789012' + SecuredCookies: false + Subnets: + - subnet-12345678 + NetId: vpc-12345678 + BackendVmIds: [] + ApplicationStickyCookiePolicies: [] + SecurityGroups: + - sg-12345678 + LoadBalancerType: internal AccessLog: - IsEnabled: false PublicationInterval: 60 - ApplicationStickyCookiePolicies: [] - BackendVmIds: [] + IsEnabled: false DnsName: internal-private-lb-example.123456789.eu-west-2.lbu.outscale.com HealthCheck: + UnhealthyThreshold: 2 + Timeout: 5 CheckInterval: 30 + Protocol: TCP HealthyThreshold: 10 Port: 80 - Protocol: TCP - Timeout: 5 - UnhealthyThreshold: 2 + LoadBalancerStickyCookiePolicies: [] + SubregionNames: + - eu-west-2a Listeners: - BackendPort: 80 BackendProtocol: TCP LoadBalancerPort: 80 LoadBalancerProtocol: TCP LoadBalancerName: private-lb-example - LoadBalancerStickyCookiePolicies: [] - LoadBalancerType: internal - NetId: vpc-12345678 - SecuredCookies: false - SecurityGroups: - - sg-12345678 - SourceSecurityGroup: - SecurityGroupAccountId: '123456789012' - SecurityGroupName: security-group-example - Subnets: - - subnet-12345678 - SubregionNames: - - eu-west-2a - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Creating an internet-facing load balancer in a Net value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 LoadBalancer: - AccessLog: - IsEnabled: false - PublicationInterval: 60 - ApplicationStickyCookiePolicies: [] - BackendVmIds: [] - DnsName: private-lb-example.123456789.eu-west-2.lbu.outscale.com - HealthCheck: - CheckInterval: 30 - HealthyThreshold: 10 - Port: 80 - Protocol: TCP - Timeout: 5 - UnhealthyThreshold: 2 - Listeners: - - BackendPort: 80 - BackendProtocol: HTTP - LoadBalancerPort: 443 - LoadBalancerProtocol: HTTPS - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate - LoadBalancerName: private-lb-example - LoadBalancerStickyCookiePolicies: [] - LoadBalancerType: internet-facing - NetId: vpc-12345678 - PublicIp: 192.0.2.0 - SecuredCookies: false - SecurityGroups: - - sg-12345678 + Tags: [] SourceSecurityGroup: - SecurityGroupAccountId: '123456789012' SecurityGroupName: security-group-example + SecurityGroupAccountId: '123456789012' + SecuredCookies: false + PublicIp: 192.0.2.0 Subnets: - subnet-12345678 + NetId: vpc-12345678 + BackendVmIds: [] + ApplicationStickyCookiePolicies: [] + SecurityGroups: + - sg-12345678 + LoadBalancerType: internet-facing + AccessLog: + PublicationInterval: 60 + IsEnabled: false + DnsName: private-lb-example.123456789.eu-west-2.lbu.outscale.com + HealthCheck: + UnhealthyThreshold: 2 + Timeout: 5 + CheckInterval: 30 + Protocol: TCP + HealthyThreshold: 10 + Port: 80 + LoadBalancerStickyCookiePolicies: [] SubregionNames: - eu-west-2a - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Listeners: + - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate + BackendPort: 80 + BackendProtocol: HTTP + LoadBalancerPort: 443 + LoadBalancerProtocol: HTTPS + LoadBalancerName: private-lb-example ex3: summary: Creating an internet-facing load balancer in the public Cloud value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 LoadBalancer: + Tags: [] + SourceSecurityGroup: + SecurityGroupName: outscale-elb-sg + SecurityGroupAccountId: outscale-elb + SecuredCookies: false + Subnets: [] + BackendVmIds: [] + ApplicationStickyCookiePolicies: [] + LoadBalancerType: internet-facing AccessLog: - IsEnabled: false PublicationInterval: 60 - ApplicationStickyCookiePolicies: [] - BackendVmIds: [] + IsEnabled: false DnsName: public-lb-example.123456789.eu-west-2.lbu.outscale.com HealthCheck: + UnhealthyThreshold: 2 + Timeout: 5 CheckInterval: 30 + Protocol: TCP HealthyThreshold: 10 Port: 8080 - Protocol: TCP - Timeout: 5 - UnhealthyThreshold: 2 + LoadBalancerStickyCookiePolicies: [] + SubregionNames: + - eu-west-2a Listeners: - BackendPort: 8080 BackendProtocol: HTTP LoadBalancerPort: 8080 LoadBalancerProtocol: HTTP LoadBalancerName: public-lb-example - LoadBalancerStickyCookiePolicies: [] - LoadBalancerType: internet-facing - SecuredCookies: false - SourceSecurityGroup: - SecurityGroupAccountId: outscale-elb - SecurityGroupName: outscale-elb-sg - Subnets: [] - SubregionNames: - - eu-west-2a - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateLoadBalancerResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer "/CreateLoadBalancerListeners": - description: |- - Creates one or more listeners for a specified load balancer.

- For more information, see [About Load Balancers](https://docs.outscale.com/en/userguide/About-Load-Balancers.html). post: + description: |- + Creates one or more listeners for a specified load balancer.

+ For more information, see [About Load Balancers](https://docs.outscale.com/en/userguide/About-Load-Balancers.html). operationId: CreateLoadBalancerListeners requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateLoadBalancerListenersRequest" examples: ex1: value: + LoadBalancerName: example-lbu Listeners: - BackendPort: 58 BackendProtocol: TCP LoadBalancerPort: 62 LoadBalancerProtocol: TCP - LoadBalancerName: example-lbu - schema: - "$ref": "#/components/schemas/CreateLoadBalancerListenersRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateLoadBalancerListenersResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 LoadBalancer: + Tags: [] + SourceSecurityGroup: + SecurityGroupName: security-group-example + SecurityGroupAccountId: '123456789012' + SecuredCookies: false + Subnets: + - subnet-12345678 + NetId: vpc-12345678 + BackendVmIds: [] + ApplicationStickyCookiePolicies: [] + SecurityGroups: + - sg-12345678 + LoadBalancerType: internal AccessLog: - IsEnabled: false PublicationInterval: 60 - ApplicationStickyCookiePolicies: [] - BackendVmIds: [] + IsEnabled: false DnsName: internal-example-lbu.123456789.eu-west-2.lbu.outscale.com HealthCheck: + UnhealthyThreshold: 2 + Timeout: 5 CheckInterval: 30 + Protocol: TCP HealthyThreshold: 10 Port: 80 - Protocol: TCP - Timeout: 5 - UnhealthyThreshold: 2 + LoadBalancerStickyCookiePolicies: [] + SubregionNames: + - eu-west-2a Listeners: - BackendPort: 58 BackendProtocol: TCP @@ -13877,42 +13996,26 @@ paths: LoadBalancerPort: 80 LoadBalancerProtocol: TCP LoadBalancerName: example-lbu - LoadBalancerStickyCookiePolicies: [] - LoadBalancerType: internal - NetId: vpc-12345678 - SecuredCookies: false - SecurityGroups: - - sg-12345678 - SourceSecurityGroup: - SecurityGroupAccountId: '123456789012' - SecurityGroupName: security-group-example - Subnets: - - subnet-12345678 - SubregionNames: - - eu-west-2a - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateLoadBalancerListenersResponse" description: The HTTP 200 response (OK). tags: - Listener "/CreateLoadBalancerPolicy": - description: |- - Creates a stickiness policy with sticky session lifetimes defined by the browser lifetime.
- The created policy can be used with HTTP or HTTPS listeners only.
- If this policy is implemented by a load balancer, this load balancer uses this cookie in all incoming requests to direct them to the specified backend server virtual machine (VM). If this cookie is not present, the load balancer sends the request to any other server according to its load-balancing algorithm.

- - You can also create a stickiness policy with sticky session lifetimes following the lifetime of an application-generated cookie.
- Unlike the other type of stickiness policy, the lifetime of the special Load Balancer Unit (LBU) cookie follows the lifetime of the application-generated cookie specified in the policy configuration. The load balancer inserts a new stickiness cookie only when the application response includes a new application cookie.
- The session stops being sticky if the application cookie is removed or expires, until a new application cookie is issued.

- For more information, see [About Load Balancers](https://docs.outscale.com/en/userguide/About-Load-Balancers.html). post: + description: |- + Creates a stickiness policy with sticky session lifetimes defined by the browser lifetime.
+ The created policy can be used with HTTP or HTTPS listeners only.
+ If this policy is implemented by a load balancer, this load balancer uses this cookie in all incoming requests to direct them to the specified backend server virtual machine (VM). If this cookie is not present, the load balancer sends the request to any other server according to its load-balancing algorithm.

+ + You can also create a stickiness policy with sticky session lifetimes following the lifetime of an application-generated cookie.
+ Unlike the other type of stickiness policy, the lifetime of the special Load Balancer Unit (LBU) cookie follows the lifetime of the application-generated cookie specified in the policy configuration. The load balancer inserts a new stickiness cookie only when the application response includes a new application cookie.
+ The session stops being sticky if the application cookie is removed or expires, until a new application cookie is issued.

+ For more information, see [About Load Balancers](https://docs.outscale.com/en/userguide/About-Load-Balancers.html). operationId: CreateLoadBalancerPolicy requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateLoadBalancerPolicyRequest" examples: ex1: summary: Creating a load balancer policy based on browser @@ -13923,112 +14026,112 @@ paths: ex2: summary: Creating a load balancer policy based on application cookie value: - CookieName: example-cookie LoadBalancerName: example-lbu PolicyName: example-app-policy PolicyType: app - schema: - "$ref": "#/components/schemas/CreateLoadBalancerPolicyRequest" + CookieName: example-cookie responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateLoadBalancerPolicyResponse" examples: ex1: summary: Creating a load balancer policy based on browser value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 LoadBalancer: + Tags: [] + SourceSecurityGroup: + SecurityGroupName: default + SecurityGroupAccountId: '123456789012' + Subnets: + - subnet-12345678 + NetId: vpc-12345678 + BackendVmIds: [] + ApplicationStickyCookiePolicies: [] + SecurityGroups: + - sg-12345678 + LoadBalancerType: internet-facing AccessLog: - IsEnabled: false PublicationInterval: 60 - ApplicationStickyCookiePolicies: [] - BackendVmIds: [] + IsEnabled: false DnsName: example-lbu-123456789.eu-west-2.lbu.outscale.com HealthCheck: + UnhealthyThreshold: 2 + Timeout: 5 CheckInterval: 30 + Protocol: TCP HealthyThreshold: 10 Port: 80 - Protocol: TCP - Timeout: 5 - UnhealthyThreshold: 2 + LoadBalancerStickyCookiePolicies: + - PolicyName: example-browser-policy + CookieExpirationPeriod: 1 + SubregionNames: + - eu-west-2a Listeners: - BackendPort: 80 BackendProtocol: HTTP LoadBalancerPort: 80 LoadBalancerProtocol: HTTP LoadBalancerName: example-lbu - LoadBalancerStickyCookiePolicies: - - CookieExpirationPeriod: 1 - PolicyName: example-browser-policy - LoadBalancerType: internet-facing - NetId: vpc-12345678 - SecurityGroups: - - sg-12345678 - SourceSecurityGroup: - SecurityGroupAccountId: '123456789012' - SecurityGroupName: default - Subnets: - - subnet-12345678 - SubregionNames: - - eu-west-2a - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Creating a load balancer policy based on application cookie value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 LoadBalancer: + Tags: [] + SourceSecurityGroup: + SecurityGroupName: default + SecurityGroupAccountId: '123456789012' + Subnets: + - subnet-12345678 + NetId: vpc-12345678 + BackendVmIds: [] + ApplicationStickyCookiePolicies: + - PolicyName: example-app-policy + CookieName: example-cookie + SecurityGroups: + - sg-12345678 + LoadBalancerType: internet-facing AccessLog: - IsEnabled: false PublicationInterval: 60 - ApplicationStickyCookiePolicies: - - CookieName: example-cookie - PolicyName: example-app-policy - BackendVmIds: [] + IsEnabled: false DnsName: example-lbu-123456789.eu-west-2.lbu.outscale.com HealthCheck: + UnhealthyThreshold: 2 + Timeout: 5 CheckInterval: 30 + Protocol: TCP HealthyThreshold: 10 Port: 80 - Protocol: TCP - Timeout: 5 - UnhealthyThreshold: 2 + LoadBalancerStickyCookiePolicies: [] + SubregionNames: + - eu-west-2a Listeners: - BackendPort: 80 BackendProtocol: HTTP LoadBalancerPort: 80 LoadBalancerProtocol: HTTP LoadBalancerName: example-lbu - LoadBalancerStickyCookiePolicies: [] - LoadBalancerType: internet-facing - NetId: vpc-12345678 - SecurityGroups: - - sg-12345678 - SourceSecurityGroup: - SecurityGroupAccountId: '123456789012' - SecurityGroupName: default - Subnets: - - subnet-12345678 - SubregionNames: - - eu-west-2a - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateLoadBalancerPolicyResponse" description: The HTTP 200 response (OK). tags: - LoadBalancerPolicy "/CreateLoadBalancerTags": - description: |- - Adds one or more tags to the specified load balancers.
- If a tag with the same key already exists for the load balancer, the tag value is replaced.

- For more information, see [About Tags](https://docs.outscale.com/en/userguide/About-Tags.html). post: + description: |- + Adds one or more tags to the specified load balancers.
+ If a tag with the same key already exists for the load balancer, the tag value is replaced.

+ For more information, see [About Tags](https://docs.outscale.com/en/userguide/About-Tags.html). operationId: CreateLoadBalancerTags requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateLoadBalancerTagsRequest" examples: ex1: value: @@ -14037,64 +14140,62 @@ paths: Tags: - Key: key1 Value: value1 - schema: - "$ref": "#/components/schemas/CreateLoadBalancerTagsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateLoadBalancerTagsResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateLoadBalancerTagsResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer "/CreateNatService": - description: |- - Creates a network address translation (NAT) service in the specified public Subnet of a Net.
- A NAT service enables virtual machines (VMs) placed in the private Subnet of this Net to connect to the Internet, without being accessible from the Internet.
- When creating a NAT service, you specify the allocation ID of the public IP you want to use as public IP for the NAT service. Once the NAT service is created, you need to create a route in the route table of the private Subnet, with 0.0.0.0/0 as destination and the ID of the NAT service as target. For more information, see [LinkPublicIP](#linkpublicip) and [CreateRoute](#createroute).
- This action also enables you to create multiple NAT services in the same Net (one per public Subnet).

- - **[IMPORTANT]**
- You cannot modify the public IP associated with a NAT service after its creation. To do so, you need to delete the NAT service and create a new one with another public IP.

- For more information, see [About NAT Services](https://docs.outscale.com/en/userguide/About-NAT-Services.html). post: + description: |- + Creates a network address translation (NAT) service in the specified public Subnet of a Net.
+ A NAT service enables virtual machines (VMs) placed in the private Subnet of this Net to connect to the Internet, without being accessible from the Internet.
+ When creating a NAT service, you specify the allocation ID of the public IP you want to use as public IP for the NAT service. Once the NAT service is created, you need to create a route in the route table of the private Subnet, with 0.0.0.0/0 as destination and the ID of the NAT service as target. For more information, see [LinkPublicIP](#linkpublicip) and [CreateRoute](#createroute).
+ This action also enables you to create multiple NAT services in the same Net (one per public Subnet).

+ + **[IMPORTANT]**
+ You cannot modify the public IP associated with a NAT service after its creation. To do so, you need to delete the NAT service and create a new one with another public IP.

+ For more information, see [About NAT Services](https://docs.outscale.com/en/userguide/About-NAT-Services.html). operationId: CreateNatService requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateNatServiceRequest" examples: ex1: value: - PublicIpId: eipalloc-12345678 SubnetId: subnet-12345678 - schema: - "$ref": "#/components/schemas/CreateNatServiceRequest" + PublicIpId: eipalloc-12345678 responses: '200': content: application/json: - examples: + schema: + "$ref": "#/components/schemas/CreateNatServiceResponse" + examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 NatService: + Tags: [] + SubnetId: subnet-12345678 NatServiceId: nat-12345678 - NetId: vpc-12345678 PublicIps: - - PublicIp: 192.0.2.0 - PublicIpId: eipalloc-12345678 + - PublicIpId: eipalloc-12345678 + PublicIp: 192.0.2.0 + NetId: vpc-12345678 State: available - SubnetId: subnet-12345678 - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateNatServiceResponse" description: The HTTP 200 response (OK). '400': content: @@ -14117,39 +14218,39 @@ paths: tags: - NatService "/CreateNet": - description: |- - Creates a Net with a specified IP range.
- The IP range (network range) of your Net must be between a /28 netmask (16 IPs) and a /16 netmask (65536 IPs).

- For more information, see [About Nets](https://docs.outscale.com/en/userguide/About-Nets.html). post: + description: |- + Creates a Net with a specified IP range.
+ The IP range (network range) of your Net must be between a /28 netmask (16 IPs) and a /16 netmask (65536 IPs).

+ For more information, see [About Nets](https://docs.outscale.com/en/userguide/About-Nets.html). operationId: CreateNet requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateNetRequest" examples: ex1: value: IpRange: 10.0.0.0/16 - schema: - "$ref": "#/components/schemas/CreateNetRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateNetResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Net: + Tags: [] DhcpOptionsSetId: dopt-12345678 IpRange: 10.0.0.0/16 + Tenancy: default NetId: vpc-12345678 State: available - Tags: [] - Tenancy: default - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateNetResponse" description: The HTTP 200 response (OK). '400': content: @@ -14178,17 +14279,19 @@ paths: tags: - Net "/CreateNetAccessPoint": - description: |- - Creates a Net access point to access an OUTSCALE service from this Net without using the Internet and public IPs.
- You specify the service using its name. For more information about the available services, see [ReadNetAccessPointServices](#readnetaccesspointservices).

- To control the routing of traffic between the Net and the specified service, you can specify one or more route tables. Virtual machines placed in Subnets associated with the specified route table thus use the Net access point to access the service. When you specify a route table, a route is automatically added to it with the destination set to the prefix list ID of the service, and the target set to the ID of the access point.

- When a Net access point is created, a public IP is automatically allocated to your account and used for the Net access point. This public IP is not connected to the Internet. It is counted in your quota, but it is not billed.

- For more information, see [About Net Access Points](https://docs.outscale.com/en/userguide/About-Net-Access-Points.html). post: + description: |- + Creates a Net access point to access an OUTSCALE service from this Net without using the Internet and public IPs.
+ You specify the service using its name. For more information about the available services, see [ReadNetAccessPointServices](#readnetaccesspointservices).

+ To control the routing of traffic between the Net and the specified service, you can specify one or more route tables. Virtual machines placed in Subnets associated with the specified route table thus use the Net access point to access the service. When you specify a route table, a route is automatically added to it with the destination set to the prefix list ID of the service, and the target set to the ID of the access point.

+ When a Net access point is created, a public IP is automatically allocated to your account and used for the Net access point. This public IP is not connected to the Internet. It is counted in your quota, but it is not billed.

+ For more information, see [About Net Access Points](https://docs.outscale.com/en/userguide/About-Net-Access-Points.html). operationId: CreateNetAccessPoint requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateNetAccessPointRequest" examples: ex1: value: @@ -14196,107 +14299,105 @@ paths: RouteTableIds: - rtb-12345678 ServiceName: com.outscale.eu-west-2.oos - schema: - "$ref": "#/components/schemas/CreateNetAccessPointRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateNetAccessPointResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 NetAccessPoint: + Tags: [] NetAccessPointId: vpce-12345678 - NetId: vpc-12345678 RouteTableIds: - rtb-12345678 - ServiceName: com.outscale.eu-west-2.oos State: pending - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateNetAccessPointResponse" + NetId: vpc-12345678 + ServiceName: com.outscale.eu-west-2.oos description: The HTTP 200 response (OK). tags: - NetAccessPoint "/CreateNetPeering": - description: |- - Requests a Net peering between a Net you own and a peer Net that belongs to you or another account.
- This action creates a Net peering that remains in the `pending-acceptance` state until it is accepted by the owner of the peer Net. If the owner of the peer Net does not accept the request within 7 days, the state of the Net peering becomes `expired`. For more information, see [AcceptNetPeering](#acceptnetpeering).

+ post: + description: |- + Requests a Net peering between a Net you own and a peer Net that belongs to you or another account.
+ This action creates a Net peering that remains in the `pending-acceptance` state until it is accepted by the owner of the peer Net. If the owner of the peer Net does not accept the request within 7 days, the state of the Net peering becomes `expired`. For more information, see [AcceptNetPeering](#acceptnetpeering).

- **[IMPORTANT]**
- * Peered Nets must contain at least one virtual machine (VM) each before the creation of the Net peering.
- * The two Nets must not have overlapping IP ranges. Otherwise, the Net peering is in the `failed` state.
- * A peering connection between two Nets works both ways. If an A-to-B connection is already created and accepted, creating a B-to-A connection is not necessary and would be automatically rejected. + **[IMPORTANT]**
+ * Peered Nets must contain at least one virtual machine (VM) each before the creation of the Net peering.
+ * The two Nets must not have overlapping IP ranges. Otherwise, the Net peering is in the `failed` state.
+ * A peering connection between two Nets works both ways. If an A-to-B connection is already created and accepted, creating a B-to-A connection is not necessary and would be automatically rejected. - For more information, see [About Net Peerings](https://docs.outscale.com/en/userguide/About-Net-Peerings.html). - post: + For more information, see [About Net Peerings](https://docs.outscale.com/en/userguide/About-Net-Peerings.html). operationId: CreateNetPeering requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateNetPeeringRequest" examples: ex1: summary: Creating a Net peering between two Nets belonging to you value: - AccepterNetId: vpc-87654321 SourceNetId: vpc-12345678 + AccepterNetId: vpc-87654321 ex2: summary: Creating a Net peering with a Net that belongs to another account value: + SourceNetId: vpc-12345678 AccepterNetId: vpc-87654321 AccepterOwnerId: '987654321098' - SourceNetId: vpc-12345678 - schema: - "$ref": "#/components/schemas/CreateNetPeeringRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateNetPeeringResponse" examples: ex1: summary: Creating a Net peering between two Nets belonging to you value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 NetPeering: + Tags: [] + State: + Name: pending-acceptance + Message: Pending acceptance by 123456789012 AccepterNet: - AccountId: '123456789012' - IpRange: 172.16.0.0/16 NetId: vpc-12345678 - NetPeeringId: pcx-12345678 - SourceNet: + IpRange: 172.16.0.0/16 AccountId: '123456789012' - IpRange: 10.0.0.0/16 + SourceNet: NetId: vpc-87654321 - State: - Message: Pending acceptance by 123456789012 - Name: pending-acceptance - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + IpRange: 10.0.0.0/16 + AccountId: '123456789012' + NetPeeringId: pcx-12345678 ex2: summary: Creating a Net peering with a Net that belongs to another account value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 NetPeering: + Tags: [] + State: + Name: pending-acceptance + Message: Pending acceptance by 123456789012 AccepterNet: - AccountId: '987654321098' - IpRange: 172.16.0.0/16 NetId: vpc-87654321 - NetPeeringId: pcx-12345678 + IpRange: 172.16.0.0/16 + AccountId: '987654321098' SourceNet: - AccountId: '123456789012' - IpRange: 10.0.0.0/16 NetId: vpc-12345678 - State: - Message: Pending acceptance by 123456789012 - Name: pending-acceptance - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateNetPeeringResponse" + IpRange: 10.0.0.0/16 + AccountId: '123456789012' + NetPeeringId: pcx-12345678 description: The HTTP 200 response (OK). '400': content: @@ -14319,93 +14420,93 @@ paths: tags: - NetPeering "/CreateNic": - description: |- - Creates a network interface card (NIC) in the specified Subnet.

- For more information, see [About NICs](https://docs.outscale.com/en/userguide/About-NICs.html). post: + description: |- + Creates a network interface card (NIC) in the specified Subnet.

+ For more information, see [About NICs](https://docs.outscale.com/en/userguide/About-NICs.html). operationId: CreateNic requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateNicRequest" examples: ex1: summary: Creating a NIC value: + SubnetId: subnet-12345678 SecurityGroupIds: - sg-12345678 - SubnetId: subnet-12345678 ex2: summary: Creating a NIC with specific private IPs value: Description: Terraform nic with private IPs + SubnetId: subnet-12345678 + SecurityGroupIds: + - sg-12345678 PrivateIps: - IsPrimary: true PrivateIp: 10.0.0.4 - IsPrimary: false PrivateIp: 10.0.0.5 - SecurityGroupIds: - - sg-12345678 - SubnetId: subnet-12345678 - schema: - "$ref": "#/components/schemas/CreateNicRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateNicResponse" examples: ex1: summary: Creating a NIC value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Nic: - AccountId: '123456789012' - Description: '' + SubregionName: eu-west-2a + SubnetId: subnet-12345678 + State: available IsSourceDestChecked: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + Tags: [] + Description: '' + AccountId: '123456789012' + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - IsPrimary: true - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - SecurityGroups: - - SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - State: available - SubnetId: subnet-12345678 - SubregionName: eu-west-2a - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + IsPrimary: true ex2: summary: Creating a NIC with specific private IPs value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Nic: - AccountId: '123456789012' - Description: '' + SubregionName: eu-west-2a + SubnetId: subnet-12345678 + State: available IsSourceDestChecked: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + Tags: [] + Description: '' + AccountId: '123456789012' + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - IsPrimary: true - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - - IsPrimary: false - PrivateDnsName: ip-10-0-0-5.eu-west-2.compute.internal + IsPrimary: true + - PrivateDnsName: ip-10-0-0-5.eu-west-2.compute.internal PrivateIp: 10.0.0.5 - SecurityGroups: - - SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - State: available - SubnetId: subnet-12345678 - SubregionName: eu-west-2a - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateNicResponse" + IsPrimary: false description: The HTTP 200 response (OK). '400': content: @@ -14428,14 +14529,16 @@ paths: tags: - Nic "/CreatePolicy": - description: |- - Creates a managed policy to apply to a user.
- This action creates a policy version and sets v1 as the default one. post: + description: |- + Creates a managed policy to apply to a user.
+ This action creates a policy version and sets v1 as the default one. operationId: CreatePolicy requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreatePolicyRequest" examples: ex1: value: @@ -14444,42 +14547,42 @@ paths: "Resource": ["*"]} ]}' Path: "/example/" PolicyName: example-user-policy - schema: - "$ref": "#/components/schemas/CreatePolicyRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreatePolicyResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Policy: + ResourcesCount: 0 + PolicyName: example-user-policy + PolicyDefaultVersionId: v1 + Path: "/example/" CreationDate: 2010-10-01 12:34:56.789000000 +00:00 Description: Example of description + PolicyId: ABCDEFGHIJKLMNOPQRSTUVWXYZ01234 + Orn: orn:ows:idauth::012345678910:policy/example/example-user-policy IsLinkable: true LastModificationDate: 2010-10-01 12:34:56.789000000 +00:00 - Orn: orn:ows:idauth::012345678910:policy/example/example-user-policy - Path: "/example/" - PolicyDefaultVersionId: v1 - PolicyId: ABCDEFGHIJKLMNOPQRSTUVWXYZ01234 - PolicyName: example-user-policy - ResourcesCount: 0 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreatePolicyResponse" description: The HTTP 200 response (OK). tags: - Policy "/CreatePolicyVersion": - description: |- - Creates a version of a specified managed policy.
- A managed policy can have up to five versions. post: + description: |- + Creates a version of a specified managed policy.
+ A managed policy can have up to five versions. operationId: CreatePolicyVersion requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreatePolicyVersionRequest" examples: ex1: value: @@ -14487,91 +14590,89 @@ paths: "Resource": ["*"]} ]}' PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy SetAsDefault: true - schema: - "$ref": "#/components/schemas/CreatePolicyVersionRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreatePolicyVersionResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 PolicyVersion: + VersionId: v2 + DefaultVersion: true + CreationDate: 2017-05-10 12:34:56.789000000 +00:00 Body: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], "Resource": ["*"]} ]}' - CreationDate: 2017-05-10 12:34:56.789000000 +00:00 - DefaultVersion: true - VersionId: v2 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreatePolicyVersionResponse" description: The HTTP 200 response (OK). tags: - Policy "/CreateProductType": - description: Creates a product type you can associate with an OMI for consumption - monitoring and billing purposes. post: + description: Creates a product type you can associate with an OMI for consumption + monitoring and billing purposes. operationId: CreateProductType requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateProductTypeRequest" examples: ex1: value: - Description: Example of description Vendor: vendor-name - schema: - "$ref": "#/components/schemas/CreateProductTypeRequest" + Description: Example of description responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateProductTypeResponse" examples: ex1: value: - ProductType: - Description: Example of description - ProductTypeId: pty-12345678 - Vendor: vendor-name ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateProductTypeResponse" + ProductType: + Vendor: vendor-name + ProductTypeId: pty-12345678 + Description: Example of description description: The HTTP 200 response (OK). tags: - ProductType "/CreatePublicIp": - description: |- - Acquires a public IP for your account.
- A public IP is a static IP designed for dynamic Cloud computing. It can be associated with a virtual machine (VM) in the public Cloud or in a Net, a network interface card (NIC), a NAT service.

- For more information, see [About Public IPs](https://docs.outscale.com/en/userguide/About-Public-IPs.html). post: + description: |- + Acquires a public IP for your account.
+ A public IP is a static IP designed for dynamic Cloud computing. It can be associated with a virtual machine (VM) in the public Cloud or in a Net, a network interface card (NIC), a NAT service.

+ For more information, see [About Public IPs](https://docs.outscale.com/en/userguide/About-Public-IPs.html). operationId: CreatePublicIp requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreatePublicIpRequest" examples: ex1: value: {} - schema: - "$ref": "#/components/schemas/CreatePublicIpRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreatePublicIpResponse" examples: ex1: value: - PublicIp: - PublicIp: 192.0.2.0 - PublicIpId: eipalloc-12345678 - Tags: [] ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreatePublicIpResponse" + PublicIp: + Tags: [] + PublicIpId: eipalloc-12345678 + PublicIp: 192.0.2.0 description: The HTTP 200 response (OK). '400': content: @@ -14594,59 +14695,59 @@ paths: tags: - PublicIp "/CreateRoute": - description: |- - Creates a route in a specified route table within a specified Net.
- You must specify one of the following elements as the target:

+ post: + description: |- + Creates a route in a specified route table within a specified Net.
+ You must specify one of the following elements as the target:

- * Net peering
- * NAT VM
- * Internet service
- * Virtual gateway
- * NAT service
- * Network interface card (NIC)

+ * Net peering
+ * NAT VM
+ * Internet service
+ * Virtual gateway
+ * NAT service
+ * Network interface card (NIC)

- The routing algorithm is based on the most specific match.

- For more information, see [About Route Tables](https://docs.outscale.com/en/userguide/About-Route-Tables.html). - post: + The routing algorithm is based on the most specific match.

+ For more information, see [About Route Tables](https://docs.outscale.com/en/userguide/About-Route-Tables.html). operationId: CreateRoute requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateRouteRequest" examples: ex1: summary: Creating a route to an Internet service value: + RouteTableId: rtb-12345678 DestinationIpRange: 0.0.0.0/0 GatewayId: igw-12345678 - RouteTableId: rtb-12345678 - schema: - "$ref": "#/components/schemas/CreateRouteRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateRouteResponse" examples: ex1: summary: Creating a route to an Internet service value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 RouteTable: - LinkRouteTables: [] - NetId: vpc-12345678 - RoutePropagatingVirtualGateways: [] - RouteTableId: rtb-12345678 Routes: - - CreationMethod: CreateRouteTable - DestinationIpRange: 10.0.0.0/16 + - DestinationIpRange: 10.0.0.0/16 + CreationMethod: CreateRouteTable State: active - - CreationMethod: CreateRoute + - GatewayId: igw-12345678 DestinationIpRange: 0.0.0.0/0 - GatewayId: igw-12345678 + CreationMethod: CreateRoute State: active + LinkRouteTables: [] + NetId: vpc-12345678 Tags: [] - schema: - "$ref": "#/components/schemas/CreateRouteResponse" + RoutePropagatingVirtualGateways: [] + RouteTableId: rtb-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -14669,42 +14770,42 @@ paths: tags: - Route "/CreateRouteTable": - description: |- - Creates a route table for a specified Net.
- You can then add routes and associate this route table with a Subnet.

- For more information, see [About Route Tables](https://docs.outscale.com/en/userguide/About-Route-Tables.html). post: + description: |- + Creates a route table for a specified Net.
+ You can then add routes and associate this route table with a Subnet.

+ For more information, see [About Route Tables](https://docs.outscale.com/en/userguide/About-Route-Tables.html). operationId: CreateRouteTable requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateRouteTableRequest" examples: ex1: value: NetId: vpc-12345678 - schema: - "$ref": "#/components/schemas/CreateRouteTableRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateRouteTableResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 RouteTable: + Routes: + - DestinationIpRange: 10.0.0.0/16 + CreationMethod: CreateRouteTable + State: active LinkRouteTables: [] NetId: vpc-12345678 + Tags: [] RoutePropagatingVirtualGateways: [] RouteTableId: rtb-12345678 - Routes: - - CreationMethod: CreateRouteTable - DestinationIpRange: 10.0.0.0/16 - State: active - Tags: [] - schema: - "$ref": "#/components/schemas/CreateRouteTableResponse" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -14727,52 +14828,52 @@ paths: tags: - RouteTable "/CreateSecurityGroup": - description: |- - Creates a security group.
- This action creates a security group either in the public Cloud or in a specified Net. By default, a default security group for use in the public Cloud and a default security group for use in a Net are created.
- When launching a virtual machine (VM), if no security group is explicitly specified, the appropriate default security group is assigned to the VM. Default security groups include a default rule granting VMs network access to each other.
- When creating a security group, you specify a name. Two security groups for use in the public Cloud or for use in a Net cannot have the same name.
- You can have up to 500 security groups in the public Cloud. You can create up to 500 security groups per Net.
- To add or remove rules, use the [CreateSecurityGroupRule](#createsecuritygrouprule) method.

- For more information, see [About Security Groups](https://docs.outscale.com/en/userguide/About-Security-Groups.html). post: + description: |- + Creates a security group.
+ This action creates a security group either in the public Cloud or in a specified Net. By default, a default security group for use in the public Cloud and a default security group for use in a Net are created.
+ When launching a virtual machine (VM), if no security group is explicitly specified, the appropriate default security group is assigned to the VM. Default security groups include a default rule granting VMs network access to each other.
+ When creating a security group, you specify a name. Two security groups for use in the public Cloud or for use in a Net cannot have the same name.
+ You can have up to 500 security groups in the public Cloud. You can create up to 500 security groups per Net.
+ To add or remove rules, use the [CreateSecurityGroupRule](#createsecuritygrouprule) method.

+ For more information, see [About Security Groups](https://docs.outscale.com/en/userguide/About-Security-Groups.html). operationId: CreateSecurityGroup requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateSecurityGroupRequest" examples: ex1: value: - Description: Security group example NetId: vpc-12345678 SecurityGroupName: security-group-example - schema: - "$ref": "#/components/schemas/CreateSecurityGroupRequest" + Description: Security group example responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateSecurityGroupResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 SecurityGroup: - AccountId: '123456789012' - Description: Example of security group - InboundRules: [] - NetId: vpc-12345678 + Tags: [] + SecurityGroupName: security-group-example OutboundRules: - FromPortRange: -1 IpProtocol: "-1" + ToPortRange: -1 IpRanges: - 0.0.0.0/0 - ToPortRange: -1 SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - Tags: [] - schema: - "$ref": "#/components/schemas/CreateSecurityGroupResponse" + AccountId: '123456789012' + Description: Example of security group + InboundRules: [] + NetId: vpc-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -14795,109 +14896,109 @@ paths: tags: - SecurityGroup "/CreateSecurityGroupRule": - description: |- - Adds one or more rules to a security group.
- Use the `SecurityGroupId` parameter to specify the security group for which you want to create a rule.
- Use the `Flow` parameter to specify if you want an inbound rule or an outbound rule.

- An inbound rule allows the security group to receive traffic: - * Either from a specific IP range (`IpRange` parameter) on a specific port range (`FromPortRange` and `ToPortRange` parameters) and specific protocol (`IpProtocol` parameter). - * Or from another specific security group (`SecurityGroupAccountIdToLink` and `SecurityGroupNameToLink` parameters).
+ post: + description: |- + Adds one or more rules to a security group.
+ Use the `SecurityGroupId` parameter to specify the security group for which you want to create a rule.
+ Use the `Flow` parameter to specify if you want an inbound rule or an outbound rule.

+ An inbound rule allows the security group to receive traffic: + * Either from a specific IP range (`IpRange` parameter) on a specific port range (`FromPortRange` and `ToPortRange` parameters) and specific protocol (`IpProtocol` parameter). + * Or from another specific security group (`SecurityGroupAccountIdToLink` and `SecurityGroupNameToLink` parameters).
- (Net only) An outbound rule works similarly but allows the security group to send traffic rather than receive traffic.
+ (Net only) An outbound rule works similarly but allows the security group to send traffic rather than receive traffic.
- Alternatively, you can use the `Rules` parameter to add several rules at the same time. + Alternatively, you can use the `Rules` parameter to add several rules at the same time. - **[NOTE]**
- * The modifications are effective as quickly as possible, but a small delay may occur.
- * By default, traffic between two security groups is allowed through both public and private IPs. To restrict traffic to private IPs only, contact our Support team at support@outscale.com. + **[NOTE]**
+ * The modifications are effective as quickly as possible, but a small delay may occur.
+ * By default, traffic between two security groups is allowed through both public and private IPs. To restrict traffic to private IPs only, contact our Support team at support@outscale.com. - For more information, see [About Security Group Rules](https://docs.outscale.com/en/userguide/About-Security-Group-Rules.html). - post: + For more information, see [About Security Group Rules](https://docs.outscale.com/en/userguide/About-Security-Group-Rules.html). operationId: CreateSecurityGroupRule requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateSecurityGroupRuleRequest" examples: ex1: summary: Creating an inbound rule from an IP range value: Flow: Inbound + SecurityGroupId: sg-12345678 FromPortRange: 80 + ToPortRange: 80 IpProtocol: tcp IpRange: 10.0.0.0/16 - SecurityGroupId: sg-12345678 - ToPortRange: 80 ex2: summary: Creating an inbound rule from another security group value: Flow: Inbound + SecurityGroupId: sg-12345678 Rules: - FromPortRange: 22 + ToPortRange: 22 IpProtocol: tcp SecurityGroupsMembers: - AccountId: '123456789012' SecurityGroupName: another-security-group - ToPortRange: 22 - SecurityGroupId: sg-12345678 - schema: - "$ref": "#/components/schemas/CreateSecurityGroupRuleRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateSecurityGroupRuleResponse" examples: ex1: summary: Creating an inbound rule from an IP range value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 SecurityGroup: + Tags: [] + SecurityGroupName: security-group-example + OutboundRules: + - FromPortRange: -1 + IpProtocol: "-1" + ToPortRange: -1 + IpRanges: + - 0.0.0.0/0 + SecurityGroupId: sg-12345678 AccountId: '123456789012' Description: Example of security group InboundRules: - FromPortRange: 80 IpProtocol: tcp + ToPortRange: 80 IpRanges: - 10.0.0.0/16 - ToPortRange: 80 NetId: vpc-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + summary: Creating an inbound rule from another security group + value: + SecurityGroup: + Tags: [] + SecurityGroupName: security-group-example OutboundRules: - FromPortRange: -1 IpProtocol: "-1" + ToPortRange: -1 IpRanges: - 0.0.0.0/0 - ToPortRange: -1 SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - Tags: [] - ex2: - summary: Creating an inbound rule from another security group - value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - SecurityGroup: AccountId: '123456789012' Description: Example of security group InboundRules: - FromPortRange: 22 IpProtocol: tcp + ToPortRange: 22 SecurityGroupsMembers: - - AccountId: '987654321098' + - SecurityGroupName: another-security-group SecurityGroupId: sg-87654321 - SecurityGroupName: another-security-group - ToPortRange: 22 + AccountId: '987654321098' NetId: vpc-12345678 - OutboundRules: - - FromPortRange: -1 - IpProtocol: "-1" - IpRanges: - - 0.0.0.0/0 - ToPortRange: -1 - SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - Tags: [] - schema: - "$ref": "#/components/schemas/CreateSecurityGroupRuleResponse" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -14920,146 +15021,146 @@ paths: tags: - SecurityGroupRule "/CreateServerCertificate": - description: |- - Creates a server certificate and its matching private key.

- These elements can be used with other services (for example, to configure SSL termination on load balancers).

- You can also specify the chain of intermediate certification authorities if your certificate is not directly signed by a root one. You can specify multiple intermediate certification authorities in the `CertificateChain` parameter. To do so, concatenate all certificates in the correct order (the first certificate must be the authority of your certificate, the second must be the authority of the first one, and so on).

- The private key must be a RSA key in PKCS1 form. To check this, open the PEM file and ensure its header reads as follows: BEGIN RSA PRIVATE KEY.

- [IMPORTANT]

- This private key must not be protected by a password or a passphrase.

- For more information, see [About Server Certificates in EIM](https://docs.outscale.com/en/userguide/About-Server-Certificates-in-EIM.html). post: + description: |- + Creates a server certificate and its matching private key.

+ These elements can be used with other services (for example, to configure SSL termination on load balancers).

+ You can also specify the chain of intermediate certification authorities if your certificate is not directly signed by a root one. You can specify multiple intermediate certification authorities in the `CertificateChain` parameter. To do so, concatenate all certificates in the correct order (the first certificate must be the authority of your certificate, the second must be the authority of the first one, and so on).

+ The private key must be a RSA key in PKCS1 form. To check this, open the PEM file and ensure its header reads as follows: BEGIN RSA PRIVATE KEY.

+ [IMPORTANT]

+ This private key must not be protected by a password or a passphrase.

+ For more information, see [About Server Certificates in EIM](https://docs.outscale.com/en/userguide/About-Server-Certificates-in-EIM.html). operationId: CreateServerCertificate requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateServerCertificateRequest" examples: ex1: value: + Name: server-cert-example Body: "..." Chain: "..." - Name: server-cert-example - Path: "/example/" PrivateKey: "..." - schema: - "$ref": "#/components/schemas/CreateServerCertificateRequest" + Path: "/example/" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateServerCertificateResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ServerCertificate: + Path: "/example/" Id: ABCDEFGHIJKLMNOPQRSTUVWXYZ1234 - Name: server-cert-example Orn: orn:ows:idauth::012345678910:server-certificate/example/server-cert-example - Path: "/example/" - schema: - "$ref": "#/components/schemas/CreateServerCertificateResponse" + Name: server-cert-example + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - ServerCertificate "/CreateSnapshot": - description: |- - Creates a snapshot. Snapshots are point-in-time images of a volume that you can use to back up your data or to create replicas of this volume.
- You can use this method in three different ways: - * **Creating from a volume**: You create a snapshot from one of your volumes.
- * **Copying a snapshot**: You copy an existing snapshot. The source snapshot can be one of your own snapshots, or a snapshot owned by another account that has granted you permission via the [UpdateSnapshot](#updatesnapshot) method.
- * **Importing from a bucket**: You import a snapshot located in an OUTSCALE Object Storage (OOS) bucket. First, the owner of the source snapshot must export it to a bucket by using the [CreateSnapshotExportTask](#createsnapshotexporttask) method. Then, they must grant you permission to read the snapshot via a pre-signed URL. For more information, see [Creating a Pre-Signed URL](https://docs.outscale.com/en/userguide/Creating-a-Pre-Signed-URL.html). + post: + description: |- + Creates a snapshot. Snapshots are point-in-time images of a volume that you can use to back up your data or to create replicas of this volume.
+ You can use this method in three different ways: + * **Creating from a volume**: You create a snapshot from one of your volumes.
+ * **Copying a snapshot**: You copy an existing snapshot. The source snapshot can be one of your own snapshots, or a snapshot owned by another account that has granted you permission via the [UpdateSnapshot](#updatesnapshot) method.
+ * **Importing from a bucket**: You import a snapshot located in an OUTSCALE Object Storage (OOS) bucket. First, the owner of the source snapshot must export it to a bucket by using the [CreateSnapshotExportTask](#createsnapshotexporttask) method. Then, they must grant you permission to read the snapshot via a pre-signed URL. For more information, see [Creating a Pre-Signed URL](https://docs.outscale.com/en/userguide/Creating-a-Pre-Signed-URL.html). - **[NOTE]**
- In case of excessive use of the snapshot creation feature on the same volume over a short period of time, 3DS OUTSCALE reserves the right to temporarily block the feature. + **[NOTE]**
+ In case of excessive use of the snapshot creation feature on the same volume over a short period of time, 3DS OUTSCALE reserves the right to temporarily block the feature. - For more information, see [About Snapshots](https://docs.outscale.com/en/userguide/About-Snapshots.html). - post: + For more information, see [About Snapshots](https://docs.outscale.com/en/userguide/About-Snapshots.html). operationId: CreateSnapshot requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateSnapshotRequest" examples: ex1: summary: Creating from a volume value: - Description: Snapshot created from a volume VolumeId: vol-12345678 + Description: Snapshot created from a volume ex2: summary: Copying a snapshot value: - Description: Snapshot created from another snapshot - SourceRegionName: eu-west-2 SourceSnapshotId: snap-12345678 + SourceRegionName: eu-west-2 + Description: Snapshot created from another snapshot ex3: summary: Importing from a bucket value: - Description: Snapshot imported from a bucket FileLocation: https://oos.eu-west-2.outscale.com/BUCKET/KEY?AWSAccessKeyId=ABCDEFGHIJ0123456789&Expires=1493372309&Signature=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX SnapshotSize: 10737418240 - schema: - "$ref": "#/components/schemas/CreateSnapshotRequest" + Description: Snapshot imported from a bucket responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateSnapshotResponse" examples: ex1: summary: Creating from a volume value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Snapshot: + VolumeSize: 10 AccountId: '123456789012' + VolumeId: vol-12345678 CreationDate: '2010-10-01T12:34:56.789Z' - Description: Snapshot created from a volume PermissionsToCreateVolume: - AccountIds: [] GlobalPermission: false + AccountIds: [] Progress: 0 SnapshotId: snap-12345678 State: pending/queued + Description: Snapshot created from a volume Tags: [] - VolumeId: vol-12345678 - VolumeSize: 10 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Copying a snapshot value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Snapshot: + VolumeSize: 10 AccountId: '123456789012' + VolumeId: vol-12345678 CreationDate: '2010-10-01T12:34:56.789Z' - Description: Snapshot copied from another snapshot PermissionsToCreateVolume: - AccountIds: [] GlobalPermission: false + AccountIds: [] Progress: 100 SnapshotId: snap-12345678 State: completed + Description: Snapshot copied from another snapshot Tags: [] - VolumeId: vol-12345678 - VolumeSize: 10 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex3: summary: Importing from a bucket value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Snapshot: + VolumeSize: 10 AccountId: '123456789012' + VolumeId: vol-12345678 CreationDate: '2010-10-01T12:34:56.789Z' - Description: Snapshot imported from a bucket PermissionsToCreateVolume: - AccountIds: [] GlobalPermission: false + AccountIds: [] Progress: 0 SnapshotId: snap-12345678 State: importing + Description: Snapshot imported from a bucket Tags: [] - VolumeId: vol-12345678 - VolumeSize: 10 - schema: - "$ref": "#/components/schemas/CreateSnapshotResponse" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -15082,87 +15183,87 @@ paths: tags: - Snapshot "/CreateSnapshotExportTask": - description: |- - Exports a snapshot to an OUTSCALE Object Storage (OOS) bucket that belongs to you. This action enables you to create a backup of your snapshot.

- You can share this snapshot with others accounts by granting permission to read it via pre-signed URLs. For more information, see [Creating a Pre-Signed URL](https://docs.outscale.com/en/userguide/Creating-a-Pre-Signed-URL.html).

- For more information, see [About Snapshots](https://docs.outscale.com/en/userguide/About-Snapshots.html). post: + description: |- + Exports a snapshot to an OUTSCALE Object Storage (OOS) bucket that belongs to you. This action enables you to create a backup of your snapshot.

+ You can share this snapshot with others accounts by granting permission to read it via pre-signed URLs. For more information, see [Creating a Pre-Signed URL](https://docs.outscale.com/en/userguide/Creating-a-Pre-Signed-URL.html).

+ For more information, see [About Snapshots](https://docs.outscale.com/en/userguide/About-Snapshots.html). operationId: CreateSnapshotExportTask requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateSnapshotExportTaskRequest" examples: ex1: value: + SnapshotId: snap-12345678 OsuExport: DiskImageFormat: qcow2 OsuBucket: BUCKET OsuPrefix: PREFIX - SnapshotId: snap-12345678 - schema: - "$ref": "#/components/schemas/CreateSnapshotExportTaskRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateSnapshotExportTaskResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 SnapshotExportTask: + Tags: [] + TaskId: snap-export-12345678 Comment: Export of snapshot snap-12345678 OsuExport: - DiskImageFormat: qcow2 - OsuBucket: BUCKET OsuPrefix: PREFIX - Progress: 0 - SnapshotId: snap-12345678 + OsuBucket: BUCKET + DiskImageFormat: qcow2 State: pending - Tags: [] - TaskId: snap-export-12345678 - schema: - "$ref": "#/components/schemas/CreateSnapshotExportTaskResponse" + SnapshotId: snap-12345678 + Progress: 0 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - Snapshot "/CreateSubnet": - description: |- - Creates a Subnet in an existing Net.
- To create a Subnet in a Net, you have to provide the ID of the Net and the IP range for the Subnet (its network range). Once the Subnet is created, you cannot modify its IP range.

- For more information, see [About Nets](https://docs.outscale.com/en/userguide/About-Nets.html). post: + description: |- + Creates a Subnet in an existing Net.
+ To create a Subnet in a Net, you have to provide the ID of the Net and the IP range for the Subnet (its network range). Once the Subnet is created, you cannot modify its IP range.

+ For more information, see [About Nets](https://docs.outscale.com/en/userguide/About-Nets.html). operationId: CreateSubnet requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateSubnetRequest" examples: ex1: value: - IpRange: 10.0.0.0/18 NetId: vpc-12345678 - schema: - "$ref": "#/components/schemas/CreateSubnetRequest" + IpRange: 10.0.0.0/18 responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateSubnetResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Subnet: + Tags: [] + SubregionName: eu-west-2a + SubnetId: subnet-12345678 AvailableIpsCount: 16379 IpRange: 10.0.0.0/18 MapPublicIpOnLaunch: false - NetId: vpc-12345678 State: available - SubnetId: subnet-12345678 - SubregionName: eu-west-2a - Tags: [] - schema: - "$ref": "#/components/schemas/CreateSubnetResponse" + NetId: vpc-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -15191,40 +15292,42 @@ paths: tags: - Subnet "/CreateTags": - description: |- - Adds one or more tags to the specified resources.
- If a tag with the same key already exists for the resource, the tag value is replaced.
- You can tag the following resources using their IDs:

+ post: + description: |- + Adds one or more tags to the specified resources.
+ If a tag with the same key already exists for the resource, the tag value is replaced.
+ You can tag the following resources using their IDs:

- * Client gateways (cgw-xxxxxxxx)
- * DHCP options (dopt-xxxxxxxx)
- * Images (ami-xxxxxxxx)
- * Internet services (igw-xxxxxxxx)
- * Keypairs (key-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx)
- * NAT services (nat-xxxxxxxx)
- * Net endpoints (vpce-xxxxxxxx)
- * Net peerings (vpcx-xxxxxxxx)
- * Nets (vpc-xxxxxxxx)
- * Network interface cards (NIC) (eni-xxxxxxxx)
- * OMI export tasks (image-export-xxxxxxxx)
- * OMIs (ami-xxxxxxxx)
- * Public IPs (eipalloc-xxxxxxxx)
- * Route tables (rtb-xxxxxxxx)
- * Security groups (sg-xxxxxxxx)
- * Snapshot export tasks (snap-export-xxxxxxxx) - * Snapshots (snap-xxxxxxxx)
- * Subnets (subnet-xxxxxxxx)
- * Virtual gateways (vgw-xxxxxxxx)
- * Virtual machines (VMs) (i-xxxxxxxx)
- * Volumes (vol-xxxxxxxx)
- * VPN connections (vpn-xxxxxxxx)
+ * Client gateways (cgw-xxxxxxxx)
+ * DHCP options (dopt-xxxxxxxx)
+ * Images (ami-xxxxxxxx)
+ * Internet services (igw-xxxxxxxx)
+ * Keypairs (key-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx)
+ * NAT services (nat-xxxxxxxx)
+ * Net endpoints (vpce-xxxxxxxx)
+ * Net peerings (vpcx-xxxxxxxx)
+ * Nets (vpc-xxxxxxxx)
+ * Network interface cards (NIC) (eni-xxxxxxxx)
+ * OMI export tasks (image-export-xxxxxxxx)
+ * OMIs (ami-xxxxxxxx)
+ * Public IPs (eipalloc-xxxxxxxx)
+ * Route tables (rtb-xxxxxxxx)
+ * Security groups (sg-xxxxxxxx)
+ * Snapshot export tasks (snap-export-xxxxxxxx) + * Snapshots (snap-xxxxxxxx)
+ * Subnets (subnet-xxxxxxxx)
+ * Virtual gateways (vgw-xxxxxxxx)
+ * Virtual machines (VMs) (i-xxxxxxxx)
+ * Volumes (vol-xxxxxxxx)
+ * VPN connections (vpn-xxxxxxxx)
- For more information, see [About Tags](https://docs.outscale.com/en/userguide/About-Tags.html). - post: + For more information, see [About Tags](https://docs.outscale.com/en/userguide/About-Tags.html). operationId: CreateTags requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateTagsRequest" examples: ex1: value: @@ -15233,19 +15336,17 @@ paths: Tags: - Key: key1 Value: value1 - schema: - "$ref": "#/components/schemas/CreateTagsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateTagsResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateTagsResponse" description: The HTTP 200 response (OK). '400': content: @@ -15268,63 +15369,65 @@ paths: tags: - Tag "/CreateUser": - description: |- - Creates an EIM user for your account.

- For more information, see [About EIM Users](https://docs.outscale.com/en/userguide/About-EIM-Users.html). post: + description: |- + Creates an EIM user for your account.

+ For more information, see [About EIM Users](https://docs.outscale.com/en/userguide/About-EIM-Users.html). operationId: CreateUser requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateUserRequest" examples: ex1: value: - Path: "/documentation/" UserEmail: user@example.com UserName: example-user - schema: - "$ref": "#/components/schemas/CreateUserRequest" + Path: "/documentation/" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateUserResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 User: CreationDate: 2010-10-01 12:34:56.789000000 +00:00 LastModificationDate: 2017-05-10 12:34:56.789000000 +00:00 - Path: "/documentation/" UserEmail: user@example.com - UserId: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 UserName: example-user - schema: - "$ref": "#/components/schemas/CreateUserResponse" + UserId: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 + Path: "/documentation/" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - User "/CreateUserGroup": - description: |- - Creates a group to which you can add users.
- You can also add an inline policy or link a managed policy to the group, which is applied to all its users. post: + description: |- + Creates a group to which you can add users.
+ You can also add an inline policy or link a managed policy to the group, which is applied to all its users. operationId: CreateUserGroup requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateUserGroupRequest" examples: ex1: value: Path: "/example/" UserGroupName: example-usergroup - schema: - "$ref": "#/components/schemas/CreateUserGroupRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateUserGroupResponse" examples: ex1: value: @@ -15337,59 +15440,59 @@ paths: Orn: orn:ows:idauth::012345678910:usergroup/example/usergroup-example Path: "/example/" UserGroupId: ug-12345678 - schema: - "$ref": "#/components/schemas/CreateUserGroupResponse" description: The HTTP 200 response (OK). tags: - UserGroup "/CreateVirtualGateway": - description: |- - Creates a virtual gateway.
- A virtual gateway is the access point on the Net side of a VPN connection.

- For more information, see [About Virtual Gateways](https://docs.outscale.com/en/userguide/About-Virtual-Gateways.html). post: + description: |- + Creates a virtual gateway.
+ A virtual gateway is the access point on the Net side of a VPN connection.

+ For more information, see [About Virtual Gateways](https://docs.outscale.com/en/userguide/About-Virtual-Gateways.html). operationId: CreateVirtualGateway requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateVirtualGatewayRequest" examples: ex1: value: ConnectionType: ipsec.1 - schema: - "$ref": "#/components/schemas/CreateVirtualGatewayRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateVirtualGatewayResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VirtualGateway: + VirtualGatewayId: vgw-12345678 ConnectionType: ipsec.1 NetToVirtualGatewayLinks: [] State: available Tags: [] - VirtualGatewayId: vgw-12345678 - schema: - "$ref": "#/components/schemas/CreateVirtualGatewayResponse" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - VirtualGateway "/CreateVmGroup": - description: |- - > [WARNING]
- > This feature is currently under development and may not function properly.
- - Creates a group of virtual machines (VMs) containing the same characteristics as a specified VM template, and then launches them.
- You can create up to 100 VM groups in your account. post: + description: |- + > [WARNING]
+ > This feature is currently under development and may not function properly.
+ + Creates a group of virtual machines (VMs) containing the same characteristics as a specified VM template, and then launches them.
+ You can create up to 100 VM groups in your account. operationId: CreateVmGroup requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateVmGroupRequest" examples: ex1: value: @@ -15404,17 +15507,15 @@ paths: VmCount: 2 VmGroupName: ClusterLog-PPD01 VmTemplateId: vmtemplate-98765432109876543210987654321012 - schema: - "$ref": "#/components/schemas/CreateVmGroupRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateVmGroupResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VmGroup: CreationDate: '2010-10-01T12:34:56.789Z' Description: Production log collector @@ -15431,8 +15532,8 @@ paths: VmGroupName: ClusterLog-PPD01 VmIds: [] VmTemplateId: vmtemplate-98765432109876543210987654321012 - schema: - "$ref": "#/components/schemas/CreateVmGroupResponse" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -15455,17 +15556,19 @@ paths: tags: - VmGroup "/CreateVmTemplate": - description: |- - > [WARNING]
- > This feature is currently under development and may not function properly.
- - Creates a virtual machine (VM) template. You can then use the VM template to create VM groups.
- You can create up to 50 VM templates in your account. post: + description: |- + > [WARNING]
+ > This feature is currently under development and may not function properly.
+ + Creates a virtual machine (VM) template. You can then use the VM template to create VM groups.
+ You can create up to 50 VM templates in your account. operationId: CreateVmTemplate requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateVmTemplateRequest" examples: ex1: value: @@ -15480,49 +15583,49 @@ paths: - Key: key1 Value: value1 VmTemplateName: vmtemplate-example - schema: - "$ref": "#/components/schemas/CreateVmTemplateRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateVmTemplateResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VmTemplate: - CpuCores: 2 - CpuGeneration: v4 + VmTemplateName: vmtemplate-example CpuPerformance: high CreationDate: 2010-10-01 12:34:56.789000000 +00:00 - Description: Log collector template - ImageId: ami-12345678 - Ram: 2 + CpuCores: 2 Tags: - Key: key1 Value: value1 + Description: Log collector template + ImageId: ami-12345678 + CpuGeneration: v4 VmTemplateId: vmtemplate-98765432109876543210987654321012 - VmTemplateName: vmtemplate-example - schema: - "$ref": "#/components/schemas/CreateVmTemplateResponse" + Ram: 2 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - VmTemplate "/CreateVms": - description: |- - Creates virtual machines (VMs), and then launches them.
- This action enables you to create a specified number of VMs using an OUTSCALE machine image (OMI) that you are allowed to use, and then to automatically launch them.
- The VMs remain in the `pending` state until they are created and ready to be used. Once automatically launched, they are in the `running` state.
- To check the state of your VMs, call the [ReadVms](#readvms) method.
- If not specified, the security group used by the service is the default one.
- The metadata server enables you to get the public key provided when the VM is launched. Official OMIs contain a script to get this public key and put it inside the VM to provide secure access without password.

- For more information, see [About VMs](https://docs.outscale.com/en/userguide/About-VMs.html). post: + description: |- + Creates virtual machines (VMs), and then launches them.
+ This action enables you to create a specified number of VMs using an OUTSCALE machine image (OMI) that you are allowed to use, and then to automatically launch them.
+ The VMs remain in the `pending` state until they are created and ready to be used. Once automatically launched, they are in the `running` state.
+ To check the state of your VMs, call the [ReadVms](#readvms) method.
+ If not specified, the security group used by the service is the default one.
+ The metadata server enables you to get the public key provided when the VM is launched. Official OMIs contain a script to get this public key and put it inside the VM to provide secure access without password.

+ For more information, see [About VMs](https://docs.outscale.com/en/userguide/About-VMs.html). operationId: CreateVms requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateVmsRequest" examples: ex1: summary: Creating a VM (minimal syntax) @@ -15532,317 +15635,315 @@ paths: summary: Creating a VM in a Net value: ImageId: ami-12345678 + VmType: tinav5.c1r1p2 KeypairName: keypair-example SecurityGroupIds: - sg-12345678 SubnetId: subnet-12345678 UserData: "..." - VmType: tinav5.c1r1p2 ex3: summary: Creating a VM with block device mappings value: - BlockDeviceMappings: - - Bsu: - VolumeSize: 15 - VolumeType: gp2 - DeviceName: "/dev/sda1" - - Bsu: - Iops: 150 - SnapshotId: snap-12345678 - VolumeSize: 22 - VolumeType: io1 - DeviceName: "/dev/sdb" ImageId: ami-12345678 + VmType: tinav5.c1r1p2 KeypairName: keypair-example SecurityGroupIds: - sg-12345678 SubnetId: subnet-12345678 UserData: "..." - VmType: tinav5.c1r1p2 + BlockDeviceMappings: + - DeviceName: "/dev/sda1" + Bsu: + VolumeSize: 15 + VolumeType: gp2 + - DeviceName: "/dev/sdb" + Bsu: + SnapshotId: snap-12345678 + VolumeSize: 22 + VolumeType: io1 + Iops: 150 ex4: summary: Creating a VM with a NIC value: ImageId: ami-12345678 + VmType: tinav5.c1r1p2 KeypairName: keypair-example + UserData: "..." Nics: - DeviceNumber: 0 NicId: eni-12345678 - UserData: "..." - VmType: tinav5.c1r1p2 - schema: - "$ref": "#/components/schemas/CreateVmsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateVmsResponse" examples: ex1: summary: Creating a VM (minimal syntax) value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Vms: - - ActionsOnNextBoot: - SecureBoot: none + - VmType: t2.small + VmInitiatedShutdownBehavior: stop + State: pending + StateReason: '' + RootDeviceType: ebs + RootDeviceName: "/dev/sda1" + IsSourceDestChecked: true + ImageId: ami-12345678 + DeletionProtection: false + BootMode: legacy Architecture: x86_64 + NestedVirtualization: false BlockDeviceMappings: - - Bsu: - DeleteOnVmDeletion: true - LinkDate: '2010-10-01T12:34:56.789Z' - State: attaching + - DeviceName: "/dev/sda1" + Bsu: VolumeId: vol-12345678 - DeviceName: "/dev/sda1" - BootMode: legacy - BsuOptimized: false - CreationDate: '2010-10-01T12:34:56.789Z' - DeletionProtection: false + State: attaching + LinkDate: '2010-10-01T12:34:56.789Z' + DeleteOnVmDeletion: true + VmId: i-12345678 + ReservationId: r-12345678 Hypervisor: xen - ImageId: ami-12345678 - IsSourceDestChecked: true - LaunchNumber: 0 - NestedVirtualization: false - Performance: medium Placement: - SubregionName: eu-west-2a Tenancy: default - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal - PrivateIp: 10.0.0.4 + SubregionName: eu-west-2a ProductCodes: - '0001' - ReservationId: r-12345678 - RootDeviceName: "/dev/sda1" - RootDeviceType: ebs + CreationDate: '2010-10-01T12:34:56.789Z' + UserData: "..." + PrivateIp: 10.0.0.4 SecurityGroups: - - SecurityGroupId: sg-12345678 - SecurityGroupName: default - State: pending - StateReason: '' + - SecurityGroupName: default + SecurityGroupId: sg-12345678 + BsuOptimized: false + LaunchNumber: 0 + Performance: medium Tags: [] - UserData: "..." - VmId: i-12345678 - VmInitiatedShutdownBehavior: stop - VmType: t2.small + ActionsOnNextBoot: + SecureBoot: none + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Creating a VM in a Net value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Vms: - - ActionsOnNextBoot: - SecureBoot: none + - VmType: tinav5.c1r1p2 + VmInitiatedShutdownBehavior: stop + State: pending + StateReason: '' + RootDeviceType: ebs + RootDeviceName: "/dev/sda1" + IsSourceDestChecked: true + KeypairName: keypair-example + ImageId: ami-12345678 + DeletionProtection: false + BootMode: legacy Architecture: x86_64 + NestedVirtualization: false BlockDeviceMappings: - - Bsu: - DeleteOnVmDeletion: true - LinkDate: '2010-10-01T12:34:56.789Z' - State: attaching + - DeviceName: "/dev/sda1" + Bsu: VolumeId: vol-12345678 - DeviceName: "/dev/sda1" - BootMode: legacy - BsuOptimized: false - CreationDate: '2010-10-01T12:34:56.789Z' - DeletionProtection: false + State: attaching + LinkDate: '2010-10-01T12:34:56.789Z' + DeleteOnVmDeletion: true + VmId: i-12345678 + ReservationId: r-12345678 Hypervisor: xen - ImageId: ami-12345678 - IsSourceDestChecked: true - KeypairName: keypair-example + Placement: + Tenancy: default + SubregionName: eu-west-2a + ProductCodes: + - '0001' + CreationDate: '2010-10-01T12:34:56.789Z' + UserData: "..." + SubnetId: subnet-12345678 + PrivateIp: 10.0.0.4 + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 + BsuOptimized: false LaunchNumber: 0 - NestedVirtualization: false NetId: vpc-12345678 Nics: - - AccountId: '123456789012' - Description: Primary network interface - IsSourceDestChecked: true + - SubnetId: subnet-12345678 + State: in-use LinkNic: - DeleteOnVmDeletion: true + State: attached DeviceNumber: 0 LinkNicId: eni-attach-12345678 - State: attached + DeleteOnVmDeletion: true + IsSourceDestChecked: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + Description: Primary network interface + AccountId: '123456789012' + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - IsPrimary: true - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - SecurityGroups: - - SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - State: in-use - SubnetId: subnet-12345678 + IsPrimary: true Performance: high - Placement: - SubregionName: eu-west-2a - Tenancy: default + Tags: [] + ActionsOnNextBoot: + SecureBoot: none PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal - PrivateIp: 10.0.0.4 - ProductCodes: - - '0001' - ReservationId: r-12345678 - RootDeviceName: "/dev/sda1" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex3: + summary: Creating a VM with block device mappings + value: + Vms: + - VmType: tinav5.c1r1p2 + VmInitiatedShutdownBehavior: stop + State: pending + StateReason: '' RootDeviceType: ebs - SecurityGroups: - - SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - State: pending - StateReason: '' - SubnetId: subnet-12345678 - Tags: [] - UserData: "..." - VmId: i-12345678 - VmInitiatedShutdownBehavior: stop - VmType: tinav5.c1r1p2 - ex3: - summary: Creating a VM with block device mappings - value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - Vms: - - ActionsOnNextBoot: - SecureBoot: none + RootDeviceName: "/dev/sda1" + IsSourceDestChecked: true + KeypairName: keypair-example + ImageId: ami-12345678 + DeletionProtection: false + BootMode: legacy Architecture: x86_64 + NestedVirtualization: false BlockDeviceMappings: - - Bsu: - DeleteOnVmDeletion: true - LinkDate: '2010-10-01T12:34:56.789Z' - State: attaching + - DeviceName: "/dev/sda1" + Bsu: VolumeId: vol-12345678 - DeviceName: "/dev/sda1" - - Bsu: - DeleteOnVmDeletion: true - LinkDate: '2010-10-01T12:34:56.789Z' State: attaching + LinkDate: '2010-10-01T12:34:56.789Z' + DeleteOnVmDeletion: true + - DeviceName: "/dev/sda1" + Bsu: VolumeId: vol-87654321 - DeviceName: "/dev/sda1" - BootMode: legacy - BsuOptimized: false - CreationDate: '2010-10-01T12:34:56.789Z' - DeletionProtection: false + State: attaching + LinkDate: '2010-10-01T12:34:56.789Z' + DeleteOnVmDeletion: true + VmId: i-12345678 + ReservationId: r-12345678 Hypervisor: xen - ImageId: ami-12345678 - IsSourceDestChecked: true - KeypairName: keypair-example + Placement: + Tenancy: default + SubregionName: eu-west-2a + ProductCodes: + - '0001' + CreationDate: '2010-10-01T12:34:56.789Z' + UserData: "..." + SubnetId: subnet-12345678 + PrivateIp: 10.0.0.4 + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 + BsuOptimized: false LaunchNumber: 0 - NestedVirtualization: false NetId: vpc-12345678 Nics: - - AccountId: '123456789012' - Description: Primary network interface - IsSourceDestChecked: true + - SubnetId: subnet-12345678 + State: in-use LinkNic: - DeleteOnVmDeletion: true + State: attached DeviceNumber: 0 LinkNicId: eni-attach-12345678 - State: attached + DeleteOnVmDeletion: true + IsSourceDestChecked: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + Description: Primary network interface + AccountId: '123456789012' + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - IsPrimary: true - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - SecurityGroups: - - SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - State: in-use - SubnetId: subnet-12345678 + IsPrimary: true Performance: high - Placement: - SubregionName: eu-west-2a - Tenancy: default - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal - PrivateIp: 10.0.0.4 - ProductCodes: - - '0001' - ReservationId: r-12345678 - RootDeviceName: "/dev/sda1" - RootDeviceType: ebs - SecurityGroups: - - SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - State: pending - StateReason: '' - SubnetId: subnet-12345678 Tags: [] - UserData: "..." - VmId: i-12345678 - VmInitiatedShutdownBehavior: stop - VmType: tinav5.c1r1p2 + ActionsOnNextBoot: + SecureBoot: none + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex4: summary: Creating a VM with a NIC value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Vms: - - ActionsOnNextBoot: - SecureBoot: none + - VmType: tinav5.c1r1p2 + VmInitiatedShutdownBehavior: stop + State: pending + StateReason: '' + RootDeviceType: ebs + RootDeviceName: "/dev/sda1" + IsSourceDestChecked: true + KeypairName: keypair-example + ImageId: ami-12345678 + DeletionProtection: false + BootMode: legacy Architecture: x86_64 + NestedVirtualization: false BlockDeviceMappings: - - Bsu: - DeleteOnVmDeletion: true - LinkDate: '2010-10-01T12:34:56.789Z' - State: attaching + - DeviceName: "/dev/sda1" + Bsu: VolumeId: vol-12345678 - DeviceName: "/dev/sda1" - BootMode: legacy - BsuOptimized: false - CreationDate: '2010-10-01T12:34:56.789Z' - DeletionProtection: false + State: attaching + LinkDate: '2010-10-01T12:34:56.789Z' + DeleteOnVmDeletion: true + VmId: i-12345678 + ReservationId: r-12345678 Hypervisor: xen - ImageId: ami-12345678 - IsSourceDestChecked: true - KeypairName: keypair-example + Placement: + Tenancy: default + SubregionName: eu-west-2a + ProductCodes: + - '0001' + CreationDate: '2010-10-01T12:34:56.789Z' + UserData: "..." + SubnetId: subnet-12345678 + PrivateIp: 10.0.0.4 + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 + BsuOptimized: false LaunchNumber: 0 - NestedVirtualization: false NetId: vpc-12345678 Nics: - - AccountId: '123456789012' - Description: Example NIC - IsSourceDestChecked: true + - SubnetId: subnet-12345678 + State: in-use LinkNic: - DeleteOnVmDeletion: true + State: attached DeviceNumber: 0 LinkNicId: eni-attach-12345678 - State: attached + DeleteOnVmDeletion: true + IsSourceDestChecked: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + Description: Example NIC + AccountId: '123456789012' + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - IsPrimary: true - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - SecurityGroups: - - SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - State: in-use - SubnetId: subnet-12345678 + IsPrimary: true Performance: high - Placement: - SubregionName: eu-west-2a - Tenancy: default - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal - PrivateIp: 10.0.0.4 - ProductCodes: - - '0001' - ReservationId: r-12345678 - RootDeviceName: "/dev/sda1" - RootDeviceType: ebs - SecurityGroups: - - SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - State: pending - StateReason: '' - SubnetId: subnet-12345678 Tags: [] - UserData: "..." - VmId: i-12345678 - VmInitiatedShutdownBehavior: stop - VmType: tinav5.c1r1p2 - schema: - "$ref": "#/components/schemas/CreateVmsResponse" + ActionsOnNextBoot: + SecureBoot: none + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -15865,71 +15966,71 @@ paths: tags: - Vm "/CreateVolume": - description: |- - Creates a Block Storage Unit (BSU) volume in a specified Region.
- BSU volumes can be attached to a virtual machine (VM) in the same Subregion. You can create an empty volume or restore a volume from an existing snapshot.
- You can create the following volume types: Enterprise (`io1`) for provisioned IOPS SSD volumes, Performance (`gp2`) for general purpose SSD volumes, or Magnetic (`standard`) volumes.

- For more information, see [About Volumes](https://docs.outscale.com/en/userguide/About-Volumes.html). post: + description: |- + Creates a Block Storage Unit (BSU) volume in a specified Region.
+ BSU volumes can be attached to a virtual machine (VM) in the same Subregion. You can create an empty volume or restore a volume from an existing snapshot.
+ You can create the following volume types: Enterprise (`io1`) for provisioned IOPS SSD volumes, Performance (`gp2`) for general purpose SSD volumes, or Magnetic (`standard`) volumes.

+ For more information, see [About Volumes](https://docs.outscale.com/en/userguide/About-Volumes.html). operationId: CreateVolume requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateVolumeRequest" examples: ex1: summary: Creating an io1 volume value: - Iops: 100 - Size: 10 - SubregionName: eu-west-2a VolumeType: io1 + SubregionName: eu-west-2a + Size: 10 + Iops: 100 ex2: summary: Creating a volume from a snapshot value: - Size: 10 SnapshotId: snap-12345678 - SubregionName: eu-west-2a VolumeType: gp2 - schema: - "$ref": "#/components/schemas/CreateVolumeRequest" + SubregionName: eu-west-2a + Size: 10 responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateVolumeResponse" examples: ex1: summary: Creating an io1 volume value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Volume: + VolumeId: vol-12345678 + Tags: [] + VolumeType: io1 + SubregionName: eu-west-2a + State: creating CreationDate: '2010-10-01T12:34:56.789Z' Iops: 100 LinkedVolumes: [] Size: 10 - State: creating - SubregionName: eu-west-2a - Tags: [] - VolumeId: vol-12345678 - VolumeType: io1 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Creating a volume from a snapshot value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Volume: + VolumeId: vol-12345678 + Tags: [] + VolumeType: gp2 + SubregionName: eu-west-2a + State: creating + SnapshotId: snap-12345678 CreationDate: '2010-10-01T12:34:56.789Z' Iops: 100 LinkedVolumes: [] Size: 10 - SnapshotId: snap-12345678 - State: creating - SubregionName: eu-west-2a - Tags: [] - VolumeId: vol-12345678 - VolumeType: gp2 - schema: - "$ref": "#/components/schemas/CreateVolumeResponse" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -15952,96 +16053,98 @@ paths: tags: - Volume "/CreateVpnConnection": - description: |- - Creates a VPN connection between a specified virtual gateway and a specified client gateway.
- You can create only one VPN connection between a virtual gateway and a client gateway.

- - **[IMPORTANT]**
- This action can be done only if the virtual gateway is in the `available` state.

- For more information, see [About VPN Connections](https://docs.outscale.com/en/userguide/About-VPN-Connections.html). post: + description: |- + Creates a VPN connection between a specified virtual gateway and a specified client gateway.
+ You can create only one VPN connection between a virtual gateway and a client gateway.

+ + **[IMPORTANT]**
+ This action can be done only if the virtual gateway is in the `available` state.

+ For more information, see [About VPN Connections](https://docs.outscale.com/en/userguide/About-VPN-Connections.html). operationId: CreateVpnConnection requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateVpnConnectionRequest" examples: ex1: value: ClientGatewayId: cgw-12345678 + VirtualGatewayId: vgw-12345678 ConnectionType: ipsec.1 StaticRoutesOnly: true - VirtualGatewayId: vgw-12345678 - schema: - "$ref": "#/components/schemas/CreateVpnConnectionRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateVpnConnectionResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VpnConnection: + Routes: [] + Tags: [] ClientGatewayConfiguration: "..." - ClientGatewayId: cgw-12345678 + StaticRoutesOnly: true + VirtualGatewayId: vgw-12345678 ConnectionType: ipsec.1 - Routes: [] + ClientGatewayId: cgw-12345678 State: pending - StaticRoutesOnly: true - Tags: [] VgwTelemetries: - - AcceptedRouteCount: 0 + - StateDescription: IPSEC IS DOWN + AcceptedRouteCount: 0 LastStateChangeDate: '2017-05-10T12:34:56.789Z' OutsideIpAddress: 192.0.2.0 - StateDescription: IPSEC IS DOWN - VirtualGatewayId: vgw-12345678 VpnConnectionId: vpn-12345678 - schema: - "$ref": "#/components/schemas/CreateVpnConnectionResponse" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - VpnConnection "/CreateVpnConnectionRoute": - description: |- - Creates a static route to a VPN connection.
- This enables you to select the network flows sent by the virtual gateway to the target VPN connection.

- For more information, see [About Routing Configuration for VPN Connections](https://docs.outscale.com/en/userguide/About-Routing-Configuration-for-VPN-Connections.html). post: + description: |- + Creates a static route to a VPN connection.
+ This enables you to select the network flows sent by the virtual gateway to the target VPN connection.

+ For more information, see [About Routing Configuration for VPN Connections](https://docs.outscale.com/en/userguide/About-Routing-Configuration-for-VPN-Connections.html). operationId: CreateVpnConnectionRoute requestBody: content: application/json: - examples: + schema: + "$ref": "#/components/schemas/CreateVpnConnectionRouteRequest" + examples: ex1: value: - DestinationIpRange: 10.0.0.0/16 VpnConnectionId: vpn-12345678 - schema: - "$ref": "#/components/schemas/CreateVpnConnectionRouteRequest" + DestinationIpRange: 10.0.0.0/16 responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateVpnConnectionRouteResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateVpnConnectionRouteResponse" description: The HTTP 200 response (OK). tags: - VpnConnection "/DeleteAccessKey": - description: |- - Deletes the specified access key of either your root account or an EIM user.

- The access key of an EIM user must be in the `INACTIVE` state to be deleted. post: + description: |- + Deletes the specified access key of either your root account or an EIM user.

+ The access key of an EIM user must be in the `INACTIVE` state to be deleted. operationId: DeleteAccessKey requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteAccessKeyRequest" examples: ex1: summary: Deleting one of your own access keys (if you are the root @@ -16053,19 +16156,17 @@ paths: value: AccessKeyId: ABCDEFGHIJ0123456789 UserName: example-user - schema: - "$ref": "#/components/schemas/DeleteAccessKeyRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteAccessKeyResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteAccessKeyResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -16073,33 +16174,33 @@ paths: tags: - AccessKey "/DeleteApiAccessRule": - description: |- - Deletes a specified API access rule.

- - **[IMPORTANT]**
- You cannot delete the last remaining API access rule. However, if you delete all the API access rules that allow you to access the APIs, you need to contact the Support team to regain access. For more information, see [Technical Support](https://docs.outscale.com/en/userguide/Technical-Support.html). post: + description: |- + Deletes a specified API access rule.

+ + **[IMPORTANT]**
+ You cannot delete the last remaining API access rule. However, if you delete all the API access rules that allow you to access the APIs, you need to contact the Support team to regain access. For more information, see [Technical Support](https://docs.outscale.com/en/userguide/Technical-Support.html). operationId: DeleteApiAccessRule requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteApiAccessRuleRequest" examples: ex1: value: ApiAccessRuleId: aar-1234567890abcdef1234567890abcdef - schema: - "$ref": "#/components/schemas/DeleteApiAccessRuleRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteApiAccessRuleResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteApiAccessRuleResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -16107,29 +16208,29 @@ paths: tags: - ApiAccessRule "/DeleteCa": - description: Deletes a specified Client Certificate Authority (CA). post: + description: Deletes a specified Client Certificate Authority (CA). operationId: DeleteCa requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteCaRequest" examples: ex1: value: CaId: ca-fedcba0987654321fedcba0987654321 - schema: - "$ref": "#/components/schemas/DeleteCaRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteCaResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteCaResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -16137,51 +16238,53 @@ paths: tags: - Ca "/DeleteClientGateway": - description: |- - Deletes a client gateway.
- You must delete the VPN connection before deleting the client gateway. post: + description: |- + Deletes a client gateway.
+ You must delete the VPN connection before deleting the client gateway. operationId: DeleteClientGateway requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteClientGatewayRequest" examples: ex1: value: ClientGatewayId: cgw-12345678 - schema: - "$ref": "#/components/schemas/DeleteClientGatewayRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteClientGatewayResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteClientGatewayResponse" description: The HTTP 200 response (OK). tags: - ClientGateway "/DeleteDedicatedGroup": - description: |- - > [WARNING]
- > This feature is currently in beta.
+ post: + description: |- + > [WARNING]
+ > This feature is currently in beta.
- Deletes a specified dedicated group of virtual machines (VMs).
+ Deletes a specified dedicated group of virtual machines (VMs).
- **[WARNING]**
- A dedicated group can be deleted only if no VM or Net is in the dedicated group. Otherwise, you need to force the deletion.
- If you force the deletion:
- - all VMs are terminated.
- - all Nets are deleted, and all resources associated with Nets are detached. - post: + **[WARNING]**
+ A dedicated group can be deleted only if no VM or Net is in the dedicated group. Otherwise, you need to force the deletion.
+ If you force the deletion:
+ - all VMs are terminated.
+ - all Nets are deleted, and all resources associated with Nets are detached. operationId: DeleteDedicatedGroup requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteDedicatedGroupRequest" examples: ex1: summary: Deleting a dedicated group without any resource in it. @@ -16193,19 +16296,17 @@ paths: value: DedicatedGroupId: ded-12345678 Force: true - schema: - "$ref": "#/components/schemas/DeleteDedicatedGroupRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteDedicatedGroupResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteDedicatedGroupResponse" description: The HTTP 200 response (OK). '400': content: @@ -16228,102 +16329,104 @@ paths: tags: - DedicatedGroup "/DeleteDhcpOptions": - description: |- - Deletes a specified DHCP options set.
- Before deleting a DHCP options set, you must disassociate it from the Nets you associated it with. To do so, you need to associate with each Net a new set of DHCP options, or the `default` one if you do not want to associate any DHCP options with the Net.

- - **[IMPORTANT]**
- You cannot delete the `default` set. post: + description: |- + Deletes a specified DHCP options set.
+ Before deleting a DHCP options set, you must disassociate it from the Nets you associated it with. To do so, you need to associate with each Net a new set of DHCP options, or the `default` one if you do not want to associate any DHCP options with the Net.

+ + **[IMPORTANT]**
+ You cannot delete the `default` set. operationId: DeleteDhcpOptions requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteDhcpOptionsRequest" examples: ex1: value: DhcpOptionsSetId: dopt-12345678 - schema: - "$ref": "#/components/schemas/DeleteDhcpOptionsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteDhcpOptionsResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteDhcpOptionsResponse" description: The HTTP 200 response (OK). tags: - DhcpOption "/DeleteDirectLink": - description: |- - Deletes a specified DirectLink.
- Before deleting a DirectLink, ensure that all your DirectLink interfaces related to this DirectLink are deleted. post: + description: |- + Deletes a specified DirectLink.
+ Before deleting a DirectLink, ensure that all your DirectLink interfaces related to this DirectLink are deleted. operationId: DeleteDirectLink requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteDirectLinkRequest" examples: ex1: value: DirectLinkId: dxcon-12345678 - schema: - "$ref": "#/components/schemas/DeleteDirectLinkRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteDirectLinkResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteDirectLinkResponse" description: The HTTP 200 response (OK). tags: - DirectLink "/DeleteDirectLinkInterface": - description: Deletes a specified DirectLink interface. post: + description: Deletes a specified DirectLink interface. operationId: DeleteDirectLinkInterface requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteDirectLinkInterfaceRequest" examples: ex1: value: DirectLinkInterfaceId: dxvif-12345678 - schema: - "$ref": "#/components/schemas/DeleteDirectLinkInterfaceRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteDirectLinkInterfaceResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteDirectLinkInterfaceResponse" description: The HTTP 200 response (OK). tags: - DirectLinkInterface "/DeleteExportTask": - description: |- - Deletes an export task.
- If the export task is not running, the command fails and an error is returned. post: + description: |- + Deletes an export task.
+ If the export task is not in the `active` or `pending` state, the command fails and an error is returned. operationId: DeleteExportTask requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteExportTaskRequest" examples: ex1: summary: Deleting an image export task @@ -16333,12 +16436,12 @@ paths: summary: Deleting a snapshot export task value: ExportTaskId: snap-export-12345678 - schema: - "$ref": "#/components/schemas/DeleteExportTaskRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteExportTaskResponse" examples: ex1: summary: Deleting an image export task @@ -16350,66 +16453,64 @@ paths: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteExportTaskResponse" description: The HTTP 200 response (OK). tags: - Task "/DeleteFlexibleGpu": - description: |- - Releases a flexible GPU (fGPU) from your account.
- The fGPU becomes free to be used by someone else. post: + description: |- + Releases a flexible GPU (fGPU) from your account.
+ The fGPU becomes free to be used by someone else. operationId: DeleteFlexibleGpu requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteFlexibleGpuRequest" examples: ex1: value: FlexibleGpuId: fgpu-12345678 - schema: - "$ref": "#/components/schemas/DeleteFlexibleGpuRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteFlexibleGpuResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteFlexibleGpuResponse" description: The HTTP 200 response (OK). tags: - FlexibleGpu "/DeleteImage": - description: Deletes an OUTSCALE machine image (OMI) so that you cannot use it - anymore to launch virtual machines (VMs). However, you can still use VMs already - launched from this OMI. post: + description: Deletes an OUTSCALE machine image (OMI) so that you cannot use + it anymore to launch virtual machines (VMs). However, you can still use VMs + already launched from this OMI. operationId: DeleteImage requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteImageRequest" examples: ex1: value: ImageId: ami-12345678 - schema: - "$ref": "#/components/schemas/DeleteImageRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteImageResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteImageResponse" description: The HTTP 200 response (OK). '400': content: @@ -16432,31 +16533,31 @@ paths: tags: - Image "/DeleteInternetService": - description: |- - Deletes an internet service.
- Before deleting an internet service, you must detach it from any Net it is attached to. post: + description: |- + Deletes an internet service.
+ Before deleting an internet service, you must detach it from any Net it is attached to. operationId: DeleteInternetService requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteInternetServiceRequest" examples: ex1: value: InternetServiceId: igw-12345678 - schema: - "$ref": "#/components/schemas/DeleteInternetServiceRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteInternetServiceResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteInternetServiceResponse" description: The HTTP 200 response (OK). '400': content: @@ -16479,14 +16580,16 @@ paths: tags: - InternetService "/DeleteKeypair": - description: |- - Deletes the specified keypair.
- This action deletes the public key stored by 3DS OUTSCALE, thus deleting the keypair. post: + description: |- + Deletes the specified keypair.
+ This action deletes the public key stored by 3DS OUTSCALE, thus deleting the keypair. operationId: DeleteKeypair requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteKeypairRequest" examples: ex1: summary: Deleting a keypair with its name @@ -16496,19 +16599,17 @@ paths: summary: Deleting a keypair with its ID value: KeypairId: key-abcdef1234567890abcdef1234567890 - schema: - "$ref": "#/components/schemas/DeleteKeypairRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteKeypairResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteKeypairResponse" description: The HTTP 200 response (OK). '400': content: @@ -16531,192 +16632,194 @@ paths: tags: - Keypair "/DeleteListenerRule": - description: |- - Deletes a listener rule.
- The previously active rule is disabled after deletion. post: + description: |- + Deletes a listener rule.
+ The previously active rule is disabled after deletion. operationId: DeleteListenerRule requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteListenerRuleRequest" examples: ex1: value: ListenerRuleName: example-listener-rule - schema: - "$ref": "#/components/schemas/DeleteListenerRuleRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteListenerRuleResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteListenerRuleResponse" description: The HTTP 200 response (OK). tags: - Listener "/DeleteLoadBalancer": - description: Deletes a specified load balancer. post: + description: Deletes a specified load balancer. operationId: DeleteLoadBalancer requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteLoadBalancerRequest" examples: ex1: value: LoadBalancerName: example-lbu - schema: - "$ref": "#/components/schemas/DeleteLoadBalancerRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteLoadBalancerResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteLoadBalancerResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer "/DeleteLoadBalancerListeners": - description: Deletes listeners of a specified load balancer. post: + description: Deletes listeners of a specified load balancer. operationId: DeleteLoadBalancerListeners requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteLoadBalancerListenersRequest" examples: ex1: value: LoadBalancerName: example-lbu LoadBalancerPorts: - 80 - schema: - "$ref": "#/components/schemas/DeleteLoadBalancerListenersRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteLoadBalancerListenersResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 LoadBalancer: + Tags: [] + SourceSecurityGroup: + SecurityGroupName: security-group-example + SecurityGroupAccountId: '123456789012' + SecuredCookies: false + Subnets: + - subnet-12345678 + NetId: vpc-12345678 + BackendVmIds: [] + ApplicationStickyCookiePolicies: [] + SecurityGroups: + - sg-12345678 + LoadBalancerType: internal AccessLog: - IsEnabled: false PublicationInterval: 60 - ApplicationStickyCookiePolicies: [] - BackendVmIds: [] + IsEnabled: false DnsName: internal-example-lbu.123456789.eu-west-2.lbu.outscale.com HealthCheck: + UnhealthyThreshold: 2 + Timeout: 5 CheckInterval: 30 + Protocol: TCP HealthyThreshold: 10 Port: 80 - Protocol: TCP - Timeout: 5 - UnhealthyThreshold: 2 - Listeners: [] - LoadBalancerName: example-lbu LoadBalancerStickyCookiePolicies: [] - LoadBalancerType: internal - NetId: vpc-12345678 - SecuredCookies: false - SecurityGroups: - - sg-12345678 - SourceSecurityGroup: - SecurityGroupAccountId: '123456789012' - SecurityGroupName: security-group-example - Subnets: - - subnet-12345678 SubregionNames: - eu-west-2a - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteLoadBalancerListenersResponse" + Listeners: [] + LoadBalancerName: example-lbu description: The HTTP 200 response (OK). tags: - Listener "/DeleteLoadBalancerPolicy": - description: |- - Deletes a specified policy from a load balancer.
- In order to be deleted, the policy must not be enabled for any listener. post: + description: |- + Deletes a specified policy from a load balancer.
+ In order to be deleted, the policy must not be enabled for any listener. operationId: DeleteLoadBalancerPolicy requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteLoadBalancerPolicyRequest" examples: ex1: value: LoadBalancerName: example-lbu PolicyName: example-browser-policy - schema: - "$ref": "#/components/schemas/DeleteLoadBalancerPolicyRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteLoadBalancerPolicyResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 LoadBalancer: + Tags: [] + SourceSecurityGroup: + SecurityGroupName: default + SecurityGroupAccountId: '123456789012' + SecuredCookies: false + PublicIp: 192.0.2.0 + Subnets: + - subnet-12345678 + NetId: vpc-12345678 + BackendVmIds: [] + ApplicationStickyCookiePolicies: [] + SecurityGroups: + - sg-12345678 + LoadBalancerType: internet-facing AccessLog: - IsEnabled: false PublicationInterval: 60 - ApplicationStickyCookiePolicies: [] - BackendVmIds: [] + IsEnabled: false DnsName: example-lbu-123456789.eu-west-2.lbu.outscale.com HealthCheck: + UnhealthyThreshold: 2 + Timeout: 5 CheckInterval: 30 + Protocol: TCP HealthyThreshold: 10 Port: 80 - Protocol: TCP - Timeout: 5 - UnhealthyThreshold: 2 + LoadBalancerStickyCookiePolicies: [] + SubregionNames: + - eu-west-2a Listeners: - BackendPort: 80 BackendProtocol: HTTP LoadBalancerPort: 80 LoadBalancerProtocol: HTTP LoadBalancerName: example-lbu - LoadBalancerStickyCookiePolicies: [] - LoadBalancerType: internet-facing - NetId: vpc-12345678 - PublicIp: 192.0.2.0 - SecuredCookies: false - SecurityGroups: - - sg-12345678 - SourceSecurityGroup: - SecurityGroupAccountId: '123456789012' - SecurityGroupName: default - Subnets: - - subnet-12345678 - SubregionNames: - - eu-west-2a - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteLoadBalancerPolicyResponse" description: The HTTP 200 response (OK). tags: - LoadBalancerPolicy "/DeleteLoadBalancerTags": - description: Deletes one or more tags from the specified load balancers. post: + description: Deletes one or more tags from the specified load balancers. operationId: DeleteLoadBalancerTags requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteLoadBalancerTagsRequest" examples: ex1: value: @@ -16724,48 +16827,46 @@ paths: - example-lbu Tags: - Key: key1 - schema: - "$ref": "#/components/schemas/DeleteLoadBalancerTagsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteLoadBalancerTagsResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteLoadBalancerTagsResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer "/DeleteNatService": - description: |- - Deletes a specified network address translation (NAT) service.
- This action disassociates the public IP from the NAT service, but does not release this public IP from your account. However, it does not delete any NAT service routes in your route tables. post: + description: |- + Deletes a specified network address translation (NAT) service.
+ This action disassociates the public IP from the NAT service, but does not release this public IP from your account. However, it does not delete any NAT service routes in your route tables. operationId: DeleteNatService requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteNatServiceRequest" examples: ex1: value: NatServiceId: nat-12345678 - schema: - "$ref": "#/components/schemas/DeleteNatServiceRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteNatServiceResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteNatServiceResponse" description: The HTTP 200 response (OK). '400': content: @@ -16788,41 +16889,41 @@ paths: tags: - NatService "/DeleteNet": - description: |- - Deletes a specified Net.
- Before deleting the Net, you need to delete or detach all the resources associated with the Net:

- - * Virtual machines (VMs)
- * Net peerings
- * Custom route tables
- * Public IPs allocated to resources in the Net
- * Network Interface Cards (NICs) created in the Subnets
- * Virtual gateways, internet services and NAT services
- * Load balancers
- * Security groups
- * Subnets post: + description: |- + Deletes a specified Net.
+ Before deleting the Net, you need to delete or detach all the resources associated with the Net:

+ + * Virtual machines (VMs)
+ * Net peerings
+ * Custom route tables
+ * Public IPs allocated to resources in the Net
+ * Network Interface Cards (NICs) created in the Subnets
+ * Virtual gateways, internet services and NAT services
+ * Load balancers
+ * Security groups
+ * Subnets operationId: DeleteNet requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteNetRequest" examples: ex1: value: NetId: vpc-12345678 - schema: - "$ref": "#/components/schemas/DeleteNetRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteNetResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteNetResponse" description: The HTTP 200 response (OK). '400': content: @@ -16845,62 +16946,62 @@ paths: tags: - Net "/DeleteNetAccessPoint": - description: |- - Deletes a specified Net access point.
- This action also deletes the corresponding routes added to the route tables you specified for the Net access point. post: + description: |- + Deletes a specified Net access point.
+ This action also deletes the corresponding routes added to the route tables you specified for the Net access point. operationId: DeleteNetAccessPoint requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteNetAccessPointRequest" examples: ex1: value: NetAccessPointId: vpce-12345678 - schema: - "$ref": "#/components/schemas/DeleteNetAccessPointRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteNetAccessPointResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteNetAccessPointResponse" description: The HTTP 200 response (OK). tags: - NetAccessPoint "/DeleteNetPeering": - description: |- - Deletes a Net peering.
- If the Net peering is in the `active` state, it can be deleted either by the owner of the requester Net or the owner of the peer Net.
- If it is in the `pending-acceptance` state, it can be deleted only by the owner of the requester Net.
- If it is in the `rejected`, `failed`, or `expired` states, it cannot be deleted. post: + description: |- + Deletes a Net peering.
+ If the Net peering is in the `active` state, it can be deleted either by the owner of the requester Net or the owner of the peer Net.
+ If it is in the `pending-acceptance` state, it can be deleted only by the owner of the requester Net.
+ If it is in the `rejected`, `failed`, or `expired` states, it cannot be deleted. operationId: DeleteNetPeering requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteNetPeeringRequest" examples: ex1: value: NetPeeringId: pcx-12345678 - schema: - "$ref": "#/components/schemas/DeleteNetPeeringRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteNetPeeringResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteNetPeeringResponse" description: The HTTP 200 response (OK). '400': content: @@ -16929,31 +17030,31 @@ paths: tags: - NetPeering "/DeleteNic": - description: |- - Deletes the specified network interface card (NIC).
- The network interface must not be attached to any virtual machine (VM). post: + description: |- + Deletes the specified network interface card (NIC).
+ The network interface must not be attached to any virtual machine (VM). operationId: DeleteNic requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteNicRequest" examples: ex1: value: NicId: eni-12345678 - schema: - "$ref": "#/components/schemas/DeleteNicRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteNicResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteNicResponse" description: The HTTP 200 response (OK). '400': content: @@ -16976,92 +17077,92 @@ paths: tags: - Nic "/DeletePolicy": - description: |- - Deletes a managed policy.
- Before deleting a managed policy, you must unlink all users linked to it and delete all the versions of the policy, except the default one, using the `DeletePolicyVersion` method. post: + description: |- + Deletes a managed policy.
+ Before deleting a managed policy, you must unlink all users linked to it and delete all the versions of the policy, except the default one, using the `DeletePolicyVersion` method. operationId: DeletePolicy requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeletePolicyRequest" examples: ex1: value: PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy - schema: - "$ref": "#/components/schemas/DeletePolicyRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeletePolicyResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeletePolicyResponse" description: The HTTP 200 response (OK). tags: - Policy "/DeletePolicyVersion": - description: Deletes a specified version of a managed policy, if it is not set - as the default one. post: + description: Deletes a specified version of a managed policy, if it is not set + as the default one. operationId: DeletePolicyVersion requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeletePolicyVersionRequest" examples: ex1: value: PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy VersionId: v1 - schema: - "$ref": "#/components/schemas/DeletePolicyVersionRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeletePolicyVersionResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeletePolicyVersionResponse" description: The HTTP 200 response (OK). tags: - Policy "/DeleteProductType": - description: |- - Deletes a specified product type that belongs to you.
- - **[WARNING]**
- The product type must not be associated with one or more OMIs to be deleted. Otherwise, you need to force the deletion.
- If you force the deletion, the product type is deleted and remains associated with the OMIs.
post: + description: |- + Deletes a specified product type that belongs to you.
+ + **[WARNING]**
+ The product type must not be associated with one or more OMIs to be deleted. Otherwise, you need to force the deletion.
+ If you force the deletion, the product type is deleted and remains associated with the OMIs.
operationId: DeleteProductType requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteProductTypeRequest" examples: ex1: value: ProductTypeId: pty-12345678 - schema: - "$ref": "#/components/schemas/DeleteProductTypeRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteProductTypeResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteProductTypeResponse" description: The HTTP 200 response (OK). '400': content: @@ -17084,31 +17185,31 @@ paths: tags: - ProductType "/DeletePublicIp": - description: |- - Releases a public IP.
- You can release a public IP associated with your account. This address is released in the public IP pool and can be used by someone else. Before releasing a public IP, ensure you updated all your resources communicating with this address. post: + description: |- + Releases a public IP.
+ You can release a public IP associated with your account. This address is released in the public IP pool and can be used by someone else. Before releasing a public IP, ensure you updated all your resources communicating with this address. operationId: DeletePublicIp requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeletePublicIpRequest" examples: ex1: value: PublicIp: 192.0.2.0 - schema: - "$ref": "#/components/schemas/DeletePublicIpRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeletePublicIpResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeletePublicIpResponse" description: The HTTP 200 response (OK). '400': content: @@ -17131,40 +17232,40 @@ paths: tags: - PublicIp "/DeleteRoute": - description: Deletes a route from a specified route table. post: + description: Deletes a route from a specified route table. operationId: DeleteRoute requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteRouteRequest" examples: ex1: value: - DestinationIpRange: 198.51.100.0/24 RouteTableId: rtb-12345678 - schema: - "$ref": "#/components/schemas/DeleteRouteRequest" + DestinationIpRange: 198.51.100.0/24 responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteRouteResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 RouteTable: + Routes: + - DestinationIpRange: 10.0.0.0/16 + CreationMethod: CreateRouteTable + State: active LinkRouteTables: [] NetId: vpc-12345678 + Tags: [] RoutePropagatingVirtualGateways: [] RouteTableId: rtb-12345678 - Routes: - - CreationMethod: CreateRouteTable - DestinationIpRange: 10.0.0.0/16 - State: active - Tags: [] - schema: - "$ref": "#/components/schemas/DeleteRouteResponse" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -17187,31 +17288,31 @@ paths: tags: - Route "/DeleteRouteTable": - description: |- - Deletes a specified route table.
- Before deleting a route table, you must disassociate it from any Subnet. You cannot delete the main route table. post: + description: |- + Deletes a specified route table.
+ Before deleting a route table, you must disassociate it from any Subnet. You cannot delete the main route table. operationId: DeleteRouteTable requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteRouteTableRequest" examples: ex1: value: RouteTableId: rtb-12345678 - schema: - "$ref": "#/components/schemas/DeleteRouteTableRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteRouteTableResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteRouteTableResponse" description: The HTTP 200 response (OK). '400': content: @@ -17234,32 +17335,32 @@ paths: tags: - RouteTable "/DeleteSecurityGroup": - description: |- - Deletes a specified security group.
- You can specify either the name of the security group or its ID.
- This action fails if the specified group is associated with a virtual machine (VM) or referenced by another security group. post: + description: |- + Deletes a specified security group.
+ You can specify either the name of the security group or its ID.
+ This action fails if the specified group is associated with a virtual machine (VM) or referenced by another security group. operationId: DeleteSecurityGroup requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteSecurityGroupRequest" examples: ex1: value: SecurityGroupId: sg-12345678 - schema: - "$ref": "#/components/schemas/DeleteSecurityGroupRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteSecurityGroupResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteSecurityGroupResponse" description: The HTTP 200 response (OK). '400': content: @@ -17282,85 +17383,85 @@ paths: tags: - SecurityGroup "/DeleteSecurityGroupRule": - description: |- - Deletes one or more inbound or outbound rules from a security group. For the rule to be deleted, the values specified in the deletion request must exactly match the value of the existing rule.
- In case of TCP and UDP protocols, you have to indicate the destination port or range of ports. In case of ICMP protocol, you have to specify the ICMP type and code numbers.
- Rules (IP permissions) consist of the protocol, IP range or source security group.
- To remove outbound access to a destination security group, we recommend to use a set of IP permissions. We also recommend to specify the protocol in a set of IP permissions. post: + description: |- + Deletes one or more inbound or outbound rules from a security group. For the rule to be deleted, the values specified in the deletion request must exactly match the value of the existing rule.
+ In case of TCP and UDP protocols, you have to indicate the destination port or range of ports. In case of ICMP protocol, you have to specify the ICMP type and code numbers.
+ Rules (IP permissions) consist of the protocol, IP range or source security group.
+ To remove outbound access to a destination security group, we recommend to use a set of IP permissions. We also recommend to specify the protocol in a set of IP permissions. operationId: DeleteSecurityGroupRule requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteSecurityGroupRuleRequest" examples: ex1: summary: Deleting an inbound rule from an IP range value: Flow: Inbound + SecurityGroupId: sg-12345678 FromPortRange: 80 + ToPortRange: 80 IpProtocol: tcp IpRange: 10.0.0.0/16 - SecurityGroupId: sg-12345678 - ToPortRange: 80 ex2: summary: Deleting an inbound rule from another security group value: Flow: Inbound + SecurityGroupId: sg-12345678 Rules: - FromPortRange: 22 + ToPortRange: 22 IpProtocol: tcp SecurityGroupsMembers: - AccountId: '123456789012' SecurityGroupName: another-security-group - ToPortRange: 22 - SecurityGroupId: sg-12345678 - schema: - "$ref": "#/components/schemas/DeleteSecurityGroupRuleRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteSecurityGroupRuleResponse" examples: ex1: summary: Deleting an inbound rule from an IP range value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 SecurityGroup: - AccountId: '123456789012' - Description: Example of security group - InboundRules: [] - NetId: vpc-12345678 + Tags: [] + SecurityGroupName: security-group-example OutboundRules: - FromPortRange: -1 IpProtocol: "-1" + ToPortRange: -1 IpRanges: - 0.0.0.0/0 - ToPortRange: -1 SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - Tags: [] - ex2: - summary: Creating an inbound rule from another security group - value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - SecurityGroup: AccountId: '123456789012' Description: Example of security group InboundRules: [] NetId: vpc-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + summary: Creating an inbound rule from another security group + value: + SecurityGroup: + Tags: [] + SecurityGroupName: security-group-example OutboundRules: - FromPortRange: -1 IpProtocol: "-1" + ToPortRange: -1 IpRanges: - 0.0.0.0/0 - ToPortRange: -1 SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - Tags: [] - schema: - "$ref": "#/components/schemas/DeleteSecurityGroupRuleResponse" + AccountId: '123456789012' + Description: Example of security group + InboundRules: [] + NetId: vpc-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -17383,58 +17484,58 @@ paths: tags: - SecurityGroupRule "/DeleteServerCertificate": - description: Deletes a specified server certificate. post: + description: Deletes a specified server certificate. operationId: DeleteServerCertificate requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteServerCertificateRequest" examples: ex1: value: Name: server-cert-example - schema: - "$ref": "#/components/schemas/DeleteServerCertificateRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteServerCertificateResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteServerCertificateResponse" description: The HTTP 200 response (OK). tags: - ServerCertificate "/DeleteSnapshot": - description: |- - Deletes a specified snapshot.
- You cannot delete a snapshot that is currently used by an OUTSCALE machine image (OMI). To do so, you first need to delete the corresponding OMI. For more information, see the [DeleteImage](#deleteimage) method. post: + description: |- + Deletes a specified snapshot.
+ You cannot delete a snapshot that is currently used by an OUTSCALE machine image (OMI). To do so, you first need to delete the corresponding OMI. For more information, see the [DeleteImage](#deleteimage) method. operationId: DeleteSnapshot requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteSnapshotRequest" examples: ex1: value: SnapshotId: snap-12345678 - schema: - "$ref": "#/components/schemas/DeleteSnapshotRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteSnapshotResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteSnapshotResponse" description: The HTTP 200 response (OK). '400': content: @@ -17457,36 +17558,36 @@ paths: tags: - Snapshot "/DeleteSubnet": - description: |- - Deletes a specified Subnet.
- Before deleting the Subnet, you need to delete all resources associated with the Subnet:

- - * Virtual machines (VMs)
- * Network Interface Cards (NICs)
- * NAT services
- * Load balancers post: + description: |- + Deletes a specified Subnet.
+ Before deleting the Subnet, you need to delete all resources associated with the Subnet:

+ + * Virtual machines (VMs)
+ * Network Interface Cards (NICs)
+ * NAT services
+ * Load balancers operationId: DeleteSubnet requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteSubnetRequest" examples: ex1: value: SubnetId: subnet-12345678 - schema: - "$ref": "#/components/schemas/DeleteSubnetRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteSubnetResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteSubnetResponse" description: The HTTP 200 response (OK). '400': content: @@ -17509,12 +17610,14 @@ paths: tags: - Subnet "/DeleteTags": - description: Deletes one or more tags from the specified resources. post: + description: Deletes one or more tags from the specified resources. operationId: DeleteTags requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteTagsRequest" examples: ex1: value: @@ -17523,19 +17626,17 @@ paths: Tags: - Key: key1 Value: value1 - schema: - "$ref": "#/components/schemas/DeleteTagsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteTagsResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteTagsResponse" description: The HTTP 200 response (OK). '400': content: @@ -17558,181 +17659,181 @@ paths: tags: - Tag "/DeleteUser": - description: Deletes a specified EIM user. The EIM user must not belong to any - group, nor have any key or linked policy. post: + description: Deletes a specified EIM user. The EIM user must not belong to any + group, nor have any key or linked policy. operationId: DeleteUser requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteUserRequest" examples: ex1: value: UserName: example-user - schema: - "$ref": "#/components/schemas/DeleteUserRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteUserResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteUserResponse" description: The HTTP 200 response (OK). tags: - User "/DeleteUserGroup": - description: |- - Deletes a specified user group.
- - **[WARNING]**
- The user group must be empty of any user and must not have any linked policy. Otherwise, you need to force the deletion.
- If you force the deletion, all inline policies will be deleted with the user group.
post: + description: |- + Deletes a specified user group.
+ + **[WARNING]**
+ The user group must be empty of any user and must not have any linked policy. Otherwise, you need to force the deletion.
+ If you force the deletion, all inline policies will be deleted with the user group.
operationId: DeleteUserGroup requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteUserGroupRequest" examples: ex1: value: Force: false Path: "/example/" UserGroupName: example-usergroup - schema: - "$ref": "#/components/schemas/DeleteUserGroupRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteUserGroupResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteUserGroupResponse" description: The HTTP 200 response (OK). tags: - UserGroup "/DeleteUserGroupPolicy": - description: Deletes a specified inline policy from a specific group. post: + description: Deletes a specified inline policy from a specific group. operationId: DeleteUserGroupPolicy requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteUserGroupPolicyRequest" examples: ex1: value: PolicyName: example-usergroup-policy UserGroupName: example-usergroup UserGroupPath: "/example/" - schema: - "$ref": "#/components/schemas/DeleteUserGroupPolicyRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteUserGroupPolicyResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteUserGroupPolicyResponse" description: The HTTP 200 response (OK). tags: - Policy "/DeleteUserPolicy": - description: Deletes a specified inline policy from a specific user. post: + description: Deletes a specified inline policy from a specific user. operationId: DeleteUserPolicy requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteUserPolicyRequest" examples: ex1: value: PolicyName: example-user-policy UserName: example-user - schema: - "$ref": "#/components/schemas/DeleteUserPolicyRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteUserPolicyResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteUserPolicyResponse" description: The HTTP 200 response (OK). tags: - Policy "/DeleteVirtualGateway": - description: |- - Deletes a specified virtual gateway.
- Before deleting a virtual gateway, we recommend to detach it from the Net and delete the VPN connection. post: + description: |- + Deletes a specified virtual gateway.
+ Before deleting a virtual gateway, we recommend to detach it from the Net and delete the VPN connection. operationId: DeleteVirtualGateway requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteVirtualGatewayRequest" examples: ex1: value: VirtualGatewayId: vgw-12345678 - schema: - "$ref": "#/components/schemas/DeleteVirtualGatewayRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteVirtualGatewayResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteVirtualGatewayResponse" description: The HTTP 200 response (OK). tags: - VirtualGateway "/DeleteVmGroup": - description: |- - > [WARNING]
- > This feature is currently under development and may not function properly.
- - Deletes a specified VM group. post: + description: |- + > [WARNING]
+ > This feature is currently under development and may not function properly.
+ + Deletes a specified VM group. operationId: DeleteVmGroup requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteVmGroupRequest" examples: ex1: value: VmGroupId: vmgroup-12345678901234567890123456789012 - schema: - "$ref": "#/components/schemas/DeleteVmGroupRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteVmGroupResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteVmGroupResponse" description: The HTTP 200 response (OK). '400': content: @@ -17755,68 +17856,68 @@ paths: tags: - VmGroup "/DeleteVmTemplate": - description: |- - > [WARNING]
- > This feature is currently under development and may not function properly.
- - Deletes a virtual machine (VM) template.
- You cannot delete a template currently used by a VM group. post: + description: |- + > [WARNING]
+ > This feature is currently under development and may not function properly.
+ + Deletes a virtual machine (VM) template.
+ You cannot delete a template currently used by a VM group. operationId: DeleteVmTemplate requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteVmTemplateRequest" examples: ex1: value: VmTemplateId: vmtemplate-98765432109876543210987654321012 - schema: - "$ref": "#/components/schemas/DeleteVmTemplateRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteVmTemplateResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteVmTemplateResponse" description: The HTTP 200 response (OK). tags: - VmTemplate "/DeleteVms": - description: |- - Terminates one or more virtual machines (VMs).
- This operation is idempotent, that means that all calls succeed if you terminate a VM more than once. post: + description: |- + Terminates one or more virtual machines (VMs).
+ This operation is idempotent, that means that all calls succeed if you terminate a VM more than once. operationId: DeleteVms requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteVmsRequest" examples: ex1: value: VmIds: - i-12345678 - schema: - "$ref": "#/components/schemas/DeleteVmsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteVmsResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Vms: - - CurrentState: shutting-down + - VmId: i-12345678 PreviousState: running - VmId: i-12345678 - schema: - "$ref": "#/components/schemas/DeleteVmsResponse" + CurrentState: shutting-down + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -17839,31 +17940,31 @@ paths: tags: - Vm "/DeleteVolume": - description: |- - Deletes a specified Block Storage Unit (BSU) volume.
- You can delete available volumes only, that is, volumes that are not attached to a virtual machine (VM). post: + description: |- + Deletes a specified Block Storage Unit (BSU) volume.
+ You can delete available volumes only, that is, volumes that are not attached to a virtual machine (VM). operationId: DeleteVolume requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteVolumeRequest" examples: ex1: value: VolumeId: vol-12345678 - schema: - "$ref": "#/components/schemas/DeleteVolumeRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteVolumeResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteVolumeResponse" description: The HTTP 200 response (OK). '400': content: @@ -17886,157 +17987,325 @@ paths: tags: - Volume "/DeleteVpnConnection": - description: |- - Deletes a specified VPN connection.
- If you want to delete a Net and all its dependencies, we recommend to detach the virtual gateway from the Net and delete the Net before deleting the VPN connection. This enables you to delete the Net without waiting for the VPN connection to be deleted. post: + description: |- + Deletes a specified VPN connection.
+ If you want to delete a Net and all its dependencies, we recommend to detach the virtual gateway from the Net and delete the Net before deleting the VPN connection. This enables you to delete the Net without waiting for the VPN connection to be deleted. operationId: DeleteVpnConnection requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteVpnConnectionRequest" examples: ex1: value: VpnConnectionId: vpn-12345678 - schema: - "$ref": "#/components/schemas/DeleteVpnConnectionRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteVpnConnectionResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteVpnConnectionResponse" description: The HTTP 200 response (OK). tags: - VpnConnection "/DeleteVpnConnectionRoute": - description: Deletes a static route to a VPN connection previously created using - the CreateVpnConnectionRoute method. post: + description: Deletes a static route to a VPN connection previously created using + the CreateVpnConnectionRoute method. operationId: DeleteVpnConnectionRoute requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteVpnConnectionRouteRequest" examples: ex1: value: - DestinationIpRange: 10.0.0.0/16 VpnConnectionId: vpn-12345678 - schema: - "$ref": "#/components/schemas/DeleteVpnConnectionRouteRequest" + DestinationIpRange: 10.0.0.0/16 responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteVpnConnectionRouteResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteVpnConnectionRouteResponse" description: The HTTP 200 response (OK). tags: - VpnConnection "/DeregisterVmsInLoadBalancer": - description: |- - > [WARNING]
- > Deprecated: This call is deprecated and will be removed.
- - Deregisters a specified virtual machine (VM) from a load balancer. post: + description: |- + > [WARNING]
+ > Deprecated: This call is deprecated and will be removed.
+ + Deregisters a specified virtual machine (VM) from a load balancer. operationId: DeregisterVmsInLoadBalancer requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeregisterVmsInLoadBalancerRequest" examples: ex1: value: + LoadBalancerName: example-lbu BackendVmIds: - i-12345678 - i-87654321 - LoadBalancerName: example-lbu + responses: + '200': + content: + application/json: + schema: + "$ref": "#/components/schemas/DeregisterVmsInLoadBalancerResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + description: The HTTP 200 response (OK). + tags: + - LoadBalancer + "/DisableOutscaleLogin": + post: + description: Disables the possibility of logging in using the Outscale credentials + of your root account when identity federation is activated. + operationId: DisableOutscaleLogin + requestBody: + content: + application/json: schema: - "$ref": "#/components/schemas/DeregisterVmsInLoadBalancerRequest" + "$ref": "#/components/schemas/DisableOutscaleLoginRequest" + examples: + ex1: + value: {} responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DisableOutscaleLoginResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + description: The HTTP 200 response (OK). + tags: + - IdentityProvider + "/DisableOutscaleLoginForUsers": + post: + description: Disables the possibility of logging in using the Outscale credentials + of your EIM users when identity federation is activated. + operationId: DisableOutscaleLoginForUsers + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/DisableOutscaleLoginRequest" + examples: + ex1: + value: {} + responses: + '200': + content: + application/json: schema: - "$ref": "#/components/schemas/DeregisterVmsInLoadBalancerResponse" + "$ref": "#/components/schemas/DisableOutscaleLoginResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - - LoadBalancer + - IdentityProvider + "/DisableOutscaleLoginPerUsers": + post: + description: Disables the possibility for one or more specific users to log + in using their Outscale credentials when identity federation is activated. + operationId: DisableOutscaleLoginPerUsers + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/DisableOutscaleLoginPerUsersRequest" + examples: + ex1: + value: + UserNames: + - example-user + - test-user + responses: + '200': + content: + application/json: + schema: + "$ref": "#/components/schemas/DisableOutscaleLoginPerUsersResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + description: The HTTP 200 response (OK). + tags: + - IdentityProvider + "/EnableOutscaleLogin": + post: + description: Enables the possibility of logging in using the Outscale credentials + of your root account when identity federation is activated. + operationId: EnableOutscaleLogin + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/EnableOutscaleLoginRequest" + examples: + ex1: + value: {} + responses: + '200': + content: + application/json: + schema: + "$ref": "#/components/schemas/EnableOutscaleLoginResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + description: The HTTP 200 response (OK). + tags: + - IdentityProvider + "/EnableOutscaleLoginForUsers": + post: + description: Enables the possibility for all your EIM users to log in using + their Outscale credentials when identity federation is activated. + operationId: EnableOutscaleLoginForUsers + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/EnableOutscaleLoginForUsersRequest" + examples: + ex1: + value: {} + responses: + '200': + content: + application/json: + schema: + "$ref": "#/components/schemas/EnableOutscaleLoginForUsersResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + description: The HTTP 200 response (OK). + tags: + - IdentityProvider + "/EnableOutscaleLoginPerUsers": + post: + description: Enables the possibility for one or more specific users to log in + using their Outscale credentials when identity federation is activated. + operationId: EnableOutscaleLoginPerUsers + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/EnableOutscaleLoginPerUsersRequest" + examples: + ex1: + value: + UserNames: + - example-user + - test-user + responses: + '200': + content: + application/json: + schema: + "$ref": "#/components/schemas/EnableOutscaleLoginPerUsersResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + description: The HTTP 200 response (OK). + tags: + - IdentityProvider "/LinkFlexibleGpu": - description: |- - Attaches one of your allocated flexible GPUs (fGPUs) to one of your virtual machines (VMs).
- To complete the linking of the fGPU, you need to do a stop/start of the VM. A simple restart is not sufficient, as the linking of the fGPU is done when the VM goes through the `stopped` state. For the difference between stop/start and restart, see [About VM Lifecycle](https://docs.outscale.com/en/userguide/About-VM-Lifecycle.html).

- - **[NOTE]**
- You can attach fGPUs only to VMs with the `highest` (1) performance flag. For more information see [About Flexible GPUs](https://docs.outscale.com/en/userguide/About-Flexible-GPUs.html) and [VM Types](https://docs.outscale.com/en/userguide/VM-Types.html). post: + description: |- + Attaches one of your allocated flexible GPUs (fGPUs) to one of your virtual machines (VMs).
+ To complete the linking of the fGPU, you need to do a stop/start of the VM. A simple restart is not sufficient, as the linking of the fGPU is done when the VM goes through the `stopped` state. For the difference between stop/start and restart, see [About VM Lifecycle](https://docs.outscale.com/en/userguide/About-VM-Lifecycle.html).

+ + **[NOTE]**
+ You can attach fGPUs only to VMs with the `highest` (1) performance flag. For more information see [About Flexible GPUs](https://docs.outscale.com/en/userguide/About-Flexible-GPUs.html) and [VM Types](https://docs.outscale.com/en/userguide/VM-Types.html). operationId: LinkFlexibleGpu requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/LinkFlexibleGpuRequest" examples: ex1: value: FlexibleGpuId: fgpu-12345678 VmId: i-12345678 - schema: - "$ref": "#/components/schemas/LinkFlexibleGpuRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/LinkFlexibleGpuResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/LinkFlexibleGpuResponse" description: The HTTP 200 response (OK). tags: - FlexibleGpu "/LinkInternetService": - description: |- - Attaches an internet service to a Net.
- To enable the connection between the Internet and a Net, you must attach an internet service to this Net. post: + description: |- + Attaches an internet service to a Net.
+ To enable the connection between the Internet and a Net, you must attach an internet service to this Net. operationId: LinkInternetService requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/LinkInternetServiceRequest" examples: ex1: value: InternetServiceId: igw-12345678 NetId: vpc-12345678 - schema: - "$ref": "#/components/schemas/LinkInternetServiceRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/LinkInternetServiceResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/LinkInternetServiceResponse" description: The HTTP 200 response (OK). '400': content: @@ -18059,35 +18328,37 @@ paths: tags: - InternetService "/LinkLoadBalancerBackendMachines": - description: |- - Attaches one or more virtual machines (VMs) to a specified load balancer. You need to specify at least the `BackendIps` or the `BackendVmIds` parameter.
- The VMs can be in different Subnets and different Subregions than the load balancer, as long as the VMs and load balancers are all in the public Cloud or all in the same Net. It may take a little time for a VM to be registered with the load balancer. Once the VM is registered with a load balancer, it receives traffic and requests from this load balancer and is called a backend VM. post: + description: |- + Attaches one or more virtual machines (VMs) to a specified load balancer. You need to specify at least the `BackendIps` or the `BackendVmIds` parameter.
+ The VMs can be in different Subnets and different Subregions than the load balancer, as long as the VMs and load balancers are all in the public Cloud or all in the same Net. It may take a little time for a VM to be registered with the load balancer. Once the VM is registered with a load balancer, it receives traffic and requests from this load balancer and is called a backend VM. operationId: LinkLoadBalancerBackendMachines requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/LinkLoadBalancerBackendMachinesRequest" examples: ex1: summary: Linking VMs to a load balancer value: + LoadBalancerName: example-lbu BackendVmIds: - i-12345678 - i-87654321 - LoadBalancerName: example-lbu ex2: summary: Linking public IPs to a load balancer value: + LoadBalancerName: example-lbu BackendIps: - 192.0.2.0 - 198.51.100.0 - LoadBalancerName: example-lbu - schema: - "$ref": "#/components/schemas/LinkLoadBalancerBackendMachinesRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/LinkLoadBalancerBackendMachinesResponse" examples: ex1: summary: Linking VMs to a load balancer @@ -18099,69 +18370,67 @@ paths: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/LinkLoadBalancerBackendMachinesResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer "/LinkManagedPolicyToUserGroup": - description: Links a managed policy to a specific group. This policy applies to - all the users contained in this group. post: + description: Links a managed policy to a specific group. This policy applies + to all the users contained in this group. operationId: LinkManagedPolicyToUserGroup requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/LinkManagedPolicyToUserGroupRequest" examples: ex1: value: PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy UserGroupName: example-usergroup - schema: - "$ref": "#/components/schemas/LinkManagedPolicyToUserGroupRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/LinkManagedPolicyToUserGroupResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/LinkManagedPolicyToUserGroupResponse" description: The HTTP 200 response (OK). tags: - Policy "/LinkNic": - description: |- - Attaches a network interface card (NIC) to a virtual machine (VM).
- The interface and the VM must be in the same Subregion. The VM can be either `running` or `stopped`. The NIC must be in the `available` state. For more information, see [Attaching a NIC to a VM](https://docs.outscale.com/en/userguide/Attaching-a-NIC-to-a-VM.html). post: + description: |- + Attaches a network interface card (NIC) to a virtual machine (VM).
+ The interface and the VM must be in the same Subregion. The VM can be either `running` or `stopped`. The NIC must be in the `available` state. For more information, see [Attaching a NIC to a VM](https://docs.outscale.com/en/userguide/Attaching-a-NIC-to-a-VM.html). operationId: LinkNic requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/LinkNicRequest" examples: ex1: value: - DeviceNumber: 1 NicId: eni-12345678 VmId: i-12345678 - schema: - "$ref": "#/components/schemas/LinkNicRequest" + DeviceNumber: 1 responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/LinkNicResponse" examples: ex1: value: - LinkNicId: eni-attach-12345678 ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/LinkNicResponse" + LinkNicId: eni-attach-12345678 description: The HTTP 200 response (OK). '400': content: @@ -18184,46 +18453,48 @@ paths: tags: - Nic "/LinkPolicy": - description: Links a managed policy to a specific user. post: + description: Links a managed policy to a specific user. operationId: LinkPolicy requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/LinkPolicyRequest" examples: ex1: value: PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy UserName: example-user - schema: - "$ref": "#/components/schemas/LinkPolicyRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/LinkPolicyResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/LinkPolicyResponse" description: The HTTP 200 response (OK). tags: - Policy "/LinkPrivateIps": - description: Assigns one or more secondary private IPs to a specified network - interface card (NIC). This action is only available in a Net. The private IPs - to be assigned can be added individually using the `PrivateIps` parameter, or - you can specify the number of private IPs to be automatically chosen within - the Subnet range using the `SecondaryPrivateIpCount` parameter. You can specify - only one of these two parameters. If none of these parameters are specified, - a private IP is chosen within the Subnet range. post: + description: Assigns one or more secondary private IPs to a specified network + interface card (NIC). This action is only available in a Net. The private + IPs to be assigned can be added individually using the `PrivateIps` parameter, + or you can specify the number of private IPs to be automatically chosen within + the Subnet range using the `SecondaryPrivateIpCount` parameter. You can specify + only one of these two parameters. If none of these parameters are specified, + a private IP is chosen within the Subnet range. operationId: LinkPrivateIps requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/LinkPrivateIpsRequest" examples: ex1: summary: Linking specific secondary private IPs to a NIC @@ -18237,19 +18508,17 @@ paths: value: NicId: eni-12345678 SecondaryPrivateIpCount: 3 - schema: - "$ref": "#/components/schemas/LinkPrivateIpsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/LinkPrivateIpsResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/LinkPrivateIpsResponse" description: The HTTP 200 response (OK). '400': content: @@ -18272,18 +18541,20 @@ paths: tags: - Nic "/LinkPublicIp": - description: |- - Associates a public IP with a virtual machine (VM) or a network interface card (NIC), in the public Cloud or in a Net. You can associate a public IP with only one VM or network interface at a time.
- To associate a public IP in a Net, ensure that the Net has an internet service attached. For more information, see the [LinkInternetService](#linkinternetservice) method.
- By default, the public IP is disassociated every time you stop and start the VM. For a persistent association, you can add the `osc.fcu.eip.auto-attach` tag to the VM with the public IP as value. For more information, see the [CreateTags](#createtags) method.

- - **[IMPORTANT]**
- You can associate a public IP with a network address translation (NAT) service only when creating the NAT service. To modify its public IP, you need to delete the NAT service and re-create it with the new public IP. For more information, see the [CreateNatService](#createnatservice) method. post: + description: |- + Associates a public IP with a virtual machine (VM) or a network interface card (NIC), in the public Cloud or in a Net. You can associate a public IP with only one VM or network interface at a time.
+ To associate a public IP in a Net, ensure that the Net has an internet service attached. For more information, see the [LinkInternetService](#linkinternetservice) method.
+ By default, the public IP is disassociated every time you stop and start the VM. For a persistent association, you can add the `osc.fcu.eip.auto-attach` tag to the VM with the public IP as value. For more information, see the [CreateTags](#createtags) method.

+ + **[IMPORTANT]**
+ You can associate a public IP with a network address translation (NAT) service only when creating the NAT service. To modify its public IP, you need to delete the NAT service and re-create it with the new public IP. For more information, see the [CreateNatService](#createnatservice) method. operationId: LinkPublicIp requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/LinkPublicIpRequest" examples: ex1: summary: Linking a public IP to a VM @@ -18293,29 +18564,27 @@ paths: ex2: summary: Linking a public IP to a NIC value: - NicId: eni-12345678 PublicIp: 192.0.2.0 - schema: - "$ref": "#/components/schemas/LinkPublicIpRequest" + NicId: eni-12345678 responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/LinkPublicIpResponse" examples: ex1: summary: Linking a public IP to a VM value: - LinkPublicIpId: eipassoc-12345678 ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + LinkPublicIpId: eipassoc-12345678 ex2: summary: Linking a public IP to a NIC value: - LinkPublicIpId: eipassoc-12345678 ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/LinkPublicIpResponse" + LinkPublicIpId: eipassoc-12345678 description: The HTTP 200 response (OK). '400': content: @@ -18338,33 +18607,33 @@ paths: tags: - PublicIp "/LinkRouteTable": - description: |- - Associates a Subnet with a route table.
- The Subnet and the route table must be in the same Net. The traffic is routed according to the route table defined within this Net. You can associate a route table with several Subnets. post: + description: |- + Associates a Subnet with a route table.
+ The Subnet and the route table must be in the same Net. The traffic is routed according to the route table defined within this Net. You can associate a route table with several Subnets. operationId: LinkRouteTable requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/LinkRouteTableRequest" examples: ex1: value: RouteTableId: rtb-12345678 SubnetId: subnet-12345678 - schema: - "$ref": "#/components/schemas/LinkRouteTableRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/LinkRouteTableResponse" examples: ex1: value: - LinkRouteTableId: rtbassoc-12345678 ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/LinkRouteTableResponse" + LinkRouteTableId: rtbassoc-12345678 description: The HTTP 200 response (OK). '400': content: @@ -18387,68 +18656,68 @@ paths: tags: - RouteTable "/LinkVirtualGateway": - description: |- - Attaches a virtual gateway to a Net. - - **[IMPORTANT]**
- This action can be done only if the virtual gateway is in the `available` state. post: + description: |- + Attaches a virtual gateway to a Net. + + **[IMPORTANT]**
+ This action can be done only if the virtual gateway is in the `available` state. operationId: LinkVirtualGateway requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/LinkVirtualGatewayRequest" examples: ex1: value: - NetId: vpc-12345678 VirtualGatewayId: vgw-12345678 - schema: - "$ref": "#/components/schemas/LinkVirtualGatewayRequest" + NetId: vpc-12345678 responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/LinkVirtualGatewayResponse" examples: ex1: value: - NetToVirtualGatewayLink: - NetId: vpc-12345678 - State: attached ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/LinkVirtualGatewayResponse" + NetToVirtualGatewayLink: + State: attached + NetId: vpc-12345678 description: The HTTP 200 response (OK). tags: - VirtualGateway "/LinkVolume": - description: |- - Attaches a Block Storage Unit (BSU) volume to a virtual machine (VM).
- The volume and the VM must be in the same Subregion. The VM can be running or stopped. The volume is attached to the specified VM device. post: + description: |- + Attaches a Block Storage Unit (BSU) volume to a virtual machine (VM).
+ The volume and the VM must be in the same Subregion. The VM can be running or stopped. The volume is attached to the specified VM device. operationId: LinkVolume requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/LinkVolumeRequest" examples: ex1: value: - DeviceName: "/dev/sdb" - VmId: i-12345678 VolumeId: vol-12345678 - schema: - "$ref": "#/components/schemas/LinkVolumeRequest" + VmId: i-12345678 + DeviceName: "/dev/sdb" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/LinkVolumeResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/LinkVolumeResponse" description: The HTTP 200 response (OK). '400': content: @@ -18471,14 +18740,16 @@ paths: tags: - Volume "/PutUserGroupPolicy": - description: |- - Creates or updates an inline policy included in a specified group.
- The policy is automatically applied to all the users of the group after its creation. post: + description: |- + Creates or updates an inline policy included in a specified group.
+ The policy is automatically applied to all the users of the group after its creation. operationId: PutUserGroupPolicy requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/PutUserGroupPolicyRequest" examples: ex1: value: @@ -18487,31 +18758,31 @@ paths: PolicyName: example-usergroup-policy UserGroupName: example-usergroup UserGroupPath: "/example/" - schema: - "$ref": "#/components/schemas/PutUserGroupPolicyRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/PutUserGroupPolicyResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/PutUserGroupPolicyResponse" description: The HTTP 200 response (OK). tags: - Policy "/PutUserPolicy": - description: |- - Creates or updates an inline policy included in a specified user.
- The policy is automatically applied to the user after its creation. post: + description: |- + Creates or updates an inline policy included in a specified user.
+ The policy is automatically applied to the user after its creation. operationId: PutUserPolicy requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/PutUserPolicyRequest" examples: ex1: value: @@ -18519,29 +18790,30 @@ paths: "Resource": ["*"]} ]}' PolicyName: example-user-policy UserName: example-user - schema: - "$ref": "#/components/schemas/PutUserPolicyRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/PutUserPolicyResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/PutUserPolicyResponse" description: The HTTP 200 response (OK). tags: - Policy "/ReadAccessKeys": - description: Lists the access key IDs of either your root account or an EIM user. post: + description: Lists the access key IDs of either your root account or an EIM + user. operationId: ReadAccessKeys requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadAccessKeysRequest" examples: ex1: value: @@ -18550,26 +18822,24 @@ paths: - ACTIVE Tag: Group1 UserName: example-user - schema: - "$ref": "#/components/schemas/ReadAccessKeysRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadAccessKeysResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 AccessKeys: - - AccessKeyId: ABCDEFGHIJ0123456789 + - State: ACTIVE + AccessKeyId: ABCDEFGHIJ0123456789 CreationDate: 2010-10-01 12:34:56.789000000 +00:00 ExpirationDate: 2063-04-05 00:00:00.000000000 +00:00 LastModificationDate: 2010-10-01 12:34:56.789000000 +00:00 - State: ACTIVE Tag: Group1 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadAccessKeysResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -18577,73 +18847,73 @@ paths: tags: - AccessKey "/ReadAccounts": - description: Gets information about the account that sent the request. post: + description: Gets information about the account that sent the request. operationId: ReadAccounts requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadAccountsRequest" examples: ex1: value: {} - schema: - "$ref": "#/components/schemas/ReadAccountsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadAccountsResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Accounts: - - AccountId: '123456789012' - City: SAINT-CLOUD + - ZipCode: '92210' CompanyName: EXAMPLE SAS + FirstName: JEAN + City: SAINT-CLOUD Country: FRANCE + LastName: DUPONT + AccountId: '123456789012' CustomerId: '87654321' Email: example@example.com - FirstName: JEAN - LastName: DUPONT - ZipCode: '92210' - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadAccountsResponse" description: The HTTP 200 response (OK). tags: - Account "/ReadAdminPassword": - description: |- - Gets the administrator password for a Windows running virtual machine (VM).
- The administrator password is encrypted using the keypair you specified when launching the VM.

- - **[IMPORTANT]**
- * Only RSA keypairs can decrypt the password of a Windows VM.
- * The administrator password is generated only on the first boot of the Windows VM. It is not returned after the first boot. post: + description: |- + Gets the administrator password for a Windows running virtual machine (VM).
+ The administrator password is encrypted using the keypair you specified when launching the VM.

+ + **[IMPORTANT]**
+ * Only RSA keypairs can decrypt the password of a Windows VM.
+ * The administrator password is generated only on the first boot of the Windows VM. It is not returned after the first boot. operationId: ReadAdminPassword requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadAdminPasswordRequest" examples: ex1: value: VmId: i-12345678 - schema: - "$ref": "#/components/schemas/ReadAdminPasswordRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadAdminPasswordResponse" examples: ex1: value: - AdminPassword: "..." + VmId: i-12345678 ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - VmId: i-12345678 - schema: - "$ref": "#/components/schemas/ReadAdminPasswordResponse" + AdminPassword: "..." description: The HTTP 200 response (OK). '400': content: @@ -18666,33 +18936,33 @@ paths: tags: - Vm "/ReadApiAccessPolicy": - description: |- - Gets information about the API access policy of your account.

- For more information, see [About Your API Access Policy](https://docs.outscale.com/en/userguide/About-Your-API-Access-Policy.html). post: + description: |- + Gets information about the API access policy of your account.

+ For more information, see [About Your API Access Policy](https://docs.outscale.com/en/userguide/About-Your-API-Access-Policy.html). operationId: ReadApiAccessPolicy requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadApiAccessPolicyRequest" examples: ex1: value: {} - schema: - "$ref": "#/components/schemas/ReadApiAccessPolicyRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadApiAccessPolicyResponse" examples: ex1: value: - ApiAccessPolicy: - MaxAccessKeyExpirationSeconds: 0 - RequireTrustedEnv: false ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadApiAccessPolicyResponse" + ApiAccessPolicy: + RequireTrustedEnv: false + MaxAccessKeyExpirationSeconds: 0 description: The HTTP 200 response (OK). '400': content: @@ -18718,44 +18988,38 @@ paths: tags: - ApiAccessPolicy "/ReadApiAccessRules": - description: Lists one or more API access rules. post: + description: Lists one or more API access rules. operationId: ReadApiAccessRules requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadApiAccessRulesRequest" examples: ex1: value: Filters: ApiAccessRuleIds: - aar-1234567890abcdef1234567890abcdef - schema: - "$ref": "#/components/schemas/ReadApiAccessRulesRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadApiAccessRulesResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ApiAccessRules: - - ApiAccessRuleId: aar-1234567890abcdef1234567890abcdef - CaIds: [] - Cns: [] - Description: Allows all IPv4 domain - IpRanges: + - IpRanges: - 0.0.0.0/0 - - ApiAccessRuleId: aar-abcdef1234567890abcdef1234567890 + ApiAccessRuleId: aar-1234567890abcdef1234567890abcdef CaIds: [] Cns: [] - Description: Allows Outscale Cockpit of this region - IpRanges: - - 46.231.144.178/32 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadApiAccessRulesResponse" + Description: Allows all IPv4 domain description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -18763,95 +19027,95 @@ paths: tags: - ApiAccessRule "/ReadApiLogs": - description: |- - Lists the logs of the API calls you have performed with this account. - - **[IMPORTANT]**
- Past logs are accessible for up to 32 days.
- By default, the retrieved interval is 48 hours. If neither of the `QueryDateBefore` nor `QueryDateAfter` parameters are specified, logs from the past 48 hours are retrieved. If you only specify one of two, logs are retrieved from a 2-day interval based on the date you provided. To retrieve logs beyond a 2-day interval, specify both parameters.

- For more information, see [About OMS](https://docs.outscale.com/en/userguide/About-OMS.html). post: + description: |- + Lists the logs of the API calls you have performed with this account. + + **[IMPORTANT]**
+ Past logs are accessible for up to 32 days.
+ By default, the retrieved interval is 48 hours. If neither of the `QueryDateBefore` nor `QueryDateAfter` parameters are specified, logs from the past 48 hours are retrieved. If you only specify one of two, logs are retrieved from a 2-day interval based on the date you provided. To retrieve logs beyond a 2-day interval, specify both parameters.

+ For more information, see [About OMS](https://docs.outscale.com/en/userguide/About-OMS.html). operationId: ReadApiLogs requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadApiLogsRequest" examples: ex1: value: Filters: - QueryDateAfter: '2017-05-10' - QueryDateBefore: '2017-05-10' QueryIpAddresses: - 192.0.2.0 - 198.51.100.0 - schema: - "$ref": "#/components/schemas/ReadApiLogsRequest" + QueryDateAfter: '2017-05-10' + QueryDateBefore: '2017-05-10' responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadApiLogsResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Logs: - - AccountId: '123456789012' - CallDuration: 47 - QueryAccessKey: ABCDEFGHIJ0123456789 + - ResponseStatusCode: 200 + ResponseSize: 1887 + QueryPayloadRaw: "{}" QueryApiName: oapi + QueryIpAddress: 192.0.2.0 + QueryUserAgent: oAPI CLI v0.1 - 2018-09-28 + CallDuration: 47 + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 QueryApiVersion: '1.27' + AccountId: '123456789012' + QueryPayloadSize: 2 QueryCallName: ReadAccessKeys + QueryAccessKey: ABCDEFGHIJ0123456789 + QueryHeaderSize: 287 QueryDate: '2017-05-10T12:34:56.789Z' QueryHeaderRaw: 'Host: api.eu-west-2.outscale.com\nAccept: */*\nConnection: close\nUser-Agent: oAPI CLI v0.1 - 2018-09-28\nX-Osc-Date: 20170510T000000Z\nContent-Type: application/json; charset=utf-8\nAuthorization: *****\nContent-Length: 2\nAccept-Encoding: gzip, deflate\nX-Forwarded-For: 192.0.2.0' - QueryHeaderSize: 287 - QueryIpAddress: 192.0.2.0 - QueryPayloadRaw: "{}" - QueryPayloadSize: 2 - QueryUserAgent: oAPI CLI v0.1 - 2018-09-28 - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - ResponseSize: 1887 - ResponseStatusCode: 200 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadApiLogsResponse" description: The HTTP 200 response (OK). tags: - ApiLog "/ReadCas": - description: Gets information about one or more of your Client Certificate Authorities - (CAs). post: + description: Gets information about one or more of your Client Certificate Authorities + (CAs). operationId: ReadCas requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadCasRequest" examples: ex1: value: Filters: CaIds: - ca-fedcba0987654321fedcba0987654321 - schema: - "$ref": "#/components/schemas/ReadCasRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadCasResponse" examples: ex1: value: - Cas: - - CaFingerprint: 1234567890abcdef1234567890abcdef12345678 - CaId: ca-fedcba0987654321fedcba0987654321 - Description: CA example ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadCasResponse" + Cas: + - Description: CA example + CaId: ca-fedcba0987654321fedcba0987654321 + CaFingerprint: 1234567890abcdef1234567890abcdef12345678 description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -18859,49 +19123,51 @@ paths: tags: - Ca "/ReadCatalog": - description: Returns the price list of OUTSCALE services for the current Region. post: + description: Returns the price list of OUTSCALE services for the current Region. operationId: ReadCatalog requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadCatalogRequest" examples: ex1: value: {} - schema: - "$ref": "#/components/schemas/ReadCatalogRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadCatalogResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Catalog: Entries: - - Category: compute - Operation: RunInstances-OD - Service: TinaOS-FCU - SubregionName: eu-west-2 + - UnitPrice: 0.04 + Type: CustomCore:v5-p1 Title: Instance - On demand - Unite de vCore pour une instance Tina v5 CxRy Performance highest - par heure - Type: CustomCore:v5-p1 - UnitPrice: 0.04 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadCatalogResponse" + SubregionName: eu-west-2 + Category: compute + Service: TinaOS-FCU + Operation: RunInstances-OD description: The HTTP 200 response (OK). tags: - Catalog "/ReadCatalogs": - description: Returns the price list of OUTSCALE services for the current Region - within a specific time period. post: + description: Returns the price list of OUTSCALE services for the current Region + within a specific time period. operationId: ReadCatalogs requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadCatalogsRequest" examples: ex1: value: @@ -18909,41 +19175,41 @@ paths: CurrentCatalogOnly: true FromDate: '2021-01-01' ToDate: '2023-01-01' - schema: - "$ref": "#/components/schemas/ReadCatalogsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadCatalogsResponse" examples: ex1: value: - Catalogs: - - Entries: - - Category: compute - Operation: RunInstances-OD - Service: TinaOS-FCU - SubregionName: eu-west-2 - Title: Instance - On demand - Unite de vCore pour une instance - Tina v5 CxRy Performance highest - par heure - Type: CustomCore:v5-p1 - UnitPrice: 0.04 - FromDate: 2021-01-01 00:00:00.000000000 +00:00 - State: CURRENT ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadCatalogsResponse" + Catalogs: + - State: CURRENT + FromDate: 2021-01-01 00:00:00.000000000 +00:00 + Entries: + - UnitPrice: 0.04 + Type: CustomCore:v5-p1 + Title: Instance - On demand - Unite de vCore pour une instance + Tina v5 CxRy Performance highest - par heure + SubregionName: eu-west-2 + Category: compute + Service: TinaOS-FCU + Operation: RunInstances-OD description: The HTTP 200 response (OK). tags: - Catalog "/ReadClientGateways": - description: Lists one or more of your client gateways. post: + description: Lists one or more of your client gateways. operationId: ReadClientGateways requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadClientGatewaysRequest" examples: ex1: value: @@ -18958,59 +19224,57 @@ paths: PublicIps: - 192.0.2.0 - 198.51.100.0 - schema: - "$ref": "#/components/schemas/ReadClientGatewaysRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadClientGatewaysResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ClientGateways: - - BgpAsn: 65000 + - State: available + BgpAsn: 65000 + Tags: [] ClientGatewayId: cgw-12345678 ConnectionType: ipsec.1 PublicIp: 192.0.2.0 - State: available - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadClientGatewaysResponse" description: The HTTP 200 response (OK). tags: - ClientGateway "/ReadConsoleOutput": - description: |- - Gets the console output for a virtual machine (VM). This console is not in real-time. It is refreshed every two seconds and provides the most recent 64 KiB output.

- - **[IMPORTANT]**
- On Windows VMs, the console is handled only on the first boot. It returns no output after the first boot. post: + description: |- + Gets the console output for a virtual machine (VM). This console is not in real-time. It is refreshed every two seconds and provides the most recent 64 KiB output.

+ + **[IMPORTANT]**
+ On Windows VMs, the console is handled only on the first boot. It returns no output after the first boot. operationId: ReadConsoleOutput requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadConsoleOutputRequest" examples: ex1: value: VmId: i-12345678 - schema: - "$ref": "#/components/schemas/ReadConsoleOutputRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadConsoleOutputResponse" examples: ex1: value: - ConsoleOutput: "..." + VmId: i-12345678 ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - VmId: i-12345678 - schema: - "$ref": "#/components/schemas/ReadConsoleOutputResponse" + ConsoleOutput: "..." description: The HTTP 200 response (OK). '400': content: @@ -19033,62 +19297,64 @@ paths: tags: - Vm "/ReadConsumptionAccount": - description: Gets information about the consumption of your account for each billable - resource within the specified time period. post: + description: Gets information about the consumption of your account for each + billable resource within the specified time period. operationId: ReadConsumptionAccount requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadConsumptionAccountRequest" examples: ex1: value: FromDate: '2023-06-01' - ShowPrice: true ToDate: '2023-07-01' - schema: - "$ref": "#/components/schemas/ReadConsumptionAccountRequest" + ShowPrice: true responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadConsumptionAccountResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ConsumptionEntries: - - AccountId: '123456789012' - Category: compute - FromDate: 2023-06-01 00:00:00.000000000 +00:00 + - UnitPrice: 0.044 + Type: BoxUsage:tinav4.c1r1p2 Operation: RunInstances-OD - PayingAccountId: '123456789012' - Price: 61.248 - Service: TinaOS-FCU SubregionName: eu-west-2a + Value: 1392 Title: Instance - On demand - tinav4.c1r1 high performance - par heure + Category: compute ToDate: 2023-06-30 00:00:00.000000000 +00:00 - Type: BoxUsage:tinav4.c1r1p2 - UnitPrice: 0.044 - Value: 1392 + Service: TinaOS-FCU + AccountId: '123456789012' + PayingAccountId: '123456789012' + FromDate: 2023-06-01 00:00:00.000000000 +00:00 + Price: 61.248 Currency: EUR - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadConsumptionAccountResponse" description: The HTTP 200 response (OK). tags: - Account "/ReadDedicatedGroups": - description: |- - > [WARNING]
- > This feature is currently in beta.
- - List one or more dedicated groups of virtual machines (VMs). post: + description: |- + > [WARNING]
+ > This feature is currently in beta.
+ + List one or more dedicated groups of virtual machines (VMs). operationId: ReadDedicatedGroups requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadDedicatedGroupsRequest" examples: ex1: summary: Filtering on a specific dedicated group @@ -19100,32 +19366,30 @@ paths: summary: Filtering on a specific Subregion and CPU generation value: Filters: - CpuGenerations: - - 4 SubregionNames: - eu-west-2a - schema: - "$ref": "#/components/schemas/ReadDedicatedGroupsRequest" + CpuGenerations: + - 4 responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadDedicatedGroupsResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 DedicatedGroups: - - AccountId: '123456789012' + - VmIds: + - i-12345678 + NetIds: [] + AccountId: '123456789012' CpuGeneration: 4 - DedicatedGroupId: ded-12345678 Name: dedicated-group-example - NetIds: [] SubregionName: eu-west-2a - VmIds: - - i-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadDedicatedGroupsResponse" + DedicatedGroupId: ded-12345678 description: The HTTP 200 response (OK). '400': content: @@ -19148,12 +19412,15 @@ paths: tags: - DedicatedGroup "/ReadDhcpOptions": - description: Gets information about the content of one or more DHCP options sets. post: + description: Gets information about the content of one or more DHCP options + sets. operationId: ReadDhcpOptions requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadDhcpOptionsRequest" examples: ex1: value: @@ -19168,98 +19435,100 @@ paths: - 198.51.100.0 DomainNames: - example.com - schema: - "$ref": "#/components/schemas/ReadDhcpOptionsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadDhcpOptionsResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 DhcpOptionsSets: - - Default: false + - Tags: [] + NtpServers: + - 203.0.113.0 + - 203.0.113.1 + Default: false DhcpOptionsSetId: dopt-12345678 DomainName: example.com DomainNameServers: - 192.0.2.0 - 198.51.100.0 - NtpServers: - - 203.0.113.0 - - 203.0.113.1 - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadDhcpOptionsResponse" description: The HTTP 200 response (OK). tags: - DhcpOption "/ReadDirectLinkInterfaces": - description: Lists one or more of your DirectLink interfaces. post: + description: Lists one or more of your DirectLink interfaces. operationId: ReadDirectLinkInterfaces requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadDirectLinkInterfacesRequest" examples: ex1: value: Filters: DirectLinkInterfaceIds: - dxvif-12345678 - schema: - "$ref": "#/components/schemas/ReadDirectLinkInterfacesRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadDirectLinkInterfacesResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 DirectLinkInterfaces: - - AccountId: '123456789012' + - Vlan: 101 + OutscalePrivateIp: 172.16.0.4/30 + DirectLinkInterfaceId: dxvif-12345678 BgpAsn: 65000 + AccountId: '123456789012' ClientPrivateIp: 172.16.0.5/30 - DirectLinkId: dxcon-12345678 - DirectLinkInterfaceId: dxvif-12345678 + VirtualGatewayId: vgw-12345678 DirectLinkInterfaceName: MyDirectLinkInterface - InterfaceType: private - Location: PAR1 + DirectLinkId: dxcon-12345678 Mtu: 1500 - OutscalePrivateIp: 172.16.0.4/30 State: available - VirtualGatewayId: vgw-12345678 - Vlan: 101 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadDirectLinkInterfacesResponse" + InterfaceType: private + Location: PAR1 description: The HTTP 200 response (OK). tags: - DirectLinkInterface "/ReadDirectLinks": - description: Lists all DirectLinks in the Region. post: + description: Lists all DirectLinks in the Region. operationId: ReadDirectLinks requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadDirectLinksRequest" examples: ex1: value: Filters: DirectLinkIds: - dxcon-12345678 - schema: - "$ref": "#/components/schemas/ReadDirectLinksRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadDirectLinksResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 DirectLinks: - AccountId: '123456789012' Bandwidth: 1Gbps @@ -19268,21 +19537,19 @@ paths: Location: PAR1 RegionName: eu-west-2 State: available - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadDirectLinksResponse" description: The HTTP 200 response (OK). tags: - DirectLink "/ReadEntitiesLinkedToPolicy": - description: Lists all entities (account, users, or user groups) linked to a specific - managed policy. post: + description: Lists all entities (account, users, or user groups) linked to a + specific managed policy. operationId: ReadEntitiesLinkedToPolicy requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadEntitiesLinkedToPolicyRequest" examples: ex1: summary: Reading all entities linked to a specific policy @@ -19295,17 +19562,23 @@ paths: EntitiesType: - USER PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy - schema: - "$ref": "#/components/schemas/ReadEntitiesLinkedToPolicyRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadEntitiesLinkedToPolicyResponse" examples: ex1: summary: Reading all entities linked to a specific policy value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 PolicyEntities: + Users: + - Id: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 + Name: example-user + Orn: orn:ows:idauth::012345678910:user/example/user-example Groups: - Id: ug-12345678 Name: example-usergroup @@ -19314,68 +19587,62 @@ paths: ItemsCount: 3 MaxResultsLimit: 100 MaxResultsTruncated: false - Users: - - Id: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 - Name: example-user - Orn: orn:ows:idauth::012345678910:user/example/user-example - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Reading only users linked to a specific policy value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 PolicyEntities: Users: - Id: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 Name: example-user Orn: orn:ows:idauth::012345678910:user/example/user-example - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadEntitiesLinkedToPolicyResponse" description: The HTTP 200 response (OK). tags: - Policy "/ReadFlexibleGpuCatalog": - description: Lists all flexible GPUs available in the public catalog. post: + description: Lists all flexible GPUs available in the public catalog. operationId: ReadFlexibleGpuCatalog requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadFlexibleGpuCatalogRequest" examples: ex1: value: {} - schema: - "$ref": "#/components/schemas/ReadFlexibleGpuCatalogRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadFlexibleGpuCatalogResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 FlexibleGpuCatalog: - - Generations: + - VRam: 16000 + Generations: - v5 MaxCpu: 80 MaxRam: 512 ModelName: nvidia-p100 - VRam: 16000 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadFlexibleGpuCatalogResponse" description: The HTTP 200 response (OK). security: [] tags: - FlexibleGpu "/ReadFlexibleGpus": - description: Lists one or more flexible GPUs (fGPUs) allocated to your account. post: + description: Lists one or more flexible GPUs (fGPUs) allocated to your account. operationId: ReadFlexibleGpus requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadFlexibleGpusRequest" examples: ex1: value: @@ -19390,15 +19657,17 @@ paths: - nvidia-p100 States: - attached - schema: - "$ref": "#/components/schemas/ReadFlexibleGpusRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadFlexibleGpusResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 FlexibleGpus: - DeleteOnVmDeletion: true FlexibleGpuId: fgpu-12345678 @@ -19407,60 +19676,58 @@ paths: State: attached SubregionName: eu-west-2a VmId: i-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadFlexibleGpusResponse" description: The HTTP 200 response (OK). tags: - FlexibleGpu "/ReadImageExportTasks": - description: Lists one or more image export tasks. post: + description: Lists one or more image export tasks. operationId: ReadImageExportTasks requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadImageExportTasksRequest" examples: ex1: value: Filters: TaskIds: - image-export-12345678 - schema: - "$ref": "#/components/schemas/ReadImageExportTasksRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadImageExportTasksResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ImageExportTasks: - - Comment: Export of image ami-12345678 + - Tags: [] ImageId: ami-12345678 + TaskId: image-export-12345678 + Comment: Export of image ami-12345678 OsuExport: - DiskImageFormat: qcow2 - OsuBucket: BUCKET OsuPrefix: PREFIX/ami-12345678/ - Progress: 0 + OsuBucket: BUCKET + DiskImageFormat: qcow2 State: pending/queued - Tags: [] - TaskId: image-export-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadImageExportTasksResponse" + Progress: 0 description: The HTTP 200 response (OK). tags: - Image "/ReadImages": - description: Lists one or more OUTSCALE machine images (OMIs) you can use. post: + description: Lists one or more OUTSCALE machine images (OMIs) you can use. operationId: ReadImages requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadImagesRequest" examples: ex1: summary: Reading a specific image @@ -19477,110 +19744,108 @@ paths: ImageNames: - Ubuntu* - RockyLinux* - schema: - "$ref": "#/components/schemas/ReadImagesRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadImagesResponse" examples: ex1: summary: Reading a specific image value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Images: - - AccountId: '123456789012' - Architecture: x86_64 - BlockDeviceMappings: - - Bsu: - DeleteOnVmDeletion: true - SnapshotId: snap-12345678 - VolumeSize: 50 - VolumeType: standard - DeviceName: "/dev/sda1" - BootModes: - - legacy - CreationDate: '2010-10-01T12:34:56.789Z' - Description: '' - FileLocation: 123456789012/create-image-example - ImageId: ami-12345678 - ImageName: create-image-example - ImageType: machine - PermissionsToLaunch: - AccountIds: [] - GlobalPermission: false + - StateComment: {} + State: available + RootDeviceType: bsu + RootDeviceName: "/dev/sda1" ProductCodes: - '0001' - RootDeviceName: "/dev/sda1" - RootDeviceType: bsu - SecureBoot: false - State: available - StateComment: {} + PermissionsToLaunch: + GlobalPermission: false + AccountIds: [] + AccountId: '123456789012' Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Description: '' + ImageId: ami-12345678 + BlockDeviceMappings: + - DeviceName: "/dev/sda1" + Bsu: + VolumeType: standard + DeleteOnVmDeletion: true + VolumeSize: 50 + SnapshotId: snap-12345678 + BootModes: + - legacy + ImageType: machine + CreationDate: '2010-10-01T12:34:56.789Z' + SecureBoot: false + FileLocation: 123456789012/create-image-example + Architecture: x86_64 + ImageName: create-image-example ex2: summary: Reading Ubuntu and RockyLinux images created by Outscale value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Images: - - AccountAlias: Outscale + - StateComment: {} + State: available + RootDeviceType: bsu + RootDeviceName: "/dev/sda1" + ProductCodes: + - '0001' + PermissionsToLaunch: + GlobalPermission: true + AccountIds: [] AccountId: '123456789012' - Architecture: x86_64 + Tags: [] + Description: '' + ImageId: ami-12345678 BlockDeviceMappings: - - Bsu: + - DeviceName: "/dev/sda1" + Bsu: + VolumeType: standard DeleteOnVmDeletion: true - SnapshotId: snap-12345678 VolumeSize: 10 - VolumeType: standard - DeviceName: "/dev/sda1" + SnapshotId: snap-12345678 + ImageType: machine + AccountAlias: Outscale CreationDate: '2010-10-01T12:34:56.789Z' - Description: '' FileLocation: Outscale/Ubuntu-2010.10.01-0 - ImageId: ami-12345678 + Architecture: x86_64 ImageName: Ubuntu-2010.10.01-0 - ImageType: machine - PermissionsToLaunch: - AccountIds: [] - GlobalPermission: true + - StateComment: {} + State: available + RootDeviceType: bsu + RootDeviceName: "/dev/sda1" ProductCodes: - '0001' - RootDeviceName: "/dev/sda1" - RootDeviceType: bsu - State: available - StateComment: {} - Tags: [] - - AccountAlias: Outscale + PermissionsToLaunch: + GlobalPermission: true + AccountIds: [] AccountId: '123456789012' - Architecture: x86_64 + Tags: [] + Description: '' + ImageId: ami-12345678 BlockDeviceMappings: - - Bsu: + - DeviceName: "/dev/sda1" + Bsu: + VolumeType: standard DeleteOnVmDeletion: true - SnapshotId: snap-12345678 VolumeSize: 10 - VolumeType: standard - DeviceName: "/dev/sda1" + SnapshotId: snap-12345678 + ImageType: machine + AccountAlias: Outscale + CreationDate: '2010-10-01T12:34:56.789Z' BootModes: - legacy - CreationDate: '2010-10-01T12:34:56.789Z' - Description: '' + SecureBoot: false FileLocation: Outscale/RockyLinux-2010.10.01-0 - ImageId: ami-12345678 + Architecture: x86_64 ImageName: RockyLinux-2010.10.01-0 - ImageType: machine - PermissionsToLaunch: - AccountIds: [] - GlobalPermission: true - ProductCodes: - - '0001' - RootDeviceName: "/dev/sda1" - RootDeviceType: bsu - SecureBoot: false - State: available - StateComment: {} - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadImagesResponse" description: The HTTP 200 response (OK). '400': content: @@ -19603,14 +19868,16 @@ paths: tags: - Image "/ReadInternetServices": - description: |- - Lists one or more of your internet services.
- An internet service enables virtual machines (VMs) launched in a Net to connect to the Internet. It allows routing of incoming and outgoing Internet traffic and management of public IP addresses. post: + description: |- + Lists one or more of your internet services.
+ An internet service enables virtual machines (VMs) launched in a Net to connect to the Internet. It allows routing of incoming and outgoing Internet traffic and management of public IP addresses. operationId: ReadInternetServices requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadInternetServicesRequest" examples: ex1: value: @@ -19625,26 +19892,24 @@ paths: TagValues: - prod - test - schema: - "$ref": "#/components/schemas/ReadInternetServicesRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadInternetServicesResponse" examples: ex1: value: - InternetServices: - - InternetServiceId: igw-12345678 - NetId: vpc-12345678 - State: available - Tags: - - Key: env - Value: prod ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadInternetServicesResponse" + InternetServices: + - Tags: + - Value: prod + Key: env + State: available + NetId: vpc-12345678 + InternetServiceId: igw-12345678 description: The HTTP 200 response (OK). '400': content: @@ -19667,36 +19932,36 @@ paths: tags: - InternetService "/ReadKeypairs": - description: Lists one or more of your keypairs. post: + description: Lists one or more of your keypairs. operationId: ReadKeypairs requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadKeypairsRequest" examples: ex1: value: Filters: KeypairNames: - keypair-example - schema: - "$ref": "#/components/schemas/ReadKeypairsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadKeypairsResponse" examples: ex1: value: - Keypairs: - - KeypairFingerprint: 11:22:33:44:55:66:77:88:99:00:aa:bb:cc:dd:ee:ff - KeypairId: key-abcdef1234567890abcdef1234567890 - KeypairName: keypair-example - KeypairType: ssh-rsa ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadKeypairsResponse" + Keypairs: + - KeypairType: ssh-rsa + KeypairName: keypair-example + KeypairId: key-abcdef1234567890abcdef1234567890 + KeypairFingerprint: 11:22:33:44:55:66:77:88:99:00:aa:bb:cc:dd:ee:ff description: The HTTP 200 response (OK). '400': content: @@ -19719,12 +19984,14 @@ paths: tags: - Keypair "/ReadLinkedPolicies": - description: Lists the managed policies linked to a specified user. post: + description: Lists the managed policies linked to a specified user. operationId: ReadLinkedPolicies requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadLinkedPoliciesRequest" examples: ex1: value: @@ -19733,208 +20000,208 @@ paths: FirstItem: 1 ResultsPerPage: 30 UserName: example-user - schema: - "$ref": "#/components/schemas/ReadLinkedPoliciesRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadLinkedPoliciesResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 HasMoreItems: true - MaxResultsLimit: 30 - MaxResultsTruncated: false Policies: - - CreationDate: 2010-10-01 12:34:56.789000000 +00:00 + - PolicyName: example-user-policy + CreationDate: 2010-10-01 12:34:56.789000000 +00:00 LastModificationDate: 2010-10-01 12:34:56.789000000 +00:00 Orn: orn:ows:idauth::012345678910:policy/example/example-user-policy PolicyId: ABCDEFGHIJKLMNOPQRSTUVWXYZ01234 - PolicyName: example-user-policy - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadLinkedPoliciesResponse" + MaxResultsLimit: 30 + MaxResultsTruncated: false description: The HTTP 200 response (OK). tags: - Policy "/ReadListenerRules": - description: Lists one or more listener rules. By default, this action returns - the full list of listener rules for the account. post: + description: Lists one or more listener rules. By default, this action returns + the full list of listener rules for the account. operationId: ReadListenerRules requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadListenerRulesRequest" examples: ex1: value: Filters: ListenerRuleNames: - example-listener-rule - schema: - "$ref": "#/components/schemas/ReadListenerRulesRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadListenerRulesResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ListenerRules: - - Action: forward - HostNamePattern: "*.example.com" - ListenerId: 123456 - ListenerRuleId: 1234 - ListenerRuleName: example-listener-rule - Priority: 10 + - Priority: 10 VmIds: - i-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadListenerRulesResponse" + ListenerRuleName: example-listener-rule + Action: forward + ListenerId: 123456 + HostNamePattern: "*.example.com" + ListenerRuleId: 1234 description: The HTTP 200 response (OK). tags: - Listener "/ReadLoadBalancerTags": - description: Lists the tags associated with one or more specified load balancers. post: + description: Lists the tags associated with one or more specified load balancers. operationId: ReadLoadBalancerTags requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadLoadBalancerTagsRequest" examples: ex1: value: LoadBalancerNames: - private-lb-example - schema: - "$ref": "#/components/schemas/ReadLoadBalancerTagsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadLoadBalancerTagsResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Tags: - - Key: key1 + - Value: value1 LoadBalancerName: private-lb-example - Value: value1 - schema: - "$ref": "#/components/schemas/ReadLoadBalancerTagsResponse" + Key: key1 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - LoadBalancer "/ReadLoadBalancers": - description: Lists one or more load balancers and their attributes. post: + description: Lists one or more load balancers and their attributes. operationId: ReadLoadBalancers requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadLoadBalancersRequest" examples: ex1: value: Filters: LoadBalancerNames: - private* - schema: - "$ref": "#/components/schemas/ReadLoadBalancersRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadLoadBalancersResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 LoadBalancers: - - AccessLog: - IsEnabled: false - PublicationInterval: 60 - ApplicationStickyCookiePolicies: [] + - Tags: [] + SourceSecurityGroup: + SecurityGroupName: security-group-example + SecurityGroupAccountId: '123456789012' + SecuredCookies: false + PublicIp: 192.0.2.0 + Subnets: + - subnet-12345678 + NetId: vpc-12345678 BackendVmIds: [] + ApplicationStickyCookiePolicies: [] + SecurityGroups: + - sg-12345678 + LoadBalancerType: internet-facing + AccessLog: + PublicationInterval: 60 + IsEnabled: false DnsName: private-lb-example.123456789.eu-west-2.lbu.outscale.com HealthCheck: + UnhealthyThreshold: 2 + Timeout: 5 CheckInterval: 30 + Protocol: TCP HealthyThreshold: 10 Port: 80 - Protocol: TCP - Timeout: 5 - UnhealthyThreshold: 2 + LoadBalancerStickyCookiePolicies: [] + SubregionNames: + - eu-west-2a Listeners: - - BackendPort: 80 + - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate + BackendPort: 80 BackendProtocol: HTTP LoadBalancerPort: 443 LoadBalancerProtocol: HTTPS - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate LoadBalancerName: private-lb-example - LoadBalancerStickyCookiePolicies: [] - LoadBalancerType: internet-facing - NetId: vpc-12345678 - PublicIp: 192.0.2.0 - SecuredCookies: false - SecurityGroups: - - sg-12345678 - SourceSecurityGroup: - SecurityGroupAccountId: '123456789012' - SecurityGroupName: security-group-example - Subnets: - - subnet-12345678 - SubregionNames: - - eu-west-2a - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadLoadBalancersResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer "/ReadLocations": - description: |- - Lists the locations, corresponding to datacenters, where you can set up a DirectLink.

- For more information, see [About DirectLink](https://docs.outscale.com/en/userguide/About-DirectLink.html). post: + description: |- + Lists the locations, corresponding to datacenters, where you can set up a DirectLink.

+ For more information, see [About DirectLink](https://docs.outscale.com/en/userguide/About-DirectLink.html). operationId: ReadLocations requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadLocationsRequest" examples: ex1: value: {} - schema: - "$ref": "#/components/schemas/ReadLocationsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadLocationsResponse" examples: ex1: value: - Locations: - - Code: PAR1 - Name: Telehouse 3, France - - Code: PAR4 - Name: Equinix Pantin, France ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadLocationsResponse" + Locations: + - Name: Telehouse 3, France + Code: PAR1 + - Name: Equinix Pantin, France + Code: PAR4 description: The HTTP 200 response (OK). security: [] tags: - Location "/ReadManagedPoliciesLinkedToUserGroup": - description: Lists the managed policies linked to a specified group. post: + description: Lists the managed policies linked to a specified group. operationId: ReadManagedPoliciesLinkedToUserGroup requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadManagedPoliciesLinkedToUserGroupRequest" examples: ex1: value: @@ -19945,15 +20212,17 @@ paths: FirstItem: 1 ResultsPerPage: 30 UserGroupName: example-usergroup - schema: - "$ref": "#/components/schemas/ReadManagedPoliciesLinkedToUserGroupRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadManagedPoliciesLinkedToUserGroupResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 HasMoreItems: true MaxResultsLimit: 30 MaxResultsTruncated: true @@ -19963,20 +20232,18 @@ paths: Orn: orn:ows:idauth::012345678910:policy/example/example-user-policy PolicyId: ABCDEFGHIJKLMNOPQRSTUVWXYZ01234 PolicyName: example-policy - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadManagedPoliciesLinkedToUserGroupResponse" description: The HTTP 200 response (OK). tags: - Policy "/ReadNatServices": - description: Lists one or more network address translation (NAT) services. post: + description: Lists one or more network address translation (NAT) services. operationId: ReadNatServices requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadNatServicesRequest" examples: ex1: value: @@ -19991,28 +20258,26 @@ paths: - vpc-87654321 SubnetIds: - subnet-12345678 - schema: - "$ref": "#/components/schemas/ReadNatServicesRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadNatServicesResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 NatServices: - - NatServiceId: nat-12345678 - NetId: vpc-12345678 + - Tags: [] + SubnetId: subnet-12345678 + NatServiceId: nat-12345678 PublicIps: - - PublicIp: 192.0.2.0 - PublicIpId: eipalloc-12345678 + - PublicIpId: eipalloc-12345678 + PublicIp: 192.0.2.0 + NetId: vpc-12345678 State: available - SubnetId: subnet-12345678 - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadNatServicesResponse" description: The HTTP 200 response (OK). '400': content: @@ -20035,14 +20300,16 @@ paths: tags: - NatService "/ReadNetAccessPointServices": - description: |- - Lists OUTSCALE services available to create Net access points.
- For more information, see [CreateNetAccessPoint](#createnetaccesspoint). post: + description: |- + Lists OUTSCALE services available to create Net access points.
+ For more information, see [CreateNetAccessPoint](#createnetaccesspoint). operationId: ReadNetAccessPointServices requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadNetAccessPointServicesRequest" examples: ex1: summary: Listing one or more services according to their service IDs @@ -20057,54 +20324,54 @@ paths: Filters: ServiceNames: - com.outscale.eu-west-2.api - schema: - "$ref": "#/components/schemas/ReadNetAccessPointServicesRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadNetAccessPointServicesResponse" examples: ex1: summary: Listing one or more services according to their service IDs value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Services: - - IpRanges: - - 192.0.2.0 + - ServiceName: com.outscale.eu-west-2.api ServiceId: pl-12345678 - ServiceName: com.outscale.eu-west-2.api - - IpRanges: + IpRanges: + - 192.0.2.0 + - ServiceName: com.outscale.eu-west-2.oos + ServiceId: pl-87654321 + IpRanges: - 198.51.100.0 - 203.0.113.0 - 203.0.113.1 - ServiceId: pl-87654321 - ServiceName: com.outscale.eu-west-2.oos + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Listing one or more services according to their service names value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Services: - - IpRanges: - - 192.0.2.0 + - ServiceName: com.outscale.eu-west-2.api ServiceId: pl-12345678 - ServiceName: com.outscale.eu-west-2.api - schema: - "$ref": "#/components/schemas/ReadNetAccessPointServicesResponse" + IpRanges: + - 192.0.2.0 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). security: [] tags: - NetAccessPoint "/ReadNetAccessPoints": - description: Lists one or more Net access points. post: + description: Lists one or more Net access points. operationId: ReadNetAccessPoints requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadNetAccessPointsRequest" examples: ex1: value: @@ -20118,37 +20385,37 @@ paths: - vpc-12345678 States: - available - schema: - "$ref": "#/components/schemas/ReadNetAccessPointsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadNetAccessPointsResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 NetAccessPoints: - - NetAccessPointId: vpce-12345678 - NetId: vpc-12345678 + - Tags: [] + NetAccessPointId: vpce-12345678 RouteTableIds: - rtb-12345678 - ServiceName: com.outscale.eu-west-2.oos State: available - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadNetAccessPointsResponse" + NetId: vpc-12345678 + ServiceName: com.outscale.eu-west-2.oos description: The HTTP 200 response (OK). tags: - NetAccessPoint "/ReadNetPeerings": - description: Lists one or more peering connections between two Nets. post: + description: Lists one or more peering connections between two Nets. operationId: ReadNetPeerings requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadNetPeeringsRequest" examples: ex1: value: @@ -20163,33 +20430,31 @@ paths: StateNames: - active - pending-acceptance - schema: - "$ref": "#/components/schemas/ReadNetPeeringsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadNetPeeringsResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 NetPeerings: - - AccepterNet: - AccountId: '123456789012' - IpRange: 172.16.0.0/16 + - Tags: [] + State: + Name: active + Message: Active + AccepterNet: NetId: vpc-12345678 - NetPeeringId: pcx-12345678 - SourceNet: + IpRange: 172.16.0.0/16 AccountId: '123456789012' - IpRange: 10.0.0.0/16 + SourceNet: NetId: vpc-12345678 - State: - Message: Active - Name: active - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadNetPeeringsResponse" + IpRange: 10.0.0.0/16 + AccountId: '123456789012' + NetPeeringId: pcx-12345678 description: The HTTP 200 response (OK). '400': content: @@ -20212,12 +20477,14 @@ paths: tags: - NetPeering "/ReadNets": - description: Lists one or more Nets. post: + description: Lists one or more Nets. operationId: ReadNets requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadNetsRequest" examples: ex1: value: @@ -20229,26 +20496,24 @@ paths: Filters: States: - available - schema: - "$ref": "#/components/schemas/ReadNetsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadNetsResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Nets: - - DhcpOptionsSetId: dopt-12345678 + - Tags: [] + DhcpOptionsSetId: dopt-12345678 IpRange: 10.0.0.0/16 + Tenancy: default NetId: vpc-12345678 State: available - Tags: [] - Tenancy: default - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadNetsResponse" description: The HTTP 200 response (OK). '400': content: @@ -20271,14 +20536,16 @@ paths: tags: - Net "/ReadNics": - description: |- - Lists one or more network interface cards (NICs).
- A NIC is a virtual network interface that you can attach to a virtual machine (VM) in a Net. post: + description: |- + Lists one or more network interface cards (NICs).
+ A NIC is a virtual network interface that you can attach to a virtual machine (VM) in a Net. operationId: ReadNics requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadNicsRequest" examples: ex1: value: @@ -20290,45 +20557,43 @@ paths: Filters: LinkNicVmIds: - i-12345678 - schema: - "$ref": "#/components/schemas/ReadNicsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadNicsResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Nics: - - AccountId: '123456789012' - Description: Primary network interface - IsSourceDestChecked: true + - SubregionName: eu-west-2a + SubnetId: subnet-12345678 + State: in-use LinkNic: + VmId: i-12345678 + LinkNicId: eni-attach-12345678 + VmAccountId: '123456789012' DeleteOnVmDeletion: false DeviceNumber: 0 - LinkNicId: eni-attach-12345678 State: attached - VmAccountId: '123456789012' - VmId: i-12345678 + IsSourceDestChecked: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + Tags: [] + Description: Primary network interface + AccountId: '123456789012' + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - IsPrimary: true - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - SecurityGroups: - - SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - State: in-use - SubnetId: subnet-12345678 - SubregionName: eu-west-2a - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadNicsResponse" + IsPrimary: true description: The HTTP 200 response (OK). '400': content: @@ -20351,12 +20616,14 @@ paths: tags: - Nic "/ReadPolicies": - description: Lists all the managed policies available for your account. post: + description: Lists all the managed policies available for your account. operationId: ReadPolicies requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadPoliciesRequest" examples: ex1: value: @@ -20366,259 +20633,259 @@ paths: Scope: OWS FirstItem: 1 ResultsPerPage: 30 - schema: - "$ref": "#/components/schemas/ReadPoliciesRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadPoliciesResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 HasMoreItems: true - MaxResultsLimit: 30 - MaxResultsTruncated: false Policies: - - CreationDate: 2010-10-01 12:34:56.789000000 +00:00 + - ResourcesCount: 1 + PolicyName: example-user-policy + PolicyDefaultVersionId: v1 + Path: "/example/" + CreationDate: 2010-10-01 12:34:56.789000000 +00:00 Description: Example of description + PolicyId: ABCDEFGHIJKLMNOPQRSTUVWXYZ01234 + Orn: orn:ows:idauth::012345678910:policy/example/example-user-policy IsLinkable: true LastModificationDate: 2010-10-01 12:34:56.789000000 +00:00 - Orn: orn:ows:idauth::012345678910:policy/example/example-user-policy - Path: "/example/" - PolicyDefaultVersionId: v1 - PolicyId: ABCDEFGHIJKLMNOPQRSTUVWXYZ01234 - PolicyName: example-user-policy - ResourcesCount: 1 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadPoliciesResponse" + MaxResultsLimit: 30 + MaxResultsTruncated: false description: The HTTP 200 response (OK). tags: - Policy "/ReadPolicy": - description: Lists information about a specified managed policy. post: + description: Lists information about a specified managed policy. operationId: ReadPolicy requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadPolicyRequest" examples: ex1: value: PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy - schema: - "$ref": "#/components/schemas/ReadPolicyRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadPolicyResponse" examples: ex1: value: Policy: + ResourcesCount: 0 + PolicyName: example-user-policy + PolicyDefaultVersionId: v1 + Path: "/example/" CreationDate: 2010-10-01 12:34:56.789000000 +00:00 Description: Example of description + PolicyId: ABCDEFGHIJKLMNOPQRSTUVWXYZ01234 + Orn: orn:ows:idauth::012345678910:policy/example/example-user-policy IsLinkable: true LastModificationDate: 2010-10-01 12:34:56.789000000 +00:00 - Orn: orn:ows:idauth::012345678910:policy/example/example-user-policy - Path: "/example/" - PolicyDefaultVersionId: v1 - PolicyId: ABCDEFGHIJKLMNOPQRSTUVWXYZ01234 - PolicyName: example-user-policy - ResourcesCount: 0 ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadPolicyResponse" description: The HTTP 200 response (OK). tags: - Policy "/ReadPolicyVersion": - description: Lists information about a specified version of a managed policy. post: + description: Lists information about a specified version of a managed policy. operationId: ReadPolicyVersion requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadPolicyVersionRequest" examples: ex1: value: PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy VersionId: v1 - schema: - "$ref": "#/components/schemas/ReadPolicyVersionRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadPolicyVersionResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 PolicyVersion: + VersionId: v1 + DefaultVersion: true + CreationDate: 2010-10-01 12:34:56.789000000 +00:00 Body: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], "Resource": ["*"]} ]}' - CreationDate: 2010-10-01 12:34:56.789000000 +00:00 - DefaultVersion: true - VersionId: v1 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadPolicyVersionResponse" description: The HTTP 200 response (OK). tags: - Policy "/ReadPolicyVersions": - description: Lists information about all the policy versions of a specified managed - policy. post: + description: Lists information about all the policy versions of a specified + managed policy. operationId: ReadPolicyVersions requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadPolicyVersionsRequest" examples: ex1: value: FirstItem: 1 PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy ResultsPerPage: 30 - schema: - "$ref": "#/components/schemas/ReadPolicyVersionsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadPolicyVersionsResponse" examples: ex1: value: - HasMoreItems: true MaxResultsLimit: 30 - PolicyVersions: - - Body: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], - "Resource": ["*"]} ]}' - CreationDate: 2010-10-01 12:34:56.789000000 +00:00 - DefaultVersion: true - VersionId: v1 ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadPolicyVersionsResponse" + PolicyVersions: + - VersionId: v1 + DefaultVersion: true + CreationDate: 2010-10-01 12:34:56.789000000 +00:00 + Body: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], + "Resource": ["*"]} ]}' + HasMoreItems: true description: The HTTP 200 response (OK). tags: - Policy "/ReadProductTypes": - description: Lists one or more product types. post: + description: Lists one or more product types. operationId: ReadProductTypes requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadProductTypesRequest" examples: ex1: value: Filters: ProductTypeIds: - '0001' - schema: - "$ref": "#/components/schemas/ReadProductTypesRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadProductTypesResponse" examples: ex1: value: - ProductTypes: - - Description: Linux - ProductTypeId: '0001' ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadProductTypesResponse" + ProductTypes: + - ProductTypeId: '0001' + Description: Linux description: The HTTP 200 response (OK). security: [] tags: - ProductType "/ReadPublicCatalog": - description: Returns the price list of OUTSCALE products and services for the - Region specified in the endpoint of the request. For more information, see [About - Regions and Subregions](https://docs.outscale.com/en/userguide/About-Regions-and-Subregions.html). post: + description: Returns the price list of OUTSCALE products and services for the + Region specified in the endpoint of the request. For more information, see + [About Regions and Subregions](https://docs.outscale.com/en/userguide/About-Regions-and-Subregions.html). operationId: ReadPublicCatalog requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadPublicCatalogRequest" examples: ex1: value: {} - schema: - "$ref": "#/components/schemas/ReadPublicCatalogRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadPublicCatalogResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Catalog: Entries: - - Category: compute - Operation: RunInstances-OD - Service: TinaOS-FCU - SubregionName: eu-west-2 + - UnitPrice: 0.04 + Type: CustomCore:v5-p1 Title: Instance - On demand - Unite de vCore pour une instance Tina v5 CxRy Performance highest - par heure - Type: CustomCore:v5-p1 - UnitPrice: 0.04 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadPublicCatalogResponse" + SubregionName: eu-west-2 + Category: compute + Service: TinaOS-FCU + Operation: RunInstances-OD description: The HTTP 200 response (OK). security: [] tags: - PublicCatalog "/ReadPublicIpRanges": - description: Gets the public IPv4 addresses in CIDR notation for the Region specified - in the endpoint of the request. For more information, see [About Regions and - Subregions](https://docs.outscale.com/en/userguide/About-Regions-and-Subregions.html). post: + description: Gets the public IPv4 addresses in CIDR notation for the Region + specified in the endpoint of the request. For more information, see [About + Regions and Subregions](https://docs.outscale.com/en/userguide/About-Regions-and-Subregions.html). operationId: ReadPublicIpRanges requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadPublicIpRangesRequest" examples: ex1: value: {} - schema: - "$ref": "#/components/schemas/ReadPublicIpRangesRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadPublicIpRangesResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 PublicIps: - 198.51.100.0/24 - 203.0.113.0/24 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadPublicIpRangesResponse" description: The HTTP 200 response (OK). security: [] tags: - PublicIp "/ReadPublicIps": - description: |- - Lists one or more public IPs allocated to your account.
- By default, this action returns information about all your public IPs: available or associated with a virtual machine (VM), a network interface card (NIC) or a NAT service. post: + description: |- + Lists one or more public IPs allocated to your account.
+ By default, this action returns information about all your public IPs: available or associated with a virtual machine (VM), a network interface card (NIC) or a NAT service. operationId: ReadPublicIps requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadPublicIpsRequest" examples: ex1: value: @@ -20630,28 +20897,26 @@ paths: Filters: VmIds: - i-12345678 - schema: - "$ref": "#/components/schemas/ReadPublicIpsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadPublicIpsResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 PublicIps: - - LinkPublicIpId: eipassoc-12345678 + - VmId: i-12345678 + Tags: [] + PublicIpId: eipalloc-12345678 + PublicIp: 192.0.2.0 + LinkPublicIpId: eipassoc-12345678 NicAccountId: '123456789012' NicId: eni-12345678 PrivateIp: 10.0.0.4 - PublicIp: 192.0.2.0 - PublicIpId: eipalloc-12345678 - Tags: [] - VmId: i-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadPublicIpsResponse" description: The HTTP 200 response (OK). '400': content: @@ -20674,14 +20939,16 @@ paths: tags: - PublicIp "/ReadQuotas": - description: |- - Lists one or more of your quotas.

- For more information, see [About Your Account](https://docs.outscale.com/en/userguide/About-Your-Account.html). post: + description: |- + Lists one or more of your quotas.

+ For more information, see [About Your Account](https://docs.outscale.com/en/userguide/About-Your-Account.html). operationId: ReadQuotas requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadQuotasRequest" examples: ex1: summary: Reading specific quota @@ -20695,102 +20962,102 @@ paths: Filters: Collections: - VPC - schema: - "$ref": "#/components/schemas/ReadQuotasRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadQuotasResponse" examples: ex1: summary: Reading specific quota value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 QuotaTypes: - - QuotaType: global - Quotas: - - AccountId: '123456789012' + - Quotas: + - ShortDescription: Load Balancer Limit + QuotaCollection: LBU + AccountId: '123456789012' Description: Maximum number of load balancers per region MaxValue: 20 - Name: lb_limit - QuotaCollection: LBU - ShortDescription: Load Balancer Limit UsedValue: 0 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Name: lb_limit + QuotaType: global ex2: summary: Reading collection of quotas value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 QuotaTypes: - - QuotaType: global - Quotas: - - AccountId: '123456789012' + - Quotas: + - ShortDescription: Example Limit + QuotaCollection: VPC + AccountId: '123456789012' Description: Maximum number of examples MaxValue: 5 + UsedValue: 0 Name: example_limit + QuotaType: global + - Quotas: + - ShortDescription: Other Example Limit QuotaCollection: VPC - ShortDescription: Example Limit - UsedValue: 0 - - QuotaType: vpc-12345678 - Quotas: - - AccountId: '123456789012' + AccountId: '123456789012' Description: Maximum number of other examples MaxValue: 50 - Name: other_example_limit - QuotaCollection: VPC - ShortDescription: Other Example Limit UsedValue: 1 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadQuotasResponse" + Name: other_example_limit + QuotaType: vpc-12345678 description: The HTTP 200 response (OK). tags: - Quota "/ReadRegions": - description: |- - Lists one or more Regions of the OUTSCALE Cloud.

- For more information, see [About Regions and Subregions](https://docs.outscale.com/en/userguide/About-Regions-and-Subregions.html). post: + description: |- + Lists one or more Regions of the OUTSCALE Cloud.

+ For more information, see [About Regions and Subregions](https://docs.outscale.com/en/userguide/About-Regions-and-Subregions.html). operationId: ReadRegions requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadRegionsRequest" examples: ex1: value: {} - schema: - "$ref": "#/components/schemas/ReadRegionsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadRegionsResponse" examples: ex1: value: - Regions: - - Endpoint: api.eu-west-2.outscale.com - RegionName: eu-west-2 - - Endpoint: api.us-east-2.outscale.com - RegionName: us-east-2 - - Endpoint: api.us-west-1.outscale.com - RegionName: us-west-1 ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadRegionsResponse" + Regions: + - RegionName: eu-west-2 + Endpoint: api.eu-west-2.outscale.com + - RegionName: us-east-2 + Endpoint: api.us-east-2.outscale.com + - RegionName: us-west-1 + Endpoint: api.us-west-1.outscale.com description: The HTTP 200 response (OK). security: [] tags: - Region "/ReadRouteTables": - description: |- - Lists one or more of your route tables.
- In your Net, each Subnet must be associated with a route table. If a Subnet is not explicitly associated with a route table, it is implicitly associated with the main route table of the Net. post: + description: |- + Lists one or more of your route tables.
+ In your Net, each Subnet must be associated with a route table. If a Subnet is not explicitly associated with a route table, it is implicitly associated with the main route table of the Net. operationId: ReadRouteTables requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadRouteTablesRequest" examples: ex1: value: @@ -20800,37 +21067,35 @@ paths: ex2: value: Filters: - LinkRouteTableMain: true NetIds: - vpc-12345678 - vpc-87654321 - schema: - "$ref": "#/components/schemas/ReadRouteTablesRequest" + LinkRouteTableMain: true responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadRouteTablesResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 RouteTables: - - LinkRouteTables: - - LinkRouteTableId: rtbassoc-12345678 - Main: true - NetId: vpc-12345678 + - Routes: + - DestinationIpRange: 10.0.0.0/16 + CreationMethod: CreateRouteTable + State: active + LinkRouteTables: + - Main: true + LinkRouteTableId: rtbassoc-12345678 RouteTableId: rtb-12345678 + NetId: vpc-12345678 NetId: vpc-12345678 + Tags: [] RoutePropagatingVirtualGateways: [] RouteTableId: rtb-12345678 - Routes: - - CreationMethod: CreateRouteTable - DestinationIpRange: 10.0.0.0/16 - State: active - Tags: [] - schema: - "$ref": "#/components/schemas/ReadRouteTablesResponse" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -20853,14 +21118,16 @@ paths: tags: - RouteTable "/ReadSecurityGroups": - description: |- - Lists one or more security groups.
- You can specify either the name of the security groups or their IDs. post: + description: |- + Lists one or more security groups.
+ You can specify either the name of the security groups or their IDs. operationId: ReadSecurityGroups requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadSecurityGroupsRequest" examples: ex1: value: @@ -20872,39 +21139,37 @@ paths: Filters: InboundRuleIpRanges: - 192.0.2.0 - schema: - "$ref": "#/components/schemas/ReadSecurityGroupsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadSecurityGroupsResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 SecurityGroups: - - AccountId: '123456789012' + - Tags: [] + SecurityGroupName: security-group-example + OutboundRules: + - FromPortRange: -1 + IpProtocol: "-1" + ToPortRange: -1 + IpRanges: + - 0.0.0.0/0 + SecurityGroupId: sg-12345678 + AccountId: '123456789012' Description: Example of security group InboundRules: - FromPortRange: 22 IpProtocol: tcp + ToPortRange: 22 IpRanges: - 192.0.2.0 - 198.51.100.0 - ToPortRange: 22 NetId: vpc-12345678 - OutboundRules: - - FromPortRange: -1 - IpProtocol: "-1" - IpRanges: - - 0.0.0.0/0 - ToPortRange: -1 - SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - Tags: [] - schema: - "$ref": "#/components/schemas/ReadSecurityGroupsResponse" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -20927,87 +21192,89 @@ paths: tags: - SecurityGroup "/ReadServerCertificates": - description: Lists your server certificates. post: + description: Lists your server certificates. operationId: ReadServerCertificates requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadServerCertificatesRequest" examples: ex1: value: Filters: Paths: - "/example/" - schema: - "$ref": "#/components/schemas/ReadServerCertificatesRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadServerCertificatesResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ServerCertificates: - - Id: ABCDEFGHIJKLMNOPQRSTUVWXYZ1234 - Name: server-cert-example + - Path: "/example/" + Id: ABCDEFGHIJKLMNOPQRSTUVWXYZ1234 Orn: orn:ows:idauth::012345678910:server-certificate/example/server-cert-example - Path: "/example/" - schema: - "$ref": "#/components/schemas/ReadServerCertificatesResponse" + Name: server-cert-example + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - ServerCertificate "/ReadSnapshotExportTasks": - description: Lists one or more snapshot export tasks. post: + description: Lists one or more snapshot export tasks. operationId: ReadSnapshotExportTasks requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadSnapshotExportTasksRequest" examples: ex1: value: Filters: TaskIds: - snap-export-12345678 - schema: - "$ref": "#/components/schemas/ReadSnapshotExportTasksRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadSnapshotExportTasksResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 SnapshotExportTasks: - - Comment: Export of snapshot snap-12345678 + - Tags: [] + TaskId: snap-export-12345678 + Comment: Export of snapshot snap-12345678 OsuExport: - DiskImageFormat: qcow2 - OsuBucket: BUCKET OsuPrefix: PREFIX - Progress: 99 - SnapshotId: snap-12345678 + OsuBucket: BUCKET + DiskImageFormat: qcow2 State: pending - Tags: [] - TaskId: snap-export-12345678 - schema: - "$ref": "#/components/schemas/ReadSnapshotExportTasksResponse" + SnapshotId: snap-12345678 + Progress: 99 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - Snapshot "/ReadSnapshots": - description: Lists one or more snapshots that are available to you and the permissions - to create volumes from them. post: + description: Lists one or more snapshots that are available to you and the permissions + to create volumes from them. operationId: ReadSnapshots requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadSnapshotsRequest" examples: ex1: value: @@ -21022,51 +21289,49 @@ paths: TagValues: - prod - test - schema: - "$ref": "#/components/schemas/ReadSnapshotsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadSnapshotsResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Snapshots: - - AccountId: '123456789012' + - VolumeSize: 10 + AccountId: '123456789012' + VolumeId: vol-12345678 CreationDate: '2010-10-01T12:34:56.789Z' - Description: Snapshot created from a volume PermissionsToCreateVolume: - AccountIds: [] GlobalPermission: false + AccountIds: [] Progress: 100 SnapshotId: snap-12345678 State: completed + Description: Snapshot created from a volume Tags: [] - VolumeId: vol-12345678 - VolumeSize: 10 - ex2: - value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + value: Snapshots: - - AccountId: '123456789012' + - VolumeSize: 10 + AccountId: '123456789012' + VolumeId: vol-12345678 CreationDate: '2010-10-01T12:34:56.789Z' - Description: Test snapshot PermissionsToCreateVolume: - AccountIds: [] GlobalPermission: false + AccountIds: [] Progress: 100 SnapshotId: snap-12345678 State: completed + Description: Test snapshot Tags: - - Key: env - Value: test - VolumeId: vol-12345678 - VolumeSize: 10 - schema: - "$ref": "#/components/schemas/ReadSnapshotsResponse" + - Value: test + Key: env + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -21089,14 +21354,16 @@ paths: tags: - Snapshot "/ReadSubnets": - description: |- - Lists one or more of your Subnets.
- If you do not specify any Subnet ID, this action describes all of your Subnets. post: + description: |- + Lists one or more of your Subnets.
+ If you do not specify any Subnet ID, this action describes all of your Subnets. operationId: ReadSubnets requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadSubnetsRequest" examples: ex1: value: @@ -21111,28 +21378,26 @@ paths: - pending SubregionNames: - eu-west-2a - schema: - "$ref": "#/components/schemas/ReadSubnetsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadSubnetsResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Subnets: - - AvailableIpsCount: 16379 + - Tags: [] + SubregionName: eu-west-2a + SubnetId: subnet-12345678 + AvailableIpsCount: 16379 IpRange: 10.0.0.0/18 MapPublicIpOnLaunch: false - NetId: vpc-12345678 State: available - SubnetId: subnet-12345678 - SubregionName: eu-west-2a - Tags: [] - schema: - "$ref": "#/components/schemas/ReadSubnetsResponse" + NetId: vpc-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -21155,15 +21420,17 @@ paths: tags: - Subnet "/ReadSubregions": - description: |- - Lists one or more of the enabled Subregions that you can access in the current Region.

- - For more information, see [About Regions and Subregions](https://docs.outscale.com/en/userguide/About-Regions-and-Subregions.html). post: + description: |- + Lists one or more of the enabled Subregions that you can access in the current Region.

+ + For more information, see [About Regions and Subregions](https://docs.outscale.com/en/userguide/About-Regions-and-Subregions.html). operationId: ReadSubregions requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadSubregionsRequest" examples: ex1: summary: Listing a specific Subregion in the current Region @@ -21178,75 +21445,73 @@ paths: SubregionNames: - eu-west-2a - eu-west-2b - schema: - "$ref": "#/components/schemas/ReadSubregionsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadSubregionsResponse" examples: ex1: summary: Listing a specific Subregion in the current Region value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Subregions: - - LocationCode: PAR1 + - State: available RegionName: eu-west-2 - State: available SubregionName: eu-west-2a + LocationCode: PAR1 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Listing two specific Subregions in the current Region value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Subregions: - - LocationCode: PAR1 + - State: available RegionName: eu-west-2 - State: available SubregionName: eu-west-2a - - LocationCode: PAR4 + LocationCode: PAR1 + - State: available RegionName: eu-west-2 - State: available SubregionName: eu-west-2b - schema: - "$ref": "#/components/schemas/ReadSubregionsResponse" + LocationCode: PAR4 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - Subregion "/ReadTags": - description: Lists one or more tags for your resources. post: + description: Lists one or more tags for your resources. operationId: ReadTags requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadTagsRequest" examples: ex1: value: Filters: - Keys: - - key1 ResourceTypes: - snapshot - schema: - "$ref": "#/components/schemas/ReadTagsRequest" + Keys: + - key1 responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadTagsResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Tags: - - Key: key1 - ResourceId: snap-12345678 + - Value: value1 ResourceType: snapshot - Value: value1 - schema: - "$ref": "#/components/schemas/ReadTagsResponse" + ResourceId: snap-12345678 + Key: key1 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -21269,59 +21534,61 @@ paths: tags: - Tag "/ReadUnitPrice": - description: Gets unit price information for the specified parameters. post: + description: Gets unit price information for the specified parameters. operationId: ReadUnitPrice requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadUnitPriceRequest" examples: ex1: value: Operation: CreateVolume Service: TinaOS-FCU Type: BSU:VolumeIOPS:io1 - schema: - "$ref": "#/components/schemas/ReadUnitPriceRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadUnitPriceResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 UnitPriceEntry: + UnitPrice: 0.01 + Unit: PER_IOPS_PER_MONTH Currency: EUR Operation: CreateVolume - Service: TinaOS-FCU Type: BSU:VolumeIOPS:io1 - Unit: PER_IOPS_PER_MONTH - UnitPrice: 0.01 - schema: - "$ref": "#/components/schemas/ReadUnitPriceResponse" + Service: TinaOS-FCU description: The HTTP 200 response (OK). tags: - Catalog "/ReadUserGroup": - description: Lists information about a specified user group, including its users. post: + description: Lists information about a specified user group, including its users. operationId: ReadUserGroup requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadUserGroupRequest" examples: ex1: value: Path: "/example/" UserGroupName: example-usergroup - schema: - "$ref": "#/components/schemas/ReadUserGroupRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadUserGroupResponse" examples: ex1: value: @@ -21341,18 +21608,18 @@ paths: UserEmail: user@example.com UserId: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 UserName: example-user - schema: - "$ref": "#/components/schemas/ReadUserGroupResponse" description: The HTTP 200 response (OK). tags: - UserGroup "/ReadUserGroupPolicies": - description: Lists the names of the inline policies embedded in a specific group. post: + description: Lists the names of the inline policies embedded in a specific group. operationId: ReadUserGroupPolicies requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadUserGroupPoliciesRequest" examples: ex1: value: @@ -21360,15 +21627,17 @@ paths: ResultsPerPage: 30 UserGroupName: example-usergroup UserGroupPath: "/example/" - schema: - "$ref": "#/components/schemas/ReadUserGroupPoliciesRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadUserGroupPoliciesResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 HasMoreItems: true MaxResultsLimit: 30 MaxResultsTruncated: true @@ -21376,56 +21645,54 @@ paths: - Body: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], "Resource": ["*"]} ]}' Name: example-policy - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadUserGroupPoliciesResponse" description: The HTTP 200 response (OK). tags: - Policy "/ReadUserGroupPolicy": - description: Returns information about an inline policy included in a specified - group. post: + description: Returns information about an inline policy included in a specified + group. operationId: ReadUserGroupPolicy requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadUserGroupPolicyRequest" examples: ex1: value: PolicyName: example-policy UserGroupName: example-usergroup UserGroupPath: "/example/" - schema: - "$ref": "#/components/schemas/ReadUserGroupPolicyRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadUserGroupPolicyResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Policy: Body: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], "Resource": ["*"]} ]}' Name: example-policy - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadUserGroupPolicyResponse" description: The HTTP 200 response (OK). tags: - Policy "/ReadUserGroups": - description: |- - Lists all the user groups of the account.
- The response can be filtered using either the PathPrefix or the UserGroupIds. post: + description: |- + Lists all the user groups of the account.
+ The response can be filtered using either the PathPrefix or the UserGroupIds. operationId: ReadUserGroups requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadUserGroupsRequest" examples: ex1: value: @@ -21435,20 +21702,20 @@ paths: - ug-12345678 FirstItem: 1 ResultsPerPage: 30 - schema: - "$ref": "#/components/schemas/ReadUserGroupsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadUserGroupsResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 HasMoreItems: true MaxResultsLimit: 30 MaxResultsTruncated: true - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 UserGroups: - CreationDate: '2010-10-01T12:34:56.789Z' LastModificationDate: '2010-10-01T12:34:56.789Z' @@ -21456,29 +21723,29 @@ paths: Orn: orn:ows:idauth::012345678910:usergroup/example/usergroup-example Path: "/example/" UserGroupId: ug-12345678 - schema: - "$ref": "#/components/schemas/ReadUserGroupsResponse" description: The HTTP 200 response (OK). tags: - UserGroup "/ReadUserGroupsPerUser": - description: Lists the groups a specified user belongs to. post: + description: Lists the groups a specified user belongs to. operationId: ReadUserGroupsPerUser requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadUserGroupsPerUserRequest" examples: ex1: value: UserName: example-user UserPath: "/example/" - schema: - "$ref": "#/components/schemas/ReadUserGroupsPerUserRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadUserGroupsPerUserResponse" examples: ex1: value: @@ -21491,28 +21758,28 @@ paths: Orn: orn:ows:idauth::012345678910:usergroup/example/usergroup-example Path: "/example/" UserGroupId: ug-12345678 - schema: - "$ref": "#/components/schemas/ReadUserGroupsPerUserResponse" description: The HTTP 200 response (OK). tags: - UserGroup "/ReadUserPolicies": - description: Lists the names of inline policies included in a specified user. post: + description: Lists the names of inline policies included in a specified user. operationId: ReadUserPolicies requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadUserPoliciesRequest" examples: ex1: value: UserName: example-user - schema: - "$ref": "#/components/schemas/ReadUserPoliciesRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadUserPoliciesResponse" examples: ex1: value: @@ -21520,30 +21787,30 @@ paths: - example-policy ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadUserPoliciesResponse" description: The HTTP 200 response (OK). tags: - Policy "/ReadUserPolicy": - description: Returns information about an inline policy included in a specified - user. post: + description: Returns information about an inline policy included in a specified + user. operationId: ReadUserPolicy requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadUserPolicyRequest" examples: ex1: value: - PolicyName: example-user-policy UserName: example-user - schema: - "$ref": "#/components/schemas/ReadUserPolicyRequest" + PolicyName: example-user-policy responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadUserPolicyResponse" examples: ex1: value: @@ -21551,54 +21818,54 @@ paths: ["*"], "Resource": ["*"]} ]}' PolicyName: example-user-policy UserName: example-user - schema: - "$ref": "#/components/schemas/ReadUserPolicyResponse" description: The HTTP 200 response (OK). tags: - Policy "/ReadUsers": - description: |- - Lists all EIM users in the account.
- The response can be filtered using the UserIds. post: + description: |- + Lists all EIM users in the account.
+ The response can be filtered using the UserIds. operationId: ReadUsers requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadUsersRequest" examples: ex1: value: Filters: UserIds: - ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 - schema: - "$ref": "#/components/schemas/ReadUsersRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadUsersResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Users: - - Path: "/documentation/" - UserEmail: user@example.com - UserId: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 + - UserEmail: user@example.com UserName: example-user - schema: - "$ref": "#/components/schemas/ReadUsersResponse" + UserId: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 + Path: "/documentation/" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - User "/ReadVirtualGateways": - description: Lists one or more virtual gateways. post: + description: Lists one or more virtual gateways. operationId: ReadVirtualGateways requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadVirtualGatewaysRequest" examples: ex1: value: @@ -21608,90 +21875,88 @@ paths: ex2: value: Filters: + States: + - available LinkStates: - attached - detached - States: - - available - schema: - "$ref": "#/components/schemas/ReadVirtualGatewaysRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadVirtualGatewaysResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VirtualGateways: - - ConnectionType: ipsec.1 + - VirtualGatewayId: vgw-12345678 + ConnectionType: ipsec.1 NetToVirtualGatewayLinks: [] State: available Tags: [] - VirtualGatewayId: vgw-12345678 - ex2: - value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + value: VirtualGateways: - - ConnectionType: ipsec.1 + - VirtualGatewayId: vgw-12345678 + ConnectionType: ipsec.1 NetToVirtualGatewayLinks: - - NetId: vpc-12345678 - State: attached + - State: attached + NetId: vpc-12345678 State: available Tags: [] - VirtualGatewayId: vgw-12345678 - schema: - "$ref": "#/components/schemas/ReadVirtualGatewaysResponse" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - VirtualGateway "/ReadVmGroups": - description: |- - > [WARNING]
- > This feature is currently under development and may not function properly.
- - Lists one or more group of virtual machines (VMs). post: + description: |- + > [WARNING]
+ > This feature is currently under development and may not function properly.
+ + Lists one or more group of virtual machines (VMs). operationId: ReadVmGroups requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadVmGroupsRequest" examples: ex1: value: Filters: VmGroupIds: - vmgroup-12345678901234567890123456789012 - schema: - "$ref": "#/components/schemas/ReadVmGroupsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadVmGroupsResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VmGroups: - - CreationDate: 2010-10-01 12:34:56.789000000 +00:00 - PositioningStrategy: attract - SecurityGroupIds: + - SecurityGroupIds: - sg-87654321 - State: available - SubnetId: subnet-12345678 - Tags: - - Key: key1 - Value: value1 - VmCount: 1 - VmGroupId: vmgroup-12345678901234567890123456789012 - VmGroupName: ClusterLog-PPD01 VmIds: - i-12345678 - schema: - "$ref": "#/components/schemas/ReadVmGroupsResponse" + CreationDate: 2010-10-01 12:34:56.789000000 +00:00 + VmCount: 1 + VmGroupName: ClusterLog-PPD01 + SubnetId: subnet-12345678 + PositioningStrategy: attract + State: available + VmGroupId: vmgroup-12345678901234567890123456789012 + Tags: + - Value: value1 + Key: key1 description: The HTTP 200 response (OK). '400': content: @@ -21714,16 +21979,18 @@ paths: tags: - VmGroup "/ReadVmTemplates": - description: |- - > [WARNING]
- > This feature is currently under development and may not function properly.
- - Lists one or more virtual machine (VM) templates. post: + description: |- + > [WARNING]
+ > This feature is currently under development and may not function properly.
+ + Lists one or more virtual machine (VM) templates. operationId: ReadVmTemplates requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadVmTemplatesRequest" examples: ex1: value: @@ -21737,79 +22004,79 @@ paths: - 2 CpuGenerations: - v4 - schema: - "$ref": "#/components/schemas/ReadVmTemplatesRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadVmTemplatesResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VmTemplates: - - CpuCores: 2 - CpuGeneration: v4 + - VmTemplateName: vmtemplate-example CpuPerformance: high CreationDate: 2010-10-01 12:34:56.789000000 +00:00 + CpuCores: 2 + Tags: [] Description: '' ImageId: ami-12345678 - Ram: 2 - Tags: [] + CpuGeneration: v4 VmTemplateId: vmtemplate-98765432109876543210987654321012 - VmTemplateName: vmtemplate-example - schema: - "$ref": "#/components/schemas/ReadVmTemplatesResponse" + Ram: 2 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - VmTemplate "/ReadVmTypes": - description: Lists one or more predefined VM types. post: + description: Lists one or more predefined VM types. operationId: ReadVmTypes requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadVmTypesRequest" examples: ex1: value: Filters: VmTypeNames: - t2.small - schema: - "$ref": "#/components/schemas/ReadVmTypesRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadVmTypesResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VmTypes: - - BsuOptimized: false + - VolumeCount: 0 + VmTypeName: t2.small + BsuOptimized: false MaxPrivateIps: 4 MemorySize: 2 VcoreCount: 1 - VmTypeName: t2.small - VolumeCount: 0 - schema: - "$ref": "#/components/schemas/ReadVmTypesResponse" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). security: [] tags: - Vm "/ReadVms": - description: |- - Lists one or more of your virtual machines (VMs).
- If you provide one or more VM IDs, this action returns a description for all of these VMs. If you do not provide any VM ID, this action returns a description for all of the VMs that belong to you. If you provide an invalid VM ID, an error is returned. If you provide the ID of a VM that does not belong to you, the description of this VM is not included in the response. The refresh interval for data returned by this action is one hour, meaning that a terminated VM may appear in the response. post: + description: |- + Lists one or more of your virtual machines (VMs).
+ If you provide one or more VM IDs, this action returns a description for all of these VMs. If you do not provide any VM ID, this action returns a description for all of the VMs that belong to you. If you provide an invalid VM ID, an error is returned. If you provide the ID of a VM that does not belong to you, the description of this VM is not included in the response. The refresh interval for data returned by this action is one hour, meaning that a terminated VM may appear in the response. operationId: ReadVms requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadVmsRequest" examples: ex1: value: @@ -21824,87 +22091,85 @@ paths: TagValues: - prod - test - schema: - "$ref": "#/components/schemas/ReadVmsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadVmsResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Vms: - - ActionsOnNextBoot: - SecureBoot: none + - VmType: tinav5.c1r1p2 + VmInitiatedShutdownBehavior: stop + State: running + StateReason: '' + RootDeviceType: ebs + RootDeviceName: "/dev/sda1" + IsSourceDestChecked: true + KeypairName: keypair-example + ImageId: ami-12345678 + DeletionProtection: false + BootMode: legacy Architecture: x86_64 + NestedVirtualization: false BlockDeviceMappings: - - Bsu: - DeleteOnVmDeletion: true - LinkDate: '2010-10-01T12:34:56.789Z' - State: attached + - DeviceName: "/dev/sda1" + Bsu: VolumeId: vol-12345678 - DeviceName: "/dev/sda1" - BootMode: legacy - BsuOptimized: false - CreationDate: '2010-10-01T12:34:56.789Z' - DeletionProtection: false - Hypervisor: xen - ImageId: ami-12345678 - IsSourceDestChecked: true - KeypairName: keypair-example + State: attached + LinkDate: '2010-10-01T12:34:56.789Z' + DeleteOnVmDeletion: true + VmId: i-12345678 + ReservationId: r-12345678 + Hypervisor: xen + Placement: + Tenancy: default + SubregionName: eu-west-2a + ProductCodes: + - '0001' + CreationDate: '2010-10-01T12:34:56.789Z' + UserData: '' + SubnetId: subnet-12345678 + PrivateIp: 10.0.0.4 + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 + BsuOptimized: false LaunchNumber: 0 - NestedVirtualization: false NetId: vpc-12345678 Nics: - - AccountId: '123456789012' - Description: Primary network interface - IsSourceDestChecked: true + - SubnetId: subnet-12345678 + State: in-use LinkNic: - DeleteOnVmDeletion: true + State: attached DeviceNumber: 0 LinkNicId: eni-attach-12345678 - State: attached + DeleteOnVmDeletion: true + IsSourceDestChecked: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + Description: Primary network interface + AccountId: '123456789012' + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - IsPrimary: true - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - SecurityGroups: - - SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - State: in-use - SubnetId: subnet-12345678 + IsPrimary: true Performance: high - Placement: - SubregionName: eu-west-2a - Tenancy: default - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal - PrivateIp: 10.0.0.4 - ProductCodes: - - '0001' - ReservationId: r-12345678 - RootDeviceName: "/dev/sda1" - RootDeviceType: ebs - SecurityGroups: - - SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - State: running - StateReason: '' - SubnetId: subnet-12345678 Tags: - - Key: env - Value: prod - UserData: '' - VmId: i-12345678 - VmInitiatedShutdownBehavior: stop - VmType: tinav5.c1r1p2 - schema: - "$ref": "#/components/schemas/ReadVmsResponse" + - Value: prod + Key: env + ActionsOnNextBoot: + SecureBoot: none + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -21927,50 +22192,52 @@ paths: tags: - Vm "/ReadVmsHealth": - description: Lists the state of one or more backend virtual machines (VMs) registered - with a specified load balancer. post: + description: Lists the state of one or more backend virtual machines (VMs) registered + with a specified load balancer. operationId: ReadVmsHealth requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadVmsHealthRequest" examples: ex1: value: + LoadBalancerName: example-lbu BackendVmIds: - i-12345678 - i-87654321 - LoadBalancerName: example-lbu - schema: - "$ref": "#/components/schemas/ReadVmsHealthRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadVmsHealthResponse" examples: ex1: value: - BackendVmHealth: - - State: UP - VmId: i-12345678 - - Description: Instance registration is pending - State: DOWN - StateReason: ELB - VmId: i-87654321 ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadVmsHealthResponse" + BackendVmHealth: + - VmId: i-12345678 + State: UP + - VmId: i-87654321 + StateReason: ELB + State: DOWN + Description: Instance registration is pending description: The HTTP 200 response (OK). tags: - LoadBalancer "/ReadVmsState": - description: Lists the status of one or more virtual machines (VMs). post: + description: Lists the status of one or more virtual machines (VMs). operationId: ReadVmsState requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadVmsStateRequest" examples: ex1: value: @@ -21980,37 +22247,35 @@ paths: Filters: SubregionNames: - eu-west-2a - schema: - "$ref": "#/components/schemas/ReadVmsStateRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadVmsStateResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VmStates: - - MaintenanceEvents: [] - SubregionName: eu-west-2a - VmId: i-12345678 + - VmId: i-12345678 VmState: running - - MaintenanceEvents: [] SubregionName: eu-west-2a - VmId: i-87654321 + MaintenanceEvents: [] + - VmId: i-87654321 VmState: stopped - ex2: - value: + SubregionName: eu-west-2a + MaintenanceEvents: [] ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + value: VmStates: - - MaintenanceEvents: [] - SubregionName: eu-west-2a - VmId: i-12345678 + - VmId: i-12345678 VmState: running - schema: - "$ref": "#/components/schemas/ReadVmsStateResponse" + SubregionName: eu-west-2a + MaintenanceEvents: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -22033,12 +22298,14 @@ paths: tags: - Vm "/ReadVolumes": - description: Lists one or more specified Block Storage Unit (BSU) volumes. post: + description: Lists one or more specified Block Storage Unit (BSU) volumes. operationId: ReadVolumes requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadVolumesRequest" examples: ex1: value: @@ -22053,34 +22320,32 @@ paths: VolumeTypes: - gp2 - io1 - schema: - "$ref": "#/components/schemas/ReadVolumesRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadVolumesResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Volumes: - - CreationDate: '2010-10-01T12:34:56.789Z' + - VolumeId: vol-12345678 + Tags: [] + VolumeType: gp2 + SubregionName: eu-west-2a + State: in-use + CreationDate: '2010-10-01T12:34:56.789Z' Iops: 100 LinkedVolumes: - - DeleteOnVmDeletion: false + - VolumeId: vol-12345678 + DeleteOnVmDeletion: false DeviceName: "/dev/sdb" State: attached VmId: i-12345678 - VolumeId: vol-12345678 Size: 10 - State: in-use - SubregionName: eu-west-2a - Tags: [] - VolumeId: vol-12345678 - VolumeType: gp2 - schema: - "$ref": "#/components/schemas/ReadVolumesResponse" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -22103,12 +22368,14 @@ paths: tags: - Volume "/ReadVpnConnections": - description: Lists one or more VPN connections. post: + description: Lists one or more VPN connections. operationId: ReadVpnConnections requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadVpnConnectionsRequest" examples: ex1: value: @@ -22123,64 +22390,62 @@ paths: VirtualGatewayIds: - vgw-12345678 - vgw-87654321 - schema: - "$ref": "#/components/schemas/ReadVpnConnectionsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadVpnConnectionsResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VpnConnections: - - ClientGatewayConfiguration: "..." - ClientGatewayId: cgw-12345678 + - Routes: [] + Tags: [] + ClientGatewayConfiguration: "..." + StaticRoutesOnly: true + VirtualGatewayId: vgw-12345678 ConnectionType: ipsec.1 - Routes: [] + ClientGatewayId: cgw-12345678 State: pending - StaticRoutesOnly: true - Tags: [] VgwTelemetries: - - AcceptedRouteCount: 0 + - StateDescription: IPSEC IS DOWN + AcceptedRouteCount: 0 LastStateChangeDate: '2017-05-10T12:34:56.789Z' OutsideIpAddress: 192.0.2.0 - StateDescription: IPSEC IS DOWN - VirtualGatewayId: vgw-12345678 VpnConnectionId: vpn-12345678 - schema: - "$ref": "#/components/schemas/ReadVpnConnectionsResponse" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - VpnConnection "/RebootVms": - description: |- - Reboots one or more virtual machines (VMs).
- This operation sends a reboot request to one or more specified VMs. This is an asynchronous action that queues this reboot request. This action only reboots VMs that are valid and that belong to you. post: + description: |- + Reboots one or more virtual machines (VMs).
+ This operation sends a reboot request to one or more specified VMs. This is an asynchronous action that queues this reboot request. This action only reboots VMs that are valid and that belong to you. operationId: RebootVms requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/RebootVmsRequest" examples: ex1: value: VmIds: - i-12345678 - schema: - "$ref": "#/components/schemas/RebootVmsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/RebootVmsResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/RebootVmsResponse" description: The HTTP 200 response (OK). '400': content: @@ -22203,66 +22468,66 @@ paths: tags: - Vm "/RegisterVmsInLoadBalancer": - description: |- - > [WARNING]
- > Deprecated: This call is deprecated and will be removed.
- - Registers one or more virtual machines (VMs) with a specified load balancer.
- The VMs can be in different Subnets and different Subregions than the load balancer, as long as the VMs and load balancers are all in the public Cloud or all in the same Net. It may take a little time for a VM to be registered with the load balancer. Once the VM is registered with a load balancer, it receives traffic and requests from this load balancer and is called a backend VM. post: + description: |- + > [WARNING]
+ > Deprecated: This call is deprecated and will be removed.
+ + Registers one or more virtual machines (VMs) with a specified load balancer.
+ The VMs can be in different Subnets and different Subregions than the load balancer, as long as the VMs and load balancers are all in the public Cloud or all in the same Net. It may take a little time for a VM to be registered with the load balancer. Once the VM is registered with a load balancer, it receives traffic and requests from this load balancer and is called a backend VM. operationId: RegisterVmsInLoadBalancer requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/RegisterVmsInLoadBalancerRequest" examples: ex1: value: + LoadBalancerName: example-lbu BackendVmIds: - i-12345678 - i-87654321 - LoadBalancerName: example-lbu - schema: - "$ref": "#/components/schemas/RegisterVmsInLoadBalancerRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/RegisterVmsInLoadBalancerResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/RegisterVmsInLoadBalancerResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer "/RejectNetPeering": - description: |- - Rejects a Net peering request.
- The Net peering must be in the `pending-acceptance` state to be rejected. The rejected Net peering is then in the `rejected` state. post: + description: |- + Rejects a Net peering request.
+ The Net peering must be in the `pending-acceptance` state to be rejected. The rejected Net peering is then in the `rejected` state. operationId: RejectNetPeering requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/RejectNetPeeringRequest" examples: ex1: value: NetPeeringId: pcx-12345678 - schema: - "$ref": "#/components/schemas/RejectNetPeeringRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/RejectNetPeeringResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/RejectNetPeeringResponse" description: The HTTP 200 response (OK). '400': content: @@ -22291,12 +22556,14 @@ paths: tags: - NetPeering "/RemoveUserFromUserGroup": - description: Removes a specified user from a specified group. post: + description: Removes a specified user from a specified group. operationId: RemoveUserFromUserGroup requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/RemoveUserFromUserGroupRequest" examples: ex1: value: @@ -22304,53 +22571,51 @@ paths: UserGroupPath: "/example/" UserName: example-user UserPath: "/example/" - schema: - "$ref": "#/components/schemas/RemoveUserFromUserGroupRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/RemoveUserFromUserGroupResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/RemoveUserFromUserGroupResponse" description: The HTTP 200 response (OK). tags: - UserGroup "/ScaleDownVmGroup": - description: |- - > [WARNING]
- > This feature is currently under development and may not function properly.
- - Deletes virtual machines (VMs) from a VM group.
- The oldest VMs are the first to be deleted. post: + description: |- + > [WARNING]
+ > This feature is currently under development and may not function properly.
+ + Deletes virtual machines (VMs) from a VM group.
+ The oldest VMs are the first to be deleted. operationId: ScaleDownVmGroup requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ScaleDownVmGroupRequest" examples: ex1: summary: Removing 1 VM from a VM group value: VmGroupId: vmgroup-12345678901234567890123456789012 VmSubtraction: 1 - schema: - "$ref": "#/components/schemas/ScaleDownVmGroupRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ScaleDownVmGroupResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ScaleDownVmGroupResponse" description: The HTTP 200 response (OK). '400': content: @@ -22373,36 +22638,36 @@ paths: tags: - VmGroup "/ScaleUpVmGroup": - description: |- - > [WARNING]
- > This feature is currently under development and may not function properly.
- - Creates additional virtual machines (VMs) in a VM group.
- The new VMs use the current version of the VM template. post: + description: |- + > [WARNING]
+ > This feature is currently under development and may not function properly.
+ + Creates additional virtual machines (VMs) in a VM group.
+ The new VMs use the current version of the VM template. operationId: ScaleUpVmGroup requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ScaleUpVmGroupRequest" examples: ex1: summary: Adding 2 VMs in a VM group value: - VmAddition: 2 VmGroupId: vmgroup-12345678901234567890123456789012 - schema: - "$ref": "#/components/schemas/ScaleUpVmGroupRequest" + VmAddition: 2 responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ScaleUpVmGroupResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ScaleUpVmGroupResponse" description: The HTTP 200 response (OK). '400': content: @@ -22425,66 +22690,66 @@ paths: tags: - VmGroup "/SetDefaultPolicyVersion": - description: |- - Sets a specified version of a managed policy as the default (operative) one.
- You can modify the default version of a policy at any time. post: + description: |- + Sets a specified version of a managed policy as the default (operative) one.
+ You can modify the default version of a policy at any time. operationId: SetDefaultPolicyVersion requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/SetDefaultPolicyVersionRequest" examples: ex1: value: PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy VersionId: v1 - schema: - "$ref": "#/components/schemas/SetDefaultPolicyVersionRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/SetDefaultPolicyVersionResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/SetDefaultPolicyVersionResponse" description: The HTTP 200 response (OK). tags: - Policy "/StartVms": - description: |- - Start one or more virtual machines (VMs).
- You can start only VMs that are valid and that belong to you. post: + description: |- + Start one or more virtual machines (VMs).
+ You can start only VMs that are valid and that belong to you. operationId: StartVms requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/StartVmsRequest" examples: ex1: value: VmIds: - i-12345678 - schema: - "$ref": "#/components/schemas/StartVmsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/StartVmsResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Vms: - - CurrentState: pending + - VmId: i-12345678 PreviousState: stopped - VmId: i-12345678 - schema: - "$ref": "#/components/schemas/StartVmsResponse" + CurrentState: pending + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -22507,36 +22772,36 @@ paths: tags: - Vm "/StopVms": - description: |- - Stops one or more running virtual machines (VMs).
- You can stop only VMs that are valid and that belong to you. Data stored in the VM RAM is lost. post: + description: |- + Stops one or more running virtual machines (VMs).
+ You can stop only VMs that are valid and that belong to you. Data stored in the VM RAM is lost. operationId: StopVms requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/StopVmsRequest" examples: ex1: value: VmIds: - i-12345678 - schema: - "$ref": "#/components/schemas/StopVmsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/StopVmsResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Vms: - - CurrentState: stopping + - VmId: i-12345678 PreviousState: running - VmId: i-12345678 - schema: - "$ref": "#/components/schemas/StopVmsResponse" + CurrentState: stopping + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -22559,61 +22824,61 @@ paths: tags: - Vm "/UnlinkFlexibleGpu": - description: |- - Detaches a flexible GPU (fGPU) from a virtual machine (VM).
- The fGPU is in the `detaching` state until the VM is stopped, after which it becomes `allocated`. It is then available again for attachment to a VM. post: + description: |- + Detaches a flexible GPU (fGPU) from a virtual machine (VM).
+ The fGPU is in the `detaching` state until the VM is stopped, after which it becomes `allocated`. It is then available again for attachment to a VM. operationId: UnlinkFlexibleGpu requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkFlexibleGpuRequest" examples: ex1: value: FlexibleGpuId: fgpu-12345678 - schema: - "$ref": "#/components/schemas/UnlinkFlexibleGpuRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkFlexibleGpuResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UnlinkFlexibleGpuResponse" description: The HTTP 200 response (OK). tags: - FlexibleGpu "/UnlinkInternetService": - description: |- - Detaches an internet service from a Net.
- This action disables and detaches an internet service from a Net. The Net must not contain virtual machines (VMs) using public IPs nor internet-facing load balancers. post: + description: |- + Detaches an internet service from a Net.
+ This action disables and detaches an internet service from a Net. The Net must not contain virtual machines (VMs) using public IPs nor internet-facing load balancers. operationId: UnlinkInternetService requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkInternetServiceRequest" examples: ex1: value: InternetServiceId: igw-12345678 NetId: vpc-12345678 - schema: - "$ref": "#/components/schemas/UnlinkInternetServiceRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkInternetServiceResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UnlinkInternetServiceResponse" description: The HTTP 200 response (OK). '400': content: @@ -22636,34 +22901,37 @@ paths: tags: - InternetService "/UnlinkLoadBalancerBackendMachines": - description: Detaches one or more backend virtual machines (VMs) from a load balancer. - You need to specify at least the `BackendIps` or the `BackendVmIds` parameter. post: + description: Detaches one or more backend virtual machines (VMs) from a load + balancer. You need to specify at least the `BackendIps` or the `BackendVmIds` + parameter. operationId: UnlinkLoadBalancerBackendMachines requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkLoadBalancerBackendMachinesRequest" examples: ex1: summary: Unlinking VMs from a load balancer value: + LoadBalancerName: example-lbu BackendVmIds: - i-12345678 - i-87654321 - LoadBalancerName: example-lbu ex2: summary: Unlinking public IPs from a load balancer value: + LoadBalancerName: example-lbu BackendIps: - 192.0.2.0 - 198.51.100.0 - LoadBalancerName: example-lbu - schema: - "$ref": "#/components/schemas/UnlinkLoadBalancerBackendMachinesRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkLoadBalancerBackendMachinesResponse" examples: ex1: summary: Unlinking VMs from a load balancer @@ -22675,65 +22943,63 @@ paths: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UnlinkLoadBalancerBackendMachinesResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer "/UnlinkManagedPolicyFromUserGroup": - description: Unlinks a managed policy from a specific group. post: + description: Unlinks a managed policy from a specific group. operationId: UnlinkManagedPolicyFromUserGroup requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkManagedPolicyFromUserGroupRequest" examples: ex1: value: PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy UserGroupName: example-usergroup - schema: - "$ref": "#/components/schemas/UnlinkManagedPolicyFromUserGroupRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkManagedPolicyFromUserGroupResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UnlinkManagedPolicyFromUserGroupResponse" description: The HTTP 200 response (OK). tags: - Policy "/UnlinkNic": - description: |- - Detaches a network interface card (NIC) from a virtual machine (VM).
- The primary NIC cannot be detached. post: + description: |- + Detaches a network interface card (NIC) from a virtual machine (VM).
+ The primary NIC cannot be detached. operationId: UnlinkNic requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkNicRequest" examples: ex1: value: LinkNicId: eni-attach-12345678 - schema: - "$ref": "#/components/schemas/UnlinkNicRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkNicResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UnlinkNicResponse" description: The HTTP 200 response (OK). '400': content: @@ -22756,41 +23022,43 @@ paths: tags: - Nic "/UnlinkPolicy": - description: Removes a managed policy from a specific user. post: + description: Removes a managed policy from a specific user. operationId: UnlinkPolicy requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkPolicyRequest" examples: ex1: value: PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy UserName: example-user - schema: - "$ref": "#/components/schemas/UnlinkPolicyRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkPolicyResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UnlinkPolicyResponse" description: The HTTP 200 response (OK). tags: - Policy "/UnlinkPrivateIps": - description: Unassigns one or more secondary private IPs from a network interface - card (NIC). post: + description: Unassigns one or more secondary private IPs from a network interface + card (NIC). operationId: UnlinkPrivateIps requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkPrivateIpsRequest" examples: ex1: value: @@ -22798,19 +23066,17 @@ paths: PrivateIps: - 10.0.0.6 - 10.0.0.7 - schema: - "$ref": "#/components/schemas/UnlinkPrivateIpsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkPrivateIpsResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UnlinkPrivateIpsResponse" description: The HTTP 200 response (OK). '400': content: @@ -22833,33 +23099,33 @@ paths: tags: - Nic "/UnlinkPublicIp": - description: |- - Disassociates a public IP from the virtual machine (VM) or network interface card (NIC) it is associated with.

- - **[IMPORTANT]**
- To disassociate the public IP from a NAT service, you need to delete the NAT service. For more information, see the [DeleteNatService](#deletenatservice) method. post: + description: |- + Disassociates a public IP from the virtual machine (VM) or network interface card (NIC) it is associated with.

+ + **[IMPORTANT]**
+ To disassociate the public IP from a NAT service, you need to delete the NAT service. For more information, see the [DeleteNatService](#deletenatservice) method. operationId: UnlinkPublicIp requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkPublicIpRequest" examples: ex1: value: PublicIp: 192.0.2.0 - schema: - "$ref": "#/components/schemas/UnlinkPublicIpRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkPublicIpResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UnlinkPublicIpResponse" description: The HTTP 200 response (OK). '400': content: @@ -22882,31 +23148,31 @@ paths: tags: - PublicIp "/UnlinkRouteTable": - description: |- - Disassociates a Subnet from a route table.
- After disassociation, the Subnet can no longer use the routes in this route table, but uses the routes in the main route table of the Net instead. post: + description: |- + Disassociates a Subnet from a route table.
+ After disassociation, the Subnet can no longer use the routes in this route table, but uses the routes in the main route table of the Net instead. operationId: UnlinkRouteTable requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkRouteTableRequest" examples: ex1: value: LinkRouteTableId: rtbassoc-12345678 - schema: - "$ref": "#/components/schemas/UnlinkRouteTableRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkRouteTableResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UnlinkRouteTableResponse" description: The HTTP 200 response (OK). '400': content: @@ -22929,61 +23195,61 @@ paths: tags: - RouteTable "/UnlinkVirtualGateway": - description: |- - Detaches a virtual gateway from a Net.
- You must wait until the virtual gateway is in the detached state before you can attach another Net to it or delete the Net it was previously attached to. post: + description: |- + Detaches a virtual gateway from a Net.
+ You must wait until the virtual gateway is in the detached state before you can attach another Net to it or delete the Net it was previously attached to. operationId: UnlinkVirtualGateway requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkVirtualGatewayRequest" examples: ex1: value: - NetId: vpc-12345678 VirtualGatewayId: vgw-12345678 - schema: - "$ref": "#/components/schemas/UnlinkVirtualGatewayRequest" + NetId: vpc-12345678 responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkVirtualGatewayResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UnlinkVirtualGatewayResponse" description: The HTTP 200 response (OK). tags: - VirtualGateway "/UnlinkVolume": - description: |- - Detaches a Block Storage Unit (BSU) volume from a virtual machine (VM).
- To detach the root device of a VM, this VM must be stopped. post: + description: |- + Detaches a Block Storage Unit (BSU) volume from a virtual machine (VM).
+ To detach the root device of a VM, this VM must be stopped. operationId: UnlinkVolume requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkVolumeRequest" examples: ex1: value: VolumeId: vol-12345678 - schema: - "$ref": "#/components/schemas/UnlinkVolumeRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkVolumeResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UnlinkVolumeResponse" description: The HTTP 200 response (OK). '400': content: @@ -23006,21 +23272,23 @@ paths: tags: - Volume "/UpdateAccessKey": - description: |- - Modifies the attributes of the specified access key of either your root account or an EIM user.

- The parameter `ExpirationDate` is not required when updating the state of your access key. However, if you do not specify the expiration date of an access key when updating its state, it is then set to not expire. post: + description: |- + Modifies the attributes of the specified access key of either your root account or an EIM user.

+ The parameter `ExpirationDate` is not required when updating the state of your access key. However, if you do not specify the expiration date of an access key when updating its state, it is then set to not expire. operationId: UpdateAccessKey requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateAccessKeyRequest" examples: ex1: summary: Updating the expiration date of the access key value: AccessKeyId: ABCDEFGHIJ0123456789 - ExpirationDate: '2063-04-05' State: ACTIVE + ExpirationDate: '2063-04-05' ex2: summary: Updating the state of one of your own access keys (if you are the root account or an EIM user) @@ -23033,38 +23301,36 @@ paths: AccessKeyId: ABCDEFGHIJ0123456789 State: ACTIVE UserName: example-user - schema: - "$ref": "#/components/schemas/UpdateAccessKeyRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateAccessKeyResponse" examples: ex1: summary: Updating an access key when using the parameter ExpirationDate value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 AccessKey: + State: ACTIVE AccessKeyId: ABCDEFGHIJ0123456789 CreationDate: 2010-10-01 12:34:56.789000000 +00:00 ExpirationDate: 2063-04-05 00:00:00.000000000 +00:00 LastModificationDate: 2017-05-10 12:34:56.789000000 +00:00 - State: ACTIVE Tag: Group1 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Updating an access key when not using the parameter ExpirationDate value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 AccessKey: + State: ACTIVE AccessKeyId: ABCDEFGHIJ0123456789 CreationDate: 2010-10-01 12:34:56.789000000 +00:00 LastModificationDate: 2017-05-10 12:34:56.789000000 +00:00 - State: ACTIVE Tag: Group1 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UpdateAccessKeyResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -23072,58 +23338,61 @@ paths: tags: - AccessKey "/UpdateAccount": - description: Updates the account information for the account that sends the request. post: + description: Updates the account information for the account that sends the + request. operationId: UpdateAccount requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateAccountRequest" examples: ex1: value: AdditionalEmails: - another@example.com - yet.another@example.com - schema: - "$ref": "#/components/schemas/UpdateAccountRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateAccountResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Account: - AccountId: '123456789012' + ZipCode: '92210' + CompanyName: EXAMPLE SAS + FirstName: JEAN AdditionalEmails: - another@example.com - yet.another@example.com City: SAINT-CLOUD - CompanyName: EXAMPLE SAS Country: FRANCE + LastName: DUPONT + AccountId: '123456789012' CustomerId: '87654321' Email: example@example.com - FirstName: JEAN - LastName: DUPONT - ZipCode: '92210' - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UpdateAccountResponse" description: The HTTP 200 response (OK). tags: - Account "/UpdateApiAccessPolicy": - description: |- - Updates the API access policy of your account.

- - **[IMPORTANT]**
- Only one API access policy can be associated with your account. post: + description: |- + Updates the API access policy of your account.

+ + **[IMPORTANT]**
+ Only one API access policy can be associated with your account. operationId: UpdateApiAccessPolicy requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateApiAccessPolicyRequest" examples: ex1: summary: Require expiration dates of maximum 1 year @@ -23142,41 +23411,39 @@ paths: value: MaxAccessKeyExpirationSeconds: 0 RequireTrustedEnv: false - schema: - "$ref": "#/components/schemas/UpdateApiAccessPolicyRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateApiAccessPolicyResponse" examples: ex1: summary: Require expiration dates of maximum 1 year value: - ApiAccessPolicy: - MaxAccessKeyExpirationSeconds: 31536000 - RequireTrustedEnv: false ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ApiAccessPolicy: + RequireTrustedEnv: false + MaxAccessKeyExpirationSeconds: 31536000 ex2: summary: Require expiration dates of maximum 100 years and activate a trusted session value: - ApiAccessPolicy: - MaxAccessKeyExpirationSeconds: 3153600000 - RequireTrustedEnv: true ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ApiAccessPolicy: + RequireTrustedEnv: true + MaxAccessKeyExpirationSeconds: 3153600000 ex3: summary: Do not require expiration dates and deactivate a trusted session value: - ApiAccessPolicy: - MaxAccessKeyExpirationSeconds: 0 - RequireTrustedEnv: false ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UpdateApiAccessPolicyResponse" + ApiAccessPolicy: + RequireTrustedEnv: false + MaxAccessKeyExpirationSeconds: 0 description: The HTTP 200 response (OK). '400': content: @@ -23202,44 +23469,44 @@ paths: tags: - ApiAccessPolicy "/UpdateApiAccessRule": - description: |- - Modifies a specified API access rule.

- - **[WARNING]**
- - The new rule you specify fully replaces the old rule. Therefore, for a parameter that is not specified, any previously set value is deleted.
- - If, as result of your modification, you no longer have access to the APIs, you will need to contact the Support team to regain access. For more information, see [Technical Support](https://docs.outscale.com/en/userguide/Technical-Support.html). post: + description: |- + Modifies a specified API access rule.

+ + **[WARNING]**
+ - The new rule you specify fully replaces the old rule. Therefore, for a parameter that is not specified, any previously set value is deleted.
+ - If, as result of your modification, you no longer have access to the APIs, you will need to contact the Support team to regain access. For more information, see [Technical Support](https://docs.outscale.com/en/userguide/Technical-Support.html). operationId: UpdateApiAccessRule requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateApiAccessRuleRequest" examples: ex1: value: ApiAccessRuleId: aar-1234567890abcdef1234567890abcdef - Description: Allows all Ipv4 domain IpRanges: - 0.0.0.0/0 - schema: - "$ref": "#/components/schemas/UpdateApiAccessRuleRequest" + Description: Allows all Ipv4 domain responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateApiAccessRuleResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ApiAccessRule: + IpRanges: + - 0.0.0.0/0 ApiAccessRuleId: aar-1234567890abcdef1234567890abcdef CaIds: [] Cns: [] Description: Allows all IPv4 domain - IpRanges: - - 0.0.0.0/0 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UpdateApiAccessRuleResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -23247,35 +23514,35 @@ paths: tags: - ApiAccessRule "/UpdateCa": - description: Modifies the specified attribute of a Client Certificate Authority - (CA). post: + description: Modifies the specified attribute of a Client Certificate Authority + (CA). operationId: UpdateCa requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateCaRequest" examples: ex1: value: CaId: ca-fedcba0987654321fedcba0987654321 Description: New description - schema: - "$ref": "#/components/schemas/UpdateCaRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateCaResponse" examples: ex1: value: - Ca: - CaFingerprint: 1234567890abcdef1234567890abcdef12345678 - CaId: ca-fedcba0987654321fedcba0987654321 - Description: New description ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UpdateCaResponse" + Ca: + Description: New description + CaId: ca-fedcba0987654321fedcba0987654321 + CaFingerprint: 1234567890abcdef1234567890abcdef12345678 description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -23283,44 +23550,44 @@ paths: tags: - Ca "/UpdateDedicatedGroup": - description: |- - > [WARNING]
- > This feature is currently in beta.
- - Modifies the name of a specified dedicated group.
post: + description: |- + > [WARNING]
+ > This feature is currently in beta.
+ + Modifies the name of a specified dedicated group.
operationId: UpdateDedicatedGroup requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateDedicatedGroupRequest" examples: ex1: value: DedicatedGroupId: ded-12345678 Name: New-dedicated-group-name - schema: - "$ref": "#/components/schemas/UpdateDedicatedGroupRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateDedicatedGroupResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 DedicatedGroup: + VmIds: + - i-12345678 + NetIds: + - vpc-12345678 AccountId: '123456789012' CpuGeneration: 4 - DedicatedGroupId: ded-12345678 Name: New-dedicated-group-name - NetIds: - - vpc-12345678 SubregionName: eu-west-2a - VmIds: - - i-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UpdateDedicatedGroupResponse" + DedicatedGroupId: ded-12345678 description: The HTTP 200 response (OK). '400': content: @@ -23343,68 +23610,72 @@ paths: tags: - DedicatedGroup "/UpdateDirectLinkInterface": - description: Modifies the maximum transmission unit (MTU) of a DirectLink interface. post: + description: Modifies the maximum transmission unit (MTU) of a DirectLink interface. operationId: UpdateDirectLinkInterface requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateDirectLinkInterfaceRequest" examples: ex1: value: DirectLinkInterfaceId: dxvif-12345678 Mtu: 1500 - schema: - "$ref": "#/components/schemas/UpdateDirectLinkInterfaceRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateDirectLinkInterfaceResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 DirectLinkInterface: - AccountId: '123456789012' + Vlan: 101 + OutscalePrivateIp: 172.16.0.4/30 + DirectLinkInterfaceId: dxvif-12345678 BgpAsn: 65000 + AccountId: '123456789012' ClientPrivateIp: 172.16.0.5/30 - DirectLinkId: dxcon-12345678 - DirectLinkInterfaceId: dxvif-12345678 + VirtualGatewayId: vgw-12345678 DirectLinkInterfaceName: MyDirectLinkInterface - InterfaceType: private - Location: PAR1 + DirectLinkId: dxcon-12345678 Mtu: 1500 - OutscalePrivateIp: 172.16.0.4/30 State: available - VirtualGatewayId: vgw-12345678 - Vlan: 101 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UpdateDirectLinkInterfaceResponse" + InterfaceType: private + Location: PAR1 description: The HTTP 200 response (OK). tags: - DirectLinkInterface "/UpdateFlexibleGpu": - description: Modifies a flexible GPU (fGPU) behavior. post: + description: Modifies a flexible GPU (fGPU) behavior. operationId: UpdateFlexibleGpu requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateFlexibleGpuRequest" examples: ex1: value: - DeleteOnVmDeletion: false FlexibleGpuId: fgpu-12345678 - schema: - "$ref": "#/components/schemas/UpdateFlexibleGpuRequest" + DeleteOnVmDeletion: false responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateFlexibleGpuResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 FlexibleGpu: DeleteOnVmDeletion: false FlexibleGpuId: fgpu-12345678 @@ -23412,23 +23683,21 @@ paths: ModelName: nvidia-p100 State: allocated SubregionName: eu-west-2a - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UpdateFlexibleGpuResponse" description: The HTTP 200 response (OK). tags: - FlexibleGpu "/UpdateImage": - description: |- - Modifies the access permissions for an OUTSCALE machine image (OMI).
- You must specify either the `Additions` or the `Removals` parameter.
- After sharing an OMI with an account, the other account can create a copy of it that they own. For more information about copying OMIs, see [CreateImage](#createimage). post: + description: |- + Modifies the access permissions for an OUTSCALE machine image (OMI).
+ You must specify either the `Additions` or the `Removals` parameter.
+ After sharing an OMI with an account, the other account can create a copy of it that they own. For more information about copying OMIs, see [CreateImage](#createimage). operationId: UpdateImage requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateImageRequest" examples: ex1: summary: Adding permission @@ -23456,145 +23725,143 @@ paths: ex4: summary: Making an image private to everyone value: - Description: Private image ImageId: ami-12345678 + Description: Private image PermissionsToLaunch: Removals: GlobalPermission: true - schema: - "$ref": "#/components/schemas/UpdateImageRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateImageResponse" examples: ex1: summary: Adding permission value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Image: + StateComment: {} + State: available + RootDeviceType: bsu + RootDeviceName: "/dev/sda1" + ProductCodes: + - '0001' + PermissionsToLaunch: + GlobalPermission: false + AccountIds: + - '987654321098' AccountId: '123456789012' - Architecture: x86_64 + Tags: [] + Description: '' + ImageId: ami-12345678 BlockDeviceMappings: - - Bsu: + - DeviceName: "/dev/sda1" + Bsu: + VolumeType: standard DeleteOnVmDeletion: true - SnapshotId: snap-12345678 VolumeSize: 50 - VolumeType: standard - DeviceName: "/dev/sda1" + SnapshotId: snap-12345678 + ImageType: machine CreationDate: '2010-10-01T12:34:56.789Z' - Description: '' FileLocation: 123456789012/image-example - ImageId: ami-12345678 + Architecture: x86_64 ImageName: image-example - ImageType: machine - PermissionsToLaunch: - AccountIds: - - '987654321098' - GlobalPermission: false - ProductCodes: - - '0001' - RootDeviceName: "/dev/sda1" - RootDeviceType: bsu - State: available - StateComment: {} - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Removing permission value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Image: + StateComment: {} + State: available + RootDeviceType: bsu + RootDeviceName: "/dev/sda1" + ProductCodes: + - '0001' + PermissionsToLaunch: + GlobalPermission: false + AccountIds: [] AccountId: '123456789012' - Architecture: x86_64 + Tags: [] + Description: '' + ImageId: ami-12345678 BlockDeviceMappings: - - Bsu: + - DeviceName: "/dev/sda1" + Bsu: + VolumeType: standard DeleteOnVmDeletion: true - SnapshotId: snap-12345678 VolumeSize: 50 - VolumeType: standard - DeviceName: "/dev/sda1" + SnapshotId: snap-12345678 + ImageType: machine CreationDate: '2010-10-01T12:34:56.789Z' - Description: '' FileLocation: 123456789012/image-example - ImageId: ami-12345678 + Architecture: x86_64 ImageName: image-example - ImageType: machine - PermissionsToLaunch: - AccountIds: [] - GlobalPermission: false - ProductCodes: - - '0001' - RootDeviceName: "/dev/sda1" - RootDeviceType: bsu - State: available - StateComment: {} - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex3: summary: Making an image public to everyone value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Image: + StateComment: {} + State: available + RootDeviceType: bsu + RootDeviceName: "/dev/sda1" + ProductCodes: + - '0001' + PermissionsToLaunch: + GlobalPermission: true + AccountIds: [] AccountId: '123456789012' - Architecture: x86_64 + Tags: [] + Description: '' + ImageId: ami-12345678 BlockDeviceMappings: - - Bsu: + - DeviceName: "/dev/sda1" + Bsu: + VolumeType: standard DeleteOnVmDeletion: true - SnapshotId: snap-12345678 VolumeSize: 50 - VolumeType: standard - DeviceName: "/dev/sda1" + SnapshotId: snap-12345678 + ImageType: machine CreationDate: '2010-10-01T12:34:56.789Z' - Description: '' FileLocation: 123456789012/image-example - ImageId: ami-12345678 + Architecture: x86_64 ImageName: image-example - ImageType: machine - PermissionsToLaunch: - AccountIds: [] - GlobalPermission: true - ProductCodes: - - '0001' - RootDeviceName: "/dev/sda1" - RootDeviceType: bsu - State: available - StateComment: {} - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex4: summary: Making an image private to everyone value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Image: + StateComment: {} + State: available + RootDeviceType: bsu + RootDeviceName: "/dev/sda1" + ProductCodes: + - '0001' + PermissionsToLaunch: + GlobalPermission: false + AccountIds: [] AccountId: '123456789012' - Architecture: x86_64 + Tags: [] + Description: Private image + ImageId: ami-12345678 BlockDeviceMappings: - - Bsu: + - DeviceName: "/dev/sda1" + Bsu: + VolumeType: standard DeleteOnVmDeletion: true - SnapshotId: snap-12345678 VolumeSize: 50 - VolumeType: standard - DeviceName: "/dev/sda1" + SnapshotId: snap-12345678 + ImageType: machine CreationDate: '2010-10-01T12:34:56.789Z' - Description: Private image FileLocation: 123456789012/image-example - ImageId: ami-12345678 + Architecture: x86_64 ImageName: image-example - ImageType: machine - PermissionsToLaunch: - AccountIds: [] - GlobalPermission: false - ProductCodes: - - '0001' - RootDeviceName: "/dev/sda1" - RootDeviceType: bsu - State: available - StateComment: {} - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UpdateImageResponse" description: The HTTP 200 response (OK). '400': content: @@ -23617,80 +23884,82 @@ paths: tags: - Image "/UpdateListenerRule": - description: |- - Updates the pattern of the listener rule.
- This call updates the pattern matching algorithm for incoming traffic. post: + description: |- + Updates the pattern of the listener rule.
+ This call updates the pattern matching algorithm for incoming traffic. operationId: UpdateListenerRule requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateListenerRuleRequest" examples: ex1: value: - HostPattern: "*.newhost.com" ListenerRuleName: example-listener-rule - schema: - "$ref": "#/components/schemas/UpdateListenerRuleRequest" + HostPattern: "*.newhost.com" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateListenerRuleResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ListenerRule: - Action: forward - HostNamePattern: "*.newhost.com" - ListenerId: 123456 - ListenerRuleId: 1234 - ListenerRuleName: example-listener-rule Priority: 10 VmIds: - i-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UpdateListenerRuleResponse" + ListenerRuleName: example-listener-rule + Action: forward + ListenerId: 123456 + HostNamePattern: "*.newhost.com" + ListenerRuleId: 1234 description: The HTTP 200 response (OK). tags: - Listener "/UpdateLoadBalancer": - description: |- - Modifies the specified attribute of a load balancer. You can specify only one attribute at a time.

+ post: + description: |- + Modifies the specified attribute of a load balancer. You can specify only one attribute at a time.

- You can set a new SSL certificate to an SSL or HTTPS listener of a load balancer.
- This certificate replaces any certificate used on the same load balancer and port.

+ You can set a new SSL certificate to an SSL or HTTPS listener of a load balancer.
+ This certificate replaces any certificate used on the same load balancer and port.

- You can also replace the currently enabled policy for the load balancer with another one.
- If the `PolicyNames` parameter is empty, the currently enabled policy is disabled. - post: + You can also replace the currently enabled policy for the load balancer with another one.
+ If the `PolicyNames` parameter is empty, the currently enabled policy is disabled. operationId: UpdateLoadBalancer requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateLoadBalancerRequest" examples: ex1: summary: Updating health checks value: + LoadBalancerName: private-lb-example HealthCheck: - CheckInterval: 30 HealthyThreshold: 10 + CheckInterval: 30 Path: "/index.html" Port: 8080 Protocol: HTTPS Timeout: 5 UnhealthyThreshold: 5 - LoadBalancerName: private-lb-example ex2: summary: Updating access logs value: + LoadBalancerName: private-lb-example AccessLog: + PublicationInterval: 5 IsEnabled: true OsuBucketName: BUCKET OsuBucketPrefix: PREFIX - PublicationInterval: 5 - LoadBalancerName: private-lb-example ex3: summary: Updating policies value: @@ -23704,219 +23973,217 @@ paths: LoadBalancerName: private-lb-example LoadBalancerPort: 443 ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/AnotherCertificate - schema: - "$ref": "#/components/schemas/UpdateLoadBalancerRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateLoadBalancerResponse" examples: ex1: summary: Updating health checks value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 LoadBalancer: + Tags: [] + SourceSecurityGroup: + SecurityGroupName: security-group-example + SecurityGroupAccountId: '123456789012' + SecuredCookies: false + PublicIp: 192.0.2.0 + Subnets: + - subnet-12345678 + NetId: vpc-12345678 + BackendVmIds: [] + ApplicationStickyCookiePolicies: [] + SecurityGroups: + - sg-12345678 + LoadBalancerType: internet-facing AccessLog: - IsEnabled: false PublicationInterval: 60 - ApplicationStickyCookiePolicies: [] - BackendVmIds: [] + IsEnabled: false DnsName: private-lb-example.123456789.eu-west-2.lbu.outscale.com HealthCheck: + UnhealthyThreshold: 5 + Timeout: 5 CheckInterval: 30 - HealthyThreshold: 10 Path: "/index.html" - Port: 8080 Protocol: HTTPS - Timeout: 5 - UnhealthyThreshold: 5 + HealthyThreshold: 10 + Port: 8080 + LoadBalancerStickyCookiePolicies: [] + SubregionNames: + - eu-west-2a Listeners: - - BackendPort: 80 + - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate + BackendPort: 80 BackendProtocol: HTTP LoadBalancerPort: 443 LoadBalancerProtocol: HTTPS - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate LoadBalancerName: private-lb-example - LoadBalancerStickyCookiePolicies: [] - LoadBalancerType: internet-facing - NetId: vpc-12345678 - PublicIp: 192.0.2.0 - SecuredCookies: false - SecurityGroups: - - sg-12345678 - SourceSecurityGroup: - SecurityGroupAccountId: '123456789012' - SecurityGroupName: security-group-example - Subnets: - - subnet-12345678 - SubregionNames: - - eu-west-2a - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Updating access logs value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 LoadBalancer: + Tags: [] + SourceSecurityGroup: + SecurityGroupName: security-group-example + SecurityGroupAccountId: '123456789012' + SecuredCookies: false + PublicIp: 192.0.2.0 + Subnets: + - subnet-12345678 + NetId: vpc-12345678 + BackendVmIds: [] + ApplicationStickyCookiePolicies: [] + SecurityGroups: + - sg-12345678 + LoadBalancerType: internet-facing AccessLog: - IsEnabled: true - OsuBucketName: BUCKET - OsuBucketPrefix: PREFIX PublicationInterval: 5 - ApplicationStickyCookiePolicies: [] - BackendVmIds: [] + OsuBucketPrefix: PREFIX + OsuBucketName: BUCKET + IsEnabled: true DnsName: private-lb-example.123456789.eu-west-2.lbu.outscale.com HealthCheck: + UnhealthyThreshold: 2 + Timeout: 5 CheckInterval: 30 + Protocol: TCP HealthyThreshold: 10 Port: 80 - Protocol: TCP - Timeout: 5 - UnhealthyThreshold: 2 + LoadBalancerStickyCookiePolicies: [] + SubregionNames: + - eu-west-2a Listeners: - - BackendPort: 80 + - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate + BackendPort: 80 BackendProtocol: HTTP LoadBalancerPort: 443 LoadBalancerProtocol: HTTPS - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate LoadBalancerName: private-lb-example - LoadBalancerStickyCookiePolicies: [] - LoadBalancerType: internet-facing - NetId: vpc-12345678 - PublicIp: 192.0.2.0 - SecuredCookies: false - SecurityGroups: - - sg-12345678 - SourceSecurityGroup: - SecurityGroupAccountId: '123456789012' - SecurityGroupName: security-group-example - Subnets: - - subnet-12345678 - SubregionNames: - - eu-west-2a - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex3: summary: Updating policies value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 LoadBalancer: + Tags: [] + SourceSecurityGroup: + SecurityGroupName: security-group-example + SecurityGroupAccountId: '123456789012' + SecuredCookies: false + PublicIp: 192.0.2.0 + Subnets: + - subnet-12345678 + NetId: vpc-12345678 + BackendVmIds: [] + ApplicationStickyCookiePolicies: [] + SecurityGroups: + - sg-12345678 + LoadBalancerType: internet-facing AccessLog: - IsEnabled: false PublicationInterval: 60 - ApplicationStickyCookiePolicies: [] - BackendVmIds: [] + IsEnabled: false DnsName: private-lb-example.123456789.eu-west-2.lbu.outscale.com HealthCheck: + UnhealthyThreshold: 2 + Timeout: 5 CheckInterval: 30 + Protocol: TCP HealthyThreshold: 10 Port: 80 - Protocol: TCP - Timeout: 5 - UnhealthyThreshold: 2 + LoadBalancerStickyCookiePolicies: + - PolicyName: example-browser-policy + CookieExpirationPeriod: 1 + SubregionNames: + - eu-west-2a Listeners: - - BackendPort: 80 + - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate + BackendPort: 80 BackendProtocol: HTTP LoadBalancerPort: 443 LoadBalancerProtocol: HTTPS - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate LoadBalancerName: private-lb-example - LoadBalancerStickyCookiePolicies: - - CookieExpirationPeriod: 1 - PolicyName: example-browser-policy - LoadBalancerType: internet-facing - NetId: vpc-12345678 - PublicIp: 192.0.2.0 - SecuredCookies: false - SecurityGroups: - - sg-12345678 - SourceSecurityGroup: - SecurityGroupAccountId: '123456789012' - SecurityGroupName: security-group-example - Subnets: - - subnet-12345678 - SubregionNames: - - eu-west-2a - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex4: summary: Updating SSL certificate value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 LoadBalancer: + Tags: [] + SourceSecurityGroup: + SecurityGroupName: security-group-example + SecurityGroupAccountId: '123456789012' + SecuredCookies: false + PublicIp: 192.0.2.0 + Subnets: + - subnet-12345678 + NetId: vpc-12345678 + BackendVmIds: [] + ApplicationStickyCookiePolicies: [] + SecurityGroups: + - sg-12345678 + LoadBalancerType: internet-facing AccessLog: - IsEnabled: false PublicationInterval: 60 - ApplicationStickyCookiePolicies: [] - BackendVmIds: [] + IsEnabled: false DnsName: private-lb-example.123456789.eu-west-2.lbu.outscale.com HealthCheck: + UnhealthyThreshold: 2 + Timeout: 5 CheckInterval: 30 + Protocol: TCP HealthyThreshold: 10 Port: 80 - Protocol: TCP - Timeout: 5 - UnhealthyThreshold: 2 + LoadBalancerStickyCookiePolicies: [] + SubregionNames: + - eu-west-2a Listeners: - - BackendPort: 80 + - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/AnotherCertificate + BackendPort: 80 BackendProtocol: HTTP LoadBalancerPort: 443 LoadBalancerProtocol: HTTPS - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/AnotherCertificate LoadBalancerName: private-lb-example - LoadBalancerStickyCookiePolicies: [] - LoadBalancerType: internet-facing - NetId: vpc-12345678 - PublicIp: 192.0.2.0 - SecuredCookies: false - SecurityGroups: - - sg-12345678 - SourceSecurityGroup: - SecurityGroupAccountId: '123456789012' - SecurityGroupName: security-group-example - Subnets: - - subnet-12345678 - SubregionNames: - - eu-west-2a - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UpdateLoadBalancerResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer "/UpdateNet": - description: Associates a DHCP options set with a specified Net. post: + description: Associates a DHCP options set with a specified Net. operationId: UpdateNet requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateNetRequest" examples: ex1: value: - DhcpOptionsSetId: dopt-12345678 NetId: vpc-12345678 - schema: - "$ref": "#/components/schemas/UpdateNetRequest" + DhcpOptionsSetId: dopt-12345678 responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateNetResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Net: + Tags: [] DhcpOptionsSetId: dopt-12345678 IpRange: 10.0.0.0/16 + Tenancy: default NetId: vpc-12345678 State: available - Tags: [] - Tenancy: default - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UpdateNetResponse" description: The HTTP 200 response (OK). '400': content: @@ -23939,81 +24206,83 @@ paths: tags: - Net "/UpdateNetAccessPoint": - description: |- - Modifies the attributes of a Net access point.
- This action enables you to add or remove route tables associated with the specified Net access point. post: + description: |- + Modifies the attributes of a Net access point.
+ This action enables you to add or remove route tables associated with the specified Net access point. operationId: UpdateNetAccessPoint requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateNetAccessPointRequest" examples: ex1: summary: Adding a route table value: + NetAccessPointId: vpce-12345678 AddRouteTableIds: - rtb-87654321 - NetAccessPointId: vpce-12345678 ex2: summary: Removing a route table value: NetAccessPointId: vpce-12345678 RemoveRouteTableIds: - rtb-12345678 - schema: - "$ref": "#/components/schemas/UpdateNetAccessPointRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateNetAccessPointResponse" examples: ex1: summary: Adding a route table value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 NetAccessPoint: + Tags: [] NetAccessPointId: vpce-12345678 - NetId: vpc-12345678 RouteTableIds: - rtb-12345678 - rtb-87654321 - ServiceName: com.outscale.eu-west-2.oos State: available - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + NetId: vpc-12345678 + ServiceName: com.outscale.eu-west-2.oos ex2: summary: Removing a route table value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 NetAccessPoint: + Tags: [] NetAccessPointId: vpce-12345678 - NetId: vpc-12345678 RouteTableIds: [] - ServiceName: com.outscale.eu-west-2.oos State: available - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UpdateNetAccessPointResponse" + NetId: vpc-12345678 + ServiceName: com.outscale.eu-west-2.oos description: The HTTP 200 response (OK). tags: - NetAccessPoint "/UpdateNic": - description: Modifies the specified network interface card (NIC). You can specify - only one attribute at a time. post: + description: Modifies the specified network interface card (NIC). You can specify + only one attribute at a time. operationId: UpdateNic requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateNicRequest" examples: ex1: summary: Modifying the DeleteOnVmDeletion value of a NIC value: + NicId: eni-12345678 LinkNic: DeleteOnVmDeletion: false LinkNicId: eni-attach-12345678 - NicId: eni-12345678 ex2: summary: Modifying the security groups of a NIC value: @@ -24023,110 +24292,108 @@ paths: ex3: summary: Modifying the description of a NIC value: - Description: Example of description NicId: eni-12345678 - schema: - "$ref": "#/components/schemas/UpdateNicRequest" + Description: Example of description responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateNicResponse" examples: ex1: summary: Modifying the DeleteOnVmDeletion value of a NIC value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Nic: - AccountId: '123456789012' - Description: Primary network interface - IsSourceDestChecked: true + SubregionName: eu-west-2a + SubnetId: subnet-12345678 + State: in-use LinkNic: + VmId: i-12345678 + LinkNicId: eni-attach-12345678 + VmAccountId: '123456789012' DeleteOnVmDeletion: false DeviceNumber: 0 - LinkNicId: eni-attach-12345678 State: attached - VmAccountId: '123456789012' - VmId: i-12345678 + IsSourceDestChecked: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + Tags: [] + Description: Primary network interface + AccountId: '123456789012' + SecurityGroups: + - SecurityGroupName: default + SecurityGroupId: sg-12345678 MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - IsPrimary: true - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - SecurityGroups: - - SecurityGroupId: sg-12345678 - SecurityGroupName: default - State: in-use - SubnetId: subnet-12345678 - SubregionName: eu-west-2a - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + IsPrimary: true ex2: summary: Modifying the security groups of a NIC value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Nic: - AccountId: '123456789012' - Description: Primary network interface - IsSourceDestChecked: true + SubregionName: eu-west-2a + SubnetId: subnet-12345678 + State: in-use LinkNic: + VmId: i-12345678 + LinkNicId: eni-attach-12345678 + VmAccountId: '123456789012' DeleteOnVmDeletion: true DeviceNumber: 0 - LinkNicId: eni-attach-12345678 State: attached - VmAccountId: '123456789012' - VmId: i-12345678 + IsSourceDestChecked: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + Tags: [] + Description: Primary network interface + AccountId: '123456789012' + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - IsPrimary: true - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - SecurityGroups: - - SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - State: in-use - SubnetId: subnet-12345678 - SubregionName: eu-west-2a - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + IsPrimary: true ex3: summary: Modifying the description of a NIC value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Nic: - AccountId: '123456789012' - Description: Example of description - IsSourceDestChecked: true + SubregionName: eu-west-2a + SubnetId: subnet-12345678 + State: in-use LinkNic: + VmId: i-12345678 + LinkNicId: eni-attach-12345678 + VmAccountId: '123456789012' DeleteOnVmDeletion: true DeviceNumber: 0 - LinkNicId: eni-attach-12345678 State: attached - VmAccountId: '123456789012' - VmId: i-12345678 + IsSourceDestChecked: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + Tags: [] + Description: Example of description + AccountId: '123456789012' + SecurityGroups: + - SecurityGroupName: default + SecurityGroupId: sg-12345678 MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - IsPrimary: true - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - SecurityGroups: - - SecurityGroupId: sg-12345678 - SecurityGroupName: default - State: in-use - SubnetId: subnet-12345678 - SubregionName: eu-west-2a - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UpdateNicResponse" + IsPrimary: true description: The HTTP 200 response (OK). '400': content: @@ -24149,62 +24416,62 @@ paths: tags: - Nic "/UpdateRoute": - description: |- - Replaces an existing route within a route table in a Net.
- You must specify one of the following elements as the target:

+ post: + description: |- + Replaces an existing route within a route table in a Net.
+ You must specify one of the following elements as the target:

- * Net peering
- * NAT virtual machine (VM)
- * Internet service
- * Virtual gateway
- * NAT service
- * Network interface card (NIC)

+ * Net peering
+ * NAT virtual machine (VM)
+ * Internet service
+ * Virtual gateway
+ * NAT service
+ * Network interface card (NIC)

- The routing algorithm is based on the most specific match. - post: + The routing algorithm is based on the most specific match. operationId: UpdateRoute requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateRouteRequest" examples: ex1: summary: Updating a route to a virtual gateway value: + RouteTableId: rtb-12345678 DestinationIpRange: 198.51.100.0/24 GatewayId: vgw-12345678 - RouteTableId: rtb-12345678 - schema: - "$ref": "#/components/schemas/UpdateRouteRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateRouteResponse" examples: ex1: summary: Updating a route to a virtual gateway value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 RouteTable: + Routes: + - DestinationIpRange: 10.0.0.0/16 + CreationMethod: CreateRouteTable + State: active + - GatewayId: vgw-12345678 + DestinationIpRange: 198.51.100.0/24 + CreationMethod: CreateRoute + State: active LinkRouteTables: - - LinkRouteTableId: rtbassoc-12345678 + - RouteTableId: rtb-12345678 Main: false - RouteTableId: rtb-12345678 SubnetId: subnet-12345678 + LinkRouteTableId: rtbassoc-12345678 NetId: vpc-12345678 + Tags: [] RoutePropagatingVirtualGateways: [] RouteTableId: rtb-12345678 - Routes: - - CreationMethod: CreateRouteTable - DestinationIpRange: 10.0.0.0/16 - State: active - - CreationMethod: CreateRoute - DestinationIpRange: 198.51.100.0/24 - GatewayId: vgw-12345678 - State: active - Tags: [] - schema: - "$ref": "#/components/schemas/UpdateRouteResponse" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -24227,77 +24494,77 @@ paths: tags: - Route "/UpdateRoutePropagation": - description: Configures the propagation of routes to a specified route table of - a Net by a virtual gateway. post: + description: Configures the propagation of routes to a specified route table + of a Net by a virtual gateway. operationId: UpdateRoutePropagation requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateRoutePropagationRequest" examples: ex1: value: - Enable: true - RouteTableId: rtb-12345678 VirtualGatewayId: vgw-12345678 - schema: - "$ref": "#/components/schemas/UpdateRoutePropagationRequest" + RouteTableId: rtb-12345678 + Enable: true responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateRoutePropagationResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 RouteTable: + Routes: + - DestinationIpRange: 10.0.0.0/16 + CreationMethod: CreateRouteTable + State: active LinkRouteTables: - - LinkRouteTableId: rtbassoc-12345678 + - RouteTableId: rtb-12345678 Main: true - RouteTableId: rtb-12345678 + LinkRouteTableId: rtbassoc-12345678 NetId: vpc-12345678 + Tags: [] RoutePropagatingVirtualGateways: - VirtualGatewayId: vgw-12345678 RouteTableId: rtb-12345678 - Routes: - - CreationMethod: CreateRouteTable - DestinationIpRange: 10.0.0.0/16 - State: active - Tags: [] - schema: - "$ref": "#/components/schemas/UpdateRoutePropagationResponse" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - VirtualGateway "/UpdateRouteTableLink": - description: |- - Replaces the route table associated with a specific Subnet in a Net with another one.
- After the route table is replaced, the Subnet uses the routes in the new route table it is associated with. post: + description: |- + Replaces the route table associated with a specific Subnet in a Net with another one.
+ After the route table is replaced, the Subnet uses the routes in the new route table it is associated with. operationId: UpdateRouteTableLink requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateRouteTableLinkRequest" examples: ex1: value: LinkRouteTableId: rtbassoc-12345678 RouteTableId: rtb-12345678 - schema: - "$ref": "#/components/schemas/UpdateRouteTableLinkRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateRouteTableLinkResponse" examples: ex1: value: - LinkRouteTableId: rtbassoc-12345678 ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UpdateRouteTableLinkResponse" + LinkRouteTableId: rtbassoc-12345678 description: The HTTP 200 response (OK). '400': content: @@ -24320,160 +24587,160 @@ paths: tags: - RouteTable "/UpdateServerCertificate": - description: Modifies the name and/or the path of a specified server certificate. post: + description: Modifies the name and/or the path of a specified server certificate. operationId: UpdateServerCertificate requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateServerCertificateRequest" examples: ex1: value: Name: server-cert-example NewName: new-name - schema: - "$ref": "#/components/schemas/UpdateServerCertificateRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateServerCertificateResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ServerCertificate: + Path: "/example/" Id: ABCDEFGHIJKLMNOPQRSTUVWXYZ1234 Name: new-name - Path: "/example/" - schema: - "$ref": "#/components/schemas/UpdateServerCertificateResponse" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - ServerCertificate "/UpdateSnapshot": - description: |- - Modifies the permissions for a specified snapshot.
- You must specify either the `Additions` or the `Removals` parameter.
- After sharing a snapshot with an account, the other account can create a copy of it that they own. For more information about copying snapshots, see [CreateSnapshot](#createsnapshot). post: + description: |- + Modifies the permissions for a specified snapshot.
+ You must specify either the `Additions` or the `Removals` parameter.
+ After sharing a snapshot with an account, the other account can create a copy of it that they own. For more information about copying snapshots, see [CreateSnapshot](#createsnapshot). operationId: UpdateSnapshot requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateSnapshotRequest" examples: ex1: summary: Adding permission value: + SnapshotId: snap-12345678 PermissionsToCreateVolume: Additions: AccountIds: - '987654321098' - SnapshotId: snap-12345678 ex2: summary: Removing permission value: + SnapshotId: snap-12345678 PermissionsToCreateVolume: Removals: AccountIds: - '987654321098' - SnapshotId: snap-12345678 ex3: summary: Making an image public to everyone value: + SnapshotId: snap-12345678 PermissionsToCreateVolume: Additions: GlobalPermission: true - SnapshotId: snap-12345678 ex4: summary: Making an image private to everyone value: + SnapshotId: snap-12345678 PermissionsToCreateVolume: Removals: GlobalPermission: true - SnapshotId: snap-12345678 - schema: - "$ref": "#/components/schemas/UpdateSnapshotRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateSnapshotResponse" examples: ex1: summary: Adding permission value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Snapshot: + VolumeSize: 10 AccountId: '123456789012' + VolumeId: vol-12345678 CreationDate: '2010-10-01T12:34:56.789Z' - Description: Snapshot created from a volume PermissionsToCreateVolume: + GlobalPermission: false AccountIds: - '987654321098' - GlobalPermission: false Progress: 100 SnapshotId: snap-12345678 State: completed + Description: Snapshot created from a volume Tags: [] - VolumeId: vol-12345678 - VolumeSize: 10 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Removing permission value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Snapshot: + VolumeSize: 10 AccountId: '123456789012' + VolumeId: vol-12345678 CreationDate: '2010-10-01T12:34:56.789Z' - Description: Snapshot created from a volume PermissionsToCreateVolume: - AccountIds: [] GlobalPermission: false + AccountIds: [] Progress: 100 SnapshotId: snap-12345678 State: completed + Description: Snapshot created from a volume Tags: [] - VolumeId: vol-12345678 - VolumeSize: 10 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex3: summary: Making an image public to everyone value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Snapshot: + VolumeSize: 10 AccountId: '123456789012' + VolumeId: vol-12345678 CreationDate: '2010-10-01T12:34:56.789Z' - Description: Snapshot created from a volume PermissionsToCreateVolume: - AccountIds: [] GlobalPermission: true + AccountIds: [] Progress: 100 SnapshotId: snap-12345678 State: completed + Description: Snapshot created from a volume Tags: [] - VolumeId: vol-12345678 - VolumeSize: 10 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex4: summary: Making an image private to everyone value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Snapshot: + VolumeSize: 10 AccountId: '123456789012' + VolumeId: vol-12345678 CreationDate: '2010-10-01T12:34:56.789Z' - Description: Snapshot created from a volume PermissionsToCreateVolume: - AccountIds: [] GlobalPermission: false + AccountIds: [] Progress: 100 SnapshotId: snap-12345678 State: completed + Description: Snapshot created from a volume Tags: [] - VolumeId: vol-12345678 - VolumeSize: 10 - schema: - "$ref": "#/components/schemas/UpdateSnapshotResponse" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -24496,39 +24763,39 @@ paths: tags: - Snapshot "/UpdateSubnet": - description: Modifies the specified attribute of a Subnet. post: + description: Modifies the specified attribute of a Subnet. operationId: UpdateSubnet requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateSubnetRequest" examples: ex1: value: - MapPublicIpOnLaunch: true SubnetId: subnet-12345678 - schema: - "$ref": "#/components/schemas/UpdateSubnetRequest" + MapPublicIpOnLaunch: true responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateSubnetResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Subnet: + Tags: [] + SubregionName: eu-west-2a + SubnetId: subnet-12345678 AvailableIpsCount: 16379 IpRange: 10.0.0.0/18 MapPublicIpOnLaunch: true - NetId: vpc-12345678 State: available - SubnetId: subnet-12345678 - SubregionName: eu-west-2a - Tags: [] - schema: - "$ref": "#/components/schemas/UpdateSubnetResponse" + NetId: vpc-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -24551,49 +24818,51 @@ paths: tags: - Subnet "/UpdateUser": - description: Modifies the name and/or the path of a specified EIM user. post: + description: Modifies the name and/or the path of a specified EIM user. operationId: UpdateUser requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateUserRequest" examples: ex1: value: - NewPath: "/product/" + UserName: example-user NewUserEmail: user@example.com NewUserName: test-user - UserName: example-user - schema: - "$ref": "#/components/schemas/UpdateUserRequest" + NewPath: "/product/" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateUserResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 User: CreationDate: 2010-10-01 12:34:56.789000000 +00:00 LastModificationDate: 2017-05-10 12:34:56.789000000 +00:00 - Path: "/product/" UserEmail: user@example.com - UserId: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 UserName: test-user - schema: - "$ref": "#/components/schemas/UpdateUserResponse" + UserId: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 + Path: "/product/" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - User "/UpdateUserGroup": - description: Modifies the name and/or the path of a specified group. post: + description: Modifies the name and/or the path of a specified group. operationId: UpdateUserGroup requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateUserGroupRequest" examples: ex1: value: @@ -24601,12 +24870,12 @@ paths: NewUserGroupName: new-usergroup Path: "/example/" UserGroupName: example-usergroup - schema: - "$ref": "#/components/schemas/UpdateUserGroupRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateUserGroupResponse" examples: ex1: value: @@ -24626,26 +24895,26 @@ paths: UserEmail: user@example.com UserId: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 UserName: example-user - schema: - "$ref": "#/components/schemas/UpdateUserGroupResponse" description: The HTTP 200 response (OK). tags: - UserGroup "/UpdateVm": - description: |- - Modifies the specified attributes of a virtual machine (VM).
- You must stop the VM before modifying the following attributes:
- * `NestedVirtualization`
- * `Performance`
- * `UserData`
- * `VmType` - - To complete the update of secure boot, you need to do a stop/start of the VM. A simple restart is not sufficient, as the update is done when the VM goes through the stopped state. For the difference between stop/start and restart, see [About VM Lifecycle](https://docs.outscale.com/en/userguide/About-VM-Lifecycle.html). post: + description: |- + Modifies the specified attributes of a virtual machine (VM).
+ You must stop the VM before modifying the following attributes:
+ * `NestedVirtualization`
+ * `Performance`
+ * `UserData`
+ * `VmType` + + To complete the update of secure boot, you need to do a stop/start of the VM. A simple restart is not sufficient, as the update is done when the VM goes through the stopped state. For the difference between stop/start and restart, see [About VM Lifecycle](https://docs.outscale.com/en/userguide/About-VM-Lifecycle.html). operationId: UpdateVm requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateVmRequest" examples: ex1: value: @@ -24653,159 +24922,157 @@ paths: VmType: tinav5.c2r2p2 ex2: value: - UserData: "..." VmId: i-12345678 - schema: - "$ref": "#/components/schemas/UpdateVmRequest" + UserData: "..." responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateVmResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Vm: - ActionsOnNextBoot: - SecureBoot: none + VmType: tinav5.c2r2p2 + VmInitiatedShutdownBehavior: stop + State: stopped + StateReason: '' + RootDeviceType: ebs + RootDeviceName: "/dev/sda1" + IsSourceDestChecked: true + KeypairName: keypair-example + ImageId: ami-12345678 + DeletionProtection: false Architecture: x86_64 + NestedVirtualization: false BlockDeviceMappings: - - Bsu: - DeleteOnVmDeletion: true - LinkDate: '2010-10-01T12:34:56.789Z' - State: attached + - DeviceName: "/dev/sda1" + Bsu: VolumeId: vol-12345678 - DeviceName: "/dev/sda1" - BsuOptimized: false - CreationDate: '2010-10-01T12:34:56.789Z' - DeletionProtection: false + State: attached + LinkDate: '2010-10-01T12:34:56.789Z' + DeleteOnVmDeletion: true + VmId: i-12345678 + ReservationId: r-12345678 Hypervisor: xen - ImageId: ami-12345678 - IsSourceDestChecked: true - KeypairName: keypair-example + Placement: + Tenancy: default + SubregionName: eu-west-2a + ProductCodes: + - '0001' + CreationDate: '2010-10-01T12:34:56.789Z' + UserData: '' + SubnetId: subnet-12345678 + PrivateIp: 10.0.0.4 + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 + BsuOptimized: false LaunchNumber: 0 - NestedVirtualization: false NetId: vpc-12345678 Nics: - - AccountId: '123456789012' - Description: Primary network interface - IsSourceDestChecked: true + - SubnetId: subnet-12345678 + State: in-use LinkNic: - DeleteOnVmDeletion: true + State: attached DeviceNumber: 0 LinkNicId: eni-attach-12345678 - State: attached + DeleteOnVmDeletion: true + IsSourceDestChecked: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + Description: Primary network interface + AccountId: '123456789012' + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - IsPrimary: true - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - SecurityGroups: - - SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - State: in-use - SubnetId: subnet-12345678 + IsPrimary: true Performance: high - Placement: - SubregionName: eu-west-2a - Tenancy: default - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal - PrivateIp: 10.0.0.4 - ProductCodes: - - '0001' - ReservationId: r-12345678 - RootDeviceName: "/dev/sda1" - RootDeviceType: ebs - SecurityGroups: - - SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - State: stopped - StateReason: '' - SubnetId: subnet-12345678 Tags: - - Key: env - Value: prod - UserData: '' - VmId: i-12345678 - VmInitiatedShutdownBehavior: stop - VmType: tinav5.c2r2p2 - ex2: - value: + - Value: prod + Key: env + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + ActionsOnNextBoot: + SecureBoot: none ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + value: Vm: - ActionsOnNextBoot: - SecureBoot: none + VmType: tinav5.c1r1p2 + VmInitiatedShutdownBehavior: stop + State: stopped + StateReason: '' + RootDeviceType: ebs + RootDeviceName: "/dev/sda1" + IsSourceDestChecked: true + KeypairName: keypair-example + ImageId: ami-12345678 + DeletionProtection: true Architecture: x86_64 + NestedVirtualization: false BlockDeviceMappings: - - Bsu: - DeleteOnVmDeletion: true - LinkDate: '2010-10-01T12:34:56.789Z' - State: attached + - DeviceName: "/dev/sda1" + Bsu: VolumeId: vol-12345678 - DeviceName: "/dev/sda1" - BsuOptimized: false - CreationDate: '2010-10-01T12:34:56.789Z' - DeletionProtection: true + State: attached + LinkDate: '2010-10-01T12:34:56.789Z' + DeleteOnVmDeletion: true + VmId: i-12345678 + ReservationId: r-12345678 Hypervisor: xen - ImageId: ami-12345678 - IsSourceDestChecked: true - KeypairName: keypair-example + Placement: + Tenancy: default + SubregionName: eu-west-2a + ProductCodes: + - '0001' + CreationDate: '2010-10-01T12:34:56.789Z' + UserData: "..." + SubnetId: subnet-12345678 + PrivateIp: 10.0.0.4 + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 + BsuOptimized: false LaunchNumber: 0 - NestedVirtualization: false NetId: vpc-12345678 Nics: - - AccountId: '123456789012' - Description: Primary network interface - IsSourceDestChecked: true + - SubnetId: subnet-12345678 + State: in-use LinkNic: - DeleteOnVmDeletion: true + State: attached DeviceNumber: 0 LinkNicId: eni-attach-12345678 - State: attached + DeleteOnVmDeletion: true + IsSourceDestChecked: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + Description: Primary network interface + AccountId: '123456789012' + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - IsPrimary: true - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - SecurityGroups: - - SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - State: in-use - SubnetId: subnet-12345678 + IsPrimary: true Performance: high - Placement: - SubregionName: eu-west-2a - Tenancy: default - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal - PrivateIp: 10.0.0.4 - ProductCodes: - - '0001' - ReservationId: r-12345678 - RootDeviceName: "/dev/sda1" - RootDeviceType: ebs - SecurityGroups: - - SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - State: stopped - StateReason: '' - SubnetId: subnet-12345678 Tags: - - Key: env - Value: prod - UserData: "..." - VmId: i-12345678 - VmInitiatedShutdownBehavior: stop - VmType: tinav5.c1r1p2 - schema: - "$ref": "#/components/schemas/UpdateVmResponse" + - Value: prod + Key: env + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + ActionsOnNextBoot: + SecureBoot: none + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -24828,55 +25095,55 @@ paths: tags: - Vm "/UpdateVmGroup": - description: |- - > [WARNING]
- > This feature is currently under development and may not function properly.
- - Modifies the specified attributes of a group of virtual machines (VMs). post: + description: |- + > [WARNING]
+ > This feature is currently under development and may not function properly.
+ + Modifies the specified attributes of a group of virtual machines (VMs). operationId: UpdateVmGroup requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateVmGroupRequest" examples: ex1: summary: Updating the name and description of a VM group value: - Description: New description of the VM group VmGroupId: vmgroup-12345678901234567890123456789012 VmGroupName: new-name + Description: New description of the VM group ex2: summary: Updating the VM template of a VM group value: VmGroupId: vmgroup-12345678901234567890123456789012 VmTemplateId: vmtemplate-98765432109876543210987654321012 - schema: - "$ref": "#/components/schemas/UpdateVmGroupRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateVmGroupResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VmGroup: - CreationDate: 2010-10-01 12:34:56.789000000 +00:00 - Description: New description of the VM group - PositioningStrategy: attract + VmTemplateId: vmtemplate-98765432109876543210987654321012 SecurityGroupIds: - sg-12345678 - State: available - SubnetId: subnet-12345678 - Tags: [] + VmIds: [] + CreationDate: 2010-10-01 12:34:56.789000000 +00:00 VmCount: 2 - VmGroupId: vmgroup-12345678901234567890123456789012 VmGroupName: new-name - VmIds: [] - VmTemplateId: vmtemplate-98765432109876543210987654321012 - schema: - "$ref": "#/components/schemas/UpdateVmGroupResponse" + SubnetId: subnet-12345678 + PositioningStrategy: attract + State: available + VmGroupId: vmgroup-12345678901234567890123456789012 + Description: New description of the VM group + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -24899,112 +25166,112 @@ paths: tags: - VmGroup "/UpdateVmTemplate": - description: |- - > [WARNING]
- > This feature is currently under development and may not function properly.
- - Modifies the specified attributes of a template of virtual machines (VMs). post: + description: |- + > [WARNING]
+ > This feature is currently under development and may not function properly.
+ + Modifies the specified attributes of a template of virtual machines (VMs). operationId: UpdateVmTemplate requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateVmTemplateRequest" examples: ex1: value: Description: The new description of the VM template VmTemplateId: vmtemplate-98765432109876543210987654321012 VmTemplateName: second-name - schema: - "$ref": "#/components/schemas/UpdateVmTemplateRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateVmTemplateResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VmTemplate: - CpuCores: 2 - CpuGeneration: v4 + VmTemplateName: second-name CpuPerformance: high CreationDate: 2010-10-01 12:34:56.789000000 +00:00 + CpuCores: 2 + Tags: [] Description: The new description of the VM template ImageId: ami-12345678 - Ram: 2 - Tags: [] + CpuGeneration: v4 VmTemplateId: vmtemplate-98765432109876543210987654321012 - VmTemplateName: second-name - schema: - "$ref": "#/components/schemas/UpdateVmTemplateResponse" + Ram: 2 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - VmTemplate "/UpdateVolume": - description: |- - Modifies the specified attributes of a volume.
- Cold volumes are volumes that are attached to stopped or stopping VMs, or that are detached. Hot volumes are volumes that are attached to running VMs.

- - **[NOTE]**
- When the modification is not instantaneous, the response displays the previous value. You can use the [ReadVolumes](#readvolumes) method to see the new value. post: + description: |- + Modifies the specified attributes of a volume.
+ Cold volumes are volumes that are attached to stopped or stopping VMs, or that are detached. Hot volumes are volumes that are attached to running VMs.

+ + **[NOTE]**
+ When the modification is not instantaneous, the response displays the previous value. You can use the [ReadVolumes](#readvolumes) method to see the new value. operationId: UpdateVolume requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateVolumeRequest" examples: ex1: summary: Updating the size of a volume value: - Size: 50 VolumeId: vol-12345678 + Size: 50 ex2: summary: Updating the type of a volume to io1 value: - Iops: 200 VolumeId: vol-12345678 VolumeType: io1 - schema: - "$ref": "#/components/schemas/UpdateVolumeRequest" + Iops: 200 responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateVolumeResponse" examples: ex1: summary: Updating the size of a volume value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Volume: + VolumeId: vol-12345678 + Tags: [] + VolumeType: gp2 + SubregionName: eu-west-2a + State: available CreationDate: '2010-10-01T12:34:56.789Z' Iops: 100 LinkedVolumes: [] Size: 10 - State: available - SubregionName: eu-west-2a - Tags: [] - VolumeId: vol-12345678 - VolumeType: gp2 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Updating the type of a volume to io1 value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Volume: + VolumeId: vol-12345678 + Tags: [] + VolumeType: io1 + SubregionName: eu-west-2a + State: available CreationDate: '2010-10-01T12:34:56.789Z' Iops: 200 LinkedVolumes: [] Size: 10 - State: available - SubregionName: eu-west-2a - Tags: [] - VolumeId: vol-12345678 - VolumeType: io1 - schema: - "$ref": "#/components/schemas/UpdateVolumeResponse" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -25027,48 +25294,48 @@ paths: tags: - Volume "/UpdateVpnConnection": - description: Modifies the specified attributes of a VPN connection. post: + description: Modifies the specified attributes of a VPN connection. operationId: UpdateVpnConnection requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateVpnConnectionRequest" examples: ex1: value: VpnConnectionId: vpn-12345678 VpnOptions: TunnelInsideIpRange: 169.254.254.22/30 - schema: - "$ref": "#/components/schemas/UpdateVpnConnectionRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateVpnConnectionResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VpnConnection: + VpnOptions: + TunnelInsideIpRange: 169.254.254.22/30 + Routes: [] + Tags: [] ClientGatewayConfiguration: "..." - ClientGatewayId: cgw-12345678 + StaticRoutesOnly: true + VirtualGatewayId: vgw-12345678 ConnectionType: ipsec.1 - Routes: [] + ClientGatewayId: cgw-12345678 State: pending - StaticRoutesOnly: true - Tags: [] VgwTelemetries: - - AcceptedRouteCount: 0 + - StateDescription: IPSEC IS DOWN + AcceptedRouteCount: 0 LastStateChangeDate: '2017-05-10T12:34:56.789Z' OutsideIpAddress: 192.0.2.0 - StateDescription: IPSEC IS DOWN - VirtualGatewayId: vgw-12345678 VpnConnectionId: vpn-12345678 - VpnOptions: - TunnelInsideIpRange: 169.254.254.22/30 - schema: - "$ref": "#/components/schemas/UpdateVpnConnectionResponse" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: diff --git a/outscale-go.yaml b/outscale-go.yaml index 1e21fc8..44607c0 100644 --- a/outscale-go.yaml +++ b/outscale-go.yaml @@ -152,6 +152,10 @@ components: MobileNumber: description: The mobile phone number of the account owner. type: string + OutscaleLoginAllowed: + description: Whether the account is allowed to log in to Cockpit v2 using + its Outscale credentials when identity federation is activated. + type: boolean PhoneNumber: description: The landline phone number of the account owner. type: string @@ -345,7 +349,7 @@ components: type: string type: object BootMode: - description: Information about the boot mode of the OMI (`legacy` and/or `uefi`). + description: Information about the boot mode of the VM. enum: - uefi - legacy @@ -375,8 +379,8 @@ components: properties: DeleteOnVmDeletion: default: true - description: By default or if set to true, the volume is deleted when terminating - the VM. If false, the volume is not deleted when terminating the VM. + description: If set to true, the volume is deleted when terminating the + VM. If false, the volume is not deleted when terminating the VM. type: boolean Iops: description: The number of I/O operations per second (IOPS). This parameter @@ -482,7 +486,7 @@ components: description: The beginning of the time period (UTC). type: string State: - description: The state of the catalog (`CURRENT` \| `OBSOLETE`). + description: The state of the catalog. enum: - CURRENT - OBSOLETE @@ -998,7 +1002,7 @@ components: "$ref": "#/components/schemas/BlockDeviceMappingImage" type: array BootModes: - description: The boot modes compatible with the OMI (`legacy` and/or `uefi`). + description: The boot modes compatible with the OMI. items: "$ref": "#/components/schemas/BootMode" type: array @@ -1969,12 +1973,11 @@ components: type: boolean PositioningStrategy: default: no-strategy - description: The positioning strategy of VMs on hypervisors. By default, - or if set to `no-strategy` our orchestrator determines the most adequate - position for your VMs. If set to `attract`, your VMs are deployed on the - same hypervisor, which improves network performance. If set to `repulse`, - your VMs are deployed on a different hypervisor, which improves fault - tolerance. + description: The positioning strategy of VMs on hypervisors. If set to `no-strategy`, + our orchestrator determines the most adequate position for your VMs. If + set to `attract`, your VMs are deployed on the same hypervisor, which + improves network performance. If set to `repulse`, your VMs are deployed + on a different hypervisor, which improves fault tolerance. enum: - attract - no-strategy @@ -2028,7 +2031,7 @@ components: type: string CpuPerformance: default: high - description: The performance of the VMs (`medium` \| `high` \| `highest`). + description: The performance of the VMs. enum: - medium - high @@ -2088,8 +2091,8 @@ components: "$ref": "#/components/schemas/BootMode" BootOnCreation: default: true - description: By default or if true, the VM is started on creation. If false, - the VM is stopped on creation. + description: If true, the VM is started on creation. If false, the VM is + stopped on creation. type: boolean BsuOptimized: description: This parameter is not available. It is present in our API for @@ -2137,9 +2140,8 @@ components: type: array Performance: default: high - description: The performance of the VM (`medium` \| `high` \| `highest`). - By default, `high`. This parameter is ignored if you specify a performance - flag directly in the `VmType` parameter. + description: The performance of the VM. This parameter is ignored if you + specify a performance flag directly in the `VmType` parameter. enum: - medium - high @@ -2174,8 +2176,8 @@ components: type: string VmInitiatedShutdownBehavior: default: stop - description: The VM behavior when you stop it. By default or if set to `stop`, - the VM stops. If set to `restart`, the VM stops then automatically restarts. + description: The VM behavior when you stop it. If set to `stop`, the VM + stops. If set to `restart`, the VM stops then automatically restarts. If set to `terminate`, the VM stops and is terminated. type: string VmType: @@ -3496,7 +3498,7 @@ components: type: string Mtu: description: The maximum transmission unit (MTU) of the DirectLink interface, - in bytes (always `1500`). + in bytes. type: integer OutscalePrivateIp: description: The IP on the OUTSCALE side of the DirectLink interface. @@ -3512,6 +3514,102 @@ components: description: The VLAN number associated with the DirectLink interface. type: integer type: object + DisableOutscaleLoginForUsersRequest: + additionalProperties: false + properties: + DryRun: + description: If true, checks whether you have the required permissions to + perform the action. + type: boolean + type: object + DisableOutscaleLoginForUsersResponse: + additionalProperties: false + properties: + ResponseContext: + "$ref": "#/components/schemas/ResponseContext" + type: object + DisableOutscaleLoginPerUsersRequest: + additionalProperties: false + properties: + DryRun: + description: If true, checks whether you have the required permissions to + perform the action. + type: boolean + UserNames: + description: The usernames of the EIM users you want to disable the Outscale + login for. + items: + type: string + type: array + type: object + DisableOutscaleLoginPerUsersResponse: + additionalProperties: false + properties: + ResponseContext: + "$ref": "#/components/schemas/ResponseContext" + type: object + DisableOutscaleLoginRequest: + additionalProperties: false + properties: + DryRun: + description: If true, checks whether you have the required permissions to + perform the action. + type: boolean + type: object + DisableOutscaleLoginResponse: + additionalProperties: false + properties: + ResponseContext: + "$ref": "#/components/schemas/ResponseContext" + type: object + EnableOutscaleLoginForUsersRequest: + additionalProperties: false + properties: + DryRun: + description: If true, checks whether you have the required permissions to + perform the action. + type: boolean + type: object + EnableOutscaleLoginForUsersResponse: + additionalProperties: false + properties: + ResponseContext: + "$ref": "#/components/schemas/ResponseContext" + type: object + EnableOutscaleLoginPerUsersRequest: + additionalProperties: false + properties: + DryRun: + description: If true, checks whether you have the required permissions to + perform the action. + type: boolean + UserNames: + description: The usernames of the EIM users you want to enable the Outscale + login for. + items: + type: string + type: array + type: object + EnableOutscaleLoginPerUsersResponse: + additionalProperties: false + properties: + ResponseContext: + "$ref": "#/components/schemas/ResponseContext" + type: object + EnableOutscaleLoginRequest: + additionalProperties: false + properties: + DryRun: + description: If true, checks whether you have the required permissions to + perform the action. + type: boolean + type: object + EnableOutscaleLoginResponse: + additionalProperties: false + properties: + ResponseContext: + "$ref": "#/components/schemas/ResponseContext" + type: object ErrorResponse: additionalProperties: false properties: @@ -3927,7 +4025,7 @@ components: type: string type: array BootModes: - description: The boot modes compatible with the OMIs (`legacy` and/or `uefi`). + description: The boot modes compatible with the OMIs. items: "$ref": "#/components/schemas/BootMode" type: array @@ -5111,7 +5209,7 @@ components: type: string type: array BootModes: - description: The boot modes of the VMs (`legacy` \| `uefi`). + description: The boot modes of the VMs. items: "$ref": "#/components/schemas/BootMode" type: array @@ -5717,7 +5815,7 @@ components: type: array VolumeStates: description: The states of the volumes (`creating` \| `available` \| `in-use` - \| `updating` \| `deleting` \| `error`). + \| `deleting` \| `error`). items: type: string type: array @@ -5902,7 +6000,7 @@ components: "$ref": "#/components/schemas/BlockDeviceMappingImage" type: array BootModes: - description: The boot modes compatible with the OMI (`legacy` and/or `uefi`). + description: The boot modes compatible with the OMI. items: "$ref": "#/components/schemas/BootMode" type: array @@ -6594,9 +6692,9 @@ components: description: The routing protocol (`HTTP` \| `HTTPS` \| `TCP` \| `SSL`). type: string ServerCertificateId: - description: The OUTSCALE Resource Name (ORN) of the server certificate. - For more information, see [Resource Identifiers > OUTSCALE Resource Names - (ORNs)](https://docs.outscale.com/en/userguide/Resource-Identifiers.html#_outscale_resource_names_orns). + description: |- + The OUTSCALE Resource Name (ORN) of the server certificate. For more information, see [Resource Identifiers > OUTSCALE Resource Names (ORNs)](https://docs.outscale.com/en/userguide/Resource-Identifiers.html#_outscale_resource_names_orns).
+ This parameter is required for `HTTPS` and `SSL` protocols. type: string required: - BackendPort @@ -7415,10 +7513,12 @@ components: description: Information about the policy entities. properties: Accounts: + description: The accounts linked to the specified policy. items: "$ref": "#/components/schemas/MinimalPolicy" type: array Groups: + description: The groups linked to the specified policy. items: "$ref": "#/components/schemas/MinimalPolicy" type: array @@ -7437,6 +7537,7 @@ components: allowed. type: boolean Users: + description: The users linked to the specified policy. items: "$ref": "#/components/schemas/MinimalPolicy" type: array @@ -7790,7 +7891,7 @@ components: ResultsPerPage: default: 100 description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer With: "$ref": "#/components/schemas/With" @@ -7884,7 +7985,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadClientGatewaysResponse: @@ -7945,11 +8046,11 @@ components: type: string Overall: default: false - description: By default or if false, returns only the consumption of the - specific account that sends this request. If true, returns either the - overall consumption of your paying account and all linked accounts (if - the account that sends this request is a paying account) or returns nothing - (if the account that sends this request is a linked account). + description: If false, returns only the consumption of the specific account + that sends this request. If true, returns either the overall consumption + of your paying account and all linked accounts (if the account that sends + this request is a paying account) or returns nothing (if the account that + sends this request is a linked account). type: boolean ShowPrice: description: If true, the response also includes the unit price of the consumed @@ -8001,7 +8102,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadDedicatedGroupsResponse: @@ -8036,7 +8137,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadDhcpOptionsResponse: @@ -8071,7 +8172,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadDirectLinkInterfacesResponse: @@ -8106,7 +8207,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadDirectLinksResponse: @@ -8129,8 +8230,8 @@ components: additionalProperties: false properties: EntitiesType: - description: The type of entity linked to the policy (`ACCOUNT` \| `USER` - \| `GROUP`) you want to get information about. + description: The type of entity linked to the policy you want to get information + about. items: enum: - ACCOUNT @@ -8216,7 +8317,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadImageExportTasksResponse: @@ -8251,7 +8352,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadImagesResponse: @@ -8286,7 +8387,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadInternetServicesResponse: @@ -8475,7 +8576,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadLocationsResponse: @@ -8554,7 +8655,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadNatServicesResponse: @@ -8589,7 +8690,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadNetAccessPointServicesResponse: @@ -8624,7 +8725,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadNetAccessPointsResponse: @@ -8659,7 +8760,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadNetPeeringsResponse: @@ -8694,7 +8795,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadNetsResponse: @@ -8729,7 +8830,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadNicsResponse: @@ -8901,7 +9002,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadProductTypesResponse: @@ -8950,7 +9051,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadPublicIpRangesResponse: @@ -8986,7 +9087,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadPublicIpsResponse: @@ -9021,7 +9122,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadQuotasResponse: @@ -9075,7 +9176,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadRouteTablesResponse: @@ -9110,7 +9211,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadSecurityGroupsResponse: @@ -9166,7 +9267,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadSnapshotExportTasksResponse: @@ -9201,7 +9302,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadSnapshotsResponse: @@ -9236,7 +9337,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadSubnetsResponse: @@ -9271,7 +9372,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadSubregionsResponse: @@ -9306,7 +9407,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadTagsResponse: @@ -9631,7 +9732,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadVirtualGatewaysResponse: @@ -9666,6 +9767,7 @@ components: ResponseContext: "$ref": "#/components/schemas/ResponseContext" VmGroups: + description: Information about one or more VM groups. items: "$ref": "#/components/schemas/VmGroup" type: array @@ -9707,7 +9809,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadVmTypesResponse: @@ -9771,7 +9873,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadVmsResponse: @@ -9795,8 +9897,8 @@ components: properties: AllVms: default: false - description: If true, includes the status of all VMs. By default or if set - to false, only includes the status of running VMs. + description: If true, includes the status of all VMs. If false, only includes + the status of running VMs. type: boolean DryRun: description: If true, checks whether you have the required permissions to @@ -9811,7 +9913,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadVmsStateResponse: @@ -9846,7 +9948,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadVolumesResponse: @@ -9881,7 +9983,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadVpnConnectionsResponse: @@ -10182,8 +10284,8 @@ components: "$ref": "#/components/schemas/ResponseContext" type: object SecureBootAction: - description: One action to perform on the next boot of the VM (`enable` | `disable` - | `setup-mode` |`none`). + description: One action to perform on the next boot of the VM. For more information, + see [About Secure Boot](https://docs.outscale.com/en/userguide/About-Secure-Boot.html#_secure_boot_actions). enum: - enable - disable @@ -10414,7 +10516,7 @@ components: type: string State: description: The state of the snapshot export task (`pending` \| `active` - \| `completed` \| `failed`). + \| `completed` \| `cancelled` \| `failed`). type: string Tags: description: One or more tags associated with the snapshot export task. @@ -11106,7 +11208,7 @@ components: type: boolean Mtu: description: The maximum transmission unit (MTU) of the DirectLink interface, - in bytes (always `1500`). + in bytes. enum: - 1500 type: integer @@ -11678,7 +11780,7 @@ components: enabled. If false, it is disabled." type: boolean Performance: - description: The performance of the VM (`medium` \| `high` \| `highest`). + description: The performance of the VM. enum: - medium - high @@ -11824,6 +11926,10 @@ components: description: The date and time (UTC) of the last modification of the EIM user. type: string + OutscaleLoginAllowed: + description: Whether the user is allowed to log in to Cockpit v2 using its + Outscale credentials when identity federation is activated. + type: boolean Path: description: The path to the EIM user. type: string @@ -11973,7 +12079,7 @@ components: description: Indicates the operating system (OS) of the VM. type: string Performance: - description: The performance of the VM (`medium` \| `high` \| `highest`). + description: The performance of the VM. type: string Placement: "$ref": "#/components/schemas/Placement" @@ -12050,10 +12156,10 @@ components: description: The description of the VM group. type: string PositioningStrategy: - description: The positioning strategy of the VMs on hypervisors. By default, - or if set to `no-strategy`, TINA determines the most adequate position - for the VMs. If set to `attract`, the VMs are deployed on the same hypervisor, - which improves network performance. If set to `repulse`, the VMs are deployed + description: The positioning strategy of the VMs on hypervisors. If set + to `no-strategy`, TINA determines the most adequate position for the VMs. + If set to `attract`, the VMs are deployed on the same hypervisor, which + improves network performance. If set to `repulse`, the VMs are deployed on a different hypervisor, which improves fault tolerance. enum: - attract @@ -12066,8 +12172,7 @@ components: type: string type: array State: - description: The state of the VM group (`pending` \| `available` \| `scaling - up` \| `scaling down` \| `deleting` \| `deleted`). + description: The state of the VM group. enum: - available - deleted @@ -12080,7 +12185,7 @@ components: description: The ID of the Subnet for the VM group. type: string Tags: - description: One or more tags associated with the VM. + description: One or more tags associated with the VM group. items: "$ref": "#/components/schemas/ResourceTag" type: array @@ -12256,7 +12361,7 @@ components: type: string State: description: The state of the volume (`creating` \| `available` \| `in-use` - \| `updating` \| `deleting` \| `error`). + \| `deleting` \| `error`). type: string SubregionName: description: The Subregion in which the volume was created. @@ -12343,73 +12448,69 @@ components: properties: AccountId: default: true - description: By default or if set to true, the account ID is displayed. + description: If true, the account ID is displayed. type: boolean CallDuration: default: true - description: By default or if set to true, the duration of the call is displayed. + description: If true, the duration of the call is displayed. type: boolean QueryAccessKey: default: true - description: By default or if set to true, the access key is displayed. + description: If true, the access key is displayed. type: boolean QueryApiName: default: true - description: By default or if set to true, the name of the API is displayed. + description: If true, the name of the API is displayed. type: boolean QueryApiVersion: default: true - description: By default or if set to true, the version of the API is displayed. + description: If true, the version of the API is displayed. type: boolean QueryCallName: default: true - description: By default or if set to true, the name of the call is displayed. + description: If true, the name of the call is displayed. type: boolean QueryDate: default: true - description: By default or if set to true, the date of the call is displayed. + description: If true, the date of the call is displayed. type: boolean QueryHeaderRaw: default: true - description: By default or if set to true, the raw header of the HTTP request - is displayed. + description: If true, the raw header of the HTTP request is displayed. type: boolean QueryHeaderSize: default: true - description: By default or if set to true, the size of the raw header of - the HTTP request is displayed. + description: If true, the size of the raw header of the HTTP request is + displayed. type: boolean QueryIpAddress: default: true - description: By default or if set to true, the IP is displayed. + description: If true, the IP is displayed. type: boolean QueryPayloadRaw: default: true - description: By default or if set to true, the raw payload of the HTTP request - is displayed. + description: If true, the raw payload of the HTTP request is displayed. type: boolean QueryPayloadSize: default: true - description: By default or if set to true, the size of the raw payload of - the HTTP request is displayed. + description: If true, the size of the raw payload of the HTTP request is + displayed. type: boolean QueryUserAgent: default: true - description: By default or if set to true, the user agent of the HTTP request - is displayed. + description: If true, the user agent of the HTTP request is displayed. type: boolean RequestId: default: true - description: By default or if set to true, the request ID is displayed. + description: If true, the request ID is displayed. type: boolean ResponseSize: default: true - description: By default or if set to true, the size of the response is displayed. + description: If true, the size of the response is displayed. type: boolean ResponseStatusCode: default: true - description: By default or if set to true, the HTTP status code of the response - is displayed. + description: If true, the HTTP status code of the response is displayed. type: boolean type: object securitySchemes: @@ -12491,57 +12592,57 @@ info: url: https://opensource.org/licenses/BSD-3-Clause termsOfService: https://en.outscale.com/terms-of-service/ title: 3DS OUTSCALE API - version: 1.35.3 + version: 1.35.4 x-osc-api-osc-billing: 1.35.0 x-osc-api-osc-cloud-vision: 1.35.0 - x-osc-api-osc-core-iaas: 1.35.3 + x-osc-api-osc-core-iaas: 1.35.4 x-osc-api-type: external openapi: 3.0.0 paths: "/AcceptNetPeering": - description: |- - Accepts a Net peering request.
- To accept this request, you must be the owner of the peer Net. If you do not accept the request within 7 days, the state of the Net peering becomes `expired`.

- - **[NOTE]**
- A peering connection between two Nets works both ways. Therefore, when an A-to-B peering connection is accepted, any pending B-to-A peering connection is automatically rejected as redundant. post: + description: |- + Accepts a Net peering request.
+ To accept this request, you must be the owner of the peer Net. If you do not accept the request within 7 days, the state of the Net peering becomes `expired`.

+ + **[NOTE]**
+ A peering connection between two Nets works both ways. Therefore, when an A-to-B peering connection is accepted, any pending B-to-A peering connection is automatically rejected as redundant. operationId: AcceptNetPeering requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/AcceptNetPeeringRequest" examples: ex1: value: NetPeeringId: pcx-12345678 - schema: - "$ref": "#/components/schemas/AcceptNetPeeringRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/AcceptNetPeeringResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 NetPeering: + Tags: [] + State: + Name: active + Message: Active AccepterNet: - AccountId: '123456789012' - IpRange: 172.16.0.0/16 NetId: vpc-12345678 + IpRange: 172.16.0.0/16 + AccountId: '123456789012' ExpirationDate: '2063-04-05T00:00:00.000Z' - NetPeeringId: pcx-12345678 SourceNet: - AccountId: '123456789012' - IpRange: 10.0.0.0/16 NetId: vpc-12345678 - State: - Message: Active - Name: active - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/AcceptNetPeeringResponse" + IpRange: 10.0.0.0/16 + AccountId: '123456789012' + NetPeeringId: pcx-12345678 description: The HTTP 200 response (OK). '400': content: @@ -12570,12 +12671,14 @@ paths: tags: - NetPeering "/AddUserToUserGroup": - description: Adds a user to a specified group. post: + description: Adds a user to a specified group. operationId: AddUserToUserGroup requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/AddUserToUserGroupRequest" examples: ex1: value: @@ -12583,86 +12686,84 @@ paths: UserGroupPath: "/example/" UserName: example-user UserPath: "/example/" - schema: - "$ref": "#/components/schemas/AddUserToUserGroupRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/AddUserToUserGroupResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/AddUserToUserGroupResponse" description: The HTTP 200 response (OK). tags: - UserGroup "/CheckAuthentication": - description: Validates the authenticity of the account. post: + description: Validates the authenticity of the account. operationId: CheckAuthentication requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CheckAuthenticationRequest" examples: ex1: value: Login: example@example.com Password: "$OSC_PASSWORD" - schema: - "$ref": "#/components/schemas/CheckAuthenticationRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CheckAuthenticationResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CheckAuthenticationResponse" description: The HTTP 200 response (OK). tags: - Account "/CreateAccessKey": - description: |- - Creates an access key for either your root account or an EIM user. The new key is automatically set to `ACTIVE`.

- For more information, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). post: + description: |- + Creates an access key for either your root account or an EIM user. The new key is automatically set to `ACTIVE`.

+ For more information, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). operationId: CreateAccessKey requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateAccessKeyRequest" examples: ex1: value: ExpirationDate: '2063-04-05' Tag: Group1 UserName: example-user - schema: - "$ref": "#/components/schemas/CreateAccessKeyRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateAccessKeyResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 AccessKey: + State: ACTIVE AccessKeyId: ABCDEFGHIJ0123456789 CreationDate: 2010-10-01 12:34:56.789000000 +00:00 ExpirationDate: 2063-04-05 00:00:00.000000000 +00:00 - LastModificationDate: 2010-10-01 12:34:56.789000000 +00:00 SecretKey: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - State: ACTIVE + LastModificationDate: 2010-10-01 12:34:56.789000000 +00:00 Tag: Group1 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateAccessKeyResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -12670,19 +12771,21 @@ paths: tags: - AccessKey "/CreateAccount": - description: |- - Creates an OUTSCALE account.

+ post: + description: |- + Creates an OUTSCALE account.

- **[IMPORTANT]**
- * You need OUTSCALE credentials and the appropriate quotas to create an account via API. To get quotas, you can send an email to sales@outscale.com.
- * If you want to pass a numeral value as a string instead of an integer, you must wrap your string in additional quotes (for example, `'"92000"'`). + **[IMPORTANT]**
+ * You need OUTSCALE credentials and the appropriate quotas to create an account via API. To get quotas, you can send an email to sales@outscale.com.
+ * If you want to pass a numeral value as a string instead of an integer, you must wrap your string in additional quotes (for example, `'"92000"'`). - For more information, see [About Your Account](https://docs.outscale.com/en/userguide/About-Your-Account.html). - post: + For more information, see [About Your Account](https://docs.outscale.com/en/userguide/About-Your-Account.html). operationId: CreateAccount requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateAccountRequest" examples: ex1: value: @@ -12694,99 +12797,97 @@ paths: FirstName: JEAN LastName: DUPONT ZipCode: '92210' - schema: - "$ref": "#/components/schemas/CreateAccountRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateAccountResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Account: - AccountId: '123456789012' - City: SAINT-CLOUD + ZipCode: '92210' CompanyName: EXAMPLE SAS - Country: FRANCE - Email: example@example.com FirstName: JEAN + City: SAINT-CLOUD + Country: FRANCE LastName: DUPONT - ZipCode: '92210' - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateAccountResponse" + AccountId: '123456789012' + Email: example@example.com description: The HTTP 200 response (OK). tags: - Account "/CreateApiAccessRule": - description: |- - Creates a rule to allow access to the API from your account.
- You need to specify at least the `CaIds` or the `IpRanges` parameter.

- - **[NOTE]**
- By default, your account has a set of rules allowing global access, that you can delete.

- For more information, see [About API Access Rules](https://docs.outscale.com/en/userguide/About-API-Access-Rules.html). post: + description: |- + Creates a rule to allow access to the API from your account.
+ You need to specify at least the `CaIds` or the `IpRanges` parameter.

+ + **[NOTE]**
+ By default, your account has a set of rules allowing global access, that you can delete.

+ For more information, see [About API Access Rules](https://docs.outscale.com/en/userguide/About-API-Access-Rules.html). operationId: CreateApiAccessRule requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateApiAccessRuleRequest" examples: ex1: summary: Creating an API access rule based on IPs value: - Description: Basic API Access Rule with IPs IpRanges: - 192.0.2.0 - 198.51.100.0/24 + Description: Basic API Access Rule with IPs ex2: summary: Creating an API access rule based on IPs and Certificate Authority (CA) value: - CaIds: - - ca-fedcba0987654321fedcba0987654321 - Description: API Access Rule with IPs and CA IpRanges: - 192.0.2.0 - 198.51.100.0/24 - schema: - "$ref": "#/components/schemas/CreateApiAccessRuleRequest" + CaIds: + - ca-fedcba0987654321fedcba0987654321 + Description: API Access Rule with IPs and CA responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateApiAccessRuleResponse" examples: ex1: summary: Creating an API access rule based on IPs value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ApiAccessRule: + IpRanges: + - 192.0.2.0 + - 198.51.100.0/24 ApiAccessRuleId: aar-fedcba0987654321fedcba0987654321 CaIds: [] Cns: [] Description: Basic API Access Rule with IPs - IpRanges: - - 192.0.2.0 - - 198.51.100.0/24 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Creating an API access rule based on IPs and Certificate Authority (CA) value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ApiAccessRule: + IpRanges: + - 192.0.2.0 + - 198.51.100.0/24 ApiAccessRuleId: aar-fedcba0987654321fedcba0987654321 CaIds: - ca-fedcba0987654321fedcba0987654321 Cns: [] Description: API Access Rule with IPs and CA - IpRanges: - - 192.0.2.0 - - 198.51.100.0/24 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateApiAccessRuleResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -12794,36 +12895,36 @@ paths: tags: - ApiAccessRule "/CreateCa": - description: |- - Creates a Client Certificate Authority (CA).

- For more information, see [About API Access Rules](https://docs.outscale.com/en/userguide/About-API-Access-Rules.html). post: + description: |- + Creates a Client Certificate Authority (CA).

+ For more information, see [About API Access Rules](https://docs.outscale.com/en/userguide/About-API-Access-Rules.html). operationId: CreateCa requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateCaRequest" examples: ex1: value: CaPem: XXXX Description: CA example - schema: - "$ref": "#/components/schemas/CreateCaRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateCaResponse" examples: ex1: value: - Ca: - CaFingerprint: 1234567890abcdef1234567890abcdef12345678 - CaId: ca-fedcba0987654321fedcba0987654321 - Description: CA example ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateCaResponse" + Ca: + Description: CA example + CaId: ca-fedcba0987654321fedcba0987654321 + CaFingerprint: 1234567890abcdef1234567890abcdef12345678 description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -12831,84 +12932,84 @@ paths: tags: - Ca "/CreateClientGateway": - description: |- - Provides information about your client gateway.
- This action registers information to identify the client gateway that you deployed in your network.
- To open a tunnel to the client gateway, you must provide the communication protocol type, the fixed public IP of the gateway, and an Autonomous System Number (ASN).

- For more information, see [About Client Gateways](https://docs.outscale.com/en/userguide/About-Client-Gateways.html). post: + description: |- + Provides information about your client gateway.
+ This action registers information to identify the client gateway that you deployed in your network.
+ To open a tunnel to the client gateway, you must provide the communication protocol type, the fixed public IP of the gateway, and an Autonomous System Number (ASN).

+ For more information, see [About Client Gateways](https://docs.outscale.com/en/userguide/About-Client-Gateways.html). operationId: CreateClientGateway requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateClientGatewayRequest" examples: ex1: value: - BgpAsn: 65000 ConnectionType: ipsec.1 PublicIp: 192.0.2.0 - schema: - "$ref": "#/components/schemas/CreateClientGatewayRequest" + BgpAsn: 65000 responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateClientGatewayResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ClientGateway: + State: available BgpAsn: 65000 + Tags: [] ClientGatewayId: cgw-12345678 ConnectionType: ipsec.1 PublicIp: 192.0.2.0 - State: available - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateClientGatewayResponse" description: The HTTP 200 response (OK). tags: - ClientGateway "/CreateDedicatedGroup": - description: |- - > [WARNING]
- > This feature is currently in beta.
- - Creates a dedicated group for virtual machines (VMs).

- For more information, see [About Dedicated Groups](https://docs.outscale.com/en/userguide/About-Dedicated-Groups.html). post: + description: |- + > [WARNING]
+ > This feature is currently in beta.
+ + Creates a dedicated group for virtual machines (VMs).

+ For more information, see [About Dedicated Groups](https://docs.outscale.com/en/userguide/About-Dedicated-Groups.html). operationId: CreateDedicatedGroup requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateDedicatedGroupRequest" examples: ex1: value: CpuGeneration: 4 Name: dedicated-group-example SubregionName: eu-west-2a - schema: - "$ref": "#/components/schemas/CreateDedicatedGroupRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateDedicatedGroupResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 DedicatedGroup: + VmIds: [] + NetIds: [] AccountId: '123456789012' CpuGeneration: 4 - DedicatedGroupId: ded-12345678 Name: dedicated-group-example - NetIds: [] SubregionName: eu-west-2a - VmIds: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateDedicatedGroupResponse" + DedicatedGroupId: ded-12345678 description: The HTTP 200 response (OK). '400': content: @@ -12931,14 +13032,16 @@ paths: tags: - DedicatedGroup "/CreateDhcpOptions": - description: |- - Creates a set of DHCP options, that you can then associate with a Net using the [UpdateNet](#updatenet) method.

- For more information, see [About DHCP Options](https://docs.outscale.com/en/userguide/About-DHCP-Options.html). post: + description: |- + Creates a set of DHCP options, that you can then associate with a Net using the [UpdateNet](#updatenet) method.

+ For more information, see [About DHCP Options](https://docs.outscale.com/en/userguide/About-DHCP-Options.html). operationId: CreateDhcpOptions requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateDhcpOptionsRequest" examples: ex1: value: @@ -12949,57 +13052,59 @@ paths: NtpServers: - 203.0.113.0 - 203.0.113.1 - schema: - "$ref": "#/components/schemas/CreateDhcpOptionsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateDhcpOptionsResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 DhcpOptionsSet: + Tags: [] + NtpServers: + - 203.0.113.0 + - 203.0.113.1 Default: false DhcpOptionsSetId: dopt-12345678 DomainName: example.com DomainNameServers: - 192.0.2.0 - 198.51.100.0 - NtpServers: - - 203.0.113.0 - - 203.0.113.1 - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateDhcpOptionsResponse" description: The HTTP 200 response (OK). tags: - DhcpOption "/CreateDirectLink": - description: |- - Creates a DirectLink between a customer network and a specified DirectLink location.

- For more information, see [About DirectLink](https://docs.outscale.com/en/userguide/About-DirectLink.html). post: + description: |- + Creates a DirectLink between a customer network and a specified DirectLink location.

+ For more information, see [About DirectLink](https://docs.outscale.com/en/userguide/About-DirectLink.html). operationId: CreateDirectLink requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateDirectLinkRequest" examples: ex1: value: + Location: PAR1 Bandwidth: 1Gbps DirectLinkName: Connection to Outscale - Location: PAR1 - schema: - "$ref": "#/components/schemas/CreateDirectLinkRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateDirectLinkResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 DirectLink: AccountId: '123456789012' Bandwidth: 1Gbps @@ -13008,130 +13113,128 @@ paths: Location: PAR1 RegionName: eu-west-2 State: requested - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateDirectLinkResponse" description: The HTTP 200 response (OK). tags: - DirectLink "/CreateDirectLinkInterface": - description: |- - Creates a DirectLink interface.
- DirectLink interfaces enable you to reach one of your Nets through a virtual gateway.

- For more information, see [About DirectLink](https://docs.outscale.com/en/userguide/About-DirectLink.html). post: + description: |- + Creates a DirectLink interface.
+ DirectLink interfaces enable you to reach one of your Nets through a virtual gateway.

+ For more information, see [About DirectLink](https://docs.outscale.com/en/userguide/About-DirectLink.html). operationId: CreateDirectLinkInterface requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateDirectLinkInterfaceRequest" examples: ex1: value: DirectLinkId: dxcon-12345678 DirectLinkInterface: + DirectLinkInterfaceName: MyDirectLinkInterface + Vlan: 101 BgpAsn: 65000 BgpKey: tgyn26example - ClientPrivateIp: 172.16.0.5/30 - DirectLinkInterfaceName: MyDirectLinkInterface OutscalePrivateIp: 172.16.0.4/30 + ClientPrivateIp: 172.16.0.5/30 VirtualGatewayId: vgw-12345678 - Vlan: 101 - schema: - "$ref": "#/components/schemas/CreateDirectLinkInterfaceRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateDirectLinkInterfaceResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 DirectLinkInterface: - AccountId: '123456789012' + Vlan: 101 + OutscalePrivateIp: 172.16.0.4/30 + DirectLinkInterfaceId: dxvif-12345678 BgpAsn: 65000 + AccountId: '123456789012' ClientPrivateIp: 172.16.0.5/30 - DirectLinkId: dxcon-12345678 - DirectLinkInterfaceId: dxvif-12345678 + VirtualGatewayId: vgw-12345678 DirectLinkInterfaceName: MyDirectLinkInterface - InterfaceType: private - Location: PAR1 + DirectLinkId: dxcon-12345678 Mtu: 1500 - OutscalePrivateIp: 172.16.0.4/30 State: pending - VirtualGatewayId: vgw-12345678 - Vlan: 101 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateDirectLinkInterfaceResponse" + InterfaceType: private + Location: PAR1 description: The HTTP 200 response (OK). tags: - DirectLinkInterface "/CreateFlexibleGpu": - description: |- - Allocates a flexible GPU (fGPU) to your account.
- You can then attach this fGPU to a virtual machine (VM).

- For more information, see [About Flexible GPUs](https://docs.outscale.com/en/userguide/About-Flexible-GPUs.html). post: + description: |- + Allocates a flexible GPU (fGPU) to your account.
+ You can then attach this fGPU to a virtual machine (VM).

+ For more information, see [About Flexible GPUs](https://docs.outscale.com/en/userguide/About-Flexible-GPUs.html). operationId: CreateFlexibleGpu requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateFlexibleGpuRequest" examples: ex1: value: - DeleteOnVmDeletion: true - Generation: v5 ModelName: nvidia-p100 + Generation: v5 SubregionName: eu-west-2a - schema: - "$ref": "#/components/schemas/CreateFlexibleGpuRequest" + DeleteOnVmDeletion: true responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateFlexibleGpuResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 FlexibleGpu: + SubregionName: eu-west-2a DeleteOnVmDeletion: true - FlexibleGpuId: fgpu-12345678 Generation: v5 ModelName: nvidia-p100 State: allocated - SubregionName: eu-west-2a - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateFlexibleGpuResponse" + FlexibleGpuId: fgpu-12345678 description: The HTTP 200 response (OK). tags: - FlexibleGpu "/CreateImage": - description: |- - Creates an OUTSCALE machine image (OMI).
- You can use this method for different use cases: - * **Creating from a VM**: You create an OMI from one of your virtual machines (VMs).
- * **Copying an OMI**: You copy an existing OMI. The source OMI can be one of your own OMIs, or an OMI owned by another account that has granted you permission via the [UpdateImage](#updateimage) method.
- * **Registering from a snapshot**: You register an OMI from an existing snapshot. The source snapshot can be one of your own snapshots, or a snapshot owned by another account that has granted you permission via the [UpdateSnapshot](#updatesnapshot) method.
- * **Registering from a bucket by using a manifest file**: You register an OMI from the manifest file of an OMI that was exported to an OUTSCALE Object Storage (OOS) bucket. First, the owner of the source OMI must export it to the bucket by using the [CreateImageExportTask](#createimageexporttask) method. Then, they must grant you permission to read the manifest file via a pre-signed URL. For more information, see [Creating a Pre-Signed URL](https://docs.outscale.com/en/userguide/Creating-a-Pre-Signed-URL.html). + post: + description: |- + Creates an OUTSCALE machine image (OMI).
+ You can use this method for different use cases: + * **Creating from a VM**: You create an OMI from one of your virtual machines (VMs).
+ * **Copying an OMI**: You copy an existing OMI. The source OMI can be one of your own OMIs, or an OMI owned by another account that has granted you permission via the [UpdateImage](#updateimage) method.
+ * **Registering from a snapshot**: You register an OMI from an existing snapshot. The source snapshot can be one of your own snapshots, or a snapshot owned by another account that has granted you permission via the [UpdateSnapshot](#updatesnapshot) method.
+ * **Registering from a bucket by using a manifest file**: You register an OMI from the manifest file of an OMI that was exported to an OUTSCALE Object Storage (OOS) bucket. First, the owner of the source OMI must export it to the bucket by using the [CreateImageExportTask](#createimageexporttask) method. Then, they must grant you permission to read the manifest file via a pre-signed URL. For more information, see [Creating a Pre-Signed URL](https://docs.outscale.com/en/userguide/Creating-a-Pre-Signed-URL.html). - **[TIP]**
- Registering from a bucket enables you to copy an OMI across Regions. + **[TIP]**
+ Registering from a bucket enables you to copy an OMI across Regions. - For more information, see [About OMIs](https://docs.outscale.com/en/userguide/About-OMIs.html). - post: + For more information, see [About OMIs](https://docs.outscale.com/en/userguide/About-OMIs.html). operationId: CreateImage requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateImageRequest" examples: ex1: summary: Creating from a VM value: ImageName: create-image-example - NoReboot: true VmId: i-12345678 + NoReboot: true ex2: summary: Copying an OMI value: @@ -13141,163 +13244,161 @@ paths: ex3: summary: Registering from a snapshot value: + ImageName: register-image-from-snapshot-example BlockDeviceMappings: - - Bsu: - DeleteOnVmDeletion: true - Iops: 150 + - DeviceName: "/dev/sda1" + Bsu: SnapshotId: snap-12345678 VolumeSize: 120 VolumeType: io1 - DeviceName: "/dev/sda1" - ImageName: register-image-from-snapshot-example + Iops: 150 + DeleteOnVmDeletion: true RootDeviceName: "/dev/sda1" ex4: summary: Registering from a bucket by using a manifest file value: - FileLocation: https://oos.eu-west-2.outscale.com/BUCKET/KEY?AWSAccessKeyId=ABCDEFGHIJ0123456789&Expires=1493372309&Signature=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX ImageName: register-image-from-bucket-example - schema: - "$ref": "#/components/schemas/CreateImageRequest" + FileLocation: https://oos.eu-west-2.outscale.com/BUCKET/KEY?AWSAccessKeyId=ABCDEFGHIJ0123456789&Expires=1493372309&Signature=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateImageResponse" examples: ex1: summary: Creating from a VM value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Image: + StateComment: {} + State: pending + RootDeviceType: bsu + RootDeviceName: "/dev/sda1" + ProductCodes: + - '0001' + PermissionsToLaunch: + GlobalPermission: false + AccountIds: [] AccountId: '123456789012' - Architecture: x86_64 + Tags: [] + Description: '' + ImageId: ami-12345678 BlockDeviceMappings: - - Bsu: + - DeviceName: "/dev/sda1" + Bsu: + VolumeType: standard DeleteOnVmDeletion: true - SnapshotId: snap-12345678 VolumeSize: 50 - VolumeType: standard - DeviceName: "/dev/sda1" + SnapshotId: snap-12345678 BootModes: - legacy + ImageType: machine CreationDate: '2010-10-01T12:34:56.789Z' - Description: '' FileLocation: 123456789012/create-image-example - ImageId: ami-12345678 + Architecture: x86_64 ImageName: create-image-example - ImageType: machine - PermissionsToLaunch: - AccountIds: [] - GlobalPermission: false - ProductCodes: - - '0001' - RootDeviceName: "/dev/sda1" - RootDeviceType: bsu - State: pending - StateComment: {} - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Copying an OMI value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Image: + StateComment: {} + State: available + RootDeviceType: bsu + RootDeviceName: "/dev/sda1" + ProductCodes: + - '0001' + PermissionsToLaunch: + GlobalPermission: false + AccountIds: [] AccountId: '123456789012' - Architecture: x86_64 + Tags: [] + Description: '' + ImageId: ami-12345678 BlockDeviceMappings: - - Bsu: + - DeviceName: "/dev/sda1" + Bsu: + VolumeType: standard DeleteOnVmDeletion: true - SnapshotId: snap-12345678 VolumeSize: 50 - VolumeType: standard - DeviceName: "/dev/sda1" + SnapshotId: snap-12345678 BootModes: - legacy + ImageType: machine CreationDate: '2010-10-01T12:34:56.789Z' - Description: '' FileLocation: 123456789012/copy-image-example - ImageId: ami-12345678 + Architecture: x86_64 ImageName: copy-image-example - ImageType: machine - PermissionsToLaunch: - AccountIds: [] - GlobalPermission: false - ProductCodes: - - '0001' - RootDeviceName: "/dev/sda1" - RootDeviceType: bsu - State: available - StateComment: {} - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex3: summary: Registering from a snapshot value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Image: + StateComment: {} + State: available + RootDeviceType: bsu + RootDeviceName: "/dev/sda1" + ProductCodes: + - '0001' + PermissionsToLaunch: + GlobalPermission: false + AccountIds: [] AccountId: '123456789012' - Architecture: x86_64 + Tags: [] + Description: '' + ImageId: ami-12345678 BlockDeviceMappings: - - Bsu: + - DeviceName: "/dev/sda1" + Bsu: + VolumeType: io1 DeleteOnVmDeletion: true + VolumeSize: 120 Iops: 150 SnapshotId: snap-12345678 - VolumeSize: 120 - VolumeType: io1 - DeviceName: "/dev/sda1" BootModes: - legacy + ImageType: machine CreationDate: '2010-10-01T12:34:56.789Z' - Description: '' FileLocation: 123456789012/register-image-from-snapshot-example - ImageId: ami-12345678 + Architecture: x86_64 ImageName: register-image-from-snapshot-example - ImageType: machine - PermissionsToLaunch: - AccountIds: [] - GlobalPermission: false - ProductCodes: - - '0001' - RootDeviceName: "/dev/sda1" - RootDeviceType: bsu - State: available - StateComment: {} - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex4: summary: Registering from a bucket by using a manifest file value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Image: + StateComment: {} + State: pending + RootDeviceType: bsu + RootDeviceName: "/dev/sda1" + ProductCodes: + - '0001' + PermissionsToLaunch: + GlobalPermission: false + AccountIds: [] AccountId: '123456789012' - Architecture: x86_64 + Tags: [] + Description: '' + ImageId: ami-12345678 BlockDeviceMappings: - - Bsu: + - DeviceName: "/dev/sda1" + Bsu: + VolumeType: standard DeleteOnVmDeletion: true - SnapshotId: snap-12345678 VolumeSize: 50 - VolumeType: standard - DeviceName: "/dev/sda1" + SnapshotId: snap-12345678 BootModes: - legacy + ImageType: machine CreationDate: '2010-10-01T12:34:56.789Z' - Description: '' FileLocation: https://oos.eu-west-2.outscale.com/BUCKET/KEY?AWSAccessKeyId=ABCDEFGHIJ0123456789&Expires=1493372309&Signature=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - ImageId: ami-12345678 + Architecture: x86_64 ImageName: register-image-from-bucket-example - ImageType: machine - PermissionsToLaunch: - AccountIds: [] - GlobalPermission: false - ProductCodes: - - '0001' - RootDeviceName: "/dev/sda1" - RootDeviceType: bsu - State: pending - StateComment: {} - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateImageResponse" description: The HTTP 200 response (OK). '400': content: @@ -13320,20 +13421,22 @@ paths: tags: - Image "/CreateImageExportTask": - description: |- - Exports an OUTSCALE machine image (OMI) to an OUTSCALE Object Storage (OOS) bucket.
- This enables you to copy an OMI between accounts in different Regions.

- This action creates the necessary snapshots and manifest file in the bucket. The OMI can then be imported to another account using a pre-signed URL of its manifest file. For more information, see [Creating a Pre-Signed URL](https://docs.outscale.com/en/userguide/Creating-a-Pre-Signed-URL.html).

- To copy an OMI in the same Region, you can also use the [CreateImage](#createimage) method.
- - **[IMPORTANT]**
- You cannot export a shared or public OMI, as they do not belong to you. To do so, you must first copy it to your account. The copy then belongs to you and you can export it.

- For more information, see [About OMIs](https://docs.outscale.com/en/userguide/About-OMIs.html). post: + description: |- + Exports an OUTSCALE machine image (OMI) to an OUTSCALE Object Storage (OOS) bucket.
+ This enables you to copy an OMI between accounts in different Regions.

+ This action creates the necessary snapshots and manifest file in the bucket. The OMI can then be imported to another account using a pre-signed URL of its manifest file. For more information, see [Creating a Pre-Signed URL](https://docs.outscale.com/en/userguide/Creating-a-Pre-Signed-URL.html).

+ To copy an OMI in the same Region, you can also use the [CreateImage](#createimage) method.
+ + **[IMPORTANT]**
+ You cannot export a shared or public OMI, as they do not belong to you. To do so, you must first copy it to your account. The copy then belongs to you and you can export it.

+ For more information, see [About OMIs](https://docs.outscale.com/en/userguide/About-OMIs.html). operationId: CreateImageExportTask requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateImageExportTaskRequest" examples: ex1: value: @@ -13342,62 +13445,60 @@ paths: DiskImageFormat: qcow2 OsuBucket: BUCKET OsuPrefix: PREFIX - schema: - "$ref": "#/components/schemas/CreateImageExportTaskRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateImageExportTaskResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ImageExportTask: - Comment: Export of image ami-12345678 + Tags: [] ImageId: ami-12345678 + TaskId: image-export-12345678 + Comment: Export of image ami-12345678 OsuExport: - DiskImageFormat: qcow2 - OsuBucket: BUCKET OsuPrefix: PREFIX/ami-12345678/ - Progress: 0 + OsuBucket: BUCKET + DiskImageFormat: qcow2 State: pending/queued - Tags: [] - TaskId: image-export-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateImageExportTaskResponse" + Progress: 0 description: The HTTP 200 response (OK). tags: - Image "/CreateInternetService": - description: |- - Creates an internet service you can use with a Net.
- An internet service enables virtual machines (VMs) launched in a Net to connect to the Internet. It allows routing of incoming and outgoing Internet traffic and management of public IP addresses.

- For more information, see [About Internet Services](https://docs.outscale.com/en/userguide/About-Internet-Services.html). post: + description: |- + Creates an internet service you can use with a Net.
+ An internet service enables virtual machines (VMs) launched in a Net to connect to the Internet. It allows routing of incoming and outgoing Internet traffic and management of public IP addresses.

+ For more information, see [About Internet Services](https://docs.outscale.com/en/userguide/About-Internet-Services.html). operationId: CreateInternetService requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateInternetServiceRequest" examples: ex1: value: {} - schema: - "$ref": "#/components/schemas/CreateInternetServiceRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateInternetServiceResponse" examples: ex1: value: - InternetService: - InternetServiceId: igw-12345678 - Tags: [] ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateInternetServiceResponse" + InternetService: + Tags: [] + InternetServiceId: igw-12345678 description: The HTTP 200 response (OK). '400': content: @@ -13420,19 +13521,21 @@ paths: tags: - InternetService "/CreateKeypair": - description: |- - Creates a keypair to use with your virtual machines (VMs).
- You can use this method in two different ways: - * **Creating a keypair**: In that case, 3DS OUTSCALE creates a 2048-bit RSA keypair, stores its public key in your account, and returns its private key in the response of the call so that you can save it in a file.
- When you save the returned private key, make sure you replace the `\n` escape sequences with real line breaks. - * **Importing a keypair created locally**: If you already have a keypair that you have created locally with a third-party tool, you can import its public key in your account. The following types of key can be imported: RSA (2048 bits or preferably 4096 bits), Ed25519, and ECDSA (256 bits, 384 bits, or 521 bits). The following formats can be used: PEM, PKCS8, RFC4716, and OpenSSH. - - For more information, see [About Keypairs](https://docs.outscale.com/en/userguide/About-Keypairs.html). post: + description: |- + Creates a keypair to use with your virtual machines (VMs).
+ You can use this method in two different ways: + * **Creating a keypair**: In that case, 3DS OUTSCALE creates a 2048-bit RSA keypair, stores its public key in your account, and returns its private key in the response of the call so that you can save it in a file.
+ When you save the returned private key, make sure you replace the `\n` escape sequences with real line breaks. + * **Importing a keypair created locally**: If you already have a keypair that you have created locally with a third-party tool, you can import its public key in your account. The following types of key can be imported: RSA (2048 bits or preferably 4096 bits), Ed25519, and ECDSA (256 bits, 384 bits, or 521 bits). The following formats can be used: PEM, PKCS8, RFC4716, and OpenSSH. + + For more information, see [About Keypairs](https://docs.outscale.com/en/userguide/About-Keypairs.html). operationId: CreateKeypair requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateKeypairRequest" examples: ex1: summary: Creating a keypair @@ -13443,39 +13546,37 @@ paths: value: KeypairName: import-keypair-example PublicKey: "..." - schema: - "$ref": "#/components/schemas/CreateKeypairRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateKeypairResponse" examples: ex1: summary: Creating a keypair value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Keypair: - KeypairFingerprint: 11:22:33:44:55:66:77:88:99:00:aa:bb:cc:dd:ee:ff - KeypairId: key-abcdef1234567890abcdef1234567890 - KeypairName: create-keypair-example - KeypairType: ssh-rsa PrivateKey: |- -----BEGIN RSA PRIVATE KEY----- ... -----END RSA PRIVATE KEY----- - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + KeypairType: ssh-rsa + KeypairName: create-keypair-example + KeypairId: key-abcdef1234567890abcdef1234567890 + KeypairFingerprint: 11:22:33:44:55:66:77:88:99:00:aa:bb:cc:dd:ee:ff ex2: summary: Importing a keypair created locally value: - Keypair: - KeypairFingerprint: 11:22:33:44:55:66:77:88:99:00:aa:bb:cc:dd:ee:ff - KeypairId: key-abcdef1234567890abcdef1234567890 - KeypairName: create-keypair-example - KeypairType: ssh-rsa ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateKeypairResponse" + Keypair: + KeypairType: ssh-rsa + KeypairName: create-keypair-example + KeypairId: key-abcdef1234567890abcdef1234567890 + KeypairFingerprint: 11:22:33:44:55:66:77:88:99:00:aa:bb:cc:dd:ee:ff description: The HTTP 200 response (OK). '400': content: @@ -13504,15 +13605,17 @@ paths: tags: - Keypair "/CreateListenerRule": - description: |- - Creates a rule for traffic redirection for the specified listener. Each rule must have either the `HostNamePattern` or `PathPattern` parameter specified. Rules are treated in priority order, from the highest value to the lowest value.
- Once the rule is created, you need to register backend VMs with it. For more information, see the [RegisterVmsInLoadBalancer](#registervmsinloadbalancer) method.

- For more information, see [About Load Balancers](https://docs.outscale.com/en/userguide/About-Load-Balancers.html). post: + description: |- + Creates a rule for traffic redirection for the specified listener. Each rule must have either the `HostNamePattern` or `PathPattern` parameter specified. Rules are treated in priority order, from the highest value to the lowest value.
+ Once the rule is created, you need to register backend VMs with it. For more information, see the [RegisterVmsInLoadBalancer](#registervmsinloadbalancer) method.

+ For more information, see [About Load Balancers](https://docs.outscale.com/en/userguide/About-Load-Balancers.html). operationId: CreateListenerRule requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateListenerRuleRequest" examples: ex1: summary: Creating a listener rule based on a host pattern @@ -13535,274 +13638,290 @@ paths: LoadBalancerPort: 80 ListenerRule: Action: forward - ListenerRuleName: example-listener-rule PathPattern: "/docs/*" + ListenerRuleName: example-listener-rule Priority: 100 VmIds: - i-12345678 - schema: - "$ref": "#/components/schemas/CreateListenerRuleRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateListenerRuleResponse" examples: ex1: summary: Creating a listener rule based on a host pattern value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ListenerRule: - Action: forward - HostNamePattern: "*.example.com" - ListenerId: 123456 - ListenerRuleId: 1234 - ListenerRuleName: example-listener-rule Priority: 10 VmIds: - i-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ListenerRuleName: example-listener-rule + Action: forward + ListenerId: 123456 + HostNamePattern: "*.example.com" + ListenerRuleId: 1234 ex2: summary: Creating a listener rule based on a path pattern value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ListenerRule: - Action: forward - ListenerId: 123456 - ListenerRuleId: 1234 - ListenerRuleName: example-listener-rule - PathPattern: "/docs/*" Priority: 100 VmIds: - i-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateListenerRuleResponse" + ListenerRuleName: example-listener-rule + Action: forward + ListenerId: 123456 + PathPattern: "/docs/*" + ListenerRuleId: 1234 description: The HTTP 200 response (OK). tags: - Listener "/CreateLoadBalancer": - description: |- - Creates a load balancer.
- The load balancer is created with a unique Domain Name Service (DNS) name. It receives the incoming traffic and routes it to its registered virtual machines (VMs).
- By default, this action creates an Internet-facing load balancer, resolving to public IPs. To create an internal load balancer in a Net, resolving to private IPs, use the `LoadBalancerType` parameter.
- You must specify either the `Subnets` or the `SubregionNames` parameters.

- For more information, see [About Load Balancers](https://docs.outscale.com/en/userguide/About-Load-Balancers.html). post: + description: |- + Creates a load balancer.
+ The load balancer is created with a unique Domain Name Service (DNS) name. It receives the incoming traffic and routes it to its registered virtual machines (VMs).
+ By default, this action creates an Internet-facing load balancer, resolving to public IPs. To create an internal load balancer in a Net, resolving to private IPs, use the `LoadBalancerType` parameter.
+ You must specify either the `Subnets` or the `SubregionNames` parameters.

+ For more information, see [About Load Balancers](https://docs.outscale.com/en/userguide/About-Load-Balancers.html). operationId: CreateLoadBalancer requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateLoadBalancerRequest" examples: ex1: summary: Creating an internal load balancer in a Net value: + LoadBalancerName: private-lb-example Listeners: - BackendPort: 80 BackendProtocol: TCP LoadBalancerPort: 80 LoadBalancerProtocol: TCP - LoadBalancerName: private-lb-example - LoadBalancerType: internal - SecurityGroups: - - sg-12345678 Subnets: - subnet-12345678 + SecurityGroups: + - sg-12345678 + LoadBalancerType: internal ex2: summary: Creating an internet-facing load balancer in a Net value: + LoadBalancerName: private-lb-example Listeners: - BackendPort: 80 BackendProtocol: HTTP LoadBalancerPort: 443 LoadBalancerProtocol: HTTPS ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate - LoadBalancerName: private-lb-example - LoadBalancerType: internet-facing - PublicIp: 192.0.2.0 - SecurityGroups: - - sg-12345678 Subnets: - subnet-12345678 + SecurityGroups: + - sg-12345678 + LoadBalancerType: internet-facing + PublicIp: 192.0.2.0 ex3: summary: Creating an internet-facing load balancer in the public Cloud value: + LoadBalancerName: public-lb-example + SubregionNames: + - eu-west-2a Listeners: - BackendPort: 8080 BackendProtocol: HTTP LoadBalancerPort: 8080 LoadBalancerProtocol: HTTP - LoadBalancerName: public-lb-example - SubregionNames: - - eu-west-2a - schema: - "$ref": "#/components/schemas/CreateLoadBalancerRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateLoadBalancerResponse" examples: ex1: summary: Creating an internal load balancer in a Net value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 LoadBalancer: + Tags: [] + SourceSecurityGroup: + SecurityGroupName: security-group-example + SecurityGroupAccountId: '123456789012' + SecuredCookies: false + Subnets: + - subnet-12345678 + NetId: vpc-12345678 + BackendVmIds: [] + ApplicationStickyCookiePolicies: [] + SecurityGroups: + - sg-12345678 + LoadBalancerType: internal AccessLog: - IsEnabled: false PublicationInterval: 60 - ApplicationStickyCookiePolicies: [] - BackendVmIds: [] + IsEnabled: false DnsName: internal-private-lb-example.123456789.eu-west-2.lbu.outscale.com HealthCheck: + UnhealthyThreshold: 2 + Timeout: 5 CheckInterval: 30 + Protocol: TCP HealthyThreshold: 10 Port: 80 - Protocol: TCP - Timeout: 5 - UnhealthyThreshold: 2 + LoadBalancerStickyCookiePolicies: [] + SubregionNames: + - eu-west-2a Listeners: - BackendPort: 80 BackendProtocol: TCP LoadBalancerPort: 80 LoadBalancerProtocol: TCP LoadBalancerName: private-lb-example - LoadBalancerStickyCookiePolicies: [] - LoadBalancerType: internal - NetId: vpc-12345678 - SecuredCookies: false - SecurityGroups: - - sg-12345678 - SourceSecurityGroup: - SecurityGroupAccountId: '123456789012' - SecurityGroupName: security-group-example - Subnets: - - subnet-12345678 - SubregionNames: - - eu-west-2a - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Creating an internet-facing load balancer in a Net value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 LoadBalancer: - AccessLog: - IsEnabled: false - PublicationInterval: 60 - ApplicationStickyCookiePolicies: [] - BackendVmIds: [] - DnsName: private-lb-example.123456789.eu-west-2.lbu.outscale.com - HealthCheck: - CheckInterval: 30 - HealthyThreshold: 10 - Port: 80 - Protocol: TCP - Timeout: 5 - UnhealthyThreshold: 2 - Listeners: - - BackendPort: 80 - BackendProtocol: HTTP - LoadBalancerPort: 443 - LoadBalancerProtocol: HTTPS - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate - LoadBalancerName: private-lb-example - LoadBalancerStickyCookiePolicies: [] - LoadBalancerType: internet-facing - NetId: vpc-12345678 - PublicIp: 192.0.2.0 - SecuredCookies: false - SecurityGroups: - - sg-12345678 + Tags: [] SourceSecurityGroup: - SecurityGroupAccountId: '123456789012' SecurityGroupName: security-group-example + SecurityGroupAccountId: '123456789012' + SecuredCookies: false + PublicIp: 192.0.2.0 Subnets: - subnet-12345678 + NetId: vpc-12345678 + BackendVmIds: [] + ApplicationStickyCookiePolicies: [] + SecurityGroups: + - sg-12345678 + LoadBalancerType: internet-facing + AccessLog: + PublicationInterval: 60 + IsEnabled: false + DnsName: private-lb-example.123456789.eu-west-2.lbu.outscale.com + HealthCheck: + UnhealthyThreshold: 2 + Timeout: 5 + CheckInterval: 30 + Protocol: TCP + HealthyThreshold: 10 + Port: 80 + LoadBalancerStickyCookiePolicies: [] SubregionNames: - eu-west-2a - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Listeners: + - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate + BackendPort: 80 + BackendProtocol: HTTP + LoadBalancerPort: 443 + LoadBalancerProtocol: HTTPS + LoadBalancerName: private-lb-example ex3: summary: Creating an internet-facing load balancer in the public Cloud value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 LoadBalancer: + Tags: [] + SourceSecurityGroup: + SecurityGroupName: outscale-elb-sg + SecurityGroupAccountId: outscale-elb + SecuredCookies: false + Subnets: [] + BackendVmIds: [] + ApplicationStickyCookiePolicies: [] + LoadBalancerType: internet-facing AccessLog: - IsEnabled: false PublicationInterval: 60 - ApplicationStickyCookiePolicies: [] - BackendVmIds: [] + IsEnabled: false DnsName: public-lb-example.123456789.eu-west-2.lbu.outscale.com HealthCheck: + UnhealthyThreshold: 2 + Timeout: 5 CheckInterval: 30 + Protocol: TCP HealthyThreshold: 10 Port: 8080 - Protocol: TCP - Timeout: 5 - UnhealthyThreshold: 2 + LoadBalancerStickyCookiePolicies: [] + SubregionNames: + - eu-west-2a Listeners: - BackendPort: 8080 BackendProtocol: HTTP LoadBalancerPort: 8080 LoadBalancerProtocol: HTTP LoadBalancerName: public-lb-example - LoadBalancerStickyCookiePolicies: [] - LoadBalancerType: internet-facing - SecuredCookies: false - SourceSecurityGroup: - SecurityGroupAccountId: outscale-elb - SecurityGroupName: outscale-elb-sg - Subnets: [] - SubregionNames: - - eu-west-2a - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateLoadBalancerResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer "/CreateLoadBalancerListeners": - description: |- - Creates one or more listeners for a specified load balancer.

- For more information, see [About Load Balancers](https://docs.outscale.com/en/userguide/About-Load-Balancers.html). post: + description: |- + Creates one or more listeners for a specified load balancer.

+ For more information, see [About Load Balancers](https://docs.outscale.com/en/userguide/About-Load-Balancers.html). operationId: CreateLoadBalancerListeners requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateLoadBalancerListenersRequest" examples: ex1: value: + LoadBalancerName: example-lbu Listeners: - BackendPort: 58 BackendProtocol: TCP LoadBalancerPort: 62 LoadBalancerProtocol: TCP - LoadBalancerName: example-lbu - schema: - "$ref": "#/components/schemas/CreateLoadBalancerListenersRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateLoadBalancerListenersResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 LoadBalancer: + Tags: [] + SourceSecurityGroup: + SecurityGroupName: security-group-example + SecurityGroupAccountId: '123456789012' + SecuredCookies: false + Subnets: + - subnet-12345678 + NetId: vpc-12345678 + BackendVmIds: [] + ApplicationStickyCookiePolicies: [] + SecurityGroups: + - sg-12345678 + LoadBalancerType: internal AccessLog: - IsEnabled: false PublicationInterval: 60 - ApplicationStickyCookiePolicies: [] - BackendVmIds: [] + IsEnabled: false DnsName: internal-example-lbu.123456789.eu-west-2.lbu.outscale.com HealthCheck: + UnhealthyThreshold: 2 + Timeout: 5 CheckInterval: 30 + Protocol: TCP HealthyThreshold: 10 Port: 80 - Protocol: TCP - Timeout: 5 - UnhealthyThreshold: 2 + LoadBalancerStickyCookiePolicies: [] + SubregionNames: + - eu-west-2a Listeners: - BackendPort: 58 BackendProtocol: TCP @@ -13813,42 +13932,26 @@ paths: LoadBalancerPort: 80 LoadBalancerProtocol: TCP LoadBalancerName: example-lbu - LoadBalancerStickyCookiePolicies: [] - LoadBalancerType: internal - NetId: vpc-12345678 - SecuredCookies: false - SecurityGroups: - - sg-12345678 - SourceSecurityGroup: - SecurityGroupAccountId: '123456789012' - SecurityGroupName: security-group-example - Subnets: - - subnet-12345678 - SubregionNames: - - eu-west-2a - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateLoadBalancerListenersResponse" description: The HTTP 200 response (OK). tags: - Listener "/CreateLoadBalancerPolicy": - description: |- - Creates a stickiness policy with sticky session lifetimes defined by the browser lifetime.
- The created policy can be used with HTTP or HTTPS listeners only.
- If this policy is implemented by a load balancer, this load balancer uses this cookie in all incoming requests to direct them to the specified backend server virtual machine (VM). If this cookie is not present, the load balancer sends the request to any other server according to its load-balancing algorithm.

- - You can also create a stickiness policy with sticky session lifetimes following the lifetime of an application-generated cookie.
- Unlike the other type of stickiness policy, the lifetime of the special Load Balancer Unit (LBU) cookie follows the lifetime of the application-generated cookie specified in the policy configuration. The load balancer inserts a new stickiness cookie only when the application response includes a new application cookie.
- The session stops being sticky if the application cookie is removed or expires, until a new application cookie is issued.

- For more information, see [About Load Balancers](https://docs.outscale.com/en/userguide/About-Load-Balancers.html). post: + description: |- + Creates a stickiness policy with sticky session lifetimes defined by the browser lifetime.
+ The created policy can be used with HTTP or HTTPS listeners only.
+ If this policy is implemented by a load balancer, this load balancer uses this cookie in all incoming requests to direct them to the specified backend server virtual machine (VM). If this cookie is not present, the load balancer sends the request to any other server according to its load-balancing algorithm.

+ + You can also create a stickiness policy with sticky session lifetimes following the lifetime of an application-generated cookie.
+ Unlike the other type of stickiness policy, the lifetime of the special Load Balancer Unit (LBU) cookie follows the lifetime of the application-generated cookie specified in the policy configuration. The load balancer inserts a new stickiness cookie only when the application response includes a new application cookie.
+ The session stops being sticky if the application cookie is removed or expires, until a new application cookie is issued.

+ For more information, see [About Load Balancers](https://docs.outscale.com/en/userguide/About-Load-Balancers.html). operationId: CreateLoadBalancerPolicy requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateLoadBalancerPolicyRequest" examples: ex1: summary: Creating a load balancer policy based on browser @@ -13859,112 +13962,112 @@ paths: ex2: summary: Creating a load balancer policy based on application cookie value: - CookieName: example-cookie LoadBalancerName: example-lbu PolicyName: example-app-policy PolicyType: app - schema: - "$ref": "#/components/schemas/CreateLoadBalancerPolicyRequest" + CookieName: example-cookie responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateLoadBalancerPolicyResponse" examples: ex1: summary: Creating a load balancer policy based on browser value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 LoadBalancer: + Tags: [] + SourceSecurityGroup: + SecurityGroupName: default + SecurityGroupAccountId: '123456789012' + Subnets: + - subnet-12345678 + NetId: vpc-12345678 + BackendVmIds: [] + ApplicationStickyCookiePolicies: [] + SecurityGroups: + - sg-12345678 + LoadBalancerType: internet-facing AccessLog: - IsEnabled: false PublicationInterval: 60 - ApplicationStickyCookiePolicies: [] - BackendVmIds: [] + IsEnabled: false DnsName: example-lbu-123456789.eu-west-2.lbu.outscale.com HealthCheck: + UnhealthyThreshold: 2 + Timeout: 5 CheckInterval: 30 + Protocol: TCP HealthyThreshold: 10 Port: 80 - Protocol: TCP - Timeout: 5 - UnhealthyThreshold: 2 + LoadBalancerStickyCookiePolicies: + - PolicyName: example-browser-policy + CookieExpirationPeriod: 1 + SubregionNames: + - eu-west-2a Listeners: - BackendPort: 80 BackendProtocol: HTTP LoadBalancerPort: 80 LoadBalancerProtocol: HTTP LoadBalancerName: example-lbu - LoadBalancerStickyCookiePolicies: - - CookieExpirationPeriod: 1 - PolicyName: example-browser-policy - LoadBalancerType: internet-facing - NetId: vpc-12345678 - SecurityGroups: - - sg-12345678 - SourceSecurityGroup: - SecurityGroupAccountId: '123456789012' - SecurityGroupName: default - Subnets: - - subnet-12345678 - SubregionNames: - - eu-west-2a - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Creating a load balancer policy based on application cookie value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 LoadBalancer: + Tags: [] + SourceSecurityGroup: + SecurityGroupName: default + SecurityGroupAccountId: '123456789012' + Subnets: + - subnet-12345678 + NetId: vpc-12345678 + BackendVmIds: [] + ApplicationStickyCookiePolicies: + - PolicyName: example-app-policy + CookieName: example-cookie + SecurityGroups: + - sg-12345678 + LoadBalancerType: internet-facing AccessLog: - IsEnabled: false PublicationInterval: 60 - ApplicationStickyCookiePolicies: - - CookieName: example-cookie - PolicyName: example-app-policy - BackendVmIds: [] + IsEnabled: false DnsName: example-lbu-123456789.eu-west-2.lbu.outscale.com HealthCheck: + UnhealthyThreshold: 2 + Timeout: 5 CheckInterval: 30 + Protocol: TCP HealthyThreshold: 10 Port: 80 - Protocol: TCP - Timeout: 5 - UnhealthyThreshold: 2 + LoadBalancerStickyCookiePolicies: [] + SubregionNames: + - eu-west-2a Listeners: - BackendPort: 80 BackendProtocol: HTTP LoadBalancerPort: 80 LoadBalancerProtocol: HTTP LoadBalancerName: example-lbu - LoadBalancerStickyCookiePolicies: [] - LoadBalancerType: internet-facing - NetId: vpc-12345678 - SecurityGroups: - - sg-12345678 - SourceSecurityGroup: - SecurityGroupAccountId: '123456789012' - SecurityGroupName: default - Subnets: - - subnet-12345678 - SubregionNames: - - eu-west-2a - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateLoadBalancerPolicyResponse" description: The HTTP 200 response (OK). tags: - LoadBalancerPolicy "/CreateLoadBalancerTags": - description: |- - Adds one or more tags to the specified load balancers.
- If a tag with the same key already exists for the load balancer, the tag value is replaced.

- For more information, see [About Tags](https://docs.outscale.com/en/userguide/About-Tags.html). post: + description: |- + Adds one or more tags to the specified load balancers.
+ If a tag with the same key already exists for the load balancer, the tag value is replaced.

+ For more information, see [About Tags](https://docs.outscale.com/en/userguide/About-Tags.html). operationId: CreateLoadBalancerTags requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateLoadBalancerTagsRequest" examples: ex1: value: @@ -13973,64 +14076,62 @@ paths: Tags: - Key: key1 Value: value1 - schema: - "$ref": "#/components/schemas/CreateLoadBalancerTagsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateLoadBalancerTagsResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateLoadBalancerTagsResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer "/CreateNatService": - description: |- - Creates a network address translation (NAT) service in the specified public Subnet of a Net.
- A NAT service enables virtual machines (VMs) placed in the private Subnet of this Net to connect to the Internet, without being accessible from the Internet.
- When creating a NAT service, you specify the allocation ID of the public IP you want to use as public IP for the NAT service. Once the NAT service is created, you need to create a route in the route table of the private Subnet, with 0.0.0.0/0 as destination and the ID of the NAT service as target. For more information, see [LinkPublicIP](#linkpublicip) and [CreateRoute](#createroute).
- This action also enables you to create multiple NAT services in the same Net (one per public Subnet).

- - **[IMPORTANT]**
- You cannot modify the public IP associated with a NAT service after its creation. To do so, you need to delete the NAT service and create a new one with another public IP.

- For more information, see [About NAT Services](https://docs.outscale.com/en/userguide/About-NAT-Services.html). post: + description: |- + Creates a network address translation (NAT) service in the specified public Subnet of a Net.
+ A NAT service enables virtual machines (VMs) placed in the private Subnet of this Net to connect to the Internet, without being accessible from the Internet.
+ When creating a NAT service, you specify the allocation ID of the public IP you want to use as public IP for the NAT service. Once the NAT service is created, you need to create a route in the route table of the private Subnet, with 0.0.0.0/0 as destination and the ID of the NAT service as target. For more information, see [LinkPublicIP](#linkpublicip) and [CreateRoute](#createroute).
+ This action also enables you to create multiple NAT services in the same Net (one per public Subnet).

+ + **[IMPORTANT]**
+ You cannot modify the public IP associated with a NAT service after its creation. To do so, you need to delete the NAT service and create a new one with another public IP.

+ For more information, see [About NAT Services](https://docs.outscale.com/en/userguide/About-NAT-Services.html). operationId: CreateNatService requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateNatServiceRequest" examples: ex1: value: - PublicIpId: eipalloc-12345678 SubnetId: subnet-12345678 - schema: - "$ref": "#/components/schemas/CreateNatServiceRequest" + PublicIpId: eipalloc-12345678 responses: '200': content: application/json: - examples: + schema: + "$ref": "#/components/schemas/CreateNatServiceResponse" + examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 NatService: + Tags: [] + SubnetId: subnet-12345678 NatServiceId: nat-12345678 - NetId: vpc-12345678 PublicIps: - - PublicIp: 192.0.2.0 - PublicIpId: eipalloc-12345678 + - PublicIpId: eipalloc-12345678 + PublicIp: 192.0.2.0 + NetId: vpc-12345678 State: available - SubnetId: subnet-12345678 - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateNatServiceResponse" description: The HTTP 200 response (OK). '400': content: @@ -14053,39 +14154,39 @@ paths: tags: - NatService "/CreateNet": - description: |- - Creates a Net with a specified IP range.
- The IP range (network range) of your Net must be between a /28 netmask (16 IPs) and a /16 netmask (65536 IPs).

- For more information, see [About Nets](https://docs.outscale.com/en/userguide/About-Nets.html). post: + description: |- + Creates a Net with a specified IP range.
+ The IP range (network range) of your Net must be between a /28 netmask (16 IPs) and a /16 netmask (65536 IPs).

+ For more information, see [About Nets](https://docs.outscale.com/en/userguide/About-Nets.html). operationId: CreateNet requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateNetRequest" examples: ex1: value: IpRange: 10.0.0.0/16 - schema: - "$ref": "#/components/schemas/CreateNetRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateNetResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Net: + Tags: [] DhcpOptionsSetId: dopt-12345678 IpRange: 10.0.0.0/16 + Tenancy: default NetId: vpc-12345678 State: available - Tags: [] - Tenancy: default - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateNetResponse" description: The HTTP 200 response (OK). '400': content: @@ -14114,17 +14215,19 @@ paths: tags: - Net "/CreateNetAccessPoint": - description: |- - Creates a Net access point to access an OUTSCALE service from this Net without using the Internet and public IPs.
- You specify the service using its name. For more information about the available services, see [ReadNetAccessPointServices](#readnetaccesspointservices).

- To control the routing of traffic between the Net and the specified service, you can specify one or more route tables. Virtual machines placed in Subnets associated with the specified route table thus use the Net access point to access the service. When you specify a route table, a route is automatically added to it with the destination set to the prefix list ID of the service, and the target set to the ID of the access point.

- When a Net access point is created, a public IP is automatically allocated to your account and used for the Net access point. This public IP is not connected to the Internet. It is counted in your quota, but it is not billed.

- For more information, see [About Net Access Points](https://docs.outscale.com/en/userguide/About-Net-Access-Points.html). post: + description: |- + Creates a Net access point to access an OUTSCALE service from this Net without using the Internet and public IPs.
+ You specify the service using its name. For more information about the available services, see [ReadNetAccessPointServices](#readnetaccesspointservices).

+ To control the routing of traffic between the Net and the specified service, you can specify one or more route tables. Virtual machines placed in Subnets associated with the specified route table thus use the Net access point to access the service. When you specify a route table, a route is automatically added to it with the destination set to the prefix list ID of the service, and the target set to the ID of the access point.

+ When a Net access point is created, a public IP is automatically allocated to your account and used for the Net access point. This public IP is not connected to the Internet. It is counted in your quota, but it is not billed.

+ For more information, see [About Net Access Points](https://docs.outscale.com/en/userguide/About-Net-Access-Points.html). operationId: CreateNetAccessPoint requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateNetAccessPointRequest" examples: ex1: value: @@ -14132,107 +14235,105 @@ paths: RouteTableIds: - rtb-12345678 ServiceName: com.outscale.eu-west-2.oos - schema: - "$ref": "#/components/schemas/CreateNetAccessPointRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateNetAccessPointResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 NetAccessPoint: + Tags: [] NetAccessPointId: vpce-12345678 - NetId: vpc-12345678 RouteTableIds: - rtb-12345678 - ServiceName: com.outscale.eu-west-2.oos State: pending - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateNetAccessPointResponse" + NetId: vpc-12345678 + ServiceName: com.outscale.eu-west-2.oos description: The HTTP 200 response (OK). tags: - NetAccessPoint "/CreateNetPeering": - description: |- - Requests a Net peering between a Net you own and a peer Net that belongs to you or another account.
- This action creates a Net peering that remains in the `pending-acceptance` state until it is accepted by the owner of the peer Net. If the owner of the peer Net does not accept the request within 7 days, the state of the Net peering becomes `expired`. For more information, see [AcceptNetPeering](#acceptnetpeering).

+ post: + description: |- + Requests a Net peering between a Net you own and a peer Net that belongs to you or another account.
+ This action creates a Net peering that remains in the `pending-acceptance` state until it is accepted by the owner of the peer Net. If the owner of the peer Net does not accept the request within 7 days, the state of the Net peering becomes `expired`. For more information, see [AcceptNetPeering](#acceptnetpeering).

- **[IMPORTANT]**
- * Peered Nets must contain at least one virtual machine (VM) each before the creation of the Net peering.
- * The two Nets must not have overlapping IP ranges. Otherwise, the Net peering is in the `failed` state.
- * A peering connection between two Nets works both ways. If an A-to-B connection is already created and accepted, creating a B-to-A connection is not necessary and would be automatically rejected. + **[IMPORTANT]**
+ * Peered Nets must contain at least one virtual machine (VM) each before the creation of the Net peering.
+ * The two Nets must not have overlapping IP ranges. Otherwise, the Net peering is in the `failed` state.
+ * A peering connection between two Nets works both ways. If an A-to-B connection is already created and accepted, creating a B-to-A connection is not necessary and would be automatically rejected. - For more information, see [About Net Peerings](https://docs.outscale.com/en/userguide/About-Net-Peerings.html). - post: + For more information, see [About Net Peerings](https://docs.outscale.com/en/userguide/About-Net-Peerings.html). operationId: CreateNetPeering requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateNetPeeringRequest" examples: ex1: summary: Creating a Net peering between two Nets belonging to you value: - AccepterNetId: vpc-87654321 SourceNetId: vpc-12345678 + AccepterNetId: vpc-87654321 ex2: summary: Creating a Net peering with a Net that belongs to another account value: + SourceNetId: vpc-12345678 AccepterNetId: vpc-87654321 AccepterOwnerId: '987654321098' - SourceNetId: vpc-12345678 - schema: - "$ref": "#/components/schemas/CreateNetPeeringRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateNetPeeringResponse" examples: ex1: summary: Creating a Net peering between two Nets belonging to you value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 NetPeering: + Tags: [] + State: + Name: pending-acceptance + Message: Pending acceptance by 123456789012 AccepterNet: - AccountId: '123456789012' - IpRange: 172.16.0.0/16 NetId: vpc-12345678 - NetPeeringId: pcx-12345678 - SourceNet: + IpRange: 172.16.0.0/16 AccountId: '123456789012' - IpRange: 10.0.0.0/16 + SourceNet: NetId: vpc-87654321 - State: - Message: Pending acceptance by 123456789012 - Name: pending-acceptance - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + IpRange: 10.0.0.0/16 + AccountId: '123456789012' + NetPeeringId: pcx-12345678 ex2: summary: Creating a Net peering with a Net that belongs to another account value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 NetPeering: + Tags: [] + State: + Name: pending-acceptance + Message: Pending acceptance by 123456789012 AccepterNet: - AccountId: '987654321098' - IpRange: 172.16.0.0/16 NetId: vpc-87654321 - NetPeeringId: pcx-12345678 + IpRange: 172.16.0.0/16 + AccountId: '987654321098' SourceNet: - AccountId: '123456789012' - IpRange: 10.0.0.0/16 NetId: vpc-12345678 - State: - Message: Pending acceptance by 123456789012 - Name: pending-acceptance - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateNetPeeringResponse" + IpRange: 10.0.0.0/16 + AccountId: '123456789012' + NetPeeringId: pcx-12345678 description: The HTTP 200 response (OK). '400': content: @@ -14255,93 +14356,93 @@ paths: tags: - NetPeering "/CreateNic": - description: |- - Creates a network interface card (NIC) in the specified Subnet.

- For more information, see [About NICs](https://docs.outscale.com/en/userguide/About-NICs.html). post: + description: |- + Creates a network interface card (NIC) in the specified Subnet.

+ For more information, see [About NICs](https://docs.outscale.com/en/userguide/About-NICs.html). operationId: CreateNic requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateNicRequest" examples: ex1: summary: Creating a NIC value: + SubnetId: subnet-12345678 SecurityGroupIds: - sg-12345678 - SubnetId: subnet-12345678 ex2: summary: Creating a NIC with specific private IPs value: Description: Terraform nic with private IPs + SubnetId: subnet-12345678 + SecurityGroupIds: + - sg-12345678 PrivateIps: - IsPrimary: true PrivateIp: 10.0.0.4 - IsPrimary: false PrivateIp: 10.0.0.5 - SecurityGroupIds: - - sg-12345678 - SubnetId: subnet-12345678 - schema: - "$ref": "#/components/schemas/CreateNicRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateNicResponse" examples: ex1: summary: Creating a NIC value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Nic: - AccountId: '123456789012' - Description: '' + SubregionName: eu-west-2a + SubnetId: subnet-12345678 + State: available IsSourceDestChecked: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + Tags: [] + Description: '' + AccountId: '123456789012' + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - IsPrimary: true - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - SecurityGroups: - - SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - State: available - SubnetId: subnet-12345678 - SubregionName: eu-west-2a - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + IsPrimary: true ex2: summary: Creating a NIC with specific private IPs value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Nic: - AccountId: '123456789012' - Description: '' + SubregionName: eu-west-2a + SubnetId: subnet-12345678 + State: available IsSourceDestChecked: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + Tags: [] + Description: '' + AccountId: '123456789012' + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - IsPrimary: true - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - - IsPrimary: false - PrivateDnsName: ip-10-0-0-5.eu-west-2.compute.internal + IsPrimary: true + - PrivateDnsName: ip-10-0-0-5.eu-west-2.compute.internal PrivateIp: 10.0.0.5 - SecurityGroups: - - SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - State: available - SubnetId: subnet-12345678 - SubregionName: eu-west-2a - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateNicResponse" + IsPrimary: false description: The HTTP 200 response (OK). '400': content: @@ -14364,14 +14465,16 @@ paths: tags: - Nic "/CreatePolicy": - description: |- - Creates a managed policy to apply to a user.
- This action creates a policy version and sets v1 as the default one. post: + description: |- + Creates a managed policy to apply to a user.
+ This action creates a policy version and sets v1 as the default one. operationId: CreatePolicy requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreatePolicyRequest" examples: ex1: value: @@ -14380,42 +14483,42 @@ paths: "Resource": ["*"]} ]}' Path: "/example/" PolicyName: example-user-policy - schema: - "$ref": "#/components/schemas/CreatePolicyRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreatePolicyResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Policy: + ResourcesCount: 0 + PolicyName: example-user-policy + PolicyDefaultVersionId: v1 + Path: "/example/" CreationDate: 2010-10-01 12:34:56.789000000 +00:00 Description: Example of description + PolicyId: ABCDEFGHIJKLMNOPQRSTUVWXYZ01234 + Orn: orn:ows:idauth::012345678910:policy/example/example-user-policy IsLinkable: true LastModificationDate: 2010-10-01 12:34:56.789000000 +00:00 - Orn: orn:ows:idauth::012345678910:policy/example/example-user-policy - Path: "/example/" - PolicyDefaultVersionId: v1 - PolicyId: ABCDEFGHIJKLMNOPQRSTUVWXYZ01234 - PolicyName: example-user-policy - ResourcesCount: 0 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreatePolicyResponse" description: The HTTP 200 response (OK). tags: - Policy "/CreatePolicyVersion": - description: |- - Creates a version of a specified managed policy.
- A managed policy can have up to five versions. post: + description: |- + Creates a version of a specified managed policy.
+ A managed policy can have up to five versions. operationId: CreatePolicyVersion requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreatePolicyVersionRequest" examples: ex1: value: @@ -14423,91 +14526,89 @@ paths: "Resource": ["*"]} ]}' PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy SetAsDefault: true - schema: - "$ref": "#/components/schemas/CreatePolicyVersionRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreatePolicyVersionResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 PolicyVersion: + VersionId: v2 + DefaultVersion: true + CreationDate: 2017-05-10 12:34:56.789000000 +00:00 Body: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], "Resource": ["*"]} ]}' - CreationDate: 2017-05-10 12:34:56.789000000 +00:00 - DefaultVersion: true - VersionId: v2 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreatePolicyVersionResponse" description: The HTTP 200 response (OK). tags: - Policy "/CreateProductType": - description: Creates a product type you can associate with an OMI for consumption - monitoring and billing purposes. post: + description: Creates a product type you can associate with an OMI for consumption + monitoring and billing purposes. operationId: CreateProductType requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateProductTypeRequest" examples: ex1: value: - Description: Example of description Vendor: vendor-name - schema: - "$ref": "#/components/schemas/CreateProductTypeRequest" + Description: Example of description responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateProductTypeResponse" examples: ex1: value: - ProductType: - Description: Example of description - ProductTypeId: pty-12345678 - Vendor: vendor-name ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateProductTypeResponse" + ProductType: + Vendor: vendor-name + ProductTypeId: pty-12345678 + Description: Example of description description: The HTTP 200 response (OK). tags: - ProductType "/CreatePublicIp": - description: |- - Acquires a public IP for your account.
- A public IP is a static IP designed for dynamic Cloud computing. It can be associated with a virtual machine (VM) in the public Cloud or in a Net, a network interface card (NIC), a NAT service.

- For more information, see [About Public IPs](https://docs.outscale.com/en/userguide/About-Public-IPs.html). post: + description: |- + Acquires a public IP for your account.
+ A public IP is a static IP designed for dynamic Cloud computing. It can be associated with a virtual machine (VM) in the public Cloud or in a Net, a network interface card (NIC), a NAT service.

+ For more information, see [About Public IPs](https://docs.outscale.com/en/userguide/About-Public-IPs.html). operationId: CreatePublicIp requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreatePublicIpRequest" examples: ex1: value: {} - schema: - "$ref": "#/components/schemas/CreatePublicIpRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreatePublicIpResponse" examples: ex1: value: - PublicIp: - PublicIp: 192.0.2.0 - PublicIpId: eipalloc-12345678 - Tags: [] ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreatePublicIpResponse" + PublicIp: + Tags: [] + PublicIpId: eipalloc-12345678 + PublicIp: 192.0.2.0 description: The HTTP 200 response (OK). '400': content: @@ -14530,59 +14631,59 @@ paths: tags: - PublicIp "/CreateRoute": - description: |- - Creates a route in a specified route table within a specified Net.
- You must specify one of the following elements as the target:

+ post: + description: |- + Creates a route in a specified route table within a specified Net.
+ You must specify one of the following elements as the target:

- * Net peering
- * NAT VM
- * Internet service
- * Virtual gateway
- * NAT service
- * Network interface card (NIC)

+ * Net peering
+ * NAT VM
+ * Internet service
+ * Virtual gateway
+ * NAT service
+ * Network interface card (NIC)

- The routing algorithm is based on the most specific match.

- For more information, see [About Route Tables](https://docs.outscale.com/en/userguide/About-Route-Tables.html). - post: + The routing algorithm is based on the most specific match.

+ For more information, see [About Route Tables](https://docs.outscale.com/en/userguide/About-Route-Tables.html). operationId: CreateRoute requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateRouteRequest" examples: ex1: summary: Creating a route to an Internet service value: + RouteTableId: rtb-12345678 DestinationIpRange: 0.0.0.0/0 GatewayId: igw-12345678 - RouteTableId: rtb-12345678 - schema: - "$ref": "#/components/schemas/CreateRouteRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateRouteResponse" examples: ex1: summary: Creating a route to an Internet service value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 RouteTable: - LinkRouteTables: [] - NetId: vpc-12345678 - RoutePropagatingVirtualGateways: [] - RouteTableId: rtb-12345678 Routes: - - CreationMethod: CreateRouteTable - DestinationIpRange: 10.0.0.0/16 + - DestinationIpRange: 10.0.0.0/16 + CreationMethod: CreateRouteTable State: active - - CreationMethod: CreateRoute + - GatewayId: igw-12345678 DestinationIpRange: 0.0.0.0/0 - GatewayId: igw-12345678 + CreationMethod: CreateRoute State: active + LinkRouteTables: [] + NetId: vpc-12345678 Tags: [] - schema: - "$ref": "#/components/schemas/CreateRouteResponse" + RoutePropagatingVirtualGateways: [] + RouteTableId: rtb-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -14605,42 +14706,42 @@ paths: tags: - Route "/CreateRouteTable": - description: |- - Creates a route table for a specified Net.
- You can then add routes and associate this route table with a Subnet.

- For more information, see [About Route Tables](https://docs.outscale.com/en/userguide/About-Route-Tables.html). post: + description: |- + Creates a route table for a specified Net.
+ You can then add routes and associate this route table with a Subnet.

+ For more information, see [About Route Tables](https://docs.outscale.com/en/userguide/About-Route-Tables.html). operationId: CreateRouteTable requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateRouteTableRequest" examples: ex1: value: NetId: vpc-12345678 - schema: - "$ref": "#/components/schemas/CreateRouteTableRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateRouteTableResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 RouteTable: + Routes: + - DestinationIpRange: 10.0.0.0/16 + CreationMethod: CreateRouteTable + State: active LinkRouteTables: [] NetId: vpc-12345678 + Tags: [] RoutePropagatingVirtualGateways: [] RouteTableId: rtb-12345678 - Routes: - - CreationMethod: CreateRouteTable - DestinationIpRange: 10.0.0.0/16 - State: active - Tags: [] - schema: - "$ref": "#/components/schemas/CreateRouteTableResponse" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -14663,52 +14764,52 @@ paths: tags: - RouteTable "/CreateSecurityGroup": - description: |- - Creates a security group.
- This action creates a security group either in the public Cloud or in a specified Net. By default, a default security group for use in the public Cloud and a default security group for use in a Net are created.
- When launching a virtual machine (VM), if no security group is explicitly specified, the appropriate default security group is assigned to the VM. Default security groups include a default rule granting VMs network access to each other.
- When creating a security group, you specify a name. Two security groups for use in the public Cloud or for use in a Net cannot have the same name.
- You can have up to 500 security groups in the public Cloud. You can create up to 500 security groups per Net.
- To add or remove rules, use the [CreateSecurityGroupRule](#createsecuritygrouprule) method.

- For more information, see [About Security Groups](https://docs.outscale.com/en/userguide/About-Security-Groups.html). post: + description: |- + Creates a security group.
+ This action creates a security group either in the public Cloud or in a specified Net. By default, a default security group for use in the public Cloud and a default security group for use in a Net are created.
+ When launching a virtual machine (VM), if no security group is explicitly specified, the appropriate default security group is assigned to the VM. Default security groups include a default rule granting VMs network access to each other.
+ When creating a security group, you specify a name. Two security groups for use in the public Cloud or for use in a Net cannot have the same name.
+ You can have up to 500 security groups in the public Cloud. You can create up to 500 security groups per Net.
+ To add or remove rules, use the [CreateSecurityGroupRule](#createsecuritygrouprule) method.

+ For more information, see [About Security Groups](https://docs.outscale.com/en/userguide/About-Security-Groups.html). operationId: CreateSecurityGroup requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateSecurityGroupRequest" examples: ex1: value: - Description: Security group example NetId: vpc-12345678 SecurityGroupName: security-group-example - schema: - "$ref": "#/components/schemas/CreateSecurityGroupRequest" + Description: Security group example responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateSecurityGroupResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 SecurityGroup: - AccountId: '123456789012' - Description: Example of security group - InboundRules: [] - NetId: vpc-12345678 + Tags: [] + SecurityGroupName: security-group-example OutboundRules: - FromPortRange: -1 IpProtocol: "-1" + ToPortRange: -1 IpRanges: - 0.0.0.0/0 - ToPortRange: -1 SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - Tags: [] - schema: - "$ref": "#/components/schemas/CreateSecurityGroupResponse" + AccountId: '123456789012' + Description: Example of security group + InboundRules: [] + NetId: vpc-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -14731,109 +14832,109 @@ paths: tags: - SecurityGroup "/CreateSecurityGroupRule": - description: |- - Adds one or more rules to a security group.
- Use the `SecurityGroupId` parameter to specify the security group for which you want to create a rule.
- Use the `Flow` parameter to specify if you want an inbound rule or an outbound rule.

- An inbound rule allows the security group to receive traffic: - * Either from a specific IP range (`IpRange` parameter) on a specific port range (`FromPortRange` and `ToPortRange` parameters) and specific protocol (`IpProtocol` parameter). - * Or from another specific security group (`SecurityGroupAccountIdToLink` and `SecurityGroupNameToLink` parameters).
+ post: + description: |- + Adds one or more rules to a security group.
+ Use the `SecurityGroupId` parameter to specify the security group for which you want to create a rule.
+ Use the `Flow` parameter to specify if you want an inbound rule or an outbound rule.

+ An inbound rule allows the security group to receive traffic: + * Either from a specific IP range (`IpRange` parameter) on a specific port range (`FromPortRange` and `ToPortRange` parameters) and specific protocol (`IpProtocol` parameter). + * Or from another specific security group (`SecurityGroupAccountIdToLink` and `SecurityGroupNameToLink` parameters).
- (Net only) An outbound rule works similarly but allows the security group to send traffic rather than receive traffic.
+ (Net only) An outbound rule works similarly but allows the security group to send traffic rather than receive traffic.
- Alternatively, you can use the `Rules` parameter to add several rules at the same time. + Alternatively, you can use the `Rules` parameter to add several rules at the same time. - **[NOTE]**
- * The modifications are effective as quickly as possible, but a small delay may occur.
- * By default, traffic between two security groups is allowed through both public and private IPs. To restrict traffic to private IPs only, contact our Support team at support@outscale.com. + **[NOTE]**
+ * The modifications are effective as quickly as possible, but a small delay may occur.
+ * By default, traffic between two security groups is allowed through both public and private IPs. To restrict traffic to private IPs only, contact our Support team at support@outscale.com. - For more information, see [About Security Group Rules](https://docs.outscale.com/en/userguide/About-Security-Group-Rules.html). - post: + For more information, see [About Security Group Rules](https://docs.outscale.com/en/userguide/About-Security-Group-Rules.html). operationId: CreateSecurityGroupRule requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateSecurityGroupRuleRequest" examples: ex1: summary: Creating an inbound rule from an IP range value: Flow: Inbound + SecurityGroupId: sg-12345678 FromPortRange: 80 + ToPortRange: 80 IpProtocol: tcp IpRange: 10.0.0.0/16 - SecurityGroupId: sg-12345678 - ToPortRange: 80 ex2: summary: Creating an inbound rule from another security group value: Flow: Inbound + SecurityGroupId: sg-12345678 Rules: - FromPortRange: 22 + ToPortRange: 22 IpProtocol: tcp SecurityGroupsMembers: - AccountId: '123456789012' SecurityGroupName: another-security-group - ToPortRange: 22 - SecurityGroupId: sg-12345678 - schema: - "$ref": "#/components/schemas/CreateSecurityGroupRuleRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateSecurityGroupRuleResponse" examples: ex1: summary: Creating an inbound rule from an IP range value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 SecurityGroup: + Tags: [] + SecurityGroupName: security-group-example + OutboundRules: + - FromPortRange: -1 + IpProtocol: "-1" + ToPortRange: -1 + IpRanges: + - 0.0.0.0/0 + SecurityGroupId: sg-12345678 AccountId: '123456789012' Description: Example of security group InboundRules: - FromPortRange: 80 IpProtocol: tcp + ToPortRange: 80 IpRanges: - 10.0.0.0/16 - ToPortRange: 80 NetId: vpc-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + summary: Creating an inbound rule from another security group + value: + SecurityGroup: + Tags: [] + SecurityGroupName: security-group-example OutboundRules: - FromPortRange: -1 IpProtocol: "-1" + ToPortRange: -1 IpRanges: - 0.0.0.0/0 - ToPortRange: -1 SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - Tags: [] - ex2: - summary: Creating an inbound rule from another security group - value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - SecurityGroup: AccountId: '123456789012' Description: Example of security group InboundRules: - FromPortRange: 22 IpProtocol: tcp + ToPortRange: 22 SecurityGroupsMembers: - - AccountId: '987654321098' + - SecurityGroupName: another-security-group SecurityGroupId: sg-87654321 - SecurityGroupName: another-security-group - ToPortRange: 22 + AccountId: '987654321098' NetId: vpc-12345678 - OutboundRules: - - FromPortRange: -1 - IpProtocol: "-1" - IpRanges: - - 0.0.0.0/0 - ToPortRange: -1 - SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - Tags: [] - schema: - "$ref": "#/components/schemas/CreateSecurityGroupRuleResponse" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -14856,146 +14957,146 @@ paths: tags: - SecurityGroupRule "/CreateServerCertificate": - description: |- - Creates a server certificate and its matching private key.

- These elements can be used with other services (for example, to configure SSL termination on load balancers).

- You can also specify the chain of intermediate certification authorities if your certificate is not directly signed by a root one. You can specify multiple intermediate certification authorities in the `CertificateChain` parameter. To do so, concatenate all certificates in the correct order (the first certificate must be the authority of your certificate, the second must be the authority of the first one, and so on).

- The private key must be a RSA key in PKCS1 form. To check this, open the PEM file and ensure its header reads as follows: BEGIN RSA PRIVATE KEY.

- [IMPORTANT]

- This private key must not be protected by a password or a passphrase.

- For more information, see [About Server Certificates in EIM](https://docs.outscale.com/en/userguide/About-Server-Certificates-in-EIM.html). post: + description: |- + Creates a server certificate and its matching private key.

+ These elements can be used with other services (for example, to configure SSL termination on load balancers).

+ You can also specify the chain of intermediate certification authorities if your certificate is not directly signed by a root one. You can specify multiple intermediate certification authorities in the `CertificateChain` parameter. To do so, concatenate all certificates in the correct order (the first certificate must be the authority of your certificate, the second must be the authority of the first one, and so on).

+ The private key must be a RSA key in PKCS1 form. To check this, open the PEM file and ensure its header reads as follows: BEGIN RSA PRIVATE KEY.

+ [IMPORTANT]

+ This private key must not be protected by a password or a passphrase.

+ For more information, see [About Server Certificates in EIM](https://docs.outscale.com/en/userguide/About-Server-Certificates-in-EIM.html). operationId: CreateServerCertificate requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateServerCertificateRequest" examples: ex1: value: + Name: server-cert-example Body: "..." Chain: "..." - Name: server-cert-example - Path: "/example/" PrivateKey: "..." - schema: - "$ref": "#/components/schemas/CreateServerCertificateRequest" + Path: "/example/" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateServerCertificateResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ServerCertificate: + Path: "/example/" Id: ABCDEFGHIJKLMNOPQRSTUVWXYZ1234 - Name: server-cert-example Orn: orn:ows:idauth::012345678910:server-certificate/example/server-cert-example - Path: "/example/" - schema: - "$ref": "#/components/schemas/CreateServerCertificateResponse" + Name: server-cert-example + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - ServerCertificate "/CreateSnapshot": - description: |- - Creates a snapshot. Snapshots are point-in-time images of a volume that you can use to back up your data or to create replicas of this volume.
- You can use this method in three different ways: - * **Creating from a volume**: You create a snapshot from one of your volumes.
- * **Copying a snapshot**: You copy an existing snapshot. The source snapshot can be one of your own snapshots, or a snapshot owned by another account that has granted you permission via the [UpdateSnapshot](#updatesnapshot) method.
- * **Importing from a bucket**: You import a snapshot located in an OUTSCALE Object Storage (OOS) bucket. First, the owner of the source snapshot must export it to a bucket by using the [CreateSnapshotExportTask](#createsnapshotexporttask) method. Then, they must grant you permission to read the snapshot via a pre-signed URL. For more information, see [Creating a Pre-Signed URL](https://docs.outscale.com/en/userguide/Creating-a-Pre-Signed-URL.html). + post: + description: |- + Creates a snapshot. Snapshots are point-in-time images of a volume that you can use to back up your data or to create replicas of this volume.
+ You can use this method in three different ways: + * **Creating from a volume**: You create a snapshot from one of your volumes.
+ * **Copying a snapshot**: You copy an existing snapshot. The source snapshot can be one of your own snapshots, or a snapshot owned by another account that has granted you permission via the [UpdateSnapshot](#updatesnapshot) method.
+ * **Importing from a bucket**: You import a snapshot located in an OUTSCALE Object Storage (OOS) bucket. First, the owner of the source snapshot must export it to a bucket by using the [CreateSnapshotExportTask](#createsnapshotexporttask) method. Then, they must grant you permission to read the snapshot via a pre-signed URL. For more information, see [Creating a Pre-Signed URL](https://docs.outscale.com/en/userguide/Creating-a-Pre-Signed-URL.html). - **[NOTE]**
- In case of excessive use of the snapshot creation feature on the same volume over a short period of time, 3DS OUTSCALE reserves the right to temporarily block the feature. + **[NOTE]**
+ In case of excessive use of the snapshot creation feature on the same volume over a short period of time, 3DS OUTSCALE reserves the right to temporarily block the feature. - For more information, see [About Snapshots](https://docs.outscale.com/en/userguide/About-Snapshots.html). - post: + For more information, see [About Snapshots](https://docs.outscale.com/en/userguide/About-Snapshots.html). operationId: CreateSnapshot requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateSnapshotRequest" examples: ex1: summary: Creating from a volume value: - Description: Snapshot created from a volume VolumeId: vol-12345678 + Description: Snapshot created from a volume ex2: summary: Copying a snapshot value: - Description: Snapshot created from another snapshot - SourceRegionName: eu-west-2 SourceSnapshotId: snap-12345678 + SourceRegionName: eu-west-2 + Description: Snapshot created from another snapshot ex3: summary: Importing from a bucket value: - Description: Snapshot imported from a bucket FileLocation: https://oos.eu-west-2.outscale.com/BUCKET/KEY?AWSAccessKeyId=ABCDEFGHIJ0123456789&Expires=1493372309&Signature=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX SnapshotSize: 10737418240 - schema: - "$ref": "#/components/schemas/CreateSnapshotRequest" + Description: Snapshot imported from a bucket responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateSnapshotResponse" examples: ex1: summary: Creating from a volume value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Snapshot: + VolumeSize: 10 AccountId: '123456789012' + VolumeId: vol-12345678 CreationDate: '2010-10-01T12:34:56.789Z' - Description: Snapshot created from a volume PermissionsToCreateVolume: - AccountIds: [] GlobalPermission: false + AccountIds: [] Progress: 0 SnapshotId: snap-12345678 State: pending/queued + Description: Snapshot created from a volume Tags: [] - VolumeId: vol-12345678 - VolumeSize: 10 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Copying a snapshot value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Snapshot: + VolumeSize: 10 AccountId: '123456789012' + VolumeId: vol-12345678 CreationDate: '2010-10-01T12:34:56.789Z' - Description: Snapshot copied from another snapshot PermissionsToCreateVolume: - AccountIds: [] GlobalPermission: false + AccountIds: [] Progress: 100 SnapshotId: snap-12345678 State: completed + Description: Snapshot copied from another snapshot Tags: [] - VolumeId: vol-12345678 - VolumeSize: 10 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex3: summary: Importing from a bucket value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Snapshot: + VolumeSize: 10 AccountId: '123456789012' + VolumeId: vol-12345678 CreationDate: '2010-10-01T12:34:56.789Z' - Description: Snapshot imported from a bucket PermissionsToCreateVolume: - AccountIds: [] GlobalPermission: false + AccountIds: [] Progress: 0 SnapshotId: snap-12345678 State: importing + Description: Snapshot imported from a bucket Tags: [] - VolumeId: vol-12345678 - VolumeSize: 10 - schema: - "$ref": "#/components/schemas/CreateSnapshotResponse" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -15018,87 +15119,87 @@ paths: tags: - Snapshot "/CreateSnapshotExportTask": - description: |- - Exports a snapshot to an OUTSCALE Object Storage (OOS) bucket that belongs to you. This action enables you to create a backup of your snapshot.

- You can share this snapshot with others accounts by granting permission to read it via pre-signed URLs. For more information, see [Creating a Pre-Signed URL](https://docs.outscale.com/en/userguide/Creating-a-Pre-Signed-URL.html).

- For more information, see [About Snapshots](https://docs.outscale.com/en/userguide/About-Snapshots.html). post: + description: |- + Exports a snapshot to an OUTSCALE Object Storage (OOS) bucket that belongs to you. This action enables you to create a backup of your snapshot.

+ You can share this snapshot with others accounts by granting permission to read it via pre-signed URLs. For more information, see [Creating a Pre-Signed URL](https://docs.outscale.com/en/userguide/Creating-a-Pre-Signed-URL.html).

+ For more information, see [About Snapshots](https://docs.outscale.com/en/userguide/About-Snapshots.html). operationId: CreateSnapshotExportTask requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateSnapshotExportTaskRequest" examples: ex1: value: + SnapshotId: snap-12345678 OsuExport: DiskImageFormat: qcow2 OsuBucket: BUCKET OsuPrefix: PREFIX - SnapshotId: snap-12345678 - schema: - "$ref": "#/components/schemas/CreateSnapshotExportTaskRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateSnapshotExportTaskResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 SnapshotExportTask: + Tags: [] + TaskId: snap-export-12345678 Comment: Export of snapshot snap-12345678 OsuExport: - DiskImageFormat: qcow2 - OsuBucket: BUCKET OsuPrefix: PREFIX - Progress: 0 - SnapshotId: snap-12345678 + OsuBucket: BUCKET + DiskImageFormat: qcow2 State: pending - Tags: [] - TaskId: snap-export-12345678 - schema: - "$ref": "#/components/schemas/CreateSnapshotExportTaskResponse" + SnapshotId: snap-12345678 + Progress: 0 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - Snapshot "/CreateSubnet": - description: |- - Creates a Subnet in an existing Net.
- To create a Subnet in a Net, you have to provide the ID of the Net and the IP range for the Subnet (its network range). Once the Subnet is created, you cannot modify its IP range.

- For more information, see [About Nets](https://docs.outscale.com/en/userguide/About-Nets.html). post: + description: |- + Creates a Subnet in an existing Net.
+ To create a Subnet in a Net, you have to provide the ID of the Net and the IP range for the Subnet (its network range). Once the Subnet is created, you cannot modify its IP range.

+ For more information, see [About Nets](https://docs.outscale.com/en/userguide/About-Nets.html). operationId: CreateSubnet requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateSubnetRequest" examples: ex1: value: - IpRange: 10.0.0.0/18 NetId: vpc-12345678 - schema: - "$ref": "#/components/schemas/CreateSubnetRequest" + IpRange: 10.0.0.0/18 responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateSubnetResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Subnet: + Tags: [] + SubregionName: eu-west-2a + SubnetId: subnet-12345678 AvailableIpsCount: 16379 IpRange: 10.0.0.0/18 MapPublicIpOnLaunch: false - NetId: vpc-12345678 State: available - SubnetId: subnet-12345678 - SubregionName: eu-west-2a - Tags: [] - schema: - "$ref": "#/components/schemas/CreateSubnetResponse" + NetId: vpc-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -15127,40 +15228,42 @@ paths: tags: - Subnet "/CreateTags": - description: |- - Adds one or more tags to the specified resources.
- If a tag with the same key already exists for the resource, the tag value is replaced.
- You can tag the following resources using their IDs:

+ post: + description: |- + Adds one or more tags to the specified resources.
+ If a tag with the same key already exists for the resource, the tag value is replaced.
+ You can tag the following resources using their IDs:

- * Client gateways (cgw-xxxxxxxx)
- * DHCP options (dopt-xxxxxxxx)
- * Images (ami-xxxxxxxx)
- * Internet services (igw-xxxxxxxx)
- * Keypairs (key-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx)
- * NAT services (nat-xxxxxxxx)
- * Net endpoints (vpce-xxxxxxxx)
- * Net peerings (vpcx-xxxxxxxx)
- * Nets (vpc-xxxxxxxx)
- * Network interface cards (NIC) (eni-xxxxxxxx)
- * OMI export tasks (image-export-xxxxxxxx)
- * OMIs (ami-xxxxxxxx)
- * Public IPs (eipalloc-xxxxxxxx)
- * Route tables (rtb-xxxxxxxx)
- * Security groups (sg-xxxxxxxx)
- * Snapshot export tasks (snap-export-xxxxxxxx) - * Snapshots (snap-xxxxxxxx)
- * Subnets (subnet-xxxxxxxx)
- * Virtual gateways (vgw-xxxxxxxx)
- * Virtual machines (VMs) (i-xxxxxxxx)
- * Volumes (vol-xxxxxxxx)
- * VPN connections (vpn-xxxxxxxx)
+ * Client gateways (cgw-xxxxxxxx)
+ * DHCP options (dopt-xxxxxxxx)
+ * Images (ami-xxxxxxxx)
+ * Internet services (igw-xxxxxxxx)
+ * Keypairs (key-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx)
+ * NAT services (nat-xxxxxxxx)
+ * Net endpoints (vpce-xxxxxxxx)
+ * Net peerings (vpcx-xxxxxxxx)
+ * Nets (vpc-xxxxxxxx)
+ * Network interface cards (NIC) (eni-xxxxxxxx)
+ * OMI export tasks (image-export-xxxxxxxx)
+ * OMIs (ami-xxxxxxxx)
+ * Public IPs (eipalloc-xxxxxxxx)
+ * Route tables (rtb-xxxxxxxx)
+ * Security groups (sg-xxxxxxxx)
+ * Snapshot export tasks (snap-export-xxxxxxxx) + * Snapshots (snap-xxxxxxxx)
+ * Subnets (subnet-xxxxxxxx)
+ * Virtual gateways (vgw-xxxxxxxx)
+ * Virtual machines (VMs) (i-xxxxxxxx)
+ * Volumes (vol-xxxxxxxx)
+ * VPN connections (vpn-xxxxxxxx)
- For more information, see [About Tags](https://docs.outscale.com/en/userguide/About-Tags.html). - post: + For more information, see [About Tags](https://docs.outscale.com/en/userguide/About-Tags.html). operationId: CreateTags requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateTagsRequest" examples: ex1: value: @@ -15169,19 +15272,17 @@ paths: Tags: - Key: key1 Value: value1 - schema: - "$ref": "#/components/schemas/CreateTagsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateTagsResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateTagsResponse" description: The HTTP 200 response (OK). '400': content: @@ -15204,63 +15305,65 @@ paths: tags: - Tag "/CreateUser": - description: |- - Creates an EIM user for your account.

- For more information, see [About EIM Users](https://docs.outscale.com/en/userguide/About-EIM-Users.html). post: + description: |- + Creates an EIM user for your account.

+ For more information, see [About EIM Users](https://docs.outscale.com/en/userguide/About-EIM-Users.html). operationId: CreateUser requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateUserRequest" examples: ex1: value: - Path: "/documentation/" UserEmail: user@example.com UserName: example-user - schema: - "$ref": "#/components/schemas/CreateUserRequest" + Path: "/documentation/" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateUserResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 User: CreationDate: 2010-10-01 12:34:56.789000000 +00:00 LastModificationDate: 2017-05-10 12:34:56.789000000 +00:00 - Path: "/documentation/" UserEmail: user@example.com - UserId: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 UserName: example-user - schema: - "$ref": "#/components/schemas/CreateUserResponse" + UserId: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 + Path: "/documentation/" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - User "/CreateUserGroup": - description: |- - Creates a group to which you can add users.
- You can also add an inline policy or link a managed policy to the group, which is applied to all its users. post: + description: |- + Creates a group to which you can add users.
+ You can also add an inline policy or link a managed policy to the group, which is applied to all its users. operationId: CreateUserGroup requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateUserGroupRequest" examples: ex1: value: Path: "/example/" UserGroupName: example-usergroup - schema: - "$ref": "#/components/schemas/CreateUserGroupRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateUserGroupResponse" examples: ex1: value: @@ -15273,59 +15376,59 @@ paths: Orn: orn:ows:idauth::012345678910:usergroup/example/usergroup-example Path: "/example/" UserGroupId: ug-12345678 - schema: - "$ref": "#/components/schemas/CreateUserGroupResponse" description: The HTTP 200 response (OK). tags: - UserGroup "/CreateVirtualGateway": - description: |- - Creates a virtual gateway.
- A virtual gateway is the access point on the Net side of a VPN connection.

- For more information, see [About Virtual Gateways](https://docs.outscale.com/en/userguide/About-Virtual-Gateways.html). post: + description: |- + Creates a virtual gateway.
+ A virtual gateway is the access point on the Net side of a VPN connection.

+ For more information, see [About Virtual Gateways](https://docs.outscale.com/en/userguide/About-Virtual-Gateways.html). operationId: CreateVirtualGateway requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateVirtualGatewayRequest" examples: ex1: value: ConnectionType: ipsec.1 - schema: - "$ref": "#/components/schemas/CreateVirtualGatewayRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateVirtualGatewayResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VirtualGateway: + VirtualGatewayId: vgw-12345678 ConnectionType: ipsec.1 NetToVirtualGatewayLinks: [] State: available Tags: [] - VirtualGatewayId: vgw-12345678 - schema: - "$ref": "#/components/schemas/CreateVirtualGatewayResponse" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - VirtualGateway "/CreateVmGroup": - description: |- - > [WARNING]
- > This feature is currently under development and may not function properly.
- - Creates a group of virtual machines (VMs) containing the same characteristics as a specified VM template, and then launches them.
- You can create up to 100 VM groups in your account. post: + description: |- + > [WARNING]
+ > This feature is currently under development and may not function properly.
+ + Creates a group of virtual machines (VMs) containing the same characteristics as a specified VM template, and then launches them.
+ You can create up to 100 VM groups in your account. operationId: CreateVmGroup requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateVmGroupRequest" examples: ex1: value: @@ -15340,17 +15443,15 @@ paths: VmCount: 2 VmGroupName: ClusterLog-PPD01 VmTemplateId: vmtemplate-98765432109876543210987654321012 - schema: - "$ref": "#/components/schemas/CreateVmGroupRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateVmGroupResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VmGroup: CreationDate: '2010-10-01T12:34:56.789Z' Description: Production log collector @@ -15367,8 +15468,8 @@ paths: VmGroupName: ClusterLog-PPD01 VmIds: [] VmTemplateId: vmtemplate-98765432109876543210987654321012 - schema: - "$ref": "#/components/schemas/CreateVmGroupResponse" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -15391,17 +15492,19 @@ paths: tags: - VmGroup "/CreateVmTemplate": - description: |- - > [WARNING]
- > This feature is currently under development and may not function properly.
- - Creates a virtual machine (VM) template. You can then use the VM template to create VM groups.
- You can create up to 50 VM templates in your account. post: + description: |- + > [WARNING]
+ > This feature is currently under development and may not function properly.
+ + Creates a virtual machine (VM) template. You can then use the VM template to create VM groups.
+ You can create up to 50 VM templates in your account. operationId: CreateVmTemplate requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateVmTemplateRequest" examples: ex1: value: @@ -15416,49 +15519,49 @@ paths: - Key: key1 Value: value1 VmTemplateName: vmtemplate-example - schema: - "$ref": "#/components/schemas/CreateVmTemplateRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateVmTemplateResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VmTemplate: - CpuCores: 2 - CpuGeneration: v4 + VmTemplateName: vmtemplate-example CpuPerformance: high CreationDate: 2010-10-01 12:34:56.789000000 +00:00 - Description: Log collector template - ImageId: ami-12345678 - Ram: 2 + CpuCores: 2 Tags: - Key: key1 Value: value1 + Description: Log collector template + ImageId: ami-12345678 + CpuGeneration: v4 VmTemplateId: vmtemplate-98765432109876543210987654321012 - VmTemplateName: vmtemplate-example - schema: - "$ref": "#/components/schemas/CreateVmTemplateResponse" + Ram: 2 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - VmTemplate "/CreateVms": - description: |- - Creates virtual machines (VMs), and then launches them.
- This action enables you to create a specified number of VMs using an OUTSCALE machine image (OMI) that you are allowed to use, and then to automatically launch them.
- The VMs remain in the `pending` state until they are created and ready to be used. Once automatically launched, they are in the `running` state.
- To check the state of your VMs, call the [ReadVms](#readvms) method.
- If not specified, the security group used by the service is the default one.
- The metadata server enables you to get the public key provided when the VM is launched. Official OMIs contain a script to get this public key and put it inside the VM to provide secure access without password.

- For more information, see [About VMs](https://docs.outscale.com/en/userguide/About-VMs.html). post: + description: |- + Creates virtual machines (VMs), and then launches them.
+ This action enables you to create a specified number of VMs using an OUTSCALE machine image (OMI) that you are allowed to use, and then to automatically launch them.
+ The VMs remain in the `pending` state until they are created and ready to be used. Once automatically launched, they are in the `running` state.
+ To check the state of your VMs, call the [ReadVms](#readvms) method.
+ If not specified, the security group used by the service is the default one.
+ The metadata server enables you to get the public key provided when the VM is launched. Official OMIs contain a script to get this public key and put it inside the VM to provide secure access without password.

+ For more information, see [About VMs](https://docs.outscale.com/en/userguide/About-VMs.html). operationId: CreateVms requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateVmsRequest" examples: ex1: summary: Creating a VM (minimal syntax) @@ -15468,317 +15571,315 @@ paths: summary: Creating a VM in a Net value: ImageId: ami-12345678 + VmType: tinav5.c1r1p2 KeypairName: keypair-example SecurityGroupIds: - sg-12345678 SubnetId: subnet-12345678 UserData: "..." - VmType: tinav5.c1r1p2 ex3: summary: Creating a VM with block device mappings value: - BlockDeviceMappings: - - Bsu: - VolumeSize: 15 - VolumeType: gp2 - DeviceName: "/dev/sda1" - - Bsu: - Iops: 150 - SnapshotId: snap-12345678 - VolumeSize: 22 - VolumeType: io1 - DeviceName: "/dev/sdb" ImageId: ami-12345678 + VmType: tinav5.c1r1p2 KeypairName: keypair-example SecurityGroupIds: - sg-12345678 SubnetId: subnet-12345678 UserData: "..." - VmType: tinav5.c1r1p2 + BlockDeviceMappings: + - DeviceName: "/dev/sda1" + Bsu: + VolumeSize: 15 + VolumeType: gp2 + - DeviceName: "/dev/sdb" + Bsu: + SnapshotId: snap-12345678 + VolumeSize: 22 + VolumeType: io1 + Iops: 150 ex4: summary: Creating a VM with a NIC value: ImageId: ami-12345678 + VmType: tinav5.c1r1p2 KeypairName: keypair-example + UserData: "..." Nics: - DeviceNumber: 0 NicId: eni-12345678 - UserData: "..." - VmType: tinav5.c1r1p2 - schema: - "$ref": "#/components/schemas/CreateVmsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateVmsResponse" examples: ex1: summary: Creating a VM (minimal syntax) value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Vms: - - ActionsOnNextBoot: - SecureBoot: none + - VmType: t2.small + VmInitiatedShutdownBehavior: stop + State: pending + StateReason: '' + RootDeviceType: ebs + RootDeviceName: "/dev/sda1" + IsSourceDestChecked: true + ImageId: ami-12345678 + DeletionProtection: false + BootMode: legacy Architecture: x86_64 + NestedVirtualization: false BlockDeviceMappings: - - Bsu: - DeleteOnVmDeletion: true - LinkDate: '2010-10-01T12:34:56.789Z' - State: attaching + - DeviceName: "/dev/sda1" + Bsu: VolumeId: vol-12345678 - DeviceName: "/dev/sda1" - BootMode: legacy - BsuOptimized: false - CreationDate: '2010-10-01T12:34:56.789Z' - DeletionProtection: false + State: attaching + LinkDate: '2010-10-01T12:34:56.789Z' + DeleteOnVmDeletion: true + VmId: i-12345678 + ReservationId: r-12345678 Hypervisor: xen - ImageId: ami-12345678 - IsSourceDestChecked: true - LaunchNumber: 0 - NestedVirtualization: false - Performance: medium Placement: - SubregionName: eu-west-2a Tenancy: default - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal - PrivateIp: 10.0.0.4 + SubregionName: eu-west-2a ProductCodes: - '0001' - ReservationId: r-12345678 - RootDeviceName: "/dev/sda1" - RootDeviceType: ebs + CreationDate: '2010-10-01T12:34:56.789Z' + UserData: "..." + PrivateIp: 10.0.0.4 SecurityGroups: - - SecurityGroupId: sg-12345678 - SecurityGroupName: default - State: pending - StateReason: '' + - SecurityGroupName: default + SecurityGroupId: sg-12345678 + BsuOptimized: false + LaunchNumber: 0 + Performance: medium Tags: [] - UserData: "..." - VmId: i-12345678 - VmInitiatedShutdownBehavior: stop - VmType: t2.small + ActionsOnNextBoot: + SecureBoot: none + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Creating a VM in a Net value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Vms: - - ActionsOnNextBoot: - SecureBoot: none + - VmType: tinav5.c1r1p2 + VmInitiatedShutdownBehavior: stop + State: pending + StateReason: '' + RootDeviceType: ebs + RootDeviceName: "/dev/sda1" + IsSourceDestChecked: true + KeypairName: keypair-example + ImageId: ami-12345678 + DeletionProtection: false + BootMode: legacy Architecture: x86_64 + NestedVirtualization: false BlockDeviceMappings: - - Bsu: - DeleteOnVmDeletion: true - LinkDate: '2010-10-01T12:34:56.789Z' - State: attaching + - DeviceName: "/dev/sda1" + Bsu: VolumeId: vol-12345678 - DeviceName: "/dev/sda1" - BootMode: legacy - BsuOptimized: false - CreationDate: '2010-10-01T12:34:56.789Z' - DeletionProtection: false + State: attaching + LinkDate: '2010-10-01T12:34:56.789Z' + DeleteOnVmDeletion: true + VmId: i-12345678 + ReservationId: r-12345678 Hypervisor: xen - ImageId: ami-12345678 - IsSourceDestChecked: true - KeypairName: keypair-example + Placement: + Tenancy: default + SubregionName: eu-west-2a + ProductCodes: + - '0001' + CreationDate: '2010-10-01T12:34:56.789Z' + UserData: "..." + SubnetId: subnet-12345678 + PrivateIp: 10.0.0.4 + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 + BsuOptimized: false LaunchNumber: 0 - NestedVirtualization: false NetId: vpc-12345678 Nics: - - AccountId: '123456789012' - Description: Primary network interface - IsSourceDestChecked: true + - SubnetId: subnet-12345678 + State: in-use LinkNic: - DeleteOnVmDeletion: true + State: attached DeviceNumber: 0 LinkNicId: eni-attach-12345678 - State: attached + DeleteOnVmDeletion: true + IsSourceDestChecked: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + Description: Primary network interface + AccountId: '123456789012' + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - IsPrimary: true - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - SecurityGroups: - - SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - State: in-use - SubnetId: subnet-12345678 + IsPrimary: true Performance: high - Placement: - SubregionName: eu-west-2a - Tenancy: default + Tags: [] + ActionsOnNextBoot: + SecureBoot: none PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal - PrivateIp: 10.0.0.4 - ProductCodes: - - '0001' - ReservationId: r-12345678 - RootDeviceName: "/dev/sda1" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex3: + summary: Creating a VM with block device mappings + value: + Vms: + - VmType: tinav5.c1r1p2 + VmInitiatedShutdownBehavior: stop + State: pending + StateReason: '' RootDeviceType: ebs - SecurityGroups: - - SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - State: pending - StateReason: '' - SubnetId: subnet-12345678 - Tags: [] - UserData: "..." - VmId: i-12345678 - VmInitiatedShutdownBehavior: stop - VmType: tinav5.c1r1p2 - ex3: - summary: Creating a VM with block device mappings - value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - Vms: - - ActionsOnNextBoot: - SecureBoot: none + RootDeviceName: "/dev/sda1" + IsSourceDestChecked: true + KeypairName: keypair-example + ImageId: ami-12345678 + DeletionProtection: false + BootMode: legacy Architecture: x86_64 + NestedVirtualization: false BlockDeviceMappings: - - Bsu: - DeleteOnVmDeletion: true - LinkDate: '2010-10-01T12:34:56.789Z' - State: attaching + - DeviceName: "/dev/sda1" + Bsu: VolumeId: vol-12345678 - DeviceName: "/dev/sda1" - - Bsu: - DeleteOnVmDeletion: true - LinkDate: '2010-10-01T12:34:56.789Z' State: attaching + LinkDate: '2010-10-01T12:34:56.789Z' + DeleteOnVmDeletion: true + - DeviceName: "/dev/sda1" + Bsu: VolumeId: vol-87654321 - DeviceName: "/dev/sda1" - BootMode: legacy - BsuOptimized: false - CreationDate: '2010-10-01T12:34:56.789Z' - DeletionProtection: false + State: attaching + LinkDate: '2010-10-01T12:34:56.789Z' + DeleteOnVmDeletion: true + VmId: i-12345678 + ReservationId: r-12345678 Hypervisor: xen - ImageId: ami-12345678 - IsSourceDestChecked: true - KeypairName: keypair-example + Placement: + Tenancy: default + SubregionName: eu-west-2a + ProductCodes: + - '0001' + CreationDate: '2010-10-01T12:34:56.789Z' + UserData: "..." + SubnetId: subnet-12345678 + PrivateIp: 10.0.0.4 + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 + BsuOptimized: false LaunchNumber: 0 - NestedVirtualization: false NetId: vpc-12345678 Nics: - - AccountId: '123456789012' - Description: Primary network interface - IsSourceDestChecked: true + - SubnetId: subnet-12345678 + State: in-use LinkNic: - DeleteOnVmDeletion: true + State: attached DeviceNumber: 0 LinkNicId: eni-attach-12345678 - State: attached + DeleteOnVmDeletion: true + IsSourceDestChecked: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + Description: Primary network interface + AccountId: '123456789012' + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - IsPrimary: true - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - SecurityGroups: - - SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - State: in-use - SubnetId: subnet-12345678 + IsPrimary: true Performance: high - Placement: - SubregionName: eu-west-2a - Tenancy: default - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal - PrivateIp: 10.0.0.4 - ProductCodes: - - '0001' - ReservationId: r-12345678 - RootDeviceName: "/dev/sda1" - RootDeviceType: ebs - SecurityGroups: - - SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - State: pending - StateReason: '' - SubnetId: subnet-12345678 Tags: [] - UserData: "..." - VmId: i-12345678 - VmInitiatedShutdownBehavior: stop - VmType: tinav5.c1r1p2 + ActionsOnNextBoot: + SecureBoot: none + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex4: summary: Creating a VM with a NIC value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Vms: - - ActionsOnNextBoot: - SecureBoot: none + - VmType: tinav5.c1r1p2 + VmInitiatedShutdownBehavior: stop + State: pending + StateReason: '' + RootDeviceType: ebs + RootDeviceName: "/dev/sda1" + IsSourceDestChecked: true + KeypairName: keypair-example + ImageId: ami-12345678 + DeletionProtection: false + BootMode: legacy Architecture: x86_64 + NestedVirtualization: false BlockDeviceMappings: - - Bsu: - DeleteOnVmDeletion: true - LinkDate: '2010-10-01T12:34:56.789Z' - State: attaching + - DeviceName: "/dev/sda1" + Bsu: VolumeId: vol-12345678 - DeviceName: "/dev/sda1" - BootMode: legacy - BsuOptimized: false - CreationDate: '2010-10-01T12:34:56.789Z' - DeletionProtection: false + State: attaching + LinkDate: '2010-10-01T12:34:56.789Z' + DeleteOnVmDeletion: true + VmId: i-12345678 + ReservationId: r-12345678 Hypervisor: xen - ImageId: ami-12345678 - IsSourceDestChecked: true - KeypairName: keypair-example + Placement: + Tenancy: default + SubregionName: eu-west-2a + ProductCodes: + - '0001' + CreationDate: '2010-10-01T12:34:56.789Z' + UserData: "..." + SubnetId: subnet-12345678 + PrivateIp: 10.0.0.4 + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 + BsuOptimized: false LaunchNumber: 0 - NestedVirtualization: false NetId: vpc-12345678 Nics: - - AccountId: '123456789012' - Description: Example NIC - IsSourceDestChecked: true + - SubnetId: subnet-12345678 + State: in-use LinkNic: - DeleteOnVmDeletion: true + State: attached DeviceNumber: 0 LinkNicId: eni-attach-12345678 - State: attached + DeleteOnVmDeletion: true + IsSourceDestChecked: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + Description: Example NIC + AccountId: '123456789012' + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - IsPrimary: true - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - SecurityGroups: - - SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - State: in-use - SubnetId: subnet-12345678 + IsPrimary: true Performance: high - Placement: - SubregionName: eu-west-2a - Tenancy: default - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal - PrivateIp: 10.0.0.4 - ProductCodes: - - '0001' - ReservationId: r-12345678 - RootDeviceName: "/dev/sda1" - RootDeviceType: ebs - SecurityGroups: - - SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - State: pending - StateReason: '' - SubnetId: subnet-12345678 Tags: [] - UserData: "..." - VmId: i-12345678 - VmInitiatedShutdownBehavior: stop - VmType: tinav5.c1r1p2 - schema: - "$ref": "#/components/schemas/CreateVmsResponse" + ActionsOnNextBoot: + SecureBoot: none + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -15801,71 +15902,71 @@ paths: tags: - Vm "/CreateVolume": - description: |- - Creates a Block Storage Unit (BSU) volume in a specified Region.
- BSU volumes can be attached to a virtual machine (VM) in the same Subregion. You can create an empty volume or restore a volume from an existing snapshot.
- You can create the following volume types: Enterprise (`io1`) for provisioned IOPS SSD volumes, Performance (`gp2`) for general purpose SSD volumes, or Magnetic (`standard`) volumes.

- For more information, see [About Volumes](https://docs.outscale.com/en/userguide/About-Volumes.html). post: + description: |- + Creates a Block Storage Unit (BSU) volume in a specified Region.
+ BSU volumes can be attached to a virtual machine (VM) in the same Subregion. You can create an empty volume or restore a volume from an existing snapshot.
+ You can create the following volume types: Enterprise (`io1`) for provisioned IOPS SSD volumes, Performance (`gp2`) for general purpose SSD volumes, or Magnetic (`standard`) volumes.

+ For more information, see [About Volumes](https://docs.outscale.com/en/userguide/About-Volumes.html). operationId: CreateVolume requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateVolumeRequest" examples: ex1: summary: Creating an io1 volume value: - Iops: 100 - Size: 10 - SubregionName: eu-west-2a VolumeType: io1 + SubregionName: eu-west-2a + Size: 10 + Iops: 100 ex2: summary: Creating a volume from a snapshot value: - Size: 10 SnapshotId: snap-12345678 - SubregionName: eu-west-2a VolumeType: gp2 - schema: - "$ref": "#/components/schemas/CreateVolumeRequest" + SubregionName: eu-west-2a + Size: 10 responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateVolumeResponse" examples: ex1: summary: Creating an io1 volume value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Volume: + VolumeId: vol-12345678 + Tags: [] + VolumeType: io1 + SubregionName: eu-west-2a + State: creating CreationDate: '2010-10-01T12:34:56.789Z' Iops: 100 LinkedVolumes: [] Size: 10 - State: creating - SubregionName: eu-west-2a - Tags: [] - VolumeId: vol-12345678 - VolumeType: io1 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Creating a volume from a snapshot value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Volume: + VolumeId: vol-12345678 + Tags: [] + VolumeType: gp2 + SubregionName: eu-west-2a + State: creating + SnapshotId: snap-12345678 CreationDate: '2010-10-01T12:34:56.789Z' Iops: 100 LinkedVolumes: [] Size: 10 - SnapshotId: snap-12345678 - State: creating - SubregionName: eu-west-2a - Tags: [] - VolumeId: vol-12345678 - VolumeType: gp2 - schema: - "$ref": "#/components/schemas/CreateVolumeResponse" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -15888,96 +15989,98 @@ paths: tags: - Volume "/CreateVpnConnection": - description: |- - Creates a VPN connection between a specified virtual gateway and a specified client gateway.
- You can create only one VPN connection between a virtual gateway and a client gateway.

- - **[IMPORTANT]**
- This action can be done only if the virtual gateway is in the `available` state.

- For more information, see [About VPN Connections](https://docs.outscale.com/en/userguide/About-VPN-Connections.html). post: + description: |- + Creates a VPN connection between a specified virtual gateway and a specified client gateway.
+ You can create only one VPN connection between a virtual gateway and a client gateway.

+ + **[IMPORTANT]**
+ This action can be done only if the virtual gateway is in the `available` state.

+ For more information, see [About VPN Connections](https://docs.outscale.com/en/userguide/About-VPN-Connections.html). operationId: CreateVpnConnection requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateVpnConnectionRequest" examples: ex1: value: ClientGatewayId: cgw-12345678 + VirtualGatewayId: vgw-12345678 ConnectionType: ipsec.1 StaticRoutesOnly: true - VirtualGatewayId: vgw-12345678 - schema: - "$ref": "#/components/schemas/CreateVpnConnectionRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateVpnConnectionResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VpnConnection: + Routes: [] + Tags: [] ClientGatewayConfiguration: "..." - ClientGatewayId: cgw-12345678 + StaticRoutesOnly: true + VirtualGatewayId: vgw-12345678 ConnectionType: ipsec.1 - Routes: [] + ClientGatewayId: cgw-12345678 State: pending - StaticRoutesOnly: true - Tags: [] VgwTelemetries: - - AcceptedRouteCount: 0 + - StateDescription: IPSEC IS DOWN + AcceptedRouteCount: 0 LastStateChangeDate: '2017-05-10T12:34:56.789Z' OutsideIpAddress: 192.0.2.0 - StateDescription: IPSEC IS DOWN - VirtualGatewayId: vgw-12345678 VpnConnectionId: vpn-12345678 - schema: - "$ref": "#/components/schemas/CreateVpnConnectionResponse" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - VpnConnection "/CreateVpnConnectionRoute": - description: |- - Creates a static route to a VPN connection.
- This enables you to select the network flows sent by the virtual gateway to the target VPN connection.

- For more information, see [About Routing Configuration for VPN Connections](https://docs.outscale.com/en/userguide/About-Routing-Configuration-for-VPN-Connections.html). post: + description: |- + Creates a static route to a VPN connection.
+ This enables you to select the network flows sent by the virtual gateway to the target VPN connection.

+ For more information, see [About Routing Configuration for VPN Connections](https://docs.outscale.com/en/userguide/About-Routing-Configuration-for-VPN-Connections.html). operationId: CreateVpnConnectionRoute requestBody: content: application/json: - examples: + schema: + "$ref": "#/components/schemas/CreateVpnConnectionRouteRequest" + examples: ex1: value: - DestinationIpRange: 10.0.0.0/16 VpnConnectionId: vpn-12345678 - schema: - "$ref": "#/components/schemas/CreateVpnConnectionRouteRequest" + DestinationIpRange: 10.0.0.0/16 responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateVpnConnectionRouteResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateVpnConnectionRouteResponse" description: The HTTP 200 response (OK). tags: - VpnConnection "/DeleteAccessKey": - description: |- - Deletes the specified access key of either your root account or an EIM user.

- The access key of an EIM user must be in the `INACTIVE` state to be deleted. post: + description: |- + Deletes the specified access key of either your root account or an EIM user.

+ The access key of an EIM user must be in the `INACTIVE` state to be deleted. operationId: DeleteAccessKey requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteAccessKeyRequest" examples: ex1: summary: Deleting one of your own access keys (if you are the root @@ -15989,19 +16092,17 @@ paths: value: AccessKeyId: ABCDEFGHIJ0123456789 UserName: example-user - schema: - "$ref": "#/components/schemas/DeleteAccessKeyRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteAccessKeyResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteAccessKeyResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -16009,33 +16110,33 @@ paths: tags: - AccessKey "/DeleteApiAccessRule": - description: |- - Deletes a specified API access rule.

- - **[IMPORTANT]**
- You cannot delete the last remaining API access rule. However, if you delete all the API access rules that allow you to access the APIs, you need to contact the Support team to regain access. For more information, see [Technical Support](https://docs.outscale.com/en/userguide/Technical-Support.html). post: + description: |- + Deletes a specified API access rule.

+ + **[IMPORTANT]**
+ You cannot delete the last remaining API access rule. However, if you delete all the API access rules that allow you to access the APIs, you need to contact the Support team to regain access. For more information, see [Technical Support](https://docs.outscale.com/en/userguide/Technical-Support.html). operationId: DeleteApiAccessRule requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteApiAccessRuleRequest" examples: ex1: value: ApiAccessRuleId: aar-1234567890abcdef1234567890abcdef - schema: - "$ref": "#/components/schemas/DeleteApiAccessRuleRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteApiAccessRuleResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteApiAccessRuleResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -16043,29 +16144,29 @@ paths: tags: - ApiAccessRule "/DeleteCa": - description: Deletes a specified Client Certificate Authority (CA). post: + description: Deletes a specified Client Certificate Authority (CA). operationId: DeleteCa requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteCaRequest" examples: ex1: value: CaId: ca-fedcba0987654321fedcba0987654321 - schema: - "$ref": "#/components/schemas/DeleteCaRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteCaResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteCaResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -16073,51 +16174,53 @@ paths: tags: - Ca "/DeleteClientGateway": - description: |- - Deletes a client gateway.
- You must delete the VPN connection before deleting the client gateway. post: + description: |- + Deletes a client gateway.
+ You must delete the VPN connection before deleting the client gateway. operationId: DeleteClientGateway requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteClientGatewayRequest" examples: ex1: value: ClientGatewayId: cgw-12345678 - schema: - "$ref": "#/components/schemas/DeleteClientGatewayRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteClientGatewayResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteClientGatewayResponse" description: The HTTP 200 response (OK). tags: - ClientGateway "/DeleteDedicatedGroup": - description: |- - > [WARNING]
- > This feature is currently in beta.
+ post: + description: |- + > [WARNING]
+ > This feature is currently in beta.
- Deletes a specified dedicated group of virtual machines (VMs).
+ Deletes a specified dedicated group of virtual machines (VMs).
- **[WARNING]**
- A dedicated group can be deleted only if no VM or Net is in the dedicated group. Otherwise, you need to force the deletion.
- If you force the deletion:
- - all VMs are terminated.
- - all Nets are deleted, and all resources associated with Nets are detached. - post: + **[WARNING]**
+ A dedicated group can be deleted only if no VM or Net is in the dedicated group. Otherwise, you need to force the deletion.
+ If you force the deletion:
+ - all VMs are terminated.
+ - all Nets are deleted, and all resources associated with Nets are detached. operationId: DeleteDedicatedGroup requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteDedicatedGroupRequest" examples: ex1: summary: Deleting a dedicated group without any resource in it. @@ -16129,19 +16232,17 @@ paths: value: DedicatedGroupId: ded-12345678 Force: true - schema: - "$ref": "#/components/schemas/DeleteDedicatedGroupRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteDedicatedGroupResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteDedicatedGroupResponse" description: The HTTP 200 response (OK). '400': content: @@ -16164,102 +16265,104 @@ paths: tags: - DedicatedGroup "/DeleteDhcpOptions": - description: |- - Deletes a specified DHCP options set.
- Before deleting a DHCP options set, you must disassociate it from the Nets you associated it with. To do so, you need to associate with each Net a new set of DHCP options, or the `default` one if you do not want to associate any DHCP options with the Net.

- - **[IMPORTANT]**
- You cannot delete the `default` set. post: + description: |- + Deletes a specified DHCP options set.
+ Before deleting a DHCP options set, you must disassociate it from the Nets you associated it with. To do so, you need to associate with each Net a new set of DHCP options, or the `default` one if you do not want to associate any DHCP options with the Net.

+ + **[IMPORTANT]**
+ You cannot delete the `default` set. operationId: DeleteDhcpOptions requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteDhcpOptionsRequest" examples: ex1: value: DhcpOptionsSetId: dopt-12345678 - schema: - "$ref": "#/components/schemas/DeleteDhcpOptionsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteDhcpOptionsResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteDhcpOptionsResponse" description: The HTTP 200 response (OK). tags: - DhcpOption "/DeleteDirectLink": - description: |- - Deletes a specified DirectLink.
- Before deleting a DirectLink, ensure that all your DirectLink interfaces related to this DirectLink are deleted. post: + description: |- + Deletes a specified DirectLink.
+ Before deleting a DirectLink, ensure that all your DirectLink interfaces related to this DirectLink are deleted. operationId: DeleteDirectLink requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteDirectLinkRequest" examples: ex1: value: DirectLinkId: dxcon-12345678 - schema: - "$ref": "#/components/schemas/DeleteDirectLinkRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteDirectLinkResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteDirectLinkResponse" description: The HTTP 200 response (OK). tags: - DirectLink "/DeleteDirectLinkInterface": - description: Deletes a specified DirectLink interface. post: + description: Deletes a specified DirectLink interface. operationId: DeleteDirectLinkInterface requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteDirectLinkInterfaceRequest" examples: ex1: value: DirectLinkInterfaceId: dxvif-12345678 - schema: - "$ref": "#/components/schemas/DeleteDirectLinkInterfaceRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteDirectLinkInterfaceResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteDirectLinkInterfaceResponse" description: The HTTP 200 response (OK). tags: - DirectLinkInterface "/DeleteExportTask": - description: |- - Deletes an export task.
- If the export task is not running, the command fails and an error is returned. post: + description: |- + Deletes an export task.
+ If the export task is not in the `active` or `pending` state, the command fails and an error is returned. operationId: DeleteExportTask requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteExportTaskRequest" examples: ex1: summary: Deleting an image export task @@ -16269,12 +16372,12 @@ paths: summary: Deleting a snapshot export task value: ExportTaskId: snap-export-12345678 - schema: - "$ref": "#/components/schemas/DeleteExportTaskRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteExportTaskResponse" examples: ex1: summary: Deleting an image export task @@ -16286,66 +16389,64 @@ paths: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteExportTaskResponse" description: The HTTP 200 response (OK). tags: - Task "/DeleteFlexibleGpu": - description: |- - Releases a flexible GPU (fGPU) from your account.
- The fGPU becomes free to be used by someone else. post: + description: |- + Releases a flexible GPU (fGPU) from your account.
+ The fGPU becomes free to be used by someone else. operationId: DeleteFlexibleGpu requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteFlexibleGpuRequest" examples: ex1: value: FlexibleGpuId: fgpu-12345678 - schema: - "$ref": "#/components/schemas/DeleteFlexibleGpuRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteFlexibleGpuResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteFlexibleGpuResponse" description: The HTTP 200 response (OK). tags: - FlexibleGpu "/DeleteImage": - description: Deletes an OUTSCALE machine image (OMI) so that you cannot use it - anymore to launch virtual machines (VMs). However, you can still use VMs already - launched from this OMI. post: + description: Deletes an OUTSCALE machine image (OMI) so that you cannot use + it anymore to launch virtual machines (VMs). However, you can still use VMs + already launched from this OMI. operationId: DeleteImage requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteImageRequest" examples: ex1: value: ImageId: ami-12345678 - schema: - "$ref": "#/components/schemas/DeleteImageRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteImageResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteImageResponse" description: The HTTP 200 response (OK). '400': content: @@ -16368,31 +16469,31 @@ paths: tags: - Image "/DeleteInternetService": - description: |- - Deletes an internet service.
- Before deleting an internet service, you must detach it from any Net it is attached to. post: + description: |- + Deletes an internet service.
+ Before deleting an internet service, you must detach it from any Net it is attached to. operationId: DeleteInternetService requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteInternetServiceRequest" examples: ex1: value: InternetServiceId: igw-12345678 - schema: - "$ref": "#/components/schemas/DeleteInternetServiceRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteInternetServiceResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteInternetServiceResponse" description: The HTTP 200 response (OK). '400': content: @@ -16415,14 +16516,16 @@ paths: tags: - InternetService "/DeleteKeypair": - description: |- - Deletes the specified keypair.
- This action deletes the public key stored by 3DS OUTSCALE, thus deleting the keypair. post: + description: |- + Deletes the specified keypair.
+ This action deletes the public key stored by 3DS OUTSCALE, thus deleting the keypair. operationId: DeleteKeypair requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteKeypairRequest" examples: ex1: summary: Deleting a keypair with its name @@ -16432,19 +16535,17 @@ paths: summary: Deleting a keypair with its ID value: KeypairId: key-abcdef1234567890abcdef1234567890 - schema: - "$ref": "#/components/schemas/DeleteKeypairRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteKeypairResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteKeypairResponse" description: The HTTP 200 response (OK). '400': content: @@ -16467,192 +16568,194 @@ paths: tags: - Keypair "/DeleteListenerRule": - description: |- - Deletes a listener rule.
- The previously active rule is disabled after deletion. post: + description: |- + Deletes a listener rule.
+ The previously active rule is disabled after deletion. operationId: DeleteListenerRule requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteListenerRuleRequest" examples: ex1: value: ListenerRuleName: example-listener-rule - schema: - "$ref": "#/components/schemas/DeleteListenerRuleRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteListenerRuleResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteListenerRuleResponse" description: The HTTP 200 response (OK). tags: - Listener "/DeleteLoadBalancer": - description: Deletes a specified load balancer. post: + description: Deletes a specified load balancer. operationId: DeleteLoadBalancer requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteLoadBalancerRequest" examples: ex1: value: LoadBalancerName: example-lbu - schema: - "$ref": "#/components/schemas/DeleteLoadBalancerRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteLoadBalancerResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteLoadBalancerResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer "/DeleteLoadBalancerListeners": - description: Deletes listeners of a specified load balancer. post: + description: Deletes listeners of a specified load balancer. operationId: DeleteLoadBalancerListeners requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteLoadBalancerListenersRequest" examples: ex1: value: LoadBalancerName: example-lbu LoadBalancerPorts: - 80 - schema: - "$ref": "#/components/schemas/DeleteLoadBalancerListenersRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteLoadBalancerListenersResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 LoadBalancer: + Tags: [] + SourceSecurityGroup: + SecurityGroupName: security-group-example + SecurityGroupAccountId: '123456789012' + SecuredCookies: false + Subnets: + - subnet-12345678 + NetId: vpc-12345678 + BackendVmIds: [] + ApplicationStickyCookiePolicies: [] + SecurityGroups: + - sg-12345678 + LoadBalancerType: internal AccessLog: - IsEnabled: false PublicationInterval: 60 - ApplicationStickyCookiePolicies: [] - BackendVmIds: [] + IsEnabled: false DnsName: internal-example-lbu.123456789.eu-west-2.lbu.outscale.com HealthCheck: + UnhealthyThreshold: 2 + Timeout: 5 CheckInterval: 30 + Protocol: TCP HealthyThreshold: 10 Port: 80 - Protocol: TCP - Timeout: 5 - UnhealthyThreshold: 2 - Listeners: [] - LoadBalancerName: example-lbu LoadBalancerStickyCookiePolicies: [] - LoadBalancerType: internal - NetId: vpc-12345678 - SecuredCookies: false - SecurityGroups: - - sg-12345678 - SourceSecurityGroup: - SecurityGroupAccountId: '123456789012' - SecurityGroupName: security-group-example - Subnets: - - subnet-12345678 SubregionNames: - eu-west-2a - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteLoadBalancerListenersResponse" + Listeners: [] + LoadBalancerName: example-lbu description: The HTTP 200 response (OK). tags: - Listener "/DeleteLoadBalancerPolicy": - description: |- - Deletes a specified policy from a load balancer.
- In order to be deleted, the policy must not be enabled for any listener. post: + description: |- + Deletes a specified policy from a load balancer.
+ In order to be deleted, the policy must not be enabled for any listener. operationId: DeleteLoadBalancerPolicy requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteLoadBalancerPolicyRequest" examples: ex1: value: LoadBalancerName: example-lbu PolicyName: example-browser-policy - schema: - "$ref": "#/components/schemas/DeleteLoadBalancerPolicyRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteLoadBalancerPolicyResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 LoadBalancer: + Tags: [] + SourceSecurityGroup: + SecurityGroupName: default + SecurityGroupAccountId: '123456789012' + SecuredCookies: false + PublicIp: 192.0.2.0 + Subnets: + - subnet-12345678 + NetId: vpc-12345678 + BackendVmIds: [] + ApplicationStickyCookiePolicies: [] + SecurityGroups: + - sg-12345678 + LoadBalancerType: internet-facing AccessLog: - IsEnabled: false PublicationInterval: 60 - ApplicationStickyCookiePolicies: [] - BackendVmIds: [] + IsEnabled: false DnsName: example-lbu-123456789.eu-west-2.lbu.outscale.com HealthCheck: + UnhealthyThreshold: 2 + Timeout: 5 CheckInterval: 30 + Protocol: TCP HealthyThreshold: 10 Port: 80 - Protocol: TCP - Timeout: 5 - UnhealthyThreshold: 2 + LoadBalancerStickyCookiePolicies: [] + SubregionNames: + - eu-west-2a Listeners: - BackendPort: 80 BackendProtocol: HTTP LoadBalancerPort: 80 LoadBalancerProtocol: HTTP LoadBalancerName: example-lbu - LoadBalancerStickyCookiePolicies: [] - LoadBalancerType: internet-facing - NetId: vpc-12345678 - PublicIp: 192.0.2.0 - SecuredCookies: false - SecurityGroups: - - sg-12345678 - SourceSecurityGroup: - SecurityGroupAccountId: '123456789012' - SecurityGroupName: default - Subnets: - - subnet-12345678 - SubregionNames: - - eu-west-2a - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteLoadBalancerPolicyResponse" description: The HTTP 200 response (OK). tags: - LoadBalancerPolicy "/DeleteLoadBalancerTags": - description: Deletes one or more tags from the specified load balancers. post: + description: Deletes one or more tags from the specified load balancers. operationId: DeleteLoadBalancerTags requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteLoadBalancerTagsRequest" examples: ex1: value: @@ -16660,48 +16763,46 @@ paths: - example-lbu Tags: - Key: key1 - schema: - "$ref": "#/components/schemas/DeleteLoadBalancerTagsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteLoadBalancerTagsResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteLoadBalancerTagsResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer "/DeleteNatService": - description: |- - Deletes a specified network address translation (NAT) service.
- This action disassociates the public IP from the NAT service, but does not release this public IP from your account. However, it does not delete any NAT service routes in your route tables. post: + description: |- + Deletes a specified network address translation (NAT) service.
+ This action disassociates the public IP from the NAT service, but does not release this public IP from your account. However, it does not delete any NAT service routes in your route tables. operationId: DeleteNatService requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteNatServiceRequest" examples: ex1: value: NatServiceId: nat-12345678 - schema: - "$ref": "#/components/schemas/DeleteNatServiceRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteNatServiceResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteNatServiceResponse" description: The HTTP 200 response (OK). '400': content: @@ -16724,41 +16825,41 @@ paths: tags: - NatService "/DeleteNet": - description: |- - Deletes a specified Net.
- Before deleting the Net, you need to delete or detach all the resources associated with the Net:

- - * Virtual machines (VMs)
- * Net peerings
- * Custom route tables
- * Public IPs allocated to resources in the Net
- * Network Interface Cards (NICs) created in the Subnets
- * Virtual gateways, internet services and NAT services
- * Load balancers
- * Security groups
- * Subnets post: + description: |- + Deletes a specified Net.
+ Before deleting the Net, you need to delete or detach all the resources associated with the Net:

+ + * Virtual machines (VMs)
+ * Net peerings
+ * Custom route tables
+ * Public IPs allocated to resources in the Net
+ * Network Interface Cards (NICs) created in the Subnets
+ * Virtual gateways, internet services and NAT services
+ * Load balancers
+ * Security groups
+ * Subnets operationId: DeleteNet requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteNetRequest" examples: ex1: value: NetId: vpc-12345678 - schema: - "$ref": "#/components/schemas/DeleteNetRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteNetResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteNetResponse" description: The HTTP 200 response (OK). '400': content: @@ -16781,62 +16882,62 @@ paths: tags: - Net "/DeleteNetAccessPoint": - description: |- - Deletes a specified Net access point.
- This action also deletes the corresponding routes added to the route tables you specified for the Net access point. post: + description: |- + Deletes a specified Net access point.
+ This action also deletes the corresponding routes added to the route tables you specified for the Net access point. operationId: DeleteNetAccessPoint requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteNetAccessPointRequest" examples: ex1: value: NetAccessPointId: vpce-12345678 - schema: - "$ref": "#/components/schemas/DeleteNetAccessPointRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteNetAccessPointResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteNetAccessPointResponse" description: The HTTP 200 response (OK). tags: - NetAccessPoint "/DeleteNetPeering": - description: |- - Deletes a Net peering.
- If the Net peering is in the `active` state, it can be deleted either by the owner of the requester Net or the owner of the peer Net.
- If it is in the `pending-acceptance` state, it can be deleted only by the owner of the requester Net.
- If it is in the `rejected`, `failed`, or `expired` states, it cannot be deleted. post: + description: |- + Deletes a Net peering.
+ If the Net peering is in the `active` state, it can be deleted either by the owner of the requester Net or the owner of the peer Net.
+ If it is in the `pending-acceptance` state, it can be deleted only by the owner of the requester Net.
+ If it is in the `rejected`, `failed`, or `expired` states, it cannot be deleted. operationId: DeleteNetPeering requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteNetPeeringRequest" examples: ex1: value: NetPeeringId: pcx-12345678 - schema: - "$ref": "#/components/schemas/DeleteNetPeeringRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteNetPeeringResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteNetPeeringResponse" description: The HTTP 200 response (OK). '400': content: @@ -16865,31 +16966,31 @@ paths: tags: - NetPeering "/DeleteNic": - description: |- - Deletes the specified network interface card (NIC).
- The network interface must not be attached to any virtual machine (VM). post: + description: |- + Deletes the specified network interface card (NIC).
+ The network interface must not be attached to any virtual machine (VM). operationId: DeleteNic requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteNicRequest" examples: ex1: value: NicId: eni-12345678 - schema: - "$ref": "#/components/schemas/DeleteNicRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteNicResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteNicResponse" description: The HTTP 200 response (OK). '400': content: @@ -16912,92 +17013,92 @@ paths: tags: - Nic "/DeletePolicy": - description: |- - Deletes a managed policy.
- Before deleting a managed policy, you must unlink all users linked to it and delete all the versions of the policy, except the default one, using the `DeletePolicyVersion` method. post: + description: |- + Deletes a managed policy.
+ Before deleting a managed policy, you must unlink all users linked to it and delete all the versions of the policy, except the default one, using the `DeletePolicyVersion` method. operationId: DeletePolicy requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeletePolicyRequest" examples: ex1: value: PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy - schema: - "$ref": "#/components/schemas/DeletePolicyRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeletePolicyResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeletePolicyResponse" description: The HTTP 200 response (OK). tags: - Policy "/DeletePolicyVersion": - description: Deletes a specified version of a managed policy, if it is not set - as the default one. post: + description: Deletes a specified version of a managed policy, if it is not set + as the default one. operationId: DeletePolicyVersion requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeletePolicyVersionRequest" examples: ex1: value: PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy VersionId: v1 - schema: - "$ref": "#/components/schemas/DeletePolicyVersionRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeletePolicyVersionResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeletePolicyVersionResponse" description: The HTTP 200 response (OK). tags: - Policy "/DeleteProductType": - description: |- - Deletes a specified product type that belongs to you.
- - **[WARNING]**
- The product type must not be associated with one or more OMIs to be deleted. Otherwise, you need to force the deletion.
- If you force the deletion, the product type is deleted and remains associated with the OMIs.
post: + description: |- + Deletes a specified product type that belongs to you.
+ + **[WARNING]**
+ The product type must not be associated with one or more OMIs to be deleted. Otherwise, you need to force the deletion.
+ If you force the deletion, the product type is deleted and remains associated with the OMIs.
operationId: DeleteProductType requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteProductTypeRequest" examples: ex1: value: ProductTypeId: pty-12345678 - schema: - "$ref": "#/components/schemas/DeleteProductTypeRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteProductTypeResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteProductTypeResponse" description: The HTTP 200 response (OK). '400': content: @@ -17020,31 +17121,31 @@ paths: tags: - ProductType "/DeletePublicIp": - description: |- - Releases a public IP.
- You can release a public IP associated with your account. This address is released in the public IP pool and can be used by someone else. Before releasing a public IP, ensure you updated all your resources communicating with this address. post: + description: |- + Releases a public IP.
+ You can release a public IP associated with your account. This address is released in the public IP pool and can be used by someone else. Before releasing a public IP, ensure you updated all your resources communicating with this address. operationId: DeletePublicIp requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeletePublicIpRequest" examples: ex1: value: PublicIp: 192.0.2.0 - schema: - "$ref": "#/components/schemas/DeletePublicIpRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeletePublicIpResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeletePublicIpResponse" description: The HTTP 200 response (OK). '400': content: @@ -17067,40 +17168,40 @@ paths: tags: - PublicIp "/DeleteRoute": - description: Deletes a route from a specified route table. post: + description: Deletes a route from a specified route table. operationId: DeleteRoute requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteRouteRequest" examples: ex1: value: - DestinationIpRange: 198.51.100.0/24 RouteTableId: rtb-12345678 - schema: - "$ref": "#/components/schemas/DeleteRouteRequest" + DestinationIpRange: 198.51.100.0/24 responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteRouteResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 RouteTable: + Routes: + - DestinationIpRange: 10.0.0.0/16 + CreationMethod: CreateRouteTable + State: active LinkRouteTables: [] NetId: vpc-12345678 + Tags: [] RoutePropagatingVirtualGateways: [] RouteTableId: rtb-12345678 - Routes: - - CreationMethod: CreateRouteTable - DestinationIpRange: 10.0.0.0/16 - State: active - Tags: [] - schema: - "$ref": "#/components/schemas/DeleteRouteResponse" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -17123,31 +17224,31 @@ paths: tags: - Route "/DeleteRouteTable": - description: |- - Deletes a specified route table.
- Before deleting a route table, you must disassociate it from any Subnet. You cannot delete the main route table. post: + description: |- + Deletes a specified route table.
+ Before deleting a route table, you must disassociate it from any Subnet. You cannot delete the main route table. operationId: DeleteRouteTable requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteRouteTableRequest" examples: ex1: value: RouteTableId: rtb-12345678 - schema: - "$ref": "#/components/schemas/DeleteRouteTableRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteRouteTableResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteRouteTableResponse" description: The HTTP 200 response (OK). '400': content: @@ -17170,32 +17271,32 @@ paths: tags: - RouteTable "/DeleteSecurityGroup": - description: |- - Deletes a specified security group.
- You can specify either the name of the security group or its ID.
- This action fails if the specified group is associated with a virtual machine (VM) or referenced by another security group. post: + description: |- + Deletes a specified security group.
+ You can specify either the name of the security group or its ID.
+ This action fails if the specified group is associated with a virtual machine (VM) or referenced by another security group. operationId: DeleteSecurityGroup requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteSecurityGroupRequest" examples: ex1: value: SecurityGroupId: sg-12345678 - schema: - "$ref": "#/components/schemas/DeleteSecurityGroupRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteSecurityGroupResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteSecurityGroupResponse" description: The HTTP 200 response (OK). '400': content: @@ -17218,85 +17319,85 @@ paths: tags: - SecurityGroup "/DeleteSecurityGroupRule": - description: |- - Deletes one or more inbound or outbound rules from a security group. For the rule to be deleted, the values specified in the deletion request must exactly match the value of the existing rule.
- In case of TCP and UDP protocols, you have to indicate the destination port or range of ports. In case of ICMP protocol, you have to specify the ICMP type and code numbers.
- Rules (IP permissions) consist of the protocol, IP range or source security group.
- To remove outbound access to a destination security group, we recommend to use a set of IP permissions. We also recommend to specify the protocol in a set of IP permissions. post: + description: |- + Deletes one or more inbound or outbound rules from a security group. For the rule to be deleted, the values specified in the deletion request must exactly match the value of the existing rule.
+ In case of TCP and UDP protocols, you have to indicate the destination port or range of ports. In case of ICMP protocol, you have to specify the ICMP type and code numbers.
+ Rules (IP permissions) consist of the protocol, IP range or source security group.
+ To remove outbound access to a destination security group, we recommend to use a set of IP permissions. We also recommend to specify the protocol in a set of IP permissions. operationId: DeleteSecurityGroupRule requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteSecurityGroupRuleRequest" examples: ex1: summary: Deleting an inbound rule from an IP range value: Flow: Inbound + SecurityGroupId: sg-12345678 FromPortRange: 80 + ToPortRange: 80 IpProtocol: tcp IpRange: 10.0.0.0/16 - SecurityGroupId: sg-12345678 - ToPortRange: 80 ex2: summary: Deleting an inbound rule from another security group value: Flow: Inbound + SecurityGroupId: sg-12345678 Rules: - FromPortRange: 22 + ToPortRange: 22 IpProtocol: tcp SecurityGroupsMembers: - AccountId: '123456789012' SecurityGroupName: another-security-group - ToPortRange: 22 - SecurityGroupId: sg-12345678 - schema: - "$ref": "#/components/schemas/DeleteSecurityGroupRuleRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteSecurityGroupRuleResponse" examples: ex1: summary: Deleting an inbound rule from an IP range value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 SecurityGroup: - AccountId: '123456789012' - Description: Example of security group - InboundRules: [] - NetId: vpc-12345678 + Tags: [] + SecurityGroupName: security-group-example OutboundRules: - FromPortRange: -1 IpProtocol: "-1" + ToPortRange: -1 IpRanges: - 0.0.0.0/0 - ToPortRange: -1 SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - Tags: [] - ex2: - summary: Creating an inbound rule from another security group - value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - SecurityGroup: AccountId: '123456789012' Description: Example of security group InboundRules: [] NetId: vpc-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + summary: Creating an inbound rule from another security group + value: + SecurityGroup: + Tags: [] + SecurityGroupName: security-group-example OutboundRules: - FromPortRange: -1 IpProtocol: "-1" + ToPortRange: -1 IpRanges: - 0.0.0.0/0 - ToPortRange: -1 SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - Tags: [] - schema: - "$ref": "#/components/schemas/DeleteSecurityGroupRuleResponse" + AccountId: '123456789012' + Description: Example of security group + InboundRules: [] + NetId: vpc-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -17319,58 +17420,58 @@ paths: tags: - SecurityGroupRule "/DeleteServerCertificate": - description: Deletes a specified server certificate. post: + description: Deletes a specified server certificate. operationId: DeleteServerCertificate requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteServerCertificateRequest" examples: ex1: value: Name: server-cert-example - schema: - "$ref": "#/components/schemas/DeleteServerCertificateRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteServerCertificateResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteServerCertificateResponse" description: The HTTP 200 response (OK). tags: - ServerCertificate "/DeleteSnapshot": - description: |- - Deletes a specified snapshot.
- You cannot delete a snapshot that is currently used by an OUTSCALE machine image (OMI). To do so, you first need to delete the corresponding OMI. For more information, see the [DeleteImage](#deleteimage) method. post: + description: |- + Deletes a specified snapshot.
+ You cannot delete a snapshot that is currently used by an OUTSCALE machine image (OMI). To do so, you first need to delete the corresponding OMI. For more information, see the [DeleteImage](#deleteimage) method. operationId: DeleteSnapshot requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteSnapshotRequest" examples: ex1: value: SnapshotId: snap-12345678 - schema: - "$ref": "#/components/schemas/DeleteSnapshotRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteSnapshotResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteSnapshotResponse" description: The HTTP 200 response (OK). '400': content: @@ -17393,36 +17494,36 @@ paths: tags: - Snapshot "/DeleteSubnet": - description: |- - Deletes a specified Subnet.
- Before deleting the Subnet, you need to delete all resources associated with the Subnet:

- - * Virtual machines (VMs)
- * Network Interface Cards (NICs)
- * NAT services
- * Load balancers post: + description: |- + Deletes a specified Subnet.
+ Before deleting the Subnet, you need to delete all resources associated with the Subnet:

+ + * Virtual machines (VMs)
+ * Network Interface Cards (NICs)
+ * NAT services
+ * Load balancers operationId: DeleteSubnet requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteSubnetRequest" examples: ex1: value: SubnetId: subnet-12345678 - schema: - "$ref": "#/components/schemas/DeleteSubnetRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteSubnetResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteSubnetResponse" description: The HTTP 200 response (OK). '400': content: @@ -17445,12 +17546,14 @@ paths: tags: - Subnet "/DeleteTags": - description: Deletes one or more tags from the specified resources. post: + description: Deletes one or more tags from the specified resources. operationId: DeleteTags requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteTagsRequest" examples: ex1: value: @@ -17459,19 +17562,17 @@ paths: Tags: - Key: key1 Value: value1 - schema: - "$ref": "#/components/schemas/DeleteTagsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteTagsResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteTagsResponse" description: The HTTP 200 response (OK). '400': content: @@ -17494,181 +17595,181 @@ paths: tags: - Tag "/DeleteUser": - description: Deletes a specified EIM user. The EIM user must not belong to any - group, nor have any key or linked policy. post: + description: Deletes a specified EIM user. The EIM user must not belong to any + group, nor have any key or linked policy. operationId: DeleteUser requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteUserRequest" examples: ex1: value: UserName: example-user - schema: - "$ref": "#/components/schemas/DeleteUserRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteUserResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteUserResponse" description: The HTTP 200 response (OK). tags: - User "/DeleteUserGroup": - description: |- - Deletes a specified user group.
- - **[WARNING]**
- The user group must be empty of any user and must not have any linked policy. Otherwise, you need to force the deletion.
- If you force the deletion, all inline policies will be deleted with the user group.
post: + description: |- + Deletes a specified user group.
+ + **[WARNING]**
+ The user group must be empty of any user and must not have any linked policy. Otherwise, you need to force the deletion.
+ If you force the deletion, all inline policies will be deleted with the user group.
operationId: DeleteUserGroup requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteUserGroupRequest" examples: ex1: value: Force: false Path: "/example/" UserGroupName: example-usergroup - schema: - "$ref": "#/components/schemas/DeleteUserGroupRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteUserGroupResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteUserGroupResponse" description: The HTTP 200 response (OK). tags: - UserGroup "/DeleteUserGroupPolicy": - description: Deletes a specified inline policy from a specific group. post: + description: Deletes a specified inline policy from a specific group. operationId: DeleteUserGroupPolicy requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteUserGroupPolicyRequest" examples: ex1: value: PolicyName: example-usergroup-policy UserGroupName: example-usergroup UserGroupPath: "/example/" - schema: - "$ref": "#/components/schemas/DeleteUserGroupPolicyRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteUserGroupPolicyResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteUserGroupPolicyResponse" description: The HTTP 200 response (OK). tags: - Policy "/DeleteUserPolicy": - description: Deletes a specified inline policy from a specific user. post: + description: Deletes a specified inline policy from a specific user. operationId: DeleteUserPolicy requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteUserPolicyRequest" examples: ex1: value: PolicyName: example-user-policy UserName: example-user - schema: - "$ref": "#/components/schemas/DeleteUserPolicyRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteUserPolicyResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteUserPolicyResponse" description: The HTTP 200 response (OK). tags: - Policy "/DeleteVirtualGateway": - description: |- - Deletes a specified virtual gateway.
- Before deleting a virtual gateway, we recommend to detach it from the Net and delete the VPN connection. post: + description: |- + Deletes a specified virtual gateway.
+ Before deleting a virtual gateway, we recommend to detach it from the Net and delete the VPN connection. operationId: DeleteVirtualGateway requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteVirtualGatewayRequest" examples: ex1: value: VirtualGatewayId: vgw-12345678 - schema: - "$ref": "#/components/schemas/DeleteVirtualGatewayRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteVirtualGatewayResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteVirtualGatewayResponse" description: The HTTP 200 response (OK). tags: - VirtualGateway "/DeleteVmGroup": - description: |- - > [WARNING]
- > This feature is currently under development and may not function properly.
- - Deletes a specified VM group. post: + description: |- + > [WARNING]
+ > This feature is currently under development and may not function properly.
+ + Deletes a specified VM group. operationId: DeleteVmGroup requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteVmGroupRequest" examples: ex1: value: VmGroupId: vmgroup-12345678901234567890123456789012 - schema: - "$ref": "#/components/schemas/DeleteVmGroupRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteVmGroupResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteVmGroupResponse" description: The HTTP 200 response (OK). '400': content: @@ -17691,68 +17792,68 @@ paths: tags: - VmGroup "/DeleteVmTemplate": - description: |- - > [WARNING]
- > This feature is currently under development and may not function properly.
- - Deletes a virtual machine (VM) template.
- You cannot delete a template currently used by a VM group. post: + description: |- + > [WARNING]
+ > This feature is currently under development and may not function properly.
+ + Deletes a virtual machine (VM) template.
+ You cannot delete a template currently used by a VM group. operationId: DeleteVmTemplate requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteVmTemplateRequest" examples: ex1: value: VmTemplateId: vmtemplate-98765432109876543210987654321012 - schema: - "$ref": "#/components/schemas/DeleteVmTemplateRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteVmTemplateResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteVmTemplateResponse" description: The HTTP 200 response (OK). tags: - VmTemplate "/DeleteVms": - description: |- - Terminates one or more virtual machines (VMs).
- This operation is idempotent, that means that all calls succeed if you terminate a VM more than once. post: + description: |- + Terminates one or more virtual machines (VMs).
+ This operation is idempotent, that means that all calls succeed if you terminate a VM more than once. operationId: DeleteVms requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteVmsRequest" examples: ex1: value: VmIds: - i-12345678 - schema: - "$ref": "#/components/schemas/DeleteVmsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteVmsResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Vms: - - CurrentState: shutting-down + - VmId: i-12345678 PreviousState: running - VmId: i-12345678 - schema: - "$ref": "#/components/schemas/DeleteVmsResponse" + CurrentState: shutting-down + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -17775,31 +17876,31 @@ paths: tags: - Vm "/DeleteVolume": - description: |- - Deletes a specified Block Storage Unit (BSU) volume.
- You can delete available volumes only, that is, volumes that are not attached to a virtual machine (VM). post: + description: |- + Deletes a specified Block Storage Unit (BSU) volume.
+ You can delete available volumes only, that is, volumes that are not attached to a virtual machine (VM). operationId: DeleteVolume requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteVolumeRequest" examples: ex1: value: VolumeId: vol-12345678 - schema: - "$ref": "#/components/schemas/DeleteVolumeRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteVolumeResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteVolumeResponse" description: The HTTP 200 response (OK). '400': content: @@ -17822,157 +17923,325 @@ paths: tags: - Volume "/DeleteVpnConnection": - description: |- - Deletes a specified VPN connection.
- If you want to delete a Net and all its dependencies, we recommend to detach the virtual gateway from the Net and delete the Net before deleting the VPN connection. This enables you to delete the Net without waiting for the VPN connection to be deleted. post: + description: |- + Deletes a specified VPN connection.
+ If you want to delete a Net and all its dependencies, we recommend to detach the virtual gateway from the Net and delete the Net before deleting the VPN connection. This enables you to delete the Net without waiting for the VPN connection to be deleted. operationId: DeleteVpnConnection requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteVpnConnectionRequest" examples: ex1: value: VpnConnectionId: vpn-12345678 - schema: - "$ref": "#/components/schemas/DeleteVpnConnectionRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteVpnConnectionResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteVpnConnectionResponse" description: The HTTP 200 response (OK). tags: - VpnConnection "/DeleteVpnConnectionRoute": - description: Deletes a static route to a VPN connection previously created using - the CreateVpnConnectionRoute method. post: + description: Deletes a static route to a VPN connection previously created using + the CreateVpnConnectionRoute method. operationId: DeleteVpnConnectionRoute requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteVpnConnectionRouteRequest" examples: ex1: value: - DestinationIpRange: 10.0.0.0/16 VpnConnectionId: vpn-12345678 - schema: - "$ref": "#/components/schemas/DeleteVpnConnectionRouteRequest" + DestinationIpRange: 10.0.0.0/16 responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteVpnConnectionRouteResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteVpnConnectionRouteResponse" description: The HTTP 200 response (OK). tags: - VpnConnection "/DeregisterVmsInLoadBalancer": - description: |- - > [WARNING]
- > Deprecated: This call is deprecated and will be removed.
- - Deregisters a specified virtual machine (VM) from a load balancer. post: + description: |- + > [WARNING]
+ > Deprecated: This call is deprecated and will be removed.
+ + Deregisters a specified virtual machine (VM) from a load balancer. operationId: DeregisterVmsInLoadBalancer requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeregisterVmsInLoadBalancerRequest" examples: ex1: value: + LoadBalancerName: example-lbu BackendVmIds: - i-12345678 - i-87654321 - LoadBalancerName: example-lbu + responses: + '200': + content: + application/json: + schema: + "$ref": "#/components/schemas/DeregisterVmsInLoadBalancerResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + description: The HTTP 200 response (OK). + tags: + - LoadBalancer + "/DisableOutscaleLogin": + post: + description: Disables the possibility of logging in using the Outscale credentials + of your root account when identity federation is activated. + operationId: DisableOutscaleLogin + requestBody: + content: + application/json: schema: - "$ref": "#/components/schemas/DeregisterVmsInLoadBalancerRequest" + "$ref": "#/components/schemas/DisableOutscaleLoginRequest" + examples: + ex1: + value: {} responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DisableOutscaleLoginResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + description: The HTTP 200 response (OK). + tags: + - IdentityProvider + "/DisableOutscaleLoginForUsers": + post: + description: Disables the possibility of logging in using the Outscale credentials + of your EIM users when identity federation is activated. + operationId: DisableOutscaleLoginForUsers + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/DisableOutscaleLoginRequest" + examples: + ex1: + value: {} + responses: + '200': + content: + application/json: schema: - "$ref": "#/components/schemas/DeregisterVmsInLoadBalancerResponse" + "$ref": "#/components/schemas/DisableOutscaleLoginResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - - LoadBalancer + - IdentityProvider + "/DisableOutscaleLoginPerUsers": + post: + description: Disables the possibility for one or more specific users to log + in using their Outscale credentials when identity federation is activated. + operationId: DisableOutscaleLoginPerUsers + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/DisableOutscaleLoginPerUsersRequest" + examples: + ex1: + value: + UserNames: + - example-user + - test-user + responses: + '200': + content: + application/json: + schema: + "$ref": "#/components/schemas/DisableOutscaleLoginPerUsersResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + description: The HTTP 200 response (OK). + tags: + - IdentityProvider + "/EnableOutscaleLogin": + post: + description: Enables the possibility of logging in using the Outscale credentials + of your root account when identity federation is activated. + operationId: EnableOutscaleLogin + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/EnableOutscaleLoginRequest" + examples: + ex1: + value: {} + responses: + '200': + content: + application/json: + schema: + "$ref": "#/components/schemas/EnableOutscaleLoginResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + description: The HTTP 200 response (OK). + tags: + - IdentityProvider + "/EnableOutscaleLoginForUsers": + post: + description: Enables the possibility for all your EIM users to log in using + their Outscale credentials when identity federation is activated. + operationId: EnableOutscaleLoginForUsers + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/EnableOutscaleLoginForUsersRequest" + examples: + ex1: + value: {} + responses: + '200': + content: + application/json: + schema: + "$ref": "#/components/schemas/EnableOutscaleLoginForUsersResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + description: The HTTP 200 response (OK). + tags: + - IdentityProvider + "/EnableOutscaleLoginPerUsers": + post: + description: Enables the possibility for one or more specific users to log in + using their Outscale credentials when identity federation is activated. + operationId: EnableOutscaleLoginPerUsers + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/EnableOutscaleLoginPerUsersRequest" + examples: + ex1: + value: + UserNames: + - example-user + - test-user + responses: + '200': + content: + application/json: + schema: + "$ref": "#/components/schemas/EnableOutscaleLoginPerUsersResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + description: The HTTP 200 response (OK). + tags: + - IdentityProvider "/LinkFlexibleGpu": - description: |- - Attaches one of your allocated flexible GPUs (fGPUs) to one of your virtual machines (VMs).
- To complete the linking of the fGPU, you need to do a stop/start of the VM. A simple restart is not sufficient, as the linking of the fGPU is done when the VM goes through the `stopped` state. For the difference between stop/start and restart, see [About VM Lifecycle](https://docs.outscale.com/en/userguide/About-VM-Lifecycle.html).

- - **[NOTE]**
- You can attach fGPUs only to VMs with the `highest` (1) performance flag. For more information see [About Flexible GPUs](https://docs.outscale.com/en/userguide/About-Flexible-GPUs.html) and [VM Types](https://docs.outscale.com/en/userguide/VM-Types.html). post: + description: |- + Attaches one of your allocated flexible GPUs (fGPUs) to one of your virtual machines (VMs).
+ To complete the linking of the fGPU, you need to do a stop/start of the VM. A simple restart is not sufficient, as the linking of the fGPU is done when the VM goes through the `stopped` state. For the difference between stop/start and restart, see [About VM Lifecycle](https://docs.outscale.com/en/userguide/About-VM-Lifecycle.html).

+ + **[NOTE]**
+ You can attach fGPUs only to VMs with the `highest` (1) performance flag. For more information see [About Flexible GPUs](https://docs.outscale.com/en/userguide/About-Flexible-GPUs.html) and [VM Types](https://docs.outscale.com/en/userguide/VM-Types.html). operationId: LinkFlexibleGpu requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/LinkFlexibleGpuRequest" examples: ex1: value: FlexibleGpuId: fgpu-12345678 VmId: i-12345678 - schema: - "$ref": "#/components/schemas/LinkFlexibleGpuRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/LinkFlexibleGpuResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/LinkFlexibleGpuResponse" description: The HTTP 200 response (OK). tags: - FlexibleGpu "/LinkInternetService": - description: |- - Attaches an internet service to a Net.
- To enable the connection between the Internet and a Net, you must attach an internet service to this Net. post: + description: |- + Attaches an internet service to a Net.
+ To enable the connection between the Internet and a Net, you must attach an internet service to this Net. operationId: LinkInternetService requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/LinkInternetServiceRequest" examples: ex1: value: InternetServiceId: igw-12345678 NetId: vpc-12345678 - schema: - "$ref": "#/components/schemas/LinkInternetServiceRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/LinkInternetServiceResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/LinkInternetServiceResponse" description: The HTTP 200 response (OK). '400': content: @@ -17995,35 +18264,37 @@ paths: tags: - InternetService "/LinkLoadBalancerBackendMachines": - description: |- - Attaches one or more virtual machines (VMs) to a specified load balancer. You need to specify at least the `BackendIps` or the `BackendVmIds` parameter.
- The VMs can be in different Subnets and different Subregions than the load balancer, as long as the VMs and load balancers are all in the public Cloud or all in the same Net. It may take a little time for a VM to be registered with the load balancer. Once the VM is registered with a load balancer, it receives traffic and requests from this load balancer and is called a backend VM. post: + description: |- + Attaches one or more virtual machines (VMs) to a specified load balancer. You need to specify at least the `BackendIps` or the `BackendVmIds` parameter.
+ The VMs can be in different Subnets and different Subregions than the load balancer, as long as the VMs and load balancers are all in the public Cloud or all in the same Net. It may take a little time for a VM to be registered with the load balancer. Once the VM is registered with a load balancer, it receives traffic and requests from this load balancer and is called a backend VM. operationId: LinkLoadBalancerBackendMachines requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/LinkLoadBalancerBackendMachinesRequest" examples: ex1: summary: Linking VMs to a load balancer value: + LoadBalancerName: example-lbu BackendVmIds: - i-12345678 - i-87654321 - LoadBalancerName: example-lbu ex2: summary: Linking public IPs to a load balancer value: + LoadBalancerName: example-lbu BackendIps: - 192.0.2.0 - 198.51.100.0 - LoadBalancerName: example-lbu - schema: - "$ref": "#/components/schemas/LinkLoadBalancerBackendMachinesRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/LinkLoadBalancerBackendMachinesResponse" examples: ex1: summary: Linking VMs to a load balancer @@ -18035,69 +18306,67 @@ paths: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/LinkLoadBalancerBackendMachinesResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer "/LinkManagedPolicyToUserGroup": - description: Links a managed policy to a specific group. This policy applies to - all the users contained in this group. post: + description: Links a managed policy to a specific group. This policy applies + to all the users contained in this group. operationId: LinkManagedPolicyToUserGroup requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/LinkManagedPolicyToUserGroupRequest" examples: ex1: value: PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy UserGroupName: example-usergroup - schema: - "$ref": "#/components/schemas/LinkManagedPolicyToUserGroupRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/LinkManagedPolicyToUserGroupResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/LinkManagedPolicyToUserGroupResponse" description: The HTTP 200 response (OK). tags: - Policy "/LinkNic": - description: |- - Attaches a network interface card (NIC) to a virtual machine (VM).
- The interface and the VM must be in the same Subregion. The VM can be either `running` or `stopped`. The NIC must be in the `available` state. For more information, see [Attaching a NIC to a VM](https://docs.outscale.com/en/userguide/Attaching-a-NIC-to-a-VM.html). post: + description: |- + Attaches a network interface card (NIC) to a virtual machine (VM).
+ The interface and the VM must be in the same Subregion. The VM can be either `running` or `stopped`. The NIC must be in the `available` state. For more information, see [Attaching a NIC to a VM](https://docs.outscale.com/en/userguide/Attaching-a-NIC-to-a-VM.html). operationId: LinkNic requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/LinkNicRequest" examples: ex1: value: - DeviceNumber: 1 NicId: eni-12345678 VmId: i-12345678 - schema: - "$ref": "#/components/schemas/LinkNicRequest" + DeviceNumber: 1 responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/LinkNicResponse" examples: ex1: value: - LinkNicId: eni-attach-12345678 ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/LinkNicResponse" + LinkNicId: eni-attach-12345678 description: The HTTP 200 response (OK). '400': content: @@ -18120,46 +18389,48 @@ paths: tags: - Nic "/LinkPolicy": - description: Links a managed policy to a specific user. post: + description: Links a managed policy to a specific user. operationId: LinkPolicy requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/LinkPolicyRequest" examples: ex1: value: PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy UserName: example-user - schema: - "$ref": "#/components/schemas/LinkPolicyRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/LinkPolicyResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/LinkPolicyResponse" description: The HTTP 200 response (OK). tags: - Policy "/LinkPrivateIps": - description: Assigns one or more secondary private IPs to a specified network - interface card (NIC). This action is only available in a Net. The private IPs - to be assigned can be added individually using the `PrivateIps` parameter, or - you can specify the number of private IPs to be automatically chosen within - the Subnet range using the `SecondaryPrivateIpCount` parameter. You can specify - only one of these two parameters. If none of these parameters are specified, - a private IP is chosen within the Subnet range. post: + description: Assigns one or more secondary private IPs to a specified network + interface card (NIC). This action is only available in a Net. The private + IPs to be assigned can be added individually using the `PrivateIps` parameter, + or you can specify the number of private IPs to be automatically chosen within + the Subnet range using the `SecondaryPrivateIpCount` parameter. You can specify + only one of these two parameters. If none of these parameters are specified, + a private IP is chosen within the Subnet range. operationId: LinkPrivateIps requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/LinkPrivateIpsRequest" examples: ex1: summary: Linking specific secondary private IPs to a NIC @@ -18173,19 +18444,17 @@ paths: value: NicId: eni-12345678 SecondaryPrivateIpCount: 3 - schema: - "$ref": "#/components/schemas/LinkPrivateIpsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/LinkPrivateIpsResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/LinkPrivateIpsResponse" description: The HTTP 200 response (OK). '400': content: @@ -18208,18 +18477,20 @@ paths: tags: - Nic "/LinkPublicIp": - description: |- - Associates a public IP with a virtual machine (VM) or a network interface card (NIC), in the public Cloud or in a Net. You can associate a public IP with only one VM or network interface at a time.
- To associate a public IP in a Net, ensure that the Net has an internet service attached. For more information, see the [LinkInternetService](#linkinternetservice) method.
- By default, the public IP is disassociated every time you stop and start the VM. For a persistent association, you can add the `osc.fcu.eip.auto-attach` tag to the VM with the public IP as value. For more information, see the [CreateTags](#createtags) method.

- - **[IMPORTANT]**
- You can associate a public IP with a network address translation (NAT) service only when creating the NAT service. To modify its public IP, you need to delete the NAT service and re-create it with the new public IP. For more information, see the [CreateNatService](#createnatservice) method. post: + description: |- + Associates a public IP with a virtual machine (VM) or a network interface card (NIC), in the public Cloud or in a Net. You can associate a public IP with only one VM or network interface at a time.
+ To associate a public IP in a Net, ensure that the Net has an internet service attached. For more information, see the [LinkInternetService](#linkinternetservice) method.
+ By default, the public IP is disassociated every time you stop and start the VM. For a persistent association, you can add the `osc.fcu.eip.auto-attach` tag to the VM with the public IP as value. For more information, see the [CreateTags](#createtags) method.

+ + **[IMPORTANT]**
+ You can associate a public IP with a network address translation (NAT) service only when creating the NAT service. To modify its public IP, you need to delete the NAT service and re-create it with the new public IP. For more information, see the [CreateNatService](#createnatservice) method. operationId: LinkPublicIp requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/LinkPublicIpRequest" examples: ex1: summary: Linking a public IP to a VM @@ -18229,29 +18500,27 @@ paths: ex2: summary: Linking a public IP to a NIC value: - NicId: eni-12345678 PublicIp: 192.0.2.0 - schema: - "$ref": "#/components/schemas/LinkPublicIpRequest" + NicId: eni-12345678 responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/LinkPublicIpResponse" examples: ex1: summary: Linking a public IP to a VM value: - LinkPublicIpId: eipassoc-12345678 ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + LinkPublicIpId: eipassoc-12345678 ex2: summary: Linking a public IP to a NIC value: - LinkPublicIpId: eipassoc-12345678 ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/LinkPublicIpResponse" + LinkPublicIpId: eipassoc-12345678 description: The HTTP 200 response (OK). '400': content: @@ -18274,33 +18543,33 @@ paths: tags: - PublicIp "/LinkRouteTable": - description: |- - Associates a Subnet with a route table.
- The Subnet and the route table must be in the same Net. The traffic is routed according to the route table defined within this Net. You can associate a route table with several Subnets. post: + description: |- + Associates a Subnet with a route table.
+ The Subnet and the route table must be in the same Net. The traffic is routed according to the route table defined within this Net. You can associate a route table with several Subnets. operationId: LinkRouteTable requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/LinkRouteTableRequest" examples: ex1: value: RouteTableId: rtb-12345678 SubnetId: subnet-12345678 - schema: - "$ref": "#/components/schemas/LinkRouteTableRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/LinkRouteTableResponse" examples: ex1: value: - LinkRouteTableId: rtbassoc-12345678 ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/LinkRouteTableResponse" + LinkRouteTableId: rtbassoc-12345678 description: The HTTP 200 response (OK). '400': content: @@ -18323,68 +18592,68 @@ paths: tags: - RouteTable "/LinkVirtualGateway": - description: |- - Attaches a virtual gateway to a Net. - - **[IMPORTANT]**
- This action can be done only if the virtual gateway is in the `available` state. post: + description: |- + Attaches a virtual gateway to a Net. + + **[IMPORTANT]**
+ This action can be done only if the virtual gateway is in the `available` state. operationId: LinkVirtualGateway requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/LinkVirtualGatewayRequest" examples: ex1: value: - NetId: vpc-12345678 VirtualGatewayId: vgw-12345678 - schema: - "$ref": "#/components/schemas/LinkVirtualGatewayRequest" + NetId: vpc-12345678 responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/LinkVirtualGatewayResponse" examples: ex1: value: - NetToVirtualGatewayLink: - NetId: vpc-12345678 - State: attached ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/LinkVirtualGatewayResponse" + NetToVirtualGatewayLink: + State: attached + NetId: vpc-12345678 description: The HTTP 200 response (OK). tags: - VirtualGateway "/LinkVolume": - description: |- - Attaches a Block Storage Unit (BSU) volume to a virtual machine (VM).
- The volume and the VM must be in the same Subregion. The VM can be running or stopped. The volume is attached to the specified VM device. post: + description: |- + Attaches a Block Storage Unit (BSU) volume to a virtual machine (VM).
+ The volume and the VM must be in the same Subregion. The VM can be running or stopped. The volume is attached to the specified VM device. operationId: LinkVolume requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/LinkVolumeRequest" examples: ex1: value: - DeviceName: "/dev/sdb" - VmId: i-12345678 VolumeId: vol-12345678 - schema: - "$ref": "#/components/schemas/LinkVolumeRequest" + VmId: i-12345678 + DeviceName: "/dev/sdb" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/LinkVolumeResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/LinkVolumeResponse" description: The HTTP 200 response (OK). '400': content: @@ -18407,14 +18676,16 @@ paths: tags: - Volume "/PutUserGroupPolicy": - description: |- - Creates or updates an inline policy included in a specified group.
- The policy is automatically applied to all the users of the group after its creation. post: + description: |- + Creates or updates an inline policy included in a specified group.
+ The policy is automatically applied to all the users of the group after its creation. operationId: PutUserGroupPolicy requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/PutUserGroupPolicyRequest" examples: ex1: value: @@ -18423,31 +18694,31 @@ paths: PolicyName: example-usergroup-policy UserGroupName: example-usergroup UserGroupPath: "/example/" - schema: - "$ref": "#/components/schemas/PutUserGroupPolicyRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/PutUserGroupPolicyResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/PutUserGroupPolicyResponse" description: The HTTP 200 response (OK). tags: - Policy "/PutUserPolicy": - description: |- - Creates or updates an inline policy included in a specified user.
- The policy is automatically applied to the user after its creation. post: + description: |- + Creates or updates an inline policy included in a specified user.
+ The policy is automatically applied to the user after its creation. operationId: PutUserPolicy requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/PutUserPolicyRequest" examples: ex1: value: @@ -18455,29 +18726,30 @@ paths: "Resource": ["*"]} ]}' PolicyName: example-user-policy UserName: example-user - schema: - "$ref": "#/components/schemas/PutUserPolicyRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/PutUserPolicyResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/PutUserPolicyResponse" description: The HTTP 200 response (OK). tags: - Policy "/ReadAccessKeys": - description: Lists the access key IDs of either your root account or an EIM user. post: + description: Lists the access key IDs of either your root account or an EIM + user. operationId: ReadAccessKeys requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadAccessKeysRequest" examples: ex1: value: @@ -18486,26 +18758,24 @@ paths: - ACTIVE Tag: Group1 UserName: example-user - schema: - "$ref": "#/components/schemas/ReadAccessKeysRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadAccessKeysResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 AccessKeys: - - AccessKeyId: ABCDEFGHIJ0123456789 + - State: ACTIVE + AccessKeyId: ABCDEFGHIJ0123456789 CreationDate: 2010-10-01 12:34:56.789000000 +00:00 ExpirationDate: 2063-04-05 00:00:00.000000000 +00:00 LastModificationDate: 2010-10-01 12:34:56.789000000 +00:00 - State: ACTIVE Tag: Group1 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadAccessKeysResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -18513,73 +18783,73 @@ paths: tags: - AccessKey "/ReadAccounts": - description: Gets information about the account that sent the request. post: + description: Gets information about the account that sent the request. operationId: ReadAccounts requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadAccountsRequest" examples: ex1: value: {} - schema: - "$ref": "#/components/schemas/ReadAccountsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadAccountsResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Accounts: - - AccountId: '123456789012' - City: SAINT-CLOUD + - ZipCode: '92210' CompanyName: EXAMPLE SAS + FirstName: JEAN + City: SAINT-CLOUD Country: FRANCE + LastName: DUPONT + AccountId: '123456789012' CustomerId: '87654321' Email: example@example.com - FirstName: JEAN - LastName: DUPONT - ZipCode: '92210' - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadAccountsResponse" description: The HTTP 200 response (OK). tags: - Account "/ReadAdminPassword": - description: |- - Gets the administrator password for a Windows running virtual machine (VM).
- The administrator password is encrypted using the keypair you specified when launching the VM.

- - **[IMPORTANT]**
- * Only RSA keypairs can decrypt the password of a Windows VM.
- * The administrator password is generated only on the first boot of the Windows VM. It is not returned after the first boot. post: + description: |- + Gets the administrator password for a Windows running virtual machine (VM).
+ The administrator password is encrypted using the keypair you specified when launching the VM.

+ + **[IMPORTANT]**
+ * Only RSA keypairs can decrypt the password of a Windows VM.
+ * The administrator password is generated only on the first boot of the Windows VM. It is not returned after the first boot. operationId: ReadAdminPassword requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadAdminPasswordRequest" examples: ex1: value: VmId: i-12345678 - schema: - "$ref": "#/components/schemas/ReadAdminPasswordRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadAdminPasswordResponse" examples: ex1: value: - AdminPassword: "..." + VmId: i-12345678 ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - VmId: i-12345678 - schema: - "$ref": "#/components/schemas/ReadAdminPasswordResponse" + AdminPassword: "..." description: The HTTP 200 response (OK). '400': content: @@ -18602,33 +18872,33 @@ paths: tags: - Vm "/ReadApiAccessPolicy": - description: |- - Gets information about the API access policy of your account.

- For more information, see [About Your API Access Policy](https://docs.outscale.com/en/userguide/About-Your-API-Access-Policy.html). post: + description: |- + Gets information about the API access policy of your account.

+ For more information, see [About Your API Access Policy](https://docs.outscale.com/en/userguide/About-Your-API-Access-Policy.html). operationId: ReadApiAccessPolicy requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadApiAccessPolicyRequest" examples: ex1: value: {} - schema: - "$ref": "#/components/schemas/ReadApiAccessPolicyRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadApiAccessPolicyResponse" examples: ex1: value: - ApiAccessPolicy: - MaxAccessKeyExpirationSeconds: 0 - RequireTrustedEnv: false ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadApiAccessPolicyResponse" + ApiAccessPolicy: + RequireTrustedEnv: false + MaxAccessKeyExpirationSeconds: 0 description: The HTTP 200 response (OK). '400': content: @@ -18654,44 +18924,38 @@ paths: tags: - ApiAccessPolicy "/ReadApiAccessRules": - description: Lists one or more API access rules. post: + description: Lists one or more API access rules. operationId: ReadApiAccessRules requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadApiAccessRulesRequest" examples: ex1: value: Filters: ApiAccessRuleIds: - aar-1234567890abcdef1234567890abcdef - schema: - "$ref": "#/components/schemas/ReadApiAccessRulesRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadApiAccessRulesResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ApiAccessRules: - - ApiAccessRuleId: aar-1234567890abcdef1234567890abcdef - CaIds: [] - Cns: [] - Description: Allows all IPv4 domain - IpRanges: + - IpRanges: - 0.0.0.0/0 - - ApiAccessRuleId: aar-abcdef1234567890abcdef1234567890 + ApiAccessRuleId: aar-1234567890abcdef1234567890abcdef CaIds: [] Cns: [] - Description: Allows Outscale Cockpit of this region - IpRanges: - - 46.231.144.178/32 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadApiAccessRulesResponse" + Description: Allows all IPv4 domain description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -18699,95 +18963,95 @@ paths: tags: - ApiAccessRule "/ReadApiLogs": - description: |- - Lists the logs of the API calls you have performed with this account. - - **[IMPORTANT]**
- Past logs are accessible for up to 32 days.
- By default, the retrieved interval is 48 hours. If neither of the `QueryDateBefore` nor `QueryDateAfter` parameters are specified, logs from the past 48 hours are retrieved. If you only specify one of two, logs are retrieved from a 2-day interval based on the date you provided. To retrieve logs beyond a 2-day interval, specify both parameters.

- For more information, see [About OMS](https://docs.outscale.com/en/userguide/About-OMS.html). post: + description: |- + Lists the logs of the API calls you have performed with this account. + + **[IMPORTANT]**
+ Past logs are accessible for up to 32 days.
+ By default, the retrieved interval is 48 hours. If neither of the `QueryDateBefore` nor `QueryDateAfter` parameters are specified, logs from the past 48 hours are retrieved. If you only specify one of two, logs are retrieved from a 2-day interval based on the date you provided. To retrieve logs beyond a 2-day interval, specify both parameters.

+ For more information, see [About OMS](https://docs.outscale.com/en/userguide/About-OMS.html). operationId: ReadApiLogs requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadApiLogsRequest" examples: ex1: value: Filters: - QueryDateAfter: '2017-05-10' - QueryDateBefore: '2017-05-10' QueryIpAddresses: - 192.0.2.0 - 198.51.100.0 - schema: - "$ref": "#/components/schemas/ReadApiLogsRequest" + QueryDateAfter: '2017-05-10' + QueryDateBefore: '2017-05-10' responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadApiLogsResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Logs: - - AccountId: '123456789012' - CallDuration: 47 - QueryAccessKey: ABCDEFGHIJ0123456789 + - ResponseStatusCode: 200 + ResponseSize: 1887 + QueryPayloadRaw: "{}" QueryApiName: oapi + QueryIpAddress: 192.0.2.0 + QueryUserAgent: oAPI CLI v0.1 - 2018-09-28 + CallDuration: 47 + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 QueryApiVersion: '1.27' + AccountId: '123456789012' + QueryPayloadSize: 2 QueryCallName: ReadAccessKeys + QueryAccessKey: ABCDEFGHIJ0123456789 + QueryHeaderSize: 287 QueryDate: '2017-05-10T12:34:56.789Z' QueryHeaderRaw: 'Host: api.eu-west-2.outscale.com\nAccept: */*\nConnection: close\nUser-Agent: oAPI CLI v0.1 - 2018-09-28\nX-Osc-Date: 20170510T000000Z\nContent-Type: application/json; charset=utf-8\nAuthorization: *****\nContent-Length: 2\nAccept-Encoding: gzip, deflate\nX-Forwarded-For: 192.0.2.0' - QueryHeaderSize: 287 - QueryIpAddress: 192.0.2.0 - QueryPayloadRaw: "{}" - QueryPayloadSize: 2 - QueryUserAgent: oAPI CLI v0.1 - 2018-09-28 - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - ResponseSize: 1887 - ResponseStatusCode: 200 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadApiLogsResponse" description: The HTTP 200 response (OK). tags: - ApiLog "/ReadCas": - description: Gets information about one or more of your Client Certificate Authorities - (CAs). post: + description: Gets information about one or more of your Client Certificate Authorities + (CAs). operationId: ReadCas requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadCasRequest" examples: ex1: value: Filters: CaIds: - ca-fedcba0987654321fedcba0987654321 - schema: - "$ref": "#/components/schemas/ReadCasRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadCasResponse" examples: ex1: value: - Cas: - - CaFingerprint: 1234567890abcdef1234567890abcdef12345678 - CaId: ca-fedcba0987654321fedcba0987654321 - Description: CA example ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadCasResponse" + Cas: + - Description: CA example + CaId: ca-fedcba0987654321fedcba0987654321 + CaFingerprint: 1234567890abcdef1234567890abcdef12345678 description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -18795,49 +19059,51 @@ paths: tags: - Ca "/ReadCatalog": - description: Returns the price list of OUTSCALE services for the current Region. post: + description: Returns the price list of OUTSCALE services for the current Region. operationId: ReadCatalog requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadCatalogRequest" examples: ex1: value: {} - schema: - "$ref": "#/components/schemas/ReadCatalogRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadCatalogResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Catalog: Entries: - - Category: compute - Operation: RunInstances-OD - Service: TinaOS-FCU - SubregionName: eu-west-2 + - UnitPrice: 0.04 + Type: CustomCore:v5-p1 Title: Instance - On demand - Unite de vCore pour une instance Tina v5 CxRy Performance highest - par heure - Type: CustomCore:v5-p1 - UnitPrice: 0.04 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadCatalogResponse" + SubregionName: eu-west-2 + Category: compute + Service: TinaOS-FCU + Operation: RunInstances-OD description: The HTTP 200 response (OK). tags: - Catalog "/ReadCatalogs": - description: Returns the price list of OUTSCALE services for the current Region - within a specific time period. post: + description: Returns the price list of OUTSCALE services for the current Region + within a specific time period. operationId: ReadCatalogs requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadCatalogsRequest" examples: ex1: value: @@ -18845,41 +19111,41 @@ paths: CurrentCatalogOnly: true FromDate: '2021-01-01' ToDate: '2023-01-01' - schema: - "$ref": "#/components/schemas/ReadCatalogsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadCatalogsResponse" examples: ex1: value: - Catalogs: - - Entries: - - Category: compute - Operation: RunInstances-OD - Service: TinaOS-FCU - SubregionName: eu-west-2 - Title: Instance - On demand - Unite de vCore pour une instance - Tina v5 CxRy Performance highest - par heure - Type: CustomCore:v5-p1 - UnitPrice: 0.04 - FromDate: 2021-01-01 00:00:00.000000000 +00:00 - State: CURRENT ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadCatalogsResponse" + Catalogs: + - State: CURRENT + FromDate: 2021-01-01 00:00:00.000000000 +00:00 + Entries: + - UnitPrice: 0.04 + Type: CustomCore:v5-p1 + Title: Instance - On demand - Unite de vCore pour une instance + Tina v5 CxRy Performance highest - par heure + SubregionName: eu-west-2 + Category: compute + Service: TinaOS-FCU + Operation: RunInstances-OD description: The HTTP 200 response (OK). tags: - Catalog "/ReadClientGateways": - description: Lists one or more of your client gateways. post: + description: Lists one or more of your client gateways. operationId: ReadClientGateways requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadClientGatewaysRequest" examples: ex1: value: @@ -18894,59 +19160,57 @@ paths: PublicIps: - 192.0.2.0 - 198.51.100.0 - schema: - "$ref": "#/components/schemas/ReadClientGatewaysRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadClientGatewaysResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ClientGateways: - - BgpAsn: 65000 + - State: available + BgpAsn: 65000 + Tags: [] ClientGatewayId: cgw-12345678 ConnectionType: ipsec.1 PublicIp: 192.0.2.0 - State: available - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadClientGatewaysResponse" description: The HTTP 200 response (OK). tags: - ClientGateway "/ReadConsoleOutput": - description: |- - Gets the console output for a virtual machine (VM). This console is not in real-time. It is refreshed every two seconds and provides the most recent 64 KiB output.

- - **[IMPORTANT]**
- On Windows VMs, the console is handled only on the first boot. It returns no output after the first boot. post: + description: |- + Gets the console output for a virtual machine (VM). This console is not in real-time. It is refreshed every two seconds and provides the most recent 64 KiB output.

+ + **[IMPORTANT]**
+ On Windows VMs, the console is handled only on the first boot. It returns no output after the first boot. operationId: ReadConsoleOutput requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadConsoleOutputRequest" examples: ex1: value: VmId: i-12345678 - schema: - "$ref": "#/components/schemas/ReadConsoleOutputRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadConsoleOutputResponse" examples: ex1: value: - ConsoleOutput: "..." + VmId: i-12345678 ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - VmId: i-12345678 - schema: - "$ref": "#/components/schemas/ReadConsoleOutputResponse" + ConsoleOutput: "..." description: The HTTP 200 response (OK). '400': content: @@ -18969,62 +19233,64 @@ paths: tags: - Vm "/ReadConsumptionAccount": - description: Gets information about the consumption of your account for each billable - resource within the specified time period. post: + description: Gets information about the consumption of your account for each + billable resource within the specified time period. operationId: ReadConsumptionAccount requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadConsumptionAccountRequest" examples: ex1: value: FromDate: '2023-06-01' - ShowPrice: true ToDate: '2023-07-01' - schema: - "$ref": "#/components/schemas/ReadConsumptionAccountRequest" + ShowPrice: true responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadConsumptionAccountResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ConsumptionEntries: - - AccountId: '123456789012' - Category: compute - FromDate: 2023-06-01 00:00:00.000000000 +00:00 + - UnitPrice: 0.044 + Type: BoxUsage:tinav4.c1r1p2 Operation: RunInstances-OD - PayingAccountId: '123456789012' - Price: 61.248 - Service: TinaOS-FCU SubregionName: eu-west-2a + Value: 1392 Title: Instance - On demand - tinav4.c1r1 high performance - par heure + Category: compute ToDate: 2023-06-30 00:00:00.000000000 +00:00 - Type: BoxUsage:tinav4.c1r1p2 - UnitPrice: 0.044 - Value: 1392 + Service: TinaOS-FCU + AccountId: '123456789012' + PayingAccountId: '123456789012' + FromDate: 2023-06-01 00:00:00.000000000 +00:00 + Price: 61.248 Currency: EUR - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadConsumptionAccountResponse" description: The HTTP 200 response (OK). tags: - Account "/ReadDedicatedGroups": - description: |- - > [WARNING]
- > This feature is currently in beta.
- - List one or more dedicated groups of virtual machines (VMs). post: + description: |- + > [WARNING]
+ > This feature is currently in beta.
+ + List one or more dedicated groups of virtual machines (VMs). operationId: ReadDedicatedGroups requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadDedicatedGroupsRequest" examples: ex1: summary: Filtering on a specific dedicated group @@ -19036,32 +19302,30 @@ paths: summary: Filtering on a specific Subregion and CPU generation value: Filters: - CpuGenerations: - - 4 SubregionNames: - eu-west-2a - schema: - "$ref": "#/components/schemas/ReadDedicatedGroupsRequest" + CpuGenerations: + - 4 responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadDedicatedGroupsResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 DedicatedGroups: - - AccountId: '123456789012' + - VmIds: + - i-12345678 + NetIds: [] + AccountId: '123456789012' CpuGeneration: 4 - DedicatedGroupId: ded-12345678 Name: dedicated-group-example - NetIds: [] SubregionName: eu-west-2a - VmIds: - - i-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadDedicatedGroupsResponse" + DedicatedGroupId: ded-12345678 description: The HTTP 200 response (OK). '400': content: @@ -19084,12 +19348,15 @@ paths: tags: - DedicatedGroup "/ReadDhcpOptions": - description: Gets information about the content of one or more DHCP options sets. post: + description: Gets information about the content of one or more DHCP options + sets. operationId: ReadDhcpOptions requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadDhcpOptionsRequest" examples: ex1: value: @@ -19104,98 +19371,100 @@ paths: - 198.51.100.0 DomainNames: - example.com - schema: - "$ref": "#/components/schemas/ReadDhcpOptionsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadDhcpOptionsResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 DhcpOptionsSets: - - Default: false + - Tags: [] + NtpServers: + - 203.0.113.0 + - 203.0.113.1 + Default: false DhcpOptionsSetId: dopt-12345678 DomainName: example.com DomainNameServers: - 192.0.2.0 - 198.51.100.0 - NtpServers: - - 203.0.113.0 - - 203.0.113.1 - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadDhcpOptionsResponse" description: The HTTP 200 response (OK). tags: - DhcpOption "/ReadDirectLinkInterfaces": - description: Lists one or more of your DirectLink interfaces. post: + description: Lists one or more of your DirectLink interfaces. operationId: ReadDirectLinkInterfaces requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadDirectLinkInterfacesRequest" examples: ex1: value: Filters: DirectLinkInterfaceIds: - dxvif-12345678 - schema: - "$ref": "#/components/schemas/ReadDirectLinkInterfacesRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadDirectLinkInterfacesResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 DirectLinkInterfaces: - - AccountId: '123456789012' + - Vlan: 101 + OutscalePrivateIp: 172.16.0.4/30 + DirectLinkInterfaceId: dxvif-12345678 BgpAsn: 65000 + AccountId: '123456789012' ClientPrivateIp: 172.16.0.5/30 - DirectLinkId: dxcon-12345678 - DirectLinkInterfaceId: dxvif-12345678 + VirtualGatewayId: vgw-12345678 DirectLinkInterfaceName: MyDirectLinkInterface - InterfaceType: private - Location: PAR1 + DirectLinkId: dxcon-12345678 Mtu: 1500 - OutscalePrivateIp: 172.16.0.4/30 State: available - VirtualGatewayId: vgw-12345678 - Vlan: 101 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadDirectLinkInterfacesResponse" + InterfaceType: private + Location: PAR1 description: The HTTP 200 response (OK). tags: - DirectLinkInterface "/ReadDirectLinks": - description: Lists all DirectLinks in the Region. post: + description: Lists all DirectLinks in the Region. operationId: ReadDirectLinks requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadDirectLinksRequest" examples: ex1: value: Filters: DirectLinkIds: - dxcon-12345678 - schema: - "$ref": "#/components/schemas/ReadDirectLinksRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadDirectLinksResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 DirectLinks: - AccountId: '123456789012' Bandwidth: 1Gbps @@ -19204,21 +19473,19 @@ paths: Location: PAR1 RegionName: eu-west-2 State: available - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadDirectLinksResponse" description: The HTTP 200 response (OK). tags: - DirectLink "/ReadEntitiesLinkedToPolicy": - description: Lists all entities (account, users, or user groups) linked to a specific - managed policy. post: + description: Lists all entities (account, users, or user groups) linked to a + specific managed policy. operationId: ReadEntitiesLinkedToPolicy requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadEntitiesLinkedToPolicyRequest" examples: ex1: summary: Reading all entities linked to a specific policy @@ -19231,17 +19498,23 @@ paths: EntitiesType: - USER PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy - schema: - "$ref": "#/components/schemas/ReadEntitiesLinkedToPolicyRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadEntitiesLinkedToPolicyResponse" examples: ex1: summary: Reading all entities linked to a specific policy value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 PolicyEntities: + Users: + - Id: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 + Name: example-user + Orn: orn:ows:idauth::012345678910:user/example/user-example Groups: - Id: ug-12345678 Name: example-usergroup @@ -19250,68 +19523,62 @@ paths: ItemsCount: 3 MaxResultsLimit: 100 MaxResultsTruncated: false - Users: - - Id: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 - Name: example-user - Orn: orn:ows:idauth::012345678910:user/example/user-example - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Reading only users linked to a specific policy value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 PolicyEntities: Users: - Id: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 Name: example-user Orn: orn:ows:idauth::012345678910:user/example/user-example - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadEntitiesLinkedToPolicyResponse" description: The HTTP 200 response (OK). tags: - Policy "/ReadFlexibleGpuCatalog": - description: Lists all flexible GPUs available in the public catalog. post: + description: Lists all flexible GPUs available in the public catalog. operationId: ReadFlexibleGpuCatalog requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadFlexibleGpuCatalogRequest" examples: ex1: value: {} - schema: - "$ref": "#/components/schemas/ReadFlexibleGpuCatalogRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadFlexibleGpuCatalogResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 FlexibleGpuCatalog: - - Generations: + - VRam: 16000 + Generations: - v5 MaxCpu: 80 MaxRam: 512 ModelName: nvidia-p100 - VRam: 16000 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadFlexibleGpuCatalogResponse" description: The HTTP 200 response (OK). security: [] tags: - FlexibleGpu "/ReadFlexibleGpus": - description: Lists one or more flexible GPUs (fGPUs) allocated to your account. post: + description: Lists one or more flexible GPUs (fGPUs) allocated to your account. operationId: ReadFlexibleGpus requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadFlexibleGpusRequest" examples: ex1: value: @@ -19326,15 +19593,17 @@ paths: - nvidia-p100 States: - attached - schema: - "$ref": "#/components/schemas/ReadFlexibleGpusRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadFlexibleGpusResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 FlexibleGpus: - DeleteOnVmDeletion: true FlexibleGpuId: fgpu-12345678 @@ -19343,60 +19612,58 @@ paths: State: attached SubregionName: eu-west-2a VmId: i-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadFlexibleGpusResponse" description: The HTTP 200 response (OK). tags: - FlexibleGpu "/ReadImageExportTasks": - description: Lists one or more image export tasks. post: + description: Lists one or more image export tasks. operationId: ReadImageExportTasks requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadImageExportTasksRequest" examples: ex1: value: Filters: TaskIds: - image-export-12345678 - schema: - "$ref": "#/components/schemas/ReadImageExportTasksRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadImageExportTasksResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ImageExportTasks: - - Comment: Export of image ami-12345678 + - Tags: [] ImageId: ami-12345678 + TaskId: image-export-12345678 + Comment: Export of image ami-12345678 OsuExport: - DiskImageFormat: qcow2 - OsuBucket: BUCKET OsuPrefix: PREFIX/ami-12345678/ - Progress: 0 + OsuBucket: BUCKET + DiskImageFormat: qcow2 State: pending/queued - Tags: [] - TaskId: image-export-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadImageExportTasksResponse" + Progress: 0 description: The HTTP 200 response (OK). tags: - Image "/ReadImages": - description: Lists one or more OUTSCALE machine images (OMIs) you can use. post: + description: Lists one or more OUTSCALE machine images (OMIs) you can use. operationId: ReadImages requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadImagesRequest" examples: ex1: summary: Reading a specific image @@ -19413,110 +19680,108 @@ paths: ImageNames: - Ubuntu* - RockyLinux* - schema: - "$ref": "#/components/schemas/ReadImagesRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadImagesResponse" examples: ex1: summary: Reading a specific image value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Images: - - AccountId: '123456789012' - Architecture: x86_64 - BlockDeviceMappings: - - Bsu: - DeleteOnVmDeletion: true - SnapshotId: snap-12345678 - VolumeSize: 50 - VolumeType: standard - DeviceName: "/dev/sda1" - BootModes: - - legacy - CreationDate: '2010-10-01T12:34:56.789Z' - Description: '' - FileLocation: 123456789012/create-image-example - ImageId: ami-12345678 - ImageName: create-image-example - ImageType: machine - PermissionsToLaunch: - AccountIds: [] - GlobalPermission: false + - StateComment: {} + State: available + RootDeviceType: bsu + RootDeviceName: "/dev/sda1" ProductCodes: - '0001' - RootDeviceName: "/dev/sda1" - RootDeviceType: bsu - SecureBoot: false - State: available - StateComment: {} + PermissionsToLaunch: + GlobalPermission: false + AccountIds: [] + AccountId: '123456789012' Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Description: '' + ImageId: ami-12345678 + BlockDeviceMappings: + - DeviceName: "/dev/sda1" + Bsu: + VolumeType: standard + DeleteOnVmDeletion: true + VolumeSize: 50 + SnapshotId: snap-12345678 + BootModes: + - legacy + ImageType: machine + CreationDate: '2010-10-01T12:34:56.789Z' + SecureBoot: false + FileLocation: 123456789012/create-image-example + Architecture: x86_64 + ImageName: create-image-example ex2: summary: Reading Ubuntu and RockyLinux images created by Outscale value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Images: - - AccountAlias: Outscale + - StateComment: {} + State: available + RootDeviceType: bsu + RootDeviceName: "/dev/sda1" + ProductCodes: + - '0001' + PermissionsToLaunch: + GlobalPermission: true + AccountIds: [] AccountId: '123456789012' - Architecture: x86_64 + Tags: [] + Description: '' + ImageId: ami-12345678 BlockDeviceMappings: - - Bsu: + - DeviceName: "/dev/sda1" + Bsu: + VolumeType: standard DeleteOnVmDeletion: true - SnapshotId: snap-12345678 VolumeSize: 10 - VolumeType: standard - DeviceName: "/dev/sda1" + SnapshotId: snap-12345678 + ImageType: machine + AccountAlias: Outscale CreationDate: '2010-10-01T12:34:56.789Z' - Description: '' FileLocation: Outscale/Ubuntu-2010.10.01-0 - ImageId: ami-12345678 + Architecture: x86_64 ImageName: Ubuntu-2010.10.01-0 - ImageType: machine - PermissionsToLaunch: - AccountIds: [] - GlobalPermission: true + - StateComment: {} + State: available + RootDeviceType: bsu + RootDeviceName: "/dev/sda1" ProductCodes: - '0001' - RootDeviceName: "/dev/sda1" - RootDeviceType: bsu - State: available - StateComment: {} - Tags: [] - - AccountAlias: Outscale + PermissionsToLaunch: + GlobalPermission: true + AccountIds: [] AccountId: '123456789012' - Architecture: x86_64 + Tags: [] + Description: '' + ImageId: ami-12345678 BlockDeviceMappings: - - Bsu: + - DeviceName: "/dev/sda1" + Bsu: + VolumeType: standard DeleteOnVmDeletion: true - SnapshotId: snap-12345678 VolumeSize: 10 - VolumeType: standard - DeviceName: "/dev/sda1" + SnapshotId: snap-12345678 + ImageType: machine + AccountAlias: Outscale + CreationDate: '2010-10-01T12:34:56.789Z' BootModes: - legacy - CreationDate: '2010-10-01T12:34:56.789Z' - Description: '' + SecureBoot: false FileLocation: Outscale/RockyLinux-2010.10.01-0 - ImageId: ami-12345678 + Architecture: x86_64 ImageName: RockyLinux-2010.10.01-0 - ImageType: machine - PermissionsToLaunch: - AccountIds: [] - GlobalPermission: true - ProductCodes: - - '0001' - RootDeviceName: "/dev/sda1" - RootDeviceType: bsu - SecureBoot: false - State: available - StateComment: {} - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadImagesResponse" description: The HTTP 200 response (OK). '400': content: @@ -19539,14 +19804,16 @@ paths: tags: - Image "/ReadInternetServices": - description: |- - Lists one or more of your internet services.
- An internet service enables virtual machines (VMs) launched in a Net to connect to the Internet. It allows routing of incoming and outgoing Internet traffic and management of public IP addresses. post: + description: |- + Lists one or more of your internet services.
+ An internet service enables virtual machines (VMs) launched in a Net to connect to the Internet. It allows routing of incoming and outgoing Internet traffic and management of public IP addresses. operationId: ReadInternetServices requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadInternetServicesRequest" examples: ex1: value: @@ -19561,26 +19828,24 @@ paths: TagValues: - prod - test - schema: - "$ref": "#/components/schemas/ReadInternetServicesRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadInternetServicesResponse" examples: ex1: value: - InternetServices: - - InternetServiceId: igw-12345678 - NetId: vpc-12345678 - State: available - Tags: - - Key: env - Value: prod ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadInternetServicesResponse" + InternetServices: + - Tags: + - Value: prod + Key: env + State: available + NetId: vpc-12345678 + InternetServiceId: igw-12345678 description: The HTTP 200 response (OK). '400': content: @@ -19603,36 +19868,36 @@ paths: tags: - InternetService "/ReadKeypairs": - description: Lists one or more of your keypairs. post: + description: Lists one or more of your keypairs. operationId: ReadKeypairs requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadKeypairsRequest" examples: ex1: value: Filters: KeypairNames: - keypair-example - schema: - "$ref": "#/components/schemas/ReadKeypairsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadKeypairsResponse" examples: ex1: value: - Keypairs: - - KeypairFingerprint: 11:22:33:44:55:66:77:88:99:00:aa:bb:cc:dd:ee:ff - KeypairId: key-abcdef1234567890abcdef1234567890 - KeypairName: keypair-example - KeypairType: ssh-rsa ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadKeypairsResponse" + Keypairs: + - KeypairType: ssh-rsa + KeypairName: keypair-example + KeypairId: key-abcdef1234567890abcdef1234567890 + KeypairFingerprint: 11:22:33:44:55:66:77:88:99:00:aa:bb:cc:dd:ee:ff description: The HTTP 200 response (OK). '400': content: @@ -19655,12 +19920,14 @@ paths: tags: - Keypair "/ReadLinkedPolicies": - description: Lists the managed policies linked to a specified user. post: + description: Lists the managed policies linked to a specified user. operationId: ReadLinkedPolicies requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadLinkedPoliciesRequest" examples: ex1: value: @@ -19669,208 +19936,208 @@ paths: FirstItem: 1 ResultsPerPage: 30 UserName: example-user - schema: - "$ref": "#/components/schemas/ReadLinkedPoliciesRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadLinkedPoliciesResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 HasMoreItems: true - MaxResultsLimit: 30 - MaxResultsTruncated: false Policies: - - CreationDate: 2010-10-01 12:34:56.789000000 +00:00 + - PolicyName: example-user-policy + CreationDate: 2010-10-01 12:34:56.789000000 +00:00 LastModificationDate: 2010-10-01 12:34:56.789000000 +00:00 Orn: orn:ows:idauth::012345678910:policy/example/example-user-policy PolicyId: ABCDEFGHIJKLMNOPQRSTUVWXYZ01234 - PolicyName: example-user-policy - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadLinkedPoliciesResponse" + MaxResultsLimit: 30 + MaxResultsTruncated: false description: The HTTP 200 response (OK). tags: - Policy "/ReadListenerRules": - description: Lists one or more listener rules. By default, this action returns - the full list of listener rules for the account. post: + description: Lists one or more listener rules. By default, this action returns + the full list of listener rules for the account. operationId: ReadListenerRules requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadListenerRulesRequest" examples: ex1: value: Filters: ListenerRuleNames: - example-listener-rule - schema: - "$ref": "#/components/schemas/ReadListenerRulesRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadListenerRulesResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ListenerRules: - - Action: forward - HostNamePattern: "*.example.com" - ListenerId: 123456 - ListenerRuleId: 1234 - ListenerRuleName: example-listener-rule - Priority: 10 + - Priority: 10 VmIds: - i-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadListenerRulesResponse" + ListenerRuleName: example-listener-rule + Action: forward + ListenerId: 123456 + HostNamePattern: "*.example.com" + ListenerRuleId: 1234 description: The HTTP 200 response (OK). tags: - Listener "/ReadLoadBalancerTags": - description: Lists the tags associated with one or more specified load balancers. post: + description: Lists the tags associated with one or more specified load balancers. operationId: ReadLoadBalancerTags requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadLoadBalancerTagsRequest" examples: ex1: value: LoadBalancerNames: - private-lb-example - schema: - "$ref": "#/components/schemas/ReadLoadBalancerTagsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadLoadBalancerTagsResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Tags: - - Key: key1 + - Value: value1 LoadBalancerName: private-lb-example - Value: value1 - schema: - "$ref": "#/components/schemas/ReadLoadBalancerTagsResponse" + Key: key1 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - LoadBalancer "/ReadLoadBalancers": - description: Lists one or more load balancers and their attributes. post: + description: Lists one or more load balancers and their attributes. operationId: ReadLoadBalancers requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadLoadBalancersRequest" examples: ex1: value: Filters: LoadBalancerNames: - private* - schema: - "$ref": "#/components/schemas/ReadLoadBalancersRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadLoadBalancersResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 LoadBalancers: - - AccessLog: - IsEnabled: false - PublicationInterval: 60 - ApplicationStickyCookiePolicies: [] + - Tags: [] + SourceSecurityGroup: + SecurityGroupName: security-group-example + SecurityGroupAccountId: '123456789012' + SecuredCookies: false + PublicIp: 192.0.2.0 + Subnets: + - subnet-12345678 + NetId: vpc-12345678 BackendVmIds: [] + ApplicationStickyCookiePolicies: [] + SecurityGroups: + - sg-12345678 + LoadBalancerType: internet-facing + AccessLog: + PublicationInterval: 60 + IsEnabled: false DnsName: private-lb-example.123456789.eu-west-2.lbu.outscale.com HealthCheck: + UnhealthyThreshold: 2 + Timeout: 5 CheckInterval: 30 + Protocol: TCP HealthyThreshold: 10 Port: 80 - Protocol: TCP - Timeout: 5 - UnhealthyThreshold: 2 + LoadBalancerStickyCookiePolicies: [] + SubregionNames: + - eu-west-2a Listeners: - - BackendPort: 80 + - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate + BackendPort: 80 BackendProtocol: HTTP LoadBalancerPort: 443 LoadBalancerProtocol: HTTPS - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate LoadBalancerName: private-lb-example - LoadBalancerStickyCookiePolicies: [] - LoadBalancerType: internet-facing - NetId: vpc-12345678 - PublicIp: 192.0.2.0 - SecuredCookies: false - SecurityGroups: - - sg-12345678 - SourceSecurityGroup: - SecurityGroupAccountId: '123456789012' - SecurityGroupName: security-group-example - Subnets: - - subnet-12345678 - SubregionNames: - - eu-west-2a - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadLoadBalancersResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer "/ReadLocations": - description: |- - Lists the locations, corresponding to datacenters, where you can set up a DirectLink.

- For more information, see [About DirectLink](https://docs.outscale.com/en/userguide/About-DirectLink.html). post: + description: |- + Lists the locations, corresponding to datacenters, where you can set up a DirectLink.

+ For more information, see [About DirectLink](https://docs.outscale.com/en/userguide/About-DirectLink.html). operationId: ReadLocations requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadLocationsRequest" examples: ex1: value: {} - schema: - "$ref": "#/components/schemas/ReadLocationsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadLocationsResponse" examples: ex1: value: - Locations: - - Code: PAR1 - Name: Telehouse 3, France - - Code: PAR4 - Name: Equinix Pantin, France ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadLocationsResponse" + Locations: + - Name: Telehouse 3, France + Code: PAR1 + - Name: Equinix Pantin, France + Code: PAR4 description: The HTTP 200 response (OK). security: [] tags: - Location "/ReadManagedPoliciesLinkedToUserGroup": - description: Lists the managed policies linked to a specified group. post: + description: Lists the managed policies linked to a specified group. operationId: ReadManagedPoliciesLinkedToUserGroup requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadManagedPoliciesLinkedToUserGroupRequest" examples: ex1: value: @@ -19881,15 +20148,17 @@ paths: FirstItem: 1 ResultsPerPage: 30 UserGroupName: example-usergroup - schema: - "$ref": "#/components/schemas/ReadManagedPoliciesLinkedToUserGroupRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadManagedPoliciesLinkedToUserGroupResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 HasMoreItems: true MaxResultsLimit: 30 MaxResultsTruncated: true @@ -19899,20 +20168,18 @@ paths: Orn: orn:ows:idauth::012345678910:policy/example/example-user-policy PolicyId: ABCDEFGHIJKLMNOPQRSTUVWXYZ01234 PolicyName: example-policy - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadManagedPoliciesLinkedToUserGroupResponse" description: The HTTP 200 response (OK). tags: - Policy "/ReadNatServices": - description: Lists one or more network address translation (NAT) services. post: + description: Lists one or more network address translation (NAT) services. operationId: ReadNatServices requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadNatServicesRequest" examples: ex1: value: @@ -19927,28 +20194,26 @@ paths: - vpc-87654321 SubnetIds: - subnet-12345678 - schema: - "$ref": "#/components/schemas/ReadNatServicesRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadNatServicesResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 NatServices: - - NatServiceId: nat-12345678 - NetId: vpc-12345678 + - Tags: [] + SubnetId: subnet-12345678 + NatServiceId: nat-12345678 PublicIps: - - PublicIp: 192.0.2.0 - PublicIpId: eipalloc-12345678 + - PublicIpId: eipalloc-12345678 + PublicIp: 192.0.2.0 + NetId: vpc-12345678 State: available - SubnetId: subnet-12345678 - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadNatServicesResponse" description: The HTTP 200 response (OK). '400': content: @@ -19971,14 +20236,16 @@ paths: tags: - NatService "/ReadNetAccessPointServices": - description: |- - Lists OUTSCALE services available to create Net access points.
- For more information, see [CreateNetAccessPoint](#createnetaccesspoint). post: + description: |- + Lists OUTSCALE services available to create Net access points.
+ For more information, see [CreateNetAccessPoint](#createnetaccesspoint). operationId: ReadNetAccessPointServices requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadNetAccessPointServicesRequest" examples: ex1: summary: Listing one or more services according to their service IDs @@ -19993,54 +20260,54 @@ paths: Filters: ServiceNames: - com.outscale.eu-west-2.api - schema: - "$ref": "#/components/schemas/ReadNetAccessPointServicesRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadNetAccessPointServicesResponse" examples: ex1: summary: Listing one or more services according to their service IDs value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Services: - - IpRanges: - - 192.0.2.0 + - ServiceName: com.outscale.eu-west-2.api ServiceId: pl-12345678 - ServiceName: com.outscale.eu-west-2.api - - IpRanges: + IpRanges: + - 192.0.2.0 + - ServiceName: com.outscale.eu-west-2.oos + ServiceId: pl-87654321 + IpRanges: - 198.51.100.0 - 203.0.113.0 - 203.0.113.1 - ServiceId: pl-87654321 - ServiceName: com.outscale.eu-west-2.oos + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Listing one or more services according to their service names value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Services: - - IpRanges: - - 192.0.2.0 + - ServiceName: com.outscale.eu-west-2.api ServiceId: pl-12345678 - ServiceName: com.outscale.eu-west-2.api - schema: - "$ref": "#/components/schemas/ReadNetAccessPointServicesResponse" + IpRanges: + - 192.0.2.0 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). security: [] tags: - NetAccessPoint "/ReadNetAccessPoints": - description: Lists one or more Net access points. post: + description: Lists one or more Net access points. operationId: ReadNetAccessPoints requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadNetAccessPointsRequest" examples: ex1: value: @@ -20054,37 +20321,37 @@ paths: - vpc-12345678 States: - available - schema: - "$ref": "#/components/schemas/ReadNetAccessPointsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadNetAccessPointsResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 NetAccessPoints: - - NetAccessPointId: vpce-12345678 - NetId: vpc-12345678 + - Tags: [] + NetAccessPointId: vpce-12345678 RouteTableIds: - rtb-12345678 - ServiceName: com.outscale.eu-west-2.oos State: available - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadNetAccessPointsResponse" + NetId: vpc-12345678 + ServiceName: com.outscale.eu-west-2.oos description: The HTTP 200 response (OK). tags: - NetAccessPoint "/ReadNetPeerings": - description: Lists one or more peering connections between two Nets. post: + description: Lists one or more peering connections between two Nets. operationId: ReadNetPeerings requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadNetPeeringsRequest" examples: ex1: value: @@ -20099,33 +20366,31 @@ paths: StateNames: - active - pending-acceptance - schema: - "$ref": "#/components/schemas/ReadNetPeeringsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadNetPeeringsResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 NetPeerings: - - AccepterNet: - AccountId: '123456789012' - IpRange: 172.16.0.0/16 + - Tags: [] + State: + Name: active + Message: Active + AccepterNet: NetId: vpc-12345678 - NetPeeringId: pcx-12345678 - SourceNet: + IpRange: 172.16.0.0/16 AccountId: '123456789012' - IpRange: 10.0.0.0/16 + SourceNet: NetId: vpc-12345678 - State: - Message: Active - Name: active - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadNetPeeringsResponse" + IpRange: 10.0.0.0/16 + AccountId: '123456789012' + NetPeeringId: pcx-12345678 description: The HTTP 200 response (OK). '400': content: @@ -20148,12 +20413,14 @@ paths: tags: - NetPeering "/ReadNets": - description: Lists one or more Nets. post: + description: Lists one or more Nets. operationId: ReadNets requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadNetsRequest" examples: ex1: value: @@ -20165,26 +20432,24 @@ paths: Filters: States: - available - schema: - "$ref": "#/components/schemas/ReadNetsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadNetsResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Nets: - - DhcpOptionsSetId: dopt-12345678 + - Tags: [] + DhcpOptionsSetId: dopt-12345678 IpRange: 10.0.0.0/16 + Tenancy: default NetId: vpc-12345678 State: available - Tags: [] - Tenancy: default - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadNetsResponse" description: The HTTP 200 response (OK). '400': content: @@ -20207,14 +20472,16 @@ paths: tags: - Net "/ReadNics": - description: |- - Lists one or more network interface cards (NICs).
- A NIC is a virtual network interface that you can attach to a virtual machine (VM) in a Net. post: + description: |- + Lists one or more network interface cards (NICs).
+ A NIC is a virtual network interface that you can attach to a virtual machine (VM) in a Net. operationId: ReadNics requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadNicsRequest" examples: ex1: value: @@ -20226,45 +20493,43 @@ paths: Filters: LinkNicVmIds: - i-12345678 - schema: - "$ref": "#/components/schemas/ReadNicsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadNicsResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Nics: - - AccountId: '123456789012' - Description: Primary network interface - IsSourceDestChecked: true + - SubregionName: eu-west-2a + SubnetId: subnet-12345678 + State: in-use LinkNic: + VmId: i-12345678 + LinkNicId: eni-attach-12345678 + VmAccountId: '123456789012' DeleteOnVmDeletion: false DeviceNumber: 0 - LinkNicId: eni-attach-12345678 State: attached - VmAccountId: '123456789012' - VmId: i-12345678 + IsSourceDestChecked: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + Tags: [] + Description: Primary network interface + AccountId: '123456789012' + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - IsPrimary: true - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - SecurityGroups: - - SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - State: in-use - SubnetId: subnet-12345678 - SubregionName: eu-west-2a - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadNicsResponse" + IsPrimary: true description: The HTTP 200 response (OK). '400': content: @@ -20287,12 +20552,14 @@ paths: tags: - Nic "/ReadPolicies": - description: Lists all the managed policies available for your account. post: + description: Lists all the managed policies available for your account. operationId: ReadPolicies requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadPoliciesRequest" examples: ex1: value: @@ -20302,259 +20569,259 @@ paths: Scope: OWS FirstItem: 1 ResultsPerPage: 30 - schema: - "$ref": "#/components/schemas/ReadPoliciesRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadPoliciesResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 HasMoreItems: true - MaxResultsLimit: 30 - MaxResultsTruncated: false Policies: - - CreationDate: 2010-10-01 12:34:56.789000000 +00:00 + - ResourcesCount: 1 + PolicyName: example-user-policy + PolicyDefaultVersionId: v1 + Path: "/example/" + CreationDate: 2010-10-01 12:34:56.789000000 +00:00 Description: Example of description + PolicyId: ABCDEFGHIJKLMNOPQRSTUVWXYZ01234 + Orn: orn:ows:idauth::012345678910:policy/example/example-user-policy IsLinkable: true LastModificationDate: 2010-10-01 12:34:56.789000000 +00:00 - Orn: orn:ows:idauth::012345678910:policy/example/example-user-policy - Path: "/example/" - PolicyDefaultVersionId: v1 - PolicyId: ABCDEFGHIJKLMNOPQRSTUVWXYZ01234 - PolicyName: example-user-policy - ResourcesCount: 1 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadPoliciesResponse" + MaxResultsLimit: 30 + MaxResultsTruncated: false description: The HTTP 200 response (OK). tags: - Policy "/ReadPolicy": - description: Lists information about a specified managed policy. post: + description: Lists information about a specified managed policy. operationId: ReadPolicy requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadPolicyRequest" examples: ex1: value: PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy - schema: - "$ref": "#/components/schemas/ReadPolicyRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadPolicyResponse" examples: ex1: value: Policy: + ResourcesCount: 0 + PolicyName: example-user-policy + PolicyDefaultVersionId: v1 + Path: "/example/" CreationDate: 2010-10-01 12:34:56.789000000 +00:00 Description: Example of description + PolicyId: ABCDEFGHIJKLMNOPQRSTUVWXYZ01234 + Orn: orn:ows:idauth::012345678910:policy/example/example-user-policy IsLinkable: true LastModificationDate: 2010-10-01 12:34:56.789000000 +00:00 - Orn: orn:ows:idauth::012345678910:policy/example/example-user-policy - Path: "/example/" - PolicyDefaultVersionId: v1 - PolicyId: ABCDEFGHIJKLMNOPQRSTUVWXYZ01234 - PolicyName: example-user-policy - ResourcesCount: 0 ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadPolicyResponse" description: The HTTP 200 response (OK). tags: - Policy "/ReadPolicyVersion": - description: Lists information about a specified version of a managed policy. post: + description: Lists information about a specified version of a managed policy. operationId: ReadPolicyVersion requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadPolicyVersionRequest" examples: ex1: value: PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy VersionId: v1 - schema: - "$ref": "#/components/schemas/ReadPolicyVersionRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadPolicyVersionResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 PolicyVersion: + VersionId: v1 + DefaultVersion: true + CreationDate: 2010-10-01 12:34:56.789000000 +00:00 Body: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], "Resource": ["*"]} ]}' - CreationDate: 2010-10-01 12:34:56.789000000 +00:00 - DefaultVersion: true - VersionId: v1 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadPolicyVersionResponse" description: The HTTP 200 response (OK). tags: - Policy "/ReadPolicyVersions": - description: Lists information about all the policy versions of a specified managed - policy. post: + description: Lists information about all the policy versions of a specified + managed policy. operationId: ReadPolicyVersions requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadPolicyVersionsRequest" examples: ex1: value: FirstItem: 1 PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy ResultsPerPage: 30 - schema: - "$ref": "#/components/schemas/ReadPolicyVersionsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadPolicyVersionsResponse" examples: ex1: value: - HasMoreItems: true MaxResultsLimit: 30 - PolicyVersions: - - Body: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], - "Resource": ["*"]} ]}' - CreationDate: 2010-10-01 12:34:56.789000000 +00:00 - DefaultVersion: true - VersionId: v1 ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadPolicyVersionsResponse" + PolicyVersions: + - VersionId: v1 + DefaultVersion: true + CreationDate: 2010-10-01 12:34:56.789000000 +00:00 + Body: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], + "Resource": ["*"]} ]}' + HasMoreItems: true description: The HTTP 200 response (OK). tags: - Policy "/ReadProductTypes": - description: Lists one or more product types. post: + description: Lists one or more product types. operationId: ReadProductTypes requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadProductTypesRequest" examples: ex1: value: Filters: ProductTypeIds: - '0001' - schema: - "$ref": "#/components/schemas/ReadProductTypesRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadProductTypesResponse" examples: ex1: value: - ProductTypes: - - Description: Linux - ProductTypeId: '0001' ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadProductTypesResponse" + ProductTypes: + - ProductTypeId: '0001' + Description: Linux description: The HTTP 200 response (OK). security: [] tags: - ProductType "/ReadPublicCatalog": - description: Returns the price list of OUTSCALE products and services for the - Region specified in the endpoint of the request. For more information, see [About - Regions and Subregions](https://docs.outscale.com/en/userguide/About-Regions-and-Subregions.html). post: + description: Returns the price list of OUTSCALE products and services for the + Region specified in the endpoint of the request. For more information, see + [About Regions and Subregions](https://docs.outscale.com/en/userguide/About-Regions-and-Subregions.html). operationId: ReadPublicCatalog requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadPublicCatalogRequest" examples: ex1: value: {} - schema: - "$ref": "#/components/schemas/ReadPublicCatalogRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadPublicCatalogResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Catalog: Entries: - - Category: compute - Operation: RunInstances-OD - Service: TinaOS-FCU - SubregionName: eu-west-2 + - UnitPrice: 0.04 + Type: CustomCore:v5-p1 Title: Instance - On demand - Unite de vCore pour une instance Tina v5 CxRy Performance highest - par heure - Type: CustomCore:v5-p1 - UnitPrice: 0.04 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadPublicCatalogResponse" + SubregionName: eu-west-2 + Category: compute + Service: TinaOS-FCU + Operation: RunInstances-OD description: The HTTP 200 response (OK). security: [] tags: - PublicCatalog "/ReadPublicIpRanges": - description: Gets the public IPv4 addresses in CIDR notation for the Region specified - in the endpoint of the request. For more information, see [About Regions and - Subregions](https://docs.outscale.com/en/userguide/About-Regions-and-Subregions.html). post: + description: Gets the public IPv4 addresses in CIDR notation for the Region + specified in the endpoint of the request. For more information, see [About + Regions and Subregions](https://docs.outscale.com/en/userguide/About-Regions-and-Subregions.html). operationId: ReadPublicIpRanges requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadPublicIpRangesRequest" examples: ex1: value: {} - schema: - "$ref": "#/components/schemas/ReadPublicIpRangesRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadPublicIpRangesResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 PublicIps: - 198.51.100.0/24 - 203.0.113.0/24 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadPublicIpRangesResponse" description: The HTTP 200 response (OK). security: [] tags: - PublicIp "/ReadPublicIps": - description: |- - Lists one or more public IPs allocated to your account.
- By default, this action returns information about all your public IPs: available or associated with a virtual machine (VM), a network interface card (NIC) or a NAT service. post: + description: |- + Lists one or more public IPs allocated to your account.
+ By default, this action returns information about all your public IPs: available or associated with a virtual machine (VM), a network interface card (NIC) or a NAT service. operationId: ReadPublicIps requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadPublicIpsRequest" examples: ex1: value: @@ -20566,28 +20833,26 @@ paths: Filters: VmIds: - i-12345678 - schema: - "$ref": "#/components/schemas/ReadPublicIpsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadPublicIpsResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 PublicIps: - - LinkPublicIpId: eipassoc-12345678 + - VmId: i-12345678 + Tags: [] + PublicIpId: eipalloc-12345678 + PublicIp: 192.0.2.0 + LinkPublicIpId: eipassoc-12345678 NicAccountId: '123456789012' NicId: eni-12345678 PrivateIp: 10.0.0.4 - PublicIp: 192.0.2.0 - PublicIpId: eipalloc-12345678 - Tags: [] - VmId: i-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadPublicIpsResponse" description: The HTTP 200 response (OK). '400': content: @@ -20610,14 +20875,16 @@ paths: tags: - PublicIp "/ReadQuotas": - description: |- - Lists one or more of your quotas.

- For more information, see [About Your Account](https://docs.outscale.com/en/userguide/About-Your-Account.html). post: + description: |- + Lists one or more of your quotas.

+ For more information, see [About Your Account](https://docs.outscale.com/en/userguide/About-Your-Account.html). operationId: ReadQuotas requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadQuotasRequest" examples: ex1: summary: Reading specific quota @@ -20631,102 +20898,102 @@ paths: Filters: Collections: - VPC - schema: - "$ref": "#/components/schemas/ReadQuotasRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadQuotasResponse" examples: ex1: summary: Reading specific quota value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 QuotaTypes: - - QuotaType: global - Quotas: - - AccountId: '123456789012' + - Quotas: + - ShortDescription: Load Balancer Limit + QuotaCollection: LBU + AccountId: '123456789012' Description: Maximum number of load balancers per region MaxValue: 20 - Name: lb_limit - QuotaCollection: LBU - ShortDescription: Load Balancer Limit UsedValue: 0 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Name: lb_limit + QuotaType: global ex2: summary: Reading collection of quotas value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 QuotaTypes: - - QuotaType: global - Quotas: - - AccountId: '123456789012' + - Quotas: + - ShortDescription: Example Limit + QuotaCollection: VPC + AccountId: '123456789012' Description: Maximum number of examples MaxValue: 5 + UsedValue: 0 Name: example_limit + QuotaType: global + - Quotas: + - ShortDescription: Other Example Limit QuotaCollection: VPC - ShortDescription: Example Limit - UsedValue: 0 - - QuotaType: vpc-12345678 - Quotas: - - AccountId: '123456789012' + AccountId: '123456789012' Description: Maximum number of other examples MaxValue: 50 - Name: other_example_limit - QuotaCollection: VPC - ShortDescription: Other Example Limit UsedValue: 1 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadQuotasResponse" + Name: other_example_limit + QuotaType: vpc-12345678 description: The HTTP 200 response (OK). tags: - Quota "/ReadRegions": - description: |- - Lists one or more Regions of the OUTSCALE Cloud.

- For more information, see [About Regions and Subregions](https://docs.outscale.com/en/userguide/About-Regions-and-Subregions.html). post: + description: |- + Lists one or more Regions of the OUTSCALE Cloud.

+ For more information, see [About Regions and Subregions](https://docs.outscale.com/en/userguide/About-Regions-and-Subregions.html). operationId: ReadRegions requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadRegionsRequest" examples: ex1: value: {} - schema: - "$ref": "#/components/schemas/ReadRegionsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadRegionsResponse" examples: ex1: value: - Regions: - - Endpoint: api.eu-west-2.outscale.com - RegionName: eu-west-2 - - Endpoint: api.us-east-2.outscale.com - RegionName: us-east-2 - - Endpoint: api.us-west-1.outscale.com - RegionName: us-west-1 ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadRegionsResponse" + Regions: + - RegionName: eu-west-2 + Endpoint: api.eu-west-2.outscale.com + - RegionName: us-east-2 + Endpoint: api.us-east-2.outscale.com + - RegionName: us-west-1 + Endpoint: api.us-west-1.outscale.com description: The HTTP 200 response (OK). security: [] tags: - Region "/ReadRouteTables": - description: |- - Lists one or more of your route tables.
- In your Net, each Subnet must be associated with a route table. If a Subnet is not explicitly associated with a route table, it is implicitly associated with the main route table of the Net. post: + description: |- + Lists one or more of your route tables.
+ In your Net, each Subnet must be associated with a route table. If a Subnet is not explicitly associated with a route table, it is implicitly associated with the main route table of the Net. operationId: ReadRouteTables requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadRouteTablesRequest" examples: ex1: value: @@ -20736,37 +21003,35 @@ paths: ex2: value: Filters: - LinkRouteTableMain: true NetIds: - vpc-12345678 - vpc-87654321 - schema: - "$ref": "#/components/schemas/ReadRouteTablesRequest" + LinkRouteTableMain: true responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadRouteTablesResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 RouteTables: - - LinkRouteTables: - - LinkRouteTableId: rtbassoc-12345678 - Main: true - NetId: vpc-12345678 + - Routes: + - DestinationIpRange: 10.0.0.0/16 + CreationMethod: CreateRouteTable + State: active + LinkRouteTables: + - Main: true + LinkRouteTableId: rtbassoc-12345678 RouteTableId: rtb-12345678 + NetId: vpc-12345678 NetId: vpc-12345678 + Tags: [] RoutePropagatingVirtualGateways: [] RouteTableId: rtb-12345678 - Routes: - - CreationMethod: CreateRouteTable - DestinationIpRange: 10.0.0.0/16 - State: active - Tags: [] - schema: - "$ref": "#/components/schemas/ReadRouteTablesResponse" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -20789,14 +21054,16 @@ paths: tags: - RouteTable "/ReadSecurityGroups": - description: |- - Lists one or more security groups.
- You can specify either the name of the security groups or their IDs. post: + description: |- + Lists one or more security groups.
+ You can specify either the name of the security groups or their IDs. operationId: ReadSecurityGroups requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadSecurityGroupsRequest" examples: ex1: value: @@ -20808,39 +21075,37 @@ paths: Filters: InboundRuleIpRanges: - 192.0.2.0 - schema: - "$ref": "#/components/schemas/ReadSecurityGroupsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadSecurityGroupsResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 SecurityGroups: - - AccountId: '123456789012' + - Tags: [] + SecurityGroupName: security-group-example + OutboundRules: + - FromPortRange: -1 + IpProtocol: "-1" + ToPortRange: -1 + IpRanges: + - 0.0.0.0/0 + SecurityGroupId: sg-12345678 + AccountId: '123456789012' Description: Example of security group InboundRules: - FromPortRange: 22 IpProtocol: tcp + ToPortRange: 22 IpRanges: - 192.0.2.0 - 198.51.100.0 - ToPortRange: 22 NetId: vpc-12345678 - OutboundRules: - - FromPortRange: -1 - IpProtocol: "-1" - IpRanges: - - 0.0.0.0/0 - ToPortRange: -1 - SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - Tags: [] - schema: - "$ref": "#/components/schemas/ReadSecurityGroupsResponse" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -20863,87 +21128,89 @@ paths: tags: - SecurityGroup "/ReadServerCertificates": - description: Lists your server certificates. post: + description: Lists your server certificates. operationId: ReadServerCertificates requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadServerCertificatesRequest" examples: ex1: value: Filters: Paths: - "/example/" - schema: - "$ref": "#/components/schemas/ReadServerCertificatesRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadServerCertificatesResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ServerCertificates: - - Id: ABCDEFGHIJKLMNOPQRSTUVWXYZ1234 - Name: server-cert-example + - Path: "/example/" + Id: ABCDEFGHIJKLMNOPQRSTUVWXYZ1234 Orn: orn:ows:idauth::012345678910:server-certificate/example/server-cert-example - Path: "/example/" - schema: - "$ref": "#/components/schemas/ReadServerCertificatesResponse" + Name: server-cert-example + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - ServerCertificate "/ReadSnapshotExportTasks": - description: Lists one or more snapshot export tasks. post: + description: Lists one or more snapshot export tasks. operationId: ReadSnapshotExportTasks requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadSnapshotExportTasksRequest" examples: ex1: value: Filters: TaskIds: - snap-export-12345678 - schema: - "$ref": "#/components/schemas/ReadSnapshotExportTasksRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadSnapshotExportTasksResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 SnapshotExportTasks: - - Comment: Export of snapshot snap-12345678 + - Tags: [] + TaskId: snap-export-12345678 + Comment: Export of snapshot snap-12345678 OsuExport: - DiskImageFormat: qcow2 - OsuBucket: BUCKET OsuPrefix: PREFIX - Progress: 99 - SnapshotId: snap-12345678 + OsuBucket: BUCKET + DiskImageFormat: qcow2 State: pending - Tags: [] - TaskId: snap-export-12345678 - schema: - "$ref": "#/components/schemas/ReadSnapshotExportTasksResponse" + SnapshotId: snap-12345678 + Progress: 99 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - Snapshot "/ReadSnapshots": - description: Lists one or more snapshots that are available to you and the permissions - to create volumes from them. post: + description: Lists one or more snapshots that are available to you and the permissions + to create volumes from them. operationId: ReadSnapshots requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadSnapshotsRequest" examples: ex1: value: @@ -20958,51 +21225,49 @@ paths: TagValues: - prod - test - schema: - "$ref": "#/components/schemas/ReadSnapshotsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadSnapshotsResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Snapshots: - - AccountId: '123456789012' + - VolumeSize: 10 + AccountId: '123456789012' + VolumeId: vol-12345678 CreationDate: '2010-10-01T12:34:56.789Z' - Description: Snapshot created from a volume PermissionsToCreateVolume: - AccountIds: [] GlobalPermission: false + AccountIds: [] Progress: 100 SnapshotId: snap-12345678 State: completed + Description: Snapshot created from a volume Tags: [] - VolumeId: vol-12345678 - VolumeSize: 10 - ex2: - value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + value: Snapshots: - - AccountId: '123456789012' + - VolumeSize: 10 + AccountId: '123456789012' + VolumeId: vol-12345678 CreationDate: '2010-10-01T12:34:56.789Z' - Description: Test snapshot PermissionsToCreateVolume: - AccountIds: [] GlobalPermission: false + AccountIds: [] Progress: 100 SnapshotId: snap-12345678 State: completed + Description: Test snapshot Tags: - - Key: env - Value: test - VolumeId: vol-12345678 - VolumeSize: 10 - schema: - "$ref": "#/components/schemas/ReadSnapshotsResponse" + - Value: test + Key: env + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -21025,14 +21290,16 @@ paths: tags: - Snapshot "/ReadSubnets": - description: |- - Lists one or more of your Subnets.
- If you do not specify any Subnet ID, this action describes all of your Subnets. post: + description: |- + Lists one or more of your Subnets.
+ If you do not specify any Subnet ID, this action describes all of your Subnets. operationId: ReadSubnets requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadSubnetsRequest" examples: ex1: value: @@ -21047,28 +21314,26 @@ paths: - pending SubregionNames: - eu-west-2a - schema: - "$ref": "#/components/schemas/ReadSubnetsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadSubnetsResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Subnets: - - AvailableIpsCount: 16379 + - Tags: [] + SubregionName: eu-west-2a + SubnetId: subnet-12345678 + AvailableIpsCount: 16379 IpRange: 10.0.0.0/18 MapPublicIpOnLaunch: false - NetId: vpc-12345678 State: available - SubnetId: subnet-12345678 - SubregionName: eu-west-2a - Tags: [] - schema: - "$ref": "#/components/schemas/ReadSubnetsResponse" + NetId: vpc-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -21091,15 +21356,17 @@ paths: tags: - Subnet "/ReadSubregions": - description: |- - Lists one or more of the enabled Subregions that you can access in the current Region.

- - For more information, see [About Regions and Subregions](https://docs.outscale.com/en/userguide/About-Regions-and-Subregions.html). post: + description: |- + Lists one or more of the enabled Subregions that you can access in the current Region.

+ + For more information, see [About Regions and Subregions](https://docs.outscale.com/en/userguide/About-Regions-and-Subregions.html). operationId: ReadSubregions requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadSubregionsRequest" examples: ex1: summary: Listing a specific Subregion in the current Region @@ -21114,75 +21381,73 @@ paths: SubregionNames: - eu-west-2a - eu-west-2b - schema: - "$ref": "#/components/schemas/ReadSubregionsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadSubregionsResponse" examples: ex1: summary: Listing a specific Subregion in the current Region value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Subregions: - - LocationCode: PAR1 + - State: available RegionName: eu-west-2 - State: available SubregionName: eu-west-2a + LocationCode: PAR1 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Listing two specific Subregions in the current Region value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Subregions: - - LocationCode: PAR1 + - State: available RegionName: eu-west-2 - State: available SubregionName: eu-west-2a - - LocationCode: PAR4 + LocationCode: PAR1 + - State: available RegionName: eu-west-2 - State: available SubregionName: eu-west-2b - schema: - "$ref": "#/components/schemas/ReadSubregionsResponse" + LocationCode: PAR4 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - Subregion "/ReadTags": - description: Lists one or more tags for your resources. post: + description: Lists one or more tags for your resources. operationId: ReadTags requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadTagsRequest" examples: ex1: value: Filters: - Keys: - - key1 ResourceTypes: - snapshot - schema: - "$ref": "#/components/schemas/ReadTagsRequest" + Keys: + - key1 responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadTagsResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Tags: - - Key: key1 - ResourceId: snap-12345678 + - Value: value1 ResourceType: snapshot - Value: value1 - schema: - "$ref": "#/components/schemas/ReadTagsResponse" + ResourceId: snap-12345678 + Key: key1 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -21205,59 +21470,61 @@ paths: tags: - Tag "/ReadUnitPrice": - description: Gets unit price information for the specified parameters. post: + description: Gets unit price information for the specified parameters. operationId: ReadUnitPrice requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadUnitPriceRequest" examples: ex1: value: Operation: CreateVolume Service: TinaOS-FCU Type: BSU:VolumeIOPS:io1 - schema: - "$ref": "#/components/schemas/ReadUnitPriceRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadUnitPriceResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 UnitPriceEntry: + UnitPrice: 0.01 + Unit: PER_IOPS_PER_MONTH Currency: EUR Operation: CreateVolume - Service: TinaOS-FCU Type: BSU:VolumeIOPS:io1 - Unit: PER_IOPS_PER_MONTH - UnitPrice: 0.01 - schema: - "$ref": "#/components/schemas/ReadUnitPriceResponse" + Service: TinaOS-FCU description: The HTTP 200 response (OK). tags: - Catalog "/ReadUserGroup": - description: Lists information about a specified user group, including its users. post: + description: Lists information about a specified user group, including its users. operationId: ReadUserGroup requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadUserGroupRequest" examples: ex1: value: Path: "/example/" UserGroupName: example-usergroup - schema: - "$ref": "#/components/schemas/ReadUserGroupRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadUserGroupResponse" examples: ex1: value: @@ -21277,18 +21544,18 @@ paths: UserEmail: user@example.com UserId: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 UserName: example-user - schema: - "$ref": "#/components/schemas/ReadUserGroupResponse" description: The HTTP 200 response (OK). tags: - UserGroup "/ReadUserGroupPolicies": - description: Lists the names of the inline policies embedded in a specific group. post: + description: Lists the names of the inline policies embedded in a specific group. operationId: ReadUserGroupPolicies requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadUserGroupPoliciesRequest" examples: ex1: value: @@ -21296,15 +21563,17 @@ paths: ResultsPerPage: 30 UserGroupName: example-usergroup UserGroupPath: "/example/" - schema: - "$ref": "#/components/schemas/ReadUserGroupPoliciesRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadUserGroupPoliciesResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 HasMoreItems: true MaxResultsLimit: 30 MaxResultsTruncated: true @@ -21312,56 +21581,54 @@ paths: - Body: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], "Resource": ["*"]} ]}' Name: example-policy - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadUserGroupPoliciesResponse" description: The HTTP 200 response (OK). tags: - Policy "/ReadUserGroupPolicy": - description: Returns information about an inline policy included in a specified - group. post: + description: Returns information about an inline policy included in a specified + group. operationId: ReadUserGroupPolicy requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadUserGroupPolicyRequest" examples: ex1: value: PolicyName: example-policy UserGroupName: example-usergroup UserGroupPath: "/example/" - schema: - "$ref": "#/components/schemas/ReadUserGroupPolicyRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadUserGroupPolicyResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Policy: Body: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], "Resource": ["*"]} ]}' Name: example-policy - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadUserGroupPolicyResponse" description: The HTTP 200 response (OK). tags: - Policy "/ReadUserGroups": - description: |- - Lists all the user groups of the account.
- The response can be filtered using either the PathPrefix or the UserGroupIds. post: + description: |- + Lists all the user groups of the account.
+ The response can be filtered using either the PathPrefix or the UserGroupIds. operationId: ReadUserGroups requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadUserGroupsRequest" examples: ex1: value: @@ -21371,20 +21638,20 @@ paths: - ug-12345678 FirstItem: 1 ResultsPerPage: 30 - schema: - "$ref": "#/components/schemas/ReadUserGroupsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadUserGroupsResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 HasMoreItems: true MaxResultsLimit: 30 MaxResultsTruncated: true - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 UserGroups: - CreationDate: '2010-10-01T12:34:56.789Z' LastModificationDate: '2010-10-01T12:34:56.789Z' @@ -21392,29 +21659,29 @@ paths: Orn: orn:ows:idauth::012345678910:usergroup/example/usergroup-example Path: "/example/" UserGroupId: ug-12345678 - schema: - "$ref": "#/components/schemas/ReadUserGroupsResponse" description: The HTTP 200 response (OK). tags: - UserGroup "/ReadUserGroupsPerUser": - description: Lists the groups a specified user belongs to. post: + description: Lists the groups a specified user belongs to. operationId: ReadUserGroupsPerUser requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadUserGroupsPerUserRequest" examples: ex1: value: UserName: example-user UserPath: "/example/" - schema: - "$ref": "#/components/schemas/ReadUserGroupsPerUserRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadUserGroupsPerUserResponse" examples: ex1: value: @@ -21427,28 +21694,28 @@ paths: Orn: orn:ows:idauth::012345678910:usergroup/example/usergroup-example Path: "/example/" UserGroupId: ug-12345678 - schema: - "$ref": "#/components/schemas/ReadUserGroupsPerUserResponse" description: The HTTP 200 response (OK). tags: - UserGroup "/ReadUserPolicies": - description: Lists the names of inline policies included in a specified user. post: + description: Lists the names of inline policies included in a specified user. operationId: ReadUserPolicies requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadUserPoliciesRequest" examples: ex1: value: UserName: example-user - schema: - "$ref": "#/components/schemas/ReadUserPoliciesRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadUserPoliciesResponse" examples: ex1: value: @@ -21456,30 +21723,30 @@ paths: - example-policy ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadUserPoliciesResponse" description: The HTTP 200 response (OK). tags: - Policy "/ReadUserPolicy": - description: Returns information about an inline policy included in a specified - user. post: + description: Returns information about an inline policy included in a specified + user. operationId: ReadUserPolicy requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadUserPolicyRequest" examples: ex1: value: - PolicyName: example-user-policy UserName: example-user - schema: - "$ref": "#/components/schemas/ReadUserPolicyRequest" + PolicyName: example-user-policy responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadUserPolicyResponse" examples: ex1: value: @@ -21487,54 +21754,54 @@ paths: ["*"], "Resource": ["*"]} ]}' PolicyName: example-user-policy UserName: example-user - schema: - "$ref": "#/components/schemas/ReadUserPolicyResponse" description: The HTTP 200 response (OK). tags: - Policy "/ReadUsers": - description: |- - Lists all EIM users in the account.
- The response can be filtered using the UserIds. post: + description: |- + Lists all EIM users in the account.
+ The response can be filtered using the UserIds. operationId: ReadUsers requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadUsersRequest" examples: ex1: value: Filters: UserIds: - ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 - schema: - "$ref": "#/components/schemas/ReadUsersRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadUsersResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Users: - - Path: "/documentation/" - UserEmail: user@example.com - UserId: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 + - UserEmail: user@example.com UserName: example-user - schema: - "$ref": "#/components/schemas/ReadUsersResponse" + UserId: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 + Path: "/documentation/" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - User "/ReadVirtualGateways": - description: Lists one or more virtual gateways. post: + description: Lists one or more virtual gateways. operationId: ReadVirtualGateways requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadVirtualGatewaysRequest" examples: ex1: value: @@ -21544,90 +21811,88 @@ paths: ex2: value: Filters: + States: + - available LinkStates: - attached - detached - States: - - available - schema: - "$ref": "#/components/schemas/ReadVirtualGatewaysRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadVirtualGatewaysResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VirtualGateways: - - ConnectionType: ipsec.1 + - VirtualGatewayId: vgw-12345678 + ConnectionType: ipsec.1 NetToVirtualGatewayLinks: [] State: available Tags: [] - VirtualGatewayId: vgw-12345678 - ex2: - value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + value: VirtualGateways: - - ConnectionType: ipsec.1 + - VirtualGatewayId: vgw-12345678 + ConnectionType: ipsec.1 NetToVirtualGatewayLinks: - - NetId: vpc-12345678 - State: attached + - State: attached + NetId: vpc-12345678 State: available Tags: [] - VirtualGatewayId: vgw-12345678 - schema: - "$ref": "#/components/schemas/ReadVirtualGatewaysResponse" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - VirtualGateway "/ReadVmGroups": - description: |- - > [WARNING]
- > This feature is currently under development and may not function properly.
- - Lists one or more group of virtual machines (VMs). post: + description: |- + > [WARNING]
+ > This feature is currently under development and may not function properly.
+ + Lists one or more group of virtual machines (VMs). operationId: ReadVmGroups requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadVmGroupsRequest" examples: ex1: value: Filters: VmGroupIds: - vmgroup-12345678901234567890123456789012 - schema: - "$ref": "#/components/schemas/ReadVmGroupsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadVmGroupsResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VmGroups: - - CreationDate: 2010-10-01 12:34:56.789000000 +00:00 - PositioningStrategy: attract - SecurityGroupIds: + - SecurityGroupIds: - sg-87654321 - State: available - SubnetId: subnet-12345678 - Tags: - - Key: key1 - Value: value1 - VmCount: 1 - VmGroupId: vmgroup-12345678901234567890123456789012 - VmGroupName: ClusterLog-PPD01 VmIds: - i-12345678 - schema: - "$ref": "#/components/schemas/ReadVmGroupsResponse" + CreationDate: 2010-10-01 12:34:56.789000000 +00:00 + VmCount: 1 + VmGroupName: ClusterLog-PPD01 + SubnetId: subnet-12345678 + PositioningStrategy: attract + State: available + VmGroupId: vmgroup-12345678901234567890123456789012 + Tags: + - Value: value1 + Key: key1 description: The HTTP 200 response (OK). '400': content: @@ -21650,16 +21915,18 @@ paths: tags: - VmGroup "/ReadVmTemplates": - description: |- - > [WARNING]
- > This feature is currently under development and may not function properly.
- - Lists one or more virtual machine (VM) templates. post: + description: |- + > [WARNING]
+ > This feature is currently under development and may not function properly.
+ + Lists one or more virtual machine (VM) templates. operationId: ReadVmTemplates requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadVmTemplatesRequest" examples: ex1: value: @@ -21673,79 +21940,79 @@ paths: - 2 CpuGenerations: - v4 - schema: - "$ref": "#/components/schemas/ReadVmTemplatesRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadVmTemplatesResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VmTemplates: - - CpuCores: 2 - CpuGeneration: v4 + - VmTemplateName: vmtemplate-example CpuPerformance: high CreationDate: 2010-10-01 12:34:56.789000000 +00:00 + CpuCores: 2 + Tags: [] Description: '' ImageId: ami-12345678 - Ram: 2 - Tags: [] + CpuGeneration: v4 VmTemplateId: vmtemplate-98765432109876543210987654321012 - VmTemplateName: vmtemplate-example - schema: - "$ref": "#/components/schemas/ReadVmTemplatesResponse" + Ram: 2 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - VmTemplate "/ReadVmTypes": - description: Lists one or more predefined VM types. post: + description: Lists one or more predefined VM types. operationId: ReadVmTypes requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadVmTypesRequest" examples: ex1: value: Filters: VmTypeNames: - t2.small - schema: - "$ref": "#/components/schemas/ReadVmTypesRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadVmTypesResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VmTypes: - - BsuOptimized: false + - VolumeCount: 0 + VmTypeName: t2.small + BsuOptimized: false MaxPrivateIps: 4 MemorySize: 2 VcoreCount: 1 - VmTypeName: t2.small - VolumeCount: 0 - schema: - "$ref": "#/components/schemas/ReadVmTypesResponse" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). security: [] tags: - Vm "/ReadVms": - description: |- - Lists one or more of your virtual machines (VMs).
- If you provide one or more VM IDs, this action returns a description for all of these VMs. If you do not provide any VM ID, this action returns a description for all of the VMs that belong to you. If you provide an invalid VM ID, an error is returned. If you provide the ID of a VM that does not belong to you, the description of this VM is not included in the response. The refresh interval for data returned by this action is one hour, meaning that a terminated VM may appear in the response. post: + description: |- + Lists one or more of your virtual machines (VMs).
+ If you provide one or more VM IDs, this action returns a description for all of these VMs. If you do not provide any VM ID, this action returns a description for all of the VMs that belong to you. If you provide an invalid VM ID, an error is returned. If you provide the ID of a VM that does not belong to you, the description of this VM is not included in the response. The refresh interval for data returned by this action is one hour, meaning that a terminated VM may appear in the response. operationId: ReadVms requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadVmsRequest" examples: ex1: value: @@ -21760,87 +22027,85 @@ paths: TagValues: - prod - test - schema: - "$ref": "#/components/schemas/ReadVmsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadVmsResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Vms: - - ActionsOnNextBoot: - SecureBoot: none + - VmType: tinav5.c1r1p2 + VmInitiatedShutdownBehavior: stop + State: running + StateReason: '' + RootDeviceType: ebs + RootDeviceName: "/dev/sda1" + IsSourceDestChecked: true + KeypairName: keypair-example + ImageId: ami-12345678 + DeletionProtection: false + BootMode: legacy Architecture: x86_64 + NestedVirtualization: false BlockDeviceMappings: - - Bsu: - DeleteOnVmDeletion: true - LinkDate: '2010-10-01T12:34:56.789Z' - State: attached + - DeviceName: "/dev/sda1" + Bsu: VolumeId: vol-12345678 - DeviceName: "/dev/sda1" - BootMode: legacy - BsuOptimized: false - CreationDate: '2010-10-01T12:34:56.789Z' - DeletionProtection: false - Hypervisor: xen - ImageId: ami-12345678 - IsSourceDestChecked: true - KeypairName: keypair-example + State: attached + LinkDate: '2010-10-01T12:34:56.789Z' + DeleteOnVmDeletion: true + VmId: i-12345678 + ReservationId: r-12345678 + Hypervisor: xen + Placement: + Tenancy: default + SubregionName: eu-west-2a + ProductCodes: + - '0001' + CreationDate: '2010-10-01T12:34:56.789Z' + UserData: '' + SubnetId: subnet-12345678 + PrivateIp: 10.0.0.4 + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 + BsuOptimized: false LaunchNumber: 0 - NestedVirtualization: false NetId: vpc-12345678 Nics: - - AccountId: '123456789012' - Description: Primary network interface - IsSourceDestChecked: true + - SubnetId: subnet-12345678 + State: in-use LinkNic: - DeleteOnVmDeletion: true + State: attached DeviceNumber: 0 LinkNicId: eni-attach-12345678 - State: attached + DeleteOnVmDeletion: true + IsSourceDestChecked: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + Description: Primary network interface + AccountId: '123456789012' + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - IsPrimary: true - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - SecurityGroups: - - SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - State: in-use - SubnetId: subnet-12345678 + IsPrimary: true Performance: high - Placement: - SubregionName: eu-west-2a - Tenancy: default - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal - PrivateIp: 10.0.0.4 - ProductCodes: - - '0001' - ReservationId: r-12345678 - RootDeviceName: "/dev/sda1" - RootDeviceType: ebs - SecurityGroups: - - SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - State: running - StateReason: '' - SubnetId: subnet-12345678 Tags: - - Key: env - Value: prod - UserData: '' - VmId: i-12345678 - VmInitiatedShutdownBehavior: stop - VmType: tinav5.c1r1p2 - schema: - "$ref": "#/components/schemas/ReadVmsResponse" + - Value: prod + Key: env + ActionsOnNextBoot: + SecureBoot: none + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -21863,50 +22128,52 @@ paths: tags: - Vm "/ReadVmsHealth": - description: Lists the state of one or more backend virtual machines (VMs) registered - with a specified load balancer. post: + description: Lists the state of one or more backend virtual machines (VMs) registered + with a specified load balancer. operationId: ReadVmsHealth requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadVmsHealthRequest" examples: ex1: value: + LoadBalancerName: example-lbu BackendVmIds: - i-12345678 - i-87654321 - LoadBalancerName: example-lbu - schema: - "$ref": "#/components/schemas/ReadVmsHealthRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadVmsHealthResponse" examples: ex1: value: - BackendVmHealth: - - State: UP - VmId: i-12345678 - - Description: Instance registration is pending - State: DOWN - StateReason: ELB - VmId: i-87654321 ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadVmsHealthResponse" + BackendVmHealth: + - VmId: i-12345678 + State: UP + - VmId: i-87654321 + StateReason: ELB + State: DOWN + Description: Instance registration is pending description: The HTTP 200 response (OK). tags: - LoadBalancer "/ReadVmsState": - description: Lists the status of one or more virtual machines (VMs). post: + description: Lists the status of one or more virtual machines (VMs). operationId: ReadVmsState requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadVmsStateRequest" examples: ex1: value: @@ -21916,37 +22183,35 @@ paths: Filters: SubregionNames: - eu-west-2a - schema: - "$ref": "#/components/schemas/ReadVmsStateRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadVmsStateResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VmStates: - - MaintenanceEvents: [] - SubregionName: eu-west-2a - VmId: i-12345678 + - VmId: i-12345678 VmState: running - - MaintenanceEvents: [] SubregionName: eu-west-2a - VmId: i-87654321 + MaintenanceEvents: [] + - VmId: i-87654321 VmState: stopped - ex2: - value: + SubregionName: eu-west-2a + MaintenanceEvents: [] ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + value: VmStates: - - MaintenanceEvents: [] - SubregionName: eu-west-2a - VmId: i-12345678 + - VmId: i-12345678 VmState: running - schema: - "$ref": "#/components/schemas/ReadVmsStateResponse" + SubregionName: eu-west-2a + MaintenanceEvents: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -21969,12 +22234,14 @@ paths: tags: - Vm "/ReadVolumes": - description: Lists one or more specified Block Storage Unit (BSU) volumes. post: + description: Lists one or more specified Block Storage Unit (BSU) volumes. operationId: ReadVolumes requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadVolumesRequest" examples: ex1: value: @@ -21989,34 +22256,32 @@ paths: VolumeTypes: - gp2 - io1 - schema: - "$ref": "#/components/schemas/ReadVolumesRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadVolumesResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Volumes: - - CreationDate: '2010-10-01T12:34:56.789Z' + - VolumeId: vol-12345678 + Tags: [] + VolumeType: gp2 + SubregionName: eu-west-2a + State: in-use + CreationDate: '2010-10-01T12:34:56.789Z' Iops: 100 LinkedVolumes: - - DeleteOnVmDeletion: false + - VolumeId: vol-12345678 + DeleteOnVmDeletion: false DeviceName: "/dev/sdb" State: attached VmId: i-12345678 - VolumeId: vol-12345678 Size: 10 - State: in-use - SubregionName: eu-west-2a - Tags: [] - VolumeId: vol-12345678 - VolumeType: gp2 - schema: - "$ref": "#/components/schemas/ReadVolumesResponse" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -22039,12 +22304,14 @@ paths: tags: - Volume "/ReadVpnConnections": - description: Lists one or more VPN connections. post: + description: Lists one or more VPN connections. operationId: ReadVpnConnections requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadVpnConnectionsRequest" examples: ex1: value: @@ -22059,64 +22326,62 @@ paths: VirtualGatewayIds: - vgw-12345678 - vgw-87654321 - schema: - "$ref": "#/components/schemas/ReadVpnConnectionsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadVpnConnectionsResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VpnConnections: - - ClientGatewayConfiguration: "..." - ClientGatewayId: cgw-12345678 + - Routes: [] + Tags: [] + ClientGatewayConfiguration: "..." + StaticRoutesOnly: true + VirtualGatewayId: vgw-12345678 ConnectionType: ipsec.1 - Routes: [] + ClientGatewayId: cgw-12345678 State: pending - StaticRoutesOnly: true - Tags: [] VgwTelemetries: - - AcceptedRouteCount: 0 + - StateDescription: IPSEC IS DOWN + AcceptedRouteCount: 0 LastStateChangeDate: '2017-05-10T12:34:56.789Z' OutsideIpAddress: 192.0.2.0 - StateDescription: IPSEC IS DOWN - VirtualGatewayId: vgw-12345678 VpnConnectionId: vpn-12345678 - schema: - "$ref": "#/components/schemas/ReadVpnConnectionsResponse" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - VpnConnection "/RebootVms": - description: |- - Reboots one or more virtual machines (VMs).
- This operation sends a reboot request to one or more specified VMs. This is an asynchronous action that queues this reboot request. This action only reboots VMs that are valid and that belong to you. post: + description: |- + Reboots one or more virtual machines (VMs).
+ This operation sends a reboot request to one or more specified VMs. This is an asynchronous action that queues this reboot request. This action only reboots VMs that are valid and that belong to you. operationId: RebootVms requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/RebootVmsRequest" examples: ex1: value: VmIds: - i-12345678 - schema: - "$ref": "#/components/schemas/RebootVmsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/RebootVmsResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/RebootVmsResponse" description: The HTTP 200 response (OK). '400': content: @@ -22139,66 +22404,66 @@ paths: tags: - Vm "/RegisterVmsInLoadBalancer": - description: |- - > [WARNING]
- > Deprecated: This call is deprecated and will be removed.
- - Registers one or more virtual machines (VMs) with a specified load balancer.
- The VMs can be in different Subnets and different Subregions than the load balancer, as long as the VMs and load balancers are all in the public Cloud or all in the same Net. It may take a little time for a VM to be registered with the load balancer. Once the VM is registered with a load balancer, it receives traffic and requests from this load balancer and is called a backend VM. post: + description: |- + > [WARNING]
+ > Deprecated: This call is deprecated and will be removed.
+ + Registers one or more virtual machines (VMs) with a specified load balancer.
+ The VMs can be in different Subnets and different Subregions than the load balancer, as long as the VMs and load balancers are all in the public Cloud or all in the same Net. It may take a little time for a VM to be registered with the load balancer. Once the VM is registered with a load balancer, it receives traffic and requests from this load balancer and is called a backend VM. operationId: RegisterVmsInLoadBalancer requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/RegisterVmsInLoadBalancerRequest" examples: ex1: value: + LoadBalancerName: example-lbu BackendVmIds: - i-12345678 - i-87654321 - LoadBalancerName: example-lbu - schema: - "$ref": "#/components/schemas/RegisterVmsInLoadBalancerRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/RegisterVmsInLoadBalancerResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/RegisterVmsInLoadBalancerResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer "/RejectNetPeering": - description: |- - Rejects a Net peering request.
- The Net peering must be in the `pending-acceptance` state to be rejected. The rejected Net peering is then in the `rejected` state. post: + description: |- + Rejects a Net peering request.
+ The Net peering must be in the `pending-acceptance` state to be rejected. The rejected Net peering is then in the `rejected` state. operationId: RejectNetPeering requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/RejectNetPeeringRequest" examples: ex1: value: NetPeeringId: pcx-12345678 - schema: - "$ref": "#/components/schemas/RejectNetPeeringRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/RejectNetPeeringResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/RejectNetPeeringResponse" description: The HTTP 200 response (OK). '400': content: @@ -22227,12 +22492,14 @@ paths: tags: - NetPeering "/RemoveUserFromUserGroup": - description: Removes a specified user from a specified group. post: + description: Removes a specified user from a specified group. operationId: RemoveUserFromUserGroup requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/RemoveUserFromUserGroupRequest" examples: ex1: value: @@ -22240,53 +22507,51 @@ paths: UserGroupPath: "/example/" UserName: example-user UserPath: "/example/" - schema: - "$ref": "#/components/schemas/RemoveUserFromUserGroupRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/RemoveUserFromUserGroupResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/RemoveUserFromUserGroupResponse" description: The HTTP 200 response (OK). tags: - UserGroup "/ScaleDownVmGroup": - description: |- - > [WARNING]
- > This feature is currently under development and may not function properly.
- - Deletes virtual machines (VMs) from a VM group.
- The oldest VMs are the first to be deleted. post: + description: |- + > [WARNING]
+ > This feature is currently under development and may not function properly.
+ + Deletes virtual machines (VMs) from a VM group.
+ The oldest VMs are the first to be deleted. operationId: ScaleDownVmGroup requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ScaleDownVmGroupRequest" examples: ex1: summary: Removing 1 VM from a VM group value: VmGroupId: vmgroup-12345678901234567890123456789012 VmSubtraction: 1 - schema: - "$ref": "#/components/schemas/ScaleDownVmGroupRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ScaleDownVmGroupResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ScaleDownVmGroupResponse" description: The HTTP 200 response (OK). '400': content: @@ -22309,36 +22574,36 @@ paths: tags: - VmGroup "/ScaleUpVmGroup": - description: |- - > [WARNING]
- > This feature is currently under development and may not function properly.
- - Creates additional virtual machines (VMs) in a VM group.
- The new VMs use the current version of the VM template. post: + description: |- + > [WARNING]
+ > This feature is currently under development and may not function properly.
+ + Creates additional virtual machines (VMs) in a VM group.
+ The new VMs use the current version of the VM template. operationId: ScaleUpVmGroup requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ScaleUpVmGroupRequest" examples: ex1: summary: Adding 2 VMs in a VM group value: - VmAddition: 2 VmGroupId: vmgroup-12345678901234567890123456789012 - schema: - "$ref": "#/components/schemas/ScaleUpVmGroupRequest" + VmAddition: 2 responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ScaleUpVmGroupResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ScaleUpVmGroupResponse" description: The HTTP 200 response (OK). '400': content: @@ -22361,66 +22626,66 @@ paths: tags: - VmGroup "/SetDefaultPolicyVersion": - description: |- - Sets a specified version of a managed policy as the default (operative) one.
- You can modify the default version of a policy at any time. post: + description: |- + Sets a specified version of a managed policy as the default (operative) one.
+ You can modify the default version of a policy at any time. operationId: SetDefaultPolicyVersion requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/SetDefaultPolicyVersionRequest" examples: ex1: value: PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy VersionId: v1 - schema: - "$ref": "#/components/schemas/SetDefaultPolicyVersionRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/SetDefaultPolicyVersionResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/SetDefaultPolicyVersionResponse" description: The HTTP 200 response (OK). tags: - Policy "/StartVms": - description: |- - Start one or more virtual machines (VMs).
- You can start only VMs that are valid and that belong to you. post: + description: |- + Start one or more virtual machines (VMs).
+ You can start only VMs that are valid and that belong to you. operationId: StartVms requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/StartVmsRequest" examples: ex1: value: VmIds: - i-12345678 - schema: - "$ref": "#/components/schemas/StartVmsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/StartVmsResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Vms: - - CurrentState: pending + - VmId: i-12345678 PreviousState: stopped - VmId: i-12345678 - schema: - "$ref": "#/components/schemas/StartVmsResponse" + CurrentState: pending + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -22443,36 +22708,36 @@ paths: tags: - Vm "/StopVms": - description: |- - Stops one or more running virtual machines (VMs).
- You can stop only VMs that are valid and that belong to you. Data stored in the VM RAM is lost. post: + description: |- + Stops one or more running virtual machines (VMs).
+ You can stop only VMs that are valid and that belong to you. Data stored in the VM RAM is lost. operationId: StopVms requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/StopVmsRequest" examples: ex1: value: VmIds: - i-12345678 - schema: - "$ref": "#/components/schemas/StopVmsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/StopVmsResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Vms: - - CurrentState: stopping + - VmId: i-12345678 PreviousState: running - VmId: i-12345678 - schema: - "$ref": "#/components/schemas/StopVmsResponse" + CurrentState: stopping + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -22495,61 +22760,61 @@ paths: tags: - Vm "/UnlinkFlexibleGpu": - description: |- - Detaches a flexible GPU (fGPU) from a virtual machine (VM).
- The fGPU is in the `detaching` state until the VM is stopped, after which it becomes `allocated`. It is then available again for attachment to a VM. post: + description: |- + Detaches a flexible GPU (fGPU) from a virtual machine (VM).
+ The fGPU is in the `detaching` state until the VM is stopped, after which it becomes `allocated`. It is then available again for attachment to a VM. operationId: UnlinkFlexibleGpu requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkFlexibleGpuRequest" examples: ex1: value: FlexibleGpuId: fgpu-12345678 - schema: - "$ref": "#/components/schemas/UnlinkFlexibleGpuRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkFlexibleGpuResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UnlinkFlexibleGpuResponse" description: The HTTP 200 response (OK). tags: - FlexibleGpu "/UnlinkInternetService": - description: |- - Detaches an internet service from a Net.
- This action disables and detaches an internet service from a Net. The Net must not contain virtual machines (VMs) using public IPs nor internet-facing load balancers. post: + description: |- + Detaches an internet service from a Net.
+ This action disables and detaches an internet service from a Net. The Net must not contain virtual machines (VMs) using public IPs nor internet-facing load balancers. operationId: UnlinkInternetService requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkInternetServiceRequest" examples: ex1: value: InternetServiceId: igw-12345678 NetId: vpc-12345678 - schema: - "$ref": "#/components/schemas/UnlinkInternetServiceRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkInternetServiceResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UnlinkInternetServiceResponse" description: The HTTP 200 response (OK). '400': content: @@ -22572,34 +22837,37 @@ paths: tags: - InternetService "/UnlinkLoadBalancerBackendMachines": - description: Detaches one or more backend virtual machines (VMs) from a load balancer. - You need to specify at least the `BackendIps` or the `BackendVmIds` parameter. post: + description: Detaches one or more backend virtual machines (VMs) from a load + balancer. You need to specify at least the `BackendIps` or the `BackendVmIds` + parameter. operationId: UnlinkLoadBalancerBackendMachines requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkLoadBalancerBackendMachinesRequest" examples: ex1: summary: Unlinking VMs from a load balancer value: + LoadBalancerName: example-lbu BackendVmIds: - i-12345678 - i-87654321 - LoadBalancerName: example-lbu ex2: summary: Unlinking public IPs from a load balancer value: + LoadBalancerName: example-lbu BackendIps: - 192.0.2.0 - 198.51.100.0 - LoadBalancerName: example-lbu - schema: - "$ref": "#/components/schemas/UnlinkLoadBalancerBackendMachinesRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkLoadBalancerBackendMachinesResponse" examples: ex1: summary: Unlinking VMs from a load balancer @@ -22611,65 +22879,63 @@ paths: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UnlinkLoadBalancerBackendMachinesResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer "/UnlinkManagedPolicyFromUserGroup": - description: Unlinks a managed policy from a specific group. post: + description: Unlinks a managed policy from a specific group. operationId: UnlinkManagedPolicyFromUserGroup requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkManagedPolicyFromUserGroupRequest" examples: ex1: value: PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy UserGroupName: example-usergroup - schema: - "$ref": "#/components/schemas/UnlinkManagedPolicyFromUserGroupRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkManagedPolicyFromUserGroupResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UnlinkManagedPolicyFromUserGroupResponse" description: The HTTP 200 response (OK). tags: - Policy "/UnlinkNic": - description: |- - Detaches a network interface card (NIC) from a virtual machine (VM).
- The primary NIC cannot be detached. post: + description: |- + Detaches a network interface card (NIC) from a virtual machine (VM).
+ The primary NIC cannot be detached. operationId: UnlinkNic requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkNicRequest" examples: ex1: value: LinkNicId: eni-attach-12345678 - schema: - "$ref": "#/components/schemas/UnlinkNicRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkNicResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UnlinkNicResponse" description: The HTTP 200 response (OK). '400': content: @@ -22692,41 +22958,43 @@ paths: tags: - Nic "/UnlinkPolicy": - description: Removes a managed policy from a specific user. post: + description: Removes a managed policy from a specific user. operationId: UnlinkPolicy requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkPolicyRequest" examples: ex1: value: PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy UserName: example-user - schema: - "$ref": "#/components/schemas/UnlinkPolicyRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkPolicyResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UnlinkPolicyResponse" description: The HTTP 200 response (OK). tags: - Policy "/UnlinkPrivateIps": - description: Unassigns one or more secondary private IPs from a network interface - card (NIC). post: + description: Unassigns one or more secondary private IPs from a network interface + card (NIC). operationId: UnlinkPrivateIps requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkPrivateIpsRequest" examples: ex1: value: @@ -22734,19 +23002,17 @@ paths: PrivateIps: - 10.0.0.6 - 10.0.0.7 - schema: - "$ref": "#/components/schemas/UnlinkPrivateIpsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkPrivateIpsResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UnlinkPrivateIpsResponse" description: The HTTP 200 response (OK). '400': content: @@ -22769,33 +23035,33 @@ paths: tags: - Nic "/UnlinkPublicIp": - description: |- - Disassociates a public IP from the virtual machine (VM) or network interface card (NIC) it is associated with.

- - **[IMPORTANT]**
- To disassociate the public IP from a NAT service, you need to delete the NAT service. For more information, see the [DeleteNatService](#deletenatservice) method. post: + description: |- + Disassociates a public IP from the virtual machine (VM) or network interface card (NIC) it is associated with.

+ + **[IMPORTANT]**
+ To disassociate the public IP from a NAT service, you need to delete the NAT service. For more information, see the [DeleteNatService](#deletenatservice) method. operationId: UnlinkPublicIp requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkPublicIpRequest" examples: ex1: value: PublicIp: 192.0.2.0 - schema: - "$ref": "#/components/schemas/UnlinkPublicIpRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkPublicIpResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UnlinkPublicIpResponse" description: The HTTP 200 response (OK). '400': content: @@ -22818,31 +23084,31 @@ paths: tags: - PublicIp "/UnlinkRouteTable": - description: |- - Disassociates a Subnet from a route table.
- After disassociation, the Subnet can no longer use the routes in this route table, but uses the routes in the main route table of the Net instead. post: + description: |- + Disassociates a Subnet from a route table.
+ After disassociation, the Subnet can no longer use the routes in this route table, but uses the routes in the main route table of the Net instead. operationId: UnlinkRouteTable requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkRouteTableRequest" examples: ex1: value: LinkRouteTableId: rtbassoc-12345678 - schema: - "$ref": "#/components/schemas/UnlinkRouteTableRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkRouteTableResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UnlinkRouteTableResponse" description: The HTTP 200 response (OK). '400': content: @@ -22865,61 +23131,61 @@ paths: tags: - RouteTable "/UnlinkVirtualGateway": - description: |- - Detaches a virtual gateway from a Net.
- You must wait until the virtual gateway is in the detached state before you can attach another Net to it or delete the Net it was previously attached to. post: + description: |- + Detaches a virtual gateway from a Net.
+ You must wait until the virtual gateway is in the detached state before you can attach another Net to it or delete the Net it was previously attached to. operationId: UnlinkVirtualGateway requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkVirtualGatewayRequest" examples: ex1: value: - NetId: vpc-12345678 VirtualGatewayId: vgw-12345678 - schema: - "$ref": "#/components/schemas/UnlinkVirtualGatewayRequest" + NetId: vpc-12345678 responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkVirtualGatewayResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UnlinkVirtualGatewayResponse" description: The HTTP 200 response (OK). tags: - VirtualGateway "/UnlinkVolume": - description: |- - Detaches a Block Storage Unit (BSU) volume from a virtual machine (VM).
- To detach the root device of a VM, this VM must be stopped. post: + description: |- + Detaches a Block Storage Unit (BSU) volume from a virtual machine (VM).
+ To detach the root device of a VM, this VM must be stopped. operationId: UnlinkVolume requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkVolumeRequest" examples: ex1: value: VolumeId: vol-12345678 - schema: - "$ref": "#/components/schemas/UnlinkVolumeRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkVolumeResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UnlinkVolumeResponse" description: The HTTP 200 response (OK). '400': content: @@ -22942,21 +23208,23 @@ paths: tags: - Volume "/UpdateAccessKey": - description: |- - Modifies the attributes of the specified access key of either your root account or an EIM user.

- The parameter `ExpirationDate` is not required when updating the state of your access key. However, if you do not specify the expiration date of an access key when updating its state, it is then set to not expire. post: + description: |- + Modifies the attributes of the specified access key of either your root account or an EIM user.

+ The parameter `ExpirationDate` is not required when updating the state of your access key. However, if you do not specify the expiration date of an access key when updating its state, it is then set to not expire. operationId: UpdateAccessKey requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateAccessKeyRequest" examples: ex1: summary: Updating the expiration date of the access key value: AccessKeyId: ABCDEFGHIJ0123456789 - ExpirationDate: '2063-04-05' State: ACTIVE + ExpirationDate: '2063-04-05' ex2: summary: Updating the state of one of your own access keys (if you are the root account or an EIM user) @@ -22969,38 +23237,36 @@ paths: AccessKeyId: ABCDEFGHIJ0123456789 State: ACTIVE UserName: example-user - schema: - "$ref": "#/components/schemas/UpdateAccessKeyRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateAccessKeyResponse" examples: ex1: summary: Updating an access key when using the parameter ExpirationDate value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 AccessKey: + State: ACTIVE AccessKeyId: ABCDEFGHIJ0123456789 CreationDate: 2010-10-01 12:34:56.789000000 +00:00 ExpirationDate: 2063-04-05 00:00:00.000000000 +00:00 LastModificationDate: 2017-05-10 12:34:56.789000000 +00:00 - State: ACTIVE Tag: Group1 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Updating an access key when not using the parameter ExpirationDate value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 AccessKey: + State: ACTIVE AccessKeyId: ABCDEFGHIJ0123456789 CreationDate: 2010-10-01 12:34:56.789000000 +00:00 LastModificationDate: 2017-05-10 12:34:56.789000000 +00:00 - State: ACTIVE Tag: Group1 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UpdateAccessKeyResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -23008,58 +23274,61 @@ paths: tags: - AccessKey "/UpdateAccount": - description: Updates the account information for the account that sends the request. post: + description: Updates the account information for the account that sends the + request. operationId: UpdateAccount requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateAccountRequest" examples: ex1: value: AdditionalEmails: - another@example.com - yet.another@example.com - schema: - "$ref": "#/components/schemas/UpdateAccountRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateAccountResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Account: - AccountId: '123456789012' + ZipCode: '92210' + CompanyName: EXAMPLE SAS + FirstName: JEAN AdditionalEmails: - another@example.com - yet.another@example.com City: SAINT-CLOUD - CompanyName: EXAMPLE SAS Country: FRANCE + LastName: DUPONT + AccountId: '123456789012' CustomerId: '87654321' Email: example@example.com - FirstName: JEAN - LastName: DUPONT - ZipCode: '92210' - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UpdateAccountResponse" description: The HTTP 200 response (OK). tags: - Account "/UpdateApiAccessPolicy": - description: |- - Updates the API access policy of your account.

- - **[IMPORTANT]**
- Only one API access policy can be associated with your account. post: + description: |- + Updates the API access policy of your account.

+ + **[IMPORTANT]**
+ Only one API access policy can be associated with your account. operationId: UpdateApiAccessPolicy requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateApiAccessPolicyRequest" examples: ex1: summary: Require expiration dates of maximum 1 year @@ -23078,41 +23347,39 @@ paths: value: MaxAccessKeyExpirationSeconds: 0 RequireTrustedEnv: false - schema: - "$ref": "#/components/schemas/UpdateApiAccessPolicyRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateApiAccessPolicyResponse" examples: ex1: summary: Require expiration dates of maximum 1 year value: - ApiAccessPolicy: - MaxAccessKeyExpirationSeconds: 31536000 - RequireTrustedEnv: false ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ApiAccessPolicy: + RequireTrustedEnv: false + MaxAccessKeyExpirationSeconds: 31536000 ex2: summary: Require expiration dates of maximum 100 years and activate a trusted session value: - ApiAccessPolicy: - MaxAccessKeyExpirationSeconds: 3153600000 - RequireTrustedEnv: true ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ApiAccessPolicy: + RequireTrustedEnv: true + MaxAccessKeyExpirationSeconds: 3153600000 ex3: summary: Do not require expiration dates and deactivate a trusted session value: - ApiAccessPolicy: - MaxAccessKeyExpirationSeconds: 0 - RequireTrustedEnv: false ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UpdateApiAccessPolicyResponse" + ApiAccessPolicy: + RequireTrustedEnv: false + MaxAccessKeyExpirationSeconds: 0 description: The HTTP 200 response (OK). '400': content: @@ -23138,44 +23405,44 @@ paths: tags: - ApiAccessPolicy "/UpdateApiAccessRule": - description: |- - Modifies a specified API access rule.

- - **[WARNING]**
- - The new rule you specify fully replaces the old rule. Therefore, for a parameter that is not specified, any previously set value is deleted.
- - If, as result of your modification, you no longer have access to the APIs, you will need to contact the Support team to regain access. For more information, see [Technical Support](https://docs.outscale.com/en/userguide/Technical-Support.html). post: + description: |- + Modifies a specified API access rule.

+ + **[WARNING]**
+ - The new rule you specify fully replaces the old rule. Therefore, for a parameter that is not specified, any previously set value is deleted.
+ - If, as result of your modification, you no longer have access to the APIs, you will need to contact the Support team to regain access. For more information, see [Technical Support](https://docs.outscale.com/en/userguide/Technical-Support.html). operationId: UpdateApiAccessRule requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateApiAccessRuleRequest" examples: ex1: value: ApiAccessRuleId: aar-1234567890abcdef1234567890abcdef - Description: Allows all Ipv4 domain IpRanges: - 0.0.0.0/0 - schema: - "$ref": "#/components/schemas/UpdateApiAccessRuleRequest" + Description: Allows all Ipv4 domain responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateApiAccessRuleResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ApiAccessRule: + IpRanges: + - 0.0.0.0/0 ApiAccessRuleId: aar-1234567890abcdef1234567890abcdef CaIds: [] Cns: [] Description: Allows all IPv4 domain - IpRanges: - - 0.0.0.0/0 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UpdateApiAccessRuleResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -23183,35 +23450,35 @@ paths: tags: - ApiAccessRule "/UpdateCa": - description: Modifies the specified attribute of a Client Certificate Authority - (CA). post: + description: Modifies the specified attribute of a Client Certificate Authority + (CA). operationId: UpdateCa requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateCaRequest" examples: ex1: value: CaId: ca-fedcba0987654321fedcba0987654321 Description: New description - schema: - "$ref": "#/components/schemas/UpdateCaRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateCaResponse" examples: ex1: value: - Ca: - CaFingerprint: 1234567890abcdef1234567890abcdef12345678 - CaId: ca-fedcba0987654321fedcba0987654321 - Description: New description ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UpdateCaResponse" + Ca: + Description: New description + CaId: ca-fedcba0987654321fedcba0987654321 + CaFingerprint: 1234567890abcdef1234567890abcdef12345678 description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -23219,44 +23486,44 @@ paths: tags: - Ca "/UpdateDedicatedGroup": - description: |- - > [WARNING]
- > This feature is currently in beta.
- - Modifies the name of a specified dedicated group.
post: + description: |- + > [WARNING]
+ > This feature is currently in beta.
+ + Modifies the name of a specified dedicated group.
operationId: UpdateDedicatedGroup requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateDedicatedGroupRequest" examples: ex1: value: DedicatedGroupId: ded-12345678 Name: New-dedicated-group-name - schema: - "$ref": "#/components/schemas/UpdateDedicatedGroupRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateDedicatedGroupResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 DedicatedGroup: + VmIds: + - i-12345678 + NetIds: + - vpc-12345678 AccountId: '123456789012' CpuGeneration: 4 - DedicatedGroupId: ded-12345678 Name: New-dedicated-group-name - NetIds: - - vpc-12345678 SubregionName: eu-west-2a - VmIds: - - i-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UpdateDedicatedGroupResponse" + DedicatedGroupId: ded-12345678 description: The HTTP 200 response (OK). '400': content: @@ -23279,68 +23546,72 @@ paths: tags: - DedicatedGroup "/UpdateDirectLinkInterface": - description: Modifies the maximum transmission unit (MTU) of a DirectLink interface. post: + description: Modifies the maximum transmission unit (MTU) of a DirectLink interface. operationId: UpdateDirectLinkInterface requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateDirectLinkInterfaceRequest" examples: ex1: value: DirectLinkInterfaceId: dxvif-12345678 Mtu: 1500 - schema: - "$ref": "#/components/schemas/UpdateDirectLinkInterfaceRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateDirectLinkInterfaceResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 DirectLinkInterface: - AccountId: '123456789012' + Vlan: 101 + OutscalePrivateIp: 172.16.0.4/30 + DirectLinkInterfaceId: dxvif-12345678 BgpAsn: 65000 + AccountId: '123456789012' ClientPrivateIp: 172.16.0.5/30 - DirectLinkId: dxcon-12345678 - DirectLinkInterfaceId: dxvif-12345678 + VirtualGatewayId: vgw-12345678 DirectLinkInterfaceName: MyDirectLinkInterface - InterfaceType: private - Location: PAR1 + DirectLinkId: dxcon-12345678 Mtu: 1500 - OutscalePrivateIp: 172.16.0.4/30 State: available - VirtualGatewayId: vgw-12345678 - Vlan: 101 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UpdateDirectLinkInterfaceResponse" + InterfaceType: private + Location: PAR1 description: The HTTP 200 response (OK). tags: - DirectLinkInterface "/UpdateFlexibleGpu": - description: Modifies a flexible GPU (fGPU) behavior. post: + description: Modifies a flexible GPU (fGPU) behavior. operationId: UpdateFlexibleGpu requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateFlexibleGpuRequest" examples: ex1: value: - DeleteOnVmDeletion: false FlexibleGpuId: fgpu-12345678 - schema: - "$ref": "#/components/schemas/UpdateFlexibleGpuRequest" + DeleteOnVmDeletion: false responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateFlexibleGpuResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 FlexibleGpu: DeleteOnVmDeletion: false FlexibleGpuId: fgpu-12345678 @@ -23348,23 +23619,21 @@ paths: ModelName: nvidia-p100 State: allocated SubregionName: eu-west-2a - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UpdateFlexibleGpuResponse" description: The HTTP 200 response (OK). tags: - FlexibleGpu "/UpdateImage": - description: |- - Modifies the access permissions for an OUTSCALE machine image (OMI).
- You must specify either the `Additions` or the `Removals` parameter.
- After sharing an OMI with an account, the other account can create a copy of it that they own. For more information about copying OMIs, see [CreateImage](#createimage). post: + description: |- + Modifies the access permissions for an OUTSCALE machine image (OMI).
+ You must specify either the `Additions` or the `Removals` parameter.
+ After sharing an OMI with an account, the other account can create a copy of it that they own. For more information about copying OMIs, see [CreateImage](#createimage). operationId: UpdateImage requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateImageRequest" examples: ex1: summary: Adding permission @@ -23392,145 +23661,143 @@ paths: ex4: summary: Making an image private to everyone value: - Description: Private image ImageId: ami-12345678 + Description: Private image PermissionsToLaunch: Removals: GlobalPermission: true - schema: - "$ref": "#/components/schemas/UpdateImageRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateImageResponse" examples: ex1: summary: Adding permission value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Image: + StateComment: {} + State: available + RootDeviceType: bsu + RootDeviceName: "/dev/sda1" + ProductCodes: + - '0001' + PermissionsToLaunch: + GlobalPermission: false + AccountIds: + - '987654321098' AccountId: '123456789012' - Architecture: x86_64 + Tags: [] + Description: '' + ImageId: ami-12345678 BlockDeviceMappings: - - Bsu: + - DeviceName: "/dev/sda1" + Bsu: + VolumeType: standard DeleteOnVmDeletion: true - SnapshotId: snap-12345678 VolumeSize: 50 - VolumeType: standard - DeviceName: "/dev/sda1" + SnapshotId: snap-12345678 + ImageType: machine CreationDate: '2010-10-01T12:34:56.789Z' - Description: '' FileLocation: 123456789012/image-example - ImageId: ami-12345678 + Architecture: x86_64 ImageName: image-example - ImageType: machine - PermissionsToLaunch: - AccountIds: - - '987654321098' - GlobalPermission: false - ProductCodes: - - '0001' - RootDeviceName: "/dev/sda1" - RootDeviceType: bsu - State: available - StateComment: {} - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Removing permission value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Image: + StateComment: {} + State: available + RootDeviceType: bsu + RootDeviceName: "/dev/sda1" + ProductCodes: + - '0001' + PermissionsToLaunch: + GlobalPermission: false + AccountIds: [] AccountId: '123456789012' - Architecture: x86_64 + Tags: [] + Description: '' + ImageId: ami-12345678 BlockDeviceMappings: - - Bsu: + - DeviceName: "/dev/sda1" + Bsu: + VolumeType: standard DeleteOnVmDeletion: true - SnapshotId: snap-12345678 VolumeSize: 50 - VolumeType: standard - DeviceName: "/dev/sda1" + SnapshotId: snap-12345678 + ImageType: machine CreationDate: '2010-10-01T12:34:56.789Z' - Description: '' FileLocation: 123456789012/image-example - ImageId: ami-12345678 + Architecture: x86_64 ImageName: image-example - ImageType: machine - PermissionsToLaunch: - AccountIds: [] - GlobalPermission: false - ProductCodes: - - '0001' - RootDeviceName: "/dev/sda1" - RootDeviceType: bsu - State: available - StateComment: {} - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex3: summary: Making an image public to everyone value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Image: + StateComment: {} + State: available + RootDeviceType: bsu + RootDeviceName: "/dev/sda1" + ProductCodes: + - '0001' + PermissionsToLaunch: + GlobalPermission: true + AccountIds: [] AccountId: '123456789012' - Architecture: x86_64 + Tags: [] + Description: '' + ImageId: ami-12345678 BlockDeviceMappings: - - Bsu: + - DeviceName: "/dev/sda1" + Bsu: + VolumeType: standard DeleteOnVmDeletion: true - SnapshotId: snap-12345678 VolumeSize: 50 - VolumeType: standard - DeviceName: "/dev/sda1" + SnapshotId: snap-12345678 + ImageType: machine CreationDate: '2010-10-01T12:34:56.789Z' - Description: '' FileLocation: 123456789012/image-example - ImageId: ami-12345678 + Architecture: x86_64 ImageName: image-example - ImageType: machine - PermissionsToLaunch: - AccountIds: [] - GlobalPermission: true - ProductCodes: - - '0001' - RootDeviceName: "/dev/sda1" - RootDeviceType: bsu - State: available - StateComment: {} - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex4: summary: Making an image private to everyone value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Image: + StateComment: {} + State: available + RootDeviceType: bsu + RootDeviceName: "/dev/sda1" + ProductCodes: + - '0001' + PermissionsToLaunch: + GlobalPermission: false + AccountIds: [] AccountId: '123456789012' - Architecture: x86_64 + Tags: [] + Description: Private image + ImageId: ami-12345678 BlockDeviceMappings: - - Bsu: + - DeviceName: "/dev/sda1" + Bsu: + VolumeType: standard DeleteOnVmDeletion: true - SnapshotId: snap-12345678 VolumeSize: 50 - VolumeType: standard - DeviceName: "/dev/sda1" + SnapshotId: snap-12345678 + ImageType: machine CreationDate: '2010-10-01T12:34:56.789Z' - Description: Private image FileLocation: 123456789012/image-example - ImageId: ami-12345678 + Architecture: x86_64 ImageName: image-example - ImageType: machine - PermissionsToLaunch: - AccountIds: [] - GlobalPermission: false - ProductCodes: - - '0001' - RootDeviceName: "/dev/sda1" - RootDeviceType: bsu - State: available - StateComment: {} - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UpdateImageResponse" description: The HTTP 200 response (OK). '400': content: @@ -23553,80 +23820,82 @@ paths: tags: - Image "/UpdateListenerRule": - description: |- - Updates the pattern of the listener rule.
- This call updates the pattern matching algorithm for incoming traffic. post: + description: |- + Updates the pattern of the listener rule.
+ This call updates the pattern matching algorithm for incoming traffic. operationId: UpdateListenerRule requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateListenerRuleRequest" examples: ex1: value: - HostPattern: "*.newhost.com" ListenerRuleName: example-listener-rule - schema: - "$ref": "#/components/schemas/UpdateListenerRuleRequest" + HostPattern: "*.newhost.com" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateListenerRuleResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ListenerRule: - Action: forward - HostNamePattern: "*.newhost.com" - ListenerId: 123456 - ListenerRuleId: 1234 - ListenerRuleName: example-listener-rule Priority: 10 VmIds: - i-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UpdateListenerRuleResponse" + ListenerRuleName: example-listener-rule + Action: forward + ListenerId: 123456 + HostNamePattern: "*.newhost.com" + ListenerRuleId: 1234 description: The HTTP 200 response (OK). tags: - Listener "/UpdateLoadBalancer": - description: |- - Modifies the specified attribute of a load balancer. You can specify only one attribute at a time.

+ post: + description: |- + Modifies the specified attribute of a load balancer. You can specify only one attribute at a time.

- You can set a new SSL certificate to an SSL or HTTPS listener of a load balancer.
- This certificate replaces any certificate used on the same load balancer and port.

+ You can set a new SSL certificate to an SSL or HTTPS listener of a load balancer.
+ This certificate replaces any certificate used on the same load balancer and port.

- You can also replace the currently enabled policy for the load balancer with another one.
- If the `PolicyNames` parameter is empty, the currently enabled policy is disabled. - post: + You can also replace the currently enabled policy for the load balancer with another one.
+ If the `PolicyNames` parameter is empty, the currently enabled policy is disabled. operationId: UpdateLoadBalancer requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateLoadBalancerRequest" examples: ex1: summary: Updating health checks value: + LoadBalancerName: private-lb-example HealthCheck: - CheckInterval: 30 HealthyThreshold: 10 + CheckInterval: 30 Path: "/index.html" Port: 8080 Protocol: HTTPS Timeout: 5 UnhealthyThreshold: 5 - LoadBalancerName: private-lb-example ex2: summary: Updating access logs value: + LoadBalancerName: private-lb-example AccessLog: + PublicationInterval: 5 IsEnabled: true OsuBucketName: BUCKET OsuBucketPrefix: PREFIX - PublicationInterval: 5 - LoadBalancerName: private-lb-example ex3: summary: Updating policies value: @@ -23640,219 +23909,217 @@ paths: LoadBalancerName: private-lb-example LoadBalancerPort: 443 ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/AnotherCertificate - schema: - "$ref": "#/components/schemas/UpdateLoadBalancerRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateLoadBalancerResponse" examples: ex1: summary: Updating health checks value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 LoadBalancer: + Tags: [] + SourceSecurityGroup: + SecurityGroupName: security-group-example + SecurityGroupAccountId: '123456789012' + SecuredCookies: false + PublicIp: 192.0.2.0 + Subnets: + - subnet-12345678 + NetId: vpc-12345678 + BackendVmIds: [] + ApplicationStickyCookiePolicies: [] + SecurityGroups: + - sg-12345678 + LoadBalancerType: internet-facing AccessLog: - IsEnabled: false PublicationInterval: 60 - ApplicationStickyCookiePolicies: [] - BackendVmIds: [] + IsEnabled: false DnsName: private-lb-example.123456789.eu-west-2.lbu.outscale.com HealthCheck: + UnhealthyThreshold: 5 + Timeout: 5 CheckInterval: 30 - HealthyThreshold: 10 Path: "/index.html" - Port: 8080 Protocol: HTTPS - Timeout: 5 - UnhealthyThreshold: 5 + HealthyThreshold: 10 + Port: 8080 + LoadBalancerStickyCookiePolicies: [] + SubregionNames: + - eu-west-2a Listeners: - - BackendPort: 80 + - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate + BackendPort: 80 BackendProtocol: HTTP LoadBalancerPort: 443 LoadBalancerProtocol: HTTPS - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate LoadBalancerName: private-lb-example - LoadBalancerStickyCookiePolicies: [] - LoadBalancerType: internet-facing - NetId: vpc-12345678 - PublicIp: 192.0.2.0 - SecuredCookies: false - SecurityGroups: - - sg-12345678 - SourceSecurityGroup: - SecurityGroupAccountId: '123456789012' - SecurityGroupName: security-group-example - Subnets: - - subnet-12345678 - SubregionNames: - - eu-west-2a - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Updating access logs value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 LoadBalancer: + Tags: [] + SourceSecurityGroup: + SecurityGroupName: security-group-example + SecurityGroupAccountId: '123456789012' + SecuredCookies: false + PublicIp: 192.0.2.0 + Subnets: + - subnet-12345678 + NetId: vpc-12345678 + BackendVmIds: [] + ApplicationStickyCookiePolicies: [] + SecurityGroups: + - sg-12345678 + LoadBalancerType: internet-facing AccessLog: - IsEnabled: true - OsuBucketName: BUCKET - OsuBucketPrefix: PREFIX PublicationInterval: 5 - ApplicationStickyCookiePolicies: [] - BackendVmIds: [] + OsuBucketPrefix: PREFIX + OsuBucketName: BUCKET + IsEnabled: true DnsName: private-lb-example.123456789.eu-west-2.lbu.outscale.com HealthCheck: + UnhealthyThreshold: 2 + Timeout: 5 CheckInterval: 30 + Protocol: TCP HealthyThreshold: 10 Port: 80 - Protocol: TCP - Timeout: 5 - UnhealthyThreshold: 2 + LoadBalancerStickyCookiePolicies: [] + SubregionNames: + - eu-west-2a Listeners: - - BackendPort: 80 + - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate + BackendPort: 80 BackendProtocol: HTTP LoadBalancerPort: 443 LoadBalancerProtocol: HTTPS - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate LoadBalancerName: private-lb-example - LoadBalancerStickyCookiePolicies: [] - LoadBalancerType: internet-facing - NetId: vpc-12345678 - PublicIp: 192.0.2.0 - SecuredCookies: false - SecurityGroups: - - sg-12345678 - SourceSecurityGroup: - SecurityGroupAccountId: '123456789012' - SecurityGroupName: security-group-example - Subnets: - - subnet-12345678 - SubregionNames: - - eu-west-2a - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex3: summary: Updating policies value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 LoadBalancer: + Tags: [] + SourceSecurityGroup: + SecurityGroupName: security-group-example + SecurityGroupAccountId: '123456789012' + SecuredCookies: false + PublicIp: 192.0.2.0 + Subnets: + - subnet-12345678 + NetId: vpc-12345678 + BackendVmIds: [] + ApplicationStickyCookiePolicies: [] + SecurityGroups: + - sg-12345678 + LoadBalancerType: internet-facing AccessLog: - IsEnabled: false PublicationInterval: 60 - ApplicationStickyCookiePolicies: [] - BackendVmIds: [] + IsEnabled: false DnsName: private-lb-example.123456789.eu-west-2.lbu.outscale.com HealthCheck: + UnhealthyThreshold: 2 + Timeout: 5 CheckInterval: 30 + Protocol: TCP HealthyThreshold: 10 Port: 80 - Protocol: TCP - Timeout: 5 - UnhealthyThreshold: 2 + LoadBalancerStickyCookiePolicies: + - PolicyName: example-browser-policy + CookieExpirationPeriod: 1 + SubregionNames: + - eu-west-2a Listeners: - - BackendPort: 80 + - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate + BackendPort: 80 BackendProtocol: HTTP LoadBalancerPort: 443 LoadBalancerProtocol: HTTPS - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate LoadBalancerName: private-lb-example - LoadBalancerStickyCookiePolicies: - - CookieExpirationPeriod: 1 - PolicyName: example-browser-policy - LoadBalancerType: internet-facing - NetId: vpc-12345678 - PublicIp: 192.0.2.0 - SecuredCookies: false - SecurityGroups: - - sg-12345678 - SourceSecurityGroup: - SecurityGroupAccountId: '123456789012' - SecurityGroupName: security-group-example - Subnets: - - subnet-12345678 - SubregionNames: - - eu-west-2a - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex4: summary: Updating SSL certificate value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 LoadBalancer: + Tags: [] + SourceSecurityGroup: + SecurityGroupName: security-group-example + SecurityGroupAccountId: '123456789012' + SecuredCookies: false + PublicIp: 192.0.2.0 + Subnets: + - subnet-12345678 + NetId: vpc-12345678 + BackendVmIds: [] + ApplicationStickyCookiePolicies: [] + SecurityGroups: + - sg-12345678 + LoadBalancerType: internet-facing AccessLog: - IsEnabled: false PublicationInterval: 60 - ApplicationStickyCookiePolicies: [] - BackendVmIds: [] + IsEnabled: false DnsName: private-lb-example.123456789.eu-west-2.lbu.outscale.com HealthCheck: + UnhealthyThreshold: 2 + Timeout: 5 CheckInterval: 30 + Protocol: TCP HealthyThreshold: 10 Port: 80 - Protocol: TCP - Timeout: 5 - UnhealthyThreshold: 2 + LoadBalancerStickyCookiePolicies: [] + SubregionNames: + - eu-west-2a Listeners: - - BackendPort: 80 + - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/AnotherCertificate + BackendPort: 80 BackendProtocol: HTTP LoadBalancerPort: 443 LoadBalancerProtocol: HTTPS - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/AnotherCertificate LoadBalancerName: private-lb-example - LoadBalancerStickyCookiePolicies: [] - LoadBalancerType: internet-facing - NetId: vpc-12345678 - PublicIp: 192.0.2.0 - SecuredCookies: false - SecurityGroups: - - sg-12345678 - SourceSecurityGroup: - SecurityGroupAccountId: '123456789012' - SecurityGroupName: security-group-example - Subnets: - - subnet-12345678 - SubregionNames: - - eu-west-2a - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UpdateLoadBalancerResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer "/UpdateNet": - description: Associates a DHCP options set with a specified Net. post: + description: Associates a DHCP options set with a specified Net. operationId: UpdateNet requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateNetRequest" examples: ex1: value: - DhcpOptionsSetId: dopt-12345678 NetId: vpc-12345678 - schema: - "$ref": "#/components/schemas/UpdateNetRequest" + DhcpOptionsSetId: dopt-12345678 responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateNetResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Net: + Tags: [] DhcpOptionsSetId: dopt-12345678 IpRange: 10.0.0.0/16 + Tenancy: default NetId: vpc-12345678 State: available - Tags: [] - Tenancy: default - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UpdateNetResponse" description: The HTTP 200 response (OK). '400': content: @@ -23875,81 +24142,83 @@ paths: tags: - Net "/UpdateNetAccessPoint": - description: |- - Modifies the attributes of a Net access point.
- This action enables you to add or remove route tables associated with the specified Net access point. post: + description: |- + Modifies the attributes of a Net access point.
+ This action enables you to add or remove route tables associated with the specified Net access point. operationId: UpdateNetAccessPoint requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateNetAccessPointRequest" examples: ex1: summary: Adding a route table value: + NetAccessPointId: vpce-12345678 AddRouteTableIds: - rtb-87654321 - NetAccessPointId: vpce-12345678 ex2: summary: Removing a route table value: NetAccessPointId: vpce-12345678 RemoveRouteTableIds: - rtb-12345678 - schema: - "$ref": "#/components/schemas/UpdateNetAccessPointRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateNetAccessPointResponse" examples: ex1: summary: Adding a route table value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 NetAccessPoint: + Tags: [] NetAccessPointId: vpce-12345678 - NetId: vpc-12345678 RouteTableIds: - rtb-12345678 - rtb-87654321 - ServiceName: com.outscale.eu-west-2.oos State: available - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + NetId: vpc-12345678 + ServiceName: com.outscale.eu-west-2.oos ex2: summary: Removing a route table value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 NetAccessPoint: + Tags: [] NetAccessPointId: vpce-12345678 - NetId: vpc-12345678 RouteTableIds: [] - ServiceName: com.outscale.eu-west-2.oos State: available - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UpdateNetAccessPointResponse" + NetId: vpc-12345678 + ServiceName: com.outscale.eu-west-2.oos description: The HTTP 200 response (OK). tags: - NetAccessPoint "/UpdateNic": - description: Modifies the specified network interface card (NIC). You can specify - only one attribute at a time. post: + description: Modifies the specified network interface card (NIC). You can specify + only one attribute at a time. operationId: UpdateNic requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateNicRequest" examples: ex1: summary: Modifying the DeleteOnVmDeletion value of a NIC value: + NicId: eni-12345678 LinkNic: DeleteOnVmDeletion: false LinkNicId: eni-attach-12345678 - NicId: eni-12345678 ex2: summary: Modifying the security groups of a NIC value: @@ -23959,110 +24228,108 @@ paths: ex3: summary: Modifying the description of a NIC value: - Description: Example of description NicId: eni-12345678 - schema: - "$ref": "#/components/schemas/UpdateNicRequest" + Description: Example of description responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateNicResponse" examples: ex1: summary: Modifying the DeleteOnVmDeletion value of a NIC value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Nic: - AccountId: '123456789012' - Description: Primary network interface - IsSourceDestChecked: true + SubregionName: eu-west-2a + SubnetId: subnet-12345678 + State: in-use LinkNic: + VmId: i-12345678 + LinkNicId: eni-attach-12345678 + VmAccountId: '123456789012' DeleteOnVmDeletion: false DeviceNumber: 0 - LinkNicId: eni-attach-12345678 State: attached - VmAccountId: '123456789012' - VmId: i-12345678 + IsSourceDestChecked: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + Tags: [] + Description: Primary network interface + AccountId: '123456789012' + SecurityGroups: + - SecurityGroupName: default + SecurityGroupId: sg-12345678 MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - IsPrimary: true - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - SecurityGroups: - - SecurityGroupId: sg-12345678 - SecurityGroupName: default - State: in-use - SubnetId: subnet-12345678 - SubregionName: eu-west-2a - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + IsPrimary: true ex2: summary: Modifying the security groups of a NIC value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Nic: - AccountId: '123456789012' - Description: Primary network interface - IsSourceDestChecked: true + SubregionName: eu-west-2a + SubnetId: subnet-12345678 + State: in-use LinkNic: + VmId: i-12345678 + LinkNicId: eni-attach-12345678 + VmAccountId: '123456789012' DeleteOnVmDeletion: true DeviceNumber: 0 - LinkNicId: eni-attach-12345678 State: attached - VmAccountId: '123456789012' - VmId: i-12345678 + IsSourceDestChecked: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + Tags: [] + Description: Primary network interface + AccountId: '123456789012' + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - IsPrimary: true - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - SecurityGroups: - - SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - State: in-use - SubnetId: subnet-12345678 - SubregionName: eu-west-2a - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + IsPrimary: true ex3: summary: Modifying the description of a NIC value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Nic: - AccountId: '123456789012' - Description: Example of description - IsSourceDestChecked: true + SubregionName: eu-west-2a + SubnetId: subnet-12345678 + State: in-use LinkNic: + VmId: i-12345678 + LinkNicId: eni-attach-12345678 + VmAccountId: '123456789012' DeleteOnVmDeletion: true DeviceNumber: 0 - LinkNicId: eni-attach-12345678 State: attached - VmAccountId: '123456789012' - VmId: i-12345678 + IsSourceDestChecked: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + Tags: [] + Description: Example of description + AccountId: '123456789012' + SecurityGroups: + - SecurityGroupName: default + SecurityGroupId: sg-12345678 MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - IsPrimary: true - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - SecurityGroups: - - SecurityGroupId: sg-12345678 - SecurityGroupName: default - State: in-use - SubnetId: subnet-12345678 - SubregionName: eu-west-2a - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UpdateNicResponse" + IsPrimary: true description: The HTTP 200 response (OK). '400': content: @@ -24085,62 +24352,62 @@ paths: tags: - Nic "/UpdateRoute": - description: |- - Replaces an existing route within a route table in a Net.
- You must specify one of the following elements as the target:

+ post: + description: |- + Replaces an existing route within a route table in a Net.
+ You must specify one of the following elements as the target:

- * Net peering
- * NAT virtual machine (VM)
- * Internet service
- * Virtual gateway
- * NAT service
- * Network interface card (NIC)

+ * Net peering
+ * NAT virtual machine (VM)
+ * Internet service
+ * Virtual gateway
+ * NAT service
+ * Network interface card (NIC)

- The routing algorithm is based on the most specific match. - post: + The routing algorithm is based on the most specific match. operationId: UpdateRoute requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateRouteRequest" examples: ex1: summary: Updating a route to a virtual gateway value: + RouteTableId: rtb-12345678 DestinationIpRange: 198.51.100.0/24 GatewayId: vgw-12345678 - RouteTableId: rtb-12345678 - schema: - "$ref": "#/components/schemas/UpdateRouteRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateRouteResponse" examples: ex1: summary: Updating a route to a virtual gateway value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 RouteTable: + Routes: + - DestinationIpRange: 10.0.0.0/16 + CreationMethod: CreateRouteTable + State: active + - GatewayId: vgw-12345678 + DestinationIpRange: 198.51.100.0/24 + CreationMethod: CreateRoute + State: active LinkRouteTables: - - LinkRouteTableId: rtbassoc-12345678 + - RouteTableId: rtb-12345678 Main: false - RouteTableId: rtb-12345678 SubnetId: subnet-12345678 + LinkRouteTableId: rtbassoc-12345678 NetId: vpc-12345678 + Tags: [] RoutePropagatingVirtualGateways: [] RouteTableId: rtb-12345678 - Routes: - - CreationMethod: CreateRouteTable - DestinationIpRange: 10.0.0.0/16 - State: active - - CreationMethod: CreateRoute - DestinationIpRange: 198.51.100.0/24 - GatewayId: vgw-12345678 - State: active - Tags: [] - schema: - "$ref": "#/components/schemas/UpdateRouteResponse" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -24163,77 +24430,77 @@ paths: tags: - Route "/UpdateRoutePropagation": - description: Configures the propagation of routes to a specified route table of - a Net by a virtual gateway. post: + description: Configures the propagation of routes to a specified route table + of a Net by a virtual gateway. operationId: UpdateRoutePropagation requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateRoutePropagationRequest" examples: ex1: value: - Enable: true - RouteTableId: rtb-12345678 VirtualGatewayId: vgw-12345678 - schema: - "$ref": "#/components/schemas/UpdateRoutePropagationRequest" + RouteTableId: rtb-12345678 + Enable: true responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateRoutePropagationResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 RouteTable: + Routes: + - DestinationIpRange: 10.0.0.0/16 + CreationMethod: CreateRouteTable + State: active LinkRouteTables: - - LinkRouteTableId: rtbassoc-12345678 + - RouteTableId: rtb-12345678 Main: true - RouteTableId: rtb-12345678 + LinkRouteTableId: rtbassoc-12345678 NetId: vpc-12345678 + Tags: [] RoutePropagatingVirtualGateways: - VirtualGatewayId: vgw-12345678 RouteTableId: rtb-12345678 - Routes: - - CreationMethod: CreateRouteTable - DestinationIpRange: 10.0.0.0/16 - State: active - Tags: [] - schema: - "$ref": "#/components/schemas/UpdateRoutePropagationResponse" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - VirtualGateway "/UpdateRouteTableLink": - description: |- - Replaces the route table associated with a specific Subnet in a Net with another one.
- After the route table is replaced, the Subnet uses the routes in the new route table it is associated with. post: + description: |- + Replaces the route table associated with a specific Subnet in a Net with another one.
+ After the route table is replaced, the Subnet uses the routes in the new route table it is associated with. operationId: UpdateRouteTableLink requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateRouteTableLinkRequest" examples: ex1: value: LinkRouteTableId: rtbassoc-12345678 RouteTableId: rtb-12345678 - schema: - "$ref": "#/components/schemas/UpdateRouteTableLinkRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateRouteTableLinkResponse" examples: ex1: value: - LinkRouteTableId: rtbassoc-12345678 ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UpdateRouteTableLinkResponse" + LinkRouteTableId: rtbassoc-12345678 description: The HTTP 200 response (OK). '400': content: @@ -24256,160 +24523,160 @@ paths: tags: - RouteTable "/UpdateServerCertificate": - description: Modifies the name and/or the path of a specified server certificate. post: + description: Modifies the name and/or the path of a specified server certificate. operationId: UpdateServerCertificate requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateServerCertificateRequest" examples: ex1: value: Name: server-cert-example NewName: new-name - schema: - "$ref": "#/components/schemas/UpdateServerCertificateRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateServerCertificateResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ServerCertificate: + Path: "/example/" Id: ABCDEFGHIJKLMNOPQRSTUVWXYZ1234 Name: new-name - Path: "/example/" - schema: - "$ref": "#/components/schemas/UpdateServerCertificateResponse" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - ServerCertificate "/UpdateSnapshot": - description: |- - Modifies the permissions for a specified snapshot.
- You must specify either the `Additions` or the `Removals` parameter.
- After sharing a snapshot with an account, the other account can create a copy of it that they own. For more information about copying snapshots, see [CreateSnapshot](#createsnapshot). post: + description: |- + Modifies the permissions for a specified snapshot.
+ You must specify either the `Additions` or the `Removals` parameter.
+ After sharing a snapshot with an account, the other account can create a copy of it that they own. For more information about copying snapshots, see [CreateSnapshot](#createsnapshot). operationId: UpdateSnapshot requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateSnapshotRequest" examples: ex1: summary: Adding permission value: + SnapshotId: snap-12345678 PermissionsToCreateVolume: Additions: AccountIds: - '987654321098' - SnapshotId: snap-12345678 ex2: summary: Removing permission value: + SnapshotId: snap-12345678 PermissionsToCreateVolume: Removals: AccountIds: - '987654321098' - SnapshotId: snap-12345678 ex3: summary: Making an image public to everyone value: + SnapshotId: snap-12345678 PermissionsToCreateVolume: Additions: GlobalPermission: true - SnapshotId: snap-12345678 ex4: summary: Making an image private to everyone value: + SnapshotId: snap-12345678 PermissionsToCreateVolume: Removals: GlobalPermission: true - SnapshotId: snap-12345678 - schema: - "$ref": "#/components/schemas/UpdateSnapshotRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateSnapshotResponse" examples: ex1: summary: Adding permission value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Snapshot: + VolumeSize: 10 AccountId: '123456789012' + VolumeId: vol-12345678 CreationDate: '2010-10-01T12:34:56.789Z' - Description: Snapshot created from a volume PermissionsToCreateVolume: + GlobalPermission: false AccountIds: - '987654321098' - GlobalPermission: false Progress: 100 SnapshotId: snap-12345678 State: completed + Description: Snapshot created from a volume Tags: [] - VolumeId: vol-12345678 - VolumeSize: 10 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Removing permission value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Snapshot: + VolumeSize: 10 AccountId: '123456789012' + VolumeId: vol-12345678 CreationDate: '2010-10-01T12:34:56.789Z' - Description: Snapshot created from a volume PermissionsToCreateVolume: - AccountIds: [] GlobalPermission: false + AccountIds: [] Progress: 100 SnapshotId: snap-12345678 State: completed + Description: Snapshot created from a volume Tags: [] - VolumeId: vol-12345678 - VolumeSize: 10 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex3: summary: Making an image public to everyone value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Snapshot: + VolumeSize: 10 AccountId: '123456789012' + VolumeId: vol-12345678 CreationDate: '2010-10-01T12:34:56.789Z' - Description: Snapshot created from a volume PermissionsToCreateVolume: - AccountIds: [] GlobalPermission: true + AccountIds: [] Progress: 100 SnapshotId: snap-12345678 State: completed + Description: Snapshot created from a volume Tags: [] - VolumeId: vol-12345678 - VolumeSize: 10 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex4: summary: Making an image private to everyone value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Snapshot: + VolumeSize: 10 AccountId: '123456789012' + VolumeId: vol-12345678 CreationDate: '2010-10-01T12:34:56.789Z' - Description: Snapshot created from a volume PermissionsToCreateVolume: - AccountIds: [] GlobalPermission: false + AccountIds: [] Progress: 100 SnapshotId: snap-12345678 State: completed + Description: Snapshot created from a volume Tags: [] - VolumeId: vol-12345678 - VolumeSize: 10 - schema: - "$ref": "#/components/schemas/UpdateSnapshotResponse" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -24432,39 +24699,39 @@ paths: tags: - Snapshot "/UpdateSubnet": - description: Modifies the specified attribute of a Subnet. post: + description: Modifies the specified attribute of a Subnet. operationId: UpdateSubnet requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateSubnetRequest" examples: ex1: value: - MapPublicIpOnLaunch: true SubnetId: subnet-12345678 - schema: - "$ref": "#/components/schemas/UpdateSubnetRequest" + MapPublicIpOnLaunch: true responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateSubnetResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Subnet: + Tags: [] + SubregionName: eu-west-2a + SubnetId: subnet-12345678 AvailableIpsCount: 16379 IpRange: 10.0.0.0/18 MapPublicIpOnLaunch: true - NetId: vpc-12345678 State: available - SubnetId: subnet-12345678 - SubregionName: eu-west-2a - Tags: [] - schema: - "$ref": "#/components/schemas/UpdateSubnetResponse" + NetId: vpc-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -24487,49 +24754,51 @@ paths: tags: - Subnet "/UpdateUser": - description: Modifies the name and/or the path of a specified EIM user. post: + description: Modifies the name and/or the path of a specified EIM user. operationId: UpdateUser requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateUserRequest" examples: ex1: value: - NewPath: "/product/" + UserName: example-user NewUserEmail: user@example.com NewUserName: test-user - UserName: example-user - schema: - "$ref": "#/components/schemas/UpdateUserRequest" + NewPath: "/product/" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateUserResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 User: CreationDate: 2010-10-01 12:34:56.789000000 +00:00 LastModificationDate: 2017-05-10 12:34:56.789000000 +00:00 - Path: "/product/" UserEmail: user@example.com - UserId: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 UserName: test-user - schema: - "$ref": "#/components/schemas/UpdateUserResponse" + UserId: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 + Path: "/product/" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - User "/UpdateUserGroup": - description: Modifies the name and/or the path of a specified group. post: + description: Modifies the name and/or the path of a specified group. operationId: UpdateUserGroup requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateUserGroupRequest" examples: ex1: value: @@ -24537,12 +24806,12 @@ paths: NewUserGroupName: new-usergroup Path: "/example/" UserGroupName: example-usergroup - schema: - "$ref": "#/components/schemas/UpdateUserGroupRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateUserGroupResponse" examples: ex1: value: @@ -24562,26 +24831,26 @@ paths: UserEmail: user@example.com UserId: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 UserName: example-user - schema: - "$ref": "#/components/schemas/UpdateUserGroupResponse" description: The HTTP 200 response (OK). tags: - UserGroup "/UpdateVm": - description: |- - Modifies the specified attributes of a virtual machine (VM).
- You must stop the VM before modifying the following attributes:
- * `NestedVirtualization`
- * `Performance`
- * `UserData`
- * `VmType` - - To complete the update of secure boot, you need to do a stop/start of the VM. A simple restart is not sufficient, as the update is done when the VM goes through the stopped state. For the difference between stop/start and restart, see [About VM Lifecycle](https://docs.outscale.com/en/userguide/About-VM-Lifecycle.html). post: + description: |- + Modifies the specified attributes of a virtual machine (VM).
+ You must stop the VM before modifying the following attributes:
+ * `NestedVirtualization`
+ * `Performance`
+ * `UserData`
+ * `VmType` + + To complete the update of secure boot, you need to do a stop/start of the VM. A simple restart is not sufficient, as the update is done when the VM goes through the stopped state. For the difference between stop/start and restart, see [About VM Lifecycle](https://docs.outscale.com/en/userguide/About-VM-Lifecycle.html). operationId: UpdateVm requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateVmRequest" examples: ex1: value: @@ -24589,159 +24858,157 @@ paths: VmType: tinav5.c2r2p2 ex2: value: - UserData: "..." VmId: i-12345678 - schema: - "$ref": "#/components/schemas/UpdateVmRequest" + UserData: "..." responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateVmResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Vm: - ActionsOnNextBoot: - SecureBoot: none + VmType: tinav5.c2r2p2 + VmInitiatedShutdownBehavior: stop + State: stopped + StateReason: '' + RootDeviceType: ebs + RootDeviceName: "/dev/sda1" + IsSourceDestChecked: true + KeypairName: keypair-example + ImageId: ami-12345678 + DeletionProtection: false Architecture: x86_64 + NestedVirtualization: false BlockDeviceMappings: - - Bsu: - DeleteOnVmDeletion: true - LinkDate: '2010-10-01T12:34:56.789Z' - State: attached + - DeviceName: "/dev/sda1" + Bsu: VolumeId: vol-12345678 - DeviceName: "/dev/sda1" - BsuOptimized: false - CreationDate: '2010-10-01T12:34:56.789Z' - DeletionProtection: false + State: attached + LinkDate: '2010-10-01T12:34:56.789Z' + DeleteOnVmDeletion: true + VmId: i-12345678 + ReservationId: r-12345678 Hypervisor: xen - ImageId: ami-12345678 - IsSourceDestChecked: true - KeypairName: keypair-example + Placement: + Tenancy: default + SubregionName: eu-west-2a + ProductCodes: + - '0001' + CreationDate: '2010-10-01T12:34:56.789Z' + UserData: '' + SubnetId: subnet-12345678 + PrivateIp: 10.0.0.4 + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 + BsuOptimized: false LaunchNumber: 0 - NestedVirtualization: false NetId: vpc-12345678 Nics: - - AccountId: '123456789012' - Description: Primary network interface - IsSourceDestChecked: true + - SubnetId: subnet-12345678 + State: in-use LinkNic: - DeleteOnVmDeletion: true + State: attached DeviceNumber: 0 LinkNicId: eni-attach-12345678 - State: attached + DeleteOnVmDeletion: true + IsSourceDestChecked: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + Description: Primary network interface + AccountId: '123456789012' + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - IsPrimary: true - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - SecurityGroups: - - SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - State: in-use - SubnetId: subnet-12345678 + IsPrimary: true Performance: high - Placement: - SubregionName: eu-west-2a - Tenancy: default - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal - PrivateIp: 10.0.0.4 - ProductCodes: - - '0001' - ReservationId: r-12345678 - RootDeviceName: "/dev/sda1" - RootDeviceType: ebs - SecurityGroups: - - SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - State: stopped - StateReason: '' - SubnetId: subnet-12345678 Tags: - - Key: env - Value: prod - UserData: '' - VmId: i-12345678 - VmInitiatedShutdownBehavior: stop - VmType: tinav5.c2r2p2 - ex2: - value: + - Value: prod + Key: env + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + ActionsOnNextBoot: + SecureBoot: none ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + value: Vm: - ActionsOnNextBoot: - SecureBoot: none + VmType: tinav5.c1r1p2 + VmInitiatedShutdownBehavior: stop + State: stopped + StateReason: '' + RootDeviceType: ebs + RootDeviceName: "/dev/sda1" + IsSourceDestChecked: true + KeypairName: keypair-example + ImageId: ami-12345678 + DeletionProtection: true Architecture: x86_64 + NestedVirtualization: false BlockDeviceMappings: - - Bsu: - DeleteOnVmDeletion: true - LinkDate: '2010-10-01T12:34:56.789Z' - State: attached + - DeviceName: "/dev/sda1" + Bsu: VolumeId: vol-12345678 - DeviceName: "/dev/sda1" - BsuOptimized: false - CreationDate: '2010-10-01T12:34:56.789Z' - DeletionProtection: true + State: attached + LinkDate: '2010-10-01T12:34:56.789Z' + DeleteOnVmDeletion: true + VmId: i-12345678 + ReservationId: r-12345678 Hypervisor: xen - ImageId: ami-12345678 - IsSourceDestChecked: true - KeypairName: keypair-example + Placement: + Tenancy: default + SubregionName: eu-west-2a + ProductCodes: + - '0001' + CreationDate: '2010-10-01T12:34:56.789Z' + UserData: "..." + SubnetId: subnet-12345678 + PrivateIp: 10.0.0.4 + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 + BsuOptimized: false LaunchNumber: 0 - NestedVirtualization: false NetId: vpc-12345678 Nics: - - AccountId: '123456789012' - Description: Primary network interface - IsSourceDestChecked: true + - SubnetId: subnet-12345678 + State: in-use LinkNic: - DeleteOnVmDeletion: true + State: attached DeviceNumber: 0 LinkNicId: eni-attach-12345678 - State: attached + DeleteOnVmDeletion: true + IsSourceDestChecked: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + Description: Primary network interface + AccountId: '123456789012' + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - IsPrimary: true - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - SecurityGroups: - - SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - State: in-use - SubnetId: subnet-12345678 + IsPrimary: true Performance: high - Placement: - SubregionName: eu-west-2a - Tenancy: default - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal - PrivateIp: 10.0.0.4 - ProductCodes: - - '0001' - ReservationId: r-12345678 - RootDeviceName: "/dev/sda1" - RootDeviceType: ebs - SecurityGroups: - - SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - State: stopped - StateReason: '' - SubnetId: subnet-12345678 Tags: - - Key: env - Value: prod - UserData: "..." - VmId: i-12345678 - VmInitiatedShutdownBehavior: stop - VmType: tinav5.c1r1p2 - schema: - "$ref": "#/components/schemas/UpdateVmResponse" + - Value: prod + Key: env + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + ActionsOnNextBoot: + SecureBoot: none + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -24764,55 +25031,55 @@ paths: tags: - Vm "/UpdateVmGroup": - description: |- - > [WARNING]
- > This feature is currently under development and may not function properly.
- - Modifies the specified attributes of a group of virtual machines (VMs). post: + description: |- + > [WARNING]
+ > This feature is currently under development and may not function properly.
+ + Modifies the specified attributes of a group of virtual machines (VMs). operationId: UpdateVmGroup requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateVmGroupRequest" examples: ex1: summary: Updating the name and description of a VM group value: - Description: New description of the VM group VmGroupId: vmgroup-12345678901234567890123456789012 VmGroupName: new-name + Description: New description of the VM group ex2: summary: Updating the VM template of a VM group value: VmGroupId: vmgroup-12345678901234567890123456789012 VmTemplateId: vmtemplate-98765432109876543210987654321012 - schema: - "$ref": "#/components/schemas/UpdateVmGroupRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateVmGroupResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VmGroup: - CreationDate: 2010-10-01 12:34:56.789000000 +00:00 - Description: New description of the VM group - PositioningStrategy: attract + VmTemplateId: vmtemplate-98765432109876543210987654321012 SecurityGroupIds: - sg-12345678 - State: available - SubnetId: subnet-12345678 - Tags: [] + VmIds: [] + CreationDate: 2010-10-01 12:34:56.789000000 +00:00 VmCount: 2 - VmGroupId: vmgroup-12345678901234567890123456789012 VmGroupName: new-name - VmIds: [] - VmTemplateId: vmtemplate-98765432109876543210987654321012 - schema: - "$ref": "#/components/schemas/UpdateVmGroupResponse" + SubnetId: subnet-12345678 + PositioningStrategy: attract + State: available + VmGroupId: vmgroup-12345678901234567890123456789012 + Description: New description of the VM group + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -24835,112 +25102,112 @@ paths: tags: - VmGroup "/UpdateVmTemplate": - description: |- - > [WARNING]
- > This feature is currently under development and may not function properly.
- - Modifies the specified attributes of a template of virtual machines (VMs). post: + description: |- + > [WARNING]
+ > This feature is currently under development and may not function properly.
+ + Modifies the specified attributes of a template of virtual machines (VMs). operationId: UpdateVmTemplate requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateVmTemplateRequest" examples: ex1: value: Description: The new description of the VM template VmTemplateId: vmtemplate-98765432109876543210987654321012 VmTemplateName: second-name - schema: - "$ref": "#/components/schemas/UpdateVmTemplateRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateVmTemplateResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VmTemplate: - CpuCores: 2 - CpuGeneration: v4 + VmTemplateName: second-name CpuPerformance: high CreationDate: 2010-10-01 12:34:56.789000000 +00:00 + CpuCores: 2 + Tags: [] Description: The new description of the VM template ImageId: ami-12345678 - Ram: 2 - Tags: [] + CpuGeneration: v4 VmTemplateId: vmtemplate-98765432109876543210987654321012 - VmTemplateName: second-name - schema: - "$ref": "#/components/schemas/UpdateVmTemplateResponse" + Ram: 2 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - VmTemplate "/UpdateVolume": - description: |- - Modifies the specified attributes of a volume.
- Cold volumes are volumes that are attached to stopped or stopping VMs, or that are detached. Hot volumes are volumes that are attached to running VMs.

- - **[NOTE]**
- When the modification is not instantaneous, the response displays the previous value. You can use the [ReadVolumes](#readvolumes) method to see the new value. post: + description: |- + Modifies the specified attributes of a volume.
+ Cold volumes are volumes that are attached to stopped or stopping VMs, or that are detached. Hot volumes are volumes that are attached to running VMs.

+ + **[NOTE]**
+ When the modification is not instantaneous, the response displays the previous value. You can use the [ReadVolumes](#readvolumes) method to see the new value. operationId: UpdateVolume requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateVolumeRequest" examples: ex1: summary: Updating the size of a volume value: - Size: 50 VolumeId: vol-12345678 + Size: 50 ex2: summary: Updating the type of a volume to io1 value: - Iops: 200 VolumeId: vol-12345678 VolumeType: io1 - schema: - "$ref": "#/components/schemas/UpdateVolumeRequest" + Iops: 200 responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateVolumeResponse" examples: ex1: summary: Updating the size of a volume value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Volume: + VolumeId: vol-12345678 + Tags: [] + VolumeType: gp2 + SubregionName: eu-west-2a + State: available CreationDate: '2010-10-01T12:34:56.789Z' Iops: 100 LinkedVolumes: [] Size: 10 - State: available - SubregionName: eu-west-2a - Tags: [] - VolumeId: vol-12345678 - VolumeType: gp2 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Updating the type of a volume to io1 value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Volume: + VolumeId: vol-12345678 + Tags: [] + VolumeType: io1 + SubregionName: eu-west-2a + State: available CreationDate: '2010-10-01T12:34:56.789Z' Iops: 200 LinkedVolumes: [] Size: 10 - State: available - SubregionName: eu-west-2a - Tags: [] - VolumeId: vol-12345678 - VolumeType: io1 - schema: - "$ref": "#/components/schemas/UpdateVolumeResponse" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -24963,48 +25230,48 @@ paths: tags: - Volume "/UpdateVpnConnection": - description: Modifies the specified attributes of a VPN connection. post: + description: Modifies the specified attributes of a VPN connection. operationId: UpdateVpnConnection requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateVpnConnectionRequest" examples: ex1: value: VpnConnectionId: vpn-12345678 VpnOptions: TunnelInsideIpRange: 169.254.254.22/30 - schema: - "$ref": "#/components/schemas/UpdateVpnConnectionRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateVpnConnectionResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VpnConnection: + VpnOptions: + TunnelInsideIpRange: 169.254.254.22/30 + Routes: [] + Tags: [] ClientGatewayConfiguration: "..." - ClientGatewayId: cgw-12345678 + StaticRoutesOnly: true + VirtualGatewayId: vgw-12345678 ConnectionType: ipsec.1 - Routes: [] + ClientGatewayId: cgw-12345678 State: pending - StaticRoutesOnly: true - Tags: [] VgwTelemetries: - - AcceptedRouteCount: 0 + - StateDescription: IPSEC IS DOWN + AcceptedRouteCount: 0 LastStateChangeDate: '2017-05-10T12:34:56.789Z' OutsideIpAddress: 192.0.2.0 - StateDescription: IPSEC IS DOWN - VirtualGatewayId: vgw-12345678 VpnConnectionId: vpn-12345678 - VpnOptions: - TunnelInsideIpRange: 169.254.254.22/30 - schema: - "$ref": "#/components/schemas/UpdateVpnConnectionResponse" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: diff --git a/outscale.yaml b/outscale.yaml index 63fd4ad..b7f4527 100644 --- a/outscale.yaml +++ b/outscale.yaml @@ -158,6 +158,10 @@ components: MobileNumber: description: The mobile phone number of the account owner. type: string + OutscaleLoginAllowed: + description: Whether the account is allowed to log in to Cockpit v2 using + its Outscale credentials when identity federation is activated. + type: boolean PhoneNumber: description: The landline phone number of the account owner. type: string @@ -351,7 +355,7 @@ components: type: string type: object BootMode: - description: Information about the boot mode of the OMI (`legacy` and/or `uefi`). + description: Information about the boot mode of the VM. enum: - uefi - legacy @@ -382,8 +386,8 @@ components: properties: DeleteOnVmDeletion: default: true - description: By default or if set to true, the volume is deleted when terminating - the VM. If false, the volume is not deleted when terminating the VM. + description: If set to true, the volume is deleted when terminating the + VM. If false, the volume is not deleted when terminating the VM. type: boolean Iops: description: The number of I/O operations per second (IOPS). This parameter @@ -490,7 +494,7 @@ components: format: date-time type: string State: - description: The state of the catalog (`CURRENT` \| `OBSOLETE`). + description: The state of the catalog. enum: - CURRENT - OBSOLETE @@ -1010,7 +1014,7 @@ components: "$ref": "#/components/schemas/BlockDeviceMappingImage" type: array BootModes: - description: The boot modes compatible with the OMI (`legacy` and/or `uefi`). + description: The boot modes compatible with the OMI. items: "$ref": "#/components/schemas/BootMode" type: array @@ -1981,12 +1985,11 @@ components: type: boolean PositioningStrategy: default: no-strategy - description: The positioning strategy of VMs on hypervisors. By default, - or if set to `no-strategy` our orchestrator determines the most adequate - position for your VMs. If set to `attract`, your VMs are deployed on the - same hypervisor, which improves network performance. If set to `repulse`, - your VMs are deployed on a different hypervisor, which improves fault - tolerance. + description: The positioning strategy of VMs on hypervisors. If set to `no-strategy`, + our orchestrator determines the most adequate position for your VMs. If + set to `attract`, your VMs are deployed on the same hypervisor, which + improves network performance. If set to `repulse`, your VMs are deployed + on a different hypervisor, which improves fault tolerance. enum: - attract - no-strategy @@ -2040,7 +2043,7 @@ components: type: string CpuPerformance: default: high - description: The performance of the VMs (`medium` \| `high` \| `highest`). + description: The performance of the VMs. enum: - medium - high @@ -2100,8 +2103,8 @@ components: "$ref": "#/components/schemas/BootMode" BootOnCreation: default: true - description: By default or if true, the VM is started on creation. If false, - the VM is stopped on creation. + description: If true, the VM is started on creation. If false, the VM is + stopped on creation. type: boolean BsuOptimized: description: This parameter is not available. It is present in our API for @@ -2149,9 +2152,8 @@ components: type: array Performance: default: high - description: The performance of the VM (`medium` \| `high` \| `highest`). - By default, `high`. This parameter is ignored if you specify a performance - flag directly in the `VmType` parameter. + description: The performance of the VM. This parameter is ignored if you + specify a performance flag directly in the `VmType` parameter. enum: - medium - high @@ -2186,8 +2188,8 @@ components: type: string VmInitiatedShutdownBehavior: default: stop - description: The VM behavior when you stop it. By default or if set to `stop`, - the VM stops. If set to `restart`, the VM stops then automatically restarts. + description: The VM behavior when you stop it. If set to `stop`, the VM + stops. If set to `restart`, the VM stops then automatically restarts. If set to `terminate`, the VM stops and is terminated. type: string VmType: @@ -3508,7 +3510,7 @@ components: type: string Mtu: description: The maximum transmission unit (MTU) of the DirectLink interface, - in bytes (always `1500`). + in bytes. type: integer OutscalePrivateIp: description: The IP on the OUTSCALE side of the DirectLink interface. @@ -3524,6 +3526,102 @@ components: description: The VLAN number associated with the DirectLink interface. type: integer type: object + DisableOutscaleLoginForUsersRequest: + additionalProperties: false + properties: + DryRun: + description: If true, checks whether you have the required permissions to + perform the action. + type: boolean + type: object + DisableOutscaleLoginForUsersResponse: + additionalProperties: false + properties: + ResponseContext: + "$ref": "#/components/schemas/ResponseContext" + type: object + DisableOutscaleLoginPerUsersRequest: + additionalProperties: false + properties: + DryRun: + description: If true, checks whether you have the required permissions to + perform the action. + type: boolean + UserNames: + description: The usernames of the EIM users you want to disable the Outscale + login for. + items: + type: string + type: array + type: object + DisableOutscaleLoginPerUsersResponse: + additionalProperties: false + properties: + ResponseContext: + "$ref": "#/components/schemas/ResponseContext" + type: object + DisableOutscaleLoginRequest: + additionalProperties: false + properties: + DryRun: + description: If true, checks whether you have the required permissions to + perform the action. + type: boolean + type: object + DisableOutscaleLoginResponse: + additionalProperties: false + properties: + ResponseContext: + "$ref": "#/components/schemas/ResponseContext" + type: object + EnableOutscaleLoginForUsersRequest: + additionalProperties: false + properties: + DryRun: + description: If true, checks whether you have the required permissions to + perform the action. + type: boolean + type: object + EnableOutscaleLoginForUsersResponse: + additionalProperties: false + properties: + ResponseContext: + "$ref": "#/components/schemas/ResponseContext" + type: object + EnableOutscaleLoginPerUsersRequest: + additionalProperties: false + properties: + DryRun: + description: If true, checks whether you have the required permissions to + perform the action. + type: boolean + UserNames: + description: The usernames of the EIM users you want to enable the Outscale + login for. + items: + type: string + type: array + type: object + EnableOutscaleLoginPerUsersResponse: + additionalProperties: false + properties: + ResponseContext: + "$ref": "#/components/schemas/ResponseContext" + type: object + EnableOutscaleLoginRequest: + additionalProperties: false + properties: + DryRun: + description: If true, checks whether you have the required permissions to + perform the action. + type: boolean + type: object + EnableOutscaleLoginResponse: + additionalProperties: false + properties: + ResponseContext: + "$ref": "#/components/schemas/ResponseContext" + type: object ErrorResponse: additionalProperties: false properties: @@ -3941,7 +4039,7 @@ components: type: string type: array BootModes: - description: The boot modes compatible with the OMIs (`legacy` and/or `uefi`). + description: The boot modes compatible with the OMIs. items: "$ref": "#/components/schemas/BootMode" type: array @@ -5127,7 +5225,7 @@ components: type: string type: array BootModes: - description: The boot modes of the VMs (`legacy` \| `uefi`). + description: The boot modes of the VMs. items: "$ref": "#/components/schemas/BootMode" type: array @@ -5735,7 +5833,7 @@ components: type: array VolumeStates: description: The states of the volumes (`creating` \| `available` \| `in-use` - \| `updating` \| `deleting` \| `error`). + \| `deleting` \| `error`). items: type: string type: array @@ -5920,7 +6018,7 @@ components: "$ref": "#/components/schemas/BlockDeviceMappingImage" type: array BootModes: - description: The boot modes compatible with the OMI (`legacy` and/or `uefi`). + description: The boot modes compatible with the OMI. items: "$ref": "#/components/schemas/BootMode" type: array @@ -6615,9 +6713,9 @@ components: description: The routing protocol (`HTTP` \| `HTTPS` \| `TCP` \| `SSL`). type: string ServerCertificateId: - description: The OUTSCALE Resource Name (ORN) of the server certificate. - For more information, see [Resource Identifiers > OUTSCALE Resource Names - (ORNs)](https://docs.outscale.com/en/userguide/Resource-Identifiers.html#_outscale_resource_names_orns). + description: |- + The OUTSCALE Resource Name (ORN) of the server certificate. For more information, see [Resource Identifiers > OUTSCALE Resource Names (ORNs)](https://docs.outscale.com/en/userguide/Resource-Identifiers.html#_outscale_resource_names_orns).
+ This parameter is required for `HTTPS` and `SSL` protocols. type: string required: - BackendPort @@ -7440,10 +7538,12 @@ components: description: Information about the policy entities. properties: Accounts: + description: The accounts linked to the specified policy. items: "$ref": "#/components/schemas/MinimalPolicy" type: array Groups: + description: The groups linked to the specified policy. items: "$ref": "#/components/schemas/MinimalPolicy" type: array @@ -7462,6 +7562,7 @@ components: allowed. type: boolean Users: + description: The users linked to the specified policy. items: "$ref": "#/components/schemas/MinimalPolicy" type: array @@ -7816,7 +7917,7 @@ components: ResultsPerPage: default: 100 description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer With: "$ref": "#/components/schemas/With" @@ -7910,7 +8011,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadClientGatewaysResponse: @@ -7971,11 +8072,11 @@ components: type: string Overall: default: false - description: By default or if false, returns only the consumption of the - specific account that sends this request. If true, returns either the - overall consumption of your paying account and all linked accounts (if - the account that sends this request is a paying account) or returns nothing - (if the account that sends this request is a linked account). + description: If false, returns only the consumption of the specific account + that sends this request. If true, returns either the overall consumption + of your paying account and all linked accounts (if the account that sends + this request is a paying account) or returns nothing (if the account that + sends this request is a linked account). type: boolean ShowPrice: description: If true, the response also includes the unit price of the consumed @@ -8027,7 +8128,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadDedicatedGroupsResponse: @@ -8062,7 +8163,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadDhcpOptionsResponse: @@ -8097,7 +8198,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadDirectLinkInterfacesResponse: @@ -8132,7 +8233,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadDirectLinksResponse: @@ -8155,8 +8256,8 @@ components: additionalProperties: false properties: EntitiesType: - description: The type of entity linked to the policy (`ACCOUNT` \| `USER` - \| `GROUP`) you want to get information about. + description: The type of entity linked to the policy you want to get information + about. items: enum: - ACCOUNT @@ -8242,7 +8343,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadImageExportTasksResponse: @@ -8277,7 +8378,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadImagesResponse: @@ -8312,7 +8413,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadInternetServicesResponse: @@ -8501,7 +8602,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadLocationsResponse: @@ -8580,7 +8681,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadNatServicesResponse: @@ -8615,7 +8716,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadNetAccessPointServicesResponse: @@ -8650,7 +8751,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadNetAccessPointsResponse: @@ -8685,7 +8786,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadNetPeeringsResponse: @@ -8720,7 +8821,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadNetsResponse: @@ -8755,7 +8856,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadNicsResponse: @@ -8927,7 +9028,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadProductTypesResponse: @@ -8976,7 +9077,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadPublicIpRangesResponse: @@ -9012,7 +9113,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadPublicIpsResponse: @@ -9047,7 +9148,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadQuotasResponse: @@ -9101,7 +9202,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadRouteTablesResponse: @@ -9136,7 +9237,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadSecurityGroupsResponse: @@ -9192,7 +9293,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadSnapshotExportTasksResponse: @@ -9227,7 +9328,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadSnapshotsResponse: @@ -9262,7 +9363,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadSubnetsResponse: @@ -9297,7 +9398,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadSubregionsResponse: @@ -9332,7 +9433,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadTagsResponse: @@ -9657,7 +9758,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadVirtualGatewaysResponse: @@ -9692,6 +9793,7 @@ components: ResponseContext: "$ref": "#/components/schemas/ResponseContext" VmGroups: + description: Information about one or more VM groups. items: "$ref": "#/components/schemas/VmGroup" type: array @@ -9733,7 +9835,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadVmTypesResponse: @@ -9797,7 +9899,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadVmsResponse: @@ -9821,8 +9923,8 @@ components: properties: AllVms: default: false - description: If true, includes the status of all VMs. By default or if set - to false, only includes the status of running VMs. + description: If true, includes the status of all VMs. If false, only includes + the status of running VMs. type: boolean DryRun: description: If true, checks whether you have the required permissions to @@ -9837,7 +9939,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadVmsStateResponse: @@ -9872,7 +9974,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadVolumesResponse: @@ -9907,7 +10009,7 @@ components: type: string ResultsPerPage: description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + `1` and `1000`, both included). type: integer type: object ReadVpnConnectionsResponse: @@ -10208,8 +10310,8 @@ components: "$ref": "#/components/schemas/ResponseContext" type: object SecureBootAction: - description: One action to perform on the next boot of the VM (`enable` | `disable` - | `setup-mode` |`none`). + description: One action to perform on the next boot of the VM. For more information, + see [About Secure Boot](https://docs.outscale.com/en/userguide/About-Secure-Boot.html#_secure_boot_actions). enum: - enable - disable @@ -10441,7 +10543,7 @@ components: type: string State: description: The state of the snapshot export task (`pending` \| `active` - \| `completed` \| `failed`). + \| `completed` \| `cancelled` \| `failed`). type: string Tags: description: One or more tags associated with the snapshot export task. @@ -11134,7 +11236,7 @@ components: type: boolean Mtu: description: The maximum transmission unit (MTU) of the DirectLink interface, - in bytes (always `1500`). + in bytes. enum: - 1500 type: integer @@ -11706,7 +11808,7 @@ components: enabled. If false, it is disabled." type: boolean Performance: - description: The performance of the VM (`medium` \| `high` \| `highest`). + description: The performance of the VM. enum: - medium - high @@ -11854,6 +11956,10 @@ components: user. format: date-time type: string + OutscaleLoginAllowed: + description: Whether the user is allowed to log in to Cockpit v2 using its + Outscale credentials when identity federation is activated. + type: boolean Path: description: The path to the EIM user. type: string @@ -12007,7 +12113,7 @@ components: description: Indicates the operating system (OS) of the VM. type: string Performance: - description: The performance of the VM (`medium` \| `high` \| `highest`). + description: The performance of the VM. type: string Placement: "$ref": "#/components/schemas/Placement" @@ -12085,10 +12191,10 @@ components: description: The description of the VM group. type: string PositioningStrategy: - description: The positioning strategy of the VMs on hypervisors. By default, - or if set to `no-strategy`, TINA determines the most adequate position - for the VMs. If set to `attract`, the VMs are deployed on the same hypervisor, - which improves network performance. If set to `repulse`, the VMs are deployed + description: The positioning strategy of the VMs on hypervisors. If set + to `no-strategy`, TINA determines the most adequate position for the VMs. + If set to `attract`, the VMs are deployed on the same hypervisor, which + improves network performance. If set to `repulse`, the VMs are deployed on a different hypervisor, which improves fault tolerance. enum: - attract @@ -12101,8 +12207,7 @@ components: type: string type: array State: - description: The state of the VM group (`pending` \| `available` \| `scaling - up` \| `scaling down` \| `deleting` \| `deleted`). + description: The state of the VM group. enum: - available - deleted @@ -12115,7 +12220,7 @@ components: description: The ID of the Subnet for the VM group. type: string Tags: - description: One or more tags associated with the VM. + description: One or more tags associated with the VM group. items: "$ref": "#/components/schemas/ResourceTag" type: array @@ -12293,7 +12398,7 @@ components: type: string State: description: The state of the volume (`creating` \| `available` \| `in-use` - \| `updating` \| `deleting` \| `error`). + \| `deleting` \| `error`). type: string SubregionName: description: The Subregion in which the volume was created. @@ -12380,73 +12485,69 @@ components: properties: AccountId: default: true - description: By default or if set to true, the account ID is displayed. + description: If true, the account ID is displayed. type: boolean CallDuration: default: true - description: By default or if set to true, the duration of the call is displayed. + description: If true, the duration of the call is displayed. type: boolean QueryAccessKey: default: true - description: By default or if set to true, the access key is displayed. + description: If true, the access key is displayed. type: boolean QueryApiName: default: true - description: By default or if set to true, the name of the API is displayed. + description: If true, the name of the API is displayed. type: boolean QueryApiVersion: default: true - description: By default or if set to true, the version of the API is displayed. + description: If true, the version of the API is displayed. type: boolean QueryCallName: default: true - description: By default or if set to true, the name of the call is displayed. + description: If true, the name of the call is displayed. type: boolean QueryDate: default: true - description: By default or if set to true, the date of the call is displayed. + description: If true, the date of the call is displayed. type: boolean QueryHeaderRaw: default: true - description: By default or if set to true, the raw header of the HTTP request - is displayed. + description: If true, the raw header of the HTTP request is displayed. type: boolean QueryHeaderSize: default: true - description: By default or if set to true, the size of the raw header of - the HTTP request is displayed. + description: If true, the size of the raw header of the HTTP request is + displayed. type: boolean QueryIpAddress: default: true - description: By default or if set to true, the IP is displayed. + description: If true, the IP is displayed. type: boolean QueryPayloadRaw: default: true - description: By default or if set to true, the raw payload of the HTTP request - is displayed. + description: If true, the raw payload of the HTTP request is displayed. type: boolean QueryPayloadSize: default: true - description: By default or if set to true, the size of the raw payload of - the HTTP request is displayed. + description: If true, the size of the raw payload of the HTTP request is + displayed. type: boolean QueryUserAgent: default: true - description: By default or if set to true, the user agent of the HTTP request - is displayed. + description: If true, the user agent of the HTTP request is displayed. type: boolean RequestId: default: true - description: By default or if set to true, the request ID is displayed. + description: If true, the request ID is displayed. type: boolean ResponseSize: default: true - description: By default or if set to true, the size of the response is displayed. + description: If true, the size of the response is displayed. type: boolean ResponseStatusCode: default: true - description: By default or if set to true, the HTTP status code of the response - is displayed. + description: If true, the HTTP status code of the response is displayed. type: boolean type: object securitySchemes: @@ -12528,57 +12629,57 @@ info: url: https://opensource.org/licenses/BSD-3-Clause termsOfService: https://en.outscale.com/terms-of-service/ title: 3DS OUTSCALE API - version: 1.35.3 + version: 1.35.4 x-osc-api-osc-billing: 1.35.0 x-osc-api-osc-cloud-vision: 1.35.0 - x-osc-api-osc-core-iaas: 1.35.3 + x-osc-api-osc-core-iaas: 1.35.4 x-osc-api-type: external openapi: 3.0.0 paths: "/AcceptNetPeering": - description: |- - Accepts a Net peering request.
- To accept this request, you must be the owner of the peer Net. If you do not accept the request within 7 days, the state of the Net peering becomes `expired`.

- - **[NOTE]**
- A peering connection between two Nets works both ways. Therefore, when an A-to-B peering connection is accepted, any pending B-to-A peering connection is automatically rejected as redundant. post: + description: |- + Accepts a Net peering request.
+ To accept this request, you must be the owner of the peer Net. If you do not accept the request within 7 days, the state of the Net peering becomes `expired`.

+ + **[NOTE]**
+ A peering connection between two Nets works both ways. Therefore, when an A-to-B peering connection is accepted, any pending B-to-A peering connection is automatically rejected as redundant. operationId: AcceptNetPeering requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/AcceptNetPeeringRequest" examples: ex1: value: NetPeeringId: pcx-12345678 - schema: - "$ref": "#/components/schemas/AcceptNetPeeringRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/AcceptNetPeeringResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 NetPeering: + Tags: [] + State: + Name: active + Message: Active AccepterNet: - AccountId: '123456789012' - IpRange: 172.16.0.0/16 NetId: vpc-12345678 + IpRange: 172.16.0.0/16 + AccountId: '123456789012' ExpirationDate: '2063-04-05T00:00:00.000Z' - NetPeeringId: pcx-12345678 SourceNet: - AccountId: '123456789012' - IpRange: 10.0.0.0/16 NetId: vpc-12345678 - State: - Message: Active - Name: active - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/AcceptNetPeeringResponse" + IpRange: 10.0.0.0/16 + AccountId: '123456789012' + NetPeeringId: pcx-12345678 description: The HTTP 200 response (OK). '400': content: @@ -12607,12 +12708,14 @@ paths: tags: - NetPeering "/AddUserToUserGroup": - description: Adds a user to a specified group. post: + description: Adds a user to a specified group. operationId: AddUserToUserGroup requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/AddUserToUserGroupRequest" examples: ex1: value: @@ -12620,86 +12723,84 @@ paths: UserGroupPath: "/example/" UserName: example-user UserPath: "/example/" - schema: - "$ref": "#/components/schemas/AddUserToUserGroupRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/AddUserToUserGroupResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/AddUserToUserGroupResponse" description: The HTTP 200 response (OK). tags: - UserGroup "/CheckAuthentication": - description: Validates the authenticity of the account. post: + description: Validates the authenticity of the account. operationId: CheckAuthentication requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CheckAuthenticationRequest" examples: ex1: value: Login: example@example.com Password: "$OSC_PASSWORD" - schema: - "$ref": "#/components/schemas/CheckAuthenticationRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CheckAuthenticationResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CheckAuthenticationResponse" description: The HTTP 200 response (OK). tags: - Account "/CreateAccessKey": - description: |- - Creates an access key for either your root account or an EIM user. The new key is automatically set to `ACTIVE`.

- For more information, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). post: + description: |- + Creates an access key for either your root account or an EIM user. The new key is automatically set to `ACTIVE`.

+ For more information, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). operationId: CreateAccessKey requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateAccessKeyRequest" examples: ex1: value: ExpirationDate: '2063-04-05' Tag: Group1 UserName: example-user - schema: - "$ref": "#/components/schemas/CreateAccessKeyRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateAccessKeyResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 AccessKey: + State: ACTIVE AccessKeyId: ABCDEFGHIJ0123456789 CreationDate: 2010-10-01 12:34:56.789000000 +00:00 ExpirationDate: 2063-04-05 00:00:00.000000000 +00:00 - LastModificationDate: 2010-10-01 12:34:56.789000000 +00:00 SecretKey: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - State: ACTIVE + LastModificationDate: 2010-10-01 12:34:56.789000000 +00:00 Tag: Group1 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateAccessKeyResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -12707,19 +12808,21 @@ paths: tags: - AccessKey "/CreateAccount": - description: |- - Creates an OUTSCALE account.

+ post: + description: |- + Creates an OUTSCALE account.

- **[IMPORTANT]**
- * You need OUTSCALE credentials and the appropriate quotas to create an account via API. To get quotas, you can send an email to sales@outscale.com.
- * If you want to pass a numeral value as a string instead of an integer, you must wrap your string in additional quotes (for example, `'"92000"'`). + **[IMPORTANT]**
+ * You need OUTSCALE credentials and the appropriate quotas to create an account via API. To get quotas, you can send an email to sales@outscale.com.
+ * If you want to pass a numeral value as a string instead of an integer, you must wrap your string in additional quotes (for example, `'"92000"'`). - For more information, see [About Your Account](https://docs.outscale.com/en/userguide/About-Your-Account.html). - post: + For more information, see [About Your Account](https://docs.outscale.com/en/userguide/About-Your-Account.html). operationId: CreateAccount requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateAccountRequest" examples: ex1: value: @@ -12731,99 +12834,97 @@ paths: FirstName: JEAN LastName: DUPONT ZipCode: '92210' - schema: - "$ref": "#/components/schemas/CreateAccountRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateAccountResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Account: - AccountId: '123456789012' - City: SAINT-CLOUD + ZipCode: '92210' CompanyName: EXAMPLE SAS - Country: FRANCE - Email: example@example.com FirstName: JEAN + City: SAINT-CLOUD + Country: FRANCE LastName: DUPONT - ZipCode: '92210' - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateAccountResponse" + AccountId: '123456789012' + Email: example@example.com description: The HTTP 200 response (OK). tags: - Account "/CreateApiAccessRule": - description: |- - Creates a rule to allow access to the API from your account.
- You need to specify at least the `CaIds` or the `IpRanges` parameter.

- - **[NOTE]**
- By default, your account has a set of rules allowing global access, that you can delete.

- For more information, see [About API Access Rules](https://docs.outscale.com/en/userguide/About-API-Access-Rules.html). post: + description: |- + Creates a rule to allow access to the API from your account.
+ You need to specify at least the `CaIds` or the `IpRanges` parameter.

+ + **[NOTE]**
+ By default, your account has a set of rules allowing global access, that you can delete.

+ For more information, see [About API Access Rules](https://docs.outscale.com/en/userguide/About-API-Access-Rules.html). operationId: CreateApiAccessRule requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateApiAccessRuleRequest" examples: ex1: summary: Creating an API access rule based on IPs value: - Description: Basic API Access Rule with IPs IpRanges: - 192.0.2.0 - 198.51.100.0/24 + Description: Basic API Access Rule with IPs ex2: summary: Creating an API access rule based on IPs and Certificate Authority (CA) value: - CaIds: - - ca-fedcba0987654321fedcba0987654321 - Description: API Access Rule with IPs and CA IpRanges: - 192.0.2.0 - 198.51.100.0/24 - schema: - "$ref": "#/components/schemas/CreateApiAccessRuleRequest" + CaIds: + - ca-fedcba0987654321fedcba0987654321 + Description: API Access Rule with IPs and CA responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateApiAccessRuleResponse" examples: ex1: summary: Creating an API access rule based on IPs value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ApiAccessRule: + IpRanges: + - 192.0.2.0 + - 198.51.100.0/24 ApiAccessRuleId: aar-fedcba0987654321fedcba0987654321 CaIds: [] Cns: [] Description: Basic API Access Rule with IPs - IpRanges: - - 192.0.2.0 - - 198.51.100.0/24 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Creating an API access rule based on IPs and Certificate Authority (CA) value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ApiAccessRule: + IpRanges: + - 192.0.2.0 + - 198.51.100.0/24 ApiAccessRuleId: aar-fedcba0987654321fedcba0987654321 CaIds: - ca-fedcba0987654321fedcba0987654321 Cns: [] Description: API Access Rule with IPs and CA - IpRanges: - - 192.0.2.0 - - 198.51.100.0/24 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateApiAccessRuleResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -12831,36 +12932,36 @@ paths: tags: - ApiAccessRule "/CreateCa": - description: |- - Creates a Client Certificate Authority (CA).

- For more information, see [About API Access Rules](https://docs.outscale.com/en/userguide/About-API-Access-Rules.html). post: + description: |- + Creates a Client Certificate Authority (CA).

+ For more information, see [About API Access Rules](https://docs.outscale.com/en/userguide/About-API-Access-Rules.html). operationId: CreateCa requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateCaRequest" examples: ex1: value: CaPem: XXXX Description: CA example - schema: - "$ref": "#/components/schemas/CreateCaRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateCaResponse" examples: ex1: value: - Ca: - CaFingerprint: 1234567890abcdef1234567890abcdef12345678 - CaId: ca-fedcba0987654321fedcba0987654321 - Description: CA example ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateCaResponse" + Ca: + Description: CA example + CaId: ca-fedcba0987654321fedcba0987654321 + CaFingerprint: 1234567890abcdef1234567890abcdef12345678 description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -12868,84 +12969,84 @@ paths: tags: - Ca "/CreateClientGateway": - description: |- - Provides information about your client gateway.
- This action registers information to identify the client gateway that you deployed in your network.
- To open a tunnel to the client gateway, you must provide the communication protocol type, the fixed public IP of the gateway, and an Autonomous System Number (ASN).

- For more information, see [About Client Gateways](https://docs.outscale.com/en/userguide/About-Client-Gateways.html). post: + description: |- + Provides information about your client gateway.
+ This action registers information to identify the client gateway that you deployed in your network.
+ To open a tunnel to the client gateway, you must provide the communication protocol type, the fixed public IP of the gateway, and an Autonomous System Number (ASN).

+ For more information, see [About Client Gateways](https://docs.outscale.com/en/userguide/About-Client-Gateways.html). operationId: CreateClientGateway requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateClientGatewayRequest" examples: ex1: value: - BgpAsn: 65000 ConnectionType: ipsec.1 PublicIp: 192.0.2.0 - schema: - "$ref": "#/components/schemas/CreateClientGatewayRequest" + BgpAsn: 65000 responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateClientGatewayResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ClientGateway: + State: available BgpAsn: 65000 + Tags: [] ClientGatewayId: cgw-12345678 ConnectionType: ipsec.1 PublicIp: 192.0.2.0 - State: available - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateClientGatewayResponse" description: The HTTP 200 response (OK). tags: - ClientGateway "/CreateDedicatedGroup": - description: |- - > [WARNING]
- > This feature is currently in beta.
- - Creates a dedicated group for virtual machines (VMs).

- For more information, see [About Dedicated Groups](https://docs.outscale.com/en/userguide/About-Dedicated-Groups.html). post: + description: |- + > [WARNING]
+ > This feature is currently in beta.
+ + Creates a dedicated group for virtual machines (VMs).

+ For more information, see [About Dedicated Groups](https://docs.outscale.com/en/userguide/About-Dedicated-Groups.html). operationId: CreateDedicatedGroup requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateDedicatedGroupRequest" examples: ex1: value: CpuGeneration: 4 Name: dedicated-group-example SubregionName: eu-west-2a - schema: - "$ref": "#/components/schemas/CreateDedicatedGroupRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateDedicatedGroupResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 DedicatedGroup: + VmIds: [] + NetIds: [] AccountId: '123456789012' CpuGeneration: 4 - DedicatedGroupId: ded-12345678 Name: dedicated-group-example - NetIds: [] SubregionName: eu-west-2a - VmIds: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateDedicatedGroupResponse" + DedicatedGroupId: ded-12345678 description: The HTTP 200 response (OK). '400': content: @@ -12968,14 +13069,16 @@ paths: tags: - DedicatedGroup "/CreateDhcpOptions": - description: |- - Creates a set of DHCP options, that you can then associate with a Net using the [UpdateNet](#updatenet) method.

- For more information, see [About DHCP Options](https://docs.outscale.com/en/userguide/About-DHCP-Options.html). post: + description: |- + Creates a set of DHCP options, that you can then associate with a Net using the [UpdateNet](#updatenet) method.

+ For more information, see [About DHCP Options](https://docs.outscale.com/en/userguide/About-DHCP-Options.html). operationId: CreateDhcpOptions requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateDhcpOptionsRequest" examples: ex1: value: @@ -12986,57 +13089,59 @@ paths: NtpServers: - 203.0.113.0 - 203.0.113.1 - schema: - "$ref": "#/components/schemas/CreateDhcpOptionsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateDhcpOptionsResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 DhcpOptionsSet: + Tags: [] + NtpServers: + - 203.0.113.0 + - 203.0.113.1 Default: false DhcpOptionsSetId: dopt-12345678 DomainName: example.com DomainNameServers: - 192.0.2.0 - 198.51.100.0 - NtpServers: - - 203.0.113.0 - - 203.0.113.1 - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateDhcpOptionsResponse" description: The HTTP 200 response (OK). tags: - DhcpOption "/CreateDirectLink": - description: |- - Creates a DirectLink between a customer network and a specified DirectLink location.

- For more information, see [About DirectLink](https://docs.outscale.com/en/userguide/About-DirectLink.html). post: + description: |- + Creates a DirectLink between a customer network and a specified DirectLink location.

+ For more information, see [About DirectLink](https://docs.outscale.com/en/userguide/About-DirectLink.html). operationId: CreateDirectLink requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateDirectLinkRequest" examples: ex1: value: + Location: PAR1 Bandwidth: 1Gbps DirectLinkName: Connection to Outscale - Location: PAR1 - schema: - "$ref": "#/components/schemas/CreateDirectLinkRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateDirectLinkResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 DirectLink: AccountId: '123456789012' Bandwidth: 1Gbps @@ -13045,130 +13150,128 @@ paths: Location: PAR1 RegionName: eu-west-2 State: requested - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateDirectLinkResponse" description: The HTTP 200 response (OK). tags: - DirectLink "/CreateDirectLinkInterface": - description: |- - Creates a DirectLink interface.
- DirectLink interfaces enable you to reach one of your Nets through a virtual gateway.

- For more information, see [About DirectLink](https://docs.outscale.com/en/userguide/About-DirectLink.html). post: + description: |- + Creates a DirectLink interface.
+ DirectLink interfaces enable you to reach one of your Nets through a virtual gateway.

+ For more information, see [About DirectLink](https://docs.outscale.com/en/userguide/About-DirectLink.html). operationId: CreateDirectLinkInterface requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateDirectLinkInterfaceRequest" examples: ex1: value: DirectLinkId: dxcon-12345678 DirectLinkInterface: + DirectLinkInterfaceName: MyDirectLinkInterface + Vlan: 101 BgpAsn: 65000 BgpKey: tgyn26example - ClientPrivateIp: 172.16.0.5/30 - DirectLinkInterfaceName: MyDirectLinkInterface OutscalePrivateIp: 172.16.0.4/30 + ClientPrivateIp: 172.16.0.5/30 VirtualGatewayId: vgw-12345678 - Vlan: 101 - schema: - "$ref": "#/components/schemas/CreateDirectLinkInterfaceRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateDirectLinkInterfaceResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 DirectLinkInterface: - AccountId: '123456789012' + Vlan: 101 + OutscalePrivateIp: 172.16.0.4/30 + DirectLinkInterfaceId: dxvif-12345678 BgpAsn: 65000 + AccountId: '123456789012' ClientPrivateIp: 172.16.0.5/30 - DirectLinkId: dxcon-12345678 - DirectLinkInterfaceId: dxvif-12345678 + VirtualGatewayId: vgw-12345678 DirectLinkInterfaceName: MyDirectLinkInterface - InterfaceType: private - Location: PAR1 + DirectLinkId: dxcon-12345678 Mtu: 1500 - OutscalePrivateIp: 172.16.0.4/30 State: pending - VirtualGatewayId: vgw-12345678 - Vlan: 101 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateDirectLinkInterfaceResponse" + InterfaceType: private + Location: PAR1 description: The HTTP 200 response (OK). tags: - DirectLinkInterface "/CreateFlexibleGpu": - description: |- - Allocates a flexible GPU (fGPU) to your account.
- You can then attach this fGPU to a virtual machine (VM).

- For more information, see [About Flexible GPUs](https://docs.outscale.com/en/userguide/About-Flexible-GPUs.html). post: + description: |- + Allocates a flexible GPU (fGPU) to your account.
+ You can then attach this fGPU to a virtual machine (VM).

+ For more information, see [About Flexible GPUs](https://docs.outscale.com/en/userguide/About-Flexible-GPUs.html). operationId: CreateFlexibleGpu requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateFlexibleGpuRequest" examples: ex1: value: - DeleteOnVmDeletion: true - Generation: v5 ModelName: nvidia-p100 + Generation: v5 SubregionName: eu-west-2a - schema: - "$ref": "#/components/schemas/CreateFlexibleGpuRequest" + DeleteOnVmDeletion: true responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateFlexibleGpuResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 FlexibleGpu: + SubregionName: eu-west-2a DeleteOnVmDeletion: true - FlexibleGpuId: fgpu-12345678 Generation: v5 ModelName: nvidia-p100 State: allocated - SubregionName: eu-west-2a - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateFlexibleGpuResponse" + FlexibleGpuId: fgpu-12345678 description: The HTTP 200 response (OK). tags: - FlexibleGpu "/CreateImage": - description: |- - Creates an OUTSCALE machine image (OMI).
- You can use this method for different use cases: - * **Creating from a VM**: You create an OMI from one of your virtual machines (VMs).
- * **Copying an OMI**: You copy an existing OMI. The source OMI can be one of your own OMIs, or an OMI owned by another account that has granted you permission via the [UpdateImage](#updateimage) method.
- * **Registering from a snapshot**: You register an OMI from an existing snapshot. The source snapshot can be one of your own snapshots, or a snapshot owned by another account that has granted you permission via the [UpdateSnapshot](#updatesnapshot) method.
- * **Registering from a bucket by using a manifest file**: You register an OMI from the manifest file of an OMI that was exported to an OUTSCALE Object Storage (OOS) bucket. First, the owner of the source OMI must export it to the bucket by using the [CreateImageExportTask](#createimageexporttask) method. Then, they must grant you permission to read the manifest file via a pre-signed URL. For more information, see [Creating a Pre-Signed URL](https://docs.outscale.com/en/userguide/Creating-a-Pre-Signed-URL.html). + post: + description: |- + Creates an OUTSCALE machine image (OMI).
+ You can use this method for different use cases: + * **Creating from a VM**: You create an OMI from one of your virtual machines (VMs).
+ * **Copying an OMI**: You copy an existing OMI. The source OMI can be one of your own OMIs, or an OMI owned by another account that has granted you permission via the [UpdateImage](#updateimage) method.
+ * **Registering from a snapshot**: You register an OMI from an existing snapshot. The source snapshot can be one of your own snapshots, or a snapshot owned by another account that has granted you permission via the [UpdateSnapshot](#updatesnapshot) method.
+ * **Registering from a bucket by using a manifest file**: You register an OMI from the manifest file of an OMI that was exported to an OUTSCALE Object Storage (OOS) bucket. First, the owner of the source OMI must export it to the bucket by using the [CreateImageExportTask](#createimageexporttask) method. Then, they must grant you permission to read the manifest file via a pre-signed URL. For more information, see [Creating a Pre-Signed URL](https://docs.outscale.com/en/userguide/Creating-a-Pre-Signed-URL.html). - **[TIP]**
- Registering from a bucket enables you to copy an OMI across Regions. + **[TIP]**
+ Registering from a bucket enables you to copy an OMI across Regions. - For more information, see [About OMIs](https://docs.outscale.com/en/userguide/About-OMIs.html). - post: + For more information, see [About OMIs](https://docs.outscale.com/en/userguide/About-OMIs.html). operationId: CreateImage requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateImageRequest" examples: ex1: summary: Creating from a VM value: ImageName: create-image-example - NoReboot: true VmId: i-12345678 + NoReboot: true ex2: summary: Copying an OMI value: @@ -13178,163 +13281,161 @@ paths: ex3: summary: Registering from a snapshot value: + ImageName: register-image-from-snapshot-example BlockDeviceMappings: - - Bsu: - DeleteOnVmDeletion: true - Iops: 150 + - DeviceName: "/dev/sda1" + Bsu: SnapshotId: snap-12345678 VolumeSize: 120 VolumeType: io1 - DeviceName: "/dev/sda1" - ImageName: register-image-from-snapshot-example + Iops: 150 + DeleteOnVmDeletion: true RootDeviceName: "/dev/sda1" ex4: summary: Registering from a bucket by using a manifest file value: - FileLocation: https://oos.eu-west-2.outscale.com/BUCKET/KEY?AWSAccessKeyId=ABCDEFGHIJ0123456789&Expires=1493372309&Signature=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX ImageName: register-image-from-bucket-example - schema: - "$ref": "#/components/schemas/CreateImageRequest" + FileLocation: https://oos.eu-west-2.outscale.com/BUCKET/KEY?AWSAccessKeyId=ABCDEFGHIJ0123456789&Expires=1493372309&Signature=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateImageResponse" examples: ex1: summary: Creating from a VM value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Image: + StateComment: {} + State: pending + RootDeviceType: bsu + RootDeviceName: "/dev/sda1" + ProductCodes: + - '0001' + PermissionsToLaunch: + GlobalPermission: false + AccountIds: [] AccountId: '123456789012' - Architecture: x86_64 + Tags: [] + Description: '' + ImageId: ami-12345678 BlockDeviceMappings: - - Bsu: + - DeviceName: "/dev/sda1" + Bsu: + VolumeType: standard DeleteOnVmDeletion: true - SnapshotId: snap-12345678 VolumeSize: 50 - VolumeType: standard - DeviceName: "/dev/sda1" + SnapshotId: snap-12345678 BootModes: - legacy + ImageType: machine CreationDate: '2010-10-01T12:34:56.789Z' - Description: '' FileLocation: 123456789012/create-image-example - ImageId: ami-12345678 + Architecture: x86_64 ImageName: create-image-example - ImageType: machine - PermissionsToLaunch: - AccountIds: [] - GlobalPermission: false - ProductCodes: - - '0001' - RootDeviceName: "/dev/sda1" - RootDeviceType: bsu - State: pending - StateComment: {} - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Copying an OMI value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Image: + StateComment: {} + State: available + RootDeviceType: bsu + RootDeviceName: "/dev/sda1" + ProductCodes: + - '0001' + PermissionsToLaunch: + GlobalPermission: false + AccountIds: [] AccountId: '123456789012' - Architecture: x86_64 + Tags: [] + Description: '' + ImageId: ami-12345678 BlockDeviceMappings: - - Bsu: + - DeviceName: "/dev/sda1" + Bsu: + VolumeType: standard DeleteOnVmDeletion: true - SnapshotId: snap-12345678 VolumeSize: 50 - VolumeType: standard - DeviceName: "/dev/sda1" + SnapshotId: snap-12345678 BootModes: - legacy + ImageType: machine CreationDate: '2010-10-01T12:34:56.789Z' - Description: '' FileLocation: 123456789012/copy-image-example - ImageId: ami-12345678 + Architecture: x86_64 ImageName: copy-image-example - ImageType: machine - PermissionsToLaunch: - AccountIds: [] - GlobalPermission: false - ProductCodes: - - '0001' - RootDeviceName: "/dev/sda1" - RootDeviceType: bsu - State: available - StateComment: {} - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex3: summary: Registering from a snapshot value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Image: + StateComment: {} + State: available + RootDeviceType: bsu + RootDeviceName: "/dev/sda1" + ProductCodes: + - '0001' + PermissionsToLaunch: + GlobalPermission: false + AccountIds: [] AccountId: '123456789012' - Architecture: x86_64 + Tags: [] + Description: '' + ImageId: ami-12345678 BlockDeviceMappings: - - Bsu: + - DeviceName: "/dev/sda1" + Bsu: + VolumeType: io1 DeleteOnVmDeletion: true + VolumeSize: 120 Iops: 150 SnapshotId: snap-12345678 - VolumeSize: 120 - VolumeType: io1 - DeviceName: "/dev/sda1" BootModes: - legacy + ImageType: machine CreationDate: '2010-10-01T12:34:56.789Z' - Description: '' FileLocation: 123456789012/register-image-from-snapshot-example - ImageId: ami-12345678 + Architecture: x86_64 ImageName: register-image-from-snapshot-example - ImageType: machine - PermissionsToLaunch: - AccountIds: [] - GlobalPermission: false - ProductCodes: - - '0001' - RootDeviceName: "/dev/sda1" - RootDeviceType: bsu - State: available - StateComment: {} - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex4: summary: Registering from a bucket by using a manifest file value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Image: + StateComment: {} + State: pending + RootDeviceType: bsu + RootDeviceName: "/dev/sda1" + ProductCodes: + - '0001' + PermissionsToLaunch: + GlobalPermission: false + AccountIds: [] AccountId: '123456789012' - Architecture: x86_64 + Tags: [] + Description: '' + ImageId: ami-12345678 BlockDeviceMappings: - - Bsu: + - DeviceName: "/dev/sda1" + Bsu: + VolumeType: standard DeleteOnVmDeletion: true - SnapshotId: snap-12345678 VolumeSize: 50 - VolumeType: standard - DeviceName: "/dev/sda1" + SnapshotId: snap-12345678 BootModes: - legacy + ImageType: machine CreationDate: '2010-10-01T12:34:56.789Z' - Description: '' FileLocation: https://oos.eu-west-2.outscale.com/BUCKET/KEY?AWSAccessKeyId=ABCDEFGHIJ0123456789&Expires=1493372309&Signature=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - ImageId: ami-12345678 + Architecture: x86_64 ImageName: register-image-from-bucket-example - ImageType: machine - PermissionsToLaunch: - AccountIds: [] - GlobalPermission: false - ProductCodes: - - '0001' - RootDeviceName: "/dev/sda1" - RootDeviceType: bsu - State: pending - StateComment: {} - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateImageResponse" description: The HTTP 200 response (OK). '400': content: @@ -13357,20 +13458,22 @@ paths: tags: - Image "/CreateImageExportTask": - description: |- - Exports an OUTSCALE machine image (OMI) to an OUTSCALE Object Storage (OOS) bucket.
- This enables you to copy an OMI between accounts in different Regions.

- This action creates the necessary snapshots and manifest file in the bucket. The OMI can then be imported to another account using a pre-signed URL of its manifest file. For more information, see [Creating a Pre-Signed URL](https://docs.outscale.com/en/userguide/Creating-a-Pre-Signed-URL.html).

- To copy an OMI in the same Region, you can also use the [CreateImage](#createimage) method.
- - **[IMPORTANT]**
- You cannot export a shared or public OMI, as they do not belong to you. To do so, you must first copy it to your account. The copy then belongs to you and you can export it.

- For more information, see [About OMIs](https://docs.outscale.com/en/userguide/About-OMIs.html). post: + description: |- + Exports an OUTSCALE machine image (OMI) to an OUTSCALE Object Storage (OOS) bucket.
+ This enables you to copy an OMI between accounts in different Regions.

+ This action creates the necessary snapshots and manifest file in the bucket. The OMI can then be imported to another account using a pre-signed URL of its manifest file. For more information, see [Creating a Pre-Signed URL](https://docs.outscale.com/en/userguide/Creating-a-Pre-Signed-URL.html).

+ To copy an OMI in the same Region, you can also use the [CreateImage](#createimage) method.
+ + **[IMPORTANT]**
+ You cannot export a shared or public OMI, as they do not belong to you. To do so, you must first copy it to your account. The copy then belongs to you and you can export it.

+ For more information, see [About OMIs](https://docs.outscale.com/en/userguide/About-OMIs.html). operationId: CreateImageExportTask requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateImageExportTaskRequest" examples: ex1: value: @@ -13379,62 +13482,60 @@ paths: DiskImageFormat: qcow2 OsuBucket: BUCKET OsuPrefix: PREFIX - schema: - "$ref": "#/components/schemas/CreateImageExportTaskRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateImageExportTaskResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ImageExportTask: - Comment: Export of image ami-12345678 + Tags: [] ImageId: ami-12345678 + TaskId: image-export-12345678 + Comment: Export of image ami-12345678 OsuExport: - DiskImageFormat: qcow2 - OsuBucket: BUCKET OsuPrefix: PREFIX/ami-12345678/ - Progress: 0 + OsuBucket: BUCKET + DiskImageFormat: qcow2 State: pending/queued - Tags: [] - TaskId: image-export-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateImageExportTaskResponse" + Progress: 0 description: The HTTP 200 response (OK). tags: - Image "/CreateInternetService": - description: |- - Creates an internet service you can use with a Net.
- An internet service enables virtual machines (VMs) launched in a Net to connect to the Internet. It allows routing of incoming and outgoing Internet traffic and management of public IP addresses.

- For more information, see [About Internet Services](https://docs.outscale.com/en/userguide/About-Internet-Services.html). post: + description: |- + Creates an internet service you can use with a Net.
+ An internet service enables virtual machines (VMs) launched in a Net to connect to the Internet. It allows routing of incoming and outgoing Internet traffic and management of public IP addresses.

+ For more information, see [About Internet Services](https://docs.outscale.com/en/userguide/About-Internet-Services.html). operationId: CreateInternetService requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateInternetServiceRequest" examples: ex1: value: {} - schema: - "$ref": "#/components/schemas/CreateInternetServiceRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateInternetServiceResponse" examples: ex1: value: - InternetService: - InternetServiceId: igw-12345678 - Tags: [] ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateInternetServiceResponse" + InternetService: + Tags: [] + InternetServiceId: igw-12345678 description: The HTTP 200 response (OK). '400': content: @@ -13457,19 +13558,21 @@ paths: tags: - InternetService "/CreateKeypair": - description: |- - Creates a keypair to use with your virtual machines (VMs).
- You can use this method in two different ways: - * **Creating a keypair**: In that case, 3DS OUTSCALE creates a 2048-bit RSA keypair, stores its public key in your account, and returns its private key in the response of the call so that you can save it in a file.
- When you save the returned private key, make sure you replace the `\n` escape sequences with real line breaks. - * **Importing a keypair created locally**: If you already have a keypair that you have created locally with a third-party tool, you can import its public key in your account. The following types of key can be imported: RSA (2048 bits or preferably 4096 bits), Ed25519, and ECDSA (256 bits, 384 bits, or 521 bits). The following formats can be used: PEM, PKCS8, RFC4716, and OpenSSH. - - For more information, see [About Keypairs](https://docs.outscale.com/en/userguide/About-Keypairs.html). post: + description: |- + Creates a keypair to use with your virtual machines (VMs).
+ You can use this method in two different ways: + * **Creating a keypair**: In that case, 3DS OUTSCALE creates a 2048-bit RSA keypair, stores its public key in your account, and returns its private key in the response of the call so that you can save it in a file.
+ When you save the returned private key, make sure you replace the `\n` escape sequences with real line breaks. + * **Importing a keypair created locally**: If you already have a keypair that you have created locally with a third-party tool, you can import its public key in your account. The following types of key can be imported: RSA (2048 bits or preferably 4096 bits), Ed25519, and ECDSA (256 bits, 384 bits, or 521 bits). The following formats can be used: PEM, PKCS8, RFC4716, and OpenSSH. + + For more information, see [About Keypairs](https://docs.outscale.com/en/userguide/About-Keypairs.html). operationId: CreateKeypair requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateKeypairRequest" examples: ex1: summary: Creating a keypair @@ -13480,39 +13583,37 @@ paths: value: KeypairName: import-keypair-example PublicKey: "..." - schema: - "$ref": "#/components/schemas/CreateKeypairRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateKeypairResponse" examples: ex1: summary: Creating a keypair value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Keypair: - KeypairFingerprint: 11:22:33:44:55:66:77:88:99:00:aa:bb:cc:dd:ee:ff - KeypairId: key-abcdef1234567890abcdef1234567890 - KeypairName: create-keypair-example - KeypairType: ssh-rsa PrivateKey: |- -----BEGIN RSA PRIVATE KEY----- ... -----END RSA PRIVATE KEY----- - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + KeypairType: ssh-rsa + KeypairName: create-keypair-example + KeypairId: key-abcdef1234567890abcdef1234567890 + KeypairFingerprint: 11:22:33:44:55:66:77:88:99:00:aa:bb:cc:dd:ee:ff ex2: summary: Importing a keypair created locally value: - Keypair: - KeypairFingerprint: 11:22:33:44:55:66:77:88:99:00:aa:bb:cc:dd:ee:ff - KeypairId: key-abcdef1234567890abcdef1234567890 - KeypairName: create-keypair-example - KeypairType: ssh-rsa ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateKeypairResponse" + Keypair: + KeypairType: ssh-rsa + KeypairName: create-keypair-example + KeypairId: key-abcdef1234567890abcdef1234567890 + KeypairFingerprint: 11:22:33:44:55:66:77:88:99:00:aa:bb:cc:dd:ee:ff description: The HTTP 200 response (OK). '400': content: @@ -13541,15 +13642,17 @@ paths: tags: - Keypair "/CreateListenerRule": - description: |- - Creates a rule for traffic redirection for the specified listener. Each rule must have either the `HostNamePattern` or `PathPattern` parameter specified. Rules are treated in priority order, from the highest value to the lowest value.
- Once the rule is created, you need to register backend VMs with it. For more information, see the [RegisterVmsInLoadBalancer](#registervmsinloadbalancer) method.

- For more information, see [About Load Balancers](https://docs.outscale.com/en/userguide/About-Load-Balancers.html). post: + description: |- + Creates a rule for traffic redirection for the specified listener. Each rule must have either the `HostNamePattern` or `PathPattern` parameter specified. Rules are treated in priority order, from the highest value to the lowest value.
+ Once the rule is created, you need to register backend VMs with it. For more information, see the [RegisterVmsInLoadBalancer](#registervmsinloadbalancer) method.

+ For more information, see [About Load Balancers](https://docs.outscale.com/en/userguide/About-Load-Balancers.html). operationId: CreateListenerRule requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateListenerRuleRequest" examples: ex1: summary: Creating a listener rule based on a host pattern @@ -13572,274 +13675,290 @@ paths: LoadBalancerPort: 80 ListenerRule: Action: forward - ListenerRuleName: example-listener-rule PathPattern: "/docs/*" + ListenerRuleName: example-listener-rule Priority: 100 VmIds: - i-12345678 - schema: - "$ref": "#/components/schemas/CreateListenerRuleRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateListenerRuleResponse" examples: ex1: summary: Creating a listener rule based on a host pattern value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ListenerRule: - Action: forward - HostNamePattern: "*.example.com" - ListenerId: 123456 - ListenerRuleId: 1234 - ListenerRuleName: example-listener-rule Priority: 10 VmIds: - i-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ListenerRuleName: example-listener-rule + Action: forward + ListenerId: 123456 + HostNamePattern: "*.example.com" + ListenerRuleId: 1234 ex2: summary: Creating a listener rule based on a path pattern value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ListenerRule: - Action: forward - ListenerId: 123456 - ListenerRuleId: 1234 - ListenerRuleName: example-listener-rule - PathPattern: "/docs/*" Priority: 100 VmIds: - i-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateListenerRuleResponse" + ListenerRuleName: example-listener-rule + Action: forward + ListenerId: 123456 + PathPattern: "/docs/*" + ListenerRuleId: 1234 description: The HTTP 200 response (OK). tags: - Listener "/CreateLoadBalancer": - description: |- - Creates a load balancer.
- The load balancer is created with a unique Domain Name Service (DNS) name. It receives the incoming traffic and routes it to its registered virtual machines (VMs).
- By default, this action creates an Internet-facing load balancer, resolving to public IPs. To create an internal load balancer in a Net, resolving to private IPs, use the `LoadBalancerType` parameter.
- You must specify either the `Subnets` or the `SubregionNames` parameters.

- For more information, see [About Load Balancers](https://docs.outscale.com/en/userguide/About-Load-Balancers.html). post: + description: |- + Creates a load balancer.
+ The load balancer is created with a unique Domain Name Service (DNS) name. It receives the incoming traffic and routes it to its registered virtual machines (VMs).
+ By default, this action creates an Internet-facing load balancer, resolving to public IPs. To create an internal load balancer in a Net, resolving to private IPs, use the `LoadBalancerType` parameter.
+ You must specify either the `Subnets` or the `SubregionNames` parameters.

+ For more information, see [About Load Balancers](https://docs.outscale.com/en/userguide/About-Load-Balancers.html). operationId: CreateLoadBalancer requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateLoadBalancerRequest" examples: ex1: summary: Creating an internal load balancer in a Net value: + LoadBalancerName: private-lb-example Listeners: - BackendPort: 80 BackendProtocol: TCP LoadBalancerPort: 80 LoadBalancerProtocol: TCP - LoadBalancerName: private-lb-example - LoadBalancerType: internal - SecurityGroups: - - sg-12345678 Subnets: - subnet-12345678 + SecurityGroups: + - sg-12345678 + LoadBalancerType: internal ex2: summary: Creating an internet-facing load balancer in a Net value: + LoadBalancerName: private-lb-example Listeners: - BackendPort: 80 BackendProtocol: HTTP LoadBalancerPort: 443 LoadBalancerProtocol: HTTPS ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate - LoadBalancerName: private-lb-example - LoadBalancerType: internet-facing - PublicIp: 192.0.2.0 - SecurityGroups: - - sg-12345678 Subnets: - subnet-12345678 + SecurityGroups: + - sg-12345678 + LoadBalancerType: internet-facing + PublicIp: 192.0.2.0 ex3: summary: Creating an internet-facing load balancer in the public Cloud value: + LoadBalancerName: public-lb-example + SubregionNames: + - eu-west-2a Listeners: - BackendPort: 8080 BackendProtocol: HTTP LoadBalancerPort: 8080 LoadBalancerProtocol: HTTP - LoadBalancerName: public-lb-example - SubregionNames: - - eu-west-2a - schema: - "$ref": "#/components/schemas/CreateLoadBalancerRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateLoadBalancerResponse" examples: ex1: summary: Creating an internal load balancer in a Net value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 LoadBalancer: + Tags: [] + SourceSecurityGroup: + SecurityGroupName: security-group-example + SecurityGroupAccountId: '123456789012' + SecuredCookies: false + Subnets: + - subnet-12345678 + NetId: vpc-12345678 + BackendVmIds: [] + ApplicationStickyCookiePolicies: [] + SecurityGroups: + - sg-12345678 + LoadBalancerType: internal AccessLog: - IsEnabled: false PublicationInterval: 60 - ApplicationStickyCookiePolicies: [] - BackendVmIds: [] + IsEnabled: false DnsName: internal-private-lb-example.123456789.eu-west-2.lbu.outscale.com HealthCheck: + UnhealthyThreshold: 2 + Timeout: 5 CheckInterval: 30 + Protocol: TCP HealthyThreshold: 10 Port: 80 - Protocol: TCP - Timeout: 5 - UnhealthyThreshold: 2 + LoadBalancerStickyCookiePolicies: [] + SubregionNames: + - eu-west-2a Listeners: - BackendPort: 80 BackendProtocol: TCP LoadBalancerPort: 80 LoadBalancerProtocol: TCP LoadBalancerName: private-lb-example - LoadBalancerStickyCookiePolicies: [] - LoadBalancerType: internal - NetId: vpc-12345678 - SecuredCookies: false - SecurityGroups: - - sg-12345678 - SourceSecurityGroup: - SecurityGroupAccountId: '123456789012' - SecurityGroupName: security-group-example - Subnets: - - subnet-12345678 - SubregionNames: - - eu-west-2a - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Creating an internet-facing load balancer in a Net value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 LoadBalancer: - AccessLog: - IsEnabled: false - PublicationInterval: 60 - ApplicationStickyCookiePolicies: [] - BackendVmIds: [] - DnsName: private-lb-example.123456789.eu-west-2.lbu.outscale.com - HealthCheck: - CheckInterval: 30 - HealthyThreshold: 10 - Port: 80 - Protocol: TCP - Timeout: 5 - UnhealthyThreshold: 2 - Listeners: - - BackendPort: 80 - BackendProtocol: HTTP - LoadBalancerPort: 443 - LoadBalancerProtocol: HTTPS - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate - LoadBalancerName: private-lb-example - LoadBalancerStickyCookiePolicies: [] - LoadBalancerType: internet-facing - NetId: vpc-12345678 - PublicIp: 192.0.2.0 - SecuredCookies: false - SecurityGroups: - - sg-12345678 + Tags: [] SourceSecurityGroup: - SecurityGroupAccountId: '123456789012' SecurityGroupName: security-group-example + SecurityGroupAccountId: '123456789012' + SecuredCookies: false + PublicIp: 192.0.2.0 Subnets: - subnet-12345678 + NetId: vpc-12345678 + BackendVmIds: [] + ApplicationStickyCookiePolicies: [] + SecurityGroups: + - sg-12345678 + LoadBalancerType: internet-facing + AccessLog: + PublicationInterval: 60 + IsEnabled: false + DnsName: private-lb-example.123456789.eu-west-2.lbu.outscale.com + HealthCheck: + UnhealthyThreshold: 2 + Timeout: 5 + CheckInterval: 30 + Protocol: TCP + HealthyThreshold: 10 + Port: 80 + LoadBalancerStickyCookiePolicies: [] SubregionNames: - eu-west-2a - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Listeners: + - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate + BackendPort: 80 + BackendProtocol: HTTP + LoadBalancerPort: 443 + LoadBalancerProtocol: HTTPS + LoadBalancerName: private-lb-example ex3: summary: Creating an internet-facing load balancer in the public Cloud value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 LoadBalancer: + Tags: [] + SourceSecurityGroup: + SecurityGroupName: outscale-elb-sg + SecurityGroupAccountId: outscale-elb + SecuredCookies: false + Subnets: [] + BackendVmIds: [] + ApplicationStickyCookiePolicies: [] + LoadBalancerType: internet-facing AccessLog: - IsEnabled: false PublicationInterval: 60 - ApplicationStickyCookiePolicies: [] - BackendVmIds: [] + IsEnabled: false DnsName: public-lb-example.123456789.eu-west-2.lbu.outscale.com HealthCheck: + UnhealthyThreshold: 2 + Timeout: 5 CheckInterval: 30 + Protocol: TCP HealthyThreshold: 10 Port: 8080 - Protocol: TCP - Timeout: 5 - UnhealthyThreshold: 2 + LoadBalancerStickyCookiePolicies: [] + SubregionNames: + - eu-west-2a Listeners: - BackendPort: 8080 BackendProtocol: HTTP LoadBalancerPort: 8080 LoadBalancerProtocol: HTTP LoadBalancerName: public-lb-example - LoadBalancerStickyCookiePolicies: [] - LoadBalancerType: internet-facing - SecuredCookies: false - SourceSecurityGroup: - SecurityGroupAccountId: outscale-elb - SecurityGroupName: outscale-elb-sg - Subnets: [] - SubregionNames: - - eu-west-2a - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateLoadBalancerResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer "/CreateLoadBalancerListeners": - description: |- - Creates one or more listeners for a specified load balancer.

- For more information, see [About Load Balancers](https://docs.outscale.com/en/userguide/About-Load-Balancers.html). post: + description: |- + Creates one or more listeners for a specified load balancer.

+ For more information, see [About Load Balancers](https://docs.outscale.com/en/userguide/About-Load-Balancers.html). operationId: CreateLoadBalancerListeners requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateLoadBalancerListenersRequest" examples: ex1: value: + LoadBalancerName: example-lbu Listeners: - BackendPort: 58 BackendProtocol: TCP LoadBalancerPort: 62 LoadBalancerProtocol: TCP - LoadBalancerName: example-lbu - schema: - "$ref": "#/components/schemas/CreateLoadBalancerListenersRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateLoadBalancerListenersResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 LoadBalancer: + Tags: [] + SourceSecurityGroup: + SecurityGroupName: security-group-example + SecurityGroupAccountId: '123456789012' + SecuredCookies: false + Subnets: + - subnet-12345678 + NetId: vpc-12345678 + BackendVmIds: [] + ApplicationStickyCookiePolicies: [] + SecurityGroups: + - sg-12345678 + LoadBalancerType: internal AccessLog: - IsEnabled: false PublicationInterval: 60 - ApplicationStickyCookiePolicies: [] - BackendVmIds: [] + IsEnabled: false DnsName: internal-example-lbu.123456789.eu-west-2.lbu.outscale.com HealthCheck: + UnhealthyThreshold: 2 + Timeout: 5 CheckInterval: 30 + Protocol: TCP HealthyThreshold: 10 Port: 80 - Protocol: TCP - Timeout: 5 - UnhealthyThreshold: 2 + LoadBalancerStickyCookiePolicies: [] + SubregionNames: + - eu-west-2a Listeners: - BackendPort: 58 BackendProtocol: TCP @@ -13850,42 +13969,26 @@ paths: LoadBalancerPort: 80 LoadBalancerProtocol: TCP LoadBalancerName: example-lbu - LoadBalancerStickyCookiePolicies: [] - LoadBalancerType: internal - NetId: vpc-12345678 - SecuredCookies: false - SecurityGroups: - - sg-12345678 - SourceSecurityGroup: - SecurityGroupAccountId: '123456789012' - SecurityGroupName: security-group-example - Subnets: - - subnet-12345678 - SubregionNames: - - eu-west-2a - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateLoadBalancerListenersResponse" description: The HTTP 200 response (OK). tags: - Listener "/CreateLoadBalancerPolicy": - description: |- - Creates a stickiness policy with sticky session lifetimes defined by the browser lifetime.
- The created policy can be used with HTTP or HTTPS listeners only.
- If this policy is implemented by a load balancer, this load balancer uses this cookie in all incoming requests to direct them to the specified backend server virtual machine (VM). If this cookie is not present, the load balancer sends the request to any other server according to its load-balancing algorithm.

- - You can also create a stickiness policy with sticky session lifetimes following the lifetime of an application-generated cookie.
- Unlike the other type of stickiness policy, the lifetime of the special Load Balancer Unit (LBU) cookie follows the lifetime of the application-generated cookie specified in the policy configuration. The load balancer inserts a new stickiness cookie only when the application response includes a new application cookie.
- The session stops being sticky if the application cookie is removed or expires, until a new application cookie is issued.

- For more information, see [About Load Balancers](https://docs.outscale.com/en/userguide/About-Load-Balancers.html). post: + description: |- + Creates a stickiness policy with sticky session lifetimes defined by the browser lifetime.
+ The created policy can be used with HTTP or HTTPS listeners only.
+ If this policy is implemented by a load balancer, this load balancer uses this cookie in all incoming requests to direct them to the specified backend server virtual machine (VM). If this cookie is not present, the load balancer sends the request to any other server according to its load-balancing algorithm.

+ + You can also create a stickiness policy with sticky session lifetimes following the lifetime of an application-generated cookie.
+ Unlike the other type of stickiness policy, the lifetime of the special Load Balancer Unit (LBU) cookie follows the lifetime of the application-generated cookie specified in the policy configuration. The load balancer inserts a new stickiness cookie only when the application response includes a new application cookie.
+ The session stops being sticky if the application cookie is removed or expires, until a new application cookie is issued.

+ For more information, see [About Load Balancers](https://docs.outscale.com/en/userguide/About-Load-Balancers.html). operationId: CreateLoadBalancerPolicy requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateLoadBalancerPolicyRequest" examples: ex1: summary: Creating a load balancer policy based on browser @@ -13896,112 +13999,112 @@ paths: ex2: summary: Creating a load balancer policy based on application cookie value: - CookieName: example-cookie LoadBalancerName: example-lbu PolicyName: example-app-policy PolicyType: app - schema: - "$ref": "#/components/schemas/CreateLoadBalancerPolicyRequest" + CookieName: example-cookie responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateLoadBalancerPolicyResponse" examples: ex1: summary: Creating a load balancer policy based on browser value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 LoadBalancer: + Tags: [] + SourceSecurityGroup: + SecurityGroupName: default + SecurityGroupAccountId: '123456789012' + Subnets: + - subnet-12345678 + NetId: vpc-12345678 + BackendVmIds: [] + ApplicationStickyCookiePolicies: [] + SecurityGroups: + - sg-12345678 + LoadBalancerType: internet-facing AccessLog: - IsEnabled: false PublicationInterval: 60 - ApplicationStickyCookiePolicies: [] - BackendVmIds: [] + IsEnabled: false DnsName: example-lbu-123456789.eu-west-2.lbu.outscale.com HealthCheck: + UnhealthyThreshold: 2 + Timeout: 5 CheckInterval: 30 + Protocol: TCP HealthyThreshold: 10 Port: 80 - Protocol: TCP - Timeout: 5 - UnhealthyThreshold: 2 + LoadBalancerStickyCookiePolicies: + - PolicyName: example-browser-policy + CookieExpirationPeriod: 1 + SubregionNames: + - eu-west-2a Listeners: - BackendPort: 80 BackendProtocol: HTTP LoadBalancerPort: 80 LoadBalancerProtocol: HTTP LoadBalancerName: example-lbu - LoadBalancerStickyCookiePolicies: - - CookieExpirationPeriod: 1 - PolicyName: example-browser-policy - LoadBalancerType: internet-facing - NetId: vpc-12345678 - SecurityGroups: - - sg-12345678 - SourceSecurityGroup: - SecurityGroupAccountId: '123456789012' - SecurityGroupName: default - Subnets: - - subnet-12345678 - SubregionNames: - - eu-west-2a - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Creating a load balancer policy based on application cookie value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 LoadBalancer: + Tags: [] + SourceSecurityGroup: + SecurityGroupName: default + SecurityGroupAccountId: '123456789012' + Subnets: + - subnet-12345678 + NetId: vpc-12345678 + BackendVmIds: [] + ApplicationStickyCookiePolicies: + - PolicyName: example-app-policy + CookieName: example-cookie + SecurityGroups: + - sg-12345678 + LoadBalancerType: internet-facing AccessLog: - IsEnabled: false PublicationInterval: 60 - ApplicationStickyCookiePolicies: - - CookieName: example-cookie - PolicyName: example-app-policy - BackendVmIds: [] + IsEnabled: false DnsName: example-lbu-123456789.eu-west-2.lbu.outscale.com HealthCheck: + UnhealthyThreshold: 2 + Timeout: 5 CheckInterval: 30 + Protocol: TCP HealthyThreshold: 10 Port: 80 - Protocol: TCP - Timeout: 5 - UnhealthyThreshold: 2 + LoadBalancerStickyCookiePolicies: [] + SubregionNames: + - eu-west-2a Listeners: - BackendPort: 80 BackendProtocol: HTTP LoadBalancerPort: 80 LoadBalancerProtocol: HTTP LoadBalancerName: example-lbu - LoadBalancerStickyCookiePolicies: [] - LoadBalancerType: internet-facing - NetId: vpc-12345678 - SecurityGroups: - - sg-12345678 - SourceSecurityGroup: - SecurityGroupAccountId: '123456789012' - SecurityGroupName: default - Subnets: - - subnet-12345678 - SubregionNames: - - eu-west-2a - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateLoadBalancerPolicyResponse" description: The HTTP 200 response (OK). tags: - LoadBalancerPolicy "/CreateLoadBalancerTags": - description: |- - Adds one or more tags to the specified load balancers.
- If a tag with the same key already exists for the load balancer, the tag value is replaced.

- For more information, see [About Tags](https://docs.outscale.com/en/userguide/About-Tags.html). post: + description: |- + Adds one or more tags to the specified load balancers.
+ If a tag with the same key already exists for the load balancer, the tag value is replaced.

+ For more information, see [About Tags](https://docs.outscale.com/en/userguide/About-Tags.html). operationId: CreateLoadBalancerTags requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateLoadBalancerTagsRequest" examples: ex1: value: @@ -14010,64 +14113,62 @@ paths: Tags: - Key: key1 Value: value1 - schema: - "$ref": "#/components/schemas/CreateLoadBalancerTagsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateLoadBalancerTagsResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateLoadBalancerTagsResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer "/CreateNatService": - description: |- - Creates a network address translation (NAT) service in the specified public Subnet of a Net.
- A NAT service enables virtual machines (VMs) placed in the private Subnet of this Net to connect to the Internet, without being accessible from the Internet.
- When creating a NAT service, you specify the allocation ID of the public IP you want to use as public IP for the NAT service. Once the NAT service is created, you need to create a route in the route table of the private Subnet, with 0.0.0.0/0 as destination and the ID of the NAT service as target. For more information, see [LinkPublicIP](#linkpublicip) and [CreateRoute](#createroute).
- This action also enables you to create multiple NAT services in the same Net (one per public Subnet).

- - **[IMPORTANT]**
- You cannot modify the public IP associated with a NAT service after its creation. To do so, you need to delete the NAT service and create a new one with another public IP.

- For more information, see [About NAT Services](https://docs.outscale.com/en/userguide/About-NAT-Services.html). post: + description: |- + Creates a network address translation (NAT) service in the specified public Subnet of a Net.
+ A NAT service enables virtual machines (VMs) placed in the private Subnet of this Net to connect to the Internet, without being accessible from the Internet.
+ When creating a NAT service, you specify the allocation ID of the public IP you want to use as public IP for the NAT service. Once the NAT service is created, you need to create a route in the route table of the private Subnet, with 0.0.0.0/0 as destination and the ID of the NAT service as target. For more information, see [LinkPublicIP](#linkpublicip) and [CreateRoute](#createroute).
+ This action also enables you to create multiple NAT services in the same Net (one per public Subnet).

+ + **[IMPORTANT]**
+ You cannot modify the public IP associated with a NAT service after its creation. To do so, you need to delete the NAT service and create a new one with another public IP.

+ For more information, see [About NAT Services](https://docs.outscale.com/en/userguide/About-NAT-Services.html). operationId: CreateNatService requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateNatServiceRequest" examples: ex1: value: - PublicIpId: eipalloc-12345678 SubnetId: subnet-12345678 - schema: - "$ref": "#/components/schemas/CreateNatServiceRequest" + PublicIpId: eipalloc-12345678 responses: '200': content: application/json: - examples: + schema: + "$ref": "#/components/schemas/CreateNatServiceResponse" + examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 NatService: + Tags: [] + SubnetId: subnet-12345678 NatServiceId: nat-12345678 - NetId: vpc-12345678 PublicIps: - - PublicIp: 192.0.2.0 - PublicIpId: eipalloc-12345678 + - PublicIpId: eipalloc-12345678 + PublicIp: 192.0.2.0 + NetId: vpc-12345678 State: available - SubnetId: subnet-12345678 - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateNatServiceResponse" description: The HTTP 200 response (OK). '400': content: @@ -14090,39 +14191,39 @@ paths: tags: - NatService "/CreateNet": - description: |- - Creates a Net with a specified IP range.
- The IP range (network range) of your Net must be between a /28 netmask (16 IPs) and a /16 netmask (65536 IPs).

- For more information, see [About Nets](https://docs.outscale.com/en/userguide/About-Nets.html). post: + description: |- + Creates a Net with a specified IP range.
+ The IP range (network range) of your Net must be between a /28 netmask (16 IPs) and a /16 netmask (65536 IPs).

+ For more information, see [About Nets](https://docs.outscale.com/en/userguide/About-Nets.html). operationId: CreateNet requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateNetRequest" examples: ex1: value: IpRange: 10.0.0.0/16 - schema: - "$ref": "#/components/schemas/CreateNetRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateNetResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Net: + Tags: [] DhcpOptionsSetId: dopt-12345678 IpRange: 10.0.0.0/16 + Tenancy: default NetId: vpc-12345678 State: available - Tags: [] - Tenancy: default - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateNetResponse" description: The HTTP 200 response (OK). '400': content: @@ -14151,17 +14252,19 @@ paths: tags: - Net "/CreateNetAccessPoint": - description: |- - Creates a Net access point to access an OUTSCALE service from this Net without using the Internet and public IPs.
- You specify the service using its name. For more information about the available services, see [ReadNetAccessPointServices](#readnetaccesspointservices).

- To control the routing of traffic between the Net and the specified service, you can specify one or more route tables. Virtual machines placed in Subnets associated with the specified route table thus use the Net access point to access the service. When you specify a route table, a route is automatically added to it with the destination set to the prefix list ID of the service, and the target set to the ID of the access point.

- When a Net access point is created, a public IP is automatically allocated to your account and used for the Net access point. This public IP is not connected to the Internet. It is counted in your quota, but it is not billed.

- For more information, see [About Net Access Points](https://docs.outscale.com/en/userguide/About-Net-Access-Points.html). post: + description: |- + Creates a Net access point to access an OUTSCALE service from this Net without using the Internet and public IPs.
+ You specify the service using its name. For more information about the available services, see [ReadNetAccessPointServices](#readnetaccesspointservices).

+ To control the routing of traffic between the Net and the specified service, you can specify one or more route tables. Virtual machines placed in Subnets associated with the specified route table thus use the Net access point to access the service. When you specify a route table, a route is automatically added to it with the destination set to the prefix list ID of the service, and the target set to the ID of the access point.

+ When a Net access point is created, a public IP is automatically allocated to your account and used for the Net access point. This public IP is not connected to the Internet. It is counted in your quota, but it is not billed.

+ For more information, see [About Net Access Points](https://docs.outscale.com/en/userguide/About-Net-Access-Points.html). operationId: CreateNetAccessPoint requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateNetAccessPointRequest" examples: ex1: value: @@ -14169,107 +14272,105 @@ paths: RouteTableIds: - rtb-12345678 ServiceName: com.outscale.eu-west-2.oos - schema: - "$ref": "#/components/schemas/CreateNetAccessPointRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateNetAccessPointResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 NetAccessPoint: + Tags: [] NetAccessPointId: vpce-12345678 - NetId: vpc-12345678 RouteTableIds: - rtb-12345678 - ServiceName: com.outscale.eu-west-2.oos State: pending - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateNetAccessPointResponse" + NetId: vpc-12345678 + ServiceName: com.outscale.eu-west-2.oos description: The HTTP 200 response (OK). tags: - NetAccessPoint "/CreateNetPeering": - description: |- - Requests a Net peering between a Net you own and a peer Net that belongs to you or another account.
- This action creates a Net peering that remains in the `pending-acceptance` state until it is accepted by the owner of the peer Net. If the owner of the peer Net does not accept the request within 7 days, the state of the Net peering becomes `expired`. For more information, see [AcceptNetPeering](#acceptnetpeering).

+ post: + description: |- + Requests a Net peering between a Net you own and a peer Net that belongs to you or another account.
+ This action creates a Net peering that remains in the `pending-acceptance` state until it is accepted by the owner of the peer Net. If the owner of the peer Net does not accept the request within 7 days, the state of the Net peering becomes `expired`. For more information, see [AcceptNetPeering](#acceptnetpeering).

- **[IMPORTANT]**
- * Peered Nets must contain at least one virtual machine (VM) each before the creation of the Net peering.
- * The two Nets must not have overlapping IP ranges. Otherwise, the Net peering is in the `failed` state.
- * A peering connection between two Nets works both ways. If an A-to-B connection is already created and accepted, creating a B-to-A connection is not necessary and would be automatically rejected. + **[IMPORTANT]**
+ * Peered Nets must contain at least one virtual machine (VM) each before the creation of the Net peering.
+ * The two Nets must not have overlapping IP ranges. Otherwise, the Net peering is in the `failed` state.
+ * A peering connection between two Nets works both ways. If an A-to-B connection is already created and accepted, creating a B-to-A connection is not necessary and would be automatically rejected. - For more information, see [About Net Peerings](https://docs.outscale.com/en/userguide/About-Net-Peerings.html). - post: + For more information, see [About Net Peerings](https://docs.outscale.com/en/userguide/About-Net-Peerings.html). operationId: CreateNetPeering requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateNetPeeringRequest" examples: ex1: summary: Creating a Net peering between two Nets belonging to you value: - AccepterNetId: vpc-87654321 SourceNetId: vpc-12345678 + AccepterNetId: vpc-87654321 ex2: summary: Creating a Net peering with a Net that belongs to another account value: + SourceNetId: vpc-12345678 AccepterNetId: vpc-87654321 AccepterOwnerId: '987654321098' - SourceNetId: vpc-12345678 - schema: - "$ref": "#/components/schemas/CreateNetPeeringRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateNetPeeringResponse" examples: ex1: summary: Creating a Net peering between two Nets belonging to you value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 NetPeering: + Tags: [] + State: + Name: pending-acceptance + Message: Pending acceptance by 123456789012 AccepterNet: - AccountId: '123456789012' - IpRange: 172.16.0.0/16 NetId: vpc-12345678 - NetPeeringId: pcx-12345678 - SourceNet: + IpRange: 172.16.0.0/16 AccountId: '123456789012' - IpRange: 10.0.0.0/16 + SourceNet: NetId: vpc-87654321 - State: - Message: Pending acceptance by 123456789012 - Name: pending-acceptance - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + IpRange: 10.0.0.0/16 + AccountId: '123456789012' + NetPeeringId: pcx-12345678 ex2: summary: Creating a Net peering with a Net that belongs to another account value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 NetPeering: + Tags: [] + State: + Name: pending-acceptance + Message: Pending acceptance by 123456789012 AccepterNet: - AccountId: '987654321098' - IpRange: 172.16.0.0/16 NetId: vpc-87654321 - NetPeeringId: pcx-12345678 + IpRange: 172.16.0.0/16 + AccountId: '987654321098' SourceNet: - AccountId: '123456789012' - IpRange: 10.0.0.0/16 NetId: vpc-12345678 - State: - Message: Pending acceptance by 123456789012 - Name: pending-acceptance - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateNetPeeringResponse" + IpRange: 10.0.0.0/16 + AccountId: '123456789012' + NetPeeringId: pcx-12345678 description: The HTTP 200 response (OK). '400': content: @@ -14292,93 +14393,93 @@ paths: tags: - NetPeering "/CreateNic": - description: |- - Creates a network interface card (NIC) in the specified Subnet.

- For more information, see [About NICs](https://docs.outscale.com/en/userguide/About-NICs.html). post: + description: |- + Creates a network interface card (NIC) in the specified Subnet.

+ For more information, see [About NICs](https://docs.outscale.com/en/userguide/About-NICs.html). operationId: CreateNic requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateNicRequest" examples: ex1: summary: Creating a NIC value: + SubnetId: subnet-12345678 SecurityGroupIds: - sg-12345678 - SubnetId: subnet-12345678 ex2: summary: Creating a NIC with specific private IPs value: Description: Terraform nic with private IPs + SubnetId: subnet-12345678 + SecurityGroupIds: + - sg-12345678 PrivateIps: - IsPrimary: true PrivateIp: 10.0.0.4 - IsPrimary: false PrivateIp: 10.0.0.5 - SecurityGroupIds: - - sg-12345678 - SubnetId: subnet-12345678 - schema: - "$ref": "#/components/schemas/CreateNicRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateNicResponse" examples: ex1: summary: Creating a NIC value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Nic: - AccountId: '123456789012' - Description: '' + SubregionName: eu-west-2a + SubnetId: subnet-12345678 + State: available IsSourceDestChecked: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + Tags: [] + Description: '' + AccountId: '123456789012' + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - IsPrimary: true - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - SecurityGroups: - - SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - State: available - SubnetId: subnet-12345678 - SubregionName: eu-west-2a - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + IsPrimary: true ex2: summary: Creating a NIC with specific private IPs value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Nic: - AccountId: '123456789012' - Description: '' + SubregionName: eu-west-2a + SubnetId: subnet-12345678 + State: available IsSourceDestChecked: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + Tags: [] + Description: '' + AccountId: '123456789012' + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - IsPrimary: true - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - - IsPrimary: false - PrivateDnsName: ip-10-0-0-5.eu-west-2.compute.internal + IsPrimary: true + - PrivateDnsName: ip-10-0-0-5.eu-west-2.compute.internal PrivateIp: 10.0.0.5 - SecurityGroups: - - SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - State: available - SubnetId: subnet-12345678 - SubregionName: eu-west-2a - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateNicResponse" + IsPrimary: false description: The HTTP 200 response (OK). '400': content: @@ -14401,14 +14502,16 @@ paths: tags: - Nic "/CreatePolicy": - description: |- - Creates a managed policy to apply to a user.
- This action creates a policy version and sets v1 as the default one. post: + description: |- + Creates a managed policy to apply to a user.
+ This action creates a policy version and sets v1 as the default one. operationId: CreatePolicy requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreatePolicyRequest" examples: ex1: value: @@ -14417,42 +14520,42 @@ paths: "Resource": ["*"]} ]}' Path: "/example/" PolicyName: example-user-policy - schema: - "$ref": "#/components/schemas/CreatePolicyRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreatePolicyResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Policy: + ResourcesCount: 0 + PolicyName: example-user-policy + PolicyDefaultVersionId: v1 + Path: "/example/" CreationDate: 2010-10-01 12:34:56.789000000 +00:00 Description: Example of description + PolicyId: ABCDEFGHIJKLMNOPQRSTUVWXYZ01234 + Orn: orn:ows:idauth::012345678910:policy/example/example-user-policy IsLinkable: true LastModificationDate: 2010-10-01 12:34:56.789000000 +00:00 - Orn: orn:ows:idauth::012345678910:policy/example/example-user-policy - Path: "/example/" - PolicyDefaultVersionId: v1 - PolicyId: ABCDEFGHIJKLMNOPQRSTUVWXYZ01234 - PolicyName: example-user-policy - ResourcesCount: 0 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreatePolicyResponse" description: The HTTP 200 response (OK). tags: - Policy "/CreatePolicyVersion": - description: |- - Creates a version of a specified managed policy.
- A managed policy can have up to five versions. post: + description: |- + Creates a version of a specified managed policy.
+ A managed policy can have up to five versions. operationId: CreatePolicyVersion requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreatePolicyVersionRequest" examples: ex1: value: @@ -14460,91 +14563,89 @@ paths: "Resource": ["*"]} ]}' PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy SetAsDefault: true - schema: - "$ref": "#/components/schemas/CreatePolicyVersionRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreatePolicyVersionResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 PolicyVersion: + VersionId: v2 + DefaultVersion: true + CreationDate: 2017-05-10 12:34:56.789000000 +00:00 Body: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], "Resource": ["*"]} ]}' - CreationDate: 2017-05-10 12:34:56.789000000 +00:00 - DefaultVersion: true - VersionId: v2 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreatePolicyVersionResponse" description: The HTTP 200 response (OK). tags: - Policy "/CreateProductType": - description: Creates a product type you can associate with an OMI for consumption - monitoring and billing purposes. post: + description: Creates a product type you can associate with an OMI for consumption + monitoring and billing purposes. operationId: CreateProductType requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateProductTypeRequest" examples: ex1: value: - Description: Example of description Vendor: vendor-name - schema: - "$ref": "#/components/schemas/CreateProductTypeRequest" + Description: Example of description responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateProductTypeResponse" examples: ex1: value: - ProductType: - Description: Example of description - ProductTypeId: pty-12345678 - Vendor: vendor-name ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateProductTypeResponse" + ProductType: + Vendor: vendor-name + ProductTypeId: pty-12345678 + Description: Example of description description: The HTTP 200 response (OK). tags: - ProductType "/CreatePublicIp": - description: |- - Acquires a public IP for your account.
- A public IP is a static IP designed for dynamic Cloud computing. It can be associated with a virtual machine (VM) in the public Cloud or in a Net, a network interface card (NIC), a NAT service.

- For more information, see [About Public IPs](https://docs.outscale.com/en/userguide/About-Public-IPs.html). post: + description: |- + Acquires a public IP for your account.
+ A public IP is a static IP designed for dynamic Cloud computing. It can be associated with a virtual machine (VM) in the public Cloud or in a Net, a network interface card (NIC), a NAT service.

+ For more information, see [About Public IPs](https://docs.outscale.com/en/userguide/About-Public-IPs.html). operationId: CreatePublicIp requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreatePublicIpRequest" examples: ex1: value: {} - schema: - "$ref": "#/components/schemas/CreatePublicIpRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreatePublicIpResponse" examples: ex1: value: - PublicIp: - PublicIp: 192.0.2.0 - PublicIpId: eipalloc-12345678 - Tags: [] ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreatePublicIpResponse" + PublicIp: + Tags: [] + PublicIpId: eipalloc-12345678 + PublicIp: 192.0.2.0 description: The HTTP 200 response (OK). '400': content: @@ -14567,59 +14668,59 @@ paths: tags: - PublicIp "/CreateRoute": - description: |- - Creates a route in a specified route table within a specified Net.
- You must specify one of the following elements as the target:

+ post: + description: |- + Creates a route in a specified route table within a specified Net.
+ You must specify one of the following elements as the target:

- * Net peering
- * NAT VM
- * Internet service
- * Virtual gateway
- * NAT service
- * Network interface card (NIC)

+ * Net peering
+ * NAT VM
+ * Internet service
+ * Virtual gateway
+ * NAT service
+ * Network interface card (NIC)

- The routing algorithm is based on the most specific match.

- For more information, see [About Route Tables](https://docs.outscale.com/en/userguide/About-Route-Tables.html). - post: + The routing algorithm is based on the most specific match.

+ For more information, see [About Route Tables](https://docs.outscale.com/en/userguide/About-Route-Tables.html). operationId: CreateRoute requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateRouteRequest" examples: ex1: summary: Creating a route to an Internet service value: + RouteTableId: rtb-12345678 DestinationIpRange: 0.0.0.0/0 GatewayId: igw-12345678 - RouteTableId: rtb-12345678 - schema: - "$ref": "#/components/schemas/CreateRouteRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateRouteResponse" examples: ex1: summary: Creating a route to an Internet service value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 RouteTable: - LinkRouteTables: [] - NetId: vpc-12345678 - RoutePropagatingVirtualGateways: [] - RouteTableId: rtb-12345678 Routes: - - CreationMethod: CreateRouteTable - DestinationIpRange: 10.0.0.0/16 + - DestinationIpRange: 10.0.0.0/16 + CreationMethod: CreateRouteTable State: active - - CreationMethod: CreateRoute + - GatewayId: igw-12345678 DestinationIpRange: 0.0.0.0/0 - GatewayId: igw-12345678 + CreationMethod: CreateRoute State: active + LinkRouteTables: [] + NetId: vpc-12345678 Tags: [] - schema: - "$ref": "#/components/schemas/CreateRouteResponse" + RoutePropagatingVirtualGateways: [] + RouteTableId: rtb-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -14642,42 +14743,42 @@ paths: tags: - Route "/CreateRouteTable": - description: |- - Creates a route table for a specified Net.
- You can then add routes and associate this route table with a Subnet.

- For more information, see [About Route Tables](https://docs.outscale.com/en/userguide/About-Route-Tables.html). post: + description: |- + Creates a route table for a specified Net.
+ You can then add routes and associate this route table with a Subnet.

+ For more information, see [About Route Tables](https://docs.outscale.com/en/userguide/About-Route-Tables.html). operationId: CreateRouteTable requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateRouteTableRequest" examples: ex1: value: NetId: vpc-12345678 - schema: - "$ref": "#/components/schemas/CreateRouteTableRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateRouteTableResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 RouteTable: + Routes: + - DestinationIpRange: 10.0.0.0/16 + CreationMethod: CreateRouteTable + State: active LinkRouteTables: [] NetId: vpc-12345678 + Tags: [] RoutePropagatingVirtualGateways: [] RouteTableId: rtb-12345678 - Routes: - - CreationMethod: CreateRouteTable - DestinationIpRange: 10.0.0.0/16 - State: active - Tags: [] - schema: - "$ref": "#/components/schemas/CreateRouteTableResponse" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -14700,52 +14801,52 @@ paths: tags: - RouteTable "/CreateSecurityGroup": - description: |- - Creates a security group.
- This action creates a security group either in the public Cloud or in a specified Net. By default, a default security group for use in the public Cloud and a default security group for use in a Net are created.
- When launching a virtual machine (VM), if no security group is explicitly specified, the appropriate default security group is assigned to the VM. Default security groups include a default rule granting VMs network access to each other.
- When creating a security group, you specify a name. Two security groups for use in the public Cloud or for use in a Net cannot have the same name.
- You can have up to 500 security groups in the public Cloud. You can create up to 500 security groups per Net.
- To add or remove rules, use the [CreateSecurityGroupRule](#createsecuritygrouprule) method.

- For more information, see [About Security Groups](https://docs.outscale.com/en/userguide/About-Security-Groups.html). post: + description: |- + Creates a security group.
+ This action creates a security group either in the public Cloud or in a specified Net. By default, a default security group for use in the public Cloud and a default security group for use in a Net are created.
+ When launching a virtual machine (VM), if no security group is explicitly specified, the appropriate default security group is assigned to the VM. Default security groups include a default rule granting VMs network access to each other.
+ When creating a security group, you specify a name. Two security groups for use in the public Cloud or for use in a Net cannot have the same name.
+ You can have up to 500 security groups in the public Cloud. You can create up to 500 security groups per Net.
+ To add or remove rules, use the [CreateSecurityGroupRule](#createsecuritygrouprule) method.

+ For more information, see [About Security Groups](https://docs.outscale.com/en/userguide/About-Security-Groups.html). operationId: CreateSecurityGroup requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateSecurityGroupRequest" examples: ex1: value: - Description: Security group example NetId: vpc-12345678 SecurityGroupName: security-group-example - schema: - "$ref": "#/components/schemas/CreateSecurityGroupRequest" + Description: Security group example responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateSecurityGroupResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 SecurityGroup: - AccountId: '123456789012' - Description: Example of security group - InboundRules: [] - NetId: vpc-12345678 + Tags: [] + SecurityGroupName: security-group-example OutboundRules: - FromPortRange: -1 IpProtocol: "-1" + ToPortRange: -1 IpRanges: - 0.0.0.0/0 - ToPortRange: -1 SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - Tags: [] - schema: - "$ref": "#/components/schemas/CreateSecurityGroupResponse" + AccountId: '123456789012' + Description: Example of security group + InboundRules: [] + NetId: vpc-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -14768,109 +14869,109 @@ paths: tags: - SecurityGroup "/CreateSecurityGroupRule": - description: |- - Adds one or more rules to a security group.
- Use the `SecurityGroupId` parameter to specify the security group for which you want to create a rule.
- Use the `Flow` parameter to specify if you want an inbound rule or an outbound rule.

- An inbound rule allows the security group to receive traffic: - * Either from a specific IP range (`IpRange` parameter) on a specific port range (`FromPortRange` and `ToPortRange` parameters) and specific protocol (`IpProtocol` parameter). - * Or from another specific security group (`SecurityGroupAccountIdToLink` and `SecurityGroupNameToLink` parameters).
+ post: + description: |- + Adds one or more rules to a security group.
+ Use the `SecurityGroupId` parameter to specify the security group for which you want to create a rule.
+ Use the `Flow` parameter to specify if you want an inbound rule or an outbound rule.

+ An inbound rule allows the security group to receive traffic: + * Either from a specific IP range (`IpRange` parameter) on a specific port range (`FromPortRange` and `ToPortRange` parameters) and specific protocol (`IpProtocol` parameter). + * Or from another specific security group (`SecurityGroupAccountIdToLink` and `SecurityGroupNameToLink` parameters).
- (Net only) An outbound rule works similarly but allows the security group to send traffic rather than receive traffic.
+ (Net only) An outbound rule works similarly but allows the security group to send traffic rather than receive traffic.
- Alternatively, you can use the `Rules` parameter to add several rules at the same time. + Alternatively, you can use the `Rules` parameter to add several rules at the same time. - **[NOTE]**
- * The modifications are effective as quickly as possible, but a small delay may occur.
- * By default, traffic between two security groups is allowed through both public and private IPs. To restrict traffic to private IPs only, contact our Support team at support@outscale.com. + **[NOTE]**
+ * The modifications are effective as quickly as possible, but a small delay may occur.
+ * By default, traffic between two security groups is allowed through both public and private IPs. To restrict traffic to private IPs only, contact our Support team at support@outscale.com. - For more information, see [About Security Group Rules](https://docs.outscale.com/en/userguide/About-Security-Group-Rules.html). - post: + For more information, see [About Security Group Rules](https://docs.outscale.com/en/userguide/About-Security-Group-Rules.html). operationId: CreateSecurityGroupRule requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateSecurityGroupRuleRequest" examples: ex1: summary: Creating an inbound rule from an IP range value: Flow: Inbound + SecurityGroupId: sg-12345678 FromPortRange: 80 + ToPortRange: 80 IpProtocol: tcp IpRange: 10.0.0.0/16 - SecurityGroupId: sg-12345678 - ToPortRange: 80 ex2: summary: Creating an inbound rule from another security group value: Flow: Inbound + SecurityGroupId: sg-12345678 Rules: - FromPortRange: 22 + ToPortRange: 22 IpProtocol: tcp SecurityGroupsMembers: - AccountId: '123456789012' SecurityGroupName: another-security-group - ToPortRange: 22 - SecurityGroupId: sg-12345678 - schema: - "$ref": "#/components/schemas/CreateSecurityGroupRuleRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateSecurityGroupRuleResponse" examples: ex1: summary: Creating an inbound rule from an IP range value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 SecurityGroup: + Tags: [] + SecurityGroupName: security-group-example + OutboundRules: + - FromPortRange: -1 + IpProtocol: "-1" + ToPortRange: -1 + IpRanges: + - 0.0.0.0/0 + SecurityGroupId: sg-12345678 AccountId: '123456789012' Description: Example of security group InboundRules: - FromPortRange: 80 IpProtocol: tcp + ToPortRange: 80 IpRanges: - 10.0.0.0/16 - ToPortRange: 80 NetId: vpc-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + summary: Creating an inbound rule from another security group + value: + SecurityGroup: + Tags: [] + SecurityGroupName: security-group-example OutboundRules: - FromPortRange: -1 IpProtocol: "-1" + ToPortRange: -1 IpRanges: - 0.0.0.0/0 - ToPortRange: -1 SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - Tags: [] - ex2: - summary: Creating an inbound rule from another security group - value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - SecurityGroup: AccountId: '123456789012' Description: Example of security group InboundRules: - FromPortRange: 22 IpProtocol: tcp + ToPortRange: 22 SecurityGroupsMembers: - - AccountId: '987654321098' + - SecurityGroupName: another-security-group SecurityGroupId: sg-87654321 - SecurityGroupName: another-security-group - ToPortRange: 22 + AccountId: '987654321098' NetId: vpc-12345678 - OutboundRules: - - FromPortRange: -1 - IpProtocol: "-1" - IpRanges: - - 0.0.0.0/0 - ToPortRange: -1 - SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - Tags: [] - schema: - "$ref": "#/components/schemas/CreateSecurityGroupRuleResponse" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -14893,146 +14994,146 @@ paths: tags: - SecurityGroupRule "/CreateServerCertificate": - description: |- - Creates a server certificate and its matching private key.

- These elements can be used with other services (for example, to configure SSL termination on load balancers).

- You can also specify the chain of intermediate certification authorities if your certificate is not directly signed by a root one. You can specify multiple intermediate certification authorities in the `CertificateChain` parameter. To do so, concatenate all certificates in the correct order (the first certificate must be the authority of your certificate, the second must be the authority of the first one, and so on).

- The private key must be a RSA key in PKCS1 form. To check this, open the PEM file and ensure its header reads as follows: BEGIN RSA PRIVATE KEY.

- [IMPORTANT]

- This private key must not be protected by a password or a passphrase.

- For more information, see [About Server Certificates in EIM](https://docs.outscale.com/en/userguide/About-Server-Certificates-in-EIM.html). post: + description: |- + Creates a server certificate and its matching private key.

+ These elements can be used with other services (for example, to configure SSL termination on load balancers).

+ You can also specify the chain of intermediate certification authorities if your certificate is not directly signed by a root one. You can specify multiple intermediate certification authorities in the `CertificateChain` parameter. To do so, concatenate all certificates in the correct order (the first certificate must be the authority of your certificate, the second must be the authority of the first one, and so on).

+ The private key must be a RSA key in PKCS1 form. To check this, open the PEM file and ensure its header reads as follows: BEGIN RSA PRIVATE KEY.

+ [IMPORTANT]

+ This private key must not be protected by a password or a passphrase.

+ For more information, see [About Server Certificates in EIM](https://docs.outscale.com/en/userguide/About-Server-Certificates-in-EIM.html). operationId: CreateServerCertificate requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateServerCertificateRequest" examples: ex1: value: + Name: server-cert-example Body: "..." Chain: "..." - Name: server-cert-example - Path: "/example/" PrivateKey: "..." - schema: - "$ref": "#/components/schemas/CreateServerCertificateRequest" + Path: "/example/" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateServerCertificateResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ServerCertificate: + Path: "/example/" Id: ABCDEFGHIJKLMNOPQRSTUVWXYZ1234 - Name: server-cert-example Orn: orn:ows:idauth::012345678910:server-certificate/example/server-cert-example - Path: "/example/" - schema: - "$ref": "#/components/schemas/CreateServerCertificateResponse" + Name: server-cert-example + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - ServerCertificate "/CreateSnapshot": - description: |- - Creates a snapshot. Snapshots are point-in-time images of a volume that you can use to back up your data or to create replicas of this volume.
- You can use this method in three different ways: - * **Creating from a volume**: You create a snapshot from one of your volumes.
- * **Copying a snapshot**: You copy an existing snapshot. The source snapshot can be one of your own snapshots, or a snapshot owned by another account that has granted you permission via the [UpdateSnapshot](#updatesnapshot) method.
- * **Importing from a bucket**: You import a snapshot located in an OUTSCALE Object Storage (OOS) bucket. First, the owner of the source snapshot must export it to a bucket by using the [CreateSnapshotExportTask](#createsnapshotexporttask) method. Then, they must grant you permission to read the snapshot via a pre-signed URL. For more information, see [Creating a Pre-Signed URL](https://docs.outscale.com/en/userguide/Creating-a-Pre-Signed-URL.html). + post: + description: |- + Creates a snapshot. Snapshots are point-in-time images of a volume that you can use to back up your data or to create replicas of this volume.
+ You can use this method in three different ways: + * **Creating from a volume**: You create a snapshot from one of your volumes.
+ * **Copying a snapshot**: You copy an existing snapshot. The source snapshot can be one of your own snapshots, or a snapshot owned by another account that has granted you permission via the [UpdateSnapshot](#updatesnapshot) method.
+ * **Importing from a bucket**: You import a snapshot located in an OUTSCALE Object Storage (OOS) bucket. First, the owner of the source snapshot must export it to a bucket by using the [CreateSnapshotExportTask](#createsnapshotexporttask) method. Then, they must grant you permission to read the snapshot via a pre-signed URL. For more information, see [Creating a Pre-Signed URL](https://docs.outscale.com/en/userguide/Creating-a-Pre-Signed-URL.html). - **[NOTE]**
- In case of excessive use of the snapshot creation feature on the same volume over a short period of time, 3DS OUTSCALE reserves the right to temporarily block the feature. + **[NOTE]**
+ In case of excessive use of the snapshot creation feature on the same volume over a short period of time, 3DS OUTSCALE reserves the right to temporarily block the feature. - For more information, see [About Snapshots](https://docs.outscale.com/en/userguide/About-Snapshots.html). - post: + For more information, see [About Snapshots](https://docs.outscale.com/en/userguide/About-Snapshots.html). operationId: CreateSnapshot requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateSnapshotRequest" examples: ex1: summary: Creating from a volume value: - Description: Snapshot created from a volume VolumeId: vol-12345678 + Description: Snapshot created from a volume ex2: summary: Copying a snapshot value: - Description: Snapshot created from another snapshot - SourceRegionName: eu-west-2 SourceSnapshotId: snap-12345678 + SourceRegionName: eu-west-2 + Description: Snapshot created from another snapshot ex3: summary: Importing from a bucket value: - Description: Snapshot imported from a bucket FileLocation: https://oos.eu-west-2.outscale.com/BUCKET/KEY?AWSAccessKeyId=ABCDEFGHIJ0123456789&Expires=1493372309&Signature=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX SnapshotSize: 10737418240 - schema: - "$ref": "#/components/schemas/CreateSnapshotRequest" + Description: Snapshot imported from a bucket responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateSnapshotResponse" examples: ex1: summary: Creating from a volume value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Snapshot: + VolumeSize: 10 AccountId: '123456789012' + VolumeId: vol-12345678 CreationDate: '2010-10-01T12:34:56.789Z' - Description: Snapshot created from a volume PermissionsToCreateVolume: - AccountIds: [] GlobalPermission: false + AccountIds: [] Progress: 0 SnapshotId: snap-12345678 State: pending/queued + Description: Snapshot created from a volume Tags: [] - VolumeId: vol-12345678 - VolumeSize: 10 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Copying a snapshot value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Snapshot: + VolumeSize: 10 AccountId: '123456789012' + VolumeId: vol-12345678 CreationDate: '2010-10-01T12:34:56.789Z' - Description: Snapshot copied from another snapshot PermissionsToCreateVolume: - AccountIds: [] GlobalPermission: false + AccountIds: [] Progress: 100 SnapshotId: snap-12345678 State: completed + Description: Snapshot copied from another snapshot Tags: [] - VolumeId: vol-12345678 - VolumeSize: 10 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex3: summary: Importing from a bucket value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Snapshot: + VolumeSize: 10 AccountId: '123456789012' + VolumeId: vol-12345678 CreationDate: '2010-10-01T12:34:56.789Z' - Description: Snapshot imported from a bucket PermissionsToCreateVolume: - AccountIds: [] GlobalPermission: false + AccountIds: [] Progress: 0 SnapshotId: snap-12345678 State: importing + Description: Snapshot imported from a bucket Tags: [] - VolumeId: vol-12345678 - VolumeSize: 10 - schema: - "$ref": "#/components/schemas/CreateSnapshotResponse" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -15055,87 +15156,87 @@ paths: tags: - Snapshot "/CreateSnapshotExportTask": - description: |- - Exports a snapshot to an OUTSCALE Object Storage (OOS) bucket that belongs to you. This action enables you to create a backup of your snapshot.

- You can share this snapshot with others accounts by granting permission to read it via pre-signed URLs. For more information, see [Creating a Pre-Signed URL](https://docs.outscale.com/en/userguide/Creating-a-Pre-Signed-URL.html).

- For more information, see [About Snapshots](https://docs.outscale.com/en/userguide/About-Snapshots.html). post: + description: |- + Exports a snapshot to an OUTSCALE Object Storage (OOS) bucket that belongs to you. This action enables you to create a backup of your snapshot.

+ You can share this snapshot with others accounts by granting permission to read it via pre-signed URLs. For more information, see [Creating a Pre-Signed URL](https://docs.outscale.com/en/userguide/Creating-a-Pre-Signed-URL.html).

+ For more information, see [About Snapshots](https://docs.outscale.com/en/userguide/About-Snapshots.html). operationId: CreateSnapshotExportTask requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateSnapshotExportTaskRequest" examples: ex1: value: + SnapshotId: snap-12345678 OsuExport: DiskImageFormat: qcow2 OsuBucket: BUCKET OsuPrefix: PREFIX - SnapshotId: snap-12345678 - schema: - "$ref": "#/components/schemas/CreateSnapshotExportTaskRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateSnapshotExportTaskResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 SnapshotExportTask: + Tags: [] + TaskId: snap-export-12345678 Comment: Export of snapshot snap-12345678 OsuExport: - DiskImageFormat: qcow2 - OsuBucket: BUCKET OsuPrefix: PREFIX - Progress: 0 - SnapshotId: snap-12345678 + OsuBucket: BUCKET + DiskImageFormat: qcow2 State: pending - Tags: [] - TaskId: snap-export-12345678 - schema: - "$ref": "#/components/schemas/CreateSnapshotExportTaskResponse" + SnapshotId: snap-12345678 + Progress: 0 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - Snapshot "/CreateSubnet": - description: |- - Creates a Subnet in an existing Net.
- To create a Subnet in a Net, you have to provide the ID of the Net and the IP range for the Subnet (its network range). Once the Subnet is created, you cannot modify its IP range.

- For more information, see [About Nets](https://docs.outscale.com/en/userguide/About-Nets.html). post: + description: |- + Creates a Subnet in an existing Net.
+ To create a Subnet in a Net, you have to provide the ID of the Net and the IP range for the Subnet (its network range). Once the Subnet is created, you cannot modify its IP range.

+ For more information, see [About Nets](https://docs.outscale.com/en/userguide/About-Nets.html). operationId: CreateSubnet requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateSubnetRequest" examples: ex1: value: - IpRange: 10.0.0.0/18 NetId: vpc-12345678 - schema: - "$ref": "#/components/schemas/CreateSubnetRequest" + IpRange: 10.0.0.0/18 responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateSubnetResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Subnet: + Tags: [] + SubregionName: eu-west-2a + SubnetId: subnet-12345678 AvailableIpsCount: 16379 IpRange: 10.0.0.0/18 MapPublicIpOnLaunch: false - NetId: vpc-12345678 State: available - SubnetId: subnet-12345678 - SubregionName: eu-west-2a - Tags: [] - schema: - "$ref": "#/components/schemas/CreateSubnetResponse" + NetId: vpc-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -15164,40 +15265,42 @@ paths: tags: - Subnet "/CreateTags": - description: |- - Adds one or more tags to the specified resources.
- If a tag with the same key already exists for the resource, the tag value is replaced.
- You can tag the following resources using their IDs:

+ post: + description: |- + Adds one or more tags to the specified resources.
+ If a tag with the same key already exists for the resource, the tag value is replaced.
+ You can tag the following resources using their IDs:

- * Client gateways (cgw-xxxxxxxx)
- * DHCP options (dopt-xxxxxxxx)
- * Images (ami-xxxxxxxx)
- * Internet services (igw-xxxxxxxx)
- * Keypairs (key-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx)
- * NAT services (nat-xxxxxxxx)
- * Net endpoints (vpce-xxxxxxxx)
- * Net peerings (vpcx-xxxxxxxx)
- * Nets (vpc-xxxxxxxx)
- * Network interface cards (NIC) (eni-xxxxxxxx)
- * OMI export tasks (image-export-xxxxxxxx)
- * OMIs (ami-xxxxxxxx)
- * Public IPs (eipalloc-xxxxxxxx)
- * Route tables (rtb-xxxxxxxx)
- * Security groups (sg-xxxxxxxx)
- * Snapshot export tasks (snap-export-xxxxxxxx) - * Snapshots (snap-xxxxxxxx)
- * Subnets (subnet-xxxxxxxx)
- * Virtual gateways (vgw-xxxxxxxx)
- * Virtual machines (VMs) (i-xxxxxxxx)
- * Volumes (vol-xxxxxxxx)
- * VPN connections (vpn-xxxxxxxx)
+ * Client gateways (cgw-xxxxxxxx)
+ * DHCP options (dopt-xxxxxxxx)
+ * Images (ami-xxxxxxxx)
+ * Internet services (igw-xxxxxxxx)
+ * Keypairs (key-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx)
+ * NAT services (nat-xxxxxxxx)
+ * Net endpoints (vpce-xxxxxxxx)
+ * Net peerings (vpcx-xxxxxxxx)
+ * Nets (vpc-xxxxxxxx)
+ * Network interface cards (NIC) (eni-xxxxxxxx)
+ * OMI export tasks (image-export-xxxxxxxx)
+ * OMIs (ami-xxxxxxxx)
+ * Public IPs (eipalloc-xxxxxxxx)
+ * Route tables (rtb-xxxxxxxx)
+ * Security groups (sg-xxxxxxxx)
+ * Snapshot export tasks (snap-export-xxxxxxxx) + * Snapshots (snap-xxxxxxxx)
+ * Subnets (subnet-xxxxxxxx)
+ * Virtual gateways (vgw-xxxxxxxx)
+ * Virtual machines (VMs) (i-xxxxxxxx)
+ * Volumes (vol-xxxxxxxx)
+ * VPN connections (vpn-xxxxxxxx)
- For more information, see [About Tags](https://docs.outscale.com/en/userguide/About-Tags.html). - post: + For more information, see [About Tags](https://docs.outscale.com/en/userguide/About-Tags.html). operationId: CreateTags requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateTagsRequest" examples: ex1: value: @@ -15206,19 +15309,17 @@ paths: Tags: - Key: key1 Value: value1 - schema: - "$ref": "#/components/schemas/CreateTagsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateTagsResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateTagsResponse" description: The HTTP 200 response (OK). '400': content: @@ -15241,63 +15342,65 @@ paths: tags: - Tag "/CreateUser": - description: |- - Creates an EIM user for your account.

- For more information, see [About EIM Users](https://docs.outscale.com/en/userguide/About-EIM-Users.html). post: + description: |- + Creates an EIM user for your account.

+ For more information, see [About EIM Users](https://docs.outscale.com/en/userguide/About-EIM-Users.html). operationId: CreateUser requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateUserRequest" examples: ex1: value: - Path: "/documentation/" UserEmail: user@example.com UserName: example-user - schema: - "$ref": "#/components/schemas/CreateUserRequest" + Path: "/documentation/" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateUserResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 User: CreationDate: 2010-10-01 12:34:56.789000000 +00:00 LastModificationDate: 2017-05-10 12:34:56.789000000 +00:00 - Path: "/documentation/" UserEmail: user@example.com - UserId: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 UserName: example-user - schema: - "$ref": "#/components/schemas/CreateUserResponse" + UserId: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 + Path: "/documentation/" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - User "/CreateUserGroup": - description: |- - Creates a group to which you can add users.
- You can also add an inline policy or link a managed policy to the group, which is applied to all its users. post: + description: |- + Creates a group to which you can add users.
+ You can also add an inline policy or link a managed policy to the group, which is applied to all its users. operationId: CreateUserGroup requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateUserGroupRequest" examples: ex1: value: Path: "/example/" UserGroupName: example-usergroup - schema: - "$ref": "#/components/schemas/CreateUserGroupRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateUserGroupResponse" examples: ex1: value: @@ -15310,59 +15413,59 @@ paths: Orn: orn:ows:idauth::012345678910:usergroup/example/usergroup-example Path: "/example/" UserGroupId: ug-12345678 - schema: - "$ref": "#/components/schemas/CreateUserGroupResponse" description: The HTTP 200 response (OK). tags: - UserGroup "/CreateVirtualGateway": - description: |- - Creates a virtual gateway.
- A virtual gateway is the access point on the Net side of a VPN connection.

- For more information, see [About Virtual Gateways](https://docs.outscale.com/en/userguide/About-Virtual-Gateways.html). post: + description: |- + Creates a virtual gateway.
+ A virtual gateway is the access point on the Net side of a VPN connection.

+ For more information, see [About Virtual Gateways](https://docs.outscale.com/en/userguide/About-Virtual-Gateways.html). operationId: CreateVirtualGateway requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateVirtualGatewayRequest" examples: ex1: value: ConnectionType: ipsec.1 - schema: - "$ref": "#/components/schemas/CreateVirtualGatewayRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateVirtualGatewayResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VirtualGateway: + VirtualGatewayId: vgw-12345678 ConnectionType: ipsec.1 NetToVirtualGatewayLinks: [] State: available Tags: [] - VirtualGatewayId: vgw-12345678 - schema: - "$ref": "#/components/schemas/CreateVirtualGatewayResponse" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - VirtualGateway "/CreateVmGroup": - description: |- - > [WARNING]
- > This feature is currently under development and may not function properly.
- - Creates a group of virtual machines (VMs) containing the same characteristics as a specified VM template, and then launches them.
- You can create up to 100 VM groups in your account. post: + description: |- + > [WARNING]
+ > This feature is currently under development and may not function properly.
+ + Creates a group of virtual machines (VMs) containing the same characteristics as a specified VM template, and then launches them.
+ You can create up to 100 VM groups in your account. operationId: CreateVmGroup requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateVmGroupRequest" examples: ex1: value: @@ -15377,17 +15480,15 @@ paths: VmCount: 2 VmGroupName: ClusterLog-PPD01 VmTemplateId: vmtemplate-98765432109876543210987654321012 - schema: - "$ref": "#/components/schemas/CreateVmGroupRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateVmGroupResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VmGroup: CreationDate: '2010-10-01T12:34:56.789Z' Description: Production log collector @@ -15404,8 +15505,8 @@ paths: VmGroupName: ClusterLog-PPD01 VmIds: [] VmTemplateId: vmtemplate-98765432109876543210987654321012 - schema: - "$ref": "#/components/schemas/CreateVmGroupResponse" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -15428,17 +15529,19 @@ paths: tags: - VmGroup "/CreateVmTemplate": - description: |- - > [WARNING]
- > This feature is currently under development and may not function properly.
- - Creates a virtual machine (VM) template. You can then use the VM template to create VM groups.
- You can create up to 50 VM templates in your account. post: + description: |- + > [WARNING]
+ > This feature is currently under development and may not function properly.
+ + Creates a virtual machine (VM) template. You can then use the VM template to create VM groups.
+ You can create up to 50 VM templates in your account. operationId: CreateVmTemplate requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateVmTemplateRequest" examples: ex1: value: @@ -15453,49 +15556,49 @@ paths: - Key: key1 Value: value1 VmTemplateName: vmtemplate-example - schema: - "$ref": "#/components/schemas/CreateVmTemplateRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateVmTemplateResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VmTemplate: - CpuCores: 2 - CpuGeneration: v4 + VmTemplateName: vmtemplate-example CpuPerformance: high CreationDate: 2010-10-01 12:34:56.789000000 +00:00 - Description: Log collector template - ImageId: ami-12345678 - Ram: 2 + CpuCores: 2 Tags: - Key: key1 Value: value1 + Description: Log collector template + ImageId: ami-12345678 + CpuGeneration: v4 VmTemplateId: vmtemplate-98765432109876543210987654321012 - VmTemplateName: vmtemplate-example - schema: - "$ref": "#/components/schemas/CreateVmTemplateResponse" + Ram: 2 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - VmTemplate "/CreateVms": - description: |- - Creates virtual machines (VMs), and then launches them.
- This action enables you to create a specified number of VMs using an OUTSCALE machine image (OMI) that you are allowed to use, and then to automatically launch them.
- The VMs remain in the `pending` state until they are created and ready to be used. Once automatically launched, they are in the `running` state.
- To check the state of your VMs, call the [ReadVms](#readvms) method.
- If not specified, the security group used by the service is the default one.
- The metadata server enables you to get the public key provided when the VM is launched. Official OMIs contain a script to get this public key and put it inside the VM to provide secure access without password.

- For more information, see [About VMs](https://docs.outscale.com/en/userguide/About-VMs.html). post: + description: |- + Creates virtual machines (VMs), and then launches them.
+ This action enables you to create a specified number of VMs using an OUTSCALE machine image (OMI) that you are allowed to use, and then to automatically launch them.
+ The VMs remain in the `pending` state until they are created and ready to be used. Once automatically launched, they are in the `running` state.
+ To check the state of your VMs, call the [ReadVms](#readvms) method.
+ If not specified, the security group used by the service is the default one.
+ The metadata server enables you to get the public key provided when the VM is launched. Official OMIs contain a script to get this public key and put it inside the VM to provide secure access without password.

+ For more information, see [About VMs](https://docs.outscale.com/en/userguide/About-VMs.html). operationId: CreateVms requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateVmsRequest" examples: ex1: summary: Creating a VM (minimal syntax) @@ -15505,317 +15608,315 @@ paths: summary: Creating a VM in a Net value: ImageId: ami-12345678 + VmType: tinav5.c1r1p2 KeypairName: keypair-example SecurityGroupIds: - sg-12345678 SubnetId: subnet-12345678 UserData: "..." - VmType: tinav5.c1r1p2 ex3: summary: Creating a VM with block device mappings value: - BlockDeviceMappings: - - Bsu: - VolumeSize: 15 - VolumeType: gp2 - DeviceName: "/dev/sda1" - - Bsu: - Iops: 150 - SnapshotId: snap-12345678 - VolumeSize: 22 - VolumeType: io1 - DeviceName: "/dev/sdb" ImageId: ami-12345678 + VmType: tinav5.c1r1p2 KeypairName: keypair-example SecurityGroupIds: - sg-12345678 SubnetId: subnet-12345678 UserData: "..." - VmType: tinav5.c1r1p2 + BlockDeviceMappings: + - DeviceName: "/dev/sda1" + Bsu: + VolumeSize: 15 + VolumeType: gp2 + - DeviceName: "/dev/sdb" + Bsu: + SnapshotId: snap-12345678 + VolumeSize: 22 + VolumeType: io1 + Iops: 150 ex4: summary: Creating a VM with a NIC value: ImageId: ami-12345678 + VmType: tinav5.c1r1p2 KeypairName: keypair-example + UserData: "..." Nics: - DeviceNumber: 0 NicId: eni-12345678 - UserData: "..." - VmType: tinav5.c1r1p2 - schema: - "$ref": "#/components/schemas/CreateVmsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateVmsResponse" examples: ex1: summary: Creating a VM (minimal syntax) value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Vms: - - ActionsOnNextBoot: - SecureBoot: none + - VmType: t2.small + VmInitiatedShutdownBehavior: stop + State: pending + StateReason: '' + RootDeviceType: ebs + RootDeviceName: "/dev/sda1" + IsSourceDestChecked: true + ImageId: ami-12345678 + DeletionProtection: false + BootMode: legacy Architecture: x86_64 + NestedVirtualization: false BlockDeviceMappings: - - Bsu: - DeleteOnVmDeletion: true - LinkDate: '2010-10-01T12:34:56.789Z' - State: attaching + - DeviceName: "/dev/sda1" + Bsu: VolumeId: vol-12345678 - DeviceName: "/dev/sda1" - BootMode: legacy - BsuOptimized: false - CreationDate: '2010-10-01T12:34:56.789Z' - DeletionProtection: false + State: attaching + LinkDate: '2010-10-01T12:34:56.789Z' + DeleteOnVmDeletion: true + VmId: i-12345678 + ReservationId: r-12345678 Hypervisor: xen - ImageId: ami-12345678 - IsSourceDestChecked: true - LaunchNumber: 0 - NestedVirtualization: false - Performance: medium Placement: - SubregionName: eu-west-2a Tenancy: default - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal - PrivateIp: 10.0.0.4 + SubregionName: eu-west-2a ProductCodes: - '0001' - ReservationId: r-12345678 - RootDeviceName: "/dev/sda1" - RootDeviceType: ebs + CreationDate: '2010-10-01T12:34:56.789Z' + UserData: "..." + PrivateIp: 10.0.0.4 SecurityGroups: - - SecurityGroupId: sg-12345678 - SecurityGroupName: default - State: pending - StateReason: '' + - SecurityGroupName: default + SecurityGroupId: sg-12345678 + BsuOptimized: false + LaunchNumber: 0 + Performance: medium Tags: [] - UserData: "..." - VmId: i-12345678 - VmInitiatedShutdownBehavior: stop - VmType: t2.small + ActionsOnNextBoot: + SecureBoot: none + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Creating a VM in a Net value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Vms: - - ActionsOnNextBoot: - SecureBoot: none + - VmType: tinav5.c1r1p2 + VmInitiatedShutdownBehavior: stop + State: pending + StateReason: '' + RootDeviceType: ebs + RootDeviceName: "/dev/sda1" + IsSourceDestChecked: true + KeypairName: keypair-example + ImageId: ami-12345678 + DeletionProtection: false + BootMode: legacy Architecture: x86_64 + NestedVirtualization: false BlockDeviceMappings: - - Bsu: - DeleteOnVmDeletion: true - LinkDate: '2010-10-01T12:34:56.789Z' - State: attaching + - DeviceName: "/dev/sda1" + Bsu: VolumeId: vol-12345678 - DeviceName: "/dev/sda1" - BootMode: legacy - BsuOptimized: false - CreationDate: '2010-10-01T12:34:56.789Z' - DeletionProtection: false + State: attaching + LinkDate: '2010-10-01T12:34:56.789Z' + DeleteOnVmDeletion: true + VmId: i-12345678 + ReservationId: r-12345678 Hypervisor: xen - ImageId: ami-12345678 - IsSourceDestChecked: true - KeypairName: keypair-example + Placement: + Tenancy: default + SubregionName: eu-west-2a + ProductCodes: + - '0001' + CreationDate: '2010-10-01T12:34:56.789Z' + UserData: "..." + SubnetId: subnet-12345678 + PrivateIp: 10.0.0.4 + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 + BsuOptimized: false LaunchNumber: 0 - NestedVirtualization: false NetId: vpc-12345678 Nics: - - AccountId: '123456789012' - Description: Primary network interface - IsSourceDestChecked: true + - SubnetId: subnet-12345678 + State: in-use LinkNic: - DeleteOnVmDeletion: true + State: attached DeviceNumber: 0 LinkNicId: eni-attach-12345678 - State: attached + DeleteOnVmDeletion: true + IsSourceDestChecked: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + Description: Primary network interface + AccountId: '123456789012' + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - IsPrimary: true - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - SecurityGroups: - - SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - State: in-use - SubnetId: subnet-12345678 + IsPrimary: true Performance: high - Placement: - SubregionName: eu-west-2a - Tenancy: default + Tags: [] + ActionsOnNextBoot: + SecureBoot: none PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal - PrivateIp: 10.0.0.4 - ProductCodes: - - '0001' - ReservationId: r-12345678 - RootDeviceName: "/dev/sda1" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex3: + summary: Creating a VM with block device mappings + value: + Vms: + - VmType: tinav5.c1r1p2 + VmInitiatedShutdownBehavior: stop + State: pending + StateReason: '' RootDeviceType: ebs - SecurityGroups: - - SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - State: pending - StateReason: '' - SubnetId: subnet-12345678 - Tags: [] - UserData: "..." - VmId: i-12345678 - VmInitiatedShutdownBehavior: stop - VmType: tinav5.c1r1p2 - ex3: - summary: Creating a VM with block device mappings - value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - Vms: - - ActionsOnNextBoot: - SecureBoot: none + RootDeviceName: "/dev/sda1" + IsSourceDestChecked: true + KeypairName: keypair-example + ImageId: ami-12345678 + DeletionProtection: false + BootMode: legacy Architecture: x86_64 + NestedVirtualization: false BlockDeviceMappings: - - Bsu: - DeleteOnVmDeletion: true - LinkDate: '2010-10-01T12:34:56.789Z' - State: attaching + - DeviceName: "/dev/sda1" + Bsu: VolumeId: vol-12345678 - DeviceName: "/dev/sda1" - - Bsu: - DeleteOnVmDeletion: true - LinkDate: '2010-10-01T12:34:56.789Z' State: attaching + LinkDate: '2010-10-01T12:34:56.789Z' + DeleteOnVmDeletion: true + - DeviceName: "/dev/sda1" + Bsu: VolumeId: vol-87654321 - DeviceName: "/dev/sda1" - BootMode: legacy - BsuOptimized: false - CreationDate: '2010-10-01T12:34:56.789Z' - DeletionProtection: false + State: attaching + LinkDate: '2010-10-01T12:34:56.789Z' + DeleteOnVmDeletion: true + VmId: i-12345678 + ReservationId: r-12345678 Hypervisor: xen - ImageId: ami-12345678 - IsSourceDestChecked: true - KeypairName: keypair-example + Placement: + Tenancy: default + SubregionName: eu-west-2a + ProductCodes: + - '0001' + CreationDate: '2010-10-01T12:34:56.789Z' + UserData: "..." + SubnetId: subnet-12345678 + PrivateIp: 10.0.0.4 + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 + BsuOptimized: false LaunchNumber: 0 - NestedVirtualization: false NetId: vpc-12345678 Nics: - - AccountId: '123456789012' - Description: Primary network interface - IsSourceDestChecked: true + - SubnetId: subnet-12345678 + State: in-use LinkNic: - DeleteOnVmDeletion: true + State: attached DeviceNumber: 0 LinkNicId: eni-attach-12345678 - State: attached + DeleteOnVmDeletion: true + IsSourceDestChecked: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + Description: Primary network interface + AccountId: '123456789012' + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - IsPrimary: true - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - SecurityGroups: - - SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - State: in-use - SubnetId: subnet-12345678 + IsPrimary: true Performance: high - Placement: - SubregionName: eu-west-2a - Tenancy: default - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal - PrivateIp: 10.0.0.4 - ProductCodes: - - '0001' - ReservationId: r-12345678 - RootDeviceName: "/dev/sda1" - RootDeviceType: ebs - SecurityGroups: - - SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - State: pending - StateReason: '' - SubnetId: subnet-12345678 Tags: [] - UserData: "..." - VmId: i-12345678 - VmInitiatedShutdownBehavior: stop - VmType: tinav5.c1r1p2 + ActionsOnNextBoot: + SecureBoot: none + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex4: summary: Creating a VM with a NIC value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Vms: - - ActionsOnNextBoot: - SecureBoot: none + - VmType: tinav5.c1r1p2 + VmInitiatedShutdownBehavior: stop + State: pending + StateReason: '' + RootDeviceType: ebs + RootDeviceName: "/dev/sda1" + IsSourceDestChecked: true + KeypairName: keypair-example + ImageId: ami-12345678 + DeletionProtection: false + BootMode: legacy Architecture: x86_64 + NestedVirtualization: false BlockDeviceMappings: - - Bsu: - DeleteOnVmDeletion: true - LinkDate: '2010-10-01T12:34:56.789Z' - State: attaching + - DeviceName: "/dev/sda1" + Bsu: VolumeId: vol-12345678 - DeviceName: "/dev/sda1" - BootMode: legacy - BsuOptimized: false - CreationDate: '2010-10-01T12:34:56.789Z' - DeletionProtection: false + State: attaching + LinkDate: '2010-10-01T12:34:56.789Z' + DeleteOnVmDeletion: true + VmId: i-12345678 + ReservationId: r-12345678 Hypervisor: xen - ImageId: ami-12345678 - IsSourceDestChecked: true - KeypairName: keypair-example + Placement: + Tenancy: default + SubregionName: eu-west-2a + ProductCodes: + - '0001' + CreationDate: '2010-10-01T12:34:56.789Z' + UserData: "..." + SubnetId: subnet-12345678 + PrivateIp: 10.0.0.4 + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 + BsuOptimized: false LaunchNumber: 0 - NestedVirtualization: false NetId: vpc-12345678 Nics: - - AccountId: '123456789012' - Description: Example NIC - IsSourceDestChecked: true + - SubnetId: subnet-12345678 + State: in-use LinkNic: - DeleteOnVmDeletion: true + State: attached DeviceNumber: 0 LinkNicId: eni-attach-12345678 - State: attached + DeleteOnVmDeletion: true + IsSourceDestChecked: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + Description: Example NIC + AccountId: '123456789012' + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - IsPrimary: true - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - SecurityGroups: - - SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - State: in-use - SubnetId: subnet-12345678 + IsPrimary: true Performance: high - Placement: - SubregionName: eu-west-2a - Tenancy: default - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal - PrivateIp: 10.0.0.4 - ProductCodes: - - '0001' - ReservationId: r-12345678 - RootDeviceName: "/dev/sda1" - RootDeviceType: ebs - SecurityGroups: - - SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - State: pending - StateReason: '' - SubnetId: subnet-12345678 Tags: [] - UserData: "..." - VmId: i-12345678 - VmInitiatedShutdownBehavior: stop - VmType: tinav5.c1r1p2 - schema: - "$ref": "#/components/schemas/CreateVmsResponse" + ActionsOnNextBoot: + SecureBoot: none + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -15838,71 +15939,71 @@ paths: tags: - Vm "/CreateVolume": - description: |- - Creates a Block Storage Unit (BSU) volume in a specified Region.
- BSU volumes can be attached to a virtual machine (VM) in the same Subregion. You can create an empty volume or restore a volume from an existing snapshot.
- You can create the following volume types: Enterprise (`io1`) for provisioned IOPS SSD volumes, Performance (`gp2`) for general purpose SSD volumes, or Magnetic (`standard`) volumes.

- For more information, see [About Volumes](https://docs.outscale.com/en/userguide/About-Volumes.html). post: + description: |- + Creates a Block Storage Unit (BSU) volume in a specified Region.
+ BSU volumes can be attached to a virtual machine (VM) in the same Subregion. You can create an empty volume or restore a volume from an existing snapshot.
+ You can create the following volume types: Enterprise (`io1`) for provisioned IOPS SSD volumes, Performance (`gp2`) for general purpose SSD volumes, or Magnetic (`standard`) volumes.

+ For more information, see [About Volumes](https://docs.outscale.com/en/userguide/About-Volumes.html). operationId: CreateVolume requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateVolumeRequest" examples: ex1: summary: Creating an io1 volume value: - Iops: 100 - Size: 10 - SubregionName: eu-west-2a VolumeType: io1 + SubregionName: eu-west-2a + Size: 10 + Iops: 100 ex2: summary: Creating a volume from a snapshot value: - Size: 10 SnapshotId: snap-12345678 - SubregionName: eu-west-2a VolumeType: gp2 - schema: - "$ref": "#/components/schemas/CreateVolumeRequest" + SubregionName: eu-west-2a + Size: 10 responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateVolumeResponse" examples: ex1: summary: Creating an io1 volume value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Volume: + VolumeId: vol-12345678 + Tags: [] + VolumeType: io1 + SubregionName: eu-west-2a + State: creating CreationDate: '2010-10-01T12:34:56.789Z' Iops: 100 LinkedVolumes: [] Size: 10 - State: creating - SubregionName: eu-west-2a - Tags: [] - VolumeId: vol-12345678 - VolumeType: io1 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Creating a volume from a snapshot value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Volume: + VolumeId: vol-12345678 + Tags: [] + VolumeType: gp2 + SubregionName: eu-west-2a + State: creating + SnapshotId: snap-12345678 CreationDate: '2010-10-01T12:34:56.789Z' Iops: 100 LinkedVolumes: [] Size: 10 - SnapshotId: snap-12345678 - State: creating - SubregionName: eu-west-2a - Tags: [] - VolumeId: vol-12345678 - VolumeType: gp2 - schema: - "$ref": "#/components/schemas/CreateVolumeResponse" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -15925,96 +16026,98 @@ paths: tags: - Volume "/CreateVpnConnection": - description: |- - Creates a VPN connection between a specified virtual gateway and a specified client gateway.
- You can create only one VPN connection between a virtual gateway and a client gateway.

- - **[IMPORTANT]**
- This action can be done only if the virtual gateway is in the `available` state.

- For more information, see [About VPN Connections](https://docs.outscale.com/en/userguide/About-VPN-Connections.html). post: + description: |- + Creates a VPN connection between a specified virtual gateway and a specified client gateway.
+ You can create only one VPN connection between a virtual gateway and a client gateway.

+ + **[IMPORTANT]**
+ This action can be done only if the virtual gateway is in the `available` state.

+ For more information, see [About VPN Connections](https://docs.outscale.com/en/userguide/About-VPN-Connections.html). operationId: CreateVpnConnection requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/CreateVpnConnectionRequest" examples: ex1: value: ClientGatewayId: cgw-12345678 + VirtualGatewayId: vgw-12345678 ConnectionType: ipsec.1 StaticRoutesOnly: true - VirtualGatewayId: vgw-12345678 - schema: - "$ref": "#/components/schemas/CreateVpnConnectionRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateVpnConnectionResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VpnConnection: + Routes: [] + Tags: [] ClientGatewayConfiguration: "..." - ClientGatewayId: cgw-12345678 + StaticRoutesOnly: true + VirtualGatewayId: vgw-12345678 ConnectionType: ipsec.1 - Routes: [] + ClientGatewayId: cgw-12345678 State: pending - StaticRoutesOnly: true - Tags: [] VgwTelemetries: - - AcceptedRouteCount: 0 + - StateDescription: IPSEC IS DOWN + AcceptedRouteCount: 0 LastStateChangeDate: '2017-05-10T12:34:56.789Z' OutsideIpAddress: 192.0.2.0 - StateDescription: IPSEC IS DOWN - VirtualGatewayId: vgw-12345678 VpnConnectionId: vpn-12345678 - schema: - "$ref": "#/components/schemas/CreateVpnConnectionResponse" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - VpnConnection "/CreateVpnConnectionRoute": - description: |- - Creates a static route to a VPN connection.
- This enables you to select the network flows sent by the virtual gateway to the target VPN connection.

- For more information, see [About Routing Configuration for VPN Connections](https://docs.outscale.com/en/userguide/About-Routing-Configuration-for-VPN-Connections.html). post: + description: |- + Creates a static route to a VPN connection.
+ This enables you to select the network flows sent by the virtual gateway to the target VPN connection.

+ For more information, see [About Routing Configuration for VPN Connections](https://docs.outscale.com/en/userguide/About-Routing-Configuration-for-VPN-Connections.html). operationId: CreateVpnConnectionRoute requestBody: content: application/json: - examples: + schema: + "$ref": "#/components/schemas/CreateVpnConnectionRouteRequest" + examples: ex1: value: - DestinationIpRange: 10.0.0.0/16 VpnConnectionId: vpn-12345678 - schema: - "$ref": "#/components/schemas/CreateVpnConnectionRouteRequest" + DestinationIpRange: 10.0.0.0/16 responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/CreateVpnConnectionRouteResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/CreateVpnConnectionRouteResponse" description: The HTTP 200 response (OK). tags: - VpnConnection "/DeleteAccessKey": - description: |- - Deletes the specified access key of either your root account or an EIM user.

- The access key of an EIM user must be in the `INACTIVE` state to be deleted. post: + description: |- + Deletes the specified access key of either your root account or an EIM user.

+ The access key of an EIM user must be in the `INACTIVE` state to be deleted. operationId: DeleteAccessKey requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteAccessKeyRequest" examples: ex1: summary: Deleting one of your own access keys (if you are the root @@ -16026,19 +16129,17 @@ paths: value: AccessKeyId: ABCDEFGHIJ0123456789 UserName: example-user - schema: - "$ref": "#/components/schemas/DeleteAccessKeyRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteAccessKeyResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteAccessKeyResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -16046,33 +16147,33 @@ paths: tags: - AccessKey "/DeleteApiAccessRule": - description: |- - Deletes a specified API access rule.

- - **[IMPORTANT]**
- You cannot delete the last remaining API access rule. However, if you delete all the API access rules that allow you to access the APIs, you need to contact the Support team to regain access. For more information, see [Technical Support](https://docs.outscale.com/en/userguide/Technical-Support.html). post: + description: |- + Deletes a specified API access rule.

+ + **[IMPORTANT]**
+ You cannot delete the last remaining API access rule. However, if you delete all the API access rules that allow you to access the APIs, you need to contact the Support team to regain access. For more information, see [Technical Support](https://docs.outscale.com/en/userguide/Technical-Support.html). operationId: DeleteApiAccessRule requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteApiAccessRuleRequest" examples: ex1: value: ApiAccessRuleId: aar-1234567890abcdef1234567890abcdef - schema: - "$ref": "#/components/schemas/DeleteApiAccessRuleRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteApiAccessRuleResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteApiAccessRuleResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -16080,29 +16181,29 @@ paths: tags: - ApiAccessRule "/DeleteCa": - description: Deletes a specified Client Certificate Authority (CA). post: + description: Deletes a specified Client Certificate Authority (CA). operationId: DeleteCa requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteCaRequest" examples: ex1: value: CaId: ca-fedcba0987654321fedcba0987654321 - schema: - "$ref": "#/components/schemas/DeleteCaRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteCaResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteCaResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -16110,51 +16211,53 @@ paths: tags: - Ca "/DeleteClientGateway": - description: |- - Deletes a client gateway.
- You must delete the VPN connection before deleting the client gateway. post: + description: |- + Deletes a client gateway.
+ You must delete the VPN connection before deleting the client gateway. operationId: DeleteClientGateway requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteClientGatewayRequest" examples: ex1: value: ClientGatewayId: cgw-12345678 - schema: - "$ref": "#/components/schemas/DeleteClientGatewayRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteClientGatewayResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteClientGatewayResponse" description: The HTTP 200 response (OK). tags: - ClientGateway "/DeleteDedicatedGroup": - description: |- - > [WARNING]
- > This feature is currently in beta.
+ post: + description: |- + > [WARNING]
+ > This feature is currently in beta.
- Deletes a specified dedicated group of virtual machines (VMs).
+ Deletes a specified dedicated group of virtual machines (VMs).
- **[WARNING]**
- A dedicated group can be deleted only if no VM or Net is in the dedicated group. Otherwise, you need to force the deletion.
- If you force the deletion:
- - all VMs are terminated.
- - all Nets are deleted, and all resources associated with Nets are detached. - post: + **[WARNING]**
+ A dedicated group can be deleted only if no VM or Net is in the dedicated group. Otherwise, you need to force the deletion.
+ If you force the deletion:
+ - all VMs are terminated.
+ - all Nets are deleted, and all resources associated with Nets are detached. operationId: DeleteDedicatedGroup requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteDedicatedGroupRequest" examples: ex1: summary: Deleting a dedicated group without any resource in it. @@ -16166,19 +16269,17 @@ paths: value: DedicatedGroupId: ded-12345678 Force: true - schema: - "$ref": "#/components/schemas/DeleteDedicatedGroupRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteDedicatedGroupResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteDedicatedGroupResponse" description: The HTTP 200 response (OK). '400': content: @@ -16201,102 +16302,104 @@ paths: tags: - DedicatedGroup "/DeleteDhcpOptions": - description: |- - Deletes a specified DHCP options set.
- Before deleting a DHCP options set, you must disassociate it from the Nets you associated it with. To do so, you need to associate with each Net a new set of DHCP options, or the `default` one if you do not want to associate any DHCP options with the Net.

- - **[IMPORTANT]**
- You cannot delete the `default` set. post: + description: |- + Deletes a specified DHCP options set.
+ Before deleting a DHCP options set, you must disassociate it from the Nets you associated it with. To do so, you need to associate with each Net a new set of DHCP options, or the `default` one if you do not want to associate any DHCP options with the Net.

+ + **[IMPORTANT]**
+ You cannot delete the `default` set. operationId: DeleteDhcpOptions requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteDhcpOptionsRequest" examples: ex1: value: DhcpOptionsSetId: dopt-12345678 - schema: - "$ref": "#/components/schemas/DeleteDhcpOptionsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteDhcpOptionsResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteDhcpOptionsResponse" description: The HTTP 200 response (OK). tags: - DhcpOption "/DeleteDirectLink": - description: |- - Deletes a specified DirectLink.
- Before deleting a DirectLink, ensure that all your DirectLink interfaces related to this DirectLink are deleted. post: + description: |- + Deletes a specified DirectLink.
+ Before deleting a DirectLink, ensure that all your DirectLink interfaces related to this DirectLink are deleted. operationId: DeleteDirectLink requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteDirectLinkRequest" examples: ex1: value: DirectLinkId: dxcon-12345678 - schema: - "$ref": "#/components/schemas/DeleteDirectLinkRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteDirectLinkResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteDirectLinkResponse" description: The HTTP 200 response (OK). tags: - DirectLink "/DeleteDirectLinkInterface": - description: Deletes a specified DirectLink interface. post: + description: Deletes a specified DirectLink interface. operationId: DeleteDirectLinkInterface requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteDirectLinkInterfaceRequest" examples: ex1: value: DirectLinkInterfaceId: dxvif-12345678 - schema: - "$ref": "#/components/schemas/DeleteDirectLinkInterfaceRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteDirectLinkInterfaceResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteDirectLinkInterfaceResponse" description: The HTTP 200 response (OK). tags: - DirectLinkInterface "/DeleteExportTask": - description: |- - Deletes an export task.
- If the export task is not running, the command fails and an error is returned. post: + description: |- + Deletes an export task.
+ If the export task is not in the `active` or `pending` state, the command fails and an error is returned. operationId: DeleteExportTask requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteExportTaskRequest" examples: ex1: summary: Deleting an image export task @@ -16306,12 +16409,12 @@ paths: summary: Deleting a snapshot export task value: ExportTaskId: snap-export-12345678 - schema: - "$ref": "#/components/schemas/DeleteExportTaskRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteExportTaskResponse" examples: ex1: summary: Deleting an image export task @@ -16323,66 +16426,64 @@ paths: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteExportTaskResponse" description: The HTTP 200 response (OK). tags: - Task "/DeleteFlexibleGpu": - description: |- - Releases a flexible GPU (fGPU) from your account.
- The fGPU becomes free to be used by someone else. post: + description: |- + Releases a flexible GPU (fGPU) from your account.
+ The fGPU becomes free to be used by someone else. operationId: DeleteFlexibleGpu requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteFlexibleGpuRequest" examples: ex1: value: FlexibleGpuId: fgpu-12345678 - schema: - "$ref": "#/components/schemas/DeleteFlexibleGpuRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteFlexibleGpuResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteFlexibleGpuResponse" description: The HTTP 200 response (OK). tags: - FlexibleGpu "/DeleteImage": - description: Deletes an OUTSCALE machine image (OMI) so that you cannot use it - anymore to launch virtual machines (VMs). However, you can still use VMs already - launched from this OMI. post: + description: Deletes an OUTSCALE machine image (OMI) so that you cannot use + it anymore to launch virtual machines (VMs). However, you can still use VMs + already launched from this OMI. operationId: DeleteImage requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteImageRequest" examples: ex1: value: ImageId: ami-12345678 - schema: - "$ref": "#/components/schemas/DeleteImageRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteImageResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteImageResponse" description: The HTTP 200 response (OK). '400': content: @@ -16405,31 +16506,31 @@ paths: tags: - Image "/DeleteInternetService": - description: |- - Deletes an internet service.
- Before deleting an internet service, you must detach it from any Net it is attached to. post: + description: |- + Deletes an internet service.
+ Before deleting an internet service, you must detach it from any Net it is attached to. operationId: DeleteInternetService requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteInternetServiceRequest" examples: ex1: value: InternetServiceId: igw-12345678 - schema: - "$ref": "#/components/schemas/DeleteInternetServiceRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteInternetServiceResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteInternetServiceResponse" description: The HTTP 200 response (OK). '400': content: @@ -16452,14 +16553,16 @@ paths: tags: - InternetService "/DeleteKeypair": - description: |- - Deletes the specified keypair.
- This action deletes the public key stored by 3DS OUTSCALE, thus deleting the keypair. post: + description: |- + Deletes the specified keypair.
+ This action deletes the public key stored by 3DS OUTSCALE, thus deleting the keypair. operationId: DeleteKeypair requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteKeypairRequest" examples: ex1: summary: Deleting a keypair with its name @@ -16469,19 +16572,17 @@ paths: summary: Deleting a keypair with its ID value: KeypairId: key-abcdef1234567890abcdef1234567890 - schema: - "$ref": "#/components/schemas/DeleteKeypairRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteKeypairResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteKeypairResponse" description: The HTTP 200 response (OK). '400': content: @@ -16504,192 +16605,194 @@ paths: tags: - Keypair "/DeleteListenerRule": - description: |- - Deletes a listener rule.
- The previously active rule is disabled after deletion. post: + description: |- + Deletes a listener rule.
+ The previously active rule is disabled after deletion. operationId: DeleteListenerRule requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteListenerRuleRequest" examples: ex1: value: ListenerRuleName: example-listener-rule - schema: - "$ref": "#/components/schemas/DeleteListenerRuleRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteListenerRuleResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteListenerRuleResponse" description: The HTTP 200 response (OK). tags: - Listener "/DeleteLoadBalancer": - description: Deletes a specified load balancer. post: + description: Deletes a specified load balancer. operationId: DeleteLoadBalancer requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteLoadBalancerRequest" examples: ex1: value: LoadBalancerName: example-lbu - schema: - "$ref": "#/components/schemas/DeleteLoadBalancerRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteLoadBalancerResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteLoadBalancerResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer "/DeleteLoadBalancerListeners": - description: Deletes listeners of a specified load balancer. post: + description: Deletes listeners of a specified load balancer. operationId: DeleteLoadBalancerListeners requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteLoadBalancerListenersRequest" examples: ex1: value: LoadBalancerName: example-lbu LoadBalancerPorts: - 80 - schema: - "$ref": "#/components/schemas/DeleteLoadBalancerListenersRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteLoadBalancerListenersResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 LoadBalancer: + Tags: [] + SourceSecurityGroup: + SecurityGroupName: security-group-example + SecurityGroupAccountId: '123456789012' + SecuredCookies: false + Subnets: + - subnet-12345678 + NetId: vpc-12345678 + BackendVmIds: [] + ApplicationStickyCookiePolicies: [] + SecurityGroups: + - sg-12345678 + LoadBalancerType: internal AccessLog: - IsEnabled: false PublicationInterval: 60 - ApplicationStickyCookiePolicies: [] - BackendVmIds: [] + IsEnabled: false DnsName: internal-example-lbu.123456789.eu-west-2.lbu.outscale.com HealthCheck: + UnhealthyThreshold: 2 + Timeout: 5 CheckInterval: 30 + Protocol: TCP HealthyThreshold: 10 Port: 80 - Protocol: TCP - Timeout: 5 - UnhealthyThreshold: 2 - Listeners: [] - LoadBalancerName: example-lbu LoadBalancerStickyCookiePolicies: [] - LoadBalancerType: internal - NetId: vpc-12345678 - SecuredCookies: false - SecurityGroups: - - sg-12345678 - SourceSecurityGroup: - SecurityGroupAccountId: '123456789012' - SecurityGroupName: security-group-example - Subnets: - - subnet-12345678 SubregionNames: - eu-west-2a - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteLoadBalancerListenersResponse" + Listeners: [] + LoadBalancerName: example-lbu description: The HTTP 200 response (OK). tags: - Listener "/DeleteLoadBalancerPolicy": - description: |- - Deletes a specified policy from a load balancer.
- In order to be deleted, the policy must not be enabled for any listener. post: + description: |- + Deletes a specified policy from a load balancer.
+ In order to be deleted, the policy must not be enabled for any listener. operationId: DeleteLoadBalancerPolicy requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteLoadBalancerPolicyRequest" examples: ex1: value: LoadBalancerName: example-lbu PolicyName: example-browser-policy - schema: - "$ref": "#/components/schemas/DeleteLoadBalancerPolicyRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteLoadBalancerPolicyResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 LoadBalancer: + Tags: [] + SourceSecurityGroup: + SecurityGroupName: default + SecurityGroupAccountId: '123456789012' + SecuredCookies: false + PublicIp: 192.0.2.0 + Subnets: + - subnet-12345678 + NetId: vpc-12345678 + BackendVmIds: [] + ApplicationStickyCookiePolicies: [] + SecurityGroups: + - sg-12345678 + LoadBalancerType: internet-facing AccessLog: - IsEnabled: false PublicationInterval: 60 - ApplicationStickyCookiePolicies: [] - BackendVmIds: [] + IsEnabled: false DnsName: example-lbu-123456789.eu-west-2.lbu.outscale.com HealthCheck: + UnhealthyThreshold: 2 + Timeout: 5 CheckInterval: 30 + Protocol: TCP HealthyThreshold: 10 Port: 80 - Protocol: TCP - Timeout: 5 - UnhealthyThreshold: 2 + LoadBalancerStickyCookiePolicies: [] + SubregionNames: + - eu-west-2a Listeners: - BackendPort: 80 BackendProtocol: HTTP LoadBalancerPort: 80 LoadBalancerProtocol: HTTP LoadBalancerName: example-lbu - LoadBalancerStickyCookiePolicies: [] - LoadBalancerType: internet-facing - NetId: vpc-12345678 - PublicIp: 192.0.2.0 - SecuredCookies: false - SecurityGroups: - - sg-12345678 - SourceSecurityGroup: - SecurityGroupAccountId: '123456789012' - SecurityGroupName: default - Subnets: - - subnet-12345678 - SubregionNames: - - eu-west-2a - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteLoadBalancerPolicyResponse" description: The HTTP 200 response (OK). tags: - LoadBalancerPolicy "/DeleteLoadBalancerTags": - description: Deletes one or more tags from the specified load balancers. post: + description: Deletes one or more tags from the specified load balancers. operationId: DeleteLoadBalancerTags requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteLoadBalancerTagsRequest" examples: ex1: value: @@ -16697,48 +16800,46 @@ paths: - example-lbu Tags: - Key: key1 - schema: - "$ref": "#/components/schemas/DeleteLoadBalancerTagsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteLoadBalancerTagsResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteLoadBalancerTagsResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer "/DeleteNatService": - description: |- - Deletes a specified network address translation (NAT) service.
- This action disassociates the public IP from the NAT service, but does not release this public IP from your account. However, it does not delete any NAT service routes in your route tables. post: + description: |- + Deletes a specified network address translation (NAT) service.
+ This action disassociates the public IP from the NAT service, but does not release this public IP from your account. However, it does not delete any NAT service routes in your route tables. operationId: DeleteNatService requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteNatServiceRequest" examples: ex1: value: NatServiceId: nat-12345678 - schema: - "$ref": "#/components/schemas/DeleteNatServiceRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteNatServiceResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteNatServiceResponse" description: The HTTP 200 response (OK). '400': content: @@ -16761,41 +16862,41 @@ paths: tags: - NatService "/DeleteNet": - description: |- - Deletes a specified Net.
- Before deleting the Net, you need to delete or detach all the resources associated with the Net:

- - * Virtual machines (VMs)
- * Net peerings
- * Custom route tables
- * Public IPs allocated to resources in the Net
- * Network Interface Cards (NICs) created in the Subnets
- * Virtual gateways, internet services and NAT services
- * Load balancers
- * Security groups
- * Subnets post: + description: |- + Deletes a specified Net.
+ Before deleting the Net, you need to delete or detach all the resources associated with the Net:

+ + * Virtual machines (VMs)
+ * Net peerings
+ * Custom route tables
+ * Public IPs allocated to resources in the Net
+ * Network Interface Cards (NICs) created in the Subnets
+ * Virtual gateways, internet services and NAT services
+ * Load balancers
+ * Security groups
+ * Subnets operationId: DeleteNet requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteNetRequest" examples: ex1: value: NetId: vpc-12345678 - schema: - "$ref": "#/components/schemas/DeleteNetRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteNetResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteNetResponse" description: The HTTP 200 response (OK). '400': content: @@ -16818,62 +16919,62 @@ paths: tags: - Net "/DeleteNetAccessPoint": - description: |- - Deletes a specified Net access point.
- This action also deletes the corresponding routes added to the route tables you specified for the Net access point. post: + description: |- + Deletes a specified Net access point.
+ This action also deletes the corresponding routes added to the route tables you specified for the Net access point. operationId: DeleteNetAccessPoint requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteNetAccessPointRequest" examples: ex1: value: NetAccessPointId: vpce-12345678 - schema: - "$ref": "#/components/schemas/DeleteNetAccessPointRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteNetAccessPointResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteNetAccessPointResponse" description: The HTTP 200 response (OK). tags: - NetAccessPoint "/DeleteNetPeering": - description: |- - Deletes a Net peering.
- If the Net peering is in the `active` state, it can be deleted either by the owner of the requester Net or the owner of the peer Net.
- If it is in the `pending-acceptance` state, it can be deleted only by the owner of the requester Net.
- If it is in the `rejected`, `failed`, or `expired` states, it cannot be deleted. post: + description: |- + Deletes a Net peering.
+ If the Net peering is in the `active` state, it can be deleted either by the owner of the requester Net or the owner of the peer Net.
+ If it is in the `pending-acceptance` state, it can be deleted only by the owner of the requester Net.
+ If it is in the `rejected`, `failed`, or `expired` states, it cannot be deleted. operationId: DeleteNetPeering requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteNetPeeringRequest" examples: ex1: value: NetPeeringId: pcx-12345678 - schema: - "$ref": "#/components/schemas/DeleteNetPeeringRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteNetPeeringResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteNetPeeringResponse" description: The HTTP 200 response (OK). '400': content: @@ -16902,31 +17003,31 @@ paths: tags: - NetPeering "/DeleteNic": - description: |- - Deletes the specified network interface card (NIC).
- The network interface must not be attached to any virtual machine (VM). post: + description: |- + Deletes the specified network interface card (NIC).
+ The network interface must not be attached to any virtual machine (VM). operationId: DeleteNic requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteNicRequest" examples: ex1: value: NicId: eni-12345678 - schema: - "$ref": "#/components/schemas/DeleteNicRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteNicResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteNicResponse" description: The HTTP 200 response (OK). '400': content: @@ -16949,92 +17050,92 @@ paths: tags: - Nic "/DeletePolicy": - description: |- - Deletes a managed policy.
- Before deleting a managed policy, you must unlink all users linked to it and delete all the versions of the policy, except the default one, using the `DeletePolicyVersion` method. post: + description: |- + Deletes a managed policy.
+ Before deleting a managed policy, you must unlink all users linked to it and delete all the versions of the policy, except the default one, using the `DeletePolicyVersion` method. operationId: DeletePolicy requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeletePolicyRequest" examples: ex1: value: PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy - schema: - "$ref": "#/components/schemas/DeletePolicyRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeletePolicyResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeletePolicyResponse" description: The HTTP 200 response (OK). tags: - Policy "/DeletePolicyVersion": - description: Deletes a specified version of a managed policy, if it is not set - as the default one. post: + description: Deletes a specified version of a managed policy, if it is not set + as the default one. operationId: DeletePolicyVersion requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeletePolicyVersionRequest" examples: ex1: value: PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy VersionId: v1 - schema: - "$ref": "#/components/schemas/DeletePolicyVersionRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeletePolicyVersionResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeletePolicyVersionResponse" description: The HTTP 200 response (OK). tags: - Policy "/DeleteProductType": - description: |- - Deletes a specified product type that belongs to you.
- - **[WARNING]**
- The product type must not be associated with one or more OMIs to be deleted. Otherwise, you need to force the deletion.
- If you force the deletion, the product type is deleted and remains associated with the OMIs.
post: + description: |- + Deletes a specified product type that belongs to you.
+ + **[WARNING]**
+ The product type must not be associated with one or more OMIs to be deleted. Otherwise, you need to force the deletion.
+ If you force the deletion, the product type is deleted and remains associated with the OMIs.
operationId: DeleteProductType requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteProductTypeRequest" examples: ex1: value: ProductTypeId: pty-12345678 - schema: - "$ref": "#/components/schemas/DeleteProductTypeRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteProductTypeResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteProductTypeResponse" description: The HTTP 200 response (OK). '400': content: @@ -17057,31 +17158,31 @@ paths: tags: - ProductType "/DeletePublicIp": - description: |- - Releases a public IP.
- You can release a public IP associated with your account. This address is released in the public IP pool and can be used by someone else. Before releasing a public IP, ensure you updated all your resources communicating with this address. post: + description: |- + Releases a public IP.
+ You can release a public IP associated with your account. This address is released in the public IP pool and can be used by someone else. Before releasing a public IP, ensure you updated all your resources communicating with this address. operationId: DeletePublicIp requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeletePublicIpRequest" examples: ex1: value: PublicIp: 192.0.2.0 - schema: - "$ref": "#/components/schemas/DeletePublicIpRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeletePublicIpResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeletePublicIpResponse" description: The HTTP 200 response (OK). '400': content: @@ -17104,40 +17205,40 @@ paths: tags: - PublicIp "/DeleteRoute": - description: Deletes a route from a specified route table. post: + description: Deletes a route from a specified route table. operationId: DeleteRoute requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteRouteRequest" examples: ex1: value: - DestinationIpRange: 198.51.100.0/24 RouteTableId: rtb-12345678 - schema: - "$ref": "#/components/schemas/DeleteRouteRequest" + DestinationIpRange: 198.51.100.0/24 responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteRouteResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 RouteTable: + Routes: + - DestinationIpRange: 10.0.0.0/16 + CreationMethod: CreateRouteTable + State: active LinkRouteTables: [] NetId: vpc-12345678 + Tags: [] RoutePropagatingVirtualGateways: [] RouteTableId: rtb-12345678 - Routes: - - CreationMethod: CreateRouteTable - DestinationIpRange: 10.0.0.0/16 - State: active - Tags: [] - schema: - "$ref": "#/components/schemas/DeleteRouteResponse" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -17160,31 +17261,31 @@ paths: tags: - Route "/DeleteRouteTable": - description: |- - Deletes a specified route table.
- Before deleting a route table, you must disassociate it from any Subnet. You cannot delete the main route table. post: + description: |- + Deletes a specified route table.
+ Before deleting a route table, you must disassociate it from any Subnet. You cannot delete the main route table. operationId: DeleteRouteTable requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteRouteTableRequest" examples: ex1: value: RouteTableId: rtb-12345678 - schema: - "$ref": "#/components/schemas/DeleteRouteTableRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteRouteTableResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteRouteTableResponse" description: The HTTP 200 response (OK). '400': content: @@ -17207,32 +17308,32 @@ paths: tags: - RouteTable "/DeleteSecurityGroup": - description: |- - Deletes a specified security group.
- You can specify either the name of the security group or its ID.
- This action fails if the specified group is associated with a virtual machine (VM) or referenced by another security group. post: + description: |- + Deletes a specified security group.
+ You can specify either the name of the security group or its ID.
+ This action fails if the specified group is associated with a virtual machine (VM) or referenced by another security group. operationId: DeleteSecurityGroup requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteSecurityGroupRequest" examples: ex1: value: SecurityGroupId: sg-12345678 - schema: - "$ref": "#/components/schemas/DeleteSecurityGroupRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteSecurityGroupResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteSecurityGroupResponse" description: The HTTP 200 response (OK). '400': content: @@ -17255,85 +17356,85 @@ paths: tags: - SecurityGroup "/DeleteSecurityGroupRule": - description: |- - Deletes one or more inbound or outbound rules from a security group. For the rule to be deleted, the values specified in the deletion request must exactly match the value of the existing rule.
- In case of TCP and UDP protocols, you have to indicate the destination port or range of ports. In case of ICMP protocol, you have to specify the ICMP type and code numbers.
- Rules (IP permissions) consist of the protocol, IP range or source security group.
- To remove outbound access to a destination security group, we recommend to use a set of IP permissions. We also recommend to specify the protocol in a set of IP permissions. post: + description: |- + Deletes one or more inbound or outbound rules from a security group. For the rule to be deleted, the values specified in the deletion request must exactly match the value of the existing rule.
+ In case of TCP and UDP protocols, you have to indicate the destination port or range of ports. In case of ICMP protocol, you have to specify the ICMP type and code numbers.
+ Rules (IP permissions) consist of the protocol, IP range or source security group.
+ To remove outbound access to a destination security group, we recommend to use a set of IP permissions. We also recommend to specify the protocol in a set of IP permissions. operationId: DeleteSecurityGroupRule requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteSecurityGroupRuleRequest" examples: ex1: summary: Deleting an inbound rule from an IP range value: Flow: Inbound + SecurityGroupId: sg-12345678 FromPortRange: 80 + ToPortRange: 80 IpProtocol: tcp IpRange: 10.0.0.0/16 - SecurityGroupId: sg-12345678 - ToPortRange: 80 ex2: summary: Deleting an inbound rule from another security group value: Flow: Inbound + SecurityGroupId: sg-12345678 Rules: - FromPortRange: 22 + ToPortRange: 22 IpProtocol: tcp SecurityGroupsMembers: - AccountId: '123456789012' SecurityGroupName: another-security-group - ToPortRange: 22 - SecurityGroupId: sg-12345678 - schema: - "$ref": "#/components/schemas/DeleteSecurityGroupRuleRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteSecurityGroupRuleResponse" examples: ex1: summary: Deleting an inbound rule from an IP range value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 SecurityGroup: - AccountId: '123456789012' - Description: Example of security group - InboundRules: [] - NetId: vpc-12345678 + Tags: [] + SecurityGroupName: security-group-example OutboundRules: - FromPortRange: -1 IpProtocol: "-1" + ToPortRange: -1 IpRanges: - 0.0.0.0/0 - ToPortRange: -1 SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - Tags: [] - ex2: - summary: Creating an inbound rule from another security group - value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - SecurityGroup: AccountId: '123456789012' Description: Example of security group InboundRules: [] NetId: vpc-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + summary: Creating an inbound rule from another security group + value: + SecurityGroup: + Tags: [] + SecurityGroupName: security-group-example OutboundRules: - FromPortRange: -1 IpProtocol: "-1" + ToPortRange: -1 IpRanges: - 0.0.0.0/0 - ToPortRange: -1 SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - Tags: [] - schema: - "$ref": "#/components/schemas/DeleteSecurityGroupRuleResponse" + AccountId: '123456789012' + Description: Example of security group + InboundRules: [] + NetId: vpc-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -17356,58 +17457,58 @@ paths: tags: - SecurityGroupRule "/DeleteServerCertificate": - description: Deletes a specified server certificate. post: + description: Deletes a specified server certificate. operationId: DeleteServerCertificate requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteServerCertificateRequest" examples: ex1: value: Name: server-cert-example - schema: - "$ref": "#/components/schemas/DeleteServerCertificateRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteServerCertificateResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteServerCertificateResponse" description: The HTTP 200 response (OK). tags: - ServerCertificate "/DeleteSnapshot": - description: |- - Deletes a specified snapshot.
- You cannot delete a snapshot that is currently used by an OUTSCALE machine image (OMI). To do so, you first need to delete the corresponding OMI. For more information, see the [DeleteImage](#deleteimage) method. post: + description: |- + Deletes a specified snapshot.
+ You cannot delete a snapshot that is currently used by an OUTSCALE machine image (OMI). To do so, you first need to delete the corresponding OMI. For more information, see the [DeleteImage](#deleteimage) method. operationId: DeleteSnapshot requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteSnapshotRequest" examples: ex1: value: SnapshotId: snap-12345678 - schema: - "$ref": "#/components/schemas/DeleteSnapshotRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteSnapshotResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteSnapshotResponse" description: The HTTP 200 response (OK). '400': content: @@ -17430,36 +17531,36 @@ paths: tags: - Snapshot "/DeleteSubnet": - description: |- - Deletes a specified Subnet.
- Before deleting the Subnet, you need to delete all resources associated with the Subnet:

- - * Virtual machines (VMs)
- * Network Interface Cards (NICs)
- * NAT services
- * Load balancers post: + description: |- + Deletes a specified Subnet.
+ Before deleting the Subnet, you need to delete all resources associated with the Subnet:

+ + * Virtual machines (VMs)
+ * Network Interface Cards (NICs)
+ * NAT services
+ * Load balancers operationId: DeleteSubnet requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteSubnetRequest" examples: ex1: value: SubnetId: subnet-12345678 - schema: - "$ref": "#/components/schemas/DeleteSubnetRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteSubnetResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteSubnetResponse" description: The HTTP 200 response (OK). '400': content: @@ -17482,12 +17583,14 @@ paths: tags: - Subnet "/DeleteTags": - description: Deletes one or more tags from the specified resources. post: + description: Deletes one or more tags from the specified resources. operationId: DeleteTags requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteTagsRequest" examples: ex1: value: @@ -17496,19 +17599,17 @@ paths: Tags: - Key: key1 Value: value1 - schema: - "$ref": "#/components/schemas/DeleteTagsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteTagsResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteTagsResponse" description: The HTTP 200 response (OK). '400': content: @@ -17531,181 +17632,181 @@ paths: tags: - Tag "/DeleteUser": - description: Deletes a specified EIM user. The EIM user must not belong to any - group, nor have any key or linked policy. post: + description: Deletes a specified EIM user. The EIM user must not belong to any + group, nor have any key or linked policy. operationId: DeleteUser requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteUserRequest" examples: ex1: value: UserName: example-user - schema: - "$ref": "#/components/schemas/DeleteUserRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteUserResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteUserResponse" description: The HTTP 200 response (OK). tags: - User "/DeleteUserGroup": - description: |- - Deletes a specified user group.
- - **[WARNING]**
- The user group must be empty of any user and must not have any linked policy. Otherwise, you need to force the deletion.
- If you force the deletion, all inline policies will be deleted with the user group.
post: + description: |- + Deletes a specified user group.
+ + **[WARNING]**
+ The user group must be empty of any user and must not have any linked policy. Otherwise, you need to force the deletion.
+ If you force the deletion, all inline policies will be deleted with the user group.
operationId: DeleteUserGroup requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteUserGroupRequest" examples: ex1: value: Force: false Path: "/example/" UserGroupName: example-usergroup - schema: - "$ref": "#/components/schemas/DeleteUserGroupRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteUserGroupResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteUserGroupResponse" description: The HTTP 200 response (OK). tags: - UserGroup "/DeleteUserGroupPolicy": - description: Deletes a specified inline policy from a specific group. post: + description: Deletes a specified inline policy from a specific group. operationId: DeleteUserGroupPolicy requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteUserGroupPolicyRequest" examples: ex1: value: PolicyName: example-usergroup-policy UserGroupName: example-usergroup UserGroupPath: "/example/" - schema: - "$ref": "#/components/schemas/DeleteUserGroupPolicyRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteUserGroupPolicyResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteUserGroupPolicyResponse" description: The HTTP 200 response (OK). tags: - Policy "/DeleteUserPolicy": - description: Deletes a specified inline policy from a specific user. post: + description: Deletes a specified inline policy from a specific user. operationId: DeleteUserPolicy requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteUserPolicyRequest" examples: ex1: value: PolicyName: example-user-policy UserName: example-user - schema: - "$ref": "#/components/schemas/DeleteUserPolicyRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteUserPolicyResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteUserPolicyResponse" description: The HTTP 200 response (OK). tags: - Policy "/DeleteVirtualGateway": - description: |- - Deletes a specified virtual gateway.
- Before deleting a virtual gateway, we recommend to detach it from the Net and delete the VPN connection. post: + description: |- + Deletes a specified virtual gateway.
+ Before deleting a virtual gateway, we recommend to detach it from the Net and delete the VPN connection. operationId: DeleteVirtualGateway requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteVirtualGatewayRequest" examples: ex1: value: VirtualGatewayId: vgw-12345678 - schema: - "$ref": "#/components/schemas/DeleteVirtualGatewayRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteVirtualGatewayResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteVirtualGatewayResponse" description: The HTTP 200 response (OK). tags: - VirtualGateway "/DeleteVmGroup": - description: |- - > [WARNING]
- > This feature is currently under development and may not function properly.
- - Deletes a specified VM group. post: + description: |- + > [WARNING]
+ > This feature is currently under development and may not function properly.
+ + Deletes a specified VM group. operationId: DeleteVmGroup requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteVmGroupRequest" examples: ex1: value: VmGroupId: vmgroup-12345678901234567890123456789012 - schema: - "$ref": "#/components/schemas/DeleteVmGroupRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteVmGroupResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteVmGroupResponse" description: The HTTP 200 response (OK). '400': content: @@ -17728,68 +17829,68 @@ paths: tags: - VmGroup "/DeleteVmTemplate": - description: |- - > [WARNING]
- > This feature is currently under development and may not function properly.
- - Deletes a virtual machine (VM) template.
- You cannot delete a template currently used by a VM group. post: + description: |- + > [WARNING]
+ > This feature is currently under development and may not function properly.
+ + Deletes a virtual machine (VM) template.
+ You cannot delete a template currently used by a VM group. operationId: DeleteVmTemplate requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteVmTemplateRequest" examples: ex1: value: VmTemplateId: vmtemplate-98765432109876543210987654321012 - schema: - "$ref": "#/components/schemas/DeleteVmTemplateRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteVmTemplateResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteVmTemplateResponse" description: The HTTP 200 response (OK). tags: - VmTemplate "/DeleteVms": - description: |- - Terminates one or more virtual machines (VMs).
- This operation is idempotent, that means that all calls succeed if you terminate a VM more than once. post: + description: |- + Terminates one or more virtual machines (VMs).
+ This operation is idempotent, that means that all calls succeed if you terminate a VM more than once. operationId: DeleteVms requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteVmsRequest" examples: ex1: value: VmIds: - i-12345678 - schema: - "$ref": "#/components/schemas/DeleteVmsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteVmsResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Vms: - - CurrentState: shutting-down + - VmId: i-12345678 PreviousState: running - VmId: i-12345678 - schema: - "$ref": "#/components/schemas/DeleteVmsResponse" + CurrentState: shutting-down + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -17812,31 +17913,31 @@ paths: tags: - Vm "/DeleteVolume": - description: |- - Deletes a specified Block Storage Unit (BSU) volume.
- You can delete available volumes only, that is, volumes that are not attached to a virtual machine (VM). post: + description: |- + Deletes a specified Block Storage Unit (BSU) volume.
+ You can delete available volumes only, that is, volumes that are not attached to a virtual machine (VM). operationId: DeleteVolume requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteVolumeRequest" examples: ex1: value: VolumeId: vol-12345678 - schema: - "$ref": "#/components/schemas/DeleteVolumeRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteVolumeResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteVolumeResponse" description: The HTTP 200 response (OK). '400': content: @@ -17859,157 +17960,325 @@ paths: tags: - Volume "/DeleteVpnConnection": - description: |- - Deletes a specified VPN connection.
- If you want to delete a Net and all its dependencies, we recommend to detach the virtual gateway from the Net and delete the Net before deleting the VPN connection. This enables you to delete the Net without waiting for the VPN connection to be deleted. post: + description: |- + Deletes a specified VPN connection.
+ If you want to delete a Net and all its dependencies, we recommend to detach the virtual gateway from the Net and delete the Net before deleting the VPN connection. This enables you to delete the Net without waiting for the VPN connection to be deleted. operationId: DeleteVpnConnection requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteVpnConnectionRequest" examples: ex1: value: VpnConnectionId: vpn-12345678 - schema: - "$ref": "#/components/schemas/DeleteVpnConnectionRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteVpnConnectionResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteVpnConnectionResponse" description: The HTTP 200 response (OK). tags: - VpnConnection "/DeleteVpnConnectionRoute": - description: Deletes a static route to a VPN connection previously created using - the CreateVpnConnectionRoute method. post: + description: Deletes a static route to a VPN connection previously created using + the CreateVpnConnectionRoute method. operationId: DeleteVpnConnectionRoute requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeleteVpnConnectionRouteRequest" examples: ex1: value: - DestinationIpRange: 10.0.0.0/16 VpnConnectionId: vpn-12345678 - schema: - "$ref": "#/components/schemas/DeleteVpnConnectionRouteRequest" + DestinationIpRange: 10.0.0.0/16 responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DeleteVpnConnectionRouteResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/DeleteVpnConnectionRouteResponse" description: The HTTP 200 response (OK). tags: - VpnConnection "/DeregisterVmsInLoadBalancer": - description: |- - > [WARNING]
- > Deprecated: This call is deprecated and will be removed.
- - Deregisters a specified virtual machine (VM) from a load balancer. post: + description: |- + > [WARNING]
+ > Deprecated: This call is deprecated and will be removed.
+ + Deregisters a specified virtual machine (VM) from a load balancer. operationId: DeregisterVmsInLoadBalancer requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/DeregisterVmsInLoadBalancerRequest" examples: ex1: value: + LoadBalancerName: example-lbu BackendVmIds: - i-12345678 - i-87654321 - LoadBalancerName: example-lbu + responses: + '200': + content: + application/json: + schema: + "$ref": "#/components/schemas/DeregisterVmsInLoadBalancerResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + description: The HTTP 200 response (OK). + tags: + - LoadBalancer + "/DisableOutscaleLogin": + post: + description: Disables the possibility of logging in using the Outscale credentials + of your root account when identity federation is activated. + operationId: DisableOutscaleLogin + requestBody: + content: + application/json: schema: - "$ref": "#/components/schemas/DeregisterVmsInLoadBalancerRequest" + "$ref": "#/components/schemas/DisableOutscaleLoginRequest" + examples: + ex1: + value: {} responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/DisableOutscaleLoginResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + description: The HTTP 200 response (OK). + tags: + - IdentityProvider + "/DisableOutscaleLoginForUsers": + post: + description: Disables the possibility of logging in using the Outscale credentials + of your EIM users when identity federation is activated. + operationId: DisableOutscaleLoginForUsers + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/DisableOutscaleLoginRequest" + examples: + ex1: + value: {} + responses: + '200': + content: + application/json: schema: - "$ref": "#/components/schemas/DeregisterVmsInLoadBalancerResponse" + "$ref": "#/components/schemas/DisableOutscaleLoginResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - - LoadBalancer + - IdentityProvider + "/DisableOutscaleLoginPerUsers": + post: + description: Disables the possibility for one or more specific users to log + in using their Outscale credentials when identity federation is activated. + operationId: DisableOutscaleLoginPerUsers + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/DisableOutscaleLoginPerUsersRequest" + examples: + ex1: + value: + UserNames: + - example-user + - test-user + responses: + '200': + content: + application/json: + schema: + "$ref": "#/components/schemas/DisableOutscaleLoginPerUsersResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + description: The HTTP 200 response (OK). + tags: + - IdentityProvider + "/EnableOutscaleLogin": + post: + description: Enables the possibility of logging in using the Outscale credentials + of your root account when identity federation is activated. + operationId: EnableOutscaleLogin + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/EnableOutscaleLoginRequest" + examples: + ex1: + value: {} + responses: + '200': + content: + application/json: + schema: + "$ref": "#/components/schemas/EnableOutscaleLoginResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + description: The HTTP 200 response (OK). + tags: + - IdentityProvider + "/EnableOutscaleLoginForUsers": + post: + description: Enables the possibility for all your EIM users to log in using + their Outscale credentials when identity federation is activated. + operationId: EnableOutscaleLoginForUsers + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/EnableOutscaleLoginForUsersRequest" + examples: + ex1: + value: {} + responses: + '200': + content: + application/json: + schema: + "$ref": "#/components/schemas/EnableOutscaleLoginForUsersResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + description: The HTTP 200 response (OK). + tags: + - IdentityProvider + "/EnableOutscaleLoginPerUsers": + post: + description: Enables the possibility for one or more specific users to log in + using their Outscale credentials when identity federation is activated. + operationId: EnableOutscaleLoginPerUsers + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/EnableOutscaleLoginPerUsersRequest" + examples: + ex1: + value: + UserNames: + - example-user + - test-user + responses: + '200': + content: + application/json: + schema: + "$ref": "#/components/schemas/EnableOutscaleLoginPerUsersResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + description: The HTTP 200 response (OK). + tags: + - IdentityProvider "/LinkFlexibleGpu": - description: |- - Attaches one of your allocated flexible GPUs (fGPUs) to one of your virtual machines (VMs).
- To complete the linking of the fGPU, you need to do a stop/start of the VM. A simple restart is not sufficient, as the linking of the fGPU is done when the VM goes through the `stopped` state. For the difference between stop/start and restart, see [About VM Lifecycle](https://docs.outscale.com/en/userguide/About-VM-Lifecycle.html).

- - **[NOTE]**
- You can attach fGPUs only to VMs with the `highest` (1) performance flag. For more information see [About Flexible GPUs](https://docs.outscale.com/en/userguide/About-Flexible-GPUs.html) and [VM Types](https://docs.outscale.com/en/userguide/VM-Types.html). post: + description: |- + Attaches one of your allocated flexible GPUs (fGPUs) to one of your virtual machines (VMs).
+ To complete the linking of the fGPU, you need to do a stop/start of the VM. A simple restart is not sufficient, as the linking of the fGPU is done when the VM goes through the `stopped` state. For the difference between stop/start and restart, see [About VM Lifecycle](https://docs.outscale.com/en/userguide/About-VM-Lifecycle.html).

+ + **[NOTE]**
+ You can attach fGPUs only to VMs with the `highest` (1) performance flag. For more information see [About Flexible GPUs](https://docs.outscale.com/en/userguide/About-Flexible-GPUs.html) and [VM Types](https://docs.outscale.com/en/userguide/VM-Types.html). operationId: LinkFlexibleGpu requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/LinkFlexibleGpuRequest" examples: ex1: value: FlexibleGpuId: fgpu-12345678 VmId: i-12345678 - schema: - "$ref": "#/components/schemas/LinkFlexibleGpuRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/LinkFlexibleGpuResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/LinkFlexibleGpuResponse" description: The HTTP 200 response (OK). tags: - FlexibleGpu "/LinkInternetService": - description: |- - Attaches an internet service to a Net.
- To enable the connection between the Internet and a Net, you must attach an internet service to this Net. post: + description: |- + Attaches an internet service to a Net.
+ To enable the connection between the Internet and a Net, you must attach an internet service to this Net. operationId: LinkInternetService requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/LinkInternetServiceRequest" examples: ex1: value: InternetServiceId: igw-12345678 NetId: vpc-12345678 - schema: - "$ref": "#/components/schemas/LinkInternetServiceRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/LinkInternetServiceResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/LinkInternetServiceResponse" description: The HTTP 200 response (OK). '400': content: @@ -18032,35 +18301,37 @@ paths: tags: - InternetService "/LinkLoadBalancerBackendMachines": - description: |- - Attaches one or more virtual machines (VMs) to a specified load balancer. You need to specify at least the `BackendIps` or the `BackendVmIds` parameter.
- The VMs can be in different Subnets and different Subregions than the load balancer, as long as the VMs and load balancers are all in the public Cloud or all in the same Net. It may take a little time for a VM to be registered with the load balancer. Once the VM is registered with a load balancer, it receives traffic and requests from this load balancer and is called a backend VM. post: + description: |- + Attaches one or more virtual machines (VMs) to a specified load balancer. You need to specify at least the `BackendIps` or the `BackendVmIds` parameter.
+ The VMs can be in different Subnets and different Subregions than the load balancer, as long as the VMs and load balancers are all in the public Cloud or all in the same Net. It may take a little time for a VM to be registered with the load balancer. Once the VM is registered with a load balancer, it receives traffic and requests from this load balancer and is called a backend VM. operationId: LinkLoadBalancerBackendMachines requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/LinkLoadBalancerBackendMachinesRequest" examples: ex1: summary: Linking VMs to a load balancer value: + LoadBalancerName: example-lbu BackendVmIds: - i-12345678 - i-87654321 - LoadBalancerName: example-lbu ex2: summary: Linking public IPs to a load balancer value: + LoadBalancerName: example-lbu BackendIps: - 192.0.2.0 - 198.51.100.0 - LoadBalancerName: example-lbu - schema: - "$ref": "#/components/schemas/LinkLoadBalancerBackendMachinesRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/LinkLoadBalancerBackendMachinesResponse" examples: ex1: summary: Linking VMs to a load balancer @@ -18072,69 +18343,67 @@ paths: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/LinkLoadBalancerBackendMachinesResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer "/LinkManagedPolicyToUserGroup": - description: Links a managed policy to a specific group. This policy applies to - all the users contained in this group. post: + description: Links a managed policy to a specific group. This policy applies + to all the users contained in this group. operationId: LinkManagedPolicyToUserGroup requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/LinkManagedPolicyToUserGroupRequest" examples: ex1: value: PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy UserGroupName: example-usergroup - schema: - "$ref": "#/components/schemas/LinkManagedPolicyToUserGroupRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/LinkManagedPolicyToUserGroupResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/LinkManagedPolicyToUserGroupResponse" description: The HTTP 200 response (OK). tags: - Policy "/LinkNic": - description: |- - Attaches a network interface card (NIC) to a virtual machine (VM).
- The interface and the VM must be in the same Subregion. The VM can be either `running` or `stopped`. The NIC must be in the `available` state. For more information, see [Attaching a NIC to a VM](https://docs.outscale.com/en/userguide/Attaching-a-NIC-to-a-VM.html). post: + description: |- + Attaches a network interface card (NIC) to a virtual machine (VM).
+ The interface and the VM must be in the same Subregion. The VM can be either `running` or `stopped`. The NIC must be in the `available` state. For more information, see [Attaching a NIC to a VM](https://docs.outscale.com/en/userguide/Attaching-a-NIC-to-a-VM.html). operationId: LinkNic requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/LinkNicRequest" examples: ex1: value: - DeviceNumber: 1 NicId: eni-12345678 VmId: i-12345678 - schema: - "$ref": "#/components/schemas/LinkNicRequest" + DeviceNumber: 1 responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/LinkNicResponse" examples: ex1: value: - LinkNicId: eni-attach-12345678 ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/LinkNicResponse" + LinkNicId: eni-attach-12345678 description: The HTTP 200 response (OK). '400': content: @@ -18157,46 +18426,48 @@ paths: tags: - Nic "/LinkPolicy": - description: Links a managed policy to a specific user. post: + description: Links a managed policy to a specific user. operationId: LinkPolicy requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/LinkPolicyRequest" examples: ex1: value: PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy UserName: example-user - schema: - "$ref": "#/components/schemas/LinkPolicyRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/LinkPolicyResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/LinkPolicyResponse" description: The HTTP 200 response (OK). tags: - Policy "/LinkPrivateIps": - description: Assigns one or more secondary private IPs to a specified network - interface card (NIC). This action is only available in a Net. The private IPs - to be assigned can be added individually using the `PrivateIps` parameter, or - you can specify the number of private IPs to be automatically chosen within - the Subnet range using the `SecondaryPrivateIpCount` parameter. You can specify - only one of these two parameters. If none of these parameters are specified, - a private IP is chosen within the Subnet range. post: + description: Assigns one or more secondary private IPs to a specified network + interface card (NIC). This action is only available in a Net. The private + IPs to be assigned can be added individually using the `PrivateIps` parameter, + or you can specify the number of private IPs to be automatically chosen within + the Subnet range using the `SecondaryPrivateIpCount` parameter. You can specify + only one of these two parameters. If none of these parameters are specified, + a private IP is chosen within the Subnet range. operationId: LinkPrivateIps requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/LinkPrivateIpsRequest" examples: ex1: summary: Linking specific secondary private IPs to a NIC @@ -18210,19 +18481,17 @@ paths: value: NicId: eni-12345678 SecondaryPrivateIpCount: 3 - schema: - "$ref": "#/components/schemas/LinkPrivateIpsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/LinkPrivateIpsResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/LinkPrivateIpsResponse" description: The HTTP 200 response (OK). '400': content: @@ -18245,18 +18514,20 @@ paths: tags: - Nic "/LinkPublicIp": - description: |- - Associates a public IP with a virtual machine (VM) or a network interface card (NIC), in the public Cloud or in a Net. You can associate a public IP with only one VM or network interface at a time.
- To associate a public IP in a Net, ensure that the Net has an internet service attached. For more information, see the [LinkInternetService](#linkinternetservice) method.
- By default, the public IP is disassociated every time you stop and start the VM. For a persistent association, you can add the `osc.fcu.eip.auto-attach` tag to the VM with the public IP as value. For more information, see the [CreateTags](#createtags) method.

- - **[IMPORTANT]**
- You can associate a public IP with a network address translation (NAT) service only when creating the NAT service. To modify its public IP, you need to delete the NAT service and re-create it with the new public IP. For more information, see the [CreateNatService](#createnatservice) method. post: + description: |- + Associates a public IP with a virtual machine (VM) or a network interface card (NIC), in the public Cloud or in a Net. You can associate a public IP with only one VM or network interface at a time.
+ To associate a public IP in a Net, ensure that the Net has an internet service attached. For more information, see the [LinkInternetService](#linkinternetservice) method.
+ By default, the public IP is disassociated every time you stop and start the VM. For a persistent association, you can add the `osc.fcu.eip.auto-attach` tag to the VM with the public IP as value. For more information, see the [CreateTags](#createtags) method.

+ + **[IMPORTANT]**
+ You can associate a public IP with a network address translation (NAT) service only when creating the NAT service. To modify its public IP, you need to delete the NAT service and re-create it with the new public IP. For more information, see the [CreateNatService](#createnatservice) method. operationId: LinkPublicIp requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/LinkPublicIpRequest" examples: ex1: summary: Linking a public IP to a VM @@ -18266,29 +18537,27 @@ paths: ex2: summary: Linking a public IP to a NIC value: - NicId: eni-12345678 PublicIp: 192.0.2.0 - schema: - "$ref": "#/components/schemas/LinkPublicIpRequest" + NicId: eni-12345678 responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/LinkPublicIpResponse" examples: ex1: summary: Linking a public IP to a VM value: - LinkPublicIpId: eipassoc-12345678 ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + LinkPublicIpId: eipassoc-12345678 ex2: summary: Linking a public IP to a NIC value: - LinkPublicIpId: eipassoc-12345678 ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/LinkPublicIpResponse" + LinkPublicIpId: eipassoc-12345678 description: The HTTP 200 response (OK). '400': content: @@ -18311,33 +18580,33 @@ paths: tags: - PublicIp "/LinkRouteTable": - description: |- - Associates a Subnet with a route table.
- The Subnet and the route table must be in the same Net. The traffic is routed according to the route table defined within this Net. You can associate a route table with several Subnets. post: + description: |- + Associates a Subnet with a route table.
+ The Subnet and the route table must be in the same Net. The traffic is routed according to the route table defined within this Net. You can associate a route table with several Subnets. operationId: LinkRouteTable requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/LinkRouteTableRequest" examples: ex1: value: RouteTableId: rtb-12345678 SubnetId: subnet-12345678 - schema: - "$ref": "#/components/schemas/LinkRouteTableRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/LinkRouteTableResponse" examples: ex1: value: - LinkRouteTableId: rtbassoc-12345678 ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/LinkRouteTableResponse" + LinkRouteTableId: rtbassoc-12345678 description: The HTTP 200 response (OK). '400': content: @@ -18360,68 +18629,68 @@ paths: tags: - RouteTable "/LinkVirtualGateway": - description: |- - Attaches a virtual gateway to a Net. - - **[IMPORTANT]**
- This action can be done only if the virtual gateway is in the `available` state. post: + description: |- + Attaches a virtual gateway to a Net. + + **[IMPORTANT]**
+ This action can be done only if the virtual gateway is in the `available` state. operationId: LinkVirtualGateway requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/LinkVirtualGatewayRequest" examples: ex1: value: - NetId: vpc-12345678 VirtualGatewayId: vgw-12345678 - schema: - "$ref": "#/components/schemas/LinkVirtualGatewayRequest" + NetId: vpc-12345678 responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/LinkVirtualGatewayResponse" examples: ex1: value: - NetToVirtualGatewayLink: - NetId: vpc-12345678 - State: attached ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/LinkVirtualGatewayResponse" + NetToVirtualGatewayLink: + State: attached + NetId: vpc-12345678 description: The HTTP 200 response (OK). tags: - VirtualGateway "/LinkVolume": - description: |- - Attaches a Block Storage Unit (BSU) volume to a virtual machine (VM).
- The volume and the VM must be in the same Subregion. The VM can be running or stopped. The volume is attached to the specified VM device. post: + description: |- + Attaches a Block Storage Unit (BSU) volume to a virtual machine (VM).
+ The volume and the VM must be in the same Subregion. The VM can be running or stopped. The volume is attached to the specified VM device. operationId: LinkVolume requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/LinkVolumeRequest" examples: ex1: value: - DeviceName: "/dev/sdb" - VmId: i-12345678 VolumeId: vol-12345678 - schema: - "$ref": "#/components/schemas/LinkVolumeRequest" + VmId: i-12345678 + DeviceName: "/dev/sdb" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/LinkVolumeResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/LinkVolumeResponse" description: The HTTP 200 response (OK). '400': content: @@ -18444,14 +18713,16 @@ paths: tags: - Volume "/PutUserGroupPolicy": - description: |- - Creates or updates an inline policy included in a specified group.
- The policy is automatically applied to all the users of the group after its creation. post: + description: |- + Creates or updates an inline policy included in a specified group.
+ The policy is automatically applied to all the users of the group after its creation. operationId: PutUserGroupPolicy requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/PutUserGroupPolicyRequest" examples: ex1: value: @@ -18460,31 +18731,31 @@ paths: PolicyName: example-usergroup-policy UserGroupName: example-usergroup UserGroupPath: "/example/" - schema: - "$ref": "#/components/schemas/PutUserGroupPolicyRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/PutUserGroupPolicyResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/PutUserGroupPolicyResponse" description: The HTTP 200 response (OK). tags: - Policy "/PutUserPolicy": - description: |- - Creates or updates an inline policy included in a specified user.
- The policy is automatically applied to the user after its creation. post: + description: |- + Creates or updates an inline policy included in a specified user.
+ The policy is automatically applied to the user after its creation. operationId: PutUserPolicy requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/PutUserPolicyRequest" examples: ex1: value: @@ -18492,29 +18763,30 @@ paths: "Resource": ["*"]} ]}' PolicyName: example-user-policy UserName: example-user - schema: - "$ref": "#/components/schemas/PutUserPolicyRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/PutUserPolicyResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/PutUserPolicyResponse" description: The HTTP 200 response (OK). tags: - Policy "/ReadAccessKeys": - description: Lists the access key IDs of either your root account or an EIM user. post: + description: Lists the access key IDs of either your root account or an EIM + user. operationId: ReadAccessKeys requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadAccessKeysRequest" examples: ex1: value: @@ -18523,26 +18795,24 @@ paths: - ACTIVE Tag: Group1 UserName: example-user - schema: - "$ref": "#/components/schemas/ReadAccessKeysRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadAccessKeysResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 AccessKeys: - - AccessKeyId: ABCDEFGHIJ0123456789 + - State: ACTIVE + AccessKeyId: ABCDEFGHIJ0123456789 CreationDate: 2010-10-01 12:34:56.789000000 +00:00 ExpirationDate: 2063-04-05 00:00:00.000000000 +00:00 LastModificationDate: 2010-10-01 12:34:56.789000000 +00:00 - State: ACTIVE Tag: Group1 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadAccessKeysResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -18550,73 +18820,73 @@ paths: tags: - AccessKey "/ReadAccounts": - description: Gets information about the account that sent the request. post: + description: Gets information about the account that sent the request. operationId: ReadAccounts requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadAccountsRequest" examples: ex1: value: {} - schema: - "$ref": "#/components/schemas/ReadAccountsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadAccountsResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Accounts: - - AccountId: '123456789012' - City: SAINT-CLOUD + - ZipCode: '92210' CompanyName: EXAMPLE SAS + FirstName: JEAN + City: SAINT-CLOUD Country: FRANCE + LastName: DUPONT + AccountId: '123456789012' CustomerId: '87654321' Email: example@example.com - FirstName: JEAN - LastName: DUPONT - ZipCode: '92210' - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadAccountsResponse" description: The HTTP 200 response (OK). tags: - Account "/ReadAdminPassword": - description: |- - Gets the administrator password for a Windows running virtual machine (VM).
- The administrator password is encrypted using the keypair you specified when launching the VM.

- - **[IMPORTANT]**
- * Only RSA keypairs can decrypt the password of a Windows VM.
- * The administrator password is generated only on the first boot of the Windows VM. It is not returned after the first boot. post: + description: |- + Gets the administrator password for a Windows running virtual machine (VM).
+ The administrator password is encrypted using the keypair you specified when launching the VM.

+ + **[IMPORTANT]**
+ * Only RSA keypairs can decrypt the password of a Windows VM.
+ * The administrator password is generated only on the first boot of the Windows VM. It is not returned after the first boot. operationId: ReadAdminPassword requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadAdminPasswordRequest" examples: ex1: value: VmId: i-12345678 - schema: - "$ref": "#/components/schemas/ReadAdminPasswordRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadAdminPasswordResponse" examples: ex1: value: - AdminPassword: "..." + VmId: i-12345678 ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - VmId: i-12345678 - schema: - "$ref": "#/components/schemas/ReadAdminPasswordResponse" + AdminPassword: "..." description: The HTTP 200 response (OK). '400': content: @@ -18639,33 +18909,33 @@ paths: tags: - Vm "/ReadApiAccessPolicy": - description: |- - Gets information about the API access policy of your account.

- For more information, see [About Your API Access Policy](https://docs.outscale.com/en/userguide/About-Your-API-Access-Policy.html). post: + description: |- + Gets information about the API access policy of your account.

+ For more information, see [About Your API Access Policy](https://docs.outscale.com/en/userguide/About-Your-API-Access-Policy.html). operationId: ReadApiAccessPolicy requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadApiAccessPolicyRequest" examples: ex1: value: {} - schema: - "$ref": "#/components/schemas/ReadApiAccessPolicyRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadApiAccessPolicyResponse" examples: ex1: value: - ApiAccessPolicy: - MaxAccessKeyExpirationSeconds: 0 - RequireTrustedEnv: false ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadApiAccessPolicyResponse" + ApiAccessPolicy: + RequireTrustedEnv: false + MaxAccessKeyExpirationSeconds: 0 description: The HTTP 200 response (OK). '400': content: @@ -18691,44 +18961,38 @@ paths: tags: - ApiAccessPolicy "/ReadApiAccessRules": - description: Lists one or more API access rules. post: + description: Lists one or more API access rules. operationId: ReadApiAccessRules requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadApiAccessRulesRequest" examples: ex1: value: Filters: ApiAccessRuleIds: - aar-1234567890abcdef1234567890abcdef - schema: - "$ref": "#/components/schemas/ReadApiAccessRulesRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadApiAccessRulesResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ApiAccessRules: - - ApiAccessRuleId: aar-1234567890abcdef1234567890abcdef - CaIds: [] - Cns: [] - Description: Allows all IPv4 domain - IpRanges: + - IpRanges: - 0.0.0.0/0 - - ApiAccessRuleId: aar-abcdef1234567890abcdef1234567890 + ApiAccessRuleId: aar-1234567890abcdef1234567890abcdef CaIds: [] Cns: [] - Description: Allows Outscale Cockpit of this region - IpRanges: - - 46.231.144.178/32 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadApiAccessRulesResponse" + Description: Allows all IPv4 domain description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -18736,95 +19000,95 @@ paths: tags: - ApiAccessRule "/ReadApiLogs": - description: |- - Lists the logs of the API calls you have performed with this account. - - **[IMPORTANT]**
- Past logs are accessible for up to 32 days.
- By default, the retrieved interval is 48 hours. If neither of the `QueryDateBefore` nor `QueryDateAfter` parameters are specified, logs from the past 48 hours are retrieved. If you only specify one of two, logs are retrieved from a 2-day interval based on the date you provided. To retrieve logs beyond a 2-day interval, specify both parameters.

- For more information, see [About OMS](https://docs.outscale.com/en/userguide/About-OMS.html). post: + description: |- + Lists the logs of the API calls you have performed with this account. + + **[IMPORTANT]**
+ Past logs are accessible for up to 32 days.
+ By default, the retrieved interval is 48 hours. If neither of the `QueryDateBefore` nor `QueryDateAfter` parameters are specified, logs from the past 48 hours are retrieved. If you only specify one of two, logs are retrieved from a 2-day interval based on the date you provided. To retrieve logs beyond a 2-day interval, specify both parameters.

+ For more information, see [About OMS](https://docs.outscale.com/en/userguide/About-OMS.html). operationId: ReadApiLogs requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadApiLogsRequest" examples: ex1: value: Filters: - QueryDateAfter: '2017-05-10' - QueryDateBefore: '2017-05-10' QueryIpAddresses: - 192.0.2.0 - 198.51.100.0 - schema: - "$ref": "#/components/schemas/ReadApiLogsRequest" + QueryDateAfter: '2017-05-10' + QueryDateBefore: '2017-05-10' responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadApiLogsResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Logs: - - AccountId: '123456789012' - CallDuration: 47 - QueryAccessKey: ABCDEFGHIJ0123456789 + - ResponseStatusCode: 200 + ResponseSize: 1887 + QueryPayloadRaw: "{}" QueryApiName: oapi + QueryIpAddress: 192.0.2.0 + QueryUserAgent: oAPI CLI v0.1 - 2018-09-28 + CallDuration: 47 + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 QueryApiVersion: '1.27' + AccountId: '123456789012' + QueryPayloadSize: 2 QueryCallName: ReadAccessKeys + QueryAccessKey: ABCDEFGHIJ0123456789 + QueryHeaderSize: 287 QueryDate: '2017-05-10T12:34:56.789Z' QueryHeaderRaw: 'Host: api.eu-west-2.outscale.com\nAccept: */*\nConnection: close\nUser-Agent: oAPI CLI v0.1 - 2018-09-28\nX-Osc-Date: 20170510T000000Z\nContent-Type: application/json; charset=utf-8\nAuthorization: *****\nContent-Length: 2\nAccept-Encoding: gzip, deflate\nX-Forwarded-For: 192.0.2.0' - QueryHeaderSize: 287 - QueryIpAddress: 192.0.2.0 - QueryPayloadRaw: "{}" - QueryPayloadSize: 2 - QueryUserAgent: oAPI CLI v0.1 - 2018-09-28 - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - ResponseSize: 1887 - ResponseStatusCode: 200 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadApiLogsResponse" description: The HTTP 200 response (OK). tags: - ApiLog "/ReadCas": - description: Gets information about one or more of your Client Certificate Authorities - (CAs). post: + description: Gets information about one or more of your Client Certificate Authorities + (CAs). operationId: ReadCas requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadCasRequest" examples: ex1: value: Filters: CaIds: - ca-fedcba0987654321fedcba0987654321 - schema: - "$ref": "#/components/schemas/ReadCasRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadCasResponse" examples: ex1: value: - Cas: - - CaFingerprint: 1234567890abcdef1234567890abcdef12345678 - CaId: ca-fedcba0987654321fedcba0987654321 - Description: CA example ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadCasResponse" + Cas: + - Description: CA example + CaId: ca-fedcba0987654321fedcba0987654321 + CaFingerprint: 1234567890abcdef1234567890abcdef12345678 description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -18832,49 +19096,51 @@ paths: tags: - Ca "/ReadCatalog": - description: Returns the price list of OUTSCALE services for the current Region. post: + description: Returns the price list of OUTSCALE services for the current Region. operationId: ReadCatalog requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadCatalogRequest" examples: ex1: value: {} - schema: - "$ref": "#/components/schemas/ReadCatalogRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadCatalogResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Catalog: Entries: - - Category: compute - Operation: RunInstances-OD - Service: TinaOS-FCU - SubregionName: eu-west-2 + - UnitPrice: 0.04 + Type: CustomCore:v5-p1 Title: Instance - On demand - Unite de vCore pour une instance Tina v5 CxRy Performance highest - par heure - Type: CustomCore:v5-p1 - UnitPrice: 0.04 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadCatalogResponse" + SubregionName: eu-west-2 + Category: compute + Service: TinaOS-FCU + Operation: RunInstances-OD description: The HTTP 200 response (OK). tags: - Catalog "/ReadCatalogs": - description: Returns the price list of OUTSCALE services for the current Region - within a specific time period. post: + description: Returns the price list of OUTSCALE services for the current Region + within a specific time period. operationId: ReadCatalogs requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadCatalogsRequest" examples: ex1: value: @@ -18882,41 +19148,41 @@ paths: CurrentCatalogOnly: true FromDate: '2021-01-01' ToDate: '2023-01-01' - schema: - "$ref": "#/components/schemas/ReadCatalogsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadCatalogsResponse" examples: ex1: value: - Catalogs: - - Entries: - - Category: compute - Operation: RunInstances-OD - Service: TinaOS-FCU - SubregionName: eu-west-2 - Title: Instance - On demand - Unite de vCore pour une instance - Tina v5 CxRy Performance highest - par heure - Type: CustomCore:v5-p1 - UnitPrice: 0.04 - FromDate: 2021-01-01 00:00:00.000000000 +00:00 - State: CURRENT ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadCatalogsResponse" + Catalogs: + - State: CURRENT + FromDate: 2021-01-01 00:00:00.000000000 +00:00 + Entries: + - UnitPrice: 0.04 + Type: CustomCore:v5-p1 + Title: Instance - On demand - Unite de vCore pour une instance + Tina v5 CxRy Performance highest - par heure + SubregionName: eu-west-2 + Category: compute + Service: TinaOS-FCU + Operation: RunInstances-OD description: The HTTP 200 response (OK). tags: - Catalog "/ReadClientGateways": - description: Lists one or more of your client gateways. post: + description: Lists one or more of your client gateways. operationId: ReadClientGateways requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadClientGatewaysRequest" examples: ex1: value: @@ -18931,59 +19197,57 @@ paths: PublicIps: - 192.0.2.0 - 198.51.100.0 - schema: - "$ref": "#/components/schemas/ReadClientGatewaysRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadClientGatewaysResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ClientGateways: - - BgpAsn: 65000 + - State: available + BgpAsn: 65000 + Tags: [] ClientGatewayId: cgw-12345678 ConnectionType: ipsec.1 PublicIp: 192.0.2.0 - State: available - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadClientGatewaysResponse" description: The HTTP 200 response (OK). tags: - ClientGateway "/ReadConsoleOutput": - description: |- - Gets the console output for a virtual machine (VM). This console is not in real-time. It is refreshed every two seconds and provides the most recent 64 KiB output.

- - **[IMPORTANT]**
- On Windows VMs, the console is handled only on the first boot. It returns no output after the first boot. post: + description: |- + Gets the console output for a virtual machine (VM). This console is not in real-time. It is refreshed every two seconds and provides the most recent 64 KiB output.

+ + **[IMPORTANT]**
+ On Windows VMs, the console is handled only on the first boot. It returns no output after the first boot. operationId: ReadConsoleOutput requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadConsoleOutputRequest" examples: ex1: value: VmId: i-12345678 - schema: - "$ref": "#/components/schemas/ReadConsoleOutputRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadConsoleOutputResponse" examples: ex1: value: - ConsoleOutput: "..." + VmId: i-12345678 ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - VmId: i-12345678 - schema: - "$ref": "#/components/schemas/ReadConsoleOutputResponse" + ConsoleOutput: "..." description: The HTTP 200 response (OK). '400': content: @@ -19006,62 +19270,64 @@ paths: tags: - Vm "/ReadConsumptionAccount": - description: Gets information about the consumption of your account for each billable - resource within the specified time period. post: + description: Gets information about the consumption of your account for each + billable resource within the specified time period. operationId: ReadConsumptionAccount requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadConsumptionAccountRequest" examples: ex1: value: FromDate: '2023-06-01' - ShowPrice: true ToDate: '2023-07-01' - schema: - "$ref": "#/components/schemas/ReadConsumptionAccountRequest" + ShowPrice: true responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadConsumptionAccountResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ConsumptionEntries: - - AccountId: '123456789012' - Category: compute - FromDate: 2023-06-01 00:00:00.000000000 +00:00 + - UnitPrice: 0.044 + Type: BoxUsage:tinav4.c1r1p2 Operation: RunInstances-OD - PayingAccountId: '123456789012' - Price: 61.248 - Service: TinaOS-FCU SubregionName: eu-west-2a + Value: 1392 Title: Instance - On demand - tinav4.c1r1 high performance - par heure + Category: compute ToDate: 2023-06-30 00:00:00.000000000 +00:00 - Type: BoxUsage:tinav4.c1r1p2 - UnitPrice: 0.044 - Value: 1392 + Service: TinaOS-FCU + AccountId: '123456789012' + PayingAccountId: '123456789012' + FromDate: 2023-06-01 00:00:00.000000000 +00:00 + Price: 61.248 Currency: EUR - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadConsumptionAccountResponse" description: The HTTP 200 response (OK). tags: - Account "/ReadDedicatedGroups": - description: |- - > [WARNING]
- > This feature is currently in beta.
- - List one or more dedicated groups of virtual machines (VMs). post: + description: |- + > [WARNING]
+ > This feature is currently in beta.
+ + List one or more dedicated groups of virtual machines (VMs). operationId: ReadDedicatedGroups requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadDedicatedGroupsRequest" examples: ex1: summary: Filtering on a specific dedicated group @@ -19073,32 +19339,30 @@ paths: summary: Filtering on a specific Subregion and CPU generation value: Filters: - CpuGenerations: - - 4 SubregionNames: - eu-west-2a - schema: - "$ref": "#/components/schemas/ReadDedicatedGroupsRequest" + CpuGenerations: + - 4 responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadDedicatedGroupsResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 DedicatedGroups: - - AccountId: '123456789012' + - VmIds: + - i-12345678 + NetIds: [] + AccountId: '123456789012' CpuGeneration: 4 - DedicatedGroupId: ded-12345678 Name: dedicated-group-example - NetIds: [] SubregionName: eu-west-2a - VmIds: - - i-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadDedicatedGroupsResponse" + DedicatedGroupId: ded-12345678 description: The HTTP 200 response (OK). '400': content: @@ -19121,12 +19385,15 @@ paths: tags: - DedicatedGroup "/ReadDhcpOptions": - description: Gets information about the content of one or more DHCP options sets. post: + description: Gets information about the content of one or more DHCP options + sets. operationId: ReadDhcpOptions requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadDhcpOptionsRequest" examples: ex1: value: @@ -19141,98 +19408,100 @@ paths: - 198.51.100.0 DomainNames: - example.com - schema: - "$ref": "#/components/schemas/ReadDhcpOptionsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadDhcpOptionsResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 DhcpOptionsSets: - - Default: false + - Tags: [] + NtpServers: + - 203.0.113.0 + - 203.0.113.1 + Default: false DhcpOptionsSetId: dopt-12345678 DomainName: example.com DomainNameServers: - 192.0.2.0 - 198.51.100.0 - NtpServers: - - 203.0.113.0 - - 203.0.113.1 - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadDhcpOptionsResponse" description: The HTTP 200 response (OK). tags: - DhcpOption "/ReadDirectLinkInterfaces": - description: Lists one or more of your DirectLink interfaces. post: + description: Lists one or more of your DirectLink interfaces. operationId: ReadDirectLinkInterfaces requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadDirectLinkInterfacesRequest" examples: ex1: value: Filters: DirectLinkInterfaceIds: - dxvif-12345678 - schema: - "$ref": "#/components/schemas/ReadDirectLinkInterfacesRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadDirectLinkInterfacesResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 DirectLinkInterfaces: - - AccountId: '123456789012' + - Vlan: 101 + OutscalePrivateIp: 172.16.0.4/30 + DirectLinkInterfaceId: dxvif-12345678 BgpAsn: 65000 + AccountId: '123456789012' ClientPrivateIp: 172.16.0.5/30 - DirectLinkId: dxcon-12345678 - DirectLinkInterfaceId: dxvif-12345678 + VirtualGatewayId: vgw-12345678 DirectLinkInterfaceName: MyDirectLinkInterface - InterfaceType: private - Location: PAR1 + DirectLinkId: dxcon-12345678 Mtu: 1500 - OutscalePrivateIp: 172.16.0.4/30 State: available - VirtualGatewayId: vgw-12345678 - Vlan: 101 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadDirectLinkInterfacesResponse" + InterfaceType: private + Location: PAR1 description: The HTTP 200 response (OK). tags: - DirectLinkInterface "/ReadDirectLinks": - description: Lists all DirectLinks in the Region. post: + description: Lists all DirectLinks in the Region. operationId: ReadDirectLinks requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadDirectLinksRequest" examples: ex1: value: Filters: DirectLinkIds: - dxcon-12345678 - schema: - "$ref": "#/components/schemas/ReadDirectLinksRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadDirectLinksResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 DirectLinks: - AccountId: '123456789012' Bandwidth: 1Gbps @@ -19241,21 +19510,19 @@ paths: Location: PAR1 RegionName: eu-west-2 State: available - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadDirectLinksResponse" description: The HTTP 200 response (OK). tags: - DirectLink "/ReadEntitiesLinkedToPolicy": - description: Lists all entities (account, users, or user groups) linked to a specific - managed policy. post: + description: Lists all entities (account, users, or user groups) linked to a + specific managed policy. operationId: ReadEntitiesLinkedToPolicy requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadEntitiesLinkedToPolicyRequest" examples: ex1: summary: Reading all entities linked to a specific policy @@ -19268,17 +19535,23 @@ paths: EntitiesType: - USER PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy - schema: - "$ref": "#/components/schemas/ReadEntitiesLinkedToPolicyRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadEntitiesLinkedToPolicyResponse" examples: ex1: summary: Reading all entities linked to a specific policy value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 PolicyEntities: + Users: + - Id: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 + Name: example-user + Orn: orn:ows:idauth::012345678910:user/example/user-example Groups: - Id: ug-12345678 Name: example-usergroup @@ -19287,68 +19560,62 @@ paths: ItemsCount: 3 MaxResultsLimit: 100 MaxResultsTruncated: false - Users: - - Id: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 - Name: example-user - Orn: orn:ows:idauth::012345678910:user/example/user-example - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Reading only users linked to a specific policy value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 PolicyEntities: Users: - Id: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 Name: example-user Orn: orn:ows:idauth::012345678910:user/example/user-example - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadEntitiesLinkedToPolicyResponse" description: The HTTP 200 response (OK). tags: - Policy "/ReadFlexibleGpuCatalog": - description: Lists all flexible GPUs available in the public catalog. post: + description: Lists all flexible GPUs available in the public catalog. operationId: ReadFlexibleGpuCatalog requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadFlexibleGpuCatalogRequest" examples: ex1: value: {} - schema: - "$ref": "#/components/schemas/ReadFlexibleGpuCatalogRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadFlexibleGpuCatalogResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 FlexibleGpuCatalog: - - Generations: + - VRam: 16000 + Generations: - v5 MaxCpu: 80 MaxRam: 512 ModelName: nvidia-p100 - VRam: 16000 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadFlexibleGpuCatalogResponse" description: The HTTP 200 response (OK). security: [] tags: - FlexibleGpu "/ReadFlexibleGpus": - description: Lists one or more flexible GPUs (fGPUs) allocated to your account. post: + description: Lists one or more flexible GPUs (fGPUs) allocated to your account. operationId: ReadFlexibleGpus requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadFlexibleGpusRequest" examples: ex1: value: @@ -19363,15 +19630,17 @@ paths: - nvidia-p100 States: - attached - schema: - "$ref": "#/components/schemas/ReadFlexibleGpusRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadFlexibleGpusResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 FlexibleGpus: - DeleteOnVmDeletion: true FlexibleGpuId: fgpu-12345678 @@ -19380,60 +19649,58 @@ paths: State: attached SubregionName: eu-west-2a VmId: i-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadFlexibleGpusResponse" description: The HTTP 200 response (OK). tags: - FlexibleGpu "/ReadImageExportTasks": - description: Lists one or more image export tasks. post: + description: Lists one or more image export tasks. operationId: ReadImageExportTasks requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadImageExportTasksRequest" examples: ex1: value: Filters: TaskIds: - image-export-12345678 - schema: - "$ref": "#/components/schemas/ReadImageExportTasksRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadImageExportTasksResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ImageExportTasks: - - Comment: Export of image ami-12345678 + - Tags: [] ImageId: ami-12345678 + TaskId: image-export-12345678 + Comment: Export of image ami-12345678 OsuExport: - DiskImageFormat: qcow2 - OsuBucket: BUCKET OsuPrefix: PREFIX/ami-12345678/ - Progress: 0 + OsuBucket: BUCKET + DiskImageFormat: qcow2 State: pending/queued - Tags: [] - TaskId: image-export-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadImageExportTasksResponse" + Progress: 0 description: The HTTP 200 response (OK). tags: - Image "/ReadImages": - description: Lists one or more OUTSCALE machine images (OMIs) you can use. post: + description: Lists one or more OUTSCALE machine images (OMIs) you can use. operationId: ReadImages requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadImagesRequest" examples: ex1: summary: Reading a specific image @@ -19450,110 +19717,108 @@ paths: ImageNames: - Ubuntu* - RockyLinux* - schema: - "$ref": "#/components/schemas/ReadImagesRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadImagesResponse" examples: ex1: summary: Reading a specific image value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Images: - - AccountId: '123456789012' - Architecture: x86_64 - BlockDeviceMappings: - - Bsu: - DeleteOnVmDeletion: true - SnapshotId: snap-12345678 - VolumeSize: 50 - VolumeType: standard - DeviceName: "/dev/sda1" - BootModes: - - legacy - CreationDate: '2010-10-01T12:34:56.789Z' - Description: '' - FileLocation: 123456789012/create-image-example - ImageId: ami-12345678 - ImageName: create-image-example - ImageType: machine - PermissionsToLaunch: - AccountIds: [] - GlobalPermission: false + - StateComment: {} + State: available + RootDeviceType: bsu + RootDeviceName: "/dev/sda1" ProductCodes: - '0001' - RootDeviceName: "/dev/sda1" - RootDeviceType: bsu - SecureBoot: false - State: available - StateComment: {} + PermissionsToLaunch: + GlobalPermission: false + AccountIds: [] + AccountId: '123456789012' Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Description: '' + ImageId: ami-12345678 + BlockDeviceMappings: + - DeviceName: "/dev/sda1" + Bsu: + VolumeType: standard + DeleteOnVmDeletion: true + VolumeSize: 50 + SnapshotId: snap-12345678 + BootModes: + - legacy + ImageType: machine + CreationDate: '2010-10-01T12:34:56.789Z' + SecureBoot: false + FileLocation: 123456789012/create-image-example + Architecture: x86_64 + ImageName: create-image-example ex2: summary: Reading Ubuntu and RockyLinux images created by Outscale value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Images: - - AccountAlias: Outscale + - StateComment: {} + State: available + RootDeviceType: bsu + RootDeviceName: "/dev/sda1" + ProductCodes: + - '0001' + PermissionsToLaunch: + GlobalPermission: true + AccountIds: [] AccountId: '123456789012' - Architecture: x86_64 + Tags: [] + Description: '' + ImageId: ami-12345678 BlockDeviceMappings: - - Bsu: + - DeviceName: "/dev/sda1" + Bsu: + VolumeType: standard DeleteOnVmDeletion: true - SnapshotId: snap-12345678 VolumeSize: 10 - VolumeType: standard - DeviceName: "/dev/sda1" + SnapshotId: snap-12345678 + ImageType: machine + AccountAlias: Outscale CreationDate: '2010-10-01T12:34:56.789Z' - Description: '' FileLocation: Outscale/Ubuntu-2010.10.01-0 - ImageId: ami-12345678 + Architecture: x86_64 ImageName: Ubuntu-2010.10.01-0 - ImageType: machine - PermissionsToLaunch: - AccountIds: [] - GlobalPermission: true + - StateComment: {} + State: available + RootDeviceType: bsu + RootDeviceName: "/dev/sda1" ProductCodes: - '0001' - RootDeviceName: "/dev/sda1" - RootDeviceType: bsu - State: available - StateComment: {} - Tags: [] - - AccountAlias: Outscale + PermissionsToLaunch: + GlobalPermission: true + AccountIds: [] AccountId: '123456789012' - Architecture: x86_64 + Tags: [] + Description: '' + ImageId: ami-12345678 BlockDeviceMappings: - - Bsu: + - DeviceName: "/dev/sda1" + Bsu: + VolumeType: standard DeleteOnVmDeletion: true - SnapshotId: snap-12345678 VolumeSize: 10 - VolumeType: standard - DeviceName: "/dev/sda1" + SnapshotId: snap-12345678 + ImageType: machine + AccountAlias: Outscale + CreationDate: '2010-10-01T12:34:56.789Z' BootModes: - legacy - CreationDate: '2010-10-01T12:34:56.789Z' - Description: '' + SecureBoot: false FileLocation: Outscale/RockyLinux-2010.10.01-0 - ImageId: ami-12345678 + Architecture: x86_64 ImageName: RockyLinux-2010.10.01-0 - ImageType: machine - PermissionsToLaunch: - AccountIds: [] - GlobalPermission: true - ProductCodes: - - '0001' - RootDeviceName: "/dev/sda1" - RootDeviceType: bsu - SecureBoot: false - State: available - StateComment: {} - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadImagesResponse" description: The HTTP 200 response (OK). '400': content: @@ -19576,14 +19841,16 @@ paths: tags: - Image "/ReadInternetServices": - description: |- - Lists one or more of your internet services.
- An internet service enables virtual machines (VMs) launched in a Net to connect to the Internet. It allows routing of incoming and outgoing Internet traffic and management of public IP addresses. post: + description: |- + Lists one or more of your internet services.
+ An internet service enables virtual machines (VMs) launched in a Net to connect to the Internet. It allows routing of incoming and outgoing Internet traffic and management of public IP addresses. operationId: ReadInternetServices requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadInternetServicesRequest" examples: ex1: value: @@ -19598,26 +19865,24 @@ paths: TagValues: - prod - test - schema: - "$ref": "#/components/schemas/ReadInternetServicesRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadInternetServicesResponse" examples: ex1: value: - InternetServices: - - InternetServiceId: igw-12345678 - NetId: vpc-12345678 - State: available - Tags: - - Key: env - Value: prod ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadInternetServicesResponse" + InternetServices: + - Tags: + - Value: prod + Key: env + State: available + NetId: vpc-12345678 + InternetServiceId: igw-12345678 description: The HTTP 200 response (OK). '400': content: @@ -19640,36 +19905,36 @@ paths: tags: - InternetService "/ReadKeypairs": - description: Lists one or more of your keypairs. post: + description: Lists one or more of your keypairs. operationId: ReadKeypairs requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadKeypairsRequest" examples: ex1: value: Filters: KeypairNames: - keypair-example - schema: - "$ref": "#/components/schemas/ReadKeypairsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadKeypairsResponse" examples: ex1: value: - Keypairs: - - KeypairFingerprint: 11:22:33:44:55:66:77:88:99:00:aa:bb:cc:dd:ee:ff - KeypairId: key-abcdef1234567890abcdef1234567890 - KeypairName: keypair-example - KeypairType: ssh-rsa ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadKeypairsResponse" + Keypairs: + - KeypairType: ssh-rsa + KeypairName: keypair-example + KeypairId: key-abcdef1234567890abcdef1234567890 + KeypairFingerprint: 11:22:33:44:55:66:77:88:99:00:aa:bb:cc:dd:ee:ff description: The HTTP 200 response (OK). '400': content: @@ -19692,12 +19957,14 @@ paths: tags: - Keypair "/ReadLinkedPolicies": - description: Lists the managed policies linked to a specified user. post: + description: Lists the managed policies linked to a specified user. operationId: ReadLinkedPolicies requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadLinkedPoliciesRequest" examples: ex1: value: @@ -19706,208 +19973,208 @@ paths: FirstItem: 1 ResultsPerPage: 30 UserName: example-user - schema: - "$ref": "#/components/schemas/ReadLinkedPoliciesRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadLinkedPoliciesResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 HasMoreItems: true - MaxResultsLimit: 30 - MaxResultsTruncated: false Policies: - - CreationDate: 2010-10-01 12:34:56.789000000 +00:00 + - PolicyName: example-user-policy + CreationDate: 2010-10-01 12:34:56.789000000 +00:00 LastModificationDate: 2010-10-01 12:34:56.789000000 +00:00 Orn: orn:ows:idauth::012345678910:policy/example/example-user-policy PolicyId: ABCDEFGHIJKLMNOPQRSTUVWXYZ01234 - PolicyName: example-user-policy - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadLinkedPoliciesResponse" + MaxResultsLimit: 30 + MaxResultsTruncated: false description: The HTTP 200 response (OK). tags: - Policy "/ReadListenerRules": - description: Lists one or more listener rules. By default, this action returns - the full list of listener rules for the account. post: + description: Lists one or more listener rules. By default, this action returns + the full list of listener rules for the account. operationId: ReadListenerRules requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadListenerRulesRequest" examples: ex1: value: Filters: ListenerRuleNames: - example-listener-rule - schema: - "$ref": "#/components/schemas/ReadListenerRulesRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadListenerRulesResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ListenerRules: - - Action: forward - HostNamePattern: "*.example.com" - ListenerId: 123456 - ListenerRuleId: 1234 - ListenerRuleName: example-listener-rule - Priority: 10 + - Priority: 10 VmIds: - i-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadListenerRulesResponse" + ListenerRuleName: example-listener-rule + Action: forward + ListenerId: 123456 + HostNamePattern: "*.example.com" + ListenerRuleId: 1234 description: The HTTP 200 response (OK). tags: - Listener "/ReadLoadBalancerTags": - description: Lists the tags associated with one or more specified load balancers. post: + description: Lists the tags associated with one or more specified load balancers. operationId: ReadLoadBalancerTags requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadLoadBalancerTagsRequest" examples: ex1: value: LoadBalancerNames: - private-lb-example - schema: - "$ref": "#/components/schemas/ReadLoadBalancerTagsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadLoadBalancerTagsResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Tags: - - Key: key1 + - Value: value1 LoadBalancerName: private-lb-example - Value: value1 - schema: - "$ref": "#/components/schemas/ReadLoadBalancerTagsResponse" + Key: key1 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - LoadBalancer "/ReadLoadBalancers": - description: Lists one or more load balancers and their attributes. post: + description: Lists one or more load balancers and their attributes. operationId: ReadLoadBalancers requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadLoadBalancersRequest" examples: ex1: value: Filters: LoadBalancerNames: - private* - schema: - "$ref": "#/components/schemas/ReadLoadBalancersRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadLoadBalancersResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 LoadBalancers: - - AccessLog: - IsEnabled: false - PublicationInterval: 60 - ApplicationStickyCookiePolicies: [] + - Tags: [] + SourceSecurityGroup: + SecurityGroupName: security-group-example + SecurityGroupAccountId: '123456789012' + SecuredCookies: false + PublicIp: 192.0.2.0 + Subnets: + - subnet-12345678 + NetId: vpc-12345678 BackendVmIds: [] + ApplicationStickyCookiePolicies: [] + SecurityGroups: + - sg-12345678 + LoadBalancerType: internet-facing + AccessLog: + PublicationInterval: 60 + IsEnabled: false DnsName: private-lb-example.123456789.eu-west-2.lbu.outscale.com HealthCheck: + UnhealthyThreshold: 2 + Timeout: 5 CheckInterval: 30 + Protocol: TCP HealthyThreshold: 10 Port: 80 - Protocol: TCP - Timeout: 5 - UnhealthyThreshold: 2 + LoadBalancerStickyCookiePolicies: [] + SubregionNames: + - eu-west-2a Listeners: - - BackendPort: 80 + - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate + BackendPort: 80 BackendProtocol: HTTP LoadBalancerPort: 443 LoadBalancerProtocol: HTTPS - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate LoadBalancerName: private-lb-example - LoadBalancerStickyCookiePolicies: [] - LoadBalancerType: internet-facing - NetId: vpc-12345678 - PublicIp: 192.0.2.0 - SecuredCookies: false - SecurityGroups: - - sg-12345678 - SourceSecurityGroup: - SecurityGroupAccountId: '123456789012' - SecurityGroupName: security-group-example - Subnets: - - subnet-12345678 - SubregionNames: - - eu-west-2a - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadLoadBalancersResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer "/ReadLocations": - description: |- - Lists the locations, corresponding to datacenters, where you can set up a DirectLink.

- For more information, see [About DirectLink](https://docs.outscale.com/en/userguide/About-DirectLink.html). post: + description: |- + Lists the locations, corresponding to datacenters, where you can set up a DirectLink.

+ For more information, see [About DirectLink](https://docs.outscale.com/en/userguide/About-DirectLink.html). operationId: ReadLocations requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadLocationsRequest" examples: ex1: value: {} - schema: - "$ref": "#/components/schemas/ReadLocationsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadLocationsResponse" examples: ex1: value: - Locations: - - Code: PAR1 - Name: Telehouse 3, France - - Code: PAR4 - Name: Equinix Pantin, France ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadLocationsResponse" + Locations: + - Name: Telehouse 3, France + Code: PAR1 + - Name: Equinix Pantin, France + Code: PAR4 description: The HTTP 200 response (OK). security: [] tags: - Location "/ReadManagedPoliciesLinkedToUserGroup": - description: Lists the managed policies linked to a specified group. post: + description: Lists the managed policies linked to a specified group. operationId: ReadManagedPoliciesLinkedToUserGroup requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadManagedPoliciesLinkedToUserGroupRequest" examples: ex1: value: @@ -19918,15 +20185,17 @@ paths: FirstItem: 1 ResultsPerPage: 30 UserGroupName: example-usergroup - schema: - "$ref": "#/components/schemas/ReadManagedPoliciesLinkedToUserGroupRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadManagedPoliciesLinkedToUserGroupResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 HasMoreItems: true MaxResultsLimit: 30 MaxResultsTruncated: true @@ -19936,20 +20205,18 @@ paths: Orn: orn:ows:idauth::012345678910:policy/example/example-user-policy PolicyId: ABCDEFGHIJKLMNOPQRSTUVWXYZ01234 PolicyName: example-policy - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadManagedPoliciesLinkedToUserGroupResponse" description: The HTTP 200 response (OK). tags: - Policy "/ReadNatServices": - description: Lists one or more network address translation (NAT) services. post: + description: Lists one or more network address translation (NAT) services. operationId: ReadNatServices requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadNatServicesRequest" examples: ex1: value: @@ -19964,28 +20231,26 @@ paths: - vpc-87654321 SubnetIds: - subnet-12345678 - schema: - "$ref": "#/components/schemas/ReadNatServicesRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadNatServicesResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 NatServices: - - NatServiceId: nat-12345678 - NetId: vpc-12345678 + - Tags: [] + SubnetId: subnet-12345678 + NatServiceId: nat-12345678 PublicIps: - - PublicIp: 192.0.2.0 - PublicIpId: eipalloc-12345678 + - PublicIpId: eipalloc-12345678 + PublicIp: 192.0.2.0 + NetId: vpc-12345678 State: available - SubnetId: subnet-12345678 - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadNatServicesResponse" description: The HTTP 200 response (OK). '400': content: @@ -20008,14 +20273,16 @@ paths: tags: - NatService "/ReadNetAccessPointServices": - description: |- - Lists OUTSCALE services available to create Net access points.
- For more information, see [CreateNetAccessPoint](#createnetaccesspoint). post: + description: |- + Lists OUTSCALE services available to create Net access points.
+ For more information, see [CreateNetAccessPoint](#createnetaccesspoint). operationId: ReadNetAccessPointServices requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadNetAccessPointServicesRequest" examples: ex1: summary: Listing one or more services according to their service IDs @@ -20030,54 +20297,54 @@ paths: Filters: ServiceNames: - com.outscale.eu-west-2.api - schema: - "$ref": "#/components/schemas/ReadNetAccessPointServicesRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadNetAccessPointServicesResponse" examples: ex1: summary: Listing one or more services according to their service IDs value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Services: - - IpRanges: - - 192.0.2.0 + - ServiceName: com.outscale.eu-west-2.api ServiceId: pl-12345678 - ServiceName: com.outscale.eu-west-2.api - - IpRanges: + IpRanges: + - 192.0.2.0 + - ServiceName: com.outscale.eu-west-2.oos + ServiceId: pl-87654321 + IpRanges: - 198.51.100.0 - 203.0.113.0 - 203.0.113.1 - ServiceId: pl-87654321 - ServiceName: com.outscale.eu-west-2.oos + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Listing one or more services according to their service names value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Services: - - IpRanges: - - 192.0.2.0 + - ServiceName: com.outscale.eu-west-2.api ServiceId: pl-12345678 - ServiceName: com.outscale.eu-west-2.api - schema: - "$ref": "#/components/schemas/ReadNetAccessPointServicesResponse" + IpRanges: + - 192.0.2.0 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). security: [] tags: - NetAccessPoint "/ReadNetAccessPoints": - description: Lists one or more Net access points. post: + description: Lists one or more Net access points. operationId: ReadNetAccessPoints requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadNetAccessPointsRequest" examples: ex1: value: @@ -20091,37 +20358,37 @@ paths: - vpc-12345678 States: - available - schema: - "$ref": "#/components/schemas/ReadNetAccessPointsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadNetAccessPointsResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 NetAccessPoints: - - NetAccessPointId: vpce-12345678 - NetId: vpc-12345678 + - Tags: [] + NetAccessPointId: vpce-12345678 RouteTableIds: - rtb-12345678 - ServiceName: com.outscale.eu-west-2.oos State: available - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadNetAccessPointsResponse" + NetId: vpc-12345678 + ServiceName: com.outscale.eu-west-2.oos description: The HTTP 200 response (OK). tags: - NetAccessPoint "/ReadNetPeerings": - description: Lists one or more peering connections between two Nets. post: + description: Lists one or more peering connections between two Nets. operationId: ReadNetPeerings requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadNetPeeringsRequest" examples: ex1: value: @@ -20136,33 +20403,31 @@ paths: StateNames: - active - pending-acceptance - schema: - "$ref": "#/components/schemas/ReadNetPeeringsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadNetPeeringsResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 NetPeerings: - - AccepterNet: - AccountId: '123456789012' - IpRange: 172.16.0.0/16 + - Tags: [] + State: + Name: active + Message: Active + AccepterNet: NetId: vpc-12345678 - NetPeeringId: pcx-12345678 - SourceNet: + IpRange: 172.16.0.0/16 AccountId: '123456789012' - IpRange: 10.0.0.0/16 + SourceNet: NetId: vpc-12345678 - State: - Message: Active - Name: active - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadNetPeeringsResponse" + IpRange: 10.0.0.0/16 + AccountId: '123456789012' + NetPeeringId: pcx-12345678 description: The HTTP 200 response (OK). '400': content: @@ -20185,12 +20450,14 @@ paths: tags: - NetPeering "/ReadNets": - description: Lists one or more Nets. post: + description: Lists one or more Nets. operationId: ReadNets requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadNetsRequest" examples: ex1: value: @@ -20202,26 +20469,24 @@ paths: Filters: States: - available - schema: - "$ref": "#/components/schemas/ReadNetsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadNetsResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Nets: - - DhcpOptionsSetId: dopt-12345678 + - Tags: [] + DhcpOptionsSetId: dopt-12345678 IpRange: 10.0.0.0/16 + Tenancy: default NetId: vpc-12345678 State: available - Tags: [] - Tenancy: default - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadNetsResponse" description: The HTTP 200 response (OK). '400': content: @@ -20244,14 +20509,16 @@ paths: tags: - Net "/ReadNics": - description: |- - Lists one or more network interface cards (NICs).
- A NIC is a virtual network interface that you can attach to a virtual machine (VM) in a Net. post: + description: |- + Lists one or more network interface cards (NICs).
+ A NIC is a virtual network interface that you can attach to a virtual machine (VM) in a Net. operationId: ReadNics requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadNicsRequest" examples: ex1: value: @@ -20263,45 +20530,43 @@ paths: Filters: LinkNicVmIds: - i-12345678 - schema: - "$ref": "#/components/schemas/ReadNicsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadNicsResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Nics: - - AccountId: '123456789012' - Description: Primary network interface - IsSourceDestChecked: true + - SubregionName: eu-west-2a + SubnetId: subnet-12345678 + State: in-use LinkNic: + VmId: i-12345678 + LinkNicId: eni-attach-12345678 + VmAccountId: '123456789012' DeleteOnVmDeletion: false DeviceNumber: 0 - LinkNicId: eni-attach-12345678 State: attached - VmAccountId: '123456789012' - VmId: i-12345678 + IsSourceDestChecked: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + Tags: [] + Description: Primary network interface + AccountId: '123456789012' + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - IsPrimary: true - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - SecurityGroups: - - SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - State: in-use - SubnetId: subnet-12345678 - SubregionName: eu-west-2a - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadNicsResponse" + IsPrimary: true description: The HTTP 200 response (OK). '400': content: @@ -20324,12 +20589,14 @@ paths: tags: - Nic "/ReadPolicies": - description: Lists all the managed policies available for your account. post: + description: Lists all the managed policies available for your account. operationId: ReadPolicies requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadPoliciesRequest" examples: ex1: value: @@ -20339,259 +20606,259 @@ paths: Scope: OWS FirstItem: 1 ResultsPerPage: 30 - schema: - "$ref": "#/components/schemas/ReadPoliciesRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadPoliciesResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 HasMoreItems: true - MaxResultsLimit: 30 - MaxResultsTruncated: false Policies: - - CreationDate: 2010-10-01 12:34:56.789000000 +00:00 + - ResourcesCount: 1 + PolicyName: example-user-policy + PolicyDefaultVersionId: v1 + Path: "/example/" + CreationDate: 2010-10-01 12:34:56.789000000 +00:00 Description: Example of description + PolicyId: ABCDEFGHIJKLMNOPQRSTUVWXYZ01234 + Orn: orn:ows:idauth::012345678910:policy/example/example-user-policy IsLinkable: true LastModificationDate: 2010-10-01 12:34:56.789000000 +00:00 - Orn: orn:ows:idauth::012345678910:policy/example/example-user-policy - Path: "/example/" - PolicyDefaultVersionId: v1 - PolicyId: ABCDEFGHIJKLMNOPQRSTUVWXYZ01234 - PolicyName: example-user-policy - ResourcesCount: 1 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadPoliciesResponse" + MaxResultsLimit: 30 + MaxResultsTruncated: false description: The HTTP 200 response (OK). tags: - Policy "/ReadPolicy": - description: Lists information about a specified managed policy. post: + description: Lists information about a specified managed policy. operationId: ReadPolicy requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadPolicyRequest" examples: ex1: value: PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy - schema: - "$ref": "#/components/schemas/ReadPolicyRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadPolicyResponse" examples: ex1: value: Policy: + ResourcesCount: 0 + PolicyName: example-user-policy + PolicyDefaultVersionId: v1 + Path: "/example/" CreationDate: 2010-10-01 12:34:56.789000000 +00:00 Description: Example of description + PolicyId: ABCDEFGHIJKLMNOPQRSTUVWXYZ01234 + Orn: orn:ows:idauth::012345678910:policy/example/example-user-policy IsLinkable: true LastModificationDate: 2010-10-01 12:34:56.789000000 +00:00 - Orn: orn:ows:idauth::012345678910:policy/example/example-user-policy - Path: "/example/" - PolicyDefaultVersionId: v1 - PolicyId: ABCDEFGHIJKLMNOPQRSTUVWXYZ01234 - PolicyName: example-user-policy - ResourcesCount: 0 ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadPolicyResponse" description: The HTTP 200 response (OK). tags: - Policy "/ReadPolicyVersion": - description: Lists information about a specified version of a managed policy. post: + description: Lists information about a specified version of a managed policy. operationId: ReadPolicyVersion requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadPolicyVersionRequest" examples: ex1: value: PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy VersionId: v1 - schema: - "$ref": "#/components/schemas/ReadPolicyVersionRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadPolicyVersionResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 PolicyVersion: + VersionId: v1 + DefaultVersion: true + CreationDate: 2010-10-01 12:34:56.789000000 +00:00 Body: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], "Resource": ["*"]} ]}' - CreationDate: 2010-10-01 12:34:56.789000000 +00:00 - DefaultVersion: true - VersionId: v1 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadPolicyVersionResponse" description: The HTTP 200 response (OK). tags: - Policy "/ReadPolicyVersions": - description: Lists information about all the policy versions of a specified managed - policy. post: + description: Lists information about all the policy versions of a specified + managed policy. operationId: ReadPolicyVersions requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadPolicyVersionsRequest" examples: ex1: value: FirstItem: 1 PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy ResultsPerPage: 30 - schema: - "$ref": "#/components/schemas/ReadPolicyVersionsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadPolicyVersionsResponse" examples: ex1: value: - HasMoreItems: true MaxResultsLimit: 30 - PolicyVersions: - - Body: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], - "Resource": ["*"]} ]}' - CreationDate: 2010-10-01 12:34:56.789000000 +00:00 - DefaultVersion: true - VersionId: v1 ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadPolicyVersionsResponse" + PolicyVersions: + - VersionId: v1 + DefaultVersion: true + CreationDate: 2010-10-01 12:34:56.789000000 +00:00 + Body: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], + "Resource": ["*"]} ]}' + HasMoreItems: true description: The HTTP 200 response (OK). tags: - Policy "/ReadProductTypes": - description: Lists one or more product types. post: + description: Lists one or more product types. operationId: ReadProductTypes requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadProductTypesRequest" examples: ex1: value: Filters: ProductTypeIds: - '0001' - schema: - "$ref": "#/components/schemas/ReadProductTypesRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadProductTypesResponse" examples: ex1: value: - ProductTypes: - - Description: Linux - ProductTypeId: '0001' ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadProductTypesResponse" + ProductTypes: + - ProductTypeId: '0001' + Description: Linux description: The HTTP 200 response (OK). security: [] tags: - ProductType "/ReadPublicCatalog": - description: Returns the price list of OUTSCALE products and services for the - Region specified in the endpoint of the request. For more information, see [About - Regions and Subregions](https://docs.outscale.com/en/userguide/About-Regions-and-Subregions.html). post: + description: Returns the price list of OUTSCALE products and services for the + Region specified in the endpoint of the request. For more information, see + [About Regions and Subregions](https://docs.outscale.com/en/userguide/About-Regions-and-Subregions.html). operationId: ReadPublicCatalog requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadPublicCatalogRequest" examples: ex1: value: {} - schema: - "$ref": "#/components/schemas/ReadPublicCatalogRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadPublicCatalogResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Catalog: Entries: - - Category: compute - Operation: RunInstances-OD - Service: TinaOS-FCU - SubregionName: eu-west-2 + - UnitPrice: 0.04 + Type: CustomCore:v5-p1 Title: Instance - On demand - Unite de vCore pour une instance Tina v5 CxRy Performance highest - par heure - Type: CustomCore:v5-p1 - UnitPrice: 0.04 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadPublicCatalogResponse" + SubregionName: eu-west-2 + Category: compute + Service: TinaOS-FCU + Operation: RunInstances-OD description: The HTTP 200 response (OK). security: [] tags: - PublicCatalog "/ReadPublicIpRanges": - description: Gets the public IPv4 addresses in CIDR notation for the Region specified - in the endpoint of the request. For more information, see [About Regions and - Subregions](https://docs.outscale.com/en/userguide/About-Regions-and-Subregions.html). post: + description: Gets the public IPv4 addresses in CIDR notation for the Region + specified in the endpoint of the request. For more information, see [About + Regions and Subregions](https://docs.outscale.com/en/userguide/About-Regions-and-Subregions.html). operationId: ReadPublicIpRanges requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadPublicIpRangesRequest" examples: ex1: value: {} - schema: - "$ref": "#/components/schemas/ReadPublicIpRangesRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadPublicIpRangesResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 PublicIps: - 198.51.100.0/24 - 203.0.113.0/24 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadPublicIpRangesResponse" description: The HTTP 200 response (OK). security: [] tags: - PublicIp "/ReadPublicIps": - description: |- - Lists one or more public IPs allocated to your account.
- By default, this action returns information about all your public IPs: available or associated with a virtual machine (VM), a network interface card (NIC) or a NAT service. post: + description: |- + Lists one or more public IPs allocated to your account.
+ By default, this action returns information about all your public IPs: available or associated with a virtual machine (VM), a network interface card (NIC) or a NAT service. operationId: ReadPublicIps requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadPublicIpsRequest" examples: ex1: value: @@ -20603,28 +20870,26 @@ paths: Filters: VmIds: - i-12345678 - schema: - "$ref": "#/components/schemas/ReadPublicIpsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadPublicIpsResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 PublicIps: - - LinkPublicIpId: eipassoc-12345678 + - VmId: i-12345678 + Tags: [] + PublicIpId: eipalloc-12345678 + PublicIp: 192.0.2.0 + LinkPublicIpId: eipassoc-12345678 NicAccountId: '123456789012' NicId: eni-12345678 PrivateIp: 10.0.0.4 - PublicIp: 192.0.2.0 - PublicIpId: eipalloc-12345678 - Tags: [] - VmId: i-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadPublicIpsResponse" description: The HTTP 200 response (OK). '400': content: @@ -20647,14 +20912,16 @@ paths: tags: - PublicIp "/ReadQuotas": - description: |- - Lists one or more of your quotas.

- For more information, see [About Your Account](https://docs.outscale.com/en/userguide/About-Your-Account.html). post: + description: |- + Lists one or more of your quotas.

+ For more information, see [About Your Account](https://docs.outscale.com/en/userguide/About-Your-Account.html). operationId: ReadQuotas requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadQuotasRequest" examples: ex1: summary: Reading specific quota @@ -20668,102 +20935,102 @@ paths: Filters: Collections: - VPC - schema: - "$ref": "#/components/schemas/ReadQuotasRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadQuotasResponse" examples: ex1: summary: Reading specific quota value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 QuotaTypes: - - QuotaType: global - Quotas: - - AccountId: '123456789012' + - Quotas: + - ShortDescription: Load Balancer Limit + QuotaCollection: LBU + AccountId: '123456789012' Description: Maximum number of load balancers per region MaxValue: 20 - Name: lb_limit - QuotaCollection: LBU - ShortDescription: Load Balancer Limit UsedValue: 0 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Name: lb_limit + QuotaType: global ex2: summary: Reading collection of quotas value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 QuotaTypes: - - QuotaType: global - Quotas: - - AccountId: '123456789012' + - Quotas: + - ShortDescription: Example Limit + QuotaCollection: VPC + AccountId: '123456789012' Description: Maximum number of examples MaxValue: 5 + UsedValue: 0 Name: example_limit + QuotaType: global + - Quotas: + - ShortDescription: Other Example Limit QuotaCollection: VPC - ShortDescription: Example Limit - UsedValue: 0 - - QuotaType: vpc-12345678 - Quotas: - - AccountId: '123456789012' + AccountId: '123456789012' Description: Maximum number of other examples MaxValue: 50 - Name: other_example_limit - QuotaCollection: VPC - ShortDescription: Other Example Limit UsedValue: 1 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadQuotasResponse" + Name: other_example_limit + QuotaType: vpc-12345678 description: The HTTP 200 response (OK). tags: - Quota "/ReadRegions": - description: |- - Lists one or more Regions of the OUTSCALE Cloud.

- For more information, see [About Regions and Subregions](https://docs.outscale.com/en/userguide/About-Regions-and-Subregions.html). post: + description: |- + Lists one or more Regions of the OUTSCALE Cloud.

+ For more information, see [About Regions and Subregions](https://docs.outscale.com/en/userguide/About-Regions-and-Subregions.html). operationId: ReadRegions requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadRegionsRequest" examples: ex1: value: {} - schema: - "$ref": "#/components/schemas/ReadRegionsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadRegionsResponse" examples: ex1: value: - Regions: - - Endpoint: api.eu-west-2.outscale.com - RegionName: eu-west-2 - - Endpoint: api.us-east-2.outscale.com - RegionName: us-east-2 - - Endpoint: api.us-west-1.outscale.com - RegionName: us-west-1 ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadRegionsResponse" + Regions: + - RegionName: eu-west-2 + Endpoint: api.eu-west-2.outscale.com + - RegionName: us-east-2 + Endpoint: api.us-east-2.outscale.com + - RegionName: us-west-1 + Endpoint: api.us-west-1.outscale.com description: The HTTP 200 response (OK). security: [] tags: - Region "/ReadRouteTables": - description: |- - Lists one or more of your route tables.
- In your Net, each Subnet must be associated with a route table. If a Subnet is not explicitly associated with a route table, it is implicitly associated with the main route table of the Net. post: + description: |- + Lists one or more of your route tables.
+ In your Net, each Subnet must be associated with a route table. If a Subnet is not explicitly associated with a route table, it is implicitly associated with the main route table of the Net. operationId: ReadRouteTables requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadRouteTablesRequest" examples: ex1: value: @@ -20773,37 +21040,35 @@ paths: ex2: value: Filters: - LinkRouteTableMain: true NetIds: - vpc-12345678 - vpc-87654321 - schema: - "$ref": "#/components/schemas/ReadRouteTablesRequest" + LinkRouteTableMain: true responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadRouteTablesResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 RouteTables: - - LinkRouteTables: - - LinkRouteTableId: rtbassoc-12345678 - Main: true - NetId: vpc-12345678 + - Routes: + - DestinationIpRange: 10.0.0.0/16 + CreationMethod: CreateRouteTable + State: active + LinkRouteTables: + - Main: true + LinkRouteTableId: rtbassoc-12345678 RouteTableId: rtb-12345678 + NetId: vpc-12345678 NetId: vpc-12345678 + Tags: [] RoutePropagatingVirtualGateways: [] RouteTableId: rtb-12345678 - Routes: - - CreationMethod: CreateRouteTable - DestinationIpRange: 10.0.0.0/16 - State: active - Tags: [] - schema: - "$ref": "#/components/schemas/ReadRouteTablesResponse" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -20826,14 +21091,16 @@ paths: tags: - RouteTable "/ReadSecurityGroups": - description: |- - Lists one or more security groups.
- You can specify either the name of the security groups or their IDs. post: + description: |- + Lists one or more security groups.
+ You can specify either the name of the security groups or their IDs. operationId: ReadSecurityGroups requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadSecurityGroupsRequest" examples: ex1: value: @@ -20845,39 +21112,37 @@ paths: Filters: InboundRuleIpRanges: - 192.0.2.0 - schema: - "$ref": "#/components/schemas/ReadSecurityGroupsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadSecurityGroupsResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 SecurityGroups: - - AccountId: '123456789012' + - Tags: [] + SecurityGroupName: security-group-example + OutboundRules: + - FromPortRange: -1 + IpProtocol: "-1" + ToPortRange: -1 + IpRanges: + - 0.0.0.0/0 + SecurityGroupId: sg-12345678 + AccountId: '123456789012' Description: Example of security group InboundRules: - FromPortRange: 22 IpProtocol: tcp + ToPortRange: 22 IpRanges: - 192.0.2.0 - 198.51.100.0 - ToPortRange: 22 NetId: vpc-12345678 - OutboundRules: - - FromPortRange: -1 - IpProtocol: "-1" - IpRanges: - - 0.0.0.0/0 - ToPortRange: -1 - SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - Tags: [] - schema: - "$ref": "#/components/schemas/ReadSecurityGroupsResponse" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -20900,87 +21165,89 @@ paths: tags: - SecurityGroup "/ReadServerCertificates": - description: Lists your server certificates. post: + description: Lists your server certificates. operationId: ReadServerCertificates requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadServerCertificatesRequest" examples: ex1: value: Filters: Paths: - "/example/" - schema: - "$ref": "#/components/schemas/ReadServerCertificatesRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadServerCertificatesResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ServerCertificates: - - Id: ABCDEFGHIJKLMNOPQRSTUVWXYZ1234 - Name: server-cert-example + - Path: "/example/" + Id: ABCDEFGHIJKLMNOPQRSTUVWXYZ1234 Orn: orn:ows:idauth::012345678910:server-certificate/example/server-cert-example - Path: "/example/" - schema: - "$ref": "#/components/schemas/ReadServerCertificatesResponse" + Name: server-cert-example + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - ServerCertificate "/ReadSnapshotExportTasks": - description: Lists one or more snapshot export tasks. post: + description: Lists one or more snapshot export tasks. operationId: ReadSnapshotExportTasks requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadSnapshotExportTasksRequest" examples: ex1: value: Filters: TaskIds: - snap-export-12345678 - schema: - "$ref": "#/components/schemas/ReadSnapshotExportTasksRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadSnapshotExportTasksResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 SnapshotExportTasks: - - Comment: Export of snapshot snap-12345678 + - Tags: [] + TaskId: snap-export-12345678 + Comment: Export of snapshot snap-12345678 OsuExport: - DiskImageFormat: qcow2 - OsuBucket: BUCKET OsuPrefix: PREFIX - Progress: 99 - SnapshotId: snap-12345678 + OsuBucket: BUCKET + DiskImageFormat: qcow2 State: pending - Tags: [] - TaskId: snap-export-12345678 - schema: - "$ref": "#/components/schemas/ReadSnapshotExportTasksResponse" + SnapshotId: snap-12345678 + Progress: 99 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - Snapshot "/ReadSnapshots": - description: Lists one or more snapshots that are available to you and the permissions - to create volumes from them. post: + description: Lists one or more snapshots that are available to you and the permissions + to create volumes from them. operationId: ReadSnapshots requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadSnapshotsRequest" examples: ex1: value: @@ -20995,51 +21262,49 @@ paths: TagValues: - prod - test - schema: - "$ref": "#/components/schemas/ReadSnapshotsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadSnapshotsResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Snapshots: - - AccountId: '123456789012' + - VolumeSize: 10 + AccountId: '123456789012' + VolumeId: vol-12345678 CreationDate: '2010-10-01T12:34:56.789Z' - Description: Snapshot created from a volume PermissionsToCreateVolume: - AccountIds: [] GlobalPermission: false + AccountIds: [] Progress: 100 SnapshotId: snap-12345678 State: completed + Description: Snapshot created from a volume Tags: [] - VolumeId: vol-12345678 - VolumeSize: 10 - ex2: - value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + value: Snapshots: - - AccountId: '123456789012' + - VolumeSize: 10 + AccountId: '123456789012' + VolumeId: vol-12345678 CreationDate: '2010-10-01T12:34:56.789Z' - Description: Test snapshot PermissionsToCreateVolume: - AccountIds: [] GlobalPermission: false + AccountIds: [] Progress: 100 SnapshotId: snap-12345678 State: completed + Description: Test snapshot Tags: - - Key: env - Value: test - VolumeId: vol-12345678 - VolumeSize: 10 - schema: - "$ref": "#/components/schemas/ReadSnapshotsResponse" + - Value: test + Key: env + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -21062,14 +21327,16 @@ paths: tags: - Snapshot "/ReadSubnets": - description: |- - Lists one or more of your Subnets.
- If you do not specify any Subnet ID, this action describes all of your Subnets. post: + description: |- + Lists one or more of your Subnets.
+ If you do not specify any Subnet ID, this action describes all of your Subnets. operationId: ReadSubnets requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadSubnetsRequest" examples: ex1: value: @@ -21084,28 +21351,26 @@ paths: - pending SubregionNames: - eu-west-2a - schema: - "$ref": "#/components/schemas/ReadSubnetsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadSubnetsResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Subnets: - - AvailableIpsCount: 16379 + - Tags: [] + SubregionName: eu-west-2a + SubnetId: subnet-12345678 + AvailableIpsCount: 16379 IpRange: 10.0.0.0/18 MapPublicIpOnLaunch: false - NetId: vpc-12345678 State: available - SubnetId: subnet-12345678 - SubregionName: eu-west-2a - Tags: [] - schema: - "$ref": "#/components/schemas/ReadSubnetsResponse" + NetId: vpc-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -21128,15 +21393,17 @@ paths: tags: - Subnet "/ReadSubregions": - description: |- - Lists one or more of the enabled Subregions that you can access in the current Region.

- - For more information, see [About Regions and Subregions](https://docs.outscale.com/en/userguide/About-Regions-and-Subregions.html). post: + description: |- + Lists one or more of the enabled Subregions that you can access in the current Region.

+ + For more information, see [About Regions and Subregions](https://docs.outscale.com/en/userguide/About-Regions-and-Subregions.html). operationId: ReadSubregions requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadSubregionsRequest" examples: ex1: summary: Listing a specific Subregion in the current Region @@ -21151,75 +21418,73 @@ paths: SubregionNames: - eu-west-2a - eu-west-2b - schema: - "$ref": "#/components/schemas/ReadSubregionsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadSubregionsResponse" examples: ex1: summary: Listing a specific Subregion in the current Region value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Subregions: - - LocationCode: PAR1 + - State: available RegionName: eu-west-2 - State: available SubregionName: eu-west-2a + LocationCode: PAR1 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Listing two specific Subregions in the current Region value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Subregions: - - LocationCode: PAR1 + - State: available RegionName: eu-west-2 - State: available SubregionName: eu-west-2a - - LocationCode: PAR4 + LocationCode: PAR1 + - State: available RegionName: eu-west-2 - State: available SubregionName: eu-west-2b - schema: - "$ref": "#/components/schemas/ReadSubregionsResponse" + LocationCode: PAR4 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - Subregion "/ReadTags": - description: Lists one or more tags for your resources. post: + description: Lists one or more tags for your resources. operationId: ReadTags requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadTagsRequest" examples: ex1: value: Filters: - Keys: - - key1 ResourceTypes: - snapshot - schema: - "$ref": "#/components/schemas/ReadTagsRequest" + Keys: + - key1 responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadTagsResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Tags: - - Key: key1 - ResourceId: snap-12345678 + - Value: value1 ResourceType: snapshot - Value: value1 - schema: - "$ref": "#/components/schemas/ReadTagsResponse" + ResourceId: snap-12345678 + Key: key1 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -21242,59 +21507,61 @@ paths: tags: - Tag "/ReadUnitPrice": - description: Gets unit price information for the specified parameters. post: + description: Gets unit price information for the specified parameters. operationId: ReadUnitPrice requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadUnitPriceRequest" examples: ex1: value: Operation: CreateVolume Service: TinaOS-FCU Type: BSU:VolumeIOPS:io1 - schema: - "$ref": "#/components/schemas/ReadUnitPriceRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadUnitPriceResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 UnitPriceEntry: + UnitPrice: 0.01 + Unit: PER_IOPS_PER_MONTH Currency: EUR Operation: CreateVolume - Service: TinaOS-FCU Type: BSU:VolumeIOPS:io1 - Unit: PER_IOPS_PER_MONTH - UnitPrice: 0.01 - schema: - "$ref": "#/components/schemas/ReadUnitPriceResponse" + Service: TinaOS-FCU description: The HTTP 200 response (OK). tags: - Catalog "/ReadUserGroup": - description: Lists information about a specified user group, including its users. post: + description: Lists information about a specified user group, including its users. operationId: ReadUserGroup requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadUserGroupRequest" examples: ex1: value: Path: "/example/" UserGroupName: example-usergroup - schema: - "$ref": "#/components/schemas/ReadUserGroupRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadUserGroupResponse" examples: ex1: value: @@ -21314,18 +21581,18 @@ paths: UserEmail: user@example.com UserId: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 UserName: example-user - schema: - "$ref": "#/components/schemas/ReadUserGroupResponse" description: The HTTP 200 response (OK). tags: - UserGroup "/ReadUserGroupPolicies": - description: Lists the names of the inline policies embedded in a specific group. post: + description: Lists the names of the inline policies embedded in a specific group. operationId: ReadUserGroupPolicies requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadUserGroupPoliciesRequest" examples: ex1: value: @@ -21333,15 +21600,17 @@ paths: ResultsPerPage: 30 UserGroupName: example-usergroup UserGroupPath: "/example/" - schema: - "$ref": "#/components/schemas/ReadUserGroupPoliciesRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadUserGroupPoliciesResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 HasMoreItems: true MaxResultsLimit: 30 MaxResultsTruncated: true @@ -21349,56 +21618,54 @@ paths: - Body: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], "Resource": ["*"]} ]}' Name: example-policy - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadUserGroupPoliciesResponse" description: The HTTP 200 response (OK). tags: - Policy "/ReadUserGroupPolicy": - description: Returns information about an inline policy included in a specified - group. post: + description: Returns information about an inline policy included in a specified + group. operationId: ReadUserGroupPolicy requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadUserGroupPolicyRequest" examples: ex1: value: PolicyName: example-policy UserGroupName: example-usergroup UserGroupPath: "/example/" - schema: - "$ref": "#/components/schemas/ReadUserGroupPolicyRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadUserGroupPolicyResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Policy: Body: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], "Resource": ["*"]} ]}' Name: example-policy - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadUserGroupPolicyResponse" description: The HTTP 200 response (OK). tags: - Policy "/ReadUserGroups": - description: |- - Lists all the user groups of the account.
- The response can be filtered using either the PathPrefix or the UserGroupIds. post: + description: |- + Lists all the user groups of the account.
+ The response can be filtered using either the PathPrefix or the UserGroupIds. operationId: ReadUserGroups requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadUserGroupsRequest" examples: ex1: value: @@ -21408,20 +21675,20 @@ paths: - ug-12345678 FirstItem: 1 ResultsPerPage: 30 - schema: - "$ref": "#/components/schemas/ReadUserGroupsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadUserGroupsResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 HasMoreItems: true MaxResultsLimit: 30 MaxResultsTruncated: true - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 UserGroups: - CreationDate: '2010-10-01T12:34:56.789Z' LastModificationDate: '2010-10-01T12:34:56.789Z' @@ -21429,29 +21696,29 @@ paths: Orn: orn:ows:idauth::012345678910:usergroup/example/usergroup-example Path: "/example/" UserGroupId: ug-12345678 - schema: - "$ref": "#/components/schemas/ReadUserGroupsResponse" description: The HTTP 200 response (OK). tags: - UserGroup "/ReadUserGroupsPerUser": - description: Lists the groups a specified user belongs to. post: + description: Lists the groups a specified user belongs to. operationId: ReadUserGroupsPerUser requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadUserGroupsPerUserRequest" examples: ex1: value: UserName: example-user UserPath: "/example/" - schema: - "$ref": "#/components/schemas/ReadUserGroupsPerUserRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadUserGroupsPerUserResponse" examples: ex1: value: @@ -21464,28 +21731,28 @@ paths: Orn: orn:ows:idauth::012345678910:usergroup/example/usergroup-example Path: "/example/" UserGroupId: ug-12345678 - schema: - "$ref": "#/components/schemas/ReadUserGroupsPerUserResponse" description: The HTTP 200 response (OK). tags: - UserGroup "/ReadUserPolicies": - description: Lists the names of inline policies included in a specified user. post: + description: Lists the names of inline policies included in a specified user. operationId: ReadUserPolicies requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadUserPoliciesRequest" examples: ex1: value: UserName: example-user - schema: - "$ref": "#/components/schemas/ReadUserPoliciesRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadUserPoliciesResponse" examples: ex1: value: @@ -21493,30 +21760,30 @@ paths: - example-policy ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadUserPoliciesResponse" description: The HTTP 200 response (OK). tags: - Policy "/ReadUserPolicy": - description: Returns information about an inline policy included in a specified - user. post: + description: Returns information about an inline policy included in a specified + user. operationId: ReadUserPolicy requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadUserPolicyRequest" examples: ex1: value: - PolicyName: example-user-policy UserName: example-user - schema: - "$ref": "#/components/schemas/ReadUserPolicyRequest" + PolicyName: example-user-policy responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadUserPolicyResponse" examples: ex1: value: @@ -21524,54 +21791,54 @@ paths: ["*"], "Resource": ["*"]} ]}' PolicyName: example-user-policy UserName: example-user - schema: - "$ref": "#/components/schemas/ReadUserPolicyResponse" description: The HTTP 200 response (OK). tags: - Policy "/ReadUsers": - description: |- - Lists all EIM users in the account.
- The response can be filtered using the UserIds. post: + description: |- + Lists all EIM users in the account.
+ The response can be filtered using the UserIds. operationId: ReadUsers requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadUsersRequest" examples: ex1: value: Filters: UserIds: - ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 - schema: - "$ref": "#/components/schemas/ReadUsersRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadUsersResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Users: - - Path: "/documentation/" - UserEmail: user@example.com - UserId: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 + - UserEmail: user@example.com UserName: example-user - schema: - "$ref": "#/components/schemas/ReadUsersResponse" + UserId: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 + Path: "/documentation/" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - User "/ReadVirtualGateways": - description: Lists one or more virtual gateways. post: + description: Lists one or more virtual gateways. operationId: ReadVirtualGateways requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadVirtualGatewaysRequest" examples: ex1: value: @@ -21581,90 +21848,88 @@ paths: ex2: value: Filters: + States: + - available LinkStates: - attached - detached - States: - - available - schema: - "$ref": "#/components/schemas/ReadVirtualGatewaysRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadVirtualGatewaysResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VirtualGateways: - - ConnectionType: ipsec.1 + - VirtualGatewayId: vgw-12345678 + ConnectionType: ipsec.1 NetToVirtualGatewayLinks: [] State: available Tags: [] - VirtualGatewayId: vgw-12345678 - ex2: - value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + value: VirtualGateways: - - ConnectionType: ipsec.1 + - VirtualGatewayId: vgw-12345678 + ConnectionType: ipsec.1 NetToVirtualGatewayLinks: - - NetId: vpc-12345678 - State: attached + - State: attached + NetId: vpc-12345678 State: available Tags: [] - VirtualGatewayId: vgw-12345678 - schema: - "$ref": "#/components/schemas/ReadVirtualGatewaysResponse" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - VirtualGateway "/ReadVmGroups": - description: |- - > [WARNING]
- > This feature is currently under development and may not function properly.
- - Lists one or more group of virtual machines (VMs). post: + description: |- + > [WARNING]
+ > This feature is currently under development and may not function properly.
+ + Lists one or more group of virtual machines (VMs). operationId: ReadVmGroups requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadVmGroupsRequest" examples: ex1: value: Filters: VmGroupIds: - vmgroup-12345678901234567890123456789012 - schema: - "$ref": "#/components/schemas/ReadVmGroupsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadVmGroupsResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VmGroups: - - CreationDate: 2010-10-01 12:34:56.789000000 +00:00 - PositioningStrategy: attract - SecurityGroupIds: + - SecurityGroupIds: - sg-87654321 - State: available - SubnetId: subnet-12345678 - Tags: - - Key: key1 - Value: value1 - VmCount: 1 - VmGroupId: vmgroup-12345678901234567890123456789012 - VmGroupName: ClusterLog-PPD01 VmIds: - i-12345678 - schema: - "$ref": "#/components/schemas/ReadVmGroupsResponse" + CreationDate: 2010-10-01 12:34:56.789000000 +00:00 + VmCount: 1 + VmGroupName: ClusterLog-PPD01 + SubnetId: subnet-12345678 + PositioningStrategy: attract + State: available + VmGroupId: vmgroup-12345678901234567890123456789012 + Tags: + - Value: value1 + Key: key1 description: The HTTP 200 response (OK). '400': content: @@ -21687,16 +21952,18 @@ paths: tags: - VmGroup "/ReadVmTemplates": - description: |- - > [WARNING]
- > This feature is currently under development and may not function properly.
- - Lists one or more virtual machine (VM) templates. post: + description: |- + > [WARNING]
+ > This feature is currently under development and may not function properly.
+ + Lists one or more virtual machine (VM) templates. operationId: ReadVmTemplates requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadVmTemplatesRequest" examples: ex1: value: @@ -21710,79 +21977,79 @@ paths: - 2 CpuGenerations: - v4 - schema: - "$ref": "#/components/schemas/ReadVmTemplatesRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadVmTemplatesResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VmTemplates: - - CpuCores: 2 - CpuGeneration: v4 + - VmTemplateName: vmtemplate-example CpuPerformance: high CreationDate: 2010-10-01 12:34:56.789000000 +00:00 + CpuCores: 2 + Tags: [] Description: '' ImageId: ami-12345678 - Ram: 2 - Tags: [] + CpuGeneration: v4 VmTemplateId: vmtemplate-98765432109876543210987654321012 - VmTemplateName: vmtemplate-example - schema: - "$ref": "#/components/schemas/ReadVmTemplatesResponse" + Ram: 2 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - VmTemplate "/ReadVmTypes": - description: Lists one or more predefined VM types. post: + description: Lists one or more predefined VM types. operationId: ReadVmTypes requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadVmTypesRequest" examples: ex1: value: Filters: VmTypeNames: - t2.small - schema: - "$ref": "#/components/schemas/ReadVmTypesRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadVmTypesResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VmTypes: - - BsuOptimized: false + - VolumeCount: 0 + VmTypeName: t2.small + BsuOptimized: false MaxPrivateIps: 4 MemorySize: 2 VcoreCount: 1 - VmTypeName: t2.small - VolumeCount: 0 - schema: - "$ref": "#/components/schemas/ReadVmTypesResponse" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). security: [] tags: - Vm "/ReadVms": - description: |- - Lists one or more of your virtual machines (VMs).
- If you provide one or more VM IDs, this action returns a description for all of these VMs. If you do not provide any VM ID, this action returns a description for all of the VMs that belong to you. If you provide an invalid VM ID, an error is returned. If you provide the ID of a VM that does not belong to you, the description of this VM is not included in the response. The refresh interval for data returned by this action is one hour, meaning that a terminated VM may appear in the response. post: + description: |- + Lists one or more of your virtual machines (VMs).
+ If you provide one or more VM IDs, this action returns a description for all of these VMs. If you do not provide any VM ID, this action returns a description for all of the VMs that belong to you. If you provide an invalid VM ID, an error is returned. If you provide the ID of a VM that does not belong to you, the description of this VM is not included in the response. The refresh interval for data returned by this action is one hour, meaning that a terminated VM may appear in the response. operationId: ReadVms requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadVmsRequest" examples: ex1: value: @@ -21797,87 +22064,85 @@ paths: TagValues: - prod - test - schema: - "$ref": "#/components/schemas/ReadVmsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadVmsResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Vms: - - ActionsOnNextBoot: - SecureBoot: none + - VmType: tinav5.c1r1p2 + VmInitiatedShutdownBehavior: stop + State: running + StateReason: '' + RootDeviceType: ebs + RootDeviceName: "/dev/sda1" + IsSourceDestChecked: true + KeypairName: keypair-example + ImageId: ami-12345678 + DeletionProtection: false + BootMode: legacy Architecture: x86_64 + NestedVirtualization: false BlockDeviceMappings: - - Bsu: - DeleteOnVmDeletion: true - LinkDate: '2010-10-01T12:34:56.789Z' - State: attached + - DeviceName: "/dev/sda1" + Bsu: VolumeId: vol-12345678 - DeviceName: "/dev/sda1" - BootMode: legacy - BsuOptimized: false - CreationDate: '2010-10-01T12:34:56.789Z' - DeletionProtection: false - Hypervisor: xen - ImageId: ami-12345678 - IsSourceDestChecked: true - KeypairName: keypair-example + State: attached + LinkDate: '2010-10-01T12:34:56.789Z' + DeleteOnVmDeletion: true + VmId: i-12345678 + ReservationId: r-12345678 + Hypervisor: xen + Placement: + Tenancy: default + SubregionName: eu-west-2a + ProductCodes: + - '0001' + CreationDate: '2010-10-01T12:34:56.789Z' + UserData: '' + SubnetId: subnet-12345678 + PrivateIp: 10.0.0.4 + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 + BsuOptimized: false LaunchNumber: 0 - NestedVirtualization: false NetId: vpc-12345678 Nics: - - AccountId: '123456789012' - Description: Primary network interface - IsSourceDestChecked: true + - SubnetId: subnet-12345678 + State: in-use LinkNic: - DeleteOnVmDeletion: true + State: attached DeviceNumber: 0 LinkNicId: eni-attach-12345678 - State: attached + DeleteOnVmDeletion: true + IsSourceDestChecked: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + Description: Primary network interface + AccountId: '123456789012' + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - IsPrimary: true - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - SecurityGroups: - - SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - State: in-use - SubnetId: subnet-12345678 + IsPrimary: true Performance: high - Placement: - SubregionName: eu-west-2a - Tenancy: default - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal - PrivateIp: 10.0.0.4 - ProductCodes: - - '0001' - ReservationId: r-12345678 - RootDeviceName: "/dev/sda1" - RootDeviceType: ebs - SecurityGroups: - - SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - State: running - StateReason: '' - SubnetId: subnet-12345678 Tags: - - Key: env - Value: prod - UserData: '' - VmId: i-12345678 - VmInitiatedShutdownBehavior: stop - VmType: tinav5.c1r1p2 - schema: - "$ref": "#/components/schemas/ReadVmsResponse" + - Value: prod + Key: env + ActionsOnNextBoot: + SecureBoot: none + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -21900,50 +22165,52 @@ paths: tags: - Vm "/ReadVmsHealth": - description: Lists the state of one or more backend virtual machines (VMs) registered - with a specified load balancer. post: + description: Lists the state of one or more backend virtual machines (VMs) registered + with a specified load balancer. operationId: ReadVmsHealth requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadVmsHealthRequest" examples: ex1: value: + LoadBalancerName: example-lbu BackendVmIds: - i-12345678 - i-87654321 - LoadBalancerName: example-lbu - schema: - "$ref": "#/components/schemas/ReadVmsHealthRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadVmsHealthResponse" examples: ex1: value: - BackendVmHealth: - - State: UP - VmId: i-12345678 - - Description: Instance registration is pending - State: DOWN - StateReason: ELB - VmId: i-87654321 ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ReadVmsHealthResponse" + BackendVmHealth: + - VmId: i-12345678 + State: UP + - VmId: i-87654321 + StateReason: ELB + State: DOWN + Description: Instance registration is pending description: The HTTP 200 response (OK). tags: - LoadBalancer "/ReadVmsState": - description: Lists the status of one or more virtual machines (VMs). post: + description: Lists the status of one or more virtual machines (VMs). operationId: ReadVmsState requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadVmsStateRequest" examples: ex1: value: @@ -21953,37 +22220,35 @@ paths: Filters: SubregionNames: - eu-west-2a - schema: - "$ref": "#/components/schemas/ReadVmsStateRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadVmsStateResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VmStates: - - MaintenanceEvents: [] - SubregionName: eu-west-2a - VmId: i-12345678 + - VmId: i-12345678 VmState: running - - MaintenanceEvents: [] SubregionName: eu-west-2a - VmId: i-87654321 + MaintenanceEvents: [] + - VmId: i-87654321 VmState: stopped - ex2: - value: + SubregionName: eu-west-2a + MaintenanceEvents: [] ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + value: VmStates: - - MaintenanceEvents: [] - SubregionName: eu-west-2a - VmId: i-12345678 + - VmId: i-12345678 VmState: running - schema: - "$ref": "#/components/schemas/ReadVmsStateResponse" + SubregionName: eu-west-2a + MaintenanceEvents: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -22006,12 +22271,14 @@ paths: tags: - Vm "/ReadVolumes": - description: Lists one or more specified Block Storage Unit (BSU) volumes. post: + description: Lists one or more specified Block Storage Unit (BSU) volumes. operationId: ReadVolumes requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadVolumesRequest" examples: ex1: value: @@ -22026,34 +22293,32 @@ paths: VolumeTypes: - gp2 - io1 - schema: - "$ref": "#/components/schemas/ReadVolumesRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadVolumesResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Volumes: - - CreationDate: '2010-10-01T12:34:56.789Z' + - VolumeId: vol-12345678 + Tags: [] + VolumeType: gp2 + SubregionName: eu-west-2a + State: in-use + CreationDate: '2010-10-01T12:34:56.789Z' Iops: 100 LinkedVolumes: - - DeleteOnVmDeletion: false + - VolumeId: vol-12345678 + DeleteOnVmDeletion: false DeviceName: "/dev/sdb" State: attached VmId: i-12345678 - VolumeId: vol-12345678 Size: 10 - State: in-use - SubregionName: eu-west-2a - Tags: [] - VolumeId: vol-12345678 - VolumeType: gp2 - schema: - "$ref": "#/components/schemas/ReadVolumesResponse" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -22076,12 +22341,14 @@ paths: tags: - Volume "/ReadVpnConnections": - description: Lists one or more VPN connections. post: + description: Lists one or more VPN connections. operationId: ReadVpnConnections requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ReadVpnConnectionsRequest" examples: ex1: value: @@ -22096,64 +22363,62 @@ paths: VirtualGatewayIds: - vgw-12345678 - vgw-87654321 - schema: - "$ref": "#/components/schemas/ReadVpnConnectionsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ReadVpnConnectionsResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VpnConnections: - - ClientGatewayConfiguration: "..." - ClientGatewayId: cgw-12345678 + - Routes: [] + Tags: [] + ClientGatewayConfiguration: "..." + StaticRoutesOnly: true + VirtualGatewayId: vgw-12345678 ConnectionType: ipsec.1 - Routes: [] + ClientGatewayId: cgw-12345678 State: pending - StaticRoutesOnly: true - Tags: [] VgwTelemetries: - - AcceptedRouteCount: 0 + - StateDescription: IPSEC IS DOWN + AcceptedRouteCount: 0 LastStateChangeDate: '2017-05-10T12:34:56.789Z' OutsideIpAddress: 192.0.2.0 - StateDescription: IPSEC IS DOWN - VirtualGatewayId: vgw-12345678 VpnConnectionId: vpn-12345678 - schema: - "$ref": "#/components/schemas/ReadVpnConnectionsResponse" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - VpnConnection "/RebootVms": - description: |- - Reboots one or more virtual machines (VMs).
- This operation sends a reboot request to one or more specified VMs. This is an asynchronous action that queues this reboot request. This action only reboots VMs that are valid and that belong to you. post: + description: |- + Reboots one or more virtual machines (VMs).
+ This operation sends a reboot request to one or more specified VMs. This is an asynchronous action that queues this reboot request. This action only reboots VMs that are valid and that belong to you. operationId: RebootVms requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/RebootVmsRequest" examples: ex1: value: VmIds: - i-12345678 - schema: - "$ref": "#/components/schemas/RebootVmsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/RebootVmsResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/RebootVmsResponse" description: The HTTP 200 response (OK). '400': content: @@ -22176,66 +22441,66 @@ paths: tags: - Vm "/RegisterVmsInLoadBalancer": - description: |- - > [WARNING]
- > Deprecated: This call is deprecated and will be removed.
- - Registers one or more virtual machines (VMs) with a specified load balancer.
- The VMs can be in different Subnets and different Subregions than the load balancer, as long as the VMs and load balancers are all in the public Cloud or all in the same Net. It may take a little time for a VM to be registered with the load balancer. Once the VM is registered with a load balancer, it receives traffic and requests from this load balancer and is called a backend VM. post: + description: |- + > [WARNING]
+ > Deprecated: This call is deprecated and will be removed.
+ + Registers one or more virtual machines (VMs) with a specified load balancer.
+ The VMs can be in different Subnets and different Subregions than the load balancer, as long as the VMs and load balancers are all in the public Cloud or all in the same Net. It may take a little time for a VM to be registered with the load balancer. Once the VM is registered with a load balancer, it receives traffic and requests from this load balancer and is called a backend VM. operationId: RegisterVmsInLoadBalancer requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/RegisterVmsInLoadBalancerRequest" examples: ex1: value: + LoadBalancerName: example-lbu BackendVmIds: - i-12345678 - i-87654321 - LoadBalancerName: example-lbu - schema: - "$ref": "#/components/schemas/RegisterVmsInLoadBalancerRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/RegisterVmsInLoadBalancerResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/RegisterVmsInLoadBalancerResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer "/RejectNetPeering": - description: |- - Rejects a Net peering request.
- The Net peering must be in the `pending-acceptance` state to be rejected. The rejected Net peering is then in the `rejected` state. post: + description: |- + Rejects a Net peering request.
+ The Net peering must be in the `pending-acceptance` state to be rejected. The rejected Net peering is then in the `rejected` state. operationId: RejectNetPeering requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/RejectNetPeeringRequest" examples: ex1: value: NetPeeringId: pcx-12345678 - schema: - "$ref": "#/components/schemas/RejectNetPeeringRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/RejectNetPeeringResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/RejectNetPeeringResponse" description: The HTTP 200 response (OK). '400': content: @@ -22264,12 +22529,14 @@ paths: tags: - NetPeering "/RemoveUserFromUserGroup": - description: Removes a specified user from a specified group. post: + description: Removes a specified user from a specified group. operationId: RemoveUserFromUserGroup requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/RemoveUserFromUserGroupRequest" examples: ex1: value: @@ -22277,53 +22544,51 @@ paths: UserGroupPath: "/example/" UserName: example-user UserPath: "/example/" - schema: - "$ref": "#/components/schemas/RemoveUserFromUserGroupRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/RemoveUserFromUserGroupResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/RemoveUserFromUserGroupResponse" description: The HTTP 200 response (OK). tags: - UserGroup "/ScaleDownVmGroup": - description: |- - > [WARNING]
- > This feature is currently under development and may not function properly.
- - Deletes virtual machines (VMs) from a VM group.
- The oldest VMs are the first to be deleted. post: + description: |- + > [WARNING]
+ > This feature is currently under development and may not function properly.
+ + Deletes virtual machines (VMs) from a VM group.
+ The oldest VMs are the first to be deleted. operationId: ScaleDownVmGroup requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ScaleDownVmGroupRequest" examples: ex1: summary: Removing 1 VM from a VM group value: VmGroupId: vmgroup-12345678901234567890123456789012 VmSubtraction: 1 - schema: - "$ref": "#/components/schemas/ScaleDownVmGroupRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ScaleDownVmGroupResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ScaleDownVmGroupResponse" description: The HTTP 200 response (OK). '400': content: @@ -22346,36 +22611,36 @@ paths: tags: - VmGroup "/ScaleUpVmGroup": - description: |- - > [WARNING]
- > This feature is currently under development and may not function properly.
- - Creates additional virtual machines (VMs) in a VM group.
- The new VMs use the current version of the VM template. post: + description: |- + > [WARNING]
+ > This feature is currently under development and may not function properly.
+ + Creates additional virtual machines (VMs) in a VM group.
+ The new VMs use the current version of the VM template. operationId: ScaleUpVmGroup requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/ScaleUpVmGroupRequest" examples: ex1: summary: Adding 2 VMs in a VM group value: - VmAddition: 2 VmGroupId: vmgroup-12345678901234567890123456789012 - schema: - "$ref": "#/components/schemas/ScaleUpVmGroupRequest" + VmAddition: 2 responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/ScaleUpVmGroupResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/ScaleUpVmGroupResponse" description: The HTTP 200 response (OK). '400': content: @@ -22398,66 +22663,66 @@ paths: tags: - VmGroup "/SetDefaultPolicyVersion": - description: |- - Sets a specified version of a managed policy as the default (operative) one.
- You can modify the default version of a policy at any time. post: + description: |- + Sets a specified version of a managed policy as the default (operative) one.
+ You can modify the default version of a policy at any time. operationId: SetDefaultPolicyVersion requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/SetDefaultPolicyVersionRequest" examples: ex1: value: PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy VersionId: v1 - schema: - "$ref": "#/components/schemas/SetDefaultPolicyVersionRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/SetDefaultPolicyVersionResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/SetDefaultPolicyVersionResponse" description: The HTTP 200 response (OK). tags: - Policy "/StartVms": - description: |- - Start one or more virtual machines (VMs).
- You can start only VMs that are valid and that belong to you. post: + description: |- + Start one or more virtual machines (VMs).
+ You can start only VMs that are valid and that belong to you. operationId: StartVms requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/StartVmsRequest" examples: ex1: value: VmIds: - i-12345678 - schema: - "$ref": "#/components/schemas/StartVmsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/StartVmsResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Vms: - - CurrentState: pending + - VmId: i-12345678 PreviousState: stopped - VmId: i-12345678 - schema: - "$ref": "#/components/schemas/StartVmsResponse" + CurrentState: pending + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -22480,36 +22745,36 @@ paths: tags: - Vm "/StopVms": - description: |- - Stops one or more running virtual machines (VMs).
- You can stop only VMs that are valid and that belong to you. Data stored in the VM RAM is lost. post: + description: |- + Stops one or more running virtual machines (VMs).
+ You can stop only VMs that are valid and that belong to you. Data stored in the VM RAM is lost. operationId: StopVms requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/StopVmsRequest" examples: ex1: value: VmIds: - i-12345678 - schema: - "$ref": "#/components/schemas/StopVmsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/StopVmsResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Vms: - - CurrentState: stopping + - VmId: i-12345678 PreviousState: running - VmId: i-12345678 - schema: - "$ref": "#/components/schemas/StopVmsResponse" + CurrentState: stopping + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -22532,61 +22797,61 @@ paths: tags: - Vm "/UnlinkFlexibleGpu": - description: |- - Detaches a flexible GPU (fGPU) from a virtual machine (VM).
- The fGPU is in the `detaching` state until the VM is stopped, after which it becomes `allocated`. It is then available again for attachment to a VM. post: + description: |- + Detaches a flexible GPU (fGPU) from a virtual machine (VM).
+ The fGPU is in the `detaching` state until the VM is stopped, after which it becomes `allocated`. It is then available again for attachment to a VM. operationId: UnlinkFlexibleGpu requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkFlexibleGpuRequest" examples: ex1: value: FlexibleGpuId: fgpu-12345678 - schema: - "$ref": "#/components/schemas/UnlinkFlexibleGpuRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkFlexibleGpuResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UnlinkFlexibleGpuResponse" description: The HTTP 200 response (OK). tags: - FlexibleGpu "/UnlinkInternetService": - description: |- - Detaches an internet service from a Net.
- This action disables and detaches an internet service from a Net. The Net must not contain virtual machines (VMs) using public IPs nor internet-facing load balancers. post: + description: |- + Detaches an internet service from a Net.
+ This action disables and detaches an internet service from a Net. The Net must not contain virtual machines (VMs) using public IPs nor internet-facing load balancers. operationId: UnlinkInternetService requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkInternetServiceRequest" examples: ex1: value: InternetServiceId: igw-12345678 NetId: vpc-12345678 - schema: - "$ref": "#/components/schemas/UnlinkInternetServiceRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkInternetServiceResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UnlinkInternetServiceResponse" description: The HTTP 200 response (OK). '400': content: @@ -22609,34 +22874,37 @@ paths: tags: - InternetService "/UnlinkLoadBalancerBackendMachines": - description: Detaches one or more backend virtual machines (VMs) from a load balancer. - You need to specify at least the `BackendIps` or the `BackendVmIds` parameter. post: + description: Detaches one or more backend virtual machines (VMs) from a load + balancer. You need to specify at least the `BackendIps` or the `BackendVmIds` + parameter. operationId: UnlinkLoadBalancerBackendMachines requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkLoadBalancerBackendMachinesRequest" examples: ex1: summary: Unlinking VMs from a load balancer value: + LoadBalancerName: example-lbu BackendVmIds: - i-12345678 - i-87654321 - LoadBalancerName: example-lbu ex2: summary: Unlinking public IPs from a load balancer value: + LoadBalancerName: example-lbu BackendIps: - 192.0.2.0 - 198.51.100.0 - LoadBalancerName: example-lbu - schema: - "$ref": "#/components/schemas/UnlinkLoadBalancerBackendMachinesRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkLoadBalancerBackendMachinesResponse" examples: ex1: summary: Unlinking VMs from a load balancer @@ -22648,65 +22916,63 @@ paths: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UnlinkLoadBalancerBackendMachinesResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer "/UnlinkManagedPolicyFromUserGroup": - description: Unlinks a managed policy from a specific group. post: + description: Unlinks a managed policy from a specific group. operationId: UnlinkManagedPolicyFromUserGroup requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkManagedPolicyFromUserGroupRequest" examples: ex1: value: PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy UserGroupName: example-usergroup - schema: - "$ref": "#/components/schemas/UnlinkManagedPolicyFromUserGroupRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkManagedPolicyFromUserGroupResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UnlinkManagedPolicyFromUserGroupResponse" description: The HTTP 200 response (OK). tags: - Policy "/UnlinkNic": - description: |- - Detaches a network interface card (NIC) from a virtual machine (VM).
- The primary NIC cannot be detached. post: + description: |- + Detaches a network interface card (NIC) from a virtual machine (VM).
+ The primary NIC cannot be detached. operationId: UnlinkNic requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkNicRequest" examples: ex1: value: LinkNicId: eni-attach-12345678 - schema: - "$ref": "#/components/schemas/UnlinkNicRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkNicResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UnlinkNicResponse" description: The HTTP 200 response (OK). '400': content: @@ -22729,41 +22995,43 @@ paths: tags: - Nic "/UnlinkPolicy": - description: Removes a managed policy from a specific user. post: + description: Removes a managed policy from a specific user. operationId: UnlinkPolicy requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkPolicyRequest" examples: ex1: value: PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy UserName: example-user - schema: - "$ref": "#/components/schemas/UnlinkPolicyRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkPolicyResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UnlinkPolicyResponse" description: The HTTP 200 response (OK). tags: - Policy "/UnlinkPrivateIps": - description: Unassigns one or more secondary private IPs from a network interface - card (NIC). post: + description: Unassigns one or more secondary private IPs from a network interface + card (NIC). operationId: UnlinkPrivateIps requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkPrivateIpsRequest" examples: ex1: value: @@ -22771,19 +23039,17 @@ paths: PrivateIps: - 10.0.0.6 - 10.0.0.7 - schema: - "$ref": "#/components/schemas/UnlinkPrivateIpsRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkPrivateIpsResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UnlinkPrivateIpsResponse" description: The HTTP 200 response (OK). '400': content: @@ -22806,33 +23072,33 @@ paths: tags: - Nic "/UnlinkPublicIp": - description: |- - Disassociates a public IP from the virtual machine (VM) or network interface card (NIC) it is associated with.

- - **[IMPORTANT]**
- To disassociate the public IP from a NAT service, you need to delete the NAT service. For more information, see the [DeleteNatService](#deletenatservice) method. post: + description: |- + Disassociates a public IP from the virtual machine (VM) or network interface card (NIC) it is associated with.

+ + **[IMPORTANT]**
+ To disassociate the public IP from a NAT service, you need to delete the NAT service. For more information, see the [DeleteNatService](#deletenatservice) method. operationId: UnlinkPublicIp requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkPublicIpRequest" examples: ex1: value: PublicIp: 192.0.2.0 - schema: - "$ref": "#/components/schemas/UnlinkPublicIpRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkPublicIpResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UnlinkPublicIpResponse" description: The HTTP 200 response (OK). '400': content: @@ -22855,31 +23121,31 @@ paths: tags: - PublicIp "/UnlinkRouteTable": - description: |- - Disassociates a Subnet from a route table.
- After disassociation, the Subnet can no longer use the routes in this route table, but uses the routes in the main route table of the Net instead. post: + description: |- + Disassociates a Subnet from a route table.
+ After disassociation, the Subnet can no longer use the routes in this route table, but uses the routes in the main route table of the Net instead. operationId: UnlinkRouteTable requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkRouteTableRequest" examples: ex1: value: LinkRouteTableId: rtbassoc-12345678 - schema: - "$ref": "#/components/schemas/UnlinkRouteTableRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkRouteTableResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UnlinkRouteTableResponse" description: The HTTP 200 response (OK). '400': content: @@ -22902,61 +23168,61 @@ paths: tags: - RouteTable "/UnlinkVirtualGateway": - description: |- - Detaches a virtual gateway from a Net.
- You must wait until the virtual gateway is in the detached state before you can attach another Net to it or delete the Net it was previously attached to. post: + description: |- + Detaches a virtual gateway from a Net.
+ You must wait until the virtual gateway is in the detached state before you can attach another Net to it or delete the Net it was previously attached to. operationId: UnlinkVirtualGateway requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkVirtualGatewayRequest" examples: ex1: value: - NetId: vpc-12345678 VirtualGatewayId: vgw-12345678 - schema: - "$ref": "#/components/schemas/UnlinkVirtualGatewayRequest" + NetId: vpc-12345678 responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkVirtualGatewayResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UnlinkVirtualGatewayResponse" description: The HTTP 200 response (OK). tags: - VirtualGateway "/UnlinkVolume": - description: |- - Detaches a Block Storage Unit (BSU) volume from a virtual machine (VM).
- To detach the root device of a VM, this VM must be stopped. post: + description: |- + Detaches a Block Storage Unit (BSU) volume from a virtual machine (VM).
+ To detach the root device of a VM, this VM must be stopped. operationId: UnlinkVolume requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkVolumeRequest" examples: ex1: value: VolumeId: vol-12345678 - schema: - "$ref": "#/components/schemas/UnlinkVolumeRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UnlinkVolumeResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UnlinkVolumeResponse" description: The HTTP 200 response (OK). '400': content: @@ -22979,21 +23245,23 @@ paths: tags: - Volume "/UpdateAccessKey": - description: |- - Modifies the attributes of the specified access key of either your root account or an EIM user.

- The parameter `ExpirationDate` is not required when updating the state of your access key. However, if you do not specify the expiration date of an access key when updating its state, it is then set to not expire. post: + description: |- + Modifies the attributes of the specified access key of either your root account or an EIM user.

+ The parameter `ExpirationDate` is not required when updating the state of your access key. However, if you do not specify the expiration date of an access key when updating its state, it is then set to not expire. operationId: UpdateAccessKey requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateAccessKeyRequest" examples: ex1: summary: Updating the expiration date of the access key value: AccessKeyId: ABCDEFGHIJ0123456789 - ExpirationDate: '2063-04-05' State: ACTIVE + ExpirationDate: '2063-04-05' ex2: summary: Updating the state of one of your own access keys (if you are the root account or an EIM user) @@ -23006,38 +23274,36 @@ paths: AccessKeyId: ABCDEFGHIJ0123456789 State: ACTIVE UserName: example-user - schema: - "$ref": "#/components/schemas/UpdateAccessKeyRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateAccessKeyResponse" examples: ex1: summary: Updating an access key when using the parameter ExpirationDate value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 AccessKey: + State: ACTIVE AccessKeyId: ABCDEFGHIJ0123456789 CreationDate: 2010-10-01 12:34:56.789000000 +00:00 ExpirationDate: 2063-04-05 00:00:00.000000000 +00:00 LastModificationDate: 2017-05-10 12:34:56.789000000 +00:00 - State: ACTIVE Tag: Group1 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Updating an access key when not using the parameter ExpirationDate value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 AccessKey: + State: ACTIVE AccessKeyId: ABCDEFGHIJ0123456789 CreationDate: 2010-10-01 12:34:56.789000000 +00:00 LastModificationDate: 2017-05-10 12:34:56.789000000 +00:00 - State: ACTIVE Tag: Group1 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UpdateAccessKeyResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -23045,58 +23311,61 @@ paths: tags: - AccessKey "/UpdateAccount": - description: Updates the account information for the account that sends the request. post: + description: Updates the account information for the account that sends the + request. operationId: UpdateAccount requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateAccountRequest" examples: ex1: value: AdditionalEmails: - another@example.com - yet.another@example.com - schema: - "$ref": "#/components/schemas/UpdateAccountRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateAccountResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Account: - AccountId: '123456789012' + ZipCode: '92210' + CompanyName: EXAMPLE SAS + FirstName: JEAN AdditionalEmails: - another@example.com - yet.another@example.com City: SAINT-CLOUD - CompanyName: EXAMPLE SAS Country: FRANCE + LastName: DUPONT + AccountId: '123456789012' CustomerId: '87654321' Email: example@example.com - FirstName: JEAN - LastName: DUPONT - ZipCode: '92210' - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UpdateAccountResponse" description: The HTTP 200 response (OK). tags: - Account "/UpdateApiAccessPolicy": - description: |- - Updates the API access policy of your account.

- - **[IMPORTANT]**
- Only one API access policy can be associated with your account. post: + description: |- + Updates the API access policy of your account.

+ + **[IMPORTANT]**
+ Only one API access policy can be associated with your account. operationId: UpdateApiAccessPolicy requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateApiAccessPolicyRequest" examples: ex1: summary: Require expiration dates of maximum 1 year @@ -23115,41 +23384,39 @@ paths: value: MaxAccessKeyExpirationSeconds: 0 RequireTrustedEnv: false - schema: - "$ref": "#/components/schemas/UpdateApiAccessPolicyRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateApiAccessPolicyResponse" examples: ex1: summary: Require expiration dates of maximum 1 year value: - ApiAccessPolicy: - MaxAccessKeyExpirationSeconds: 31536000 - RequireTrustedEnv: false ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ApiAccessPolicy: + RequireTrustedEnv: false + MaxAccessKeyExpirationSeconds: 31536000 ex2: summary: Require expiration dates of maximum 100 years and activate a trusted session value: - ApiAccessPolicy: - MaxAccessKeyExpirationSeconds: 3153600000 - RequireTrustedEnv: true ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ApiAccessPolicy: + RequireTrustedEnv: true + MaxAccessKeyExpirationSeconds: 3153600000 ex3: summary: Do not require expiration dates and deactivate a trusted session value: - ApiAccessPolicy: - MaxAccessKeyExpirationSeconds: 0 - RequireTrustedEnv: false ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UpdateApiAccessPolicyResponse" + ApiAccessPolicy: + RequireTrustedEnv: false + MaxAccessKeyExpirationSeconds: 0 description: The HTTP 200 response (OK). '400': content: @@ -23175,44 +23442,44 @@ paths: tags: - ApiAccessPolicy "/UpdateApiAccessRule": - description: |- - Modifies a specified API access rule.

- - **[WARNING]**
- - The new rule you specify fully replaces the old rule. Therefore, for a parameter that is not specified, any previously set value is deleted.
- - If, as result of your modification, you no longer have access to the APIs, you will need to contact the Support team to regain access. For more information, see [Technical Support](https://docs.outscale.com/en/userguide/Technical-Support.html). post: + description: |- + Modifies a specified API access rule.

+ + **[WARNING]**
+ - The new rule you specify fully replaces the old rule. Therefore, for a parameter that is not specified, any previously set value is deleted.
+ - If, as result of your modification, you no longer have access to the APIs, you will need to contact the Support team to regain access. For more information, see [Technical Support](https://docs.outscale.com/en/userguide/Technical-Support.html). operationId: UpdateApiAccessRule requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateApiAccessRuleRequest" examples: ex1: value: ApiAccessRuleId: aar-1234567890abcdef1234567890abcdef - Description: Allows all Ipv4 domain IpRanges: - 0.0.0.0/0 - schema: - "$ref": "#/components/schemas/UpdateApiAccessRuleRequest" + Description: Allows all Ipv4 domain responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateApiAccessRuleResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ApiAccessRule: + IpRanges: + - 0.0.0.0/0 ApiAccessRuleId: aar-1234567890abcdef1234567890abcdef CaIds: [] Cns: [] Description: Allows all IPv4 domain - IpRanges: - - 0.0.0.0/0 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UpdateApiAccessRuleResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -23220,35 +23487,35 @@ paths: tags: - ApiAccessRule "/UpdateCa": - description: Modifies the specified attribute of a Client Certificate Authority - (CA). post: + description: Modifies the specified attribute of a Client Certificate Authority + (CA). operationId: UpdateCa requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateCaRequest" examples: ex1: value: CaId: ca-fedcba0987654321fedcba0987654321 Description: New description - schema: - "$ref": "#/components/schemas/UpdateCaRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateCaResponse" examples: ex1: value: - Ca: - CaFingerprint: 1234567890abcdef1234567890abcdef12345678 - CaId: ca-fedcba0987654321fedcba0987654321 - Description: New description ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UpdateCaResponse" + Ca: + Description: New description + CaId: ca-fedcba0987654321fedcba0987654321 + CaFingerprint: 1234567890abcdef1234567890abcdef12345678 description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -23256,44 +23523,44 @@ paths: tags: - Ca "/UpdateDedicatedGroup": - description: |- - > [WARNING]
- > This feature is currently in beta.
- - Modifies the name of a specified dedicated group.
post: + description: |- + > [WARNING]
+ > This feature is currently in beta.
+ + Modifies the name of a specified dedicated group.
operationId: UpdateDedicatedGroup requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateDedicatedGroupRequest" examples: ex1: value: DedicatedGroupId: ded-12345678 Name: New-dedicated-group-name - schema: - "$ref": "#/components/schemas/UpdateDedicatedGroupRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateDedicatedGroupResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 DedicatedGroup: + VmIds: + - i-12345678 + NetIds: + - vpc-12345678 AccountId: '123456789012' CpuGeneration: 4 - DedicatedGroupId: ded-12345678 Name: New-dedicated-group-name - NetIds: - - vpc-12345678 SubregionName: eu-west-2a - VmIds: - - i-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UpdateDedicatedGroupResponse" + DedicatedGroupId: ded-12345678 description: The HTTP 200 response (OK). '400': content: @@ -23316,68 +23583,72 @@ paths: tags: - DedicatedGroup "/UpdateDirectLinkInterface": - description: Modifies the maximum transmission unit (MTU) of a DirectLink interface. post: + description: Modifies the maximum transmission unit (MTU) of a DirectLink interface. operationId: UpdateDirectLinkInterface requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateDirectLinkInterfaceRequest" examples: ex1: value: DirectLinkInterfaceId: dxvif-12345678 Mtu: 1500 - schema: - "$ref": "#/components/schemas/UpdateDirectLinkInterfaceRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateDirectLinkInterfaceResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 DirectLinkInterface: - AccountId: '123456789012' + Vlan: 101 + OutscalePrivateIp: 172.16.0.4/30 + DirectLinkInterfaceId: dxvif-12345678 BgpAsn: 65000 + AccountId: '123456789012' ClientPrivateIp: 172.16.0.5/30 - DirectLinkId: dxcon-12345678 - DirectLinkInterfaceId: dxvif-12345678 + VirtualGatewayId: vgw-12345678 DirectLinkInterfaceName: MyDirectLinkInterface - InterfaceType: private - Location: PAR1 + DirectLinkId: dxcon-12345678 Mtu: 1500 - OutscalePrivateIp: 172.16.0.4/30 State: available - VirtualGatewayId: vgw-12345678 - Vlan: 101 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UpdateDirectLinkInterfaceResponse" + InterfaceType: private + Location: PAR1 description: The HTTP 200 response (OK). tags: - DirectLinkInterface "/UpdateFlexibleGpu": - description: Modifies a flexible GPU (fGPU) behavior. post: + description: Modifies a flexible GPU (fGPU) behavior. operationId: UpdateFlexibleGpu requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateFlexibleGpuRequest" examples: ex1: value: - DeleteOnVmDeletion: false FlexibleGpuId: fgpu-12345678 - schema: - "$ref": "#/components/schemas/UpdateFlexibleGpuRequest" + DeleteOnVmDeletion: false responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateFlexibleGpuResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 FlexibleGpu: DeleteOnVmDeletion: false FlexibleGpuId: fgpu-12345678 @@ -23385,23 +23656,21 @@ paths: ModelName: nvidia-p100 State: allocated SubregionName: eu-west-2a - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UpdateFlexibleGpuResponse" description: The HTTP 200 response (OK). tags: - FlexibleGpu "/UpdateImage": - description: |- - Modifies the access permissions for an OUTSCALE machine image (OMI).
- You must specify either the `Additions` or the `Removals` parameter.
- After sharing an OMI with an account, the other account can create a copy of it that they own. For more information about copying OMIs, see [CreateImage](#createimage). post: + description: |- + Modifies the access permissions for an OUTSCALE machine image (OMI).
+ You must specify either the `Additions` or the `Removals` parameter.
+ After sharing an OMI with an account, the other account can create a copy of it that they own. For more information about copying OMIs, see [CreateImage](#createimage). operationId: UpdateImage requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateImageRequest" examples: ex1: summary: Adding permission @@ -23429,145 +23698,143 @@ paths: ex4: summary: Making an image private to everyone value: - Description: Private image ImageId: ami-12345678 + Description: Private image PermissionsToLaunch: Removals: GlobalPermission: true - schema: - "$ref": "#/components/schemas/UpdateImageRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateImageResponse" examples: ex1: summary: Adding permission value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Image: + StateComment: {} + State: available + RootDeviceType: bsu + RootDeviceName: "/dev/sda1" + ProductCodes: + - '0001' + PermissionsToLaunch: + GlobalPermission: false + AccountIds: + - '987654321098' AccountId: '123456789012' - Architecture: x86_64 + Tags: [] + Description: '' + ImageId: ami-12345678 BlockDeviceMappings: - - Bsu: + - DeviceName: "/dev/sda1" + Bsu: + VolumeType: standard DeleteOnVmDeletion: true - SnapshotId: snap-12345678 VolumeSize: 50 - VolumeType: standard - DeviceName: "/dev/sda1" + SnapshotId: snap-12345678 + ImageType: machine CreationDate: '2010-10-01T12:34:56.789Z' - Description: '' FileLocation: 123456789012/image-example - ImageId: ami-12345678 + Architecture: x86_64 ImageName: image-example - ImageType: machine - PermissionsToLaunch: - AccountIds: - - '987654321098' - GlobalPermission: false - ProductCodes: - - '0001' - RootDeviceName: "/dev/sda1" - RootDeviceType: bsu - State: available - StateComment: {} - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Removing permission value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Image: + StateComment: {} + State: available + RootDeviceType: bsu + RootDeviceName: "/dev/sda1" + ProductCodes: + - '0001' + PermissionsToLaunch: + GlobalPermission: false + AccountIds: [] AccountId: '123456789012' - Architecture: x86_64 + Tags: [] + Description: '' + ImageId: ami-12345678 BlockDeviceMappings: - - Bsu: + - DeviceName: "/dev/sda1" + Bsu: + VolumeType: standard DeleteOnVmDeletion: true - SnapshotId: snap-12345678 VolumeSize: 50 - VolumeType: standard - DeviceName: "/dev/sda1" + SnapshotId: snap-12345678 + ImageType: machine CreationDate: '2010-10-01T12:34:56.789Z' - Description: '' FileLocation: 123456789012/image-example - ImageId: ami-12345678 + Architecture: x86_64 ImageName: image-example - ImageType: machine - PermissionsToLaunch: - AccountIds: [] - GlobalPermission: false - ProductCodes: - - '0001' - RootDeviceName: "/dev/sda1" - RootDeviceType: bsu - State: available - StateComment: {} - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex3: summary: Making an image public to everyone value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Image: + StateComment: {} + State: available + RootDeviceType: bsu + RootDeviceName: "/dev/sda1" + ProductCodes: + - '0001' + PermissionsToLaunch: + GlobalPermission: true + AccountIds: [] AccountId: '123456789012' - Architecture: x86_64 + Tags: [] + Description: '' + ImageId: ami-12345678 BlockDeviceMappings: - - Bsu: + - DeviceName: "/dev/sda1" + Bsu: + VolumeType: standard DeleteOnVmDeletion: true - SnapshotId: snap-12345678 VolumeSize: 50 - VolumeType: standard - DeviceName: "/dev/sda1" + SnapshotId: snap-12345678 + ImageType: machine CreationDate: '2010-10-01T12:34:56.789Z' - Description: '' FileLocation: 123456789012/image-example - ImageId: ami-12345678 + Architecture: x86_64 ImageName: image-example - ImageType: machine - PermissionsToLaunch: - AccountIds: [] - GlobalPermission: true - ProductCodes: - - '0001' - RootDeviceName: "/dev/sda1" - RootDeviceType: bsu - State: available - StateComment: {} - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex4: summary: Making an image private to everyone value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Image: + StateComment: {} + State: available + RootDeviceType: bsu + RootDeviceName: "/dev/sda1" + ProductCodes: + - '0001' + PermissionsToLaunch: + GlobalPermission: false + AccountIds: [] AccountId: '123456789012' - Architecture: x86_64 + Tags: [] + Description: Private image + ImageId: ami-12345678 BlockDeviceMappings: - - Bsu: + - DeviceName: "/dev/sda1" + Bsu: + VolumeType: standard DeleteOnVmDeletion: true - SnapshotId: snap-12345678 VolumeSize: 50 - VolumeType: standard - DeviceName: "/dev/sda1" + SnapshotId: snap-12345678 + ImageType: machine CreationDate: '2010-10-01T12:34:56.789Z' - Description: Private image FileLocation: 123456789012/image-example - ImageId: ami-12345678 + Architecture: x86_64 ImageName: image-example - ImageType: machine - PermissionsToLaunch: - AccountIds: [] - GlobalPermission: false - ProductCodes: - - '0001' - RootDeviceName: "/dev/sda1" - RootDeviceType: bsu - State: available - StateComment: {} - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UpdateImageResponse" description: The HTTP 200 response (OK). '400': content: @@ -23590,80 +23857,82 @@ paths: tags: - Image "/UpdateListenerRule": - description: |- - Updates the pattern of the listener rule.
- This call updates the pattern matching algorithm for incoming traffic. post: + description: |- + Updates the pattern of the listener rule.
+ This call updates the pattern matching algorithm for incoming traffic. operationId: UpdateListenerRule requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateListenerRuleRequest" examples: ex1: value: - HostPattern: "*.newhost.com" ListenerRuleName: example-listener-rule - schema: - "$ref": "#/components/schemas/UpdateListenerRuleRequest" + HostPattern: "*.newhost.com" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateListenerRuleResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ListenerRule: - Action: forward - HostNamePattern: "*.newhost.com" - ListenerId: 123456 - ListenerRuleId: 1234 - ListenerRuleName: example-listener-rule Priority: 10 VmIds: - i-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UpdateListenerRuleResponse" + ListenerRuleName: example-listener-rule + Action: forward + ListenerId: 123456 + HostNamePattern: "*.newhost.com" + ListenerRuleId: 1234 description: The HTTP 200 response (OK). tags: - Listener "/UpdateLoadBalancer": - description: |- - Modifies the specified attribute of a load balancer. You can specify only one attribute at a time.

+ post: + description: |- + Modifies the specified attribute of a load balancer. You can specify only one attribute at a time.

- You can set a new SSL certificate to an SSL or HTTPS listener of a load balancer.
- This certificate replaces any certificate used on the same load balancer and port.

+ You can set a new SSL certificate to an SSL or HTTPS listener of a load balancer.
+ This certificate replaces any certificate used on the same load balancer and port.

- You can also replace the currently enabled policy for the load balancer with another one.
- If the `PolicyNames` parameter is empty, the currently enabled policy is disabled. - post: + You can also replace the currently enabled policy for the load balancer with another one.
+ If the `PolicyNames` parameter is empty, the currently enabled policy is disabled. operationId: UpdateLoadBalancer requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateLoadBalancerRequest" examples: ex1: summary: Updating health checks value: + LoadBalancerName: private-lb-example HealthCheck: - CheckInterval: 30 HealthyThreshold: 10 + CheckInterval: 30 Path: "/index.html" Port: 8080 Protocol: HTTPS Timeout: 5 UnhealthyThreshold: 5 - LoadBalancerName: private-lb-example ex2: summary: Updating access logs value: + LoadBalancerName: private-lb-example AccessLog: + PublicationInterval: 5 IsEnabled: true OsuBucketName: BUCKET OsuBucketPrefix: PREFIX - PublicationInterval: 5 - LoadBalancerName: private-lb-example ex3: summary: Updating policies value: @@ -23677,219 +23946,217 @@ paths: LoadBalancerName: private-lb-example LoadBalancerPort: 443 ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/AnotherCertificate - schema: - "$ref": "#/components/schemas/UpdateLoadBalancerRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateLoadBalancerResponse" examples: ex1: summary: Updating health checks value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 LoadBalancer: + Tags: [] + SourceSecurityGroup: + SecurityGroupName: security-group-example + SecurityGroupAccountId: '123456789012' + SecuredCookies: false + PublicIp: 192.0.2.0 + Subnets: + - subnet-12345678 + NetId: vpc-12345678 + BackendVmIds: [] + ApplicationStickyCookiePolicies: [] + SecurityGroups: + - sg-12345678 + LoadBalancerType: internet-facing AccessLog: - IsEnabled: false PublicationInterval: 60 - ApplicationStickyCookiePolicies: [] - BackendVmIds: [] + IsEnabled: false DnsName: private-lb-example.123456789.eu-west-2.lbu.outscale.com HealthCheck: + UnhealthyThreshold: 5 + Timeout: 5 CheckInterval: 30 - HealthyThreshold: 10 Path: "/index.html" - Port: 8080 Protocol: HTTPS - Timeout: 5 - UnhealthyThreshold: 5 + HealthyThreshold: 10 + Port: 8080 + LoadBalancerStickyCookiePolicies: [] + SubregionNames: + - eu-west-2a Listeners: - - BackendPort: 80 + - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate + BackendPort: 80 BackendProtocol: HTTP LoadBalancerPort: 443 LoadBalancerProtocol: HTTPS - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate LoadBalancerName: private-lb-example - LoadBalancerStickyCookiePolicies: [] - LoadBalancerType: internet-facing - NetId: vpc-12345678 - PublicIp: 192.0.2.0 - SecuredCookies: false - SecurityGroups: - - sg-12345678 - SourceSecurityGroup: - SecurityGroupAccountId: '123456789012' - SecurityGroupName: security-group-example - Subnets: - - subnet-12345678 - SubregionNames: - - eu-west-2a - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Updating access logs value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 LoadBalancer: + Tags: [] + SourceSecurityGroup: + SecurityGroupName: security-group-example + SecurityGroupAccountId: '123456789012' + SecuredCookies: false + PublicIp: 192.0.2.0 + Subnets: + - subnet-12345678 + NetId: vpc-12345678 + BackendVmIds: [] + ApplicationStickyCookiePolicies: [] + SecurityGroups: + - sg-12345678 + LoadBalancerType: internet-facing AccessLog: - IsEnabled: true - OsuBucketName: BUCKET - OsuBucketPrefix: PREFIX PublicationInterval: 5 - ApplicationStickyCookiePolicies: [] - BackendVmIds: [] + OsuBucketPrefix: PREFIX + OsuBucketName: BUCKET + IsEnabled: true DnsName: private-lb-example.123456789.eu-west-2.lbu.outscale.com HealthCheck: + UnhealthyThreshold: 2 + Timeout: 5 CheckInterval: 30 + Protocol: TCP HealthyThreshold: 10 Port: 80 - Protocol: TCP - Timeout: 5 - UnhealthyThreshold: 2 + LoadBalancerStickyCookiePolicies: [] + SubregionNames: + - eu-west-2a Listeners: - - BackendPort: 80 + - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate + BackendPort: 80 BackendProtocol: HTTP LoadBalancerPort: 443 LoadBalancerProtocol: HTTPS - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate LoadBalancerName: private-lb-example - LoadBalancerStickyCookiePolicies: [] - LoadBalancerType: internet-facing - NetId: vpc-12345678 - PublicIp: 192.0.2.0 - SecuredCookies: false - SecurityGroups: - - sg-12345678 - SourceSecurityGroup: - SecurityGroupAccountId: '123456789012' - SecurityGroupName: security-group-example - Subnets: - - subnet-12345678 - SubregionNames: - - eu-west-2a - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex3: summary: Updating policies value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 LoadBalancer: + Tags: [] + SourceSecurityGroup: + SecurityGroupName: security-group-example + SecurityGroupAccountId: '123456789012' + SecuredCookies: false + PublicIp: 192.0.2.0 + Subnets: + - subnet-12345678 + NetId: vpc-12345678 + BackendVmIds: [] + ApplicationStickyCookiePolicies: [] + SecurityGroups: + - sg-12345678 + LoadBalancerType: internet-facing AccessLog: - IsEnabled: false PublicationInterval: 60 - ApplicationStickyCookiePolicies: [] - BackendVmIds: [] + IsEnabled: false DnsName: private-lb-example.123456789.eu-west-2.lbu.outscale.com HealthCheck: + UnhealthyThreshold: 2 + Timeout: 5 CheckInterval: 30 + Protocol: TCP HealthyThreshold: 10 Port: 80 - Protocol: TCP - Timeout: 5 - UnhealthyThreshold: 2 + LoadBalancerStickyCookiePolicies: + - PolicyName: example-browser-policy + CookieExpirationPeriod: 1 + SubregionNames: + - eu-west-2a Listeners: - - BackendPort: 80 + - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate + BackendPort: 80 BackendProtocol: HTTP LoadBalancerPort: 443 LoadBalancerProtocol: HTTPS - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate LoadBalancerName: private-lb-example - LoadBalancerStickyCookiePolicies: - - CookieExpirationPeriod: 1 - PolicyName: example-browser-policy - LoadBalancerType: internet-facing - NetId: vpc-12345678 - PublicIp: 192.0.2.0 - SecuredCookies: false - SecurityGroups: - - sg-12345678 - SourceSecurityGroup: - SecurityGroupAccountId: '123456789012' - SecurityGroupName: security-group-example - Subnets: - - subnet-12345678 - SubregionNames: - - eu-west-2a - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex4: summary: Updating SSL certificate value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 LoadBalancer: + Tags: [] + SourceSecurityGroup: + SecurityGroupName: security-group-example + SecurityGroupAccountId: '123456789012' + SecuredCookies: false + PublicIp: 192.0.2.0 + Subnets: + - subnet-12345678 + NetId: vpc-12345678 + BackendVmIds: [] + ApplicationStickyCookiePolicies: [] + SecurityGroups: + - sg-12345678 + LoadBalancerType: internet-facing AccessLog: - IsEnabled: false PublicationInterval: 60 - ApplicationStickyCookiePolicies: [] - BackendVmIds: [] + IsEnabled: false DnsName: private-lb-example.123456789.eu-west-2.lbu.outscale.com HealthCheck: + UnhealthyThreshold: 2 + Timeout: 5 CheckInterval: 30 + Protocol: TCP HealthyThreshold: 10 Port: 80 - Protocol: TCP - Timeout: 5 - UnhealthyThreshold: 2 + LoadBalancerStickyCookiePolicies: [] + SubregionNames: + - eu-west-2a Listeners: - - BackendPort: 80 + - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/AnotherCertificate + BackendPort: 80 BackendProtocol: HTTP LoadBalancerPort: 443 LoadBalancerProtocol: HTTPS - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/AnotherCertificate LoadBalancerName: private-lb-example - LoadBalancerStickyCookiePolicies: [] - LoadBalancerType: internet-facing - NetId: vpc-12345678 - PublicIp: 192.0.2.0 - SecuredCookies: false - SecurityGroups: - - sg-12345678 - SourceSecurityGroup: - SecurityGroupAccountId: '123456789012' - SecurityGroupName: security-group-example - Subnets: - - subnet-12345678 - SubregionNames: - - eu-west-2a - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UpdateLoadBalancerResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer "/UpdateNet": - description: Associates a DHCP options set with a specified Net. post: + description: Associates a DHCP options set with a specified Net. operationId: UpdateNet requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateNetRequest" examples: ex1: value: - DhcpOptionsSetId: dopt-12345678 NetId: vpc-12345678 - schema: - "$ref": "#/components/schemas/UpdateNetRequest" + DhcpOptionsSetId: dopt-12345678 responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateNetResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Net: + Tags: [] DhcpOptionsSetId: dopt-12345678 IpRange: 10.0.0.0/16 + Tenancy: default NetId: vpc-12345678 State: available - Tags: [] - Tenancy: default - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UpdateNetResponse" description: The HTTP 200 response (OK). '400': content: @@ -23912,81 +24179,83 @@ paths: tags: - Net "/UpdateNetAccessPoint": - description: |- - Modifies the attributes of a Net access point.
- This action enables you to add or remove route tables associated with the specified Net access point. post: + description: |- + Modifies the attributes of a Net access point.
+ This action enables you to add or remove route tables associated with the specified Net access point. operationId: UpdateNetAccessPoint requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateNetAccessPointRequest" examples: ex1: summary: Adding a route table value: + NetAccessPointId: vpce-12345678 AddRouteTableIds: - rtb-87654321 - NetAccessPointId: vpce-12345678 ex2: summary: Removing a route table value: NetAccessPointId: vpce-12345678 RemoveRouteTableIds: - rtb-12345678 - schema: - "$ref": "#/components/schemas/UpdateNetAccessPointRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateNetAccessPointResponse" examples: ex1: summary: Adding a route table value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 NetAccessPoint: + Tags: [] NetAccessPointId: vpce-12345678 - NetId: vpc-12345678 RouteTableIds: - rtb-12345678 - rtb-87654321 - ServiceName: com.outscale.eu-west-2.oos State: available - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + NetId: vpc-12345678 + ServiceName: com.outscale.eu-west-2.oos ex2: summary: Removing a route table value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 NetAccessPoint: + Tags: [] NetAccessPointId: vpce-12345678 - NetId: vpc-12345678 RouteTableIds: [] - ServiceName: com.outscale.eu-west-2.oos State: available - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UpdateNetAccessPointResponse" + NetId: vpc-12345678 + ServiceName: com.outscale.eu-west-2.oos description: The HTTP 200 response (OK). tags: - NetAccessPoint "/UpdateNic": - description: Modifies the specified network interface card (NIC). You can specify - only one attribute at a time. post: + description: Modifies the specified network interface card (NIC). You can specify + only one attribute at a time. operationId: UpdateNic requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateNicRequest" examples: ex1: summary: Modifying the DeleteOnVmDeletion value of a NIC value: + NicId: eni-12345678 LinkNic: DeleteOnVmDeletion: false LinkNicId: eni-attach-12345678 - NicId: eni-12345678 ex2: summary: Modifying the security groups of a NIC value: @@ -23996,110 +24265,108 @@ paths: ex3: summary: Modifying the description of a NIC value: - Description: Example of description NicId: eni-12345678 - schema: - "$ref": "#/components/schemas/UpdateNicRequest" + Description: Example of description responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateNicResponse" examples: ex1: summary: Modifying the DeleteOnVmDeletion value of a NIC value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Nic: - AccountId: '123456789012' - Description: Primary network interface - IsSourceDestChecked: true + SubregionName: eu-west-2a + SubnetId: subnet-12345678 + State: in-use LinkNic: + VmId: i-12345678 + LinkNicId: eni-attach-12345678 + VmAccountId: '123456789012' DeleteOnVmDeletion: false DeviceNumber: 0 - LinkNicId: eni-attach-12345678 State: attached - VmAccountId: '123456789012' - VmId: i-12345678 + IsSourceDestChecked: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + Tags: [] + Description: Primary network interface + AccountId: '123456789012' + SecurityGroups: + - SecurityGroupName: default + SecurityGroupId: sg-12345678 MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - IsPrimary: true - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - SecurityGroups: - - SecurityGroupId: sg-12345678 - SecurityGroupName: default - State: in-use - SubnetId: subnet-12345678 - SubregionName: eu-west-2a - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + IsPrimary: true ex2: summary: Modifying the security groups of a NIC value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Nic: - AccountId: '123456789012' - Description: Primary network interface - IsSourceDestChecked: true + SubregionName: eu-west-2a + SubnetId: subnet-12345678 + State: in-use LinkNic: + VmId: i-12345678 + LinkNicId: eni-attach-12345678 + VmAccountId: '123456789012' DeleteOnVmDeletion: true DeviceNumber: 0 - LinkNicId: eni-attach-12345678 State: attached - VmAccountId: '123456789012' - VmId: i-12345678 + IsSourceDestChecked: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + Tags: [] + Description: Primary network interface + AccountId: '123456789012' + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - IsPrimary: true - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - SecurityGroups: - - SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - State: in-use - SubnetId: subnet-12345678 - SubregionName: eu-west-2a - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + IsPrimary: true ex3: summary: Modifying the description of a NIC value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Nic: - AccountId: '123456789012' - Description: Example of description - IsSourceDestChecked: true + SubregionName: eu-west-2a + SubnetId: subnet-12345678 + State: in-use LinkNic: + VmId: i-12345678 + LinkNicId: eni-attach-12345678 + VmAccountId: '123456789012' DeleteOnVmDeletion: true DeviceNumber: 0 - LinkNicId: eni-attach-12345678 State: attached - VmAccountId: '123456789012' - VmId: i-12345678 + IsSourceDestChecked: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + Tags: [] + Description: Example of description + AccountId: '123456789012' + SecurityGroups: + - SecurityGroupName: default + SecurityGroupId: sg-12345678 MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - IsPrimary: true - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - SecurityGroups: - - SecurityGroupId: sg-12345678 - SecurityGroupName: default - State: in-use - SubnetId: subnet-12345678 - SubregionName: eu-west-2a - Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UpdateNicResponse" + IsPrimary: true description: The HTTP 200 response (OK). '400': content: @@ -24122,62 +24389,62 @@ paths: tags: - Nic "/UpdateRoute": - description: |- - Replaces an existing route within a route table in a Net.
- You must specify one of the following elements as the target:

+ post: + description: |- + Replaces an existing route within a route table in a Net.
+ You must specify one of the following elements as the target:

- * Net peering
- * NAT virtual machine (VM)
- * Internet service
- * Virtual gateway
- * NAT service
- * Network interface card (NIC)

+ * Net peering
+ * NAT virtual machine (VM)
+ * Internet service
+ * Virtual gateway
+ * NAT service
+ * Network interface card (NIC)

- The routing algorithm is based on the most specific match. - post: + The routing algorithm is based on the most specific match. operationId: UpdateRoute requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateRouteRequest" examples: ex1: summary: Updating a route to a virtual gateway value: + RouteTableId: rtb-12345678 DestinationIpRange: 198.51.100.0/24 GatewayId: vgw-12345678 - RouteTableId: rtb-12345678 - schema: - "$ref": "#/components/schemas/UpdateRouteRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateRouteResponse" examples: ex1: summary: Updating a route to a virtual gateway value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 RouteTable: + Routes: + - DestinationIpRange: 10.0.0.0/16 + CreationMethod: CreateRouteTable + State: active + - GatewayId: vgw-12345678 + DestinationIpRange: 198.51.100.0/24 + CreationMethod: CreateRoute + State: active LinkRouteTables: - - LinkRouteTableId: rtbassoc-12345678 + - RouteTableId: rtb-12345678 Main: false - RouteTableId: rtb-12345678 SubnetId: subnet-12345678 + LinkRouteTableId: rtbassoc-12345678 NetId: vpc-12345678 + Tags: [] RoutePropagatingVirtualGateways: [] RouteTableId: rtb-12345678 - Routes: - - CreationMethod: CreateRouteTable - DestinationIpRange: 10.0.0.0/16 - State: active - - CreationMethod: CreateRoute - DestinationIpRange: 198.51.100.0/24 - GatewayId: vgw-12345678 - State: active - Tags: [] - schema: - "$ref": "#/components/schemas/UpdateRouteResponse" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -24200,77 +24467,77 @@ paths: tags: - Route "/UpdateRoutePropagation": - description: Configures the propagation of routes to a specified route table of - a Net by a virtual gateway. post: + description: Configures the propagation of routes to a specified route table + of a Net by a virtual gateway. operationId: UpdateRoutePropagation requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateRoutePropagationRequest" examples: ex1: value: - Enable: true - RouteTableId: rtb-12345678 VirtualGatewayId: vgw-12345678 - schema: - "$ref": "#/components/schemas/UpdateRoutePropagationRequest" + RouteTableId: rtb-12345678 + Enable: true responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateRoutePropagationResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 RouteTable: + Routes: + - DestinationIpRange: 10.0.0.0/16 + CreationMethod: CreateRouteTable + State: active LinkRouteTables: - - LinkRouteTableId: rtbassoc-12345678 + - RouteTableId: rtb-12345678 Main: true - RouteTableId: rtb-12345678 + LinkRouteTableId: rtbassoc-12345678 NetId: vpc-12345678 + Tags: [] RoutePropagatingVirtualGateways: - VirtualGatewayId: vgw-12345678 RouteTableId: rtb-12345678 - Routes: - - CreationMethod: CreateRouteTable - DestinationIpRange: 10.0.0.0/16 - State: active - Tags: [] - schema: - "$ref": "#/components/schemas/UpdateRoutePropagationResponse" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - VirtualGateway "/UpdateRouteTableLink": - description: |- - Replaces the route table associated with a specific Subnet in a Net with another one.
- After the route table is replaced, the Subnet uses the routes in the new route table it is associated with. post: + description: |- + Replaces the route table associated with a specific Subnet in a Net with another one.
+ After the route table is replaced, the Subnet uses the routes in the new route table it is associated with. operationId: UpdateRouteTableLink requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateRouteTableLinkRequest" examples: ex1: value: LinkRouteTableId: rtbassoc-12345678 RouteTableId: rtb-12345678 - schema: - "$ref": "#/components/schemas/UpdateRouteTableLinkRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateRouteTableLinkResponse" examples: ex1: value: - LinkRouteTableId: rtbassoc-12345678 ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - schema: - "$ref": "#/components/schemas/UpdateRouteTableLinkResponse" + LinkRouteTableId: rtbassoc-12345678 description: The HTTP 200 response (OK). '400': content: @@ -24293,160 +24560,160 @@ paths: tags: - RouteTable "/UpdateServerCertificate": - description: Modifies the name and/or the path of a specified server certificate. post: + description: Modifies the name and/or the path of a specified server certificate. operationId: UpdateServerCertificate requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateServerCertificateRequest" examples: ex1: value: Name: server-cert-example NewName: new-name - schema: - "$ref": "#/components/schemas/UpdateServerCertificateRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateServerCertificateResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ServerCertificate: + Path: "/example/" Id: ABCDEFGHIJKLMNOPQRSTUVWXYZ1234 Name: new-name - Path: "/example/" - schema: - "$ref": "#/components/schemas/UpdateServerCertificateResponse" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - ServerCertificate "/UpdateSnapshot": - description: |- - Modifies the permissions for a specified snapshot.
- You must specify either the `Additions` or the `Removals` parameter.
- After sharing a snapshot with an account, the other account can create a copy of it that they own. For more information about copying snapshots, see [CreateSnapshot](#createsnapshot). post: + description: |- + Modifies the permissions for a specified snapshot.
+ You must specify either the `Additions` or the `Removals` parameter.
+ After sharing a snapshot with an account, the other account can create a copy of it that they own. For more information about copying snapshots, see [CreateSnapshot](#createsnapshot). operationId: UpdateSnapshot requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateSnapshotRequest" examples: ex1: summary: Adding permission value: + SnapshotId: snap-12345678 PermissionsToCreateVolume: Additions: AccountIds: - '987654321098' - SnapshotId: snap-12345678 ex2: summary: Removing permission value: + SnapshotId: snap-12345678 PermissionsToCreateVolume: Removals: AccountIds: - '987654321098' - SnapshotId: snap-12345678 ex3: summary: Making an image public to everyone value: + SnapshotId: snap-12345678 PermissionsToCreateVolume: Additions: GlobalPermission: true - SnapshotId: snap-12345678 ex4: summary: Making an image private to everyone value: + SnapshotId: snap-12345678 PermissionsToCreateVolume: Removals: GlobalPermission: true - SnapshotId: snap-12345678 - schema: - "$ref": "#/components/schemas/UpdateSnapshotRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateSnapshotResponse" examples: ex1: summary: Adding permission value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Snapshot: + VolumeSize: 10 AccountId: '123456789012' + VolumeId: vol-12345678 CreationDate: '2010-10-01T12:34:56.789Z' - Description: Snapshot created from a volume PermissionsToCreateVolume: + GlobalPermission: false AccountIds: - '987654321098' - GlobalPermission: false Progress: 100 SnapshotId: snap-12345678 State: completed + Description: Snapshot created from a volume Tags: [] - VolumeId: vol-12345678 - VolumeSize: 10 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Removing permission value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Snapshot: + VolumeSize: 10 AccountId: '123456789012' + VolumeId: vol-12345678 CreationDate: '2010-10-01T12:34:56.789Z' - Description: Snapshot created from a volume PermissionsToCreateVolume: - AccountIds: [] GlobalPermission: false + AccountIds: [] Progress: 100 SnapshotId: snap-12345678 State: completed + Description: Snapshot created from a volume Tags: [] - VolumeId: vol-12345678 - VolumeSize: 10 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex3: summary: Making an image public to everyone value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Snapshot: + VolumeSize: 10 AccountId: '123456789012' + VolumeId: vol-12345678 CreationDate: '2010-10-01T12:34:56.789Z' - Description: Snapshot created from a volume PermissionsToCreateVolume: - AccountIds: [] GlobalPermission: true + AccountIds: [] Progress: 100 SnapshotId: snap-12345678 State: completed + Description: Snapshot created from a volume Tags: [] - VolumeId: vol-12345678 - VolumeSize: 10 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex4: summary: Making an image private to everyone value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Snapshot: + VolumeSize: 10 AccountId: '123456789012' + VolumeId: vol-12345678 CreationDate: '2010-10-01T12:34:56.789Z' - Description: Snapshot created from a volume PermissionsToCreateVolume: - AccountIds: [] GlobalPermission: false + AccountIds: [] Progress: 100 SnapshotId: snap-12345678 State: completed + Description: Snapshot created from a volume Tags: [] - VolumeId: vol-12345678 - VolumeSize: 10 - schema: - "$ref": "#/components/schemas/UpdateSnapshotResponse" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -24469,39 +24736,39 @@ paths: tags: - Snapshot "/UpdateSubnet": - description: Modifies the specified attribute of a Subnet. post: + description: Modifies the specified attribute of a Subnet. operationId: UpdateSubnet requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateSubnetRequest" examples: ex1: value: - MapPublicIpOnLaunch: true SubnetId: subnet-12345678 - schema: - "$ref": "#/components/schemas/UpdateSubnetRequest" + MapPublicIpOnLaunch: true responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateSubnetResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Subnet: + Tags: [] + SubregionName: eu-west-2a + SubnetId: subnet-12345678 AvailableIpsCount: 16379 IpRange: 10.0.0.0/18 MapPublicIpOnLaunch: true - NetId: vpc-12345678 State: available - SubnetId: subnet-12345678 - SubregionName: eu-west-2a - Tags: [] - schema: - "$ref": "#/components/schemas/UpdateSubnetResponse" + NetId: vpc-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -24524,49 +24791,51 @@ paths: tags: - Subnet "/UpdateUser": - description: Modifies the name and/or the path of a specified EIM user. post: + description: Modifies the name and/or the path of a specified EIM user. operationId: UpdateUser requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateUserRequest" examples: ex1: value: - NewPath: "/product/" + UserName: example-user NewUserEmail: user@example.com NewUserName: test-user - UserName: example-user - schema: - "$ref": "#/components/schemas/UpdateUserRequest" + NewPath: "/product/" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateUserResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 User: CreationDate: 2010-10-01 12:34:56.789000000 +00:00 LastModificationDate: 2017-05-10 12:34:56.789000000 +00:00 - Path: "/product/" UserEmail: user@example.com - UserId: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 UserName: test-user - schema: - "$ref": "#/components/schemas/UpdateUserResponse" + UserId: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 + Path: "/product/" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - User "/UpdateUserGroup": - description: Modifies the name and/or the path of a specified group. post: + description: Modifies the name and/or the path of a specified group. operationId: UpdateUserGroup requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateUserGroupRequest" examples: ex1: value: @@ -24574,12 +24843,12 @@ paths: NewUserGroupName: new-usergroup Path: "/example/" UserGroupName: example-usergroup - schema: - "$ref": "#/components/schemas/UpdateUserGroupRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateUserGroupResponse" examples: ex1: value: @@ -24599,26 +24868,26 @@ paths: UserEmail: user@example.com UserId: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 UserName: example-user - schema: - "$ref": "#/components/schemas/UpdateUserGroupResponse" description: The HTTP 200 response (OK). tags: - UserGroup "/UpdateVm": - description: |- - Modifies the specified attributes of a virtual machine (VM).
- You must stop the VM before modifying the following attributes:
- * `NestedVirtualization`
- * `Performance`
- * `UserData`
- * `VmType` - - To complete the update of secure boot, you need to do a stop/start of the VM. A simple restart is not sufficient, as the update is done when the VM goes through the stopped state. For the difference between stop/start and restart, see [About VM Lifecycle](https://docs.outscale.com/en/userguide/About-VM-Lifecycle.html). post: + description: |- + Modifies the specified attributes of a virtual machine (VM).
+ You must stop the VM before modifying the following attributes:
+ * `NestedVirtualization`
+ * `Performance`
+ * `UserData`
+ * `VmType` + + To complete the update of secure boot, you need to do a stop/start of the VM. A simple restart is not sufficient, as the update is done when the VM goes through the stopped state. For the difference between stop/start and restart, see [About VM Lifecycle](https://docs.outscale.com/en/userguide/About-VM-Lifecycle.html). operationId: UpdateVm requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateVmRequest" examples: ex1: value: @@ -24626,159 +24895,157 @@ paths: VmType: tinav5.c2r2p2 ex2: value: - UserData: "..." VmId: i-12345678 - schema: - "$ref": "#/components/schemas/UpdateVmRequest" + UserData: "..." responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateVmResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Vm: - ActionsOnNextBoot: - SecureBoot: none + VmType: tinav5.c2r2p2 + VmInitiatedShutdownBehavior: stop + State: stopped + StateReason: '' + RootDeviceType: ebs + RootDeviceName: "/dev/sda1" + IsSourceDestChecked: true + KeypairName: keypair-example + ImageId: ami-12345678 + DeletionProtection: false Architecture: x86_64 + NestedVirtualization: false BlockDeviceMappings: - - Bsu: - DeleteOnVmDeletion: true - LinkDate: '2010-10-01T12:34:56.789Z' - State: attached + - DeviceName: "/dev/sda1" + Bsu: VolumeId: vol-12345678 - DeviceName: "/dev/sda1" - BsuOptimized: false - CreationDate: '2010-10-01T12:34:56.789Z' - DeletionProtection: false + State: attached + LinkDate: '2010-10-01T12:34:56.789Z' + DeleteOnVmDeletion: true + VmId: i-12345678 + ReservationId: r-12345678 Hypervisor: xen - ImageId: ami-12345678 - IsSourceDestChecked: true - KeypairName: keypair-example + Placement: + Tenancy: default + SubregionName: eu-west-2a + ProductCodes: + - '0001' + CreationDate: '2010-10-01T12:34:56.789Z' + UserData: '' + SubnetId: subnet-12345678 + PrivateIp: 10.0.0.4 + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 + BsuOptimized: false LaunchNumber: 0 - NestedVirtualization: false NetId: vpc-12345678 Nics: - - AccountId: '123456789012' - Description: Primary network interface - IsSourceDestChecked: true + - SubnetId: subnet-12345678 + State: in-use LinkNic: - DeleteOnVmDeletion: true + State: attached DeviceNumber: 0 LinkNicId: eni-attach-12345678 - State: attached + DeleteOnVmDeletion: true + IsSourceDestChecked: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + Description: Primary network interface + AccountId: '123456789012' + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - IsPrimary: true - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - SecurityGroups: - - SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - State: in-use - SubnetId: subnet-12345678 + IsPrimary: true Performance: high - Placement: - SubregionName: eu-west-2a - Tenancy: default - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal - PrivateIp: 10.0.0.4 - ProductCodes: - - '0001' - ReservationId: r-12345678 - RootDeviceName: "/dev/sda1" - RootDeviceType: ebs - SecurityGroups: - - SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - State: stopped - StateReason: '' - SubnetId: subnet-12345678 Tags: - - Key: env - Value: prod - UserData: '' - VmId: i-12345678 - VmInitiatedShutdownBehavior: stop - VmType: tinav5.c2r2p2 - ex2: - value: + - Value: prod + Key: env + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + ActionsOnNextBoot: + SecureBoot: none ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + value: Vm: - ActionsOnNextBoot: - SecureBoot: none + VmType: tinav5.c1r1p2 + VmInitiatedShutdownBehavior: stop + State: stopped + StateReason: '' + RootDeviceType: ebs + RootDeviceName: "/dev/sda1" + IsSourceDestChecked: true + KeypairName: keypair-example + ImageId: ami-12345678 + DeletionProtection: true Architecture: x86_64 + NestedVirtualization: false BlockDeviceMappings: - - Bsu: - DeleteOnVmDeletion: true - LinkDate: '2010-10-01T12:34:56.789Z' - State: attached + - DeviceName: "/dev/sda1" + Bsu: VolumeId: vol-12345678 - DeviceName: "/dev/sda1" - BsuOptimized: false - CreationDate: '2010-10-01T12:34:56.789Z' - DeletionProtection: true + State: attached + LinkDate: '2010-10-01T12:34:56.789Z' + DeleteOnVmDeletion: true + VmId: i-12345678 + ReservationId: r-12345678 Hypervisor: xen - ImageId: ami-12345678 - IsSourceDestChecked: true - KeypairName: keypair-example + Placement: + Tenancy: default + SubregionName: eu-west-2a + ProductCodes: + - '0001' + CreationDate: '2010-10-01T12:34:56.789Z' + UserData: "..." + SubnetId: subnet-12345678 + PrivateIp: 10.0.0.4 + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 + BsuOptimized: false LaunchNumber: 0 - NestedVirtualization: false NetId: vpc-12345678 Nics: - - AccountId: '123456789012' - Description: Primary network interface - IsSourceDestChecked: true + - SubnetId: subnet-12345678 + State: in-use LinkNic: - DeleteOnVmDeletion: true + State: attached DeviceNumber: 0 LinkNicId: eni-attach-12345678 - State: attached + DeleteOnVmDeletion: true + IsSourceDestChecked: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + Description: Primary network interface + AccountId: '123456789012' + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - IsPrimary: true - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - SecurityGroups: - - SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - State: in-use - SubnetId: subnet-12345678 + IsPrimary: true Performance: high - Placement: - SubregionName: eu-west-2a - Tenancy: default - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal - PrivateIp: 10.0.0.4 - ProductCodes: - - '0001' - ReservationId: r-12345678 - RootDeviceName: "/dev/sda1" - RootDeviceType: ebs - SecurityGroups: - - SecurityGroupId: sg-12345678 - SecurityGroupName: security-group-example - State: stopped - StateReason: '' - SubnetId: subnet-12345678 Tags: - - Key: env - Value: prod - UserData: "..." - VmId: i-12345678 - VmInitiatedShutdownBehavior: stop - VmType: tinav5.c1r1p2 - schema: - "$ref": "#/components/schemas/UpdateVmResponse" + - Value: prod + Key: env + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + ActionsOnNextBoot: + SecureBoot: none + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -24801,55 +25068,55 @@ paths: tags: - Vm "/UpdateVmGroup": - description: |- - > [WARNING]
- > This feature is currently under development and may not function properly.
- - Modifies the specified attributes of a group of virtual machines (VMs). post: + description: |- + > [WARNING]
+ > This feature is currently under development and may not function properly.
+ + Modifies the specified attributes of a group of virtual machines (VMs). operationId: UpdateVmGroup requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateVmGroupRequest" examples: ex1: summary: Updating the name and description of a VM group value: - Description: New description of the VM group VmGroupId: vmgroup-12345678901234567890123456789012 VmGroupName: new-name + Description: New description of the VM group ex2: summary: Updating the VM template of a VM group value: VmGroupId: vmgroup-12345678901234567890123456789012 VmTemplateId: vmtemplate-98765432109876543210987654321012 - schema: - "$ref": "#/components/schemas/UpdateVmGroupRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateVmGroupResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VmGroup: - CreationDate: 2010-10-01 12:34:56.789000000 +00:00 - Description: New description of the VM group - PositioningStrategy: attract + VmTemplateId: vmtemplate-98765432109876543210987654321012 SecurityGroupIds: - sg-12345678 - State: available - SubnetId: subnet-12345678 - Tags: [] + VmIds: [] + CreationDate: 2010-10-01 12:34:56.789000000 +00:00 VmCount: 2 - VmGroupId: vmgroup-12345678901234567890123456789012 VmGroupName: new-name - VmIds: [] - VmTemplateId: vmtemplate-98765432109876543210987654321012 - schema: - "$ref": "#/components/schemas/UpdateVmGroupResponse" + SubnetId: subnet-12345678 + PositioningStrategy: attract + State: available + VmGroupId: vmgroup-12345678901234567890123456789012 + Description: New description of the VM group + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -24872,112 +25139,112 @@ paths: tags: - VmGroup "/UpdateVmTemplate": - description: |- - > [WARNING]
- > This feature is currently under development and may not function properly.
- - Modifies the specified attributes of a template of virtual machines (VMs). post: + description: |- + > [WARNING]
+ > This feature is currently under development and may not function properly.
+ + Modifies the specified attributes of a template of virtual machines (VMs). operationId: UpdateVmTemplate requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateVmTemplateRequest" examples: ex1: value: Description: The new description of the VM template VmTemplateId: vmtemplate-98765432109876543210987654321012 VmTemplateName: second-name - schema: - "$ref": "#/components/schemas/UpdateVmTemplateRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateVmTemplateResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VmTemplate: - CpuCores: 2 - CpuGeneration: v4 + VmTemplateName: second-name CpuPerformance: high CreationDate: 2010-10-01 12:34:56.789000000 +00:00 + CpuCores: 2 + Tags: [] Description: The new description of the VM template ImageId: ami-12345678 - Ram: 2 - Tags: [] + CpuGeneration: v4 VmTemplateId: vmtemplate-98765432109876543210987654321012 - VmTemplateName: second-name - schema: - "$ref": "#/components/schemas/UpdateVmTemplateResponse" + Ram: 2 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - VmTemplate "/UpdateVolume": - description: |- - Modifies the specified attributes of a volume.
- Cold volumes are volumes that are attached to stopped or stopping VMs, or that are detached. Hot volumes are volumes that are attached to running VMs.

- - **[NOTE]**
- When the modification is not instantaneous, the response displays the previous value. You can use the [ReadVolumes](#readvolumes) method to see the new value. post: + description: |- + Modifies the specified attributes of a volume.
+ Cold volumes are volumes that are attached to stopped or stopping VMs, or that are detached. Hot volumes are volumes that are attached to running VMs.

+ + **[NOTE]**
+ When the modification is not instantaneous, the response displays the previous value. You can use the [ReadVolumes](#readvolumes) method to see the new value. operationId: UpdateVolume requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateVolumeRequest" examples: ex1: summary: Updating the size of a volume value: - Size: 50 VolumeId: vol-12345678 + Size: 50 ex2: summary: Updating the type of a volume to io1 value: - Iops: 200 VolumeId: vol-12345678 VolumeType: io1 - schema: - "$ref": "#/components/schemas/UpdateVolumeRequest" + Iops: 200 responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateVolumeResponse" examples: ex1: summary: Updating the size of a volume value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Volume: + VolumeId: vol-12345678 + Tags: [] + VolumeType: gp2 + SubregionName: eu-west-2a + State: available CreationDate: '2010-10-01T12:34:56.789Z' Iops: 100 LinkedVolumes: [] Size: 10 - State: available - SubregionName: eu-west-2a - Tags: [] - VolumeId: vol-12345678 - VolumeType: gp2 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Updating the type of a volume to io1 value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Volume: + VolumeId: vol-12345678 + Tags: [] + VolumeType: io1 + SubregionName: eu-west-2a + State: available CreationDate: '2010-10-01T12:34:56.789Z' Iops: 200 LinkedVolumes: [] Size: 10 - State: available - SubregionName: eu-west-2a - Tags: [] - VolumeId: vol-12345678 - VolumeType: io1 - schema: - "$ref": "#/components/schemas/UpdateVolumeResponse" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -25000,48 +25267,48 @@ paths: tags: - Volume "/UpdateVpnConnection": - description: Modifies the specified attributes of a VPN connection. post: + description: Modifies the specified attributes of a VPN connection. operationId: UpdateVpnConnection requestBody: content: application/json: + schema: + "$ref": "#/components/schemas/UpdateVpnConnectionRequest" examples: ex1: value: VpnConnectionId: vpn-12345678 VpnOptions: TunnelInsideIpRange: 169.254.254.22/30 - schema: - "$ref": "#/components/schemas/UpdateVpnConnectionRequest" responses: '200': content: application/json: + schema: + "$ref": "#/components/schemas/UpdateVpnConnectionResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VpnConnection: + VpnOptions: + TunnelInsideIpRange: 169.254.254.22/30 + Routes: [] + Tags: [] ClientGatewayConfiguration: "..." - ClientGatewayId: cgw-12345678 + StaticRoutesOnly: true + VirtualGatewayId: vgw-12345678 ConnectionType: ipsec.1 - Routes: [] + ClientGatewayId: cgw-12345678 State: pending - StaticRoutesOnly: true - Tags: [] VgwTelemetries: - - AcceptedRouteCount: 0 + - StateDescription: IPSEC IS DOWN + AcceptedRouteCount: 0 LastStateChangeDate: '2017-05-10T12:34:56.789Z' OutsideIpAddress: 192.0.2.0 - StateDescription: IPSEC IS DOWN - VirtualGatewayId: vgw-12345678 VpnConnectionId: vpn-12345678 - VpnOptions: - TunnelInsideIpRange: 169.254.254.22/30 - schema: - "$ref": "#/components/schemas/UpdateVpnConnectionResponse" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: