diff --git a/old-outscale.yaml b/old-outscale.yaml index ce8c03c..2b82876 100644 --- a/old-outscale.yaml +++ b/old-outscale.yaml @@ -1,10 +1,12 @@ +--- components: schemas: AcceptNetPeeringRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean NetPeeringId: description: The ID of the Net peering you want to accept. @@ -16,9 +18,9 @@ components: additionalProperties: false properties: NetPeering: - $ref: '#/components/schemas/NetPeering' + "$ref": "#/components/schemas/NetPeering" ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object AccepterNet: additionalProperties: false @@ -28,7 +30,8 @@ components: description: The account ID of the owner of the accepter Net. type: string IpRange: - description: The IP range for the accepter Net, in CIDR notation (for example, `10.0.0.0/16`). + description: The IP range for the accepter Net, in CIDR notation (for example, + `10.0.0.0/16`). type: string NetId: description: The ID of the accepter Net. @@ -50,11 +53,13 @@ components: format: datetime type: string LastModificationDate: - description: The date and time (UTC) of the last modification of the access key. + description: The date and time (UTC) of the last modification of the access + key. format: datetime type: string State: - description: The state of the access key (`ACTIVE` if the key is valid for API calls, or `INACTIVE` if not). + description: The state of the access key (`ACTIVE` if the key is valid for + API calls, or `INACTIVE` if not). type: string type: object AccessKeySecretKey: @@ -73,14 +78,16 @@ components: format: datetime type: string LastModificationDate: - description: The date and time (UTC) of the last modification of the access key. + description: The date and time (UTC) of the last modification of the access + key. format: datetime type: string SecretKey: description: The access key that enables you to send requests. type: string State: - description: The state of the access key (`ACTIVE` if the key is valid for API calls, or `INACTIVE` if not). + description: The state of the access key (`ACTIVE` if the key is valid for + API calls, or `INACTIVE` if not). type: string type: object AccessLog: @@ -88,16 +95,21 @@ components: description: Information about access logs. properties: IsEnabled: - description: If true, access logs are enabled for your load balancer. If false, they are not. If you set this to true in your request, the `OsuBucketName` parameter is required. + description: If true, access logs are enabled for your load balancer. If + false, they are not. If you set this to true in your request, the `OsuBucketName` + parameter is required. type: boolean OsuBucketName: description: The name of the OOS bucket for the access logs. type: string OsuBucketPrefix: - description: The path to the folder of the access logs in your OOS bucket (by default, the `root` level of your bucket). + description: The path to the folder of the access logs in your OOS bucket + (by default, the `root` level of your bucket). type: string PublicationInterval: - description: The time interval for the publication of access logs in the OOS bucket, in minutes. This value can be either `5` or `60` (by default, `60`). + description: The time interval for the publication of access logs in the + OOS bucket, in minutes. This value can be either `5` or `60` (by default, + `60`). type: integer type: object Account: @@ -108,9 +120,10 @@ components: description: The ID of the account. type: string AdditionalEmails: - description: One or more additional email addresses for the account. These addresses are used for notifications only. + description: One or more additional email addresses for the account. These + addresses are used for notifications only. items: - pattern: ^.+@[a-zA-Z0-9-]+(?:\.[a-zA-Z0-9-]+)+$ + pattern: "^.+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)+$" type: string type: array City: @@ -126,7 +139,8 @@ components: description: The ID of the customer. type: string Email: - description: The main email address for the account. This address is used for your credentials and for notifications. + description: The main email address for the account. This address is used + for your credentials and for notifications. type: string FirstName: description: The first name of the account owner. @@ -158,11 +172,15 @@ components: description: Information about the API access policy. properties: MaxAccessKeyExpirationSeconds: - description: The maximum possible lifetime for your access keys, in seconds. If `0`, your access keys can have unlimited lifetimes. + description: The maximum possible lifetime for your access keys, in seconds. + If `0`, your access keys can have unlimited lifetimes. format: int64 type: integer RequireTrustedEnv: - description: If true, a trusted session is activated, allowing you to bypass Certificate Authorities (CAs) enforcement. For more information, see the `ApiKeyAuth` authentication scheme in the [Authentication](#authentication) section. + description: If true, a trusted session is activated, allowing you to bypass + Certificate Authorities (CAs) enforcement. For more information, see the + `ApiKeyAuth` authentication scheme in the [Authentication](#authentication) + section. type: boolean type: object ApiAccessRule: @@ -170,10 +188,11 @@ components: description: Information about the API access rule. properties: ApiAccessRuleId: - description: ' The ID of the API access rule.' + description: " The ID of the API access rule." type: string CaIds: - description: One or more IDs of Client Certificate Authorities (CAs) used for the API access rule. + description: One or more IDs of Client Certificate Authorities (CAs) used + for the API access rule. items: type: string type: array @@ -186,7 +205,8 @@ components: description: The description of the API access rule. type: string IpRanges: - description: One or more IP ranges used for the API access rule, in CIDR notation (for example, `192.0.2.0/16`). + description: One or more IP ranges used for the API access rule, in CIDR + notation (for example, `192.0.2.0/16`). items: type: string type: array @@ -199,7 +219,8 @@ components: description: The name of the application cookie used for stickiness. type: string PolicyName: - description: The mnemonic name for the policy being created. The name must be unique within a set of policies for this load balancer. + description: The mnemonic name for the policy being created. The name must + be unique within a set of policies for this load balancer. type: string type: object BackendVmHealth: @@ -210,12 +231,13 @@ components: description: The description of the state of the back-end VM. type: string State: - description: The state of the back-end VM (`InService` \| `OutOfService` \| `Unknown`). + description: The state of the back-end VM (`InService` \| `OutOfService` + \| `Unknown`). type: string StateReason: - description: 'Information about the cause of `OutOfService` VMs.
- - Specifically, whether the cause is Elastic Load Balancing or the VM (`ELB` \| `Instance` \| `N/A`).' + description: |- + Information about the cause of `OutOfService` VMs.
+ Specifically, whether the cause is Elastic Load Balancing or the VM (`ELB` \| `Instance` \| `N/A`). type: string VmId: description: The ID of the back-end VM. @@ -226,19 +248,23 @@ components: description: Information about the created block device mapping. properties: Bsu: - $ref: '#/components/schemas/BsuCreated' + "$ref": "#/components/schemas/BsuCreated" DeviceName: description: The name of the device. type: string type: object BlockDeviceMappingImage: additionalProperties: false - description: One or more parameters used to automatically set up volumes when the VM is created. + description: One or more parameters used to automatically set up volumes when + the VM is created. properties: Bsu: - $ref: '#/components/schemas/BsuToCreate' + "$ref": "#/components/schemas/BsuToCreate" DeviceName: - description: The device name for the volume. For a root device, you must use `/dev/sda1`. For other volumes, you must use `/dev/sdX`, `/dev/sdXX`, `/dev/xvdX`, or `/dev/xvdXX` (where the first `X` is a letter between `b` and `z`, and the second `X` is a letter between `a` and `z`). + description: The device name for the volume. For a root device, you must + use `/dev/sda1`. For other volumes, you must use `/dev/sdX`, `/dev/sdXX`, + `/dev/xvdX`, or `/dev/xvdXX` (where the first `X` is a letter between + `b` and `z`, and the second `X` is a letter between `a` and `z`). type: string VirtualDeviceName: description: The name of the virtual device (`ephemeralN`). @@ -249,12 +275,16 @@ components: description: Information about the block device mapping. properties: Bsu: - $ref: '#/components/schemas/BsuToCreate' + "$ref": "#/components/schemas/BsuToCreate" DeviceName: - description: The device name for the volume. For a root device, you must use `/dev/sda1`. For other volumes, you must use `/dev/sdX`, `/dev/sdXX`, `/dev/xvdX`, or `/dev/xvdXX` (where the first `X` is a letter between `b` and `z`, and the second `X` is a letter between `a` and `z`). + description: The device name for the volume. For a root device, you must + use `/dev/sda1`. For other volumes, you must use `/dev/sdX`, `/dev/sdXX`, + `/dev/xvdX`, or `/dev/xvdXX` (where the first `X` is a letter between + `b` and `z`, and the second `X` is a letter between `a` and `z`). type: string NoDevice: - description: Removes the device which is included in the block device mapping of the OMI. + description: Removes the device which is included in the block device mapping + of the OMI. type: string VirtualDeviceName: description: The name of the virtual device (`ephemeralN`). @@ -265,12 +295,16 @@ components: description: Information about the block device mapping. properties: Bsu: - $ref: '#/components/schemas/BsuToUpdateVm' + "$ref": "#/components/schemas/BsuToUpdateVm" DeviceName: - description: The device name for the volume. For a root device, you must use `/dev/sda1`. For other volumes, you must use `/dev/sdX`, `/dev/sdXX`, `/dev/xvdX`, or `/dev/xvdXX` (where the first `X` is a letter between `b` and `z`, and the second `X` is a letter between `a` and `z`). + description: The device name for the volume. For a root device, you must + use `/dev/sda1`. For other volumes, you must use `/dev/sdX`, `/dev/sdXX`, + `/dev/xvdX`, or `/dev/xvdXX` (where the first `X` is a letter between + `b` and `z`, and the second `X` is a letter between `a` and `z`). type: string NoDevice: - description: Removes the device which is included in the block device mapping of the OMI. + description: Removes the device which is included in the block device mapping + of the OMI. type: string VirtualDeviceName: description: The name of the virtual device (`ephemeralN`). @@ -281,10 +315,12 @@ components: description: Information about the created BSU volume. properties: DeleteOnVmDeletion: - description: If true, the volume is deleted when terminating the VM. If false, the volume is not deleted when terminating the VM. + description: If true, the volume is deleted when terminating the VM. If + false, the volume is not deleted when terminating the VM. type: boolean LinkDate: - description: The date and time of attachment of the volume to the VM, in ISO 8601 date-time format. + description: The date and time of attachment of the volume to the VM, in + ISO 8601 date-time format. format: date type: string State: @@ -300,25 +336,28 @@ 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: 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. type: boolean Iops: - description: The number of I/O operations per second (IOPS). This parameter must be specified only if you create an `io1` volume. The maximum number of IOPS allowed for `io1` volumes is `13000` with a maximum performance ratio of 300 IOPS per gibibyte. + description: The number of I/O operations per second (IOPS). This parameter + must be specified only if you create an `io1` volume. The maximum number + of IOPS allowed for `io1` volumes is `13000` with a maximum performance + ratio of 300 IOPS per gibibyte. type: integer SnapshotId: description: The ID of the snapshot used to create the volume. type: string VolumeSize: - description: 'The size of the volume, in gibibytes (GiB).
- + description: |- + The size of the volume, in gibibytes (GiB).
If you specify a snapshot ID, the volume size must be at least equal to the snapshot size.
- - If you specify a snapshot ID but no volume size, the volume is created with a size similar to the snapshot one.' + If you specify a snapshot ID but no volume size, the volume is created with a size similar to the snapshot one. type: integer VolumeType: - description: 'The type of the volume (`standard` \| `io1` \| `gp2`). If not specified in the request, a `standard` volume is created.
- - For more information about volume types, see [About Volumes > Volume Types and IOPS](https://docs.outscale.com/en/userguide/About-Volumes.html#_volume_types_and_iops).' + description: |- + The type of the volume (`standard` \| `io1` \| `gp2`). If not specified in the request, a `standard` volume is created.
+ For more information about volume types, see [About Volumes > Volume Types and IOPS](https://docs.outscale.com/en/userguide/About-Volumes.html#_volume_types_and_iops). type: string type: object BsuToUpdateVm: @@ -326,7 +365,8 @@ components: description: Information about the BSU volume. properties: DeleteOnVmDeletion: - description: If set to true, the volume is deleted when terminating the VM. If set to false, the volume is not deleted when terminating the VM. + description: If set to true, the volume is deleted when terminating the + VM. If set to false, the volume is not deleted when terminating the VM. type: boolean VolumeId: description: The ID of the volume. @@ -353,7 +393,7 @@ components: Entries: description: One or more catalog entries. items: - $ref: '#/components/schemas/CatalogEntry' + "$ref": "#/components/schemas/CatalogEntry" type: array type: object CatalogEntry: @@ -364,13 +404,16 @@ components: description: The category of the catalog entry (for example, `network`). type: string Flags: - description: When returned and equal to `PER_MONTH`, the price of the catalog entry is calculated on a monthly basis. + description: When returned and equal to `PER_MONTH`, the price of the catalog + entry is calculated on a monthly basis. type: string Operation: - description: The API call associated with the catalog entry (for example, `CreateVms` or `RunInstances`). + description: The API call associated with the catalog entry (for example, + `CreateVms` or `RunInstances`). type: string Service: - description: The service associated with the catalog entry (`TinaOS-FCU`, `TinaOS-LBU`, `TinaOS-DirectLink`, or `TinaOS-OOS`). + description: The service associated with the catalog entry (`TinaOS-FCU`, + `TinaOS-LBU`, `TinaOS-DirectLink`, or `TinaOS-OOS`). type: string SubregionName: description: The Subregion associated with the catalog entry. @@ -382,7 +425,8 @@ components: description: The type of resource associated with the catalog entry. type: string UnitPrice: - description: The unit price of the catalog entry, in the currency of the catalog of the Region where the API method was used. + description: The unit price of the catalog entry, in the currency of the + catalog of the Region where the API method was used. format: float type: number type: object @@ -393,7 +437,7 @@ components: Entries: description: One or more catalog entries. items: - $ref: '#/components/schemas/CatalogEntry' + "$ref": "#/components/schemas/CatalogEntry" type: array FromDate: description: The beginning of the time period, in ISO 8601 date-time format. @@ -414,7 +458,8 @@ components: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Login: description: The email address of the account. @@ -430,36 +475,41 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object ClientGateway: additionalProperties: false description: Information about the client gateway. properties: BgpAsn: - description: The Autonomous System Number (ASN) used by the Border Gateway Protocol (BGP) to find the path to your client gateway through the Internet. + description: The Autonomous System Number (ASN) used by the Border Gateway + Protocol (BGP) to find the path to your client gateway through the Internet. type: integer ClientGatewayId: description: The ID of the client gateway. type: string ConnectionType: - description: The type of communication tunnel used by the client gateway (only `ipsec.1` is supported). + description: The type of communication tunnel used by the client gateway + (only `ipsec.1` is supported). type: string PublicIp: - description: The public IPv4 address of the client gateway (must be a fixed address into a NATed network). + description: The public IPv4 address of the client gateway (must be a fixed + address into a NATed network). type: string State: - description: The state of the client gateway (`pending` \| `available` \| `deleting` \| `deleted`). + description: The state of the client gateway (`pending` \| `available` \| + `deleting` \| `deleted`). type: string Tags: description: One or more tags associated with the client gateway. items: - $ref: '#/components/schemas/ResourceTag' + "$ref": "#/components/schemas/ResourceTag" type: array type: object ConsumptionEntry: additionalProperties: false - description: Information about the resources consumed during the specified time period. + description: Information about the resources consumed during the specified time + period. properties: AccountId: description: The ID of your TINA account. @@ -472,13 +522,16 @@ components: format: datetime type: string Operation: - description: The API call that triggered the resource consumption (for example, `RunInstances` or `CreateVolume`). + description: The API call that triggered the resource consumption (for example, + `RunInstances` or `CreateVolume`). type: string PayingAccountId: - description: The ID of the TINA account which is billed for your consumption. It can be different from your account in the `AccountId` parameter. + description: The ID of the TINA account which is billed for your consumption. + It can be different from your account in the `AccountId` parameter. type: string Service: - description: The service of the API call (`TinaOS-FCU`, `TinaOS-LBU`, `TinaOS-DirectLink`, `TinaOS-OOS`, or `TinaOS-OSU`). + description: The service of the API call (`TinaOS-FCU`, `TinaOS-LBU`, `TinaOS-DirectLink`, + `TinaOS-OOS`, or `TinaOS-OSU`). type: string SubregionName: description: The name of the Subregion. @@ -494,7 +547,8 @@ components: description: The type of resource, depending on the API call. type: string Value: - description: The consumed amount for the resource. The unit depends on the resource type. For more information, see the `Title` element. + description: The consumed amount for the resource. The unit depends on the + resource type. For more information, see the `Title` element. format: double type: number type: object @@ -502,28 +556,40 @@ components: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean ExpirationDate: - description: The date and time, or the date, at which you want the access key to expire, in ISO 8601 format (for example, `2020-06-14T00:00:00.000Z`, or `2020-06-14`). To remove an existing expiration date, use the method without specifying this parameter. + description: The date and time, or the date, at which you want the access + key to expire, in ISO 8601 format (for example, `2020-06-14T00:00:00.000Z`, + or `2020-06-14`). To remove an existing expiration date, use the method + without specifying this parameter. format: datetime type: string + UserName: + description: The name of the EIM user that owns the key to be created. If + you do not specify a user name, this action creates an access key for + the user who sends the request (which can be the root account). + type: string type: object CreateAccessKeyResponse: additionalProperties: false properties: AccessKey: - $ref: '#/components/schemas/AccessKeySecretKey' + "$ref": "#/components/schemas/AccessKeySecretKey" ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object CreateAccountRequest: additionalProperties: false properties: AdditionalEmails: - description: One or more additional email addresses for the account. These addresses are used for notifications only. If you already have a list of additional emails registered, you cannot add to it, only replace it. To remove all registered additional emails, specify an empty list. + description: One or more additional email addresses for the account. These + addresses are used for notifications only. If you already have a list + of additional emails registered, you cannot add to it, only replace it. + To remove all registered additional emails, specify an empty list. items: - pattern: ^.+@[a-zA-Z0-9-]+(?:\.[a-zA-Z0-9-]+)+$ + pattern: "^.+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)+$" type: string type: array City: @@ -539,10 +605,12 @@ components: description: The ID of the customer. It must be 8 digits. type: string DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Email: - description: The main email address for the account. This address is used for your credentials and notifications. + description: The main email address for the account. This address is used + for your credentials and notifications. type: string FirstName: description: The first name of the account owner. @@ -582,20 +650,21 @@ components: additionalProperties: false properties: Account: - $ref: '#/components/schemas/Account' + "$ref": "#/components/schemas/Account" ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object CreateApiAccessRuleRequest: additionalProperties: false properties: CaIds: - description: ' One or more IDs of Client Certificate Authorities (CAs).' + description: " One or more IDs of Client Certificate Authorities (CAs)." items: type: string type: array Cns: - description: One or more Client Certificate Common Names (CNs). If this parameter is specified, you must also specify the `CaIds` parameter. + description: One or more Client Certificate Common Names (CNs). If this + parameter is specified, you must also specify the `CaIds` parameter. items: type: string type: array @@ -603,7 +672,8 @@ components: description: A description for the API access rule. type: string DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean IpRanges: description: One or more IP addresses or CIDR blocks (for example, `192.0.2.0/16`). @@ -615,21 +685,24 @@ components: additionalProperties: false properties: ApiAccessRule: - $ref: '#/components/schemas/ApiAccessRule' + "$ref": "#/components/schemas/ApiAccessRule" ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object CreateCaRequest: additionalProperties: false properties: CaPem: - description: 'The CA in PEM format.
With OSC CLI, use the following syntax to make sure your CA file is correctly parsed: `--CaPem="$(cat FILENAME)"`.' + description: 'The CA in PEM format.
With OSC CLI, use the following + syntax to make sure your CA file is correctly parsed: `--CaPem="$(cat + FILENAME)"`.' type: string Description: description: The description of the CA. type: string DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean required: - CaPem @@ -638,21 +711,25 @@ components: additionalProperties: false properties: Ca: - $ref: '#/components/schemas/Ca' + "$ref": "#/components/schemas/Ca" ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object CreateClientGatewayRequest: additionalProperties: false properties: BgpAsn: - description: The Autonomous System Number (ASN) used by the Border Gateway Protocol (BGP) to find the path to your client gateway through the Internet. This number must be between `1` and `4294967295`. + description: The Autonomous System Number (ASN) used by the Border Gateway + Protocol (BGP) to find the path to your client gateway through the Internet. + This number must be between `1` and `4294967295`. type: integer ConnectionType: - description: The communication protocol used to establish tunnel with your client gateway (only `ipsec.1` is supported). + description: The communication protocol used to establish tunnel with your + client gateway (only `ipsec.1` is supported). type: string DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean PublicIp: description: The public fixed IPv4 address of your client gateway. @@ -666,31 +743,42 @@ components: additionalProperties: false properties: ClientGateway: - $ref: '#/components/schemas/ClientGateway' + "$ref": "#/components/schemas/ClientGateway" ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object CreateDhcpOptionsRequest: additionalProperties: false properties: DomainName: - description: 'Specify a domain name (for example, `MyCompany.com`). You can specify only one domain name. You must specify at least one of the following parameters: `DomainName`, `DomainNameServers`, `LogServers`, or `NtpServers`.' + description: 'Specify a domain name (for example, `MyCompany.com`). You + can specify only one domain name. You must specify at least one of the + following parameters: `DomainName`, `DomainNameServers`, `LogServers`, + or `NtpServers`.' type: string DomainNameServers: - description: 'The IPs of domain name servers. If no IPs are specified, the `OutscaleProvidedDNS` value is set by default. You must specify at least one of the following parameters: `DomainName`, `DomainNameServers`, `LogServers`, or `NtpServers`.' + description: 'The IPs of domain name servers. If no IPs are specified, the + `OutscaleProvidedDNS` value is set by default. You must specify at least + one of the following parameters: `DomainName`, `DomainNameServers`, `LogServers`, + or `NtpServers`.' items: type: string type: array DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean LogServers: - description: 'The IPs of the log servers. You must specify at least one of the following parameters: `DomainName`, `DomainNameServers`, `LogServers`, or `NtpServers`.' + description: 'The IPs of the log servers. You must specify at least one + of the following parameters: `DomainName`, `DomainNameServers`, `LogServers`, + or `NtpServers`.' items: type: string type: array NtpServers: - description: 'The IPs of the Network Time Protocol (NTP) servers. You must specify at least one of the following parameters: `DomainName`, `DomainNameServers`, `LogServers`, or `NtpServers`.' + description: 'The IPs of the Network Time Protocol (NTP) servers. You must + specify at least one of the following parameters: `DomainName`, `DomainNameServers`, + `LogServers`, or `NtpServers`.' items: type: string type: array @@ -699,20 +787,22 @@ components: additionalProperties: false properties: DhcpOptionsSet: - $ref: '#/components/schemas/DhcpOptionsSet' + "$ref": "#/components/schemas/DhcpOptionsSet" ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object CreateDirectLinkInterfaceRequest: additionalProperties: false properties: DirectLinkId: - description: The ID of the existing DirectLink for which you want to create the DirectLink interface. + description: The ID of the existing DirectLink for which you want to create + the DirectLink interface. type: string DirectLinkInterface: - $ref: '#/components/schemas/DirectLinkInterface' + "$ref": "#/components/schemas/DirectLinkInterface" DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean required: - DirectLinkId @@ -722,9 +812,9 @@ components: additionalProperties: false properties: DirectLinkInterface: - $ref: '#/components/schemas/DirectLinkInterfaces' + "$ref": "#/components/schemas/DirectLinkInterfaces" ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object CreateDirectLinkRequest: additionalProperties: false @@ -736,10 +826,12 @@ components: description: The name of the DirectLink. type: string DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Location: - description: The code of the requested location for the DirectLink, returned by the [ReadLocations](#readlocations) method. + description: The code of the requested location for the DirectLink, returned + by the [ReadLocations](#readlocations) method. type: string required: - Bandwidth @@ -750,9 +842,9 @@ components: additionalProperties: false properties: DirectLink: - $ref: '#/components/schemas/DirectLink' + "$ref": "#/components/schemas/DirectLink" ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object CreateFlexibleGpuRequest: additionalProperties: false @@ -762,13 +854,18 @@ components: description: If true, the fGPU is deleted when the VM is terminated. type: boolean DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Generation: - description: The processor generation that the fGPU must be compatible with. If not specified, the oldest possible processor generation is selected (as provided by [ReadFlexibleGpuCatalog](#readflexiblegpucatalog) for the specified model of fGPU). + description: The processor generation that the fGPU must be compatible with. + If not specified, the oldest possible processor generation is selected + (as provided by [ReadFlexibleGpuCatalog](#readflexiblegpucatalog) for + the specified model of fGPU). type: string ModelName: - description: The model of fGPU you want to allocate. For more information, see [About Flexible GPUs](https://docs.outscale.com/en/userguide/About-Flexible-GPUs.html). + description: The model of fGPU you want to allocate. For more information, + see [About Flexible GPUs](https://docs.outscale.com/en/userguide/About-Flexible-GPUs.html). type: string SubregionName: description: The Subregion in which you want to create the fGPU. @@ -781,21 +878,22 @@ components: additionalProperties: false properties: FlexibleGpu: - $ref: '#/components/schemas/FlexibleGpu' + "$ref": "#/components/schemas/FlexibleGpu" ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object CreateImageExportTaskRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean ImageId: description: The ID of the OMI to export. type: string OsuExport: - $ref: '#/components/schemas/OsuExportToCreate' + "$ref": "#/components/schemas/OsuExportToCreate" required: - OsuExport - ImageId @@ -804,37 +902,43 @@ components: additionalProperties: false properties: ImageExportTask: - $ref: '#/components/schemas/ImageExportTask' + "$ref": "#/components/schemas/ImageExportTask" ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object CreateImageRequest: additionalProperties: false properties: Architecture: - description: The architecture of the OMI (by default, `i386` if you specified the `FileLocation` or `RootDeviceName` parameter). + description: The architecture of the OMI (by default, `i386` if you specified + the `FileLocation` or `RootDeviceName` parameter). type: string BlockDeviceMappings: description: One or more block device mappings. items: - $ref: '#/components/schemas/BlockDeviceMappingImage' + "$ref": "#/components/schemas/BlockDeviceMappingImage" type: array Description: description: A description for the new OMI. type: string DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean FileLocation: - description: 'The pre-signed URL of the OMI manifest file, or the full path to the OMI stored in a bucket. If you specify this parameter, a copy of the OMI is created in your account. You must specify only one of the following parameters: `FileLocation`, `RootDeviceName`, `SourceImageId` or `VmId`.' + description: 'The pre-signed URL of the OMI manifest file, or the full path + to the OMI stored in a bucket. If you specify this parameter, a copy of + the OMI is created in your account. You must specify only one of the following + parameters: `FileLocation`, `RootDeviceName`, `SourceImageId` or `VmId`.' type: string ImageName: - description: 'A unique name for the new OMI.
- - Constraints: 3-128 alphanumeric characters, underscores (_), spaces ( ), parentheses (()), slashes (/), periods (.), or dashes (-).' + description: |- + A unique name for the new OMI.
+ Constraints: 3-128 alphanumeric characters, underscores (_), spaces ( ), parentheses (()), slashes (/), periods (.), or dashes (-). type: string NoReboot: - description: If false, the VM shuts down before creating the OMI and then reboots. If true, the VM does not. + description: If false, the VM shuts down before creating the OMI and then + reboots. If true, the VM does not. type: boolean ProductCodes: description: The product codes associated with the OMI. @@ -842,49 +946,59 @@ components: type: string type: array RootDeviceName: - description: 'The name of the root device. You must specify only one of the following parameters: `FileLocation`, `RootDeviceName`, `SourceImageId` or `VmId`.' + description: 'The name of the root device. You must specify only one of + the following parameters: `FileLocation`, `RootDeviceName`, `SourceImageId` + or `VmId`.' type: string SourceImageId: - description: 'The ID of the OMI you want to copy. You must specify only one of the following parameters: `FileLocation`, `RootDeviceName`, `SourceImageId` or `VmId`.' + description: 'The ID of the OMI you want to copy. You must specify only + one of the following parameters: `FileLocation`, `RootDeviceName`, `SourceImageId` + or `VmId`.' type: string SourceRegionName: - description: The name of the source Region, which must be the same as the Region of your account. + description: The name of the source Region, which must be the same as the + Region of your account. type: string VmId: - description: 'The ID of the VM from which you want to create the OMI. You must specify only one of the following parameters: `FileLocation`, `RootDeviceName`, `SourceImageId` or `VmId`.' + description: 'The ID of the VM from which you want to create the OMI. You + must specify only one of the following parameters: `FileLocation`, `RootDeviceName`, + `SourceImageId` or `VmId`.' type: string type: object CreateImageResponse: additionalProperties: false properties: Image: - $ref: '#/components/schemas/Image' + "$ref": "#/components/schemas/Image" ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object CreateInternetServiceRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean type: object CreateInternetServiceResponse: additionalProperties: false properties: InternetService: - $ref: '#/components/schemas/InternetService' + "$ref": "#/components/schemas/InternetService" ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object CreateKeypairRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean KeypairName: - description: A unique name for the keypair, with a maximum length of 255 [ASCII printable characters](https://en.wikipedia.org/wiki/ASCII#Printable_characters). + description: A unique name for the keypair, with a maximum length of 255 + [ASCII printable characters](https://en.wikipedia.org/wiki/ASCII#Printable_characters). type: string PublicKey: description: The public key. It must be Base64-encoded. @@ -896,20 +1010,21 @@ components: additionalProperties: false properties: Keypair: - $ref: '#/components/schemas/KeypairCreated' + "$ref": "#/components/schemas/KeypairCreated" ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object CreateListenerRuleRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Listener: - $ref: '#/components/schemas/LoadBalancerLight' + "$ref": "#/components/schemas/LoadBalancerLight" ListenerRule: - $ref: '#/components/schemas/ListenerRuleForCreation' + "$ref": "#/components/schemas/ListenerRuleForCreation" VmIds: description: The IDs of the backend VMs. items: @@ -924,23 +1039,25 @@ components: additionalProperties: false properties: ListenerRule: - $ref: '#/components/schemas/ListenerRule' + "$ref": "#/components/schemas/ListenerRule" ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object CreateLoadBalancerListenersRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Listeners: description: One or more listeners for the load balancer. items: - $ref: '#/components/schemas/ListenerForCreation' + "$ref": "#/components/schemas/ListenerForCreation" type: array LoadBalancerName: - description: The name of the load balancer for which you want to create listeners. + description: The name of the load balancer for which you want to create + listeners. type: string required: - Listeners @@ -950,30 +1067,38 @@ components: additionalProperties: false properties: LoadBalancer: - $ref: '#/components/schemas/LoadBalancer' + "$ref": "#/components/schemas/LoadBalancer" ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object CreateLoadBalancerPolicyRequest: additionalProperties: false properties: CookieExpirationPeriod: - description: The lifetime of the cookie, in seconds. If not specified, the default value of this parameter is `1`, which means that the sticky session lasts for the duration of the browser session. + description: The lifetime of the cookie, in seconds. If not specified, the + default value of this parameter is `1`, which means that the sticky session + lasts for the duration of the browser session. type: integer CookieName: - description: The name of the application cookie used for stickiness. This parameter is required if you create a stickiness policy based on an application-generated cookie. + description: The name of the application cookie used for stickiness. This + parameter is required if you create a stickiness policy based on an application-generated + cookie. type: string DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean LoadBalancerName: - description: The name of the load balancer for which you want to create a policy. + description: The name of the load balancer for which you want to create + a policy. type: string PolicyName: - description: The name of the policy. This name must be unique and consist of alphanumeric characters and dashes (-). + description: The name of the policy. This name must be unique and consist + of alphanumeric characters and dashes (-). type: string PolicyType: - description: 'The type of stickiness policy you want to create: `app` or `load_balancer`.' + description: 'The type of stickiness policy you want to create: `app` or + `load_balancer`.' type: string required: - PolicyType @@ -984,49 +1109,61 @@ components: additionalProperties: false properties: LoadBalancer: - $ref: '#/components/schemas/LoadBalancer' + "$ref": "#/components/schemas/LoadBalancer" ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object CreateLoadBalancerRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Listeners: description: One or more listeners to create. items: - $ref: '#/components/schemas/ListenerForCreation' + "$ref": "#/components/schemas/ListenerForCreation" type: array LoadBalancerName: - description: The unique name of the load balancer (32 alphanumeric or hyphen characters maximum, but cannot start or end with a hyphen). + description: The unique name of the load balancer (32 alphanumeric or hyphen + characters maximum, but cannot start or end with a hyphen). type: string LoadBalancerType: - description: 'The type of load balancer: `internet-facing` or `internal`. Use this parameter only for load balancers in a Net.' + description: 'The type of load balancer: `internet-facing` or `internal`. + Use this parameter only for load balancers in a Net.' type: string PublicIp: - description: (internet-facing only) The public IP you want to associate with the load balancer. If not specified, a public IP owned by 3DS OUTSCALE is associated. + description: "(internet-facing only) The public IP you want to associate + with the load balancer. If not specified, a public IP owned by 3DS OUTSCALE + is associated." type: string SecurityGroups: - description: (Net only) One or more IDs of security groups you want to assign to the load balancer. If not specified, the default security group of the Net is assigned to the load balancer. + description: "(Net only) One or more IDs of security groups you want to + assign to the load balancer. If not specified, the default security group + of the Net is assigned to the load balancer." items: type: string type: array Subnets: - description: (Net only) The ID of the Subnet in which you want to create the load balancer. Regardless of this Subnet, the load balancer can distribute traffic to all Subnets. This parameter is required in a Net. + description: "(Net only) The ID of the Subnet in which you want to create + the load balancer. Regardless of this Subnet, the load balancer can distribute + traffic to all Subnets. This parameter is required in a Net." items: type: string type: array SubregionNames: - description: (public Cloud only) The Subregion in which you want to create the load balancer. Regardless of this Subregion, the load balancer can distribute traffic to all Subregions. This parameter is required in the public Cloud. + description: "(public Cloud only) The Subregion in which you want to create + the load balancer. Regardless of this Subregion, the load balancer can + distribute traffic to all Subregions. This parameter is required in the + public Cloud." items: type: string type: array Tags: description: One or more tags assigned to the load balancer. items: - $ref: '#/components/schemas/ResourceTag' + "$ref": "#/components/schemas/ResourceTag" type: array required: - Listeners @@ -1036,15 +1173,16 @@ components: additionalProperties: false properties: LoadBalancer: - $ref: '#/components/schemas/LoadBalancer' + "$ref": "#/components/schemas/LoadBalancer" ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object CreateLoadBalancerTagsRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean LoadBalancerNames: description: One or more load balancer names. @@ -1054,7 +1192,7 @@ components: Tags: description: One or more tags to add to the specified load balancers. items: - $ref: '#/components/schemas/ResourceTag' + "$ref": "#/components/schemas/ResourceTag" type: array required: - LoadBalancerNames @@ -1064,18 +1202,19 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object CreateNatServiceRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean PublicIpId: - description: 'The allocation ID of the public IP to associate with the NAT service.
- - If the public IP is already associated with another resource, you must first disassociate it.' + description: |- + The allocation ID of the public IP to associate with the NAT service.
+ If the public IP is already associated with another resource, you must first disassociate it. type: string SubnetId: description: The ID of the Subnet in which you want to create the NAT service. @@ -1088,15 +1227,16 @@ components: additionalProperties: false properties: NatService: - $ref: '#/components/schemas/NatService' + "$ref": "#/components/schemas/NatService" ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object CreateNetAccessPointRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean NetId: description: The ID of the Net. @@ -1117,9 +1257,9 @@ components: additionalProperties: false properties: NetAccessPoint: - $ref: '#/components/schemas/NetAccessPoint' + "$ref": "#/components/schemas/NetAccessPoint" ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object CreateNetPeeringRequest: additionalProperties: false @@ -1128,7 +1268,8 @@ components: description: The ID of the Net you want to connect with. type: string DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean SourceNetId: description: The ID of the Net you send the peering request from. @@ -1141,21 +1282,24 @@ components: additionalProperties: false properties: NetPeering: - $ref: '#/components/schemas/NetPeering' + "$ref": "#/components/schemas/NetPeering" ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object CreateNetRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean IpRange: description: The IP range for the Net, in CIDR notation (for example, `10.0.0.0/16`). type: string Tenancy: - description: The tenancy options for the VMs (`default` if a VM created in a Net can be launched with any tenancy, `dedicated` if it can be launched with dedicated tenancy VMs running on single-tenant hardware). + description: The tenancy options for the VMs (`default` if a VM created + in a Net can be launched with any tenancy, `dedicated` if it can be launched + with dedicated tenancy VMs running on single-tenant hardware). type: string required: - IpRange @@ -1164,9 +1308,9 @@ components: additionalProperties: false properties: Net: - $ref: '#/components/schemas/Net' + "$ref": "#/components/schemas/Net" ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object CreateNicRequest: additionalProperties: false @@ -1175,16 +1319,16 @@ components: description: A description for the NIC. type: string DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean PrivateIps: - description: 'The primary private IP for the NIC.
- + description: |- + The primary private IP for the NIC.
This IP must be within the IP range of the Subnet that you specify with the `SubnetId` attribute.
- - If you do not specify this attribute, a random private IP is selected within the IP range of the Subnet.' + If you do not specify this attribute, a random private IP is selected within the IP range of the Subnet. items: - $ref: '#/components/schemas/PrivateIpLight' + "$ref": "#/components/schemas/PrivateIpLight" type: array SecurityGroupIds: description: One or more IDs of security groups for the NIC. @@ -1201,36 +1345,40 @@ components: additionalProperties: false properties: Nic: - $ref: '#/components/schemas/Nic' + "$ref": "#/components/schemas/Nic" ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object CreatePublicIpRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean type: object CreatePublicIpResponse: additionalProperties: false properties: PublicIp: - $ref: '#/components/schemas/PublicIp' + "$ref": "#/components/schemas/PublicIp" ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object CreateRouteRequest: additionalProperties: false properties: DestinationIpRange: - description: The IP range used for the destination match, in CIDR notation (for example, `10.0.0.0/24`). + description: The IP range used for the destination match, in CIDR notation + (for example, `10.0.0.0/24`). type: string DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean GatewayId: - description: The ID of an Internet service or virtual gateway attached to your Net. + description: The ID of an Internet service or virtual gateway attached to + your Net. type: string NatServiceId: description: The ID of a NAT service. @@ -1255,15 +1403,16 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" RouteTable: - $ref: '#/components/schemas/RouteTable' + "$ref": "#/components/schemas/RouteTable" type: object CreateRouteTableRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean NetId: description: The ID of the Net for which you want to create a route table. @@ -1275,28 +1424,29 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" RouteTable: - $ref: '#/components/schemas/RouteTable' + "$ref": "#/components/schemas/RouteTable" type: object CreateSecurityGroupRequest: additionalProperties: false properties: Description: - description: A description for the security group, with a maximum length of 255 [ASCII printable characters](https://en.wikipedia.org/wiki/ASCII#Printable_characters). + description: A description for the security group, with a maximum length + of 255 [ASCII printable characters](https://en.wikipedia.org/wiki/ASCII#Printable_characters). type: string DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean NetId: description: The ID of the Net for the security group. type: string SecurityGroupName: - description: 'The name of the security group.
- + description: |- + The name of the security group.
This name must not start with `sg-`.
- - This name must be unique and contain between 1 and 255 ASCII characters. Accented letters are not allowed.' + This name must be unique and contain between 1 and 255 ASCII characters. Accented letters are not allowed. type: string required: - Description @@ -1306,44 +1456,62 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" SecurityGroup: - $ref: '#/components/schemas/SecurityGroup' + "$ref": "#/components/schemas/SecurityGroup" type: object CreateSecurityGroupRuleRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Flow: - description: 'The direction of the flow: `Inbound` or `Outbound`. You can specify `Outbound` for Nets only.' + description: 'The direction of the flow: `Inbound` or `Outbound`. You can + specify `Outbound` for Nets only.' type: string FromPortRange: - description: The beginning of the port range for the TCP and UDP protocols, or an ICMP type number. If you specify this parameter, you cannot specify the `Rules` parameter and its subparameters. + description: The beginning of the port range for the TCP and UDP protocols, + or an ICMP type number. If you specify this parameter, you cannot specify + the `Rules` parameter and its subparameters. type: integer IpProtocol: - description: The IP protocol name (`tcp`, `udp`, `icmp`, or `-1` for all protocols). By default, `-1`. In a Net, this can also be an IP protocol number. For more information, see the [IANA.org website](https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml). If you specify this parameter, you cannot specify the `Rules` parameter and its subparameters. + description: The IP protocol name (`tcp`, `udp`, `icmp`, or `-1` for all + protocols). By default, `-1`. In a Net, this can also be an IP protocol + number. For more information, see the [IANA.org website](https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml). + If you specify this parameter, you cannot specify the `Rules` parameter + and its subparameters. type: string IpRange: - description: The IP range for the security group rule, in CIDR notation (for example, 10.0.0.0/16). If you specify this parameter, you cannot specify the `Rules` parameter and its subparameters. + description: The IP range for the security group rule, in CIDR notation + (for example, 10.0.0.0/16). If you specify this parameter, you cannot + specify the `Rules` parameter and its subparameters. type: string Rules: - description: 'Information about the security group rule to create. If you specify this parent parameter and its subparameters, you cannot specify the following parent parameters: `FromPortRange`, `IpProtocol`, `IpRange`, and `ToPortRange`.' + description: 'Information about the security group rule to create. If you + specify this parent parameter and its subparameters, you cannot specify + the following parent parameters: `FromPortRange`, `IpProtocol`, `IpRange`, + and `ToPortRange`.' items: - $ref: '#/components/schemas/SecurityGroupRule' + "$ref": "#/components/schemas/SecurityGroupRule" type: array SecurityGroupAccountIdToLink: - description: The account ID that owns the source or destination security group specified in the `SecurityGroupNameToLink` parameter. + description: The account ID that owns the source or destination security + group specified in the `SecurityGroupNameToLink` parameter. type: string SecurityGroupId: - description: The ID of the security group for which you want to create a rule. + description: The ID of the security group for which you want to create a + rule. type: string SecurityGroupNameToLink: - description: The ID of a source or destination security group that you want to link to the security group of the rule. + description: The ID of a source or destination security group that you want + to link to the security group of the rule. type: string ToPortRange: - description: The end of the port range for the TCP and UDP protocols, or an ICMP code number. If you specify this parameter, you cannot specify the `Rules` parameter and its subparameters. + description: The end of the port range for the TCP and UDP protocols, or + an ICMP code number. If you specify this parameter, you cannot specify + the `Rules` parameter and its subparameters. type: integer required: - SecurityGroupId @@ -1353,30 +1521,40 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" SecurityGroup: - $ref: '#/components/schemas/SecurityGroup' + "$ref": "#/components/schemas/SecurityGroup" type: object CreateServerCertificateRequest: additionalProperties: false properties: Body: - description: 'The PEM-encoded X509 certificate.
With OSC CLI, use the following syntax to make sure your CA file is correctly parsed: `--CaPem="$(cat FILENAME)"`.' + description: 'The PEM-encoded X509 certificate.
With OSC CLI, use the + following syntax to make sure your CA file is correctly parsed: `--CaPem="$(cat + FILENAME)"`.' type: string Chain: - description: 'The PEM-encoded intermediate certification authorities.
With OSC CLI, use the following syntax to make sure your CA file is correctly parsed: `--CaPem="$(cat FILENAME)"`.' + description: 'The PEM-encoded intermediate certification authorities.
With OSC CLI, use the following syntax to make sure your CA file is + correctly parsed: `--CaPem="$(cat FILENAME)"`.' type: string DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Name: - description: 'A unique name for the certificate. Constraints: 1-128 alphanumeric characters, pluses (+), equals (=), commas (,), periods (.), at signs (@), minuses (-), or underscores (_).' + description: 'A unique name for the certificate. Constraints: 1-128 alphanumeric + characters, pluses (+), equals (=), commas (,), periods (.), at signs + (@), minuses (-), or underscores (_).' type: string Path: - description: The path to the server certificate, set to a slash (/) if not specified. + description: The path to the server certificate, set to a slash (/) if not + specified. type: string PrivateKey: - description: 'The PEM-encoded private key matching the certificate.
With OSC CLI, use the following syntax to make sure your CA file is correctly parsed: `--CaPem="$(cat FILENAME)"`.' + description: 'The PEM-encoded private key matching the certificate.
With + OSC CLI, use the following syntax to make sure your CA file is correctly + parsed: `--CaPem="$(cat FILENAME)"`.' type: string required: - Body @@ -1387,18 +1565,19 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" ServerCertificate: - $ref: '#/components/schemas/ServerCertificate' + "$ref": "#/components/schemas/ServerCertificate" type: object CreateSnapshotExportTaskRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean OsuExport: - $ref: '#/components/schemas/OsuExportToCreate' + "$ref": "#/components/schemas/OsuExportToCreate" SnapshotId: description: The ID of the snapshot to export. type: string @@ -1410,9 +1589,9 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" SnapshotExportTask: - $ref: '#/components/schemas/SnapshotExportTask' + "$ref": "#/components/schemas/SnapshotExportTask" type: object CreateSnapshotRequest: additionalProperties: false @@ -1421,43 +1600,52 @@ components: description: A description for the snapshot. type: string DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean FileLocation: - description: (When importing) The pre-signed URL of the snapshot you want to import, or the normal URL of the snapshot if you have permission on the OOS bucket. For more information, see [Configuring a Pre-signed URL](https://docs.outscale.com/en/userguide/Configuring-a-Pre-signed-URL.html) or [Managing Access to Your Buckets and Objects](https://docs.outscale.com/en/userguide/Managing-Access-to-Your-Buckets-and-Objects.html). + description: "(When importing) The pre-signed URL of the snapshot you want + to import, or the normal URL of the snapshot if you have permission on + the OOS bucket. For more information, see [Configuring a Pre-signed URL](https://docs.outscale.com/en/userguide/Configuring-a-Pre-signed-URL.html) + or [Managing Access to Your Buckets and Objects](https://docs.outscale.com/en/userguide/Managing-Access-to-Your-Buckets-and-Objects.html)." type: string SnapshotSize: - description: (When importing) The size of the snapshot you want to create in your account, in bytes. This size must be greater than or equal to the size of the original, uncompressed snapshot. + description: "(When importing) The size of the snapshot you want to create + in your account, in bytes. This size must be greater than or equal to + the size of the original, uncompressed snapshot." format: int64 type: integer SourceRegionName: - description: (When copying) The name of the source Region, which must be the same as the Region of your account. + description: "(When copying) The name of the source Region, which must be + the same as the Region of your account." type: string SourceSnapshotId: - description: (When copying) The ID of the snapshot you want to copy. + description: "(When copying) The ID of the snapshot you want to copy." type: string VolumeId: - description: (When creating) The ID of the volume you want to create a snapshot of. + description: "(When creating) The ID of the volume you want to create a + snapshot of." type: string type: object CreateSnapshotResponse: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" Snapshot: - $ref: '#/components/schemas/Snapshot' + "$ref": "#/components/schemas/Snapshot" type: object CreateSubnetRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean IpRange: - description: 'The IP range in the Subnet, in CIDR notation (for example, `10.0.0.0/16`).
- - The IP range of the Subnet can be either the same as the Net one if you create only a single Subnet in this Net, or a subset of the Net one. In case of several Subnets in a Net, their IP ranges must not overlap. The smallest Subnet you can create uses a /29 netmask (eight IPs). For more information, see [About VPCs](https://docs.outscale.com/en/userguide/About-VPCs.html).' + description: |- + The IP range in the Subnet, in CIDR notation (for example, `10.0.0.0/16`).
+ The IP range of the Subnet can be either the same as the Net one if you create only a single Subnet in this Net, or a subset of the Net one. In case of several Subnets in a Net, their IP ranges must not overlap. The smallest Subnet you can create uses a /29 netmask (eight IPs). For more information, see [About VPCs](https://docs.outscale.com/en/userguide/About-VPCs.html). type: string NetId: description: The ID of the Net for which you want to create a Subnet. @@ -1473,15 +1661,16 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" Subnet: - $ref: '#/components/schemas/Subnet' + "$ref": "#/components/schemas/Subnet" type: object CreateTagsRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean ResourceIds: description: One or more resource IDs. @@ -1491,7 +1680,7 @@ components: Tags: description: One or more tags to add to the specified resources. items: - $ref: '#/components/schemas/ResourceTag' + "$ref": "#/components/schemas/ResourceTag" type: array required: - ResourceIds @@ -1501,16 +1690,42 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" + type: object + CreateUserRequest: + additionalProperties: false + properties: + DryRun: + description: If true, checks whether you have the required permissions to + perform the action. + type: boolean + Path: + description: The path to the EIM user you want to create (by default, `/`). + type: string + UserName: + description: The name of the EIM user you want to create. + type: string + required: + - UserName + type: object + CreateUserResponse: + additionalProperties: false + properties: + ResponseContext: + "$ref": "#/components/schemas/ResponseContext" + User: + "$ref": "#/components/schemas/User" type: object CreateVirtualGatewayRequest: additionalProperties: false properties: ConnectionType: - description: The type of VPN connection supported by the virtual gateway (only `ipsec.1` is supported). + description: The type of VPN connection supported by the virtual gateway + (only `ipsec.1` is supported). type: string DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean required: - ConnectionType @@ -1519,9 +1734,9 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" VirtualGateway: - $ref: '#/components/schemas/VirtualGateway' + "$ref": "#/components/schemas/VirtualGateway" type: object CreateVmGroupRequest: additionalProperties: false @@ -1530,11 +1745,17 @@ components: description: A description for the VM group. type: string DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. 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. 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. enum: - attract - no-strategy @@ -1551,7 +1772,7 @@ components: Tags: description: One or more tags to add to the VM group. items: - $ref: '#/components/schemas/ResourceTag' + "$ref": "#/components/schemas/ResourceTag" type: array VmCount: description: The number of VMs deployed in the VM group. @@ -1573,9 +1794,9 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" VmGroup: - $ref: '#/components/schemas/VmGroup' + "$ref": "#/components/schemas/VmGroup" type: object CreateVmTemplateRequest: additionalProperties: false @@ -1598,10 +1819,12 @@ components: description: A description for the VM template. type: string DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean ImageId: - description: The ID of the OMI to use for each VM. You can find a list of OMIs by calling the [ReadImages](#readimages) method. + description: The ID of the OMI to use for each VM. You can find a list of + OMIs by calling the [ReadImages](#readimages) method. type: string KeypairName: description: The name of the keypair to use for each VM. @@ -1612,7 +1835,7 @@ components: Tags: description: One or more tags to add to the VM template. items: - $ref: '#/components/schemas/ResourceTag' + "$ref": "#/components/schemas/ResourceTag" type: array VmTemplateName: description: The name of the VM template. @@ -1628,9 +1851,9 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" VmTemplate: - $ref: '#/components/schemas/VmTemplate' + "$ref": "#/components/schemas/VmTemplate" type: object CreateVmsRequest: additionalProperties: false @@ -1638,55 +1861,69 @@ components: BlockDeviceMappings: description: One or more block device mappings. items: - $ref: '#/components/schemas/BlockDeviceMappingVmCreation' + "$ref": "#/components/schemas/BlockDeviceMappingVmCreation" type: array BootOnCreation: default: true - description: By default or if true, the VM is started on creation. If false, the VM is stopped on creation. + description: By default or 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 the sake of historical compatibility with AWS. + description: This parameter is not available. It is present in our API for + the sake of historical compatibility with AWS. type: boolean ClientToken: description: A unique identifier which enables you to manage the idempotency. type: string DeletionProtection: - description: If true, you cannot delete the VM unless you change this parameter back to false. + description: If true, you cannot delete the VM unless you change this parameter + back to false. type: boolean DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean ImageId: - description: The ID of the OMI used to create the VM. You can find the list of OMIs by calling the [ReadImages](#readimages) method. + description: The ID of the OMI used to create the VM. You can find the list + of OMIs by calling the [ReadImages](#readimages) method. type: string KeypairName: description: The name of the keypair. type: string MaxVmsCount: - description: The maximum number of VMs you want to create. If all the VMs cannot be created, the largest possible number of VMs above MinVmsCount is created. + description: The maximum number of VMs you want to create. If all the VMs + cannot be created, the largest possible number of VMs above MinVmsCount + is created. type: integer MinVmsCount: - description: The minimum number of VMs you want to create. If this number of VMs cannot be created, no VMs are created. + description: The minimum number of VMs you want to create. If this number + of VMs cannot be created, no VMs are created. type: integer NestedVirtualization: default: false - description: (dedicated tenancy only) If true, nested virtualization is enabled. If false, it is disabled. + description: "(dedicated tenancy only) If true, nested virtualization is + enabled. If false, it is disabled." type: boolean Nics: - description: One or more NICs. If you specify this parameter, you must not specify the `SubnetId` and `SubregionName` parameters. You also must define one NIC as the primary network interface of the VM with `0` as its device number. + description: One or more NICs. If you specify this parameter, you must not + specify the `SubnetId` and `SubregionName` parameters. You also must define + one NIC as the primary network interface of the VM with `0` as its device + number. items: - $ref: '#/components/schemas/NicForVmCreation' + "$ref": "#/components/schemas/NicForVmCreation" 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 (`medium` \| `high` \| `highest`). + By default, `high`. This parameter is ignored if you specify a performance + flag directly in the `VmType` parameter. enum: - medium - high - highest type: string Placement: - $ref: '#/components/schemas/Placement' + "$ref": "#/components/schemas/Placement" PrivateIps: description: One or more private IPs of the VM. items: @@ -1703,19 +1940,23 @@ components: type: string type: array SubnetId: - description: The ID of the Subnet in which you want to create the VM. If you specify this parameter, you must not specify the `Nics` parameter. + description: The ID of the Subnet in which you want to create the VM. If + you specify this parameter, you must not specify the `Nics` parameter. type: string UserData: - description: Data or script used to add a specific configuration to the VM. It must be Base64-encoded and is limited to 500 kibibytes (KiB). + description: Data or script used to add a specific configuration to the + VM. It must be Base64-encoded and is limited to 500 kibibytes (KiB). 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. If set to `terminate`, the VM stops and is terminated. + 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. + If set to `terminate`, the VM stops and is terminated. type: string VmType: - description: 'The type of VM. You can specify a TINA type (in the `tinavW.cXrYpZ` or `tinavW.cXrY` format), or an AWS type (for example, `t2.small`, which is the default value).
- - If you specify an AWS type, it is converted in the background to its corresponding TINA type, but the AWS type is still returned. If the specified or converted TINA type includes a performance flag, this performance flag is applied regardless of the value you may have provided in the `Performance` parameter. For more information, see [Instance Types](https://docs.outscale.com/en/userguide/Instance-Types.html).' + description: |- + The type of VM. You can specify a TINA type (in the `tinavW.cXrYpZ` or `tinavW.cXrY` format), or an AWS type (for example, `t2.small`, which is the default value).
+ If you specify an AWS type, it is converted in the background to its corresponding TINA type, but the AWS type is still returned. If the specified or converted TINA type includes a performance flag, this performance flag is applied regardless of the value you may have provided in the `Performance` parameter. For more information, see [Instance Types](https://docs.outscale.com/en/userguide/Instance-Types.html). type: string required: - ImageId @@ -1724,24 +1965,30 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" Vms: description: Information about one or more created VMs. items: - $ref: '#/components/schemas/Vm' + "$ref": "#/components/schemas/Vm" type: array type: object CreateVolumeRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Iops: - description: The number of I/O operations per second (IOPS). This parameter must be specified only if you create an `io1` volume. The maximum number of IOPS allowed for `io1` volumes is `13000` with a maximum performance ratio of 300 IOPS per gibibyte. + description: The number of I/O operations per second (IOPS). This parameter + must be specified only if you create an `io1` volume. The maximum number + of IOPS allowed for `io1` volumes is `13000` with a maximum performance + ratio of 300 IOPS per gibibyte. type: integer Size: - description: 'The size of the volume, in gibibytes (GiB). The maximum allowed size for a volume is 14901 GiB. This parameter is required if the volume is not created from a snapshot (`SnapshotId` unspecified). ' + description: 'The size of the volume, in gibibytes (GiB). The maximum allowed + size for a volume is 14901 GiB. This parameter is required if the volume + is not created from a snapshot (`SnapshotId` unspecified). ' type: integer SnapshotId: description: The ID of the snapshot from which you want to create the volume. @@ -1750,9 +1997,9 @@ components: description: The Subregion in which you want to create the volume. type: string VolumeType: - description: 'The type of volume you want to create (`io1` \| `gp2` \| `standard`). If not specified, a `standard` volume is created.
- - For more information about volume types, see [About Volumes > Volume Types and IOPS](https://docs.outscale.com/en/userguide/About-Volumes.html#_volume_types_and_iops).' + description: |- + The type of volume you want to create (`io1` \| `gp2` \| `standard`). If not specified, a `standard` volume is created.
+ For more information about volume types, see [About Volumes > Volume Types and IOPS](https://docs.outscale.com/en/userguide/About-Volumes.html#_volume_types_and_iops). type: string required: - SubregionName @@ -1761,9 +2008,9 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" Volume: - $ref: '#/components/schemas/Volume' + "$ref": "#/components/schemas/Volume" type: object CreateVpnConnectionRequest: additionalProperties: false @@ -1775,10 +2022,14 @@ components: description: The type of VPN connection (only `ipsec.1` is supported). type: string DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean StaticRoutesOnly: - description: If false, the VPN connection uses dynamic routing with Border Gateway Protocol (BGP). If true, routing is controlled using static routes. For more information about how to create and delete static routes, see [CreateVpnConnectionRoute](#createvpnconnectionroute) and [DeleteVpnConnectionRoute](#deletevpnconnectionroute). + description: If false, the VPN connection uses dynamic routing with Border + Gateway Protocol (BGP). If true, routing is controlled using static routes. + For more information about how to create and delete static routes, see + [CreateVpnConnectionRoute](#createvpnconnectionroute) and [DeleteVpnConnectionRoute](#deletevpnconnectionroute). type: boolean VirtualGatewayId: description: The ID of the virtual gateway. @@ -1792,18 +2043,20 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" VpnConnection: - $ref: '#/components/schemas/VpnConnection' + "$ref": "#/components/schemas/VpnConnection" type: object CreateVpnConnectionRouteRequest: additionalProperties: false properties: DestinationIpRange: - description: The network prefix of the route, in CIDR notation (for example, `10.12.0.0/16`). + description: The network prefix of the route, in CIDR notation (for example, + `10.12.0.0/16`). type: string DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean VpnConnectionId: description: The ID of the target VPN connection of the static route. @@ -1816,7 +2069,7 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object DeleteAccessKeyRequest: additionalProperties: false @@ -1825,8 +2078,14 @@ components: description: The ID of the access key you want to delete. type: string DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean + UserName: + description: The name of the EIM user the access key you want to delete + is associated with. By default, the user who sends the request (which + can be the root account). + type: string required: - AccessKeyId type: object @@ -1834,7 +2093,7 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object DeleteApiAccessRuleRequest: additionalProperties: false @@ -1843,7 +2102,8 @@ components: description: The ID of the API access rule you want to delete. type: string DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean required: - ApiAccessRuleId @@ -1852,7 +2112,7 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object DeleteCaRequest: additionalProperties: false @@ -1861,7 +2121,8 @@ components: description: The ID of the CA you want to delete. type: string DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean required: - CaId @@ -1870,7 +2131,7 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object DeleteClientGatewayRequest: additionalProperties: false @@ -1879,7 +2140,8 @@ components: description: The ID of the client gateway you want to delete. type: string DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean required: - ClientGatewayId @@ -1888,7 +2150,7 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object DeleteDhcpOptionsRequest: additionalProperties: false @@ -1897,7 +2159,8 @@ components: description: The ID of the DHCP options set you want to delete. type: string DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean required: - DhcpOptionsSetId @@ -1906,7 +2169,7 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object DeleteDirectLinkInterfaceRequest: additionalProperties: false @@ -1915,7 +2178,8 @@ components: description: The ID of the DirectLink interface you want to delete. type: string DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean required: - DirectLinkInterfaceId @@ -1924,7 +2188,7 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object DeleteDirectLinkRequest: additionalProperties: false @@ -1933,7 +2197,8 @@ components: description: The ID of the DirectLink you want to delete. type: string DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean required: - DirectLinkId @@ -1942,13 +2207,14 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object DeleteExportTaskRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean ExportTaskId: description: The ID of the export task to delete. @@ -1960,13 +2226,14 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object DeleteFlexibleGpuRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean FlexibleGpuId: description: The ID of the fGPU you want to delete. @@ -1978,13 +2245,14 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object DeleteImageRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean ImageId: description: The ID of the OMI you want to delete. @@ -1996,13 +2264,14 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object DeleteInternetServiceRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean InternetServiceId: description: The ID of the Internet service you want to delete. @@ -2014,13 +2283,14 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object DeleteKeypairRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean KeypairName: description: The name of the keypair you want to delete. @@ -2032,13 +2302,14 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object DeleteListenerRuleRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean ListenerRuleName: description: The name of the rule you want to delete. @@ -2050,16 +2321,18 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object DeleteLoadBalancerListenersRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean LoadBalancerName: - description: The name of the load balancer for which you want to delete listeners. + description: The name of the load balancer for which you want to delete + listeners. type: string LoadBalancerPorts: description: One or more port numbers of the listeners you want to delete. @@ -2074,18 +2347,20 @@ components: additionalProperties: false properties: LoadBalancer: - $ref: '#/components/schemas/LoadBalancer' + "$ref": "#/components/schemas/LoadBalancer" ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object DeleteLoadBalancerPolicyRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean LoadBalancerName: - description: The name of the load balancer for which you want to delete a policy. + description: The name of the load balancer for which you want to delete + a policy. type: string PolicyName: description: The name of the policy you want to delete. @@ -2098,15 +2373,16 @@ components: additionalProperties: false properties: LoadBalancer: - $ref: '#/components/schemas/LoadBalancer' + "$ref": "#/components/schemas/LoadBalancer" ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object DeleteLoadBalancerRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean LoadBalancerName: description: The name of the load balancer you want to delete. @@ -2118,13 +2394,14 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object DeleteLoadBalancerTagsRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean LoadBalancerNames: description: One or more load balancer names. @@ -2134,7 +2411,7 @@ components: Tags: description: One or more tags to delete from the load balancers. items: - $ref: '#/components/schemas/ResourceLoadBalancerTag' + "$ref": "#/components/schemas/ResourceLoadBalancerTag" type: array required: - LoadBalancerNames @@ -2144,13 +2421,14 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object DeleteNatServiceRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean NatServiceId: description: The ID of the NAT service you want to delete. @@ -2162,13 +2440,14 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object DeleteNetAccessPointRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean NetAccessPointId: description: The ID of the Net access point. @@ -2180,13 +2459,14 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object DeleteNetPeeringRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean NetPeeringId: description: The ID of the Net peering you want to delete. @@ -2198,13 +2478,14 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object DeleteNetRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean NetId: description: The ID of the Net you want to delete. @@ -2216,13 +2497,14 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object DeleteNicRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean NicId: description: The ID of the NIC you want to delete. @@ -2234,26 +2516,28 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object DeletePublicIpRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean PublicIp: description: The public IP. In the public Cloud, this parameter is required. type: string PublicIpId: - description: The ID representing the association of the public IP with the VM or the NIC. In a Net, this parameter is required. + description: The ID representing the association of the public IP with the + VM or the NIC. In a Net, this parameter is required. type: string type: object DeletePublicIpResponse: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object DeleteRouteRequest: additionalProperties: false @@ -2262,7 +2546,8 @@ components: description: The exact IP range for the route. type: string DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean RouteTableId: description: The ID of the route table from which you want to delete a route. @@ -2275,15 +2560,16 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" RouteTable: - $ref: '#/components/schemas/RouteTable' + "$ref": "#/components/schemas/RouteTable" type: object DeleteRouteTableRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean RouteTableId: description: The ID of the route table you want to delete. @@ -2295,13 +2581,14 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object DeleteSecurityGroupRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean SecurityGroupId: description: The ID of the security group you want to delete. @@ -2314,42 +2601,51 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object DeleteSecurityGroupRuleRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Flow: - description: 'The direction of the flow: `Inbound` or `Outbound`. You can specify `Outbound` for Nets only.' + description: 'The direction of the flow: `Inbound` or `Outbound`. You can + specify `Outbound` for Nets only.' type: string FromPortRange: - description: The beginning of the port range for the TCP and UDP protocols, or an ICMP type number. + description: The beginning of the port range for the TCP and UDP protocols, + or an ICMP type number. type: integer IpProtocol: - description: The IP protocol name (`tcp`, `udp`, `icmp`, or `-1` for all protocols). By default, `-1`. In a Net, this can also be an IP protocol number. For more information, see the [IANA.org website](https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml). + description: The IP protocol name (`tcp`, `udp`, `icmp`, or `-1` for all + protocols). By default, `-1`. In a Net, this can also be an IP protocol + number. For more information, see the [IANA.org website](https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml). type: string IpRange: - description: The IP range for the security group rule, in CIDR notation (for example, `10.0.0.0/16`). + description: The IP range for the security group rule, in CIDR notation + (for example, `10.0.0.0/16`). type: string Rules: description: One or more rules you want to delete from the security group. items: - $ref: '#/components/schemas/SecurityGroupRule' + "$ref": "#/components/schemas/SecurityGroupRule" type: array SecurityGroupAccountIdToUnlink: - description: The account ID of the owner of the security group you want to delete a rule from. + description: The account ID of the owner of the security group you want + to delete a rule from. type: string SecurityGroupId: description: The ID of the security group you want to delete a rule from. type: string SecurityGroupNameToUnlink: - description: The ID of the source security group. If you are in the Public Cloud, you can also specify the name of the source security group. + description: The ID of the source security group. If you are in the Public + Cloud, you can also specify the name of the source security group. type: string ToPortRange: - description: The end of the port range for the TCP and UDP protocols, or an ICMP code number. + description: The end of the port range for the TCP and UDP protocols, or + an ICMP code number. type: integer required: - SecurityGroupId @@ -2359,15 +2655,16 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" SecurityGroup: - $ref: '#/components/schemas/SecurityGroup' + "$ref": "#/components/schemas/SecurityGroup" type: object DeleteServerCertificateRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Name: description: The name of the server certificate you want to delete. @@ -2379,13 +2676,14 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object DeleteSnapshotRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean SnapshotId: description: The ID of the snapshot you want to delete. @@ -2397,13 +2695,14 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object DeleteSubnetRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean SubnetId: description: The ID of the Subnet you want to delete. @@ -2415,13 +2714,14 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object DeleteTagsRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean ResourceIds: description: One or more resource IDs. @@ -2429,9 +2729,10 @@ components: type: string type: array Tags: - description: One or more tags to delete (if you set a tag value, only the tags matching exactly this value are deleted). + description: One or more tags to delete (if you set a tag value, only the + tags matching exactly this value are deleted). items: - $ref: '#/components/schemas/ResourceTag' + "$ref": "#/components/schemas/ResourceTag" type: array required: - ResourceIds @@ -2441,13 +2742,33 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" + type: object + DeleteUserRequest: + additionalProperties: false + properties: + DryRun: + description: If true, checks whether you have the required permissions to + perform the action. + type: boolean + UserName: + description: The name of the EIM user you want to delete. + type: string + required: + - UserName + type: object + DeleteUserResponse: + additionalProperties: false + properties: + ResponseContext: + "$ref": "#/components/schemas/ResponseContext" type: object DeleteVirtualGatewayRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean VirtualGatewayId: description: The ID of the virtual gateway you want to delete. @@ -2459,13 +2780,14 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object DeleteVmGroupRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean VmGroupId: description: The ID of the VM group you want to delete. @@ -2477,13 +2799,14 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object DeleteVmTemplateRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean VmTemplateId: description: 'The ID of the VM template you want to delete. ' @@ -2495,13 +2818,14 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object DeleteVmsRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean VmIds: description: One or more IDs of VMs. @@ -2515,18 +2839,19 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" Vms: description: Information about one or more terminated VMs. items: - $ref: '#/components/schemas/VmState' + "$ref": "#/components/schemas/VmState" type: array type: object DeleteVolumeRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean VolumeId: description: The ID of the volume you want to delete. @@ -2538,13 +2863,14 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object DeleteVpnConnectionRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean VpnConnectionId: description: The ID of the VPN connection you want to delete. @@ -2556,19 +2882,22 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object DeleteVpnConnectionRouteRequest: additionalProperties: false properties: DestinationIpRange: - description: The network prefix of the route to delete, in CIDR notation (for example, `10.12.0.0/16`). + description: The network prefix of the route to delete, in CIDR notation + (for example, `10.12.0.0/16`). type: string DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean VpnConnectionId: - description: The ID of the target VPN connection of the static route to delete. + description: The ID of the target VPN connection of the static route to + delete. type: string required: - DestinationIpRange @@ -2578,7 +2907,7 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object DeregisterVmsInLoadBalancerRequest: additionalProperties: false @@ -2589,7 +2918,8 @@ components: type: string type: array DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean LoadBalancerName: description: The name of the load balancer. @@ -2602,14 +2932,15 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object DhcpOptionsSet: additionalProperties: false description: Information about the DHCP options set. properties: Default: - description: If true, the DHCP options set is a default one. If false, it is not. + description: If true, the DHCP options set is a default one. If false, it + is not. type: boolean DhcpOptionsSetId: description: The ID of the DHCP options set. @@ -2635,7 +2966,7 @@ components: Tags: description: One or more tags associated with the DHCP options set. items: - $ref: '#/components/schemas/ResourceTag' + "$ref": "#/components/schemas/ResourceTag" type: array type: object DirectLink: @@ -2661,17 +2992,13 @@ components: description: The Region in which the DirectLink has been created. type: string State: - description: 'The state of the DirectLink.
- + description: |- + The state of the DirectLink.
* `requested`: The DirectLink is requested but the request has not been validated yet.
- * `pending`: The DirectLink request has been validated. It remains in the `pending` state until you establish the physical link.
- * `available`: The physical link is established and the connection is ready to use.
- * `deleting`: The deletion process is in progress.
- - * `deleted`: The DirectLink is deleted.' + * `deleted`: The DirectLink is deleted. type: string type: object DirectLinkInterface: @@ -2679,7 +3006,9 @@ components: description: Information about the DirectLink interface. properties: BgpAsn: - description: The BGP (Border Gateway Protocol) ASN (Autonomous System Number) on the customer's side of the DirectLink interface. This number must be between `64512` and `65534`. + description: The BGP (Border Gateway Protocol) ASN (Autonomous System Number) + on the customer's side of the DirectLink interface. This number must be + between `64512` and `65534`. type: integer BgpKey: description: The BGP authentication key. @@ -2713,7 +3042,8 @@ components: description: The account ID of the owner of the DirectLink interface. type: string BgpAsn: - description: The BGP (Border Gateway Protocol) ASN (Autonomous System Number) on the customer's side of the DirectLink interface. + description: The BGP (Border Gateway Protocol) ASN (Autonomous System Number) + on the customer's side of the DirectLink interface. type: integer BgpKey: description: The BGP authentication key. @@ -2737,13 +3067,15 @@ components: description: The datacenter where the DirectLink interface is located. type: string Mtu: - description: The maximum transmission unit (MTU) of the DirectLink interface, in bytes (always `1500`). + description: The maximum transmission unit (MTU) of the DirectLink interface, + in bytes (always `1500`). type: integer OutscalePrivateIp: description: The IP on the OUTSCALE side of the DirectLink interface. type: string State: - description: The state of the DirectLink interface (`pending` \| `available` \| `deleting` \| `deleted` \| `confirming` \| `rejected` \| `expired`). + description: The state of the DirectLink interface (`pending` \| `available` + \| `deleting` \| `deleted` \| `confirming` \| `rejected` \| `expired`). type: string VirtualGatewayId: description: The ID of the target virtual gateway. @@ -2758,10 +3090,10 @@ components: Errors: description: One or more errors. items: - $ref: '#/components/schemas/Errors' + "$ref": "#/components/schemas/Errors" type: array ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object Errors: additionalProperties: false @@ -2832,7 +3164,8 @@ components: type: string type: array QueryApiNames: - description: The names of the APIs of the logged calls (always `oapi` for the OUTSCALE API). + description: The names of the APIs of the logged calls (always `oapi` for + the OUTSCALE API). items: type: string type: array @@ -2842,11 +3175,17 @@ components: type: string type: array QueryDateAfter: - description: The date and time, or the date, after which you want to retrieve logged calls, in ISO 8601 format (for example, `2020-06-14T00:00:00.000Z` or `2020-06-14`). By default, this date is set to 48 hours before the `QueryDateBefore` parameter value. + description: The date and time, or the date, after which you want to retrieve + logged calls, in ISO 8601 format (for example, `2020-06-14T00:00:00.000Z` + or `2020-06-14`). By default, this date is set to 48 hours before the + `QueryDateBefore` parameter value. format: date type: string QueryDateBefore: - description: The date and time, or the date, before which you want to retrieve logged calls, in ISO 8601 format (for example, `2020-06-30T00:00:00.000Z` or `2020-06-14`). By default, this date is set to now, or 48 hours after the `QueryDateAfter` parameter value. + description: The date and time, or the date, before which you want to retrieve + logged calls, in ISO 8601 format (for example, `2020-06-30T00:00:00.000Z` + or `2020-06-14`). By default, this date is set to now, or 48 hours after + the `QueryDateAfter` parameter value. format: date type: string QueryIpAddresses: @@ -2895,14 +3234,19 @@ components: description: One or more filters. properties: CurrentCatalogOnly: - description: By default or if set to true, only returns the current catalog. If false, returns the current catalog and past catalogs. + description: By default or if set to true, only returns the current catalog. + If false, returns the current catalog and past catalogs. type: boolean FromDate: - description: The beginning of the time period, in ISO 8601 date format (for example, `2020-06-14`). This date cannot be older than 3 years. You must specify the parameters `FromDate` and `ToDate` together. + description: The beginning of the time period, in ISO 8601 date format (for + example, `2020-06-14`). This date cannot be older than 3 years. You must + specify the parameters `FromDate` and `ToDate` together. format: date type: string ToDate: - description: The end of the time period, in ISO 8601 date format (for example, `2020-06-30`). You must specify the parameters `FromDate` and `ToDate` together. + description: The end of the time period, in ISO 8601 date format (for example, + `2020-06-30`). You must specify the parameters `FromDate` and `ToDate` + together. format: date type: string type: object @@ -2911,7 +3255,8 @@ components: description: One or more filters. properties: BgpAsns: - description: The Border Gateway Protocol (BGP) Autonomous System Numbers (ASNs) of the connections. + description: The Border Gateway Protocol (BGP) Autonomous System Numbers + (ASNs) of the connections. items: type: integer type: array @@ -2921,7 +3266,8 @@ components: type: string type: array ConnectionTypes: - description: The types of communication tunnels used by the client gateways (only `ipsec.1` is supported). + description: The types of communication tunnels used by the client gateways + (only `ipsec.1` is supported). items: type: string type: array @@ -2931,7 +3277,8 @@ components: type: string type: array States: - description: The states of the client gateways (`pending` \| `available` \| `deleting` \| `deleted`). + description: The states of the client gateways (`pending` \| `available` + \| `deleting` \| `deleted`). items: type: string type: array @@ -2946,7 +3293,8 @@ components: type: string type: array Tags: - description: 'The key/value combination of the tags associated with the client gateways, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' + description: 'The key/value combination of the tags associated with the + client gateways, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' items: type: string type: array @@ -2956,7 +3304,8 @@ components: description: One or more filters. properties: Default: - description: If true, lists all default DHCP options set. If false, lists all non-default DHCP options set. + description: If true, lists all default DHCP options set. If false, lists + all non-default DHCP options set. type: boolean DhcpOptionsSetIds: description: The IDs of the DHCP options sets. @@ -2964,7 +3313,8 @@ components: type: string type: array DomainNameServers: - description: The IPs of the domain name servers used for the DHCP options sets. + description: The IPs of the domain name servers used for the DHCP options + sets. items: type: string type: array @@ -2979,7 +3329,8 @@ components: type: string type: array NtpServers: - description: The IPs of the Network Time Protocol (NTP) servers used for the DHCP options sets. + description: The IPs of the Network Time Protocol (NTP) servers used for + the DHCP options sets. items: type: string type: array @@ -2994,7 +3345,8 @@ components: type: string type: array Tags: - description: 'The key/value combination of the tags associated with the DHCP options sets, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' + description: 'The key/value combination of the tags associated with the + DHCP options sets, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' items: type: string type: array @@ -3039,7 +3391,8 @@ components: description: One or more filters. properties: DeleteOnVmDeletion: - description: Indicates whether the fGPU is deleted when terminating the VM. + description: Indicates whether the fGPU is deleted when terminating the + VM. type: boolean FlexibleGpuIds: description: One or more IDs of fGPUs. @@ -3052,12 +3405,14 @@ components: type: string type: array ModelNames: - description: One or more models of fGPUs. For more information, see [About Flexible GPUs](https://docs.outscale.com/en/userguide/About-Flexible-GPUs.html). + description: One or more models of fGPUs. For more information, see [About + Flexible GPUs](https://docs.outscale.com/en/userguide/About-Flexible-GPUs.html). items: type: string type: array States: - description: The states of the fGPUs (`allocated` \| `attaching` \| `attached` \| `detaching`). + description: The states of the fGPUs (`allocated` \| `attaching` \| `attached` + \| `detaching`). items: type: string type: array @@ -3082,7 +3437,8 @@ components: type: string type: array AccountIds: - description: The account IDs of the owners of the OMIs. By default, all the OMIs for which you have launch permissions are described. + description: The account IDs of the owners of the OMIs. By default, all + the OMIs for which you have launch permissions are described. items: type: string type: array @@ -3092,7 +3448,8 @@ components: type: string type: array BlockDeviceMappingDeleteOnVmDeletion: - description: Whether the volumes are deleted or not when terminating the VM. + description: Whether the volumes are deleted or not when terminating the + VM. type: boolean BlockDeviceMappingDeviceNames: description: The device names for the volumes. @@ -3140,12 +3497,14 @@ components: type: string type: array PermissionsToLaunchAccountIds: - description: The account IDs of the users who have launch permissions for the OMIs. + description: The account IDs of the users who have launch permissions for + the OMIs. items: type: string type: array PermissionsToLaunchGlobalPermission: - description: If true, lists all public OMIs. If false, lists all private OMIs. + description: If true, lists all public OMIs. If false, lists all private + OMIs. type: boolean ProductCodes: description: The product codes associated with the OMI. @@ -3178,7 +3537,8 @@ components: type: string type: array Tags: - description: 'The key/value combination of the tags associated with the OMIs, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' + description: 'The key/value combination of the tags associated with the + OMIs, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' items: type: string type: array @@ -3203,7 +3563,9 @@ components: type: string type: array LinkStates: - description: The current states of the attachments between the Internet services and the Nets (only `available`, if the Internet gateway is attached to a VPC). + description: The current states of the attachments between the Internet + services and the Nets (only `available`, if the Internet gateway is attached + to a VPC). items: type: string type: array @@ -3218,7 +3580,8 @@ components: type: string type: array Tags: - description: 'The key/value combination of the tags associated with the Internet services, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' + description: 'The key/value combination of the tags associated with the + Internet services, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' items: type: string type: array @@ -3273,7 +3636,8 @@ components: type: string type: array States: - description: The states of the NAT services (`pending` \| `available` \| `deleting` \| `deleted`). + description: The states of the NAT services (`pending` \| `available` \| + `deleting` \| `deleted`). items: type: string type: array @@ -3293,7 +3657,8 @@ components: type: string type: array Tags: - description: 'The key/value combination of the tags associated with the NAT services, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' + description: 'The key/value combination of the tags associated with the + NAT services, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' items: type: string type: array @@ -3308,7 +3673,8 @@ components: type: string type: array IpRanges: - description: The IP ranges for the Nets, in CIDR notation (for example, `10.0.0.0/16`). + description: The IP ranges for the Nets, in CIDR notation (for example, + `10.0.0.0/16`). items: type: string type: array @@ -3336,7 +3702,8 @@ components: type: string type: array Tags: - description: 'The key/value combination of the tags associated with the Nets, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' + description: 'The key/value combination of the tags associated with the + Nets, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' items: type: string type: array @@ -3361,7 +3728,8 @@ components: type: string type: array States: - description: The states of the Net access points (`pending` \| `available` \| `deleting` \| `deleted`). + description: The states of the Net access points (`pending` \| `available` + \| `deleting` \| `deleted`). items: type: string type: array @@ -3376,7 +3744,8 @@ components: type: string type: array Tags: - description: 'The key/value combination of the tags associated with the Net access points, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' + description: 'The key/value combination of the tags associated with the + Net access points, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' items: type: string type: array @@ -3391,7 +3760,8 @@ components: type: string type: array AccepterNetIpRanges: - description: The IP ranges of the peer Nets, in CIDR notation (for example, `10.0.0.0/24`). + description: The IP ranges of the peer Nets, in CIDR notation (for example, + `10.0.0.0/24`). items: type: string type: array @@ -3426,7 +3796,8 @@ components: type: string type: array StateNames: - description: The states of the Net peerings (`pending-acceptance` \| `active` \| `rejected` \| `failed` \| `expired` \| `deleted`). + description: The states of the Net peerings (`pending-acceptance` \| `active` + \| `rejected` \| `failed` \| `expired` \| `deleted`). items: type: string type: array @@ -3441,7 +3812,8 @@ components: type: string type: array Tags: - description: 'The key/value combination of the tags associated with the Net peerings, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' + description: 'The key/value combination of the tags associated with the + Net peerings, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' items: type: string type: array @@ -3456,10 +3828,12 @@ components: type: string type: array IsSourceDestCheck: - description: Whether the source/destination checking is enabled (true) or disabled (false). + description: Whether the source/destination checking is enabled (true) or + disabled (false). type: boolean LinkNicDeleteOnVmDeletion: - description: Whether the NICs are deleted when the VMs they are attached to are terminated. + description: Whether the NICs are deleted when the VMs they are attached + to are terminated. type: boolean LinkNicDeviceNumbers: description: The device numbers the NICs are attached to. @@ -3477,7 +3851,8 @@ components: type: string type: array LinkNicVmAccountIds: - description: The account IDs of the owners of the VMs the NICs are attached to. + description: The account IDs of the owners of the VMs the NICs are attached + to. items: type: string type: array @@ -3487,17 +3862,20 @@ components: type: string type: array LinkPublicIpAccountIds: - description: The account IDs of the owners of the public IPs associated with the NICs. + description: The account IDs of the owners of the public IPs associated + with the NICs. items: type: string type: array LinkPublicIpLinkPublicIpIds: - description: The association IDs returned when the public IPs were associated with the NICs. + description: The association IDs returned when the public IPs were associated + with the NICs. items: type: string type: array LinkPublicIpPublicIpIds: - description: The allocation IDs returned when the public IPs were allocated to their accounts. + description: The allocation IDs returned when the public IPs were allocated + to their accounts. items: type: string type: array @@ -3527,7 +3905,8 @@ components: type: string type: array PrivateIpsLinkPublicIpAccountIds: - description: The account IDs of the owner of the public IPs associated with the private IPs. + description: The account IDs of the owner of the public IPs associated with + the private IPs. items: type: string type: array @@ -3537,7 +3916,8 @@ components: type: string type: array PrivateIpsPrimaryIp: - description: Whether the private IP is the primary IP associated with the NIC. + description: Whether the private IP is the primary IP associated with the + NIC. type: boolean PrivateIpsPrivateIps: description: The private IPs of the NICs. @@ -3580,7 +3960,8 @@ components: type: string type: array Tags: - description: 'The key/value combination of the tags associated with the NICs, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' + description: 'The key/value combination of the tags associated with the + NICs, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' items: type: string type: array @@ -3600,7 +3981,8 @@ components: description: One or more filters. properties: LinkPublicIpIds: - description: The IDs representing the associations of public IPs with VMs or NICs. + description: The IDs representing the associations of public IPs with VMs + or NICs. items: type: string type: array @@ -3615,7 +3997,8 @@ components: type: string type: array Placements: - description: Whether the public IPs are for use in the public Cloud or in a Net. + description: Whether the public IPs are for use in the public Cloud or in + a Net. items: type: string type: array @@ -3645,7 +4028,8 @@ components: type: string type: array Tags: - description: 'The key/value combination of the tags associated with the public IPs, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' + description: 'The key/value combination of the tags associated with the + public IPs, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' items: type: string type: array @@ -3670,7 +4054,8 @@ components: type: string type: array QuotaTypes: - description: The resource IDs if these are resource-specific quotas, `global` if they are not. + description: The resource IDs if these are resource-specific quotas, `global` + if they are not. items: type: string type: array @@ -3690,7 +4075,8 @@ components: type: string type: array LinkRouteTableLinkRouteTableIds: - description: The IDs of the associations between the route tables and the Subnets. + description: The IDs of the associations between the route tables and the + Subnets. items: type: string type: array @@ -3763,7 +4149,8 @@ components: type: string type: array Tags: - description: 'The key/value combination of the tags associated with the route tables, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' + description: 'The key/value combination of the tags associated with the + route tables, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' items: type: string type: array @@ -3788,17 +4175,20 @@ components: type: string type: array InboundRuleFromPortRanges: - description: The beginnings of the port ranges for the TCP and UDP protocols, or the ICMP type numbers. + description: The beginnings of the port ranges for the TCP and UDP protocols, + or the ICMP type numbers. items: type: integer type: array InboundRuleIpRanges: - description: The IP ranges that have been granted permissions, in CIDR notation (for example, `10.0.0.0/24`). + description: The IP ranges that have been granted permissions, in CIDR notation + (for example, `10.0.0.0/24`). items: type: string type: array InboundRuleProtocols: - description: The IP protocols for the permissions (`tcp` \| `udp` \| `icmp`, or a protocol number, or `-1` for all protocols). + description: The IP protocols for the permissions (`tcp` \| `udp` \| `icmp`, + or a protocol number, or `-1` for all protocols). items: type: string type: array @@ -3813,12 +4203,14 @@ components: type: string type: array InboundRuleToPortRanges: - description: The ends of the port ranges for the TCP and UDP protocols, or the ICMP code numbers. + description: The ends of the port ranges for the TCP and UDP protocols, + or the ICMP code numbers. items: type: integer type: array NetIds: - description: The IDs of the Nets specified when the security groups were created. + description: The IDs of the Nets specified when the security groups were + created. items: type: string type: array @@ -3828,17 +4220,20 @@ components: type: string type: array OutboundRuleFromPortRanges: - description: The beginnings of the port ranges for the TCP and UDP protocols, or the ICMP type numbers. + description: The beginnings of the port ranges for the TCP and UDP protocols, + or the ICMP type numbers. items: type: integer type: array OutboundRuleIpRanges: - description: The IP ranges that have been granted permissions, in CIDR notation (for example, `10.0.0.0/24`). + description: The IP ranges that have been granted permissions, in CIDR notation + (for example, `10.0.0.0/24`). items: type: string type: array OutboundRuleProtocols: - description: The IP protocols for the permissions (`tcp` \| `udp` \| `icmp`, or a protocol number, or `-1` for all protocols). + description: The IP protocols for the permissions (`tcp` \| `udp` \| `icmp`, + or a protocol number, or `-1` for all protocols). items: type: string type: array @@ -3853,7 +4248,8 @@ components: type: string type: array OutboundRuleToPortRanges: - description: The ends of the port ranges for the TCP and UDP protocols, or the ICMP code numbers. + description: The ends of the port ranges for the TCP and UDP protocols, + or the ICMP code numbers. items: type: integer type: array @@ -3878,7 +4274,8 @@ components: type: string type: array Tags: - description: 'The key/value combination of the tags associated with the security groups, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' + description: 'The key/value combination of the tags associated with the + security groups, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' items: type: string type: array @@ -3928,16 +4325,19 @@ components: type: string type: array FromCreationDate: - description: The beginning of the time period, in ISO 8601 date-time format (for example, `2020-06-14T00:00:00.000Z`). + description: The beginning of the time period, in ISO 8601 date-time format + (for example, `2020-06-14T00:00:00.000Z`). format: date-time type: string PermissionsToCreateVolumeAccountIds: - description: The account IDs of one or more users who have permissions to create volumes. + description: The account IDs of one or more users who have permissions to + create volumes. items: type: string type: array PermissionsToCreateVolumeGlobalPermission: - description: If true, lists all public volumes. If false, lists all private volumes. + description: If true, lists all public volumes. If false, lists all private + volumes. type: boolean Progresses: description: The progresses of the snapshots, as a percentage. @@ -3965,12 +4365,14 @@ components: type: string type: array Tags: - description: 'The key/value combination of the tags associated with the snapshots, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' + description: 'The key/value combination of the tags associated with the + snapshots, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' items: type: string type: array ToCreationDate: - description: The end of the time period, in ISO 8601 date-time format (for example, `2020-06-30T00:00:00.000Z`). + description: The end of the time period, in ISO 8601 date-time format (for + example, `2020-06-30T00:00:00.000Z`). format: date-time type: string VolumeIds: @@ -3979,7 +4381,8 @@ components: type: string type: array VolumeSizes: - description: The sizes of the volumes used to create the snapshots, in gibibytes (GiB). + description: The sizes of the volumes used to create the snapshots, in gibibytes + (GiB). items: type: integer type: array @@ -3994,7 +4397,8 @@ components: type: integer type: array IpRanges: - description: The IP ranges in the Subnets, in CIDR notation (for example, `10.0.0.0/16`). + description: The IP ranges in the Subnets, in CIDR notation (for example, + `10.0.0.0/16`). items: type: string type: array @@ -4029,7 +4433,8 @@ components: type: string type: array Tags: - description: 'The key/value combination of the tags associated with the Subnets, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' + description: 'The key/value combination of the tags associated with the + Subnets, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' items: type: string type: array @@ -4049,7 +4454,9 @@ components: description: One or more filters. properties: Keys: - description: The keys of the tags that are assigned to the resources. You can use this filter alongside the `Values` filter. In that case, you filter the resources corresponding to each tag, regardless of the other filter. + description: The keys of the tags that are assigned to the resources. You + can use this filter alongside the `Values` filter. In that case, you filter + the resources corresponding to each tag, regardless of the other filter. items: type: string type: array @@ -4059,12 +4466,19 @@ components: type: string type: array ResourceTypes: - description: The resource type (`vm` \| `image` \| `volume` \| `snapshot` \| `public-ip` \| `security-group` \| `route-table` \| `nic` \| `net` \| `subnet` \| `net-peering` \| `net-access-point` \| `nat-service` \| `internet-service` \| `client-gateway` \| `virtual-gateway` \| `vpn-connection` \| `dhcp-options` \| `task`). + description: The resource type (`vm` \| `image` \| `volume` \| `snapshot` + \| `public-ip` \| `security-group` \| `route-table` \| `nic` \| `net` + \| `subnet` \| `net-peering` \| `net-access-point` \| `nat-service` \| + `internet-service` \| `client-gateway` \| `virtual-gateway` \| `vpn-connection` + \| `dhcp-options` \| `task`). items: type: string type: array Values: - description: The values of the tags that are assigned to the resources. You can use this filter alongside the `TagKeys` filter. In that case, you filter the resources corresponding to each tag, regardless of the other filter. + description: The values of the tags that are assigned to the resources. + You can use this filter alongside the `TagKeys` filter. In that case, + you filter the resources corresponding to each tag, regardless of the + other filter. items: type: string type: array @@ -4084,12 +4498,14 @@ components: type: string type: array LinkStates: - description: The current states of the attachments between the virtual gateways and the Nets (`attaching` \| `attached` \| `detaching` \| `detached`). + description: The current states of the attachments between the virtual gateways + and the Nets (`attaching` \| `attached` \| `detaching` \| `detached`). items: type: string type: array States: - description: The states of the virtual gateways (`pending` \| `available` \| `deleting` \| `deleted`). + description: The states of the virtual gateways (`pending` \| `available` + \| `deleting` \| `deleted`). items: type: string type: array @@ -4104,7 +4520,8 @@ components: type: string type: array Tags: - description: 'The key/value combination of the tags associated with the virtual gateways, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' + description: 'The key/value combination of the tags associated with the + virtual gateways, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' items: type: string type: array @@ -4129,7 +4546,8 @@ components: type: string type: array Tags: - description: 'The key/value combination of the tags associated with the VMs, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' + description: 'The key/value combination of the tags associated with the + VMs, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' items: type: string type: array @@ -4169,7 +4587,8 @@ components: type: string type: array Tags: - description: 'The key/value combination of the tags associated with the VMs, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' + description: 'The key/value combination of the tags associated with the + VMs, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' items: type: string type: array @@ -4244,7 +4663,8 @@ components: type: string type: array Tags: - description: 'The key/value combination of the tags associated with the VM templates, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' + description: 'The key/value combination of the tags associated with the + VM templates, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' items: type: string type: array @@ -4264,7 +4684,8 @@ components: description: One or more filters. properties: BsuOptimized: - description: This parameter is not available. It is present in our API for the sake of historical compatibility with AWS. + description: This parameter is not available. It is present in our API for + the sake of historical compatibility with AWS. type: boolean MemorySizes: description: The amounts of memory, in gibibytes (GiB). @@ -4278,7 +4699,8 @@ components: type: integer type: array VmTypeNames: - description: The names of the VM types. For more information, see [Instance Types](https://docs.outscale.com/en/userguide/Instance-Types.html). + description: The names of the VM types. For more information, see [Instance + Types](https://docs.outscale.com/en/userguide/Instance-Types.html). items: type: string type: array @@ -4330,7 +4752,8 @@ components: type: string type: array VmStates: - description: The states of the VMs (`pending` \| `running` \| `stopping` \| `stopped` \| `shutting-down` \| `terminated` \| `quarantine`). + description: The states of the VMs (`pending` \| `running` \| `stopping` + \| `stopped` \| `shutting-down` \| `terminated` \| `quarantine`). items: type: string type: array @@ -4340,13 +4763,15 @@ components: description: One or more filters. properties: CreationDates: - description: The dates and times of creation of the volumes, in ISO 8601 date-time format (for example, `2020-06-30T00:00:00.000Z`). + description: The dates and times of creation of the volumes, in ISO 8601 + date-time format (for example, `2020-06-30T00:00:00.000Z`). items: format: date type: string type: array LinkVolumeDeleteOnVmDeletion: - description: Whether the volumes are deleted or not when terminating the VMs. + description: Whether the volumes are deleted or not when terminating the + VMs. type: boolean LinkVolumeDeviceNames: description: The VM device names. @@ -4354,13 +4779,15 @@ components: type: string type: array LinkVolumeLinkDates: - description: The dates and times of creation of the volumes, in ISO 8601 date-time format (for example, `2020-06-30T00:00:00.000Z`). + description: The dates and times of creation of the volumes, in ISO 8601 + date-time format (for example, `2020-06-30T00:00:00.000Z`). items: format: date type: string type: array LinkVolumeLinkStates: - description: The attachment states of the volumes (`attaching` \| `detaching` \| `attached` \| `detached`). + description: The attachment states of the volumes (`attaching` \| `detaching` + \| `attached` \| `detached`). items: type: string type: array @@ -4390,7 +4817,8 @@ components: type: string type: array Tags: - description: 'The key/value combination of the tags associated with the volumes, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' + description: 'The key/value combination of the tags associated with the + volumes, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' items: type: string type: array @@ -4405,7 +4833,8 @@ components: type: integer type: array VolumeStates: - description: The states of the volumes (`creating` \| `available` \| `in-use` \| `updating` \| `deleting` \| `error`). + description: The states of the volumes (`creating` \| `available` \| `in-use` + \| `updating` \| `deleting` \| `error`). items: type: string type: array @@ -4420,7 +4849,8 @@ components: description: One or more filters. properties: BgpAsns: - description: The Border Gateway Protocol (BGP) Autonomous System Numbers (ASNs) of the connections. + description: The Border Gateway Protocol (BGP) Autonomous System Numbers + (ASNs) of the connections. items: type: integer type: array @@ -4440,12 +4870,16 @@ components: type: string type: array States: - description: The states of the VPN connections (`pending` \| `available` \| `deleting` \| `deleted`). + description: The states of the VPN connections (`pending` \| `available` + \| `deleting` \| `deleted`). items: type: string type: array StaticRoutesOnly: - description: If false, the VPN connection uses dynamic routing with Border Gateway Protocol (BGP). If true, routing is controlled using static routes. For more information about how to create and delete static routes, see [CreateVpnConnectionRoute](#createvpnconnectionroute) and [DeleteVpnConnectionRoute](#deletevpnconnectionroute). + description: If false, the VPN connection uses dynamic routing with Border + Gateway Protocol (BGP). If true, routing is controlled using static routes. + For more information about how to create and delete static routes, see + [CreateVpnConnectionRoute](#createvpnconnectionroute) and [DeleteVpnConnectionRoute](#deletevpnconnectionroute). type: boolean TagKeys: description: The keys of the tags associated with the VPN connections. @@ -4458,7 +4892,8 @@ components: type: string type: array Tags: - description: 'The key/value combination of the tags associated with the VPN connections, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' + description: 'The key/value combination of the tags associated with the + VPN connections, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' items: type: string type: array @@ -4487,10 +4922,12 @@ components: description: The compatible processor generation. type: string ModelName: - description: The model of fGPU. For more information, see [About Flexible GPUs](https://docs.outscale.com/en/userguide/About-Flexible-GPUs.html). + description: The model of fGPU. For more information, see [About Flexible + GPUs](https://docs.outscale.com/en/userguide/About-Flexible-GPUs.html). type: string State: - description: The state of the fGPU (`allocated` \| `attaching` \| `attached` \| `detaching`). + description: The state of the fGPU (`allocated` \| `attaching` \| `attached` + \| `detaching`). type: string SubregionName: description: The Subregion where the fGPU is located. @@ -4501,7 +4938,8 @@ components: type: object FlexibleGpuCatalog: additionalProperties: false - description: Information about the flexible GPU (fGPU) that is available in the public catalog. + description: Information about the flexible GPU (fGPU) that is available in + the public catalog. properties: Generations: description: The generations of VMs that the fGPU is compatible with. @@ -4509,10 +4947,12 @@ components: type: string type: array MaxCpu: - description: The maximum number of VM vCores that the fGPU is compatible with. + description: The maximum number of VM vCores that the fGPU is compatible + with. type: integer MaxRam: - description: The maximum amount of VM memory that the fGPU is compatible with. + description: The maximum amount of VM memory that the fGPU is compatible + with. type: integer ModelName: description: The model of fGPU. @@ -4526,10 +4966,12 @@ components: description: Information about the health check configuration. properties: CheckInterval: - description: The number of seconds between two pings (between `5` and `600` both included). + description: The number of seconds between two pings (between `5` and `600` + both included). type: integer HealthyThreshold: - description: The number of consecutive successful pings before considering the VM as healthy (between `2` and `10` both included). + description: The number of consecutive successful pings before considering + the VM as healthy (between `2` and `10` both included). type: integer Path: description: If you use the HTTP or HTTPS protocols, the ping path. @@ -4538,13 +4980,16 @@ components: description: The port number (between `1` and `65535`, both included). type: integer Protocol: - description: The protocol for the URL of the VM (`HTTP` \| `HTTPS` \| `TCP` \| `SSL`). + description: The protocol for the URL of the VM (`HTTP` \| `HTTPS` \| `TCP` + \| `SSL`). type: string Timeout: - description: The maximum waiting time for a response before considering the VM as unhealthy, in seconds (between `2` and `60` both included). + description: The maximum waiting time for a response before considering + the VM as unhealthy, in seconds (between `2` and `60` both included). type: integer UnhealthyThreshold: - description: The number of consecutive failed pings before considering the VM as unhealthy (between `2` and `10` both included). + description: The number of consecutive failed pings before considering the + VM as unhealthy (between `2` and `10` both included). type: integer required: - CheckInterval @@ -4570,10 +5015,11 @@ components: BlockDeviceMappings: description: One or more block device mappings. items: - $ref: '#/components/schemas/BlockDeviceMappingImage' + "$ref": "#/components/schemas/BlockDeviceMappingImage" type: array CreationDate: - description: The date and time of creation of the OMI, in ISO 8601 date-time format. + description: The date and time of creation of the OMI, in ISO 8601 date-time + format. format: date type: string Description: @@ -4592,7 +5038,7 @@ components: description: The type of the OMI. type: string PermissionsToLaunch: - $ref: '#/components/schemas/PermissionsOnResource' + "$ref": "#/components/schemas/PermissionsOnResource" ProductCodes: description: The product codes associated with the OMI. items: @@ -4608,11 +5054,11 @@ components: description: The state of the OMI (`pending` \| `available` \| `failed`). type: string StateComment: - $ref: '#/components/schemas/StateComment' + "$ref": "#/components/schemas/StateComment" Tags: description: One or more tags associated with the OMI. items: - $ref: '#/components/schemas/ResourceTag' + "$ref": "#/components/schemas/ResourceTag" type: array type: object ImageExportTask: @@ -4626,17 +5072,18 @@ components: description: The ID of the OMI to be exported. type: string OsuExport: - $ref: '#/components/schemas/OsuExportImageExportTask' + "$ref": "#/components/schemas/OsuExportImageExportTask" Progress: description: The progress of the OMI export task, as a percentage. type: integer State: - description: The state of the OMI export task (`pending/queued` \| `pending` \| `completed` \| `failed` \| `cancelled`). + description: The state of the OMI export task (`pending/queued` \| `pending` + \| `completed` \| `failed` \| `cancelled`). type: string Tags: description: One or more tags associated with the image export task. items: - $ref: '#/components/schemas/ResourceTag' + "$ref": "#/components/schemas/ResourceTag" type: array TaskId: description: The ID of the OMI export task. @@ -4653,12 +5100,13 @@ components: description: The ID of the Net attached to the Internet service. type: string State: - description: The state of the attachment of the Internet service to the Net (always `available`). + description: The state of the attachment of the Internet service to the + Net (always `available`). type: string Tags: description: One or more tags associated with the Internet service. items: - $ref: '#/components/schemas/ResourceTag' + "$ref": "#/components/schemas/ResourceTag" type: array type: object Keypair: @@ -4666,7 +5114,8 @@ components: description: Information about the keypair. properties: KeypairFingerprint: - description: The MD5 public key fingerprint as specified in section 4 of RFC 4716. + description: The MD5 public key fingerprint as specified in section 4 of + RFC 4716. type: string KeypairName: description: The name of the keypair. @@ -4677,20 +5126,23 @@ components: description: Information about the created keypair. properties: KeypairFingerprint: - description: The MD5 public key fingerprint as specified in section 4 of RFC 4716. + description: The MD5 public key fingerprint as specified in section 4 of + RFC 4716. type: string KeypairName: description: The name of the keypair. type: string PrivateKey: - description: The private key. When saving the private key in a .rsa file, replace the `\n` escape sequences with line breaks. + description: The private key. When saving the private key in a .rsa file, + replace the `\n` escape sequences with line breaks. type: string type: object LinkFlexibleGpuRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean FlexibleGpuId: description: The ID of the fGPU you want to attach. @@ -4706,19 +5158,21 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object LinkInternetServiceRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean InternetServiceId: description: The ID of the Internet service you want to attach. type: string NetId: - description: The ID of the Net to which you want to attach the Internet service. + description: The ID of the Net to which you want to attach the Internet + service. type: string required: - InternetServiceId @@ -4728,26 +5182,27 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object LinkLoadBalancerBackendMachinesRequest: additionalProperties: false properties: BackendIps: - description: ' One or more public IPs of back-end VMs.' + description: " One or more public IPs of back-end VMs." items: type: string type: array BackendVmIds: - description: ' One or more IDs of back-end VMs.' + description: " One or more IDs of back-end VMs." items: type: string type: array DryRun: - description: ' If true, checks whether you have the required permissions to perform the action.' + description: " If true, checks whether you have the required permissions + to perform the action." type: boolean LoadBalancerName: - description: ' The name of the load balancer. ' + description: " The name of the load balancer. " type: string required: - LoadBalancerName @@ -4756,7 +5211,7 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object LinkNic: additionalProperties: false @@ -4766,13 +5221,15 @@ components: description: If true, the NIC is deleted when the VM is terminated. type: boolean DeviceNumber: - description: The device index for the NIC attachment (between `1` and `7`, both included). + description: The device index for the NIC attachment (between `1` and `7`, + both included). type: integer LinkNicId: description: The ID of the NIC to attach. type: string State: - description: The state of the attachment (`attaching` \| `attached` \| `detaching` \| `detached`). + description: The state of the attachment (`attaching` \| `attached` \| `detaching` + \| `detached`). type: string VmAccountId: description: The account ID of the owner of the VM. @@ -4789,23 +5246,27 @@ components: description: If true, the NIC is deleted when the VM is terminated. type: boolean DeviceNumber: - description: The device index for the NIC attachment (between `1` and `7`, both included). + description: The device index for the NIC attachment (between `1` and `7`, + both included). type: integer LinkNicId: description: The ID of the NIC to attach. type: string State: - description: The state of the attachment (`attaching` \| `attached` \| `detaching` \| `detached`). + description: The state of the attachment (`attaching` \| `attached` \| `detaching` + \| `detached`). type: string type: object LinkNicRequest: additionalProperties: false properties: DeviceNumber: - description: The index of the VM device for the NIC attachment (between `1` and `7`, both included). + description: The index of the VM device for the NIC attachment (between + `1` and `7`, both included). type: integer DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean NicId: description: The ID of the NIC you want to attach. @@ -4825,14 +5286,16 @@ components: description: The ID of the NIC attachment. type: string ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object LinkNicToUpdate: additionalProperties: false - description: Information about the NIC attachment. If you are modifying the `DeleteOnVmDeletion` attribute, you must specify the ID of the NIC attachment. + description: Information about the NIC attachment. If you are modifying the + `DeleteOnVmDeletion` attribute, you must specify the ID of the NIC attachment. properties: DeleteOnVmDeletion: - description: If true, the NIC is deleted when the VM is terminated. If false, the NIC is detached from the VM. + description: If true, the NIC is deleted when the VM is terminated. If false, + the NIC is detached from the VM. type: boolean LinkNicId: description: The ID of the NIC attachment. @@ -4842,16 +5305,19 @@ components: additionalProperties: false properties: AllowRelink: - description: If true, allows an IP that is already assigned to another NIC in the same Subnet to be assigned to the NIC you specified. + description: If true, allows an IP that is already assigned to another NIC + in the same Subnet to be assigned to the NIC you specified. type: boolean DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean NicId: description: The ID of the NIC. type: string PrivateIps: - description: The secondary private IP or IPs you want to assign to the NIC within the IP range of the Subnet. + description: The secondary private IP or IPs you want to assign to the NIC + within the IP range of the Subnet. items: type: string type: array @@ -4865,14 +5331,15 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object LinkPublicIp: additionalProperties: false description: Information about the public IP association. properties: LinkPublicIpId: - description: (Required in a Net) The ID representing the association of the public IP with the VM or the NIC. + description: "(Required in a Net) The ID representing the association of + the public IP with the VM or the NIC." type: string PublicDnsName: description: The name of the public DNS. @@ -4905,39 +5372,50 @@ components: additionalProperties: false properties: AllowRelink: - description: If true, allows the public IP to be associated with the VM or NIC that you specify even if it is already associated with another VM or NIC. If false, prevents the EIP from being associated with the VM or NIC that you specify if it is already associated with another VM or NIC. (By default, true in the public Cloud, false in a Net.) + description: If true, allows the public IP to be associated with the VM + or NIC that you specify even if it is already associated with another + VM or NIC. If false, prevents the EIP from being associated with the VM + or NIC that you specify if it is already associated with another VM or + NIC. (By default, true in the public Cloud, false in a Net.) type: boolean DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean NicId: - description: (Net only) The ID of the NIC. This parameter is required if the VM has more than one NIC attached. Otherwise, you need to specify the `VmId` parameter instead. You cannot specify both parameters at the same time. + description: "(Net only) The ID of the NIC. This parameter is required if + the VM has more than one NIC attached. Otherwise, you need to specify + the `VmId` parameter instead. You cannot specify both parameters at the + same time." type: string PrivateIp: - description: (Net only) The primary or secondary private IP of the specified NIC. By default, the primary private IP. + description: "(Net only) The primary or secondary private IP of the specified + NIC. By default, the primary private IP." type: string PublicIp: - description: The public IP. This parameter is required unless you use the `PublicIpId` parameter. + description: The public IP. This parameter is required unless you use the + `PublicIpId` parameter. type: string PublicIpId: - description: The allocation ID of the public IP. This parameter is required unless you use the `PublicIp` parameter. + description: The allocation ID of the public IP. This parameter is required + unless you use the `PublicIp` parameter. type: string VmId: - description: 'The ID of the VM.
- + description: |- + The ID of the VM.
- In the public Cloud, this parameter is required.
- - - In a Net, this parameter is required if the VM has only one NIC. Otherwise, you need to specify the `NicId` parameter instead. You cannot specify both parameters at the same time.' + - In a Net, this parameter is required if the VM has only one NIC. Otherwise, you need to specify the `NicId` parameter instead. You cannot specify both parameters at the same time. type: string type: object LinkPublicIpResponse: additionalProperties: false properties: LinkPublicIpId: - description: (Net only) The ID representing the association of the public IP with the VM or the NIC. + description: "(Net only) The ID representing the association of the public + IP with the VM or the NIC." type: string ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object LinkRouteTable: additionalProperties: false @@ -4960,7 +5438,8 @@ components: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean RouteTableId: description: The ID of the route table. @@ -4979,13 +5458,14 @@ components: description: The ID of the association between the route table and the Subnet. type: string ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object LinkVirtualGatewayRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean NetId: description: The ID of the Net to which you want to attach the virtual gateway. @@ -5001,18 +5481,22 @@ components: additionalProperties: false properties: NetToVirtualGatewayLink: - $ref: '#/components/schemas/NetToVirtualGatewayLink' + "$ref": "#/components/schemas/NetToVirtualGatewayLink" ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object LinkVolumeRequest: additionalProperties: false properties: DeviceName: - description: The name of the device. For a root device, you must use `/dev/sda1`. For other volumes, you must use `/dev/sdX`, `/dev/sdXX`, `/dev/xvdX`, or `/dev/xvdXX` (where the first `X` is a letter between `b` and `z`, and the second `X` is a letter between `a` and `z`). + description: The name of the device. For a root device, you must use `/dev/sda1`. + For other volumes, you must use `/dev/sdX`, `/dev/sdXX`, `/dev/xvdX`, + or `/dev/xvdXX` (where the first `X` is a letter between `b` and `z`, + and the second `X` is a letter between `a` and `z`). type: string DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean VmId: description: The ID of the VM you want to attach the volume to. @@ -5029,20 +5513,22 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object LinkedVolume: additionalProperties: false description: Information about volume attachment. properties: DeleteOnVmDeletion: - description: If true, the volume is deleted when terminating the VM. If false, the volume is not deleted when terminating the VM. + description: If true, the volume is deleted when terminating the VM. If + false, the volume is not deleted when terminating the VM. type: boolean DeviceName: description: The name of the device. type: string State: - description: The state of the attachment of the volume (`attaching` \| `detaching` \| `attached` \| `detached`). + description: The state of the attachment of the volume (`attaching` \| `detaching` + \| `attached` \| `detached`). type: string VmId: description: The ID of the VM. @@ -5056,24 +5542,30 @@ components: description: Information about the listener. properties: BackendPort: - description: The port on which the back-end VM is listening (between `1` and `65535`, both included). + description: The port on which the back-end VM is listening (between `1` + and `65535`, both included). type: integer BackendProtocol: - description: The protocol for routing traffic to back-end VMs (`HTTP` \| `HTTPS` \| `TCP` \| `SSL`). + description: The protocol for routing traffic to back-end VMs (`HTTP` \| + `HTTPS` \| `TCP` \| `SSL`). type: string LoadBalancerPort: - description: The port on which the load balancer is listening (between `1` and `65535`, both included). + description: The port on which the load balancer is listening (between `1` + and `65535`, both included). type: integer LoadBalancerProtocol: description: The routing protocol (`HTTP` \| `HTTPS` \| `TCP` \| `SSL`). type: string PolicyNames: - description: The names of the policies. If there are no policies enabled, the list is empty. + description: The names of the policies. If there are no policies enabled, + the list is empty. items: type: string type: array 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). type: string type: object ListenerForCreation: @@ -5081,19 +5573,24 @@ components: description: Information about the listener to create. properties: BackendPort: - description: The port on which the back-end VM is listening (between `1` and `65535`, both included). + description: The port on which the back-end VM is listening (between `1` + and `65535`, both included). type: integer BackendProtocol: - description: The protocol for routing traffic to back-end VMs (`HTTP` \| `HTTPS` \| `TCP` \| `SSL`). + description: The protocol for routing traffic to back-end VMs (`HTTP` \| + `HTTPS` \| `TCP` \| `SSL`). type: string LoadBalancerPort: - description: The port on which the load balancer is listening (between `1` and `65535`, both included). + description: The port on which the load balancer is listening (between `1` + and `65535`, both included). type: integer LoadBalancerProtocol: 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). type: string required: - BackendPort @@ -5108,7 +5605,9 @@ components: description: The type of action for the rule (always `forward`). type: string HostNamePattern: - description: A host-name pattern for the rule, with a maximum length of 128 characters. This host-name pattern supports maximum three wildcards, and must not contain any special characters except [-.?]. + description: A host-name pattern for the rule, with a maximum length of + 128 characters. This host-name pattern supports maximum three wildcards, + and must not contain any special characters except [-.?]. type: string ListenerId: description: The ID of the listener. @@ -5120,10 +5619,14 @@ components: description: A human-readable name for the listener rule. type: string PathPattern: - description: A path pattern for the rule, with a maximum length of 128 characters. This path pattern supports maximum three wildcards, and must not contain any special characters except [_-.$/~"'@:+?]. + description: A path pattern for the rule, with a maximum length of 128 characters. + This path pattern supports maximum three wildcards, and must not contain + any special characters except [_-.$/~"'@:+?]. type: string Priority: - description: The priority level of the listener rule, between `1` and `19999` both included. Each rule must have a unique priority level. Otherwise, an error is returned. + description: The priority level of the listener rule, between `1` and `19999` + both included. Each rule must have a unique priority level. Otherwise, + an error is returned. type: integer VmIds: description: The IDs of the backend VMs. @@ -5139,16 +5642,22 @@ components: description: The type of action for the rule (always `forward`). type: string HostNamePattern: - description: 'A host-name pattern for the rule, with a maximum length of 128 characters. This host-name pattern supports maximum three wildcards, and must not contain any special characters except [-.?]. ' + description: 'A host-name pattern for the rule, with a maximum length of + 128 characters. This host-name pattern supports maximum three wildcards, + and must not contain any special characters except [-.?]. ' type: string ListenerRuleName: description: A human-readable name for the listener rule. type: string PathPattern: - description: A path pattern for the rule, with a maximum length of 128 characters. This path pattern supports maximum three wildcards, and must not contain any special characters except [_-.$/~"'@:+?]. + description: A path pattern for the rule, with a maximum length of 128 characters. + This path pattern supports maximum three wildcards, and must not contain + any special characters except [_-.$/~"'@:+?]. type: string Priority: - description: The priority level of the listener rule, between `1` and `19999` both included. Each rule must have a unique priority level. Otherwise, an error is returned. + description: The priority level of the listener rule, between `1` and `19999` + both included. Each rule must have a unique priority level. Otherwise, + an error is returned. type: integer required: - ListenerRuleName @@ -5159,11 +5668,11 @@ components: description: Information about the load balancer. properties: AccessLog: - $ref: '#/components/schemas/AccessLog' + "$ref": "#/components/schemas/AccessLog" ApplicationStickyCookiePolicies: description: The stickiness policies defined for the load balancer. items: - $ref: '#/components/schemas/ApplicationStickyCookiePolicy' + "$ref": "#/components/schemas/ApplicationStickyCookiePolicy" type: array BackendIps: description: One or more public IPs of back-end VMs. @@ -5179,11 +5688,11 @@ components: description: The DNS name of the load balancer. type: string HealthCheck: - $ref: '#/components/schemas/HealthCheck' + "$ref": "#/components/schemas/HealthCheck" Listeners: description: The listeners for the load balancer. items: - $ref: '#/components/schemas/Listener' + "$ref": "#/components/schemas/Listener" type: array LoadBalancerName: description: The name of the load balancer. @@ -5191,31 +5700,32 @@ components: LoadBalancerStickyCookiePolicies: description: The policies defined for the load balancer. items: - $ref: '#/components/schemas/LoadBalancerStickyCookiePolicy' + "$ref": "#/components/schemas/LoadBalancerStickyCookiePolicy" type: array LoadBalancerType: - description: 'The type of load balancer. Valid only for load balancers in a Net.
- + description: |- + The type of load balancer. Valid only for load balancers in a Net.
If `LoadBalancerType` is `internet-facing`, the load balancer has a public DNS name that resolves to a public IP.
- - If `LoadBalancerType` is `internal`, the load balancer has a public DNS name that resolves to a private IP.' + If `LoadBalancerType` is `internal`, the load balancer has a public DNS name that resolves to a private IP. type: string NetId: description: The ID of the Net for the load balancer. type: string PublicIp: - description: (internet-facing only) The public IP associated with the load balancer. + description: "(internet-facing only) The public IP associated with the load + balancer." type: string SecuredCookies: description: Whether secure cookies are enabled for the load balancer. type: boolean SecurityGroups: - description: One or more IDs of security groups for the load balancers. Valid only for load balancers in a Net. + description: One or more IDs of security groups for the load balancers. + Valid only for load balancers in a Net. items: type: string type: array SourceSecurityGroup: - $ref: '#/components/schemas/SourceSecurityGroup' + "$ref": "#/components/schemas/SourceSecurityGroup" Subnets: description: The ID of the Subnet in which the load balancer was created. items: @@ -5229,7 +5739,7 @@ components: Tags: description: One or more tags associated with the load balancer. items: - $ref: '#/components/schemas/ResourceTag' + "$ref": "#/components/schemas/ResourceTag" type: array type: object LoadBalancerLight: @@ -5240,7 +5750,8 @@ components: description: The name of the load balancer to which the listener is attached. type: string LoadBalancerPort: - description: The port of load balancer on which the load balancer is listening (between `1` and `65535` both included). + description: The port of load balancer on which the load balancer is listening + (between `1` and `65535` both included). type: integer required: - LoadBalancerName @@ -5251,9 +5762,9 @@ components: description: Information about the stickiness policy. properties: CookieExpirationPeriod: - description: 'The time period, in seconds, after which the cookie should be considered stale.
- - If `1`, the stickiness session lasts for the duration of the browser session.' + description: |- + The time period, in seconds, after which the cookie should be considered stale.
+ If `1`, the stickiness session lasts for the duration of the browser session. type: integer PolicyName: description: The name of the stickiness policy. @@ -5278,10 +5789,12 @@ components: description: Information about the DirectLink location. properties: Code: - description: The location code, to be set as the `Location` parameter of the *CreateDirectLink* method when creating a DirectLink. + description: The location code, to be set as the `Location` parameter of + the *CreateDirectLink* method when creating a DirectLink. type: string Name: - description: The name and description of the location, corresponding to a datacenter. + description: The name and description of the location, corresponding to + a datacenter. type: string type: object Log: @@ -5298,7 +5811,8 @@ components: description: The access key used for the logged call. type: string QueryApiName: - description: The name of the API used by the logged call (always `oapi` for the OUTSCALE API). + description: The name of the API used by the logged call (always `oapi` + for the OUTSCALE API). type: string QueryApiVersion: description: The version of the API used by the logged call. @@ -5307,14 +5821,16 @@ components: description: The name of the logged call. type: string QueryDate: - description: The date and time of the logged call, in ISO 8601 date-time format. + description: The date and time of the logged call, in ISO 8601 date-time + format. format: date type: string QueryHeaderRaw: description: The raw header of the HTTP request of the logged call. type: string QueryHeaderSize: - description: The size of the raw header of the HTTP request of the logged call, in bytes. + description: The size of the raw header of the HTTP request of the logged + call, in bytes. type: integer QueryIpAddress: description: The IP used for the logged call. @@ -5323,7 +5839,8 @@ components: description: The raw payload of the HTTP request of the logged call. type: string QueryPayloadSize: - description: The size of the raw payload of the HTTP request of the logged call, in bytes. + description: The size of the raw payload of the HTTP request of the logged + call, in bytes. type: integer QueryUserAgent: description: The user agent of the HTTP request of the logged call. @@ -5368,12 +5885,14 @@ components: description: The ID of the Net in which the NAT service is. type: string PublicIps: - description: Information about the public IP or IPs associated with the NAT service. + description: Information about the public IP or IPs associated with the + NAT service. items: - $ref: '#/components/schemas/PublicIpLight' + "$ref": "#/components/schemas/PublicIpLight" type: array State: - description: The state of the NAT service (`pending` \| `available` \| `deleting` \| `deleted`). + description: The state of the NAT service (`pending` \| `available` \| `deleting` + \| `deleted`). type: string SubnetId: description: The ID of the Subnet in which the NAT service is. @@ -5381,7 +5900,7 @@ components: Tags: description: One or more tags associated with the NAT service. items: - $ref: '#/components/schemas/ResourceTag' + "$ref": "#/components/schemas/ResourceTag" type: array type: object Net: @@ -5389,7 +5908,8 @@ components: description: Information about the Net. properties: DhcpOptionsSetId: - description: The ID of the DHCP options set (or `default` if you want to associate the default one). + description: The ID of the DHCP options set (or `default` if you want to + associate the default one). type: string IpRange: description: The IP range for the Net, in CIDR notation (for example, `10.0.0.0/16`). @@ -5403,7 +5923,7 @@ components: Tags: description: One or more tags associated with the Net. items: - $ref: '#/components/schemas/ResourceTag' + "$ref": "#/components/schemas/ResourceTag" type: array Tenancy: description: The VM tenancy in a Net. @@ -5425,15 +5945,17 @@ components: type: string type: array ServiceName: - description: The name of the service with which the Net access point is associated. + description: The name of the service with which the Net access point is + associated. type: string State: - description: The state of the Net access point (`pending` \| `available` \| `deleting` \| `deleted`). + description: The state of the Net access point (`pending` \| `available` + \| `deleting` \| `deleted`). type: string Tags: description: One or more tags associated with the Net access point. items: - $ref: '#/components/schemas/ResourceTag' + "$ref": "#/components/schemas/ResourceTag" type: array type: object NetPeering: @@ -5441,18 +5963,18 @@ components: description: Information about the Net peering. properties: AccepterNet: - $ref: '#/components/schemas/AccepterNet' + "$ref": "#/components/schemas/AccepterNet" NetPeeringId: description: The ID of the Net peering. type: string SourceNet: - $ref: '#/components/schemas/SourceNet' + "$ref": "#/components/schemas/SourceNet" State: - $ref: '#/components/schemas/NetPeeringState' + "$ref": "#/components/schemas/NetPeeringState" Tags: description: One or more tags associated with the Net peering. items: - $ref: '#/components/schemas/ResourceTag' + "$ref": "#/components/schemas/ResourceTag" type: array type: object NetPeeringState: @@ -5463,7 +5985,8 @@ components: description: Additional information about the state of the Net peering. type: string Name: - description: The state of the Net peering (`pending-acceptance` \| `active` \| `rejected` \| `failed` \| `expired` \| `deleted`). + description: The state of the Net peering (`pending-acceptance` \| `active` + \| `rejected` \| `failed` \| `expired` \| `deleted`). type: string type: object NetToVirtualGatewayLink: @@ -5474,7 +5997,8 @@ components: description: The ID of the Net to which the virtual gateway is attached. type: string State: - description: The state of the attachment (`attaching` \| `attached` \| `detaching` \| `detached`). + description: The state of the attachment (`attaching` \| `attached` \| `detaching` + \| `detached`). type: string type: object Nic: @@ -5488,12 +6012,14 @@ components: description: The description of the NIC. type: string IsSourceDestChecked: - description: (Net only) If true, the source/destination check is enabled. If false, it is disabled. This value must be false for a NAT VM to perform network address translation (NAT) in a Net. + description: "(Net only) If true, the source/destination check is enabled. + If false, it is disabled. This value must be false for a NAT VM to perform + network address translation (NAT) in a Net." type: boolean LinkNic: - $ref: '#/components/schemas/LinkNic' + "$ref": "#/components/schemas/LinkNic" LinkPublicIp: - $ref: '#/components/schemas/LinkPublicIp' + "$ref": "#/components/schemas/LinkPublicIp" MacAddress: description: The Media Access Control (MAC) address of the NIC. type: string @@ -5509,15 +6035,16 @@ components: PrivateIps: description: The private IPs of the NIC. items: - $ref: '#/components/schemas/PrivateIp' + "$ref": "#/components/schemas/PrivateIp" type: array SecurityGroups: description: One or more IDs of security groups for the NIC. items: - $ref: '#/components/schemas/SecurityGroupLight' + "$ref": "#/components/schemas/SecurityGroupLight" type: array State: - description: The state of the NIC (`available` \| `attaching` \| `in-use` \| `detaching`). + description: The state of the NIC (`available` \| `attaching` \| `in-use` + \| `detaching`). type: string SubnetId: description: The ID of the Subnet. @@ -5528,40 +6055,54 @@ components: Tags: description: One or more tags associated with the NIC. items: - $ref: '#/components/schemas/ResourceTag' + "$ref": "#/components/schemas/ResourceTag" type: array type: object NicForVmCreation: additionalProperties: false - description: Information about the network interface card (NIC) when creating a virtual machine (VM). + description: Information about the network interface card (NIC) when creating + a virtual machine (VM). properties: DeleteOnVmDeletion: - description: If true, the NIC is deleted when the VM is terminated. You can specify this parameter only for a new NIC. To modify this value for an existing NIC, see [UpdateNic](#updatenic). + description: If true, the NIC is deleted when the VM is terminated. You + can specify this parameter only for a new NIC. To modify this value for + an existing NIC, see [UpdateNic](#updatenic). type: boolean Description: - description: The description of the NIC, if you are creating a NIC when creating the VM. + description: The description of the NIC, if you are creating a NIC when + creating the VM. type: string DeviceNumber: - description: The index of the VM device for the NIC attachment (between `0` and `7`, both included). This parameter is required if you create a NIC when creating the VM. + description: The index of the VM device for the NIC attachment (between + `0` and `7`, both included). This parameter is required if you create + a NIC when creating the VM. type: integer NicId: - description: The ID of the NIC, if you are attaching an existing NIC when creating a VM. + description: The ID of the NIC, if you are attaching an existing NIC when + creating a VM. type: string PrivateIps: - description: One or more private IPs to assign to the NIC, if you create a NIC when creating a VM. Only one private IP can be the primary private IP. + description: One or more private IPs to assign to the NIC, if you create + a NIC when creating a VM. Only one private IP can be the primary private + IP. items: - $ref: '#/components/schemas/PrivateIpLight' + "$ref": "#/components/schemas/PrivateIpLight" type: array SecondaryPrivateIpCount: - description: The number of secondary private IPs, if you create a NIC when creating a VM. This parameter cannot be specified if you specified more than one private IP in the `PrivateIps` parameter. + description: The number of secondary private IPs, if you create a NIC when + creating a VM. This parameter cannot be specified if you specified more + than one private IP in the `PrivateIps` parameter. type: integer SecurityGroupIds: - description: One or more IDs of security groups for the NIC, if you create a NIC when creating a VM. + description: One or more IDs of security groups for the NIC, if you create + a NIC when creating a VM. items: type: string type: array SubnetId: - description: The ID of the Subnet for the NIC, if you create a NIC when creating a VM. This parameter is required if you create a NIC when creating the VM. + description: The ID of the Subnet for the NIC, if you create a NIC when + creating a VM. This parameter is required if you create a NIC when creating + the VM. type: string type: object NicLight: @@ -5575,12 +6116,14 @@ components: description: The description of the NIC. type: string IsSourceDestChecked: - description: (Net only) If true, the source/destination check is enabled. If false, it is disabled. This value must be false for a NAT VM to perform network address translation (NAT) in a Net. + description: "(Net only) If true, the source/destination check is enabled. + If false, it is disabled. This value must be false for a NAT VM to perform + network address translation (NAT) in a Net." type: boolean LinkNic: - $ref: '#/components/schemas/LinkNicLight' + "$ref": "#/components/schemas/LinkNicLight" LinkPublicIp: - $ref: '#/components/schemas/LinkPublicIpLightForVm' + "$ref": "#/components/schemas/LinkPublicIpLightForVm" MacAddress: description: The Media Access Control (MAC) address of the NIC. type: string @@ -5596,15 +6139,16 @@ components: PrivateIps: description: The private IP or IPs of the NIC. items: - $ref: '#/components/schemas/PrivateIpLightForVm' + "$ref": "#/components/schemas/PrivateIpLightForVm" type: array SecurityGroups: description: One or more IDs of security groups for the NIC. items: - $ref: '#/components/schemas/SecurityGroupLight' + "$ref": "#/components/schemas/SecurityGroupLight" type: array State: - description: The state of the NIC (`available` \| `attaching` \| `in-use` \| `detaching`). + description: The state of the NIC (`available` \| `attaching` \| `in-use` + \| `detaching`). type: string SubnetId: description: The ID of the Subnet for the NIC. @@ -5615,10 +6159,12 @@ components: description: Information about the OOS API key. properties: ApiKeyId: - description: The API key of the OOS account that enables you to access the bucket. + description: The API key of the OOS account that enables you to access the + bucket. type: string SecretKey: - description: The secret key of the OOS account that enables you to access the bucket. + description: The secret key of the OOS account that enables you to access + the bucket. type: string type: object OsuExportImageExportTask: @@ -5635,7 +6181,8 @@ components: description: The URL of the manifest file. type: string OsuPrefix: - description: The prefix for the key of the OOS object corresponding to the image. + description: The prefix for the key of the OOS object corresponding to the + image. type: string required: - DiskImageFormat @@ -5652,7 +6199,8 @@ components: description: The name of the OOS bucket the snapshot is exported to. type: string OsuPrefix: - description: The prefix for the key of the OOS object corresponding to the snapshot. + description: The prefix for the key of the OOS object corresponding to the + snapshot. type: string required: - DiskImageFormat @@ -5666,7 +6214,7 @@ components: description: The format of the export disk (`qcow2` \| `raw`). type: string OsuApiKey: - $ref: '#/components/schemas/OsuApiKey' + "$ref": "#/components/schemas/OsuApiKey" OsuBucket: description: The name of the OOS bucket where you want to export the object. type: string @@ -5690,62 +6238,70 @@ components: type: string type: array GlobalPermission: - description: 'A global permission for all accounts.
- + description: |- + A global permission for all accounts.
(Request) Set this parameter to true to make the resource public (if the parent parameter is `Additions`) or to make the resource private (if the parent parameter is `Removals`).
- - (Response) If true, the resource is public. If false, the resource is private.' + (Response) If true, the resource is public. If false, the resource is private. type: boolean type: object PermissionsOnResourceCreation: additionalProperties: false - description: 'Information about the permissions for the resource.
- - Specify either the `Additions` or the `Removals` parameter.' + description: |- + Information about the permissions for the resource.
+ Specify either the `Additions` or the `Removals` parameter. properties: Additions: - $ref: '#/components/schemas/PermissionsOnResource' + "$ref": "#/components/schemas/PermissionsOnResource" Removals: - $ref: '#/components/schemas/PermissionsOnResource' + "$ref": "#/components/schemas/PermissionsOnResource" type: object Phase1Options: additionalProperties: false - description: 'Information about Phase 1 of the Internet Key Exchange (IKE) negotiation. When Phase 1 finishes successfully, peers proceed to Phase 2 negotiations. ' + description: 'Information about Phase 1 of the Internet Key Exchange (IKE) negotiation. + When Phase 1 finishes successfully, peers proceed to Phase 2 negotiations. ' properties: DpdTimeoutAction: - description: The action to carry out after a Dead Peer Detection (DPD) timeout occurs. + description: The action to carry out after a Dead Peer Detection (DPD) timeout + occurs. type: string DpdTimeoutSeconds: - description: The maximum waiting time for a Dead Peer Detection (DPD) response before considering the peer as dead, in seconds. + description: The maximum waiting time for a Dead Peer Detection (DPD) response + before considering the peer as dead, in seconds. type: integer IkeVersions: - description: The Internet Key Exchange (IKE) versions allowed for the VPN tunnel. + description: The Internet Key Exchange (IKE) versions allowed for the VPN + tunnel. items: type: string type: array Phase1DhGroupNumbers: - description: The Diffie-Hellman (DH) group numbers allowed for the VPN tunnel for phase 1. + description: The Diffie-Hellman (DH) group numbers allowed for the VPN tunnel + for phase 1. items: type: integer type: array Phase1EncryptionAlgorithms: - description: The encryption algorithms allowed for the VPN tunnel for phase 1. + description: The encryption algorithms allowed for the VPN tunnel for phase + 1. items: type: string type: array Phase1IntegrityAlgorithms: - description: The integrity algorithms allowed for the VPN tunnel for phase 1. + description: The integrity algorithms allowed for the VPN tunnel for phase + 1. items: type: string type: array Phase1LifetimeSeconds: - description: The lifetime for phase 1 of the IKE negotiation process, in seconds. + description: The lifetime for phase 1 of the IKE negotiation process, in + seconds. type: integer ReplayWindowSize: description: The number of packets in an IKE replay window. type: integer StartupAction: - description: The action to carry out when establishing tunnels for a VPN connection. + description: The action to carry out when establishing tunnels for a VPN + connection. type: string type: object Phase2Options: @@ -5753,25 +6309,31 @@ components: description: 'Information about Phase 2 of the Internet Key Exchange (IKE) negotiation. ' properties: Phase2DhGroupNumbers: - description: The Diffie-Hellman (DH) group numbers allowed for the VPN tunnel for phase 2. + description: The Diffie-Hellman (DH) group numbers allowed for the VPN tunnel + for phase 2. items: type: integer type: array Phase2EncryptionAlgorithms: - description: The encryption algorithms allowed for the VPN tunnel for phase 2. + description: The encryption algorithms allowed for the VPN tunnel for phase + 2. items: type: string type: array Phase2IntegrityAlgorithms: - description: The integrity algorithms allowed for the VPN tunnel for phase 2. + description: The integrity algorithms allowed for the VPN tunnel for phase + 2. items: type: string type: array Phase2LifetimeSeconds: - description: The lifetime for phase 2 of the Internet Key Exchange (IKE) negociation process, in seconds. + description: The lifetime for phase 2 of the Internet Key Exchange (IKE) + negociation process, in seconds. type: integer PreSharedKey: - description: The pre-shared key to establish the initial authentication between the client gateway and the virtual gateway. This key can contain any character except line breaks and double quotes ("). + description: The pre-shared key to establish the initial authentication + between the client gateway and the virtual gateway. This key can contain + any character except line breaks and double quotes ("). type: string type: object Placement: @@ -5779,7 +6341,8 @@ components: description: Information about the placement of the VM. properties: SubregionName: - description: The name of the Subregion. If you specify this parameter, you must not specify the `Nics` parameter. + description: The name of the Subregion. If you specify this parameter, you + must not specify the `Nics` parameter. type: string Tenancy: description: The tenancy of the VM (`default` \| `dedicated`). @@ -5793,7 +6356,7 @@ components: description: If true, the IP is the primary private IP of the NIC. type: boolean LinkPublicIp: - $ref: '#/components/schemas/LinkPublicIp' + "$ref": "#/components/schemas/LinkPublicIp" PrivateDnsName: description: The name of the private DNS. type: string @@ -5820,7 +6383,7 @@ components: description: If true, the IP is the primary private IP of the NIC. type: boolean LinkPublicIp: - $ref: '#/components/schemas/LinkPublicIpLightForVm' + "$ref": "#/components/schemas/LinkPublicIpLightForVm" PrivateDnsName: description: The name of the private DNS. type: string @@ -5847,7 +6410,8 @@ components: description: Information about the public IP. properties: LinkPublicIpId: - description: (Required in a Net) The ID representing the association of the public IP with the VM or the NIC. + description: "(Required in a Net) The ID representing the association of + the public IP with the VM or the NIC." type: string NicAccountId: description: The account ID of the owner of the NIC. @@ -5867,7 +6431,7 @@ components: Tags: description: One or more tags associated with the public IP. items: - $ref: '#/components/schemas/ResourceTag' + "$ref": "#/components/schemas/ResourceTag" type: array VmId: description: The ID of the VM the public IP is associated with (if any). @@ -5881,7 +6445,8 @@ components: description: The public IP associated with the NAT service. type: string PublicIpId: - description: The allocation ID of the public IP associated with the NAT service. + description: The allocation ID of the public IP associated with the NAT + service. type: string type: object Quota: @@ -5895,7 +6460,8 @@ components: description: The description of the quota. type: string MaxValue: - description: The maximum value of the quota for the OUTSCALE user account (if there is no limit, `0`). + description: The maximum value of the quota for the OUTSCALE user account + (if there is no limit, `0`). type: integer Name: description: The unique name of the quota. @@ -5915,22 +6481,28 @@ components: description: One or more quotas. properties: QuotaType: - description: The resource ID if it is a resource-specific quota, `global` if it is not. + description: The resource ID if it is a resource-specific quota, `global` + if it is not. type: string Quotas: description: One or more quotas associated with the user. items: - $ref: '#/components/schemas/Quota' + "$ref": "#/components/schemas/Quota" type: array type: object ReadAccessKeysRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Filters: - $ref: '#/components/schemas/FiltersAccessKeys' + "$ref": "#/components/schemas/FiltersAccessKeys" + UserName: + description: The name of the EIM user. By default, the user who sends the + request (which can be the root account). + type: string type: object ReadAccessKeysResponse: additionalProperties: false @@ -5938,16 +6510,17 @@ components: AccessKeys: description: A list of access keys. items: - $ref: '#/components/schemas/AccessKey' + "$ref": "#/components/schemas/AccessKey" type: array ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object ReadAccountsRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean type: object ReadAccountsResponse: @@ -5956,16 +6529,17 @@ components: Accounts: description: The list of the accounts. items: - $ref: '#/components/schemas/Account' + "$ref": "#/components/schemas/Account" type: array ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object ReadAdminPasswordRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean VmId: description: The ID of the VM. @@ -5977,10 +6551,11 @@ components: additionalProperties: false properties: AdminPassword: - description: The password of the VM. After the first boot, returns an empty string. + description: The password of the VM. After the first boot, returns an empty + string. type: string ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" VmId: description: The ID of the VM. type: string @@ -5989,25 +6564,27 @@ components: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean type: object ReadApiAccessPolicyResponse: additionalProperties: false properties: ApiAccessPolicy: - $ref: '#/components/schemas/ApiAccessPolicy' + "$ref": "#/components/schemas/ApiAccessPolicy" ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object ReadApiAccessRulesRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Filters: - $ref: '#/components/schemas/FiltersApiAccessRule' + "$ref": "#/components/schemas/FiltersApiAccessRule" type: object ReadApiAccessRulesResponse: additionalProperties: false @@ -6015,28 +6592,31 @@ components: ApiAccessRules: description: A list of API access rules. items: - $ref: '#/components/schemas/ApiAccessRule' + "$ref": "#/components/schemas/ApiAccessRule" type: array ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object ReadApiLogsRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Filters: - $ref: '#/components/schemas/FiltersApiLog' + "$ref": "#/components/schemas/FiltersApiLog" NextPageToken: - description: The token to request the next page of results. Each token refers to a specific page. + description: The token to request the next page of results. Each token refers + to a specific page. type: string ResultsPerPage: default: 100 - description: The maximum number of logs returned in a single response (between `1`and `1000`, both included). By default, `100`. + description: The maximum number of logs returned in a single response (between + `1`and `1000`, both included). By default, `100`. type: integer With: - $ref: '#/components/schemas/With' + "$ref": "#/components/schemas/With" type: object ReadApiLogsResponse: additionalProperties: false @@ -6044,22 +6624,24 @@ components: Logs: description: Information about one or more logs. items: - $ref: '#/components/schemas/Log' + "$ref": "#/components/schemas/Log" type: array NextPageToken: - description: The token to request the next page of results. Each token refers to a specific page. + description: The token to request the next page of results. Each token refers + to a specific page. type: string ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object ReadCasRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Filters: - $ref: '#/components/schemas/FiltersCa' + "$ref": "#/components/schemas/FiltersCa" type: object ReadCasResponse: additionalProperties: false @@ -6067,35 +6649,37 @@ components: Cas: description: Information about one or more CAs. items: - $ref: '#/components/schemas/Ca' + "$ref": "#/components/schemas/Ca" type: array ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object ReadCatalogRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean type: object ReadCatalogResponse: additionalProperties: false properties: Catalog: - $ref: '#/components/schemas/Catalog' + "$ref": "#/components/schemas/Catalog" ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object ReadCatalogsRequest: additionalProperties: false description: ReadCatalogsRequest properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Filters: - $ref: '#/components/schemas/FiltersCatalogs' + "$ref": "#/components/schemas/FiltersCatalogs" description: ReadCatalogsRequest_Filters type: object ReadCatalogsResponse: @@ -6105,19 +6689,20 @@ components: Catalogs: description: Information about one or more catalogs. items: - $ref: '#/components/schemas/Catalogs' + "$ref": "#/components/schemas/Catalogs" type: array ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object ReadClientGatewaysRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Filters: - $ref: '#/components/schemas/FiltersClientGateway' + "$ref": "#/components/schemas/FiltersClientGateway" type: object ReadClientGatewaysResponse: additionalProperties: false @@ -6125,16 +6710,17 @@ components: ClientGateways: description: Information about one or more client gateways. items: - $ref: '#/components/schemas/ClientGateway' + "$ref": "#/components/schemas/ClientGateway" type: array ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object ReadConsoleOutputRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean VmId: description: The ID of the VM. @@ -6146,10 +6732,11 @@ components: additionalProperties: false properties: ConsoleOutput: - description: The Base64-encoded output of the console. If a command line tool is used, the output is decoded by the tool. + description: The Base64-encoded output of the console. If a command line + tool is used, the output is decoded by the tool. type: string ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" VmId: description: The ID of the VM. type: string @@ -6158,18 +6745,27 @@ components: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean FromDate: - description: The beginning of the time period, in ISO 8601 date format (for example, `2020-06-14`). The date-time format is also accepted, but only with a time set to midnight (for example, `2020-06-14T00:00:00.000Z`). + description: The beginning of the time period, in ISO 8601 date format (for + example, `2020-06-14`). The date-time format is also accepted, but only + with a time set to midnight (for example, `2020-06-14T00:00:00.000Z`). format: datetime 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: 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). type: boolean ToDate: - description: The end of the time period, in ISO 8601 date format (for example, `2020-06-30`). The date-time format is also accepted, but only with a time set to midnight (for example, `2020-06-30T00:00:00.000Z`). + description: The end of the time period, in ISO 8601 date format (for example, + `2020-06-30`). The date-time format is also accepted, but only with a + time set to midnight (for example, `2020-06-30T00:00:00.000Z`). format: datetime type: string required: @@ -6180,21 +6776,23 @@ components: additionalProperties: false properties: ConsumptionEntries: - description: Information about the resources consumed during the specified time period. + description: Information about the resources consumed during the specified + time period. items: - $ref: '#/components/schemas/ConsumptionEntry' + "$ref": "#/components/schemas/ConsumptionEntry" type: array ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object ReadDhcpOptionsRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Filters: - $ref: '#/components/schemas/FiltersDhcpOptions' + "$ref": "#/components/schemas/FiltersDhcpOptions" type: object ReadDhcpOptionsResponse: additionalProperties: false @@ -6202,19 +6800,20 @@ components: DhcpOptionsSets: description: Information about one or more DHCP options sets. items: - $ref: '#/components/schemas/DhcpOptionsSet' + "$ref": "#/components/schemas/DhcpOptionsSet" type: array ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object ReadDirectLinkInterfacesRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Filters: - $ref: '#/components/schemas/FiltersDirectLinkInterface' + "$ref": "#/components/schemas/FiltersDirectLinkInterface" type: object ReadDirectLinkInterfacesResponse: additionalProperties: false @@ -6222,19 +6821,20 @@ components: DirectLinkInterfaces: description: Information about one or more DirectLink interfaces. items: - $ref: '#/components/schemas/DirectLinkInterfaces' + "$ref": "#/components/schemas/DirectLinkInterfaces" type: array ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object ReadDirectLinksRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Filters: - $ref: '#/components/schemas/FiltersDirectLink' + "$ref": "#/components/schemas/FiltersDirectLink" type: object ReadDirectLinksResponse: additionalProperties: false @@ -6242,37 +6842,40 @@ components: DirectLinks: description: Information about one or more DirectLinks. items: - $ref: '#/components/schemas/DirectLink' + "$ref": "#/components/schemas/DirectLink" type: array ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object ReadFlexibleGpuCatalogRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean type: object ReadFlexibleGpuCatalogResponse: additionalProperties: false properties: FlexibleGpuCatalog: - description: Information about one or more fGPUs available in the public catalog. + description: Information about one or more fGPUs available in the public + catalog. items: - $ref: '#/components/schemas/FlexibleGpuCatalog' + "$ref": "#/components/schemas/FlexibleGpuCatalog" type: array ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object ReadFlexibleGpusRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Filters: - $ref: '#/components/schemas/FiltersFlexibleGpu' + "$ref": "#/components/schemas/FiltersFlexibleGpu" type: object ReadFlexibleGpusResponse: additionalProperties: false @@ -6280,19 +6883,20 @@ components: FlexibleGpus: description: Information about one or more fGPUs. items: - $ref: '#/components/schemas/FlexibleGpu' + "$ref": "#/components/schemas/FlexibleGpu" type: array ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object ReadImageExportTasksRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Filters: - $ref: '#/components/schemas/FiltersExportTask' + "$ref": "#/components/schemas/FiltersExportTask" type: object ReadImageExportTasksResponse: additionalProperties: false @@ -6300,19 +6904,20 @@ components: ImageExportTasks: description: Information about one or more image export tasks. items: - $ref: '#/components/schemas/ImageExportTask' + "$ref": "#/components/schemas/ImageExportTask" type: array ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object ReadImagesRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Filters: - $ref: '#/components/schemas/FiltersImage' + "$ref": "#/components/schemas/FiltersImage" type: object ReadImagesResponse: additionalProperties: false @@ -6320,19 +6925,20 @@ components: Images: description: Information about one or more OMIs. items: - $ref: '#/components/schemas/Image' + "$ref": "#/components/schemas/Image" type: array ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object ReadInternetServicesRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Filters: - $ref: '#/components/schemas/FiltersInternetService' + "$ref": "#/components/schemas/FiltersInternetService" type: object ReadInternetServicesResponse: additionalProperties: false @@ -6340,19 +6946,20 @@ components: InternetServices: description: Information about one or more Internet services. items: - $ref: '#/components/schemas/InternetService' + "$ref": "#/components/schemas/InternetService" type: array ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object ReadKeypairsRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Filters: - $ref: '#/components/schemas/FiltersKeypair' + "$ref": "#/components/schemas/FiltersKeypair" type: object ReadKeypairsResponse: additionalProperties: false @@ -6360,19 +6967,20 @@ components: Keypairs: description: Information about one or more keypairs. items: - $ref: '#/components/schemas/Keypair' + "$ref": "#/components/schemas/Keypair" type: array ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object ReadListenerRulesRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Filters: - $ref: '#/components/schemas/FiltersListenerRule' + "$ref": "#/components/schemas/FiltersListenerRule" type: object ReadListenerRulesResponse: additionalProperties: false @@ -6380,16 +6988,17 @@ components: ListenerRules: description: The list of the rules to describe. items: - $ref: '#/components/schemas/ListenerRule' + "$ref": "#/components/schemas/ListenerRule" type: array ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object ReadLoadBalancerTagsRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean LoadBalancerNames: description: One or more load balancer names. @@ -6403,21 +7012,22 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" Tags: description: Information about one or more load balancer tags. items: - $ref: '#/components/schemas/LoadBalancerTag' + "$ref": "#/components/schemas/LoadBalancerTag" type: array type: object ReadLoadBalancersRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Filters: - $ref: '#/components/schemas/FiltersLoadBalancer' + "$ref": "#/components/schemas/FiltersLoadBalancer" type: object ReadLoadBalancersResponse: additionalProperties: false @@ -6425,16 +7035,17 @@ components: LoadBalancers: description: Information about one or more load balancers. items: - $ref: '#/components/schemas/LoadBalancer' + "$ref": "#/components/schemas/LoadBalancer" type: array ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object ReadLocationsRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean type: object ReadLocationsResponse: @@ -6443,19 +7054,20 @@ components: Locations: description: Information about one or more locations. items: - $ref: '#/components/schemas/Location' + "$ref": "#/components/schemas/Location" type: array ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object ReadNatServicesRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Filters: - $ref: '#/components/schemas/FiltersNatService' + "$ref": "#/components/schemas/FiltersNatService" type: object ReadNatServicesResponse: additionalProperties: false @@ -6463,39 +7075,41 @@ components: NatServices: description: Information about one or more NAT services. items: - $ref: '#/components/schemas/NatService' + "$ref": "#/components/schemas/NatService" type: array ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object ReadNetAccessPointServicesRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Filters: - $ref: '#/components/schemas/FiltersService' + "$ref": "#/components/schemas/FiltersService" type: object ReadNetAccessPointServicesResponse: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" Services: description: The names of the services you can use for Net access points. items: - $ref: '#/components/schemas/Service' + "$ref": "#/components/schemas/Service" type: array type: object ReadNetAccessPointsRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Filters: - $ref: '#/components/schemas/FiltersNetAccessPoint' + "$ref": "#/components/schemas/FiltersNetAccessPoint" type: object ReadNetAccessPointsResponse: additionalProperties: false @@ -6503,19 +7117,20 @@ components: NetAccessPoints: description: One or more Net access points. items: - $ref: '#/components/schemas/NetAccessPoint' + "$ref": "#/components/schemas/NetAccessPoint" type: array ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object ReadNetPeeringsRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Filters: - $ref: '#/components/schemas/FiltersNetPeering' + "$ref": "#/components/schemas/FiltersNetPeering" type: object ReadNetPeeringsResponse: additionalProperties: false @@ -6523,19 +7138,20 @@ components: NetPeerings: description: Information about one or more Net peerings. items: - $ref: '#/components/schemas/NetPeering' + "$ref": "#/components/schemas/NetPeering" type: array ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object ReadNetsRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Filters: - $ref: '#/components/schemas/FiltersNet' + "$ref": "#/components/schemas/FiltersNet" type: object ReadNetsResponse: additionalProperties: false @@ -6543,19 +7159,20 @@ components: Nets: description: Information about the described Nets. items: - $ref: '#/components/schemas/Net' + "$ref": "#/components/schemas/Net" type: array ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object ReadNicsRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Filters: - $ref: '#/components/schemas/FiltersNic' + "$ref": "#/components/schemas/FiltersNic" type: object ReadNicsResponse: additionalProperties: false @@ -6563,19 +7180,20 @@ components: Nics: description: Information about one or more NICs. items: - $ref: '#/components/schemas/Nic' + "$ref": "#/components/schemas/Nic" type: array ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object ReadProductTypesRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Filters: - $ref: '#/components/schemas/FiltersProductType' + "$ref": "#/components/schemas/FiltersProductType" type: object ReadProductTypesResponse: additionalProperties: false @@ -6583,52 +7201,56 @@ components: ProductTypes: description: Information about one or more product types. items: - $ref: '#/components/schemas/ProductType' + "$ref": "#/components/schemas/ProductType" type: array ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object ReadPublicCatalogRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean type: object ReadPublicCatalogResponse: additionalProperties: false properties: Catalog: - $ref: '#/components/schemas/Catalog' + "$ref": "#/components/schemas/Catalog" ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object ReadPublicIpRangesRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean type: object ReadPublicIpRangesResponse: additionalProperties: false properties: PublicIps: - description: The list of public IPv4 addresses used in the Region, in CIDR notation. + description: The list of public IPv4 addresses used in the Region, in CIDR + notation. items: type: string type: array ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object ReadPublicIpsRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Filters: - $ref: '#/components/schemas/FiltersPublicIp' + "$ref": "#/components/schemas/FiltersPublicIp" type: object ReadPublicIpsResponse: additionalProperties: false @@ -6636,19 +7258,20 @@ components: PublicIps: description: Information about one or more public IPs. items: - $ref: '#/components/schemas/PublicIp' + "$ref": "#/components/schemas/PublicIp" type: array ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object ReadQuotasRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Filters: - $ref: '#/components/schemas/FiltersQuota' + "$ref": "#/components/schemas/FiltersQuota" type: object ReadQuotasResponse: additionalProperties: false @@ -6656,16 +7279,17 @@ components: QuotaTypes: description: Information about one or more quotas. items: - $ref: '#/components/schemas/QuotaTypes' + "$ref": "#/components/schemas/QuotaTypes" type: array ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object ReadRegionsRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean type: object ReadRegionsResponse: @@ -6674,29 +7298,30 @@ components: Regions: description: Information about one or more Regions. items: - $ref: '#/components/schemas/Region' + "$ref": "#/components/schemas/Region" type: array ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object ReadRouteTablesRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Filters: - $ref: '#/components/schemas/FiltersRouteTable' + "$ref": "#/components/schemas/FiltersRouteTable" type: object ReadRouteTablesResponse: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" RouteTables: description: Information about one or more route tables. items: - $ref: '#/components/schemas/RouteTable' + "$ref": "#/components/schemas/RouteTable" type: array type: object ReadSecretAccessKeyRequest: @@ -6706,7 +7331,8 @@ components: description: The ID of the access key. type: string DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean required: - AccessKeyId @@ -6715,229 +7341,259 @@ components: additionalProperties: false properties: AccessKey: - $ref: '#/components/schemas/AccessKeySecretKey' + "$ref": "#/components/schemas/AccessKeySecretKey" ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object ReadSecurityGroupsRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Filters: - $ref: '#/components/schemas/FiltersSecurityGroup' + "$ref": "#/components/schemas/FiltersSecurityGroup" type: object ReadSecurityGroupsResponse: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" SecurityGroups: description: Information about one or more security groups. items: - $ref: '#/components/schemas/SecurityGroup' + "$ref": "#/components/schemas/SecurityGroup" type: array type: object ReadServerCertificatesRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Filters: - $ref: '#/components/schemas/FiltersServerCertificate' + "$ref": "#/components/schemas/FiltersServerCertificate" type: object ReadServerCertificatesResponse: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" ServerCertificates: description: Information about one or more server certificates. items: - $ref: '#/components/schemas/ServerCertificate' + "$ref": "#/components/schemas/ServerCertificate" type: array type: object ReadSnapshotExportTasksRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Filters: - $ref: '#/components/schemas/FiltersExportTask' + "$ref": "#/components/schemas/FiltersExportTask" type: object ReadSnapshotExportTasksResponse: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" SnapshotExportTasks: description: Information about one or more snapshot export tasks. items: - $ref: '#/components/schemas/SnapshotExportTask' + "$ref": "#/components/schemas/SnapshotExportTask" type: array type: object ReadSnapshotsRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Filters: - $ref: '#/components/schemas/FiltersSnapshot' + "$ref": "#/components/schemas/FiltersSnapshot" type: object ReadSnapshotsResponse: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" Snapshots: description: Information about one or more snapshots and their permissions. items: - $ref: '#/components/schemas/Snapshot' + "$ref": "#/components/schemas/Snapshot" type: array type: object ReadSubnetsRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Filters: - $ref: '#/components/schemas/FiltersSubnet' + "$ref": "#/components/schemas/FiltersSubnet" type: object ReadSubnetsResponse: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" Subnets: description: Information about one or more Subnets. items: - $ref: '#/components/schemas/Subnet' + "$ref": "#/components/schemas/Subnet" type: array type: object ReadSubregionsRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Filters: - $ref: '#/components/schemas/FiltersSubregion' + "$ref": "#/components/schemas/FiltersSubregion" type: object ReadSubregionsResponse: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" Subregions: description: Information about one or more Subregions. items: - $ref: '#/components/schemas/Subregion' + "$ref": "#/components/schemas/Subregion" type: array type: object ReadTagsRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Filters: - $ref: '#/components/schemas/FiltersTag' + "$ref": "#/components/schemas/FiltersTag" type: object ReadTagsResponse: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" Tags: description: Information about one or more tags. items: - $ref: '#/components/schemas/Tag' + "$ref": "#/components/schemas/Tag" + type: array + type: object + ReadUsersRequest: + additionalProperties: false + properties: + DryRun: + description: If true, checks whether you have the required permissions to + perform the action. + type: boolean + type: object + ReadUsersResponse: + additionalProperties: false + properties: + ResponseContext: + "$ref": "#/components/schemas/ResponseContext" + Users: + description: A list of EIM users. + items: + "$ref": "#/components/schemas/User" type: array type: object ReadVirtualGatewaysRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Filters: - $ref: '#/components/schemas/FiltersVirtualGateway' + "$ref": "#/components/schemas/FiltersVirtualGateway" type: object ReadVirtualGatewaysResponse: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" VirtualGateways: description: Information about one or more virtual gateways. items: - $ref: '#/components/schemas/VirtualGateway' + "$ref": "#/components/schemas/VirtualGateway" type: array type: object ReadVmGroupsRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Filters: - $ref: '#/components/schemas/FiltersVmGroup' + "$ref": "#/components/schemas/FiltersVmGroup" description: ReadVmGroupsRequest_Filters type: object ReadVmGroupsResponse: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" VmGroups: description: Information about one or more VM groups. items: - $ref: '#/components/schemas/VmGroup' + "$ref": "#/components/schemas/VmGroup" type: array type: object ReadVmTemplatesRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Filters: - $ref: '#/components/schemas/FiltersVmTemplate' + "$ref": "#/components/schemas/FiltersVmTemplate" type: object ReadVmTemplatesResponse: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" VmTemplates: description: Information about one or more VM templates. items: - $ref: '#/components/schemas/VmTemplate' + "$ref": "#/components/schemas/VmTemplate" type: array type: object ReadVmTypesRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Filters: - $ref: '#/components/schemas/FiltersVmType' + "$ref": "#/components/schemas/FiltersVmType" type: object ReadVmTypesResponse: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" VmTypes: description: Information about one or more VM types. items: - $ref: '#/components/schemas/VmType' + "$ref": "#/components/schemas/VmType" type: array type: object ReadVmsHealthRequest: @@ -6949,7 +7605,8 @@ components: type: string type: array DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean LoadBalancerName: description: The name of the load balancer. @@ -6963,29 +7620,30 @@ components: BackendVmHealth: description: Information about the health of one or more back-end VMs. items: - $ref: '#/components/schemas/BackendVmHealth' + "$ref": "#/components/schemas/BackendVmHealth" type: array ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object ReadVmsRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Filters: - $ref: '#/components/schemas/FiltersVm' + "$ref": "#/components/schemas/FiltersVm" type: object ReadVmsResponse: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" Vms: description: Information about one or more VMs. items: - $ref: '#/components/schemas/Vm' + "$ref": "#/components/schemas/Vm" type: array type: object ReadVmsStateRequest: @@ -6993,70 +7651,75 @@ 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. By default or if set + to false, only includes the status of running VMs. type: boolean DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Filters: - $ref: '#/components/schemas/FiltersVmsState' + "$ref": "#/components/schemas/FiltersVmsState" type: object ReadVmsStateResponse: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" VmStates: description: Information about one or more VM states. items: - $ref: '#/components/schemas/VmStates' + "$ref": "#/components/schemas/VmStates" type: array type: object ReadVolumesRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Filters: - $ref: '#/components/schemas/FiltersVolume' + "$ref": "#/components/schemas/FiltersVolume" type: object ReadVolumesResponse: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" Volumes: description: Information about one or more volumes. items: - $ref: '#/components/schemas/Volume' + "$ref": "#/components/schemas/Volume" type: array type: object ReadVpnConnectionsRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Filters: - $ref: '#/components/schemas/FiltersVpnConnection' + "$ref": "#/components/schemas/FiltersVpnConnection" type: object ReadVpnConnectionsResponse: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" VpnConnections: description: Information about one or more VPN connections. items: - $ref: '#/components/schemas/VpnConnection' + "$ref": "#/components/schemas/VpnConnection" type: array type: object RebootVmsRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean VmIds: description: One or more IDs of the VMs you want to reboot. @@ -7070,7 +7733,7 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object Region: additionalProperties: false @@ -7087,14 +7750,15 @@ components: additionalProperties: false properties: BackendVmIds: - description: 'One or more IDs of back-end VMs.
- - Specifying the same ID several times has no effect as each back-end VM has equal weight.' + description: |- + One or more IDs of back-end VMs.
+ Specifying the same ID several times has no effect as each back-end VM has equal weight. items: type: string type: array DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean LoadBalancerName: description: The name of the load balancer. @@ -7107,13 +7771,14 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object RejectNetPeeringRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean NetPeeringId: description: The ID of the Net peering you want to reject. @@ -7125,19 +7790,21 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object ResetAccountPasswordRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Password: description: The new password for the account. type: string Token: - description: The token you received at the email address provided for the account. + description: The token you received at the email address provided for the + account. type: string required: - Password @@ -7147,7 +7814,7 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object ResourceLoadBalancerTag: additionalProperties: false @@ -7187,13 +7854,15 @@ components: description: The method used to create the route. type: string DestinationIpRange: - description: The IP range used for the destination match, in CIDR notation (for example, `10.0.0.0/24`). + description: The IP range used for the destination match, in CIDR notation + (for example, `10.0.0.0/24`). type: string DestinationServiceId: description: The ID of the OUTSCALE service. type: string GatewayId: - description: The ID of the Internet service or virtual gateway attached to the Net. + description: The ID of the Internet service or virtual gateway attached + to the Net. type: string NatServiceId: description: The ID of a NAT service attached to the Net. @@ -7222,13 +7891,15 @@ components: description: Information about the route. properties: DestinationIpRange: - description: The IP range used for the destination match, in CIDR notation (for example, `10.0.0.0/24`). + description: The IP range used for the destination match, in CIDR notation + (for example, `10.0.0.0/24`). type: string RouteType: description: The type of route (always `static`). type: string State: - description: The current state of the static route (`pending` \| `available` \| `deleting` \| `deleted`). + description: The current state of the static route (`pending` \| `available` + \| `deleting` \| `deleted`). type: string type: object RoutePropagatingVirtualGateway: @@ -7246,7 +7917,7 @@ components: LinkRouteTables: description: One or more associations between the route table and Subnets. items: - $ref: '#/components/schemas/LinkRouteTable' + "$ref": "#/components/schemas/LinkRouteTable" type: array NetId: description: The ID of the Net for the route table. @@ -7254,7 +7925,7 @@ components: RoutePropagatingVirtualGateways: description: Information about virtual gateways propagating routes. items: - $ref: '#/components/schemas/RoutePropagatingVirtualGateway' + "$ref": "#/components/schemas/RoutePropagatingVirtualGateway" type: array RouteTableId: description: The ID of the route table. @@ -7262,19 +7933,20 @@ components: Routes: description: One or more routes in the route table. items: - $ref: '#/components/schemas/Route' + "$ref": "#/components/schemas/Route" type: array Tags: description: One or more tags associated with the route table. items: - $ref: '#/components/schemas/ResourceTag' + "$ref": "#/components/schemas/ResourceTag" type: array type: object ScaleDownVmGroupRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean VmGroupId: description: The ID of the VM group you want to scale down. @@ -7290,13 +7962,14 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object ScaleUpVmGroupRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean VmAddition: description: The number of VMs you want to add to the VM group. @@ -7312,7 +7985,7 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object SecurityGroup: additionalProperties: false @@ -7327,7 +8000,7 @@ components: InboundRules: description: The inbound rules associated with the security group. items: - $ref: '#/components/schemas/SecurityGroupRule' + "$ref": "#/components/schemas/SecurityGroupRule" type: array NetId: description: The ID of the Net for the security group. @@ -7335,7 +8008,7 @@ components: OutboundRules: description: The outbound rules associated with the security group. items: - $ref: '#/components/schemas/SecurityGroupRule' + "$ref": "#/components/schemas/SecurityGroupRule" type: array SecurityGroupId: description: The ID of the security group. @@ -7346,7 +8019,7 @@ components: Tags: description: One or more tags associated with the security group. items: - $ref: '#/components/schemas/ResourceTag' + "$ref": "#/components/schemas/ResourceTag" type: array type: object SecurityGroupLight: @@ -7365,28 +8038,35 @@ components: description: Information about the security group rule. properties: FromPortRange: - description: The beginning of the port range for the TCP and UDP protocols, or an ICMP type number. + description: The beginning of the port range for the TCP and UDP protocols, + or an ICMP type number. type: integer IpProtocol: - description: The IP protocol name (`tcp`, `udp`, `icmp`, or `-1` for all protocols). By default, `-1`. In a Net, this can also be an IP protocol number. For more information, see the [IANA.org website](https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml). + description: The IP protocol name (`tcp`, `udp`, `icmp`, or `-1` for all + protocols). By default, `-1`. In a Net, this can also be an IP protocol + number. For more information, see the [IANA.org website](https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml). type: string IpRanges: - description: One or more IP ranges for the security group rules, in CIDR notation (for example, `10.0.0.0/16`). + description: One or more IP ranges for the security group rules, in CIDR + notation (for example, `10.0.0.0/16`). items: type: string type: array SecurityGroupsMembers: - description: Information about one or more source or destination security groups. + description: Information about one or more source or destination security + groups. items: - $ref: '#/components/schemas/SecurityGroupsMember' + "$ref": "#/components/schemas/SecurityGroupsMember" type: array ServiceIds: - description: One or more service IDs to allow traffic from a Net to access the corresponding OUTSCALE services. For more information, see [ReadNetAccessPointServices](#readnetaccesspointservices). + description: One or more service IDs to allow traffic from a Net to access + the corresponding OUTSCALE services. For more information, see [ReadNetAccessPointServices](#readnetaccesspointservices). items: type: string type: array ToPortRange: - description: The end of the port range for the TCP and UDP protocols, or an ICMP code number. + description: The end of the port range for the TCP and UDP protocols, or + an ICMP code number. type: integer type: object SecurityGroupsMember: @@ -7394,20 +8074,24 @@ components: description: Information about a source or destination security group. properties: AccountId: - description: The account ID that owns the source or destination security group. + description: The account ID that owns the source or destination security + group. type: string SecurityGroupId: - description: The ID of a source or destination security group that you want to link to the security group of the rule. + description: The ID of a source or destination security group that you want + to link to the security group of the rule. type: string SecurityGroupName: - description: (Public Cloud only) The name of a source or destination security group that you want to link to the security group of the rule. + description: "(Public Cloud only) The name of a source or destination security + group that you want to link to the security group of the rule." type: string type: object SendResetPasswordEmailRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Email: description: The email address provided for the account. @@ -7419,7 +8103,7 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object ServerCertificate: additionalProperties: false @@ -7436,7 +8120,9 @@ components: description: The name of the server certificate. type: string Orn: - 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). type: string Path: description: The path to the server certificate. @@ -7480,7 +8166,7 @@ components: description: The description of the snapshot. type: string PermissionsToCreateVolume: - $ref: '#/components/schemas/PermissionsOnResource' + "$ref": "#/components/schemas/PermissionsOnResource" Progress: description: The progress of the snapshot, as a percentage. type: integer @@ -7493,13 +8179,14 @@ components: Tags: description: One or more tags associated with the snapshot. items: - $ref: '#/components/schemas/ResourceTag' + "$ref": "#/components/schemas/ResourceTag" type: array VolumeId: description: The ID of the volume used to create the snapshot. type: string VolumeSize: - description: The size of the volume used to create the snapshot, in gibibytes (GiB). + description: The size of the volume used to create the snapshot, in gibibytes + (GiB). type: integer type: object SnapshotExportTask: @@ -7510,7 +8197,7 @@ components: description: If the snapshot export task fails, an error message appears. type: string OsuExport: - $ref: '#/components/schemas/OsuExportSnapshotExportTask' + "$ref": "#/components/schemas/OsuExportSnapshotExportTask" Progress: description: The progress of the snapshot export task, as a percentage. type: integer @@ -7518,12 +8205,13 @@ components: description: The ID of the snapshot to be exported. type: string State: - description: The state of the snapshot export task (`pending` \| `active` \| `completed` \| `failed`). + description: The state of the snapshot export task (`pending` \| `active` + \| `completed` \| `failed`). type: string Tags: description: One or more tags associated with the snapshot export task. items: - $ref: '#/components/schemas/ResourceTag' + "$ref": "#/components/schemas/ResourceTag" type: array TaskId: description: The ID of the snapshot export task. @@ -7537,7 +8225,8 @@ components: description: The account ID of the owner of the source Net. type: string IpRange: - description: The IP range for the source Net, in CIDR notation (for example, `10.0.0.0/16`). + description: The IP range for the source Net, in CIDR notation (for example, + `10.0.0.0/16`). type: string NetId: description: The ID of the source Net. @@ -7545,9 +8234,9 @@ components: type: object SourceSecurityGroup: additionalProperties: false - description: 'Information about the source security group of the load balancer, which you can use as part of your inbound rules for your registered VMs.
- - To only allow traffic from load balancers, add a security group rule that specifies this source security group as the inbound source.' + description: |- + Information about the source security group of the load balancer, which you can use as part of your inbound rules for your registered VMs.
+ To only allow traffic from load balancers, add a security group rule that specifies this source security group as the inbound source. properties: SecurityGroupAccountId: description: The account ID of the owner of the security group. @@ -7560,7 +8249,8 @@ components: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean VmIds: description: One or more IDs of VMs. @@ -7574,11 +8264,11 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" Vms: description: Information about one or more started VMs. items: - $ref: '#/components/schemas/VmState' + "$ref": "#/components/schemas/VmState" type: array type: object StateComment: @@ -7596,7 +8286,8 @@ components: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean ForceStop: description: Forces the VM to stop. @@ -7613,11 +8304,11 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" Vms: description: Information about one or more stopped VMs. items: - $ref: '#/components/schemas/VmState' + "$ref": "#/components/schemas/VmState" type: array type: object Subnet: @@ -7628,10 +8319,12 @@ components: description: The number of available IPs in the Subnets. type: integer IpRange: - description: The IP range in the Subnet, in CIDR notation (for example, `10.0.0.0/16`). + description: The IP range in the Subnet, in CIDR notation (for example, + `10.0.0.0/16`). type: string MapPublicIpOnLaunch: - description: If true, a public IP is assigned to the network interface cards (NICs) created in the specified Subnet. + description: If true, a public IP is assigned to the network interface cards + (NICs) created in the specified Subnet. type: boolean NetId: description: The ID of the Net in which the Subnet is. @@ -7648,7 +8341,7 @@ components: Tags: description: One or more tags associated with the Subnet. items: - $ref: '#/components/schemas/ResourceTag' + "$ref": "#/components/schemas/ResourceTag" type: array type: object Subregion: @@ -7662,7 +8355,8 @@ components: description: The name of the Region containing the Subregion. type: string State: - description: The state of the Subregion (`available` \| `information` \| `impaired` \| `unavailable`). + description: The state of the Subregion (`available` \| `information` \| + `impaired` \| `unavailable`). type: string SubregionName: description: The name of the Subregion. @@ -7689,7 +8383,8 @@ components: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean FlexibleGpuId: description: The ID of the fGPU you want to detach from your VM. @@ -7701,19 +8396,21 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object UnlinkInternetServiceRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean InternetServiceId: description: The ID of the Internet service you want to detach. type: string NetId: - description: The ID of the Net from which you want to detach the Internet service. + description: The ID of the Net from which you want to detach the Internet + service. type: string required: - InternetServiceId @@ -7723,26 +8420,27 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object UnlinkLoadBalancerBackendMachinesRequest: additionalProperties: false properties: BackendIps: - description: ' One or more public IPs of back-end VMs.' + description: " One or more public IPs of back-end VMs." items: type: string type: array BackendVmIds: - description: ' One or more IDs of back-end VMs.' + description: " One or more IDs of back-end VMs." items: type: string type: array DryRun: - description: ' If true, checks whether you have the required permissions to perform the action.' + description: " If true, checks whether you have the required permissions + to perform the action." type: boolean LoadBalancerName: - description: ' The name of the load balancer.' + description: " The name of the load balancer." type: string required: - LoadBalancerName @@ -7751,13 +8449,14 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object UnlinkNicRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean LinkNicId: description: The ID of the attachment operation. @@ -7769,19 +8468,21 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object UnlinkPrivateIpsRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean NicId: description: The ID of the NIC. type: string PrivateIps: - description: One or more secondary private IPs you want to unassign from the NIC. + description: One or more secondary private IPs you want to unassign from + the NIC. items: type: string type: array @@ -7793,32 +8494,37 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object UnlinkPublicIpRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean LinkPublicIpId: - description: The ID representing the association of the public IP with the VM or the NIC. This parameter is required unless you use the `PublicIp` parameter. + description: The ID representing the association of the public IP with the + VM or the NIC. This parameter is required unless you use the `PublicIp` + parameter. type: string PublicIp: - description: The public IP. This parameter is required unless you use the `LinkPublicIpId` parameter. + description: The public IP. This parameter is required unless you use the + `LinkPublicIpId` parameter. type: string type: object UnlinkPublicIpResponse: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object UnlinkRouteTableRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean LinkRouteTableId: description: The ID of the association between the route table and the Subnet. @@ -7830,16 +8536,18 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object UnlinkVirtualGatewayRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean NetId: - description: The ID of the Net from which you want to detach the virtual gateway. + description: The ID of the Net from which you want to detach the virtual + gateway. type: string VirtualGatewayId: description: The ID of the virtual gateway. @@ -7852,16 +8560,18 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object UnlinkVolumeRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean ForceUnlink: - description: 'Forces the detachment of the volume in case of previous failure. Important: This action may damage your data or file systems.' + description: 'Forces the detachment of the volume in case of previous failure. + Important: This action may damage your data or file systems.' type: boolean VolumeId: description: The ID of the volume you want to detach. @@ -7873,7 +8583,7 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object UpdateAccessKeyRequest: additionalProperties: false @@ -7882,14 +8592,24 @@ components: description: The ID of the access key. type: string DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean ExpirationDate: - description: The date and time, or the date, at which you want the access key to expire, in ISO 8601 format (for example, `2020-06-14T00:00:00.000Z` or `2020-06-14`). If not specified, the access key is set to not expire. + description: The date and time, or the date, at which you want the access + key to expire, in ISO 8601 format (for example, `2020-06-14T00:00:00.000Z` + or `2020-06-14`). If not specified, the access key is set to not expire. format: datetime type: string State: - description: The new state for the access key (`ACTIVE` \| `INACTIVE`). When set to `ACTIVE`, the access key is enabled and can be used to send requests. When set to `INACTIVE`, the access key is disabled. + description: The new state for the access key (`ACTIVE` \| `INACTIVE`). + When set to `ACTIVE`, the access key is enabled and can be used to send + requests. When set to `INACTIVE`, the access key is disabled. + type: string + UserName: + description: The name of the EIM the access key you want to modify is associated + with. If you do not specify a user name, this action modifies the access + key of the user who sends the request (which can be the root account). type: string required: - AccessKeyId @@ -7899,17 +8619,20 @@ components: additionalProperties: false properties: AccessKey: - $ref: '#/components/schemas/AccessKey' + "$ref": "#/components/schemas/AccessKey" ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object UpdateAccountRequest: additionalProperties: false properties: AdditionalEmails: - description: One or more additional email addresses for the account. These addresses are used for notifications only. If you already have a list of additional emails registered, you cannot add to it, only replace it. To remove all registered additional emails, specify an empty list. + description: One or more additional email addresses for the account. These + addresses are used for notifications only. If you already have a list + of additional emails registered, you cannot add to it, only replace it. + To remove all registered additional emails, specify an empty list. items: - pattern: ^.+@[a-zA-Z0-9-]+(?:\.[a-zA-Z0-9-]+)+$ + pattern: "^.+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)+$" type: string type: array City: @@ -7922,10 +8645,12 @@ components: description: The new country of the account owner. type: string DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Email: - description: The main email address for the account. This address is used for your credentials and notifications. + description: The main email address for the account. This address is used + for your credentials and notifications. type: string FirstName: description: The new first name of the account owner. @@ -7956,22 +8681,30 @@ components: additionalProperties: false properties: Account: - $ref: '#/components/schemas/Account' + "$ref": "#/components/schemas/Account" ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object UpdateApiAccessPolicyRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean MaxAccessKeyExpirationSeconds: - description: The maximum possible lifetime for your access keys, in seconds (between `0` and `3153600000`, both included). If set to `O`, your access keys can have unlimited lifetimes, but a trusted session cannot be activated. Otherwise, all your access keys must have an expiration date. This value must be greater than the remaining lifetime of each access key of your account. + description: The maximum possible lifetime for your access keys, in seconds + (between `0` and `3153600000`, both included). If set to `O`, your access + keys can have unlimited lifetimes, but a trusted session cannot be activated. + Otherwise, all your access keys must have an expiration date. This value + must be greater than the remaining lifetime of each access key of your + account. format: int64 type: integer RequireTrustedEnv: - description: If true, a trusted session is activated, provided that you specify the `MaxAccessKeyExpirationSeconds` parameter with a value greater than `0`. + description: If true, a trusted session is activated, provided that you + specify the `MaxAccessKeyExpirationSeconds` parameter with a value greater + than `0`. type: boolean required: - MaxAccessKeyExpirationSeconds @@ -7981,9 +8714,9 @@ components: additionalProperties: false properties: ApiAccessPolicy: - $ref: '#/components/schemas/ApiAccessPolicy' + "$ref": "#/components/schemas/ApiAccessPolicy" ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object UpdateApiAccessRuleRequest: additionalProperties: false @@ -8005,7 +8738,8 @@ components: description: A new description for the API access rule. type: string DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean IpRanges: description: One or more IP addresses or CIDR blocks (for example, `192.0.2.0/16`). @@ -8019,9 +8753,9 @@ components: additionalProperties: false properties: ApiAccessRule: - $ref: '#/components/schemas/ApiAccessRule' + "$ref": "#/components/schemas/ApiAccessRule" ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object UpdateCaRequest: additionalProperties: false @@ -8033,7 +8767,8 @@ components: description: The description of the CA. type: string DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean required: - CaId @@ -8042,9 +8777,9 @@ components: additionalProperties: false properties: Ca: - $ref: '#/components/schemas/Ca' + "$ref": "#/components/schemas/Ca" ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object UpdateDirectLinkInterfaceRequest: additionalProperties: false @@ -8053,10 +8788,12 @@ components: description: The ID of the DirectLink interface you want to update. type: string DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Mtu: - description: The maximum transmission unit (MTU) of the DirectLink interface, in bytes (always `1500`). + description: The maximum transmission unit (MTU) of the DirectLink interface, + in bytes (always `1500`). enum: - 1500 type: integer @@ -8068,9 +8805,9 @@ components: additionalProperties: false properties: DirectLinkInterface: - $ref: '#/components/schemas/DirectLinkInterfaces' + "$ref": "#/components/schemas/DirectLinkInterfaces" ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object UpdateFlexibleGpuRequest: additionalProperties: false @@ -8079,7 +8816,8 @@ components: description: If true, the fGPU is deleted when the VM is terminated. type: boolean DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean FlexibleGpuId: description: The ID of the fGPU you want to modify. @@ -8091,21 +8829,22 @@ components: additionalProperties: false properties: FlexibleGpu: - $ref: '#/components/schemas/FlexibleGpu' + "$ref": "#/components/schemas/FlexibleGpu" ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object UpdateImageRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean ImageId: description: The ID of the OMI you want to modify. type: string PermissionsToLaunch: - $ref: '#/components/schemas/PermissionsOnResourceCreation' + "$ref": "#/components/schemas/PermissionsOnResourceCreation" required: - ImageId - PermissionsToLaunch @@ -8114,25 +8853,30 @@ components: additionalProperties: false properties: Image: - $ref: '#/components/schemas/Image' + "$ref": "#/components/schemas/Image" ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object UpdateListenerRuleRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean HostPattern: - description: A host-name pattern for the rule, with a maximum length of 128 characters. This host-name pattern supports maximum three wildcards, and must not contain any special characters except [-.?]. + description: A host-name pattern for the rule, with a maximum length of + 128 characters. This host-name pattern supports maximum three wildcards, + and must not contain any special characters except [-.?]. nullable: true type: string ListenerRuleName: description: The name of the listener rule. type: string PathPattern: - description: A path pattern for the rule, with a maximum length of 128 characters. This path pattern supports maximum three wildcards, and must not contain any special characters except [_-.$/~"'@:+?]. + description: A path pattern for the rule, with a maximum length of 128 characters. + This path pattern supports maximum three wildcards, and must not contain + any special characters except [_-.$/~"'@:+?]. nullable: true type: string required: @@ -8142,25 +8886,28 @@ components: additionalProperties: false properties: ListenerRule: - $ref: '#/components/schemas/ListenerRule' + "$ref": "#/components/schemas/ListenerRule" ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object UpdateLoadBalancerRequest: additionalProperties: false properties: AccessLog: - $ref: '#/components/schemas/AccessLog' + "$ref": "#/components/schemas/AccessLog" DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean HealthCheck: - $ref: '#/components/schemas/HealthCheck' + "$ref": "#/components/schemas/HealthCheck" LoadBalancerName: description: The name of the load balancer. type: string LoadBalancerPort: - description: The port on which the load balancer is listening (between `1` and `65535`, both included). This parameter is required if you want to update the server certificate. + description: The port on which the load balancer is listening (between `1` + and `65535`, both included). This parameter is required if you want to + update the server certificate. type: integer PolicyNames: description: The name of the policy you want to enable for the listener. @@ -8168,18 +8915,30 @@ components: type: string type: array PublicIp: - description: (internet-facing only) The public IP you want to associate with the load balancer. The former public IP of the load balancer is then disassociated. If you specify an empty string and the former public IP belonged to you, it is disassociated and replaced by a public IP owned by 3DS OUTSCALE. + description: "(internet-facing only) The public IP you want to associate + with the load balancer. The former public IP of the load balancer is then + disassociated. If you specify an empty string and the former public IP + belonged to you, it is disassociated and replaced by a public IP owned + by 3DS OUTSCALE." type: string SecuredCookies: description: If true, secure cookies are enabled for the load balancer. type: boolean SecurityGroups: - description: (Net only) One or more IDs of security groups you want to assign to the load balancer. You need to specify the already assigned security groups that you want to keep along with the new ones you are assigning. If the list is empty, the default security group of the Net is assigned to the load balancer. + description: "(Net only) One or more IDs of security groups you want to + assign to the load balancer. You need to specify the already assigned + security groups that you want to keep along with the new ones you are + assigning. If the list is empty, the default security group of the Net + is assigned to the load balancer." items: type: string type: array 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). If this parameter is specified, you must also specify the `LoadBalancerPort` parameter. + 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). + If this parameter is specified, you must also specify the `LoadBalancerPort` + parameter. type: string required: - LoadBalancerName @@ -8188,26 +8947,29 @@ components: additionalProperties: false properties: LoadBalancer: - $ref: '#/components/schemas/LoadBalancer' + "$ref": "#/components/schemas/LoadBalancer" ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object UpdateNetAccessPointRequest: additionalProperties: false properties: AddRouteTableIds: - description: One or more IDs of route tables to associate with the specified Net access point. + description: One or more IDs of route tables to associate with the specified + Net access point. items: type: string type: array DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean NetAccessPointId: description: The ID of the Net access point. type: string RemoveRouteTableIds: - description: One or more IDs of route tables to disassociate from the specified Net access point. + description: One or more IDs of route tables to disassociate from the specified + Net access point. items: type: string type: array @@ -8218,18 +8980,20 @@ components: additionalProperties: false properties: NetAccessPoint: - $ref: '#/components/schemas/NetAccessPoint' + "$ref": "#/components/schemas/NetAccessPoint" ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object UpdateNetRequest: additionalProperties: false properties: DhcpOptionsSetId: - description: The ID of the DHCP options set (or `default` if you want to associate the default one). + description: The ID of the DHCP options set (or `default` if you want to + associate the default one). type: string DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean NetId: description: The ID of the Net. @@ -8242,9 +9006,9 @@ components: additionalProperties: false properties: Net: - $ref: '#/components/schemas/Net' + "$ref": "#/components/schemas/Net" ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object UpdateNicRequest: additionalProperties: false @@ -8253,17 +9017,18 @@ components: description: A new description for the NIC. type: string DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean LinkNic: - $ref: '#/components/schemas/LinkNicToUpdate' + "$ref": "#/components/schemas/LinkNicToUpdate" NicId: description: The ID of the NIC you want to modify. type: string SecurityGroupIds: - description: 'One or more IDs of security groups for the NIC.
- - You must specify at least one group, even if you use the default security group in the Net.' + description: |- + One or more IDs of security groups for the NIC.
+ You must specify at least one group, even if you use the default security group in the Net. items: type: string type: array @@ -8274,18 +9039,20 @@ components: additionalProperties: false properties: Nic: - $ref: '#/components/schemas/Nic' + "$ref": "#/components/schemas/Nic" ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" type: object UpdateRoutePropagationRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Enable: - description: If true, a virtual gateway can propagate routes to a specified route table of a Net. If false, the propagation is disabled. + description: If true, a virtual gateway can propagate routes to a specified + route table of a Net. If false, the propagation is disabled. type: boolean RouteTableId: description: The ID of the route table. @@ -8302,21 +9069,24 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" RouteTable: - $ref: '#/components/schemas/RouteTable' + "$ref": "#/components/schemas/RouteTable" type: object UpdateRouteRequest: additionalProperties: false properties: DestinationIpRange: - description: The IP range used for the destination match, in CIDR notation (for example, `10.0.0.0/24`). + description: The IP range used for the destination match, in CIDR notation + (for example, `10.0.0.0/24`). type: string DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean GatewayId: - description: The ID of an Internet service or virtual gateway attached to your Net. + description: The ID of an Internet service or virtual gateway attached to + your Net. type: string NatServiceId: description: The ID of a NAT service. @@ -8341,15 +9111,16 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" RouteTable: - $ref: '#/components/schemas/RouteTable' + "$ref": "#/components/schemas/RouteTable" type: object UpdateServerCertificateRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Name: description: The name of the server certificate you want to modify. @@ -8367,18 +9138,19 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" ServerCertificate: - $ref: '#/components/schemas/ServerCertificate' + "$ref": "#/components/schemas/ServerCertificate" type: object UpdateSnapshotRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean PermissionsToCreateVolume: - $ref: '#/components/schemas/PermissionsOnResourceCreation' + "$ref": "#/components/schemas/PermissionsOnResourceCreation" SnapshotId: description: The ID of the snapshot. type: string @@ -8390,18 +9162,20 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" Snapshot: - $ref: '#/components/schemas/Snapshot' + "$ref": "#/components/schemas/Snapshot" type: object UpdateSubnetRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean MapPublicIpOnLaunch: - description: If true, a public IP is assigned to the network interface cards (NICs) created in the specified Subnet. + description: If true, a public IP is assigned to the network interface cards + (NICs) created in the specified Subnet. type: boolean SubnetId: description: The ID of the Subnet. @@ -8414,9 +9188,36 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" Subnet: - $ref: '#/components/schemas/Subnet' + "$ref": "#/components/schemas/Subnet" + type: object + UpdateUserRequest: + additionalProperties: false + properties: + DryRun: + description: If true, checks whether you have the required permissions to + perform the action. + type: boolean + NewPath: + description: A new path for the EIM user. + type: string + NewUserName: + description: A new name for the EIM user. + type: string + UserName: + description: The name of the EIM user you want to modify. + type: string + required: + - UserName + type: object + UpdateUserResponse: + additionalProperties: false + properties: + ResponseContext: + "$ref": "#/components/schemas/ResponseContext" + User: + "$ref": "#/components/schemas/User" type: object UpdateVmGroupRequest: additionalProperties: false @@ -8425,12 +9226,13 @@ components: description: A new description for the VM group. type: string DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Tags: description: New tags for your VM group. items: - $ref: '#/components/schemas/ResourceTag' + "$ref": "#/components/schemas/ResourceTag" type: array VmGroupId: description: The ID of the VM group you want to update. @@ -8448,9 +9250,9 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" VmGroup: - $ref: '#/components/schemas/VmGroup' + "$ref": "#/components/schemas/VmGroup" type: object UpdateVmRequest: additionalProperties: false @@ -8458,27 +9260,33 @@ components: BlockDeviceMappings: description: One or more block device mappings of the VM. items: - $ref: '#/components/schemas/BlockDeviceMappingVmUpdate' + "$ref": "#/components/schemas/BlockDeviceMappingVmUpdate" type: array BsuOptimized: - description: This parameter is not available. It is present in our API for the sake of historical compatibility with AWS. + description: This parameter is not available. It is present in our API for + the sake of historical compatibility with AWS. type: boolean DeletionProtection: - description: If true, you cannot delete the VM unless you change this parameter back to false. + description: If true, you cannot delete the VM unless you change this parameter + back to false. type: boolean DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean IsSourceDestChecked: - description: (Net only) If true, the source/destination check is enabled. If false, it is disabled. This value must be false for a NAT VM to perform network address translation (NAT) in a Net. + description: "(Net only) If true, the source/destination check is enabled. + If false, it is disabled. This value must be false for a NAT VM to perform + network address translation (NAT) in a Net." type: boolean KeypairName: - description: 'The name of a keypair you want to associate with the VM.
- - When you replace the keypair of a VM with another one, the metadata of the VM is modified to reflect the new public key, but the replacement is still not effective in the operating system of the VM. To complete the replacement and effectively apply the new keypair, you need to perform other actions inside the VM. For more information, see [Modifying the Keypair of an Instance](https://docs.outscale.com/en/userguide/Modifying-the-Keypair-of-an-Instance.html).' + description: |- + The name of a keypair you want to associate with the VM.
+ When you replace the keypair of a VM with another one, the metadata of the VM is modified to reflect the new public key, but the replacement is still not effective in the operating system of the VM. To complete the replacement and effectively apply the new keypair, you need to perform other actions inside the VM. For more information, see [Modifying the Keypair of an Instance](https://docs.outscale.com/en/userguide/Modifying-the-Keypair-of-an-Instance.html). type: string NestedVirtualization: - description: (dedicated tenancy only) If true, nested virtualization is enabled. If false, it is disabled. + description: "(dedicated tenancy only) If true, nested virtualization is + enabled. If false, it is disabled." type: boolean Performance: description: The performance of the VM (`medium` \| `high` \| `highest`). @@ -8493,13 +9301,16 @@ components: type: string type: array UserData: - description: The Base64-encoded MIME user data, limited to 500 kibibytes (KiB). + description: The Base64-encoded MIME user data, limited to 500 kibibytes + (KiB). type: string VmId: description: The ID of the VM. type: string VmInitiatedShutdownBehavior: - 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. + 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: description: The type of VM. For more information, see [Instance Types](https://docs.outscale.com/en/userguide/Instance-Types.html). @@ -8511,9 +9322,9 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" Vm: - $ref: '#/components/schemas/Vm' + "$ref": "#/components/schemas/Vm" type: object UpdateVmTemplateRequest: additionalProperties: false @@ -8522,12 +9333,13 @@ components: description: A new description for the VM template. type: string DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Tags: description: New tags for your VM template. items: - $ref: '#/components/schemas/ResourceTag' + "$ref": "#/components/schemas/ResourceTag" type: array VmTemplateId: description: The ID of the VM template you want to update. @@ -8542,27 +9354,36 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" VmTemplate: - $ref: '#/components/schemas/VmTemplate' + "$ref": "#/components/schemas/VmTemplate" type: object UpdateVolumeRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean Iops: - description: The new number of I/O operations per second (IOPS). This parameter can be specified only if you update an `io1` volume. The maximum number of IOPS allowed for `io1` volumes is `13000` with a maximum performance ratio of 300 IOPS per gibibyte. This modification is instantaneous on a cold volume, not on a hot one. + description: The new number of I/O operations per second (IOPS). This parameter + can be specified only if you update an `io1` volume. The maximum number + of IOPS allowed for `io1` volumes is `13000` with a maximum performance + ratio of 300 IOPS per gibibyte. This modification is instantaneous on + a cold volume, not on a hot one. type: integer Size: - description: (cold volume only) The new size of the volume, in gibibytes (GiB). This value must be equal to or greater than the current size of the volume. This modification is not instantaneous. + description: "(cold volume only) The new size of the volume, in gibibytes + (GiB). This value must be equal to or greater than the current size of + the volume. This modification is not instantaneous." type: integer VolumeId: description: The ID of the volume you want to update. type: string VolumeType: - description: (cold volume only) The new type of the volume (`standard` \| `io1` \| `gp2`). This modification is instantaneous. If you update to an `io1` volume, you must also specify the `Iops` parameter. + description: "(cold volume only) The new type of the volume (`standard` + \\| `io1` \\| `gp2`). This modification is instantaneous. If you update + to an `io1` volume, you must also specify the `Iops` parameter." type: string required: - VolumeId @@ -8571,9 +9392,9 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" Volume: - $ref: '#/components/schemas/Volume' + "$ref": "#/components/schemas/Volume" type: object UpdateVpnConnectionRequest: additionalProperties: false @@ -8582,7 +9403,8 @@ components: description: The ID of the client gateway. type: string DryRun: - description: If true, checks whether you have the required permissions to perform the action. + description: If true, checks whether you have the required permissions to + perform the action. type: boolean VirtualGatewayId: description: The ID of the virtual gateway. @@ -8591,7 +9413,7 @@ components: description: The ID of the VPN connection you want to modify. type: string VpnOptions: - $ref: '#/components/schemas/VpnOptions' + "$ref": "#/components/schemas/VpnOptions" required: - VpnConnectionId type: object @@ -8599,16 +9421,31 @@ components: additionalProperties: false properties: ResponseContext: - $ref: '#/components/schemas/ResponseContext' + "$ref": "#/components/schemas/ResponseContext" VpnConnection: - $ref: '#/components/schemas/VpnConnection' + "$ref": "#/components/schemas/VpnConnection" + type: object + User: + additionalProperties: false + description: Information about the EIM user. + properties: + Path: + description: The path to the EIM user. + type: string + UserId: + description: " The ID of the EIM user." + type: string + UserName: + description: The name of the EIM user. + type: string type: object VgwTelemetry: additionalProperties: false description: Information about the current state of a VPN tunnel. properties: AcceptedRouteCount: - description: The number of routes accepted through BGP (Border Gateway Protocol) route exchanges. + description: The number of routes accepted through BGP (Border Gateway Protocol) + route exchanges. type: integer LastStateChangeDate: description: The date and time (UTC) of the latest state update. @@ -8629,20 +9466,22 @@ components: description: Information about the virtual gateway. properties: ConnectionType: - description: The type of VPN connection supported by the virtual gateway (only `ipsec.1` is supported). + description: The type of VPN connection supported by the virtual gateway + (only `ipsec.1` is supported). type: string NetToVirtualGatewayLinks: description: The Net to which the virtual gateway is attached. items: - $ref: '#/components/schemas/NetToVirtualGatewayLink' + "$ref": "#/components/schemas/NetToVirtualGatewayLink" type: array State: - description: The state of the virtual gateway (`pending` \| `available` \| `deleting` \| `deleted`). + description: The state of the virtual gateway (`pending` \| `available` + \| `deleting` \| `deleted`). type: string Tags: description: One or more tags associated with the virtual gateway. items: - $ref: '#/components/schemas/ResourceTag' + "$ref": "#/components/schemas/ResourceTag" type: array VirtualGatewayId: description: The ID of the virtual gateway. @@ -8658,10 +9497,11 @@ components: BlockDeviceMappings: description: The block device mapping of the VM. items: - $ref: '#/components/schemas/BlockDeviceMappingCreated' + "$ref": "#/components/schemas/BlockDeviceMappingCreated" type: array BsuOptimized: - description: This parameter is not available. It is present in our API for the sake of historical compatibility with AWS. + description: This parameter is not available. It is present in our API for + the sake of historical compatibility with AWS. type: boolean ClientToken: description: The idempotency token provided when launching the VM. @@ -8671,7 +9511,8 @@ components: format: datetime type: string DeletionProtection: - description: If true, you cannot delete the VM unless you change this parameter back to false. + description: If true, you cannot delete the VM unless you change this parameter + back to false. type: boolean Hypervisor: description: The hypervisor type of the VMs (`ovm` \| `xen`). @@ -8680,24 +9521,29 @@ components: description: The ID of the OMI used to create the VM. type: string IsSourceDestChecked: - description: (Net only) If true, the source/destination check is enabled. If false, it is disabled. This value must be false for a NAT VM to perform network address translation (NAT) in a Net. + description: "(Net only) If true, the source/destination check is enabled. + If false, it is disabled. This value must be false for a NAT VM to perform + network address translation (NAT) in a Net." type: boolean KeypairName: description: The name of the keypair used when launching the VM. type: string LaunchNumber: - description: The number for the VM when launching a group of several VMs (for example, `0`, `1`, `2`, and so on). + description: The number for the VM when launching a group of several VMs + (for example, `0`, `1`, `2`, and so on). type: integer NestedVirtualization: - description: If true, nested virtualization is enabled. If false, it is disabled. + description: If true, nested virtualization is enabled. If false, it is + disabled. type: boolean NetId: description: The ID of the Net in which the VM is running. type: string Nics: - description: (Net only) The network interface cards (NICs) the VMs are attached to. + description: "(Net only) The network interface cards (NICs) the VMs are + attached to." items: - $ref: '#/components/schemas/NicLight' + "$ref": "#/components/schemas/NicLight" type: array OsFamily: description: Indicates the operating system (OS) of the VM. @@ -8706,7 +9552,7 @@ components: description: The performance of the VM (`medium` \| `high` \| `highest`). type: string Placement: - $ref: '#/components/schemas/Placement' + "$ref": "#/components/schemas/Placement" PrivateDnsName: description: The name of the private DNS. type: string @@ -8714,7 +9560,8 @@ components: description: The primary private IP of the VM. type: string ProductCodes: - description: The product codes associated with the OMI used to create the VM. + description: The product codes associated with the OMI used to create the + VM. items: type: string type: array @@ -8736,10 +9583,11 @@ components: SecurityGroups: description: One or more security groups associated with the VM. items: - $ref: '#/components/schemas/SecurityGroupLight' + "$ref": "#/components/schemas/SecurityGroupLight" type: array State: - description: The state of the VM (`pending` \| `running` \| `stopping` \| `stopped` \| `shutting-down` \| `terminated` \| `quarantine`). + description: The state of the VM (`pending` \| `running` \| `stopping` \| + `stopped` \| `shutting-down` \| `terminated` \| `quarantine`). type: string StateReason: description: The reason explaining the current state of the VM. @@ -8750,7 +9598,7 @@ components: Tags: description: One or more tags associated with the VM. items: - $ref: '#/components/schemas/ResourceTag' + "$ref": "#/components/schemas/ResourceTag" type: array UserData: description: The Base64-encoded MIME user data. @@ -8759,7 +9607,9 @@ components: description: The ID of the VM. type: string VmInitiatedShutdownBehavior: - 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 deleted. + 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 deleted. type: string VmType: description: The type of VM. For more information, see [Instance Types](https://docs.outscale.com/en/userguide/Instance-Types.html). @@ -8777,7 +9627,11 @@ 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 on a different hypervisor, which improves fault tolerance. + 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 + on a different hypervisor, which improves fault tolerance. enum: - attract - no-strategy @@ -8789,7 +9643,8 @@ 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 (`pending` \| `available` \| `scaling + up` \| `scaling down` \| `deleting` \| `deleted`). enum: - available - deleted @@ -8804,7 +9659,7 @@ components: Tags: description: One or more tags associated with the VM group. items: - $ref: '#/components/schemas/ResourceTag' + "$ref": "#/components/schemas/ResourceTag" type: array VmCount: description: The number of VMs in the VM group. @@ -8829,10 +9684,12 @@ components: description: Information about the state of the VM. properties: CurrentState: - description: The current state of the VM (`InService` \| `OutOfService` \| `Unknown`). + description: The current state of the VM (`InService` \| `OutOfService` + \| `Unknown`). type: string PreviousState: - description: The previous state of the VM (`InService` \| `OutOfService` \| `Unknown`). + description: The previous state of the VM (`InService` \| `OutOfService` + \| `Unknown`). type: string VmId: description: The ID of the VM. @@ -8845,7 +9702,7 @@ components: MaintenanceEvents: description: One or more scheduled events associated with the VM. items: - $ref: '#/components/schemas/MaintenanceEvent' + "$ref": "#/components/schemas/MaintenanceEvent" type: array SubregionName: description: The name of the Subregion of the VM. @@ -8854,7 +9711,8 @@ components: description: The ID of the VM. type: string VmState: - description: The state of the VM (`pending` \| `running` \| `stopping` \| `stopped` \| `shutting-down` \| `terminated` \| `quarantine`). + description: The state of the VM (`pending` \| `running` \| `stopping` \| + `stopped` \| `shutting-down` \| `terminated` \| `quarantine`). type: string type: object VmTemplate: @@ -8893,7 +9751,7 @@ components: Tags: description: One or more tags associated with the VM template. items: - $ref: '#/components/schemas/ResourceTag' + "$ref": "#/components/schemas/ResourceTag" type: array VmTemplateId: description: The ID of the VM template. @@ -8914,10 +9772,12 @@ components: description: Information about the VM type. properties: BsuOptimized: - description: This parameter is not available. It is present in our API for the sake of historical compatibility with AWS. + description: This parameter is not available. It is present in our API for + the sake of historical compatibility with AWS. type: boolean MaxPrivateIps: - description: The maximum number of private IPs per network interface card (NIC). + description: The maximum number of private IPs per network interface card + (NIC). type: integer MemorySize: description: The amount of memory, in gibibytes. @@ -8945,16 +9805,15 @@ components: format: datetime type: string Iops: - description: 'The number of I/O operations per second (IOPS):
- + description: |- + The number of I/O operations per second (IOPS):
- For `io1` volumes, the number of provisioned IOPS
- - - For `gp2` volumes, the baseline performance of the volume' + - For `gp2` volumes, the baseline performance of the volume type: integer LinkedVolumes: description: Information about your volume attachment. items: - $ref: '#/components/schemas/LinkedVolume' + "$ref": "#/components/schemas/LinkedVolume" type: array Size: description: The size of the volume, in gibibytes (GiB). @@ -8963,7 +9822,8 @@ components: description: The snapshot from which the volume was created. type: string State: - description: The state of the volume (`creating` \| `available` \| `in-use` \| `updating` \| `deleting` \| `error`). + description: The state of the volume (`creating` \| `available` \| `in-use` + \| `updating` \| `deleting` \| `error`). type: string SubregionName: description: The Subregion in which the volume was created. @@ -8971,7 +9831,7 @@ components: Tags: description: One or more tags associated with the volume. items: - $ref: '#/components/schemas/ResourceTag' + "$ref": "#/components/schemas/ResourceTag" type: array VolumeId: description: The ID of the volume. @@ -8988,51 +9848,60 @@ components: description: Example configuration for the client gateway. type: string ClientGatewayId: - description: The ID of the client gateway used on the client end of the connection. + description: The ID of the client gateway used on the client end of the + connection. type: string ConnectionType: description: The type of VPN connection (always `ipsec.1`). type: string Routes: - description: Information about one or more static routes associated with the VPN connection, if any. + description: Information about one or more static routes associated with + the VPN connection, if any. items: - $ref: '#/components/schemas/RouteLight' + "$ref": "#/components/schemas/RouteLight" type: array State: - description: The state of the VPN connection (`pending` \| `available` \| `deleting` \| `deleted`). + description: The state of the VPN connection (`pending` \| `available` \| + `deleting` \| `deleted`). type: string StaticRoutesOnly: - description: If false, the VPN connection uses dynamic routing with Border Gateway Protocol (BGP). If true, routing is controlled using static routes. For more information about how to create and delete static routes, see [CreateVpnConnectionRoute](#createvpnconnectionroute) and [DeleteVpnConnectionRoute](#deletevpnconnectionroute). + description: If false, the VPN connection uses dynamic routing with Border + Gateway Protocol (BGP). If true, routing is controlled using static routes. + For more information about how to create and delete static routes, see + [CreateVpnConnectionRoute](#createvpnconnectionroute) and [DeleteVpnConnectionRoute](#deletevpnconnectionroute). type: boolean Tags: description: One or more tags associated with the VPN connection. items: - $ref: '#/components/schemas/ResourceTag' + "$ref": "#/components/schemas/ResourceTag" type: array VgwTelemetries: - description: Information about the current state of one or more of the VPN tunnels. + description: Information about the current state of one or more of the VPN + tunnels. items: - $ref: '#/components/schemas/VgwTelemetry' + "$ref": "#/components/schemas/VgwTelemetry" type: array VirtualGatewayId: - description: The ID of the virtual gateway used on the OUTSCALE end of the connection. + description: The ID of the virtual gateway used on the OUTSCALE end of the + connection. type: string VpnConnectionId: description: The ID of the VPN connection. type: string VpnOptions: - $ref: '#/components/schemas/VpnOptions' + "$ref": "#/components/schemas/VpnOptions" type: object VpnOptions: additionalProperties: false description: Information about the VPN options. properties: Phase1Options: - $ref: '#/components/schemas/Phase1Options' + "$ref": "#/components/schemas/Phase1Options" Phase2Options: - $ref: '#/components/schemas/Phase2Options' + "$ref": "#/components/schemas/Phase2Options" TunnelInsideIpRange: - description: The range of inside IPs for the tunnel. This must be a /30 CIDR block from the 169.254.254.0/24 range. + description: The range of inside IPs for the tunnel. This must be a /30 + CIDR block from the 169.254.254.0/24 range. type: string type: object With: @@ -9069,11 +9938,13 @@ components: type: boolean QueryHeaderRaw: default: true - description: By default or if set to true, the raw header of the HTTP request is displayed. + description: By default or if set to 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: By default or if set to true, the size of the raw header of + the HTTP request is displayed. type: boolean QueryIpAddress: default: true @@ -9081,15 +9952,18 @@ components: type: boolean QueryPayloadRaw: default: true - description: By default or if set to true, the raw payload of the HTTP request is displayed. + description: By default or if set to 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: By default or if set to 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: By default or if set to true, the user agent of the HTTP request + is displayed. type: boolean RequestId: default: true @@ -9101,95 +9975,99 @@ components: type: boolean ResponseStatusCode: default: true - description: By default or if set to true, the HTTP status code of the response is displayed. + description: By default or if set to true, the HTTP status code of the response + is displayed. type: boolean type: object securitySchemes: ApiKeyAuth: - description: "With this authentication scheme, you must use an access key to sign your API requests. For more information, see [About Signatures of API Requests](https://docs.outscale.com/en/userguide/About-Signatures-of-API-Requests.html).
\n * In addition to your access key, you can configure API access rules with Certificate Authorities (CAs), requiring you to provide a certificate to perform actions. In that case, you can bypass systematically providing a certificate by activating a trusted session. For more information, see the [UpdateApiAccessPolicy](#updateapiaccesspolicy) method and [About Your API Access Policy](https://docs.outscale.com/en/userguide/About-Your-API-Access-Policy.html)." + description: |- + With this authentication scheme, you must use an access key to sign your API requests. For more information, see [About Signatures of API Requests](https://docs.outscale.com/en/userguide/About-Signatures-of-API-Requests.html).
+ * In addition to your access key, you can configure API access rules with Certificate Authorities (CAs), requiring you to provide a certificate to perform actions. In that case, you can bypass systematically providing a certificate by activating a trusted session. For more information, see the [UpdateApiAccessPolicy](#updateapiaccesspolicy) method and [About Your API Access Policy](https://docs.outscale.com/en/userguide/About-Your-API-Access-Policy.html). in: header name: Authorization type: apiKey ApiKeyAuthSec: - description: "With this authentication scheme, you must use an access key to sign your API requests. For more information, see [About Signatures of API Requests](https://docs.outscale.com/en/userguide/About-Signatures-of-API-Requests.html).
\n * In addition to your access key, if you have configured API access rules with a Certificate Authority (CA), you cannot bypass systematically providing a certificate even if you activate a trusted session. For more information, see [About Your API Access Policy](https://docs.outscale.com/en/userguide/About-Your-API-Access-Policy.html)." + description: |- + With this authentication scheme, you must use an access key to sign your API requests. For more information, see [About Signatures of API Requests](https://docs.outscale.com/en/userguide/About-Signatures-of-API-Requests.html).
+ * In addition to your access key, if you have configured API access rules with a Certificate Authority (CA), you cannot bypass systematically providing a certificate even if you activate a trusted session. For more information, see [About Your API Access Policy](https://docs.outscale.com/en/userguide/About-Your-API-Access-Policy.html). in: header name: Authorization type: apiKey BasicAuth: - description: "With this authentication scheme, you must specify the following headers in your API request:
\n * `Authorization: Basic XXXX`, where `XXXX` is your `email:password` encoded in Base64\n * `X-Osc-Date` in the `YYYYMMDDTHHMMSSZ` format\n * Example with Curl: ``$ curl -X POST https://api.eu-west-2.outscale.com/api/v1/ReadAccessKeys -H "Authorization: Basic `echo -n "MYEMAIL:MYPASSWORD" | base64`" -H "X-Osc-Date: `TZ=GMT date "+%Y%m%dT%H%M%SZ"`"``\n * In addition to your email and password combination, if you have configured API access rules with a Certificate Authority (CA), you cannot bypass systematically providing a certificate even if you activate a trusted session. For more information, see [About Your API Access Policy](https://docs.outscale.com/en/userguide/About-Your-API-Access-Policy.html)." + description: |- + With this authentication scheme, you must specify the following headers in your API request:
+ * `Authorization: Basic XXXX`, where `XXXX` is your `email:password` encoded in Base64 + * `X-Osc-Date` in the `YYYYMMDDTHHMMSSZ` format + * Example with Curl: ``$ curl -X POST https://api.eu-west-2.outscale.com/api/v1/ReadAccessKeys -H "Authorization: Basic `echo -n "MYEMAIL:MYPASSWORD" | base64`" -H "X-Osc-Date: `TZ=GMT date "+%Y%m%dT%H%M%SZ"`"`` + * In addition to your email and password combination, if you have configured API access rules with a Certificate Authority (CA), you cannot bypass systematically providing a certificate even if you activate a trusted session. For more information, see [About Your API Access Policy](https://docs.outscale.com/en/userguide/About-Your-API-Access-Policy.html). scheme: basic type: http info: contact: email: support@outscale.com - description: 'Welcome to the OUTSCALE API documentation.
- + description: |- + Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

- You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

- Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
- You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

- - An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).' + An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). license: name: BSD 3 Clause url: https://opensource.org/licenses/BSD-3-Clause termsOfService: https://en.outscale.com/terms-of-service/ title: 3DS OUTSCALE API - version: '1.26' + version: '1.27' openapi: 3.0.0 paths: - /AcceptNetPeering: - description: 'Accepts a Net peering request.
- + "/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.' + 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: operationId: AcceptNetPeering requestBody: content: application/json: schema: - $ref: '#/components/schemas/AcceptNetPeeringRequest' + "$ref": "#/components/schemas/AcceptNetPeeringRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/AcceptNetPeeringResponse' + "$ref": "#/components/schemas/AcceptNetPeeringResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '409': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 409 response (Conflict). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - NetPeering - /CheckAuthentication: + "/CheckAuthentication": description: Validates the authenticity of the account. post: operationId: CheckAuthentication @@ -9197,91 +10075,88 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/CheckAuthenticationRequest' + "$ref": "#/components/schemas/CheckAuthenticationRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/CheckAuthenticationResponse' + "$ref": "#/components/schemas/CheckAuthenticationResponse" description: The HTTP 200 response (OK). tags: - Account - /CreateAccessKey: - description: Creates an access key for your account. The new key is automatically set to `ACTIVE`. + "/CreateAccessKey": + description: Creates an access key for either your root account or an EIM user. + The new key is automatically set to `ACTIVE`. post: operationId: CreateAccessKey requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateAccessKeyRequest' + "$ref": "#/components/schemas/CreateAccessKeyRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/CreateAccessKeyResponse' + "$ref": "#/components/schemas/CreateAccessKeyResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] - BasicAuth: [] tags: - AccessKey - /CreateAccount: - description: 'Creates an OUTSCALE account.

- + "/CreateAccount": + description: |- + Creates an OUTSCALE account.

**[NOTE]**
- * 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"''`).' + * 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"'`). post: operationId: CreateAccount requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateAccountRequest' + "$ref": "#/components/schemas/CreateAccountRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/CreateAccountResponse' + "$ref": "#/components/schemas/CreateAccountResponse" description: The HTTP 200 response (OK). tags: - Account - /CreateApiAccessRule: - description: 'Creates a rule to allow access to the API from your 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).' + 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: operationId: CreateApiAccessRule requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateApiAccessRuleRequest' + "$ref": "#/components/schemas/CreateApiAccessRuleRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/CreateApiAccessRuleResponse' + "$ref": "#/components/schemas/CreateApiAccessRuleResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] - BasicAuth: [] tags: - ApiAccessRule - /CreateCa: + "/CreateCa": description: Creates a Client Certificate Authority (CA). post: operationId: CreateCa @@ -9289,330 +10164,317 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/CreateCaRequest' + "$ref": "#/components/schemas/CreateCaRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/CreateCaResponse' + "$ref": "#/components/schemas/CreateCaResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] - BasicAuth: [] tags: - Ca - /CreateClientGateway: - description: 'Provides information about your client gateway.
- + "/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).' + 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). post: operationId: CreateClientGateway requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateClientGatewayRequest' + "$ref": "#/components/schemas/CreateClientGatewayRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/CreateClientGatewayResponse' + "$ref": "#/components/schemas/CreateClientGatewayResponse" description: The HTTP 200 response (OK). tags: - ClientGateway - /CreateDhcpOptions: - description: Creates a set of DHCP options, that you can then associate with a Net using the [UpdateNet](#updatenet) method. + "/CreateDhcpOptions": + description: Creates a set of DHCP options, that you can then associate with a + Net using the [UpdateNet](#updatenet) method. post: operationId: CreateDhcpOptions requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateDhcpOptionsRequest' + "$ref": "#/components/schemas/CreateDhcpOptionsRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/CreateDhcpOptionsResponse' + "$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. + "/CreateDirectLink": + description: Creates a DirectLink between a customer network and a specified DirectLink + location. post: operationId: CreateDirectLink requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateDirectLinkRequest' + "$ref": "#/components/schemas/CreateDirectLinkRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/CreateDirectLinkResponse' + "$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.' + "/CreateDirectLinkInterface": + description: |- + Creates a DirectLink interface.
+ DirectLink interfaces enable you to reach one of your Nets through a virtual gateway. post: operationId: CreateDirectLinkInterface requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateDirectLinkInterfaceRequest' + "$ref": "#/components/schemas/CreateDirectLinkInterfaceRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/CreateDirectLinkInterfaceResponse' + "$ref": "#/components/schemas/CreateDirectLinkInterfaceResponse" 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).' + "/CreateFlexibleGpu": + description: |- + Allocates a flexible GPU (fGPU) to your account.
+ You can then attach this fGPU to a virtual machine (VM). post: operationId: CreateFlexibleGpu requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateFlexibleGpuRequest' + "$ref": "#/components/schemas/CreateFlexibleGpuRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/CreateFlexibleGpuResponse' + "$ref": "#/components/schemas/CreateFlexibleGpuResponse" description: The HTTP 200 response (OK). tags: - FlexibleGpu - /CreateImage: - description: 'Creates an OUTSCALE machine image (OMI) from an existing virtual machine (VM) which is either running or stopped.
- + "/CreateImage": + description: |- + Creates an OUTSCALE machine image (OMI) from an existing virtual machine (VM) which is either running or stopped.
This action also creates a snapshot of the root volume of the VM, as well as a snapshot of each Block Storage Unit (BSU) volume attached to the VM. For more information, see [About OMIs](https://docs.outscale.com/en/userguide/About-OMIs.html).

- You can also use this method to copy an OMI to your account, from an account in the same Region. To do so, the owner of the source OMI must share it with your account. For more information about how to share an OMI with another account in the same Region, see [UpdateImage](#updateimage).
- To copy an OMI between accounts in different Regions, the owner of the source OMI must first export it to an OUTSCALE Object Storage (OOS) bucket using the [CreateImageExportTask](#createimageexporttask) method, and then you need to create a copy of the image in your account.
- The copy of the source OMI is independent and belongs to you.

- You can also use this method to register an OMI to finalize its creation process.
- You can register an OMI from a snapshot of a root device to create an OMI based on this snapshot. You can also register an OMI that has been exported to an S3-compatible bucket to create a copy of it in your account. For more information about OMI export to an OOS bucket, see [CreateImageExportTask](#createimageexporttask).
- You can register an OMI using a pre-signed URL of the manifest file of the OMI. You do not need any permission for this OMI, or the bucket in which it is contained. The manifest file is obsolete seven days after a completed export as it contains pre-signed URLs to the appropriate snapshots (pre-signed URLs are valid for only seven days).
- - Once the OMI is registered, you can launch a VM from this OMI. The copy of the source OMI is independent and belongs to you.' + Once the OMI is registered, you can launch a VM from this OMI. The copy of the source OMI is independent and belongs to you. post: operationId: CreateImage requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateImageRequest' + "$ref": "#/components/schemas/CreateImageRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/CreateImageResponse' + "$ref": "#/components/schemas/CreateImageResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - Image - /CreateImageExportTask: - description: 'Exports an Outscale machine image (OMI) to an OUTSCALE Object Storage (OOS) bucket.
- + "/CreateImageExportTask": + description: |- + Exports an Outscale machine image (OMI) to an OUTSCALE Object Storage (OOS) bucket.
This action enables you to copy an OMI between accounts in different Regions. To copy an OMI in the same Region, you can also use the [CreateImage](#createimage) method.
- The copy of the OMI belongs to you and is independent from the source OMI.

- **[NOTE]**
- - 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.' + 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. post: operationId: CreateImageExportTask requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateImageExportTaskRequest' + "$ref": "#/components/schemas/CreateImageExportTaskRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/CreateImageExportTaskResponse' + "$ref": "#/components/schemas/CreateImageExportTaskResponse" description: The HTTP 200 response (OK). tags: - Image - /CreateInternetService: - description: 'Creates an Internet service you can use with a Net.
- - An Internet service enables your virtual machines (VMs) launched in a Net to connect to the Internet. By default, a Net includes an Internet service, and each Subnet is public. Every VM launched within a default Subnet has a private IP and a public IP.' + "/CreateInternetService": + description: |- + Creates an Internet service you can use with a Net.
+ An Internet service enables your virtual machines (VMs) launched in a Net to connect to the Internet. By default, a Net includes an Internet service, and each Subnet is public. Every VM launched within a default Subnet has a private IP and a public IP. post: operationId: CreateInternetService requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateInternetServiceRequest' + "$ref": "#/components/schemas/CreateInternetServiceRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/CreateInternetServiceResponse' + "$ref": "#/components/schemas/CreateInternetServiceResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - InternetService - /CreateKeypair: - description: 'Creates a 2048-bit RSA keypair with a specified name.
- + "/CreateKeypair": + description: |- + Creates a 2048-bit RSA keypair with a specified name.
This action returns the private key that you need to save. The public key is stored by 3DS OUTSCALE.

- You can also import a public key. The following types of key can be imported: RSA (minimum 2048 bits, recommended 4096 bits), ECDSA (minimum and recommended 256 bits), and Ed25519. The following formats can be used: PEM, PKCS8, RFC4716, and OpenSSH.
- - This action imports the public key of a keypair created by a third-party tool and uses it to create a keypair. The private key is never provided to 3DS OUTSCALE.' + This action imports the public key of a keypair created by a third-party tool and uses it to create a keypair. The private key is never provided to 3DS OUTSCALE. post: operationId: CreateKeypair requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateKeypairRequest' + "$ref": "#/components/schemas/CreateKeypairRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/CreateKeypairResponse' + "$ref": "#/components/schemas/CreateKeypairResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '409': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 409 response (Conflict). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). 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.' + "/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. post: operationId: CreateListenerRule requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateListenerRuleRequest' + "$ref": "#/components/schemas/CreateListenerRuleRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/CreateListenerRuleResponse' + "$ref": "#/components/schemas/CreateListenerRuleResponse" description: The HTTP 200 response (OK). tags: - Listener - /CreateLoadBalancer: - description: 'Creates a load balancer.
- + "/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.' + You must specify either the `Subnets` or the `SubregionNames` parameters. post: operationId: CreateLoadBalancer requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateLoadBalancerRequest' + "$ref": "#/components/schemas/CreateLoadBalancerRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/CreateLoadBalancerResponse' + "$ref": "#/components/schemas/CreateLoadBalancerResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer - /CreateLoadBalancerListeners: + "/CreateLoadBalancerListeners": description: Creates one or more listeners for a specified load balancer. post: operationId: CreateLoadBalancerListeners @@ -9620,226 +10482,213 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/CreateLoadBalancerListenersRequest' + "$ref": "#/components/schemas/CreateLoadBalancerListenersRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/CreateLoadBalancerListenersResponse' + "$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.
- + "/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 back-end 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.' + The session stops being sticky if the application cookie is removed or expires, until a new application cookie is issued. post: operationId: CreateLoadBalancerPolicy requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateLoadBalancerPolicyRequest' + "$ref": "#/components/schemas/CreateLoadBalancerPolicyRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/CreateLoadBalancerPolicyResponse' + "$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.' + "/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. post: operationId: CreateLoadBalancerTags requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateLoadBalancerTagsRequest' + "$ref": "#/components/schemas/CreateLoadBalancerTagsRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/CreateLoadBalancerTagsResponse' + "$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.
- + "/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).

- **[NOTE]**
- - 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.' + 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. post: operationId: CreateNatService requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateNatServiceRequest' + "$ref": "#/components/schemas/CreateNatServiceRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/CreateNatServiceResponse' + "$ref": "#/components/schemas/CreateNatServiceResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). 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).' + "/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). post: operationId: CreateNet requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateNetRequest' + "$ref": "#/components/schemas/CreateNetRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/CreateNetResponse' + "$ref": "#/components/schemas/CreateNetResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '409': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 409 response (Conflict). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - Net - /CreateNetAccessPoint: - description: 'Creates a Net access point to access an OUTSCALE service from this Net without using the Internet and public IPs.
- + "/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.' + 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. post: operationId: CreateNetAccessPoint requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateNetAccessPointRequest' + "$ref": "#/components/schemas/CreateNetAccessPointRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/CreateNetAccessPointResponse' + "$ref": "#/components/schemas/CreateNetAccessPointResponse" 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.
- + "/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).

- **[NOTE]**
- * 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. Therefore, you do not need to create a B-to-A connection if an A-to-B connection is created and accepted.' + * A peering connection between two Nets works both ways. Therefore, you do not need to create a B-to-A connection if an A-to-B connection is created and accepted. post: operationId: CreateNetPeering requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateNetPeeringRequest' + "$ref": "#/components/schemas/CreateNetPeeringRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/CreateNetPeeringResponse' + "$ref": "#/components/schemas/CreateNetPeeringResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - NetPeering - /CreateNic: + "/CreateNic": description: Creates a network interface card (NIC) in the specified Subnet. post: operationId: CreateNic @@ -9847,750 +10696,712 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/CreateNicRequest' + "$ref": "#/components/schemas/CreateNicRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/CreateNicResponse' + "$ref": "#/components/schemas/CreateNicResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - Nic - /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.' + "/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. post: operationId: CreatePublicIp requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreatePublicIpRequest' + "$ref": "#/components/schemas/CreatePublicIpRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/CreatePublicIpResponse' + "$ref": "#/components/schemas/CreatePublicIpResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - PublicIp - /CreateRoute: - description: 'Creates a route in a specified route table within a specified Net.
- + "/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:

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

- - The routing algorithm is based on the most specific match.' + The routing algorithm is based on the most specific match. post: operationId: CreateRoute requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateRouteRequest' + "$ref": "#/components/schemas/CreateRouteRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/CreateRouteResponse' + "$ref": "#/components/schemas/CreateRouteResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). 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.' + "/CreateRouteTable": + description: |- + Creates a route table for a specified Net.
+ You can then add routes and associate this route table with a Subnet. post: operationId: CreateRouteTable requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateRouteTableRequest' + "$ref": "#/components/schemas/CreateRouteTableRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/CreateRouteTableResponse' + "$ref": "#/components/schemas/CreateRouteTableResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - RouteTable - /CreateSecurityGroup: - description: 'Creates a security group.
- + "/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.' + To add or remove rules, use the [CreateSecurityGroupRule](#createsecuritygrouprule) method. post: operationId: CreateSecurityGroup requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateSecurityGroupRequest' + "$ref": "#/components/schemas/CreateSecurityGroupRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/CreateSecurityGroupResponse' + "$ref": "#/components/schemas/CreateSecurityGroupResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - SecurityGroup - /CreateSecurityGroupRule: - description: 'Adds one or more rules to a security group.
- + "/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).
- (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. - **[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.' + * 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. post: operationId: CreateSecurityGroupRule requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateSecurityGroupRuleRequest' + "$ref": "#/components/schemas/CreateSecurityGroupRuleRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/CreateSecurityGroupRuleResponse' + "$ref": "#/components/schemas/CreateSecurityGroupRuleResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - SecurityGroupRule - /CreateServerCertificate: - description: 'Creates a server certificate and its matching private key.

- + "/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 the 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.' + This private key must not be protected by a password or a passphrase. post: operationId: CreateServerCertificate requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateServerCertificateRequest' + "$ref": "#/components/schemas/CreateServerCertificateRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/CreateServerCertificateResponse' + "$ref": "#/components/schemas/CreateServerCertificateResponse" 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.
- + "/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**: You create a snapshot from one of your volumes.
- * **Copying**: 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**: You import a snapshot located in an OUTSCALE Object Storage (OOS) bucket. First, the owner of the source snapshot must export it to the bucket by using the [CreateSnapshotExportTask](#createsnapshotexporttask) method. Then, they must grant you read permission on the bucket via a pre-signed URL or Access Control Lists. For more information, see [Managing Access to Your Buckets and Objects](https://docs.outscale.com/en/userguide/Managing-Access-to-Your-Buckets-and-Objects.html).' + * **Importing**: You import a snapshot located in an OUTSCALE Object Storage (OOS) bucket. First, the owner of the source snapshot must export it to the bucket by using the [CreateSnapshotExportTask](#createsnapshotexporttask) method. Then, they must grant you read permission on the bucket via a pre-signed URL or Access Control Lists. For more information, see [Managing Access to Your Buckets and Objects](https://docs.outscale.com/en/userguide/Managing-Access-to-Your-Buckets-and-Objects.html). post: operationId: CreateSnapshot requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateSnapshotRequest' + "$ref": "#/components/schemas/CreateSnapshotRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/CreateSnapshotResponse' + "$ref": "#/components/schemas/CreateSnapshotResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - Snapshot - /CreateSnapshotExportTask: - description: 'Exports a snapshot to an OUTSCALE Object Storage (OOS) bucket.
- + "/CreateSnapshotExportTask": + description: |- + Exports a snapshot to an OUTSCALE Object Storage (OOS) bucket.
This action enables you to create a backup of your snapshot or to copy it to another account. You, or other users you send a pre-signed URL to, can then download this snapshot from the bucket using the [CreateSnapshot](#createsnapshot) method.
- - This procedure enables you to copy a snapshot between accounts within the same Region or in different Regions. To copy a snapshot within the same Region, you can also use the [CreateSnapshot](#createsnapshot) direct method. The copy of the source snapshot is independent and belongs to you.' + This procedure enables you to copy a snapshot between accounts within the same Region or in different Regions. To copy a snapshot within the same Region, you can also use the [CreateSnapshot](#createsnapshot) direct method. The copy of the source snapshot is independent and belongs to you. post: operationId: CreateSnapshotExportTask requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateSnapshotExportTaskRequest' + "$ref": "#/components/schemas/CreateSnapshotExportTaskRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/CreateSnapshotExportTaskResponse' + "$ref": "#/components/schemas/CreateSnapshotExportTaskResponse" 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.' + "/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. post: operationId: CreateSubnet requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateSubnetRequest' + "$ref": "#/components/schemas/CreateSubnetRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/CreateSubnetResponse' + "$ref": "#/components/schemas/CreateSubnetResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '409': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 409 response (Conflict). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - Subnet - /CreateTags: - description: 'Adds one or more tags to the specified resources.
- + "/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:

- * Virtual machines (VMs) (i-xxxxxxxx)
- * OMIs (ami-xxxxxxxx)
- * Volumes (vol-xxxxxxxx)
- * Snapshots (snap-xxxxxxxx)
- * Public IPs (eipalloc-xxxxxxxx)
- * Security groups (sg-xxxxxxxx)
- * Route tables (rtb-xxxxxxxx)
- * Network interface cards (NIC) (eni-xxxxxxxx)
- * Nets (vpc-xxxxxxxx)
- * Subnets (subnet-xxxxxxxx)
- * Net peerings (vpcx-xxxxxxxx)
- * Net endpoints (vpce-xxxxxxxx)
- * NAT services (nat-xxxxxxxx)
- * Internet services (igw-xxxxxxxx)
- * Client gateways (cgw-xxxxxxxx)
- * Virtual gateways (vgw-xxxxxxxx)
- * VPN connections (vpn-xxxxxxxx)
- * DHCP options (dopt-xxxxxxxx)
- * OMI export tasks (image-export-xxxxxxxx)
- - * Snapshot export tasks (snap-export-xxxxxxxx)' + * Snapshot export tasks (snap-export-xxxxxxxx) post: operationId: CreateTags requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateTagsRequest' + "$ref": "#/components/schemas/CreateTagsRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/CreateTagsResponse' + "$ref": "#/components/schemas/CreateTagsResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - Tag - /CreateVirtualGateway: - description: 'Creates a virtual gateway.
- - A virtual gateway is the access point on the Net side of a VPN connection.' + "/CreateUser": + description: Creates an EIM user for your account. + post: + operationId: CreateUser + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/CreateUserRequest" + responses: + '200': + content: + application/json: + schema: + "$ref": "#/components/schemas/CreateUserResponse" + description: The HTTP 200 response (OK). + tags: + - User + "/CreateVirtualGateway": + description: |- + Creates a virtual gateway.
+ A virtual gateway is the access point on the Net side of a VPN connection. post: operationId: CreateVirtualGateway requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateVirtualGatewayRequest' + "$ref": "#/components/schemas/CreateVirtualGatewayRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/CreateVirtualGatewayResponse' + "$ref": "#/components/schemas/CreateVirtualGatewayResponse" description: The HTTP 200 response (OK). tags: - VirtualGateway - /CreateVmGroup: - description: '> [WARNING]
- + "/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.' + You can create up to 100 VM groups in your account. post: operationId: CreateVmGroup requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateVmGroupRequest' + "$ref": "#/components/schemas/CreateVmGroupRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/CreateVmGroupResponse' + "$ref": "#/components/schemas/CreateVmGroupResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - VmGroup - /CreateVmTemplate: - description: '> [WARNING]
- + "/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.' + You can create up to 50 VM templates in your account. post: operationId: CreateVmTemplate requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateVmTemplateRequest' + "$ref": "#/components/schemas/CreateVmTemplateRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/CreateVmTemplateResponse' + "$ref": "#/components/schemas/CreateVmTemplateResponse" description: The HTTP 200 response (OK). tags: - VmTemplate - /CreateVms: - description: 'Creates virtual machines (VMs), and then launches them.
- + "/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.' + 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. post: operationId: CreateVms requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateVmsRequest' + "$ref": "#/components/schemas/CreateVmsRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/CreateVmsResponse' + "$ref": "#/components/schemas/CreateVmsResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - Vm - /CreateVolume: - description: 'Creates a Block Storage Unit (BSU) volume in a specified Region.
- + "/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.' + 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. post: operationId: CreateVolume requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateVolumeRequest' + "$ref": "#/components/schemas/CreateVolumeRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/CreateVolumeResponse' + "$ref": "#/components/schemas/CreateVolumeResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). 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.' + "/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. post: operationId: CreateVpnConnection requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateVpnConnectionRequest' + "$ref": "#/components/schemas/CreateVpnConnectionRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/CreateVpnConnectionResponse' + "$ref": "#/components/schemas/CreateVpnConnectionResponse" 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.' + "/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. post: operationId: CreateVpnConnectionRoute requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateVpnConnectionRouteRequest' + "$ref": "#/components/schemas/CreateVpnConnectionRouteRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/CreateVpnConnectionRouteResponse' + "$ref": "#/components/schemas/CreateVpnConnectionRouteResponse" description: The HTTP 200 response (OK). tags: - VpnConnection - /DeleteAccessKey: - description: 'Deletes the specified access key of your account.

- + "/DeleteAccessKey": + description: |- + Deletes the specified access key of either your root account or an EIM user.

**[NOTE]**
- - To protect against brute force attacks, the number of requests allowed for this method in a given time period is limited.' + To protect against brute force attacks, the number of requests allowed for this method in a given time period is limited. post: operationId: DeleteAccessKey requestBody: content: application/json: schema: - $ref: '#/components/schemas/DeleteAccessKeyRequest' + "$ref": "#/components/schemas/DeleteAccessKeyRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DeleteAccessKeyResponse' + "$ref": "#/components/schemas/DeleteAccessKeyResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] - BasicAuth: [] tags: - AccessKey - /DeleteApiAccessRule: - description: "Deletes a specified API access rule.

\n\n**[NOTE]**
\nYou 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)." + "/DeleteApiAccessRule": + description: "Deletes a specified API access rule.

\n\n**[NOTE]**
\nYou 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: operationId: DeleteApiAccessRule requestBody: content: application/json: schema: - $ref: '#/components/schemas/DeleteApiAccessRuleRequest' + "$ref": "#/components/schemas/DeleteApiAccessRuleRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DeleteApiAccessRuleResponse' + "$ref": "#/components/schemas/DeleteApiAccessRuleResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] - BasicAuth: [] tags: - ApiAccessRule - /DeleteCa: + "/DeleteCa": description: Deletes a specified Client Certificate Authority (CA). post: operationId: DeleteCa @@ -10598,85 +11409,83 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DeleteCaRequest' + "$ref": "#/components/schemas/DeleteCaRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DeleteCaResponse' + "$ref": "#/components/schemas/DeleteCaResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] - BasicAuth: [] tags: - Ca - /DeleteClientGateway: - description: 'Deletes a client gateway.
- - You must delete the VPN connection before deleting the client gateway.' + "/DeleteClientGateway": + description: |- + Deletes a client gateway.
+ You must delete the VPN connection before deleting the client gateway. post: operationId: DeleteClientGateway requestBody: content: application/json: schema: - $ref: '#/components/schemas/DeleteClientGatewayRequest' + "$ref": "#/components/schemas/DeleteClientGatewayRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DeleteClientGatewayResponse' + "$ref": "#/components/schemas/DeleteClientGatewayResponse" description: The HTTP 200 response (OK). tags: - ClientGateway - /DeleteDhcpOptions: - description: 'Deletes a specified DHCP options set.
- + "/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.

- **[NOTE]**
- - You cannot delete the `default` set.' + You cannot delete the `default` set. post: operationId: DeleteDhcpOptions requestBody: content: application/json: schema: - $ref: '#/components/schemas/DeleteDhcpOptionsRequest' + "$ref": "#/components/schemas/DeleteDhcpOptionsRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DeleteDhcpOptionsResponse' + "$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.' + "/DeleteDirectLink": + description: |- + Deletes a specified DirectLink.
+ Before deleting a DirectLink, ensure that all your DirectLink interfaces related to this DirectLink are deleted. post: operationId: DeleteDirectLink requestBody: content: application/json: schema: - $ref: '#/components/schemas/DeleteDirectLinkRequest' + "$ref": "#/components/schemas/DeleteDirectLinkRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DeleteDirectLinkResponse' + "$ref": "#/components/schemas/DeleteDirectLinkResponse" description: The HTTP 200 response (OK). tags: - DirectLink - /DeleteDirectLinkInterface: + "/DeleteDirectLinkInterface": description: Deletes a specified DirectLink interface. post: operationId: DeleteDirectLinkInterface @@ -10684,189 +11493,191 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DeleteDirectLinkInterfaceRequest' + "$ref": "#/components/schemas/DeleteDirectLinkInterfaceRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DeleteDirectLinkInterfaceResponse' + "$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.' + "/DeleteExportTask": + description: |- + Deletes an export task.
+ If the export task is not running, the command fails and an error is returned. post: operationId: DeleteExportTask requestBody: content: application/json: schema: - $ref: '#/components/schemas/DeleteExportTaskRequest' + "$ref": "#/components/schemas/DeleteExportTaskRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DeleteExportTaskResponse' + "$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.' + "/DeleteFlexibleGpu": + description: |- + Releases a flexible GPU (fGPU) from your account.
+ The fGPU becomes free to be used by someone else. post: operationId: DeleteFlexibleGpu requestBody: content: application/json: schema: - $ref: '#/components/schemas/DeleteFlexibleGpuRequest' + "$ref": "#/components/schemas/DeleteFlexibleGpuRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DeleteFlexibleGpuResponse' + "$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. + "/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: operationId: DeleteImage requestBody: content: application/json: schema: - $ref: '#/components/schemas/DeleteImageRequest' + "$ref": "#/components/schemas/DeleteImageRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DeleteImageResponse' + "$ref": "#/components/schemas/DeleteImageResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - Image - /DeleteInternetService: - description: 'Deletes an Internet service.
- - Before deleting an Internet service, you must detach it from any Net it is attached to.' + "/DeleteInternetService": + description: |- + Deletes an Internet service.
+ Before deleting an Internet service, you must detach it from any Net it is attached to. post: operationId: DeleteInternetService requestBody: content: application/json: schema: - $ref: '#/components/schemas/DeleteInternetServiceRequest' + "$ref": "#/components/schemas/DeleteInternetServiceRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DeleteInternetServiceResponse' + "$ref": "#/components/schemas/DeleteInternetServiceResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - InternetService - /DeleteKeypair: - description: 'Deletes the specified keypair.
- - This action deletes the public key stored by 3DS OUTSCALE, thus deleting the keypair.' + "/DeleteKeypair": + description: |- + Deletes the specified keypair.
+ This action deletes the public key stored by 3DS OUTSCALE, thus deleting the keypair. post: operationId: DeleteKeypair requestBody: content: application/json: schema: - $ref: '#/components/schemas/DeleteKeypairRequest' + "$ref": "#/components/schemas/DeleteKeypairRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DeleteKeypairResponse' + "$ref": "#/components/schemas/DeleteKeypairResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - Keypair - /DeleteListenerRule: - description: 'Deletes a listener rule.
- - The previously active rule is disabled after deletion.' + "/DeleteListenerRule": + description: |- + Deletes a listener rule.
+ The previously active rule is disabled after deletion. post: operationId: DeleteListenerRule requestBody: content: application/json: schema: - $ref: '#/components/schemas/DeleteListenerRuleRequest' + "$ref": "#/components/schemas/DeleteListenerRuleRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DeleteListenerRuleResponse' + "$ref": "#/components/schemas/DeleteListenerRuleResponse" description: The HTTP 200 response (OK). tags: - Listener - /DeleteLoadBalancer: + "/DeleteLoadBalancer": description: Deletes a specified load balancer. post: operationId: DeleteLoadBalancer @@ -10874,17 +11685,17 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DeleteLoadBalancerRequest' + "$ref": "#/components/schemas/DeleteLoadBalancerRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DeleteLoadBalancerResponse' + "$ref": "#/components/schemas/DeleteLoadBalancerResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer - /DeleteLoadBalancerListeners: + "/DeleteLoadBalancerListeners": description: Deletes listeners of a specified load balancer. post: operationId: DeleteLoadBalancerListeners @@ -10892,37 +11703,37 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DeleteLoadBalancerListenersRequest' + "$ref": "#/components/schemas/DeleteLoadBalancerListenersRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DeleteLoadBalancerListenersResponse' + "$ref": "#/components/schemas/DeleteLoadBalancerListenersResponse" 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.' + "/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: operationId: DeleteLoadBalancerPolicy requestBody: content: application/json: schema: - $ref: '#/components/schemas/DeleteLoadBalancerPolicyRequest' + "$ref": "#/components/schemas/DeleteLoadBalancerPolicyRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DeleteLoadBalancerPolicyResponse' + "$ref": "#/components/schemas/DeleteLoadBalancerPolicyResponse" description: The HTTP 200 response (OK). tags: - LoadBalancerPolicy - /DeleteLoadBalancerTags: + "/DeleteLoadBalancerTags": description: Deletes one or more tags from the specified load balancers. post: operationId: DeleteLoadBalancerTags @@ -10930,256 +11741,245 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DeleteLoadBalancerTagsRequest' + "$ref": "#/components/schemas/DeleteLoadBalancerTagsRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DeleteLoadBalancerTagsResponse' + "$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.' + "/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: operationId: DeleteNatService requestBody: content: application/json: schema: - $ref: '#/components/schemas/DeleteNatServiceRequest' + "$ref": "#/components/schemas/DeleteNatServiceRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DeleteNatServiceResponse' + "$ref": "#/components/schemas/DeleteNatServiceResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - NatService - /DeleteNet: - description: 'Deletes a specified Net.
- + "/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' + * Subnets post: operationId: DeleteNet requestBody: content: application/json: schema: - $ref: '#/components/schemas/DeleteNetRequest' + "$ref": "#/components/schemas/DeleteNetRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DeleteNetResponse' + "$ref": "#/components/schemas/DeleteNetResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). 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.' + "/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: operationId: DeleteNetAccessPoint requestBody: content: application/json: schema: - $ref: '#/components/schemas/DeleteNetAccessPointRequest' + "$ref": "#/components/schemas/DeleteNetAccessPointRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DeleteNetAccessPointResponse' + "$ref": "#/components/schemas/DeleteNetAccessPointResponse" description: The HTTP 200 response (OK). tags: - NetAccessPoint - /DeleteNetPeering: - description: 'Deletes a Net peering.
- + "/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.' + If it is in the `rejected`, `failed`, or `expired` states, it cannot be deleted. post: operationId: DeleteNetPeering requestBody: content: application/json: schema: - $ref: '#/components/schemas/DeleteNetPeeringRequest' + "$ref": "#/components/schemas/DeleteNetPeeringRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DeleteNetPeeringResponse' + "$ref": "#/components/schemas/DeleteNetPeeringResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '409': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 409 response (Conflict). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - NetPeering - /DeleteNic: - description: 'Deletes the specified network interface card (NIC).
- - The network interface must not be attached to any virtual machine (VM).' + "/DeleteNic": + description: |- + Deletes the specified network interface card (NIC).
+ The network interface must not be attached to any virtual machine (VM). post: operationId: DeleteNic requestBody: content: application/json: schema: - $ref: '#/components/schemas/DeleteNicRequest' + "$ref": "#/components/schemas/DeleteNicRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DeleteNicResponse' + "$ref": "#/components/schemas/DeleteNicResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - Nic - /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.' + "/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: operationId: DeletePublicIp requestBody: content: application/json: schema: - $ref: '#/components/schemas/DeletePublicIpRequest' + "$ref": "#/components/schemas/DeletePublicIpRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DeletePublicIpResponse' + "$ref": "#/components/schemas/DeletePublicIpResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - PublicIp - /DeleteRoute: + "/DeleteRoute": description: Deletes a route from a specified route table. post: operationId: DeleteRoute @@ -11187,155 +11987,152 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DeleteRouteRequest' + "$ref": "#/components/schemas/DeleteRouteRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DeleteRouteResponse' + "$ref": "#/components/schemas/DeleteRouteResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). 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.' + "/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: operationId: DeleteRouteTable requestBody: content: application/json: schema: - $ref: '#/components/schemas/DeleteRouteTableRequest' + "$ref": "#/components/schemas/DeleteRouteTableRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DeleteRouteTableResponse' + "$ref": "#/components/schemas/DeleteRouteTableResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - RouteTable - /DeleteSecurityGroup: - description: 'Deletes a specified security group.
- + "/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.' + This action fails if the specified group is associated with a virtual machine (VM) or referenced by another security group. post: operationId: DeleteSecurityGroup requestBody: content: application/json: schema: - $ref: '#/components/schemas/DeleteSecurityGroupRequest' + "$ref": "#/components/schemas/DeleteSecurityGroupRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DeleteSecurityGroupResponse' + "$ref": "#/components/schemas/DeleteSecurityGroupResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). 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.
- + "/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.' + 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: operationId: DeleteSecurityGroupRule requestBody: content: application/json: schema: - $ref: '#/components/schemas/DeleteSecurityGroupRuleRequest' + "$ref": "#/components/schemas/DeleteSecurityGroupRuleRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DeleteSecurityGroupRuleResponse' + "$ref": "#/components/schemas/DeleteSecurityGroupRuleResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - SecurityGroupRule - /DeleteServerCertificate: + "/DeleteServerCertificate": description: Deletes a specified server certificate. post: operationId: DeleteServerCertificate @@ -11343,102 +12140,98 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DeleteServerCertificateRequest' + "$ref": "#/components/schemas/DeleteServerCertificateRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DeleteServerCertificateResponse' + "$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.' + "/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: operationId: DeleteSnapshot requestBody: content: application/json: schema: - $ref: '#/components/schemas/DeleteSnapshotRequest' + "$ref": "#/components/schemas/DeleteSnapshotRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DeleteSnapshotResponse' + "$ref": "#/components/schemas/DeleteSnapshotResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - Snapshot - /DeleteSubnet: - description: 'Deletes a specified Subnet.
- + "/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)
- * Network Address Translation (NAT) gateways
- - * Load balancers' + * Load balancers post: operationId: DeleteSubnet requestBody: content: application/json: schema: - $ref: '#/components/schemas/DeleteSubnetRequest' + "$ref": "#/components/schemas/DeleteSubnetRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DeleteSubnetResponse' + "$ref": "#/components/schemas/DeleteSubnetResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - Subnet - /DeleteTags: + "/DeleteTags": description: Deletes one or more tags from the specified resources. post: operationId: DeleteTags @@ -11446,235 +12239,252 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DeleteTagsRequest' + "$ref": "#/components/schemas/DeleteTagsRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DeleteTagsResponse' + "$ref": "#/components/schemas/DeleteTagsResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - Tag - /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.' + "/DeleteUser": + description: Deletes a specified EIM user. The EIM user must not belong to any + group and have any key, signing certificate or attached policy. + post: + operationId: DeleteUser + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/DeleteUserRequest" + responses: + '200': + content: + application/json: + schema: + "$ref": "#/components/schemas/DeleteUserResponse" + description: The HTTP 200 response (OK). + tags: + - User + "/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: operationId: DeleteVirtualGateway requestBody: content: application/json: schema: - $ref: '#/components/schemas/DeleteVirtualGatewayRequest' + "$ref": "#/components/schemas/DeleteVirtualGatewayRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DeleteVirtualGatewayResponse' + "$ref": "#/components/schemas/DeleteVirtualGatewayResponse" description: The HTTP 200 response (OK). tags: - VirtualGateway - /DeleteVmGroup: - description: '> [WARNING]
- + "/DeleteVmGroup": + description: |- + > [WARNING]
> This feature is currently under development and may not function properly.
- - Deletes a specified VM group.' + Deletes a specified VM group. post: operationId: DeleteVmGroup requestBody: content: application/json: schema: - $ref: '#/components/schemas/DeleteVmGroupRequest' + "$ref": "#/components/schemas/DeleteVmGroupRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DeleteVmGroupResponse' + "$ref": "#/components/schemas/DeleteVmGroupResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - VmGroup - /DeleteVmTemplate: - description: '> [WARNING]
- + "/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.' + You cannot delete a template currently used by a VM group. post: operationId: DeleteVmTemplate requestBody: content: application/json: schema: - $ref: '#/components/schemas/DeleteVmTemplateRequest' + "$ref": "#/components/schemas/DeleteVmTemplateRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DeleteVmTemplateResponse' + "$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.' + "/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: operationId: DeleteVms requestBody: content: application/json: schema: - $ref: '#/components/schemas/DeleteVmsRequest' + "$ref": "#/components/schemas/DeleteVmsRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DeleteVmsResponse' + "$ref": "#/components/schemas/DeleteVmsResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). 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).' + "/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: operationId: DeleteVolume requestBody: content: application/json: schema: - $ref: '#/components/schemas/DeleteVolumeRequest' + "$ref": "#/components/schemas/DeleteVolumeRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DeleteVolumeResponse' + "$ref": "#/components/schemas/DeleteVolumeResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). 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.' + "/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: operationId: DeleteVpnConnection requestBody: content: application/json: schema: - $ref: '#/components/schemas/DeleteVpnConnectionRequest' + "$ref": "#/components/schemas/DeleteVpnConnectionRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DeleteVpnConnectionResponse' + "$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. + "/DeleteVpnConnectionRoute": + description: Deletes a static route to a VPN connection previously created using + the CreateVpnConnectionRoute method. post: operationId: DeleteVpnConnectionRoute requestBody: content: application/json: schema: - $ref: '#/components/schemas/DeleteVpnConnectionRouteRequest' + "$ref": "#/components/schemas/DeleteVpnConnectionRouteRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DeleteVpnConnectionRouteResponse' + "$ref": "#/components/schemas/DeleteVpnConnectionRouteResponse" description: The HTTP 200 response (OK). tags: - VpnConnection - /DeregisterVmsInLoadBalancer: + "/DeregisterVmsInLoadBalancer": description: Deregisters a specified virtual machine (VM) from a load balancer. post: operationId: DeregisterVmsInLoadBalancer @@ -11682,252 +12492,255 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DeregisterVmsInLoadBalancerRequest' + "$ref": "#/components/schemas/DeregisterVmsInLoadBalancerRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DeregisterVmsInLoadBalancerResponse' + "$ref": "#/components/schemas/DeregisterVmsInLoadBalancerResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer - /LinkFlexibleGpu: - description: 'Attaches one of your allocated flexible GPUs (fGPUs) to one of your virtual machines (VMs).
- - The fGPU is in the `attaching` state until the VM is stopped, after which it becomes `attached`.' + "/LinkFlexibleGpu": + description: |- + Attaches one of your allocated flexible GPUs (fGPUs) to one of your virtual machines (VMs).
+ The fGPU is in the `attaching` state until the VM is stopped, after which it becomes `attached`. post: operationId: LinkFlexibleGpu requestBody: content: application/json: schema: - $ref: '#/components/schemas/LinkFlexibleGpuRequest' + "$ref": "#/components/schemas/LinkFlexibleGpuRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/LinkFlexibleGpuResponse' + "$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.' + "/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: operationId: LinkInternetService requestBody: content: application/json: schema: - $ref: '#/components/schemas/LinkInternetServiceRequest' + "$ref": "#/components/schemas/LinkInternetServiceRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/LinkInternetServiceResponse' + "$ref": "#/components/schemas/LinkInternetServiceResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). 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 back-end VM.' + "/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 back-end VM. post: operationId: LinkLoadBalancerBackendMachines requestBody: content: application/json: schema: - $ref: '#/components/schemas/LinkLoadBalancerBackendMachinesRequest' + "$ref": "#/components/schemas/LinkLoadBalancerBackendMachinesRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/LinkLoadBalancerBackendMachinesResponse' + "$ref": "#/components/schemas/LinkLoadBalancerBackendMachinesResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer - /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 an FNI to an Instance](https://docs.outscale.com/en/userguide/Attaching-an-FNI-to-an-Instance.html).' + "/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 an FNI to an Instance](https://docs.outscale.com/en/userguide/Attaching-an-FNI-to-an-Instance.html). post: operationId: LinkNic requestBody: content: application/json: schema: - $ref: '#/components/schemas/LinkNicRequest' + "$ref": "#/components/schemas/LinkNicRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/LinkNicResponse' + "$ref": "#/components/schemas/LinkNicResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - Nic - /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. + "/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: operationId: LinkPrivateIps requestBody: content: application/json: schema: - $ref: '#/components/schemas/LinkPrivateIpsRequest' + "$ref": "#/components/schemas/LinkPrivateIpsRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/LinkPrivateIpsResponse' + "$ref": "#/components/schemas/LinkPrivateIpsResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). 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.
- + "/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.

- **[NOTE]**
- - 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.' + 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: operationId: LinkPublicIp requestBody: content: application/json: schema: - $ref: '#/components/schemas/LinkPublicIpRequest' + "$ref": "#/components/schemas/LinkPublicIpRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/LinkPublicIpResponse' + "$ref": "#/components/schemas/LinkPublicIpResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). 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.' + "/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: operationId: LinkRouteTable requestBody: content: application/json: schema: - $ref: '#/components/schemas/LinkRouteTableRequest' + "$ref": "#/components/schemas/LinkRouteTableRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/LinkRouteTableResponse' + "$ref": "#/components/schemas/LinkRouteTableResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - RouteTable - /LinkVirtualGateway: + "/LinkVirtualGateway": description: Attaches a virtual gateway to a Net. post: operationId: LinkVirtualGateway @@ -11935,76 +12748,76 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LinkVirtualGatewayRequest' + "$ref": "#/components/schemas/LinkVirtualGatewayRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/LinkVirtualGatewayResponse' + "$ref": "#/components/schemas/LinkVirtualGatewayResponse" 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.' + "/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: operationId: LinkVolume requestBody: content: application/json: schema: - $ref: '#/components/schemas/LinkVolumeRequest' + "$ref": "#/components/schemas/LinkVolumeRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/LinkVolumeResponse' + "$ref": "#/components/schemas/LinkVolumeResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - Volume - /ReadAccessKeys: - description: Lists the access key IDs of your account. + "/ReadAccessKeys": + description: Lists the access key IDs of either your root account or an EIM user. post: operationId: ReadAccessKeys requestBody: content: application/json: schema: - $ref: '#/components/schemas/ReadAccessKeysRequest' + "$ref": "#/components/schemas/ReadAccessKeysRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ReadAccessKeysResponse' + "$ref": "#/components/schemas/ReadAccessKeysResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] - BasicAuth: [] tags: - AccessKey - /ReadAccounts: + "/ReadAccounts": description: Gets information about the account that sent the request. post: operationId: ReadAccounts @@ -12012,60 +12825,58 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ReadAccountsRequest' + "$ref": "#/components/schemas/ReadAccountsRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ReadAccountsResponse' + "$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).
- + "/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.

- **[NOTE]**
- - The administrator password is generated only on the first boot of the Windows VM. It is not returned after the first boot.' + The administrator password is generated only on the first boot of the Windows VM. It is not returned after the first boot. post: operationId: ReadAdminPassword requestBody: content: application/json: schema: - $ref: '#/components/schemas/ReadAdminPasswordRequest' + "$ref": "#/components/schemas/ReadAdminPasswordRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ReadAdminPasswordResponse' + "$ref": "#/components/schemas/ReadAdminPasswordResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - Vm - /ReadApiAccessPolicy: + "/ReadApiAccessPolicy": description: Gets information about the API access policy of your account. post: operationId: ReadApiAccessPolicy @@ -12073,38 +12884,38 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ReadApiAccessPolicyRequest' + "$ref": "#/components/schemas/ReadApiAccessPolicyRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ReadApiAccessPolicyResponse' + "$ref": "#/components/schemas/ReadApiAccessPolicyResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). security: - ApiKeyAuthSec: [] - BasicAuth: [] tags: - ApiAccessPolicy - /ReadApiAccessRules: + "/ReadApiAccessRules": description: Lists one or more API access rules. post: operationId: ReadApiAccessRules @@ -12112,884 +12923,862 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ReadApiAccessRulesRequest' + "$ref": "#/components/schemas/ReadApiAccessRulesRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ReadApiAccessRulesResponse' + "$ref": "#/components/schemas/ReadApiAccessRulesResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] - BasicAuth: [] tags: - ApiAccessRule - /ReadApiLogs: - description: 'Lists the logs of the API calls you have performed with this account. For more information, see [About OUTSCALE Monitoring Services (OMS)](https://docs.outscale.com/en/userguide/About-OUTSCALE-Monitoring-Services-(OMS).html).

- + "/ReadApiLogs": + description: |- + Lists the logs of the API calls you have performed with this account. For more information, see [About OUTSCALE Monitoring Services (OMS)](https://docs.outscale.com/en/userguide/About-OUTSCALE-Monitoring-Services-(OMS).html).

**[NOTE]**
- 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.' + 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. post: operationId: ReadApiLogs requestBody: content: application/json: schema: - $ref: '#/components/schemas/ReadApiLogsRequest' + "$ref": "#/components/schemas/ReadApiLogsRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ReadApiLogsResponse' + "$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). + "/ReadCas": + description: Gets information about one or more of your Client Certificate Authorities + (CAs). post: operationId: ReadCas requestBody: content: application/json: schema: - $ref: '#/components/schemas/ReadCasRequest' + "$ref": "#/components/schemas/ReadCasRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ReadCasResponse' + "$ref": "#/components/schemas/ReadCasResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] - BasicAuth: [] tags: - Ca - /ReadCatalog: - description: Returns the price list of OUTSCALE products and services for the current Region. + "/ReadCatalog": + description: Returns the price list of OUTSCALE products and services for the + current Region. post: operationId: ReadCatalog requestBody: content: application/json: schema: - $ref: '#/components/schemas/ReadCatalogRequest' + "$ref": "#/components/schemas/ReadCatalogRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ReadCatalogResponse' + "$ref": "#/components/schemas/ReadCatalogResponse" description: The HTTP 200 response (OK). tags: - Catalog - /ReadCatalogs: - description: Returns the price list of OUTSCALE products and services for the current Region within a specific time period. + "/ReadCatalogs": + description: Returns the price list of OUTSCALE products and services for the + current Region within a specific time period. post: operationId: ReadCatalogs requestBody: content: application/json: schema: - $ref: '#/components/schemas/ReadCatalogsRequest' + "$ref": "#/components/schemas/ReadCatalogsRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ReadCatalogsResponse' + "$ref": "#/components/schemas/ReadCatalogsResponse" description: The HTTP 200 response (OK). tags: - Catalog - /ReadClientGateways: - description: 'Lists one or more of your client gateways.

- + "/ReadClientGateways": + description: |- + Lists one or more of your client gateways.

**[NOTE]**
- - If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned.' + If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. post: operationId: ReadClientGateways requestBody: content: application/json: schema: - $ref: '#/components/schemas/ReadClientGatewaysRequest' + "$ref": "#/components/schemas/ReadClientGatewaysRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ReadClientGatewaysResponse' + "$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 provides the most recent 64 KiB output.

- + "/ReadConsoleOutput": + description: |- + Gets the console output for a virtual machine (VM). This console provides the most recent 64 KiB output.

**[NOTE]**
- - On Windows VMs, the console is handled only on the first boot. It returns no output after the first boot.' + On Windows VMs, the console is handled only on the first boot. It returns no output after the first boot. post: operationId: ReadConsoleOutput requestBody: content: application/json: schema: - $ref: '#/components/schemas/ReadConsoleOutputRequest' + "$ref": "#/components/schemas/ReadConsoleOutputRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ReadConsoleOutputResponse' + "$ref": "#/components/schemas/ReadConsoleOutputResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - Vm - /ReadConsumptionAccount: - description: 'Gets information about the consumption of your account for each billable resource within the specified time period.

- + "/ReadConsumptionAccount": + description: |- + Gets information about the consumption of your account for each billable resource within the specified time period.

**[NOTE]**
- - If you exceed the number of identical requests allowed for a configured time period, the `Throttling` error message is returned.' + If you exceed the number of identical requests allowed for a configured time period, the `Throttling` error message is returned. post: operationId: ReadConsumptionAccount requestBody: content: application/json: schema: - $ref: '#/components/schemas/ReadConsumptionAccountRequest' + "$ref": "#/components/schemas/ReadConsumptionAccountRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ReadConsumptionAccountResponse' + "$ref": "#/components/schemas/ReadConsumptionAccountResponse" description: The HTTP 200 response (OK). tags: - Account - /ReadDhcpOptions: - description: 'Gets information about the content of one or more DHCP options sets.

- + "/ReadDhcpOptions": + description: |- + Gets information about the content of one or more DHCP options sets.

**[NOTE]**
- - If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned.' + If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. post: operationId: ReadDhcpOptions requestBody: content: application/json: schema: - $ref: '#/components/schemas/ReadDhcpOptionsRequest' + "$ref": "#/components/schemas/ReadDhcpOptionsRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ReadDhcpOptionsResponse' + "$ref": "#/components/schemas/ReadDhcpOptionsResponse" description: The HTTP 200 response (OK). tags: - DhcpOption - /ReadDirectLinkInterfaces: - description: 'Lists one or more of your DirectLink interfaces.

- + "/ReadDirectLinkInterfaces": + description: |- + Lists one or more of your DirectLink interfaces.

**[NOTE]**
- - If you exceed the number of identical requests allowed for a configured time period, the `Throttling` error message is returned.' + If you exceed the number of identical requests allowed for a configured time period, the `Throttling` error message is returned. post: operationId: ReadDirectLinkInterfaces requestBody: content: application/json: schema: - $ref: '#/components/schemas/ReadDirectLinkInterfacesRequest' + "$ref": "#/components/schemas/ReadDirectLinkInterfacesRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ReadDirectLinkInterfacesResponse' + "$ref": "#/components/schemas/ReadDirectLinkInterfacesResponse" description: The HTTP 200 response (OK). tags: - DirectLinkInterface - /ReadDirectLinks: - description: 'Lists all DirectLinks in the Region.

- + "/ReadDirectLinks": + description: |- + Lists all DirectLinks in the Region.

**[NOTE]**
- - If you exceed the number of identical requests allowed for a configured time period, the `Throttling` error message is returned.' + If you exceed the number of identical requests allowed for a configured time period, the `Throttling` error message is returned. post: operationId: ReadDirectLinks requestBody: content: application/json: schema: - $ref: '#/components/schemas/ReadDirectLinksRequest' + "$ref": "#/components/schemas/ReadDirectLinksRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ReadDirectLinksResponse' + "$ref": "#/components/schemas/ReadDirectLinksResponse" description: The HTTP 200 response (OK). tags: - DirectLink - /ReadFlexibleGpuCatalog: - description: 'Lists all flexible GPUs available in the public catalog.

- + "/ReadFlexibleGpuCatalog": + description: |- + Lists all flexible GPUs available in the public catalog.

**[NOTE]**
- - If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned.' + If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. post: operationId: ReadFlexibleGpuCatalog requestBody: content: application/json: schema: - $ref: '#/components/schemas/ReadFlexibleGpuCatalogRequest' + "$ref": "#/components/schemas/ReadFlexibleGpuCatalogRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ReadFlexibleGpuCatalogResponse' + "$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.

- + "/ReadFlexibleGpus": + description: |- + Lists one or more flexible GPUs (fGPUs) allocated to your account.

**[NOTE]**
- - If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned.' + If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. post: operationId: ReadFlexibleGpus requestBody: content: application/json: schema: - $ref: '#/components/schemas/ReadFlexibleGpusRequest' + "$ref": "#/components/schemas/ReadFlexibleGpusRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ReadFlexibleGpusResponse' + "$ref": "#/components/schemas/ReadFlexibleGpusResponse" description: The HTTP 200 response (OK). tags: - FlexibleGpu - /ReadImageExportTasks: - description: 'Lists one or more image export tasks.

- + "/ReadImageExportTasks": + description: |- + Lists one or more image export tasks.

**[NOTE]**
- - If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned.' + If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. post: operationId: ReadImageExportTasks requestBody: content: application/json: schema: - $ref: '#/components/schemas/ReadImageExportTasksRequest' + "$ref": "#/components/schemas/ReadImageExportTasksRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ReadImageExportTasksResponse' + "$ref": "#/components/schemas/ReadImageExportTasksResponse" description: The HTTP 200 response (OK). tags: - Image - /ReadImages: - description: 'Lists one or more OUTSCALE machine images (OMIs) you can use.

- + "/ReadImages": + description: |- + Lists one or more OUTSCALE machine images (OMIs) you can use.

**[NOTE]**
- - If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned.' + If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. post: operationId: ReadImages requestBody: content: application/json: schema: - $ref: '#/components/schemas/ReadImagesRequest' + "$ref": "#/components/schemas/ReadImagesRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ReadImagesResponse' + "$ref": "#/components/schemas/ReadImagesResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - Image - /ReadInternetServices: - description: 'Lists one or more of your Internet services.
- + "/ReadInternetServices": + description: |- + Lists one or more of your Internet services.
An Internet service enables your virtual machines (VMs) launched in a Net to connect to the Internet. By default, a Net includes an Internet service, and each Subnet is public. Every VM launched within a default Subnet has a private IP and a public IP.

- **[NOTE]**
- - If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned.' + If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. post: operationId: ReadInternetServices requestBody: content: application/json: schema: - $ref: '#/components/schemas/ReadInternetServicesRequest' + "$ref": "#/components/schemas/ReadInternetServicesRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ReadInternetServicesResponse' + "$ref": "#/components/schemas/ReadInternetServicesResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - InternetService - /ReadKeypairs: - description: 'Lists one or more of your keypairs.

- + "/ReadKeypairs": + description: |- + Lists one or more of your keypairs.

**[NOTE]**
- - If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned.' + If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. post: operationId: ReadKeypairs requestBody: content: application/json: schema: - $ref: '#/components/schemas/ReadKeypairsRequest' + "$ref": "#/components/schemas/ReadKeypairsRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ReadKeypairsResponse' + "$ref": "#/components/schemas/ReadKeypairsResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - Keypair - /ReadListenerRules: - description: Lists one or more listener rules. By default, this action returns the full list of listener rules for the account. + "/ReadListenerRules": + description: Lists one or more listener rules. By default, this action returns + the full list of listener rules for the account. post: operationId: ReadListenerRules requestBody: content: application/json: schema: - $ref: '#/components/schemas/ReadListenerRulesRequest' + "$ref": "#/components/schemas/ReadListenerRulesRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ReadListenerRulesResponse' + "$ref": "#/components/schemas/ReadListenerRulesResponse" description: The HTTP 200 response (OK). tags: - Listener - /ReadLoadBalancerTags: - description: 'Lists the tags associated with one or more specified load balancers.

- + "/ReadLoadBalancerTags": + description: |- + Lists the tags associated with one or more specified load balancers.

**[NOTE]**
- - If you exceed the number of identical requests allowed for a configured time period, the `Throttling` error message is returned.' + If you exceed the number of identical requests allowed for a configured time period, the `Throttling` error message is returned. post: operationId: ReadLoadBalancerTags requestBody: content: application/json: schema: - $ref: '#/components/schemas/ReadLoadBalancerTagsRequest' + "$ref": "#/components/schemas/ReadLoadBalancerTagsRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ReadLoadBalancerTagsResponse' + "$ref": "#/components/schemas/ReadLoadBalancerTagsResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer - /ReadLoadBalancers: - description: 'Lists one or more load balancers and their attributes.

- + "/ReadLoadBalancers": + description: |- + Lists one or more load balancers and their attributes.

**[NOTE]**
- - If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned.' + If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. post: operationId: ReadLoadBalancers requestBody: content: application/json: schema: - $ref: '#/components/schemas/ReadLoadBalancersRequest' + "$ref": "#/components/schemas/ReadLoadBalancersRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ReadLoadBalancersResponse' + "$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.

- + "/ReadLocations": + description: |- + Lists the locations, corresponding to datacenters, where you can set up a DirectLink.

**[NOTE]**
- - If you exceed the number of identical requests allowed for a configured time period, the `Throttling` error message is returned.' + If you exceed the number of identical requests allowed for a configured time period, the `Throttling` error message is returned. post: operationId: ReadLocations requestBody: content: application/json: schema: - $ref: '#/components/schemas/ReadLocationsRequest' + "$ref": "#/components/schemas/ReadLocationsRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ReadLocationsResponse' + "$ref": "#/components/schemas/ReadLocationsResponse" description: The HTTP 200 response (OK). security: [] tags: - Location - /ReadNatServices: - description: 'Lists one or more network address translation (NAT) services.

- + "/ReadNatServices": + description: |- + Lists one or more network address translation (NAT) services.

**[NOTE]**
- - If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned.' + If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. post: operationId: ReadNatServices requestBody: content: application/json: schema: - $ref: '#/components/schemas/ReadNatServicesRequest' + "$ref": "#/components/schemas/ReadNatServicesRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ReadNatServicesResponse' + "$ref": "#/components/schemas/ReadNatServicesResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - NatService - /ReadNetAccessPointServices: - description: 'Lists OUTSCALE services available to create Net access points.
- + "/ReadNetAccessPointServices": + description: |- + Lists OUTSCALE services available to create Net access points.
For more information, see [CreateNetAccessPoint](#createnetaccesspoint).

- **[NOTE]**
- - If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned.' + If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. post: operationId: ReadNetAccessPointServices requestBody: content: application/json: schema: - $ref: '#/components/schemas/ReadNetAccessPointServicesRequest' + "$ref": "#/components/schemas/ReadNetAccessPointServicesRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ReadNetAccessPointServicesResponse' + "$ref": "#/components/schemas/ReadNetAccessPointServicesResponse" description: The HTTP 200 response (OK). security: [] tags: - NetAccessPoint - /ReadNetAccessPoints: - description: 'Lists one or more Net access points.

- + "/ReadNetAccessPoints": + description: |- + Lists one or more Net access points.

**[NOTE]**
- - If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned.' + If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. post: operationId: ReadNetAccessPoints requestBody: content: application/json: schema: - $ref: '#/components/schemas/ReadNetAccessPointsRequest' + "$ref": "#/components/schemas/ReadNetAccessPointsRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ReadNetAccessPointsResponse' + "$ref": "#/components/schemas/ReadNetAccessPointsResponse" description: The HTTP 200 response (OK). tags: - NetAccessPoint - /ReadNetPeerings: - description: 'Lists one or more peering connections between two Nets.

- + "/ReadNetPeerings": + description: |- + Lists one or more peering connections between two Nets.

**[NOTE]**
- - If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned.' + If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. post: operationId: ReadNetPeerings requestBody: content: application/json: schema: - $ref: '#/components/schemas/ReadNetPeeringsRequest' + "$ref": "#/components/schemas/ReadNetPeeringsRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ReadNetPeeringsResponse' + "$ref": "#/components/schemas/ReadNetPeeringsResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - NetPeering - /ReadNets: - description: 'Lists one or more Nets.

- + "/ReadNets": + description: |- + Lists one or more Nets.

**[NOTE]**
- - If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned.' + If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. post: operationId: ReadNets requestBody: content: application/json: schema: - $ref: '#/components/schemas/ReadNetsRequest' + "$ref": "#/components/schemas/ReadNetsRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ReadNetsResponse' + "$ref": "#/components/schemas/ReadNetsResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - Net - /ReadNics: - description: 'Lists one or more network interface cards (NICs).
- + "/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.

- **[NOTE]**
- - If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned.' + If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. post: operationId: ReadNics requestBody: content: application/json: schema: - $ref: '#/components/schemas/ReadNicsRequest' + "$ref": "#/components/schemas/ReadNicsRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ReadNicsResponse' + "$ref": "#/components/schemas/ReadNicsResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - Nic - /ReadProductTypes: - description: 'Lists one or more product types.

- + "/ReadProductTypes": + description: |- + Lists one or more product types.

**[NOTE]**
- - If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned.' + If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. post: operationId: ReadProductTypes requestBody: content: application/json: schema: - $ref: '#/components/schemas/ReadProductTypesRequest' + "$ref": "#/components/schemas/ReadProductTypesRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ReadProductTypesResponse' + "$ref": "#/components/schemas/ReadProductTypesResponse" 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 [Regions, Endpoints and Availability Zones Reference](https://docs.outscale.com/en/userguide/Regions-Endpoints-and-Availability-Zones-Reference.html). + "/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 [Regions, + Endpoints and Availability Zones Reference](https://docs.outscale.com/en/userguide/Regions-Endpoints-and-Availability-Zones-Reference.html). post: operationId: ReadPublicCatalog requestBody: content: application/json: schema: - $ref: '#/components/schemas/ReadPublicCatalogRequest' + "$ref": "#/components/schemas/ReadPublicCatalogRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ReadPublicCatalogResponse' + "$ref": "#/components/schemas/ReadPublicCatalogResponse" 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 [Regions, Endpoints and Availability Zones Reference](https://docs.outscale.com/en/userguide/Regions-Endpoints-and-Availability-Zones-Reference.html). + "/ReadPublicIpRanges": + description: Gets the public IPv4 addresses in CIDR notation for the Region specified + in the endpoint of the request. For more information, see [Regions, Endpoints + and Availability Zones Reference](https://docs.outscale.com/en/userguide/Regions-Endpoints-and-Availability-Zones-Reference.html). post: operationId: ReadPublicIpRanges requestBody: content: application/json: schema: - $ref: '#/components/schemas/ReadPublicIpRangesRequest' + "$ref": "#/components/schemas/ReadPublicIpRangesRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ReadPublicIpRangesResponse' + "$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.
- + "/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.

- **[NOTE]**
- - If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned.' + If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. post: operationId: ReadPublicIps requestBody: content: application/json: schema: - $ref: '#/components/schemas/ReadPublicIpsRequest' + "$ref": "#/components/schemas/ReadPublicIpsRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ReadPublicIpsResponse' + "$ref": "#/components/schemas/ReadPublicIpsResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - PublicIp - /ReadQuotas: - description: 'Lists one or more of your quotas.

- + "/ReadQuotas": + description: |- + Lists one or more of your quotas.

**[NOTE]**
- - If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned.' + If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. post: operationId: ReadQuotas requestBody: content: application/json: schema: - $ref: '#/components/schemas/ReadQuotasRequest' + "$ref": "#/components/schemas/ReadQuotasRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ReadQuotasResponse' + "$ref": "#/components/schemas/ReadQuotasResponse" description: The HTTP 200 response (OK). tags: - Quota - /ReadRegions: + "/ReadRegions": description: Lists one or more Regions of the OUTSCALE Cloud. post: operationId: ReadRegions @@ -12997,125 +13786,122 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ReadRegionsRequest' + "$ref": "#/components/schemas/ReadRegionsRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ReadRegionsResponse' + "$ref": "#/components/schemas/ReadRegionsResponse" description: The HTTP 200 response (OK). security: [] tags: - Region - /ReadRouteTables: - description: 'Lists one or more of your route tables.
- + "/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.

- **[NOTE]**
- - If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned.' + If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. post: operationId: ReadRouteTables requestBody: content: application/json: schema: - $ref: '#/components/schemas/ReadRouteTablesRequest' + "$ref": "#/components/schemas/ReadRouteTablesRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ReadRouteTablesResponse' + "$ref": "#/components/schemas/ReadRouteTablesResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - RouteTable - /ReadSecretAccessKey: - description: Lists information about the specified access key of your account, including its secret key. + "/ReadSecretAccessKey": + description: Lists information about the specified access key of your root account, + including its secret key. post: operationId: ReadSecretAccessKey requestBody: content: application/json: schema: - $ref: '#/components/schemas/ReadSecretAccessKeyRequest' + "$ref": "#/components/schemas/ReadSecretAccessKeyRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ReadSecretAccessKeyResponse' + "$ref": "#/components/schemas/ReadSecretAccessKeyResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] - BasicAuth: [] tags: - AccessKey - /ReadSecurityGroups: - description: 'Lists one or more security groups.
- + "/ReadSecurityGroups": + description: |- + Lists one or more security groups.
You can specify either the name of the security groups or their IDs.

- **[NOTE]**
- - If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned.' + If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. post: operationId: ReadSecurityGroups requestBody: content: application/json: schema: - $ref: '#/components/schemas/ReadSecurityGroupsRequest' + "$ref": "#/components/schemas/ReadSecurityGroupsRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ReadSecurityGroupsResponse' + "$ref": "#/components/schemas/ReadSecurityGroupsResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - SecurityGroup - /ReadServerCertificates: + "/ReadServerCertificates": description: Lists your server certificates. post: operationId: ReadServerCertificates @@ -13123,1101 +13909,1094 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ReadServerCertificatesRequest' + "$ref": "#/components/schemas/ReadServerCertificatesRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ReadServerCertificatesResponse' + "$ref": "#/components/schemas/ReadServerCertificatesResponse" description: The HTTP 200 response (OK). tags: - ServerCertificate - /ReadSnapshotExportTasks: - description: 'Lists one or more snapshot export tasks.

- + "/ReadSnapshotExportTasks": + description: |- + Lists one or more snapshot export tasks.

**[NOTE]**
- - If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned.' + If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. post: operationId: ReadSnapshotExportTasks requestBody: content: application/json: schema: - $ref: '#/components/schemas/ReadSnapshotExportTasksRequest' + "$ref": "#/components/schemas/ReadSnapshotExportTasksRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ReadSnapshotExportTasksResponse' + "$ref": "#/components/schemas/ReadSnapshotExportTasksResponse" 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.

- + "/ReadSnapshots": + description: |- + Lists one or more snapshots that are available to you and the permissions to create volumes from them.

**[NOTE]**
- - If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned.' + If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. post: operationId: ReadSnapshots requestBody: content: application/json: schema: - $ref: '#/components/schemas/ReadSnapshotsRequest' + "$ref": "#/components/schemas/ReadSnapshotsRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ReadSnapshotsResponse' + "$ref": "#/components/schemas/ReadSnapshotsResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - Snapshot - /ReadSubnets: - description: 'Lists one or more of your Subnets.
- + "/ReadSubnets": + description: |- + Lists one or more of your Subnets.
If you do not specify any Subnet ID, this action describes all of your Subnets.

- **[NOTE]**
- - If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned.' + If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. post: operationId: ReadSubnets requestBody: content: application/json: schema: - $ref: '#/components/schemas/ReadSubnetsRequest' + "$ref": "#/components/schemas/ReadSubnetsRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ReadSubnetsResponse' + "$ref": "#/components/schemas/ReadSubnetsResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - Subnet - /ReadSubregions: - description: 'Lists one or more of the enabled Subregions that you can access in the current Region.

- + "/ReadSubregions": + description: |- + Lists one or more of the enabled Subregions that you can access in the current Region.

**[NOTE]**
- - If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned.
- - - You can use this command to get information about Subregions only in a Region for which you have an account. Otherwise, the `AuthFailure` error message is returned.' + - You can use this command to get information about Subregions only in a Region for which you have an account. Otherwise, the `AuthFailure` error message is returned. post: operationId: ReadSubregions requestBody: content: application/json: schema: - $ref: '#/components/schemas/ReadSubregionsRequest' + "$ref": "#/components/schemas/ReadSubregionsRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ReadSubregionsResponse' + "$ref": "#/components/schemas/ReadSubregionsResponse" description: The HTTP 200 response (OK). tags: - Subregion - /ReadTags: - description: 'Lists one or more tags for your resources.

- + "/ReadTags": + description: |- + Lists one or more tags for your resources.

**[NOTE]**
- - If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned.' + If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. post: operationId: ReadTags requestBody: content: application/json: schema: - $ref: '#/components/schemas/ReadTagsRequest' + "$ref": "#/components/schemas/ReadTagsRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ReadTagsResponse' + "$ref": "#/components/schemas/ReadTagsResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - Tag - /ReadVirtualGateways: - description: 'Lists one or more virtual gateways.

- + "/ReadUsers": + description: Lists all EIM users that have a specified path.
+ post: + operationId: ReadUsers + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/ReadUsersRequest" + responses: + '200': + content: + application/json: + schema: + "$ref": "#/components/schemas/ReadUsersResponse" + description: The HTTP 200 response (OK). + tags: + - User + "/ReadVirtualGateways": + description: |- + Lists one or more virtual gateways.

**[NOTE]**
- - If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned.' + If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. post: operationId: ReadVirtualGateways requestBody: content: application/json: schema: - $ref: '#/components/schemas/ReadVirtualGatewaysRequest' + "$ref": "#/components/schemas/ReadVirtualGatewaysRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ReadVirtualGatewaysResponse' + "$ref": "#/components/schemas/ReadVirtualGatewaysResponse" description: The HTTP 200 response (OK). tags: - VirtualGateway - /ReadVmGroups: - description: '> [WARNING]
- + "/ReadVmGroups": + description: |- + > [WARNING]
> This feature is currently under development and may not function properly.
- - Lists one or more group of virtual machines (VMs).' + Lists one or more group of virtual machines (VMs). post: operationId: ReadVmGroups requestBody: content: application/json: schema: - $ref: '#/components/schemas/ReadVmGroupsRequest' + "$ref": "#/components/schemas/ReadVmGroupsRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ReadVmGroupsResponse' + "$ref": "#/components/schemas/ReadVmGroupsResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - VmGroup - /ReadVmTemplates: - description: '> [WARNING]
- + "/ReadVmTemplates": + description: |- + > [WARNING]
> This feature is currently under development and may not function properly.
- - Lists one or more virtual machine (VM) templates.' + Lists one or more virtual machine (VM) templates. post: operationId: ReadVmTemplates requestBody: content: application/json: schema: - $ref: '#/components/schemas/ReadVmTemplatesRequest' + "$ref": "#/components/schemas/ReadVmTemplatesRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ReadVmTemplatesResponse' + "$ref": "#/components/schemas/ReadVmTemplatesResponse" description: The HTTP 200 response (OK). tags: - VmTemplate - /ReadVmTypes: - description: 'Lists one or more predefined VM types.

- + "/ReadVmTypes": + description: |- + Lists one or more predefined VM types.

**[NOTE]**
- - If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned.' + If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. post: operationId: ReadVmTypes requestBody: content: application/json: schema: - $ref: '#/components/schemas/ReadVmTypesRequest' + "$ref": "#/components/schemas/ReadVmTypesRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ReadVmTypesResponse' + "$ref": "#/components/schemas/ReadVmTypesResponse" description: The HTTP 200 response (OK). security: [] tags: - Vm - /ReadVms: - description: 'Lists one or more of your virtual machines (VMs).
- + "/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.

- **[NOTE]**
- - If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned.' + If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. post: operationId: ReadVms requestBody: content: application/json: schema: - $ref: '#/components/schemas/ReadVmsRequest' + "$ref": "#/components/schemas/ReadVmsRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ReadVmsResponse' + "$ref": "#/components/schemas/ReadVmsResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - Vm - /ReadVmsHealth: - description: 'Lists the state of one or more back-end virtual machines (VMs) registered with a specified load balancer.

- + "/ReadVmsHealth": + description: |- + Lists the state of one or more back-end virtual machines (VMs) registered with a specified load balancer.

**[NOTE]**
- - If you exceed the number of identical requests allowed for a configured time period, the `Throttling` error message is returned.' + If you exceed the number of identical requests allowed for a configured time period, the `Throttling` error message is returned. post: operationId: ReadVmsHealth requestBody: content: application/json: schema: - $ref: '#/components/schemas/ReadVmsHealthRequest' + "$ref": "#/components/schemas/ReadVmsHealthRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ReadVmsHealthResponse' + "$ref": "#/components/schemas/ReadVmsHealthResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer - /ReadVmsState: - description: 'Lists the status of one or more virtual machines (VMs).

- + "/ReadVmsState": + description: |- + Lists the status of one or more virtual machines (VMs).

**[NOTE]**
- - If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned.' + If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. post: operationId: ReadVmsState requestBody: content: application/json: schema: - $ref: '#/components/schemas/ReadVmsStateRequest' + "$ref": "#/components/schemas/ReadVmsStateRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ReadVmsStateResponse' + "$ref": "#/components/schemas/ReadVmsStateResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - Vm - /ReadVolumes: - description: 'Lists one or more specified Block Storage Unit (BSU) volumes.

- + "/ReadVolumes": + description: |- + Lists one or more specified Block Storage Unit (BSU) volumes.

**[NOTE]**
- - If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned.' + If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. post: operationId: ReadVolumes requestBody: content: application/json: schema: - $ref: '#/components/schemas/ReadVolumesRequest' + "$ref": "#/components/schemas/ReadVolumesRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ReadVolumesResponse' + "$ref": "#/components/schemas/ReadVolumesResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - Volume - /ReadVpnConnections: - description: 'Lists one or more VPN connections.

- + "/ReadVpnConnections": + description: |- + Lists one or more VPN connections.

**[NOTE]**
- - If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned.' + If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. post: operationId: ReadVpnConnections requestBody: content: application/json: schema: - $ref: '#/components/schemas/ReadVpnConnectionsRequest' + "$ref": "#/components/schemas/ReadVpnConnectionsRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ReadVpnConnectionsResponse' + "$ref": "#/components/schemas/ReadVpnConnectionsResponse" 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.' + "/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: operationId: RebootVms requestBody: content: application/json: schema: - $ref: '#/components/schemas/RebootVmsRequest' + "$ref": "#/components/schemas/RebootVmsRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RebootVmsResponse' + "$ref": "#/components/schemas/RebootVmsResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - Vm - /RegisterVmsInLoadBalancer: - description: '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 back-end VM.' + "/RegisterVmsInLoadBalancer": + description: |- + 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 back-end VM. post: operationId: RegisterVmsInLoadBalancer requestBody: content: application/json: schema: - $ref: '#/components/schemas/RegisterVmsInLoadBalancerRequest' + "$ref": "#/components/schemas/RegisterVmsInLoadBalancerRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RegisterVmsInLoadBalancerResponse' + "$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.' + "/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: operationId: RejectNetPeering requestBody: content: application/json: schema: - $ref: '#/components/schemas/RejectNetPeeringRequest' + "$ref": "#/components/schemas/RejectNetPeeringRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RejectNetPeeringResponse' + "$ref": "#/components/schemas/RejectNetPeeringResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '409': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 409 response (Conflict). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - NetPeering - /ResetAccountPassword: - description: 'Replaces the account password with the new one you provide.
- + "/ResetAccountPassword": + description: |- + Replaces the account password with the new one you provide.
You must also provide the token you received by email when asking for a password reset using the SendResetPasswordEmail method.

- Password strength is tested through heuristic algorithms. For more information, see the [zxcvbn GitHub](https://github.com/dropbox/zxcvbn).

- **[NOTE]**
- - To protect against brute force attacks, the number of requests allowed for this method in a given time period is limited.' + To protect against brute force attacks, the number of requests allowed for this method in a given time period is limited. post: operationId: ResetAccountPassword requestBody: content: application/json: schema: - $ref: '#/components/schemas/ResetAccountPasswordRequest' + "$ref": "#/components/schemas/ResetAccountPasswordRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ResetAccountPasswordResponse' + "$ref": "#/components/schemas/ResetAccountPasswordResponse" description: The HTTP 200 response (OK). security: [] tags: - Account - /ScaleDownVmGroup: - description: '> [WARNING]
- + "/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.' + The oldest VMs are the first to be deleted. post: operationId: ScaleDownVmGroup requestBody: content: application/json: schema: - $ref: '#/components/schemas/ScaleDownVmGroupRequest' + "$ref": "#/components/schemas/ScaleDownVmGroupRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ScaleDownVmGroupResponse' + "$ref": "#/components/schemas/ScaleDownVmGroupResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - VmGroup - /ScaleUpVmGroup: - description: '> [WARNING]
- + "/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.' + The new VMs use the current version of the VM template. post: operationId: ScaleUpVmGroup requestBody: content: application/json: schema: - $ref: '#/components/schemas/ScaleUpVmGroupRequest' + "$ref": "#/components/schemas/ScaleUpVmGroupRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ScaleUpVmGroupResponse' + "$ref": "#/components/schemas/ScaleUpVmGroupResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - VmGroup - /SendResetPasswordEmail: - description: 'Sends an email to the email address provided for the account with a token to reset your password.
- + "/SendResetPasswordEmail": + description: |- + Sends an email to the email address provided for the account with a token to reset your password.
You need to provide this token when updating the account password using the ResetAccountPassword method.

- **[NOTE]**
- - To protect against brute force attacks, the number of requests allowed for this method in a given time period is limited.' + To protect against brute force attacks, the number of requests allowed for this method in a given time period is limited. post: operationId: SendResetPasswordEmail requestBody: content: application/json: schema: - $ref: '#/components/schemas/SendResetPasswordEmailRequest' + "$ref": "#/components/schemas/SendResetPasswordEmailRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/SendResetPasswordEmailResponse' + "$ref": "#/components/schemas/SendResetPasswordEmailResponse" description: The HTTP 200 response (OK). security: [] tags: - Account - /StartVms: - description: 'Start one or more virtual machines (VMs).
- - You can start only VMs that are valid and that belong to you.' + "/StartVms": + description: |- + Start one or more virtual machines (VMs).
+ You can start only VMs that are valid and that belong to you. post: operationId: StartVms requestBody: content: application/json: schema: - $ref: '#/components/schemas/StartVmsRequest' + "$ref": "#/components/schemas/StartVmsRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/StartVmsResponse' + "$ref": "#/components/schemas/StartVmsResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). 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.' + "/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: operationId: StopVms requestBody: content: application/json: schema: - $ref: '#/components/schemas/StopVmsRequest' + "$ref": "#/components/schemas/StopVmsRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/StopVmsResponse' + "$ref": "#/components/schemas/StopVmsResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). 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 available for allocation again.' + "/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 available for allocation again. post: operationId: UnlinkFlexibleGpu requestBody: content: application/json: schema: - $ref: '#/components/schemas/UnlinkFlexibleGpuRequest' + "$ref": "#/components/schemas/UnlinkFlexibleGpuRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/UnlinkFlexibleGpuResponse' + "$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.' + "/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: operationId: UnlinkInternetService requestBody: content: application/json: schema: - $ref: '#/components/schemas/UnlinkInternetServiceRequest' + "$ref": "#/components/schemas/UnlinkInternetServiceRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/UnlinkInternetServiceResponse' + "$ref": "#/components/schemas/UnlinkInternetServiceResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - InternetService - /UnlinkLoadBalancerBackendMachines: - description: Detaches one or more back-end virtual machines (VMs) from a load balancer. You need to specify at least the `BackendIps` or the `BackendVmIds` parameter. + "/UnlinkLoadBalancerBackendMachines": + description: Detaches one or more back-end virtual machines (VMs) from a load + balancer. You need to specify at least the `BackendIps` or the `BackendVmIds` + parameter. post: operationId: UnlinkLoadBalancerBackendMachines requestBody: content: application/json: schema: - $ref: '#/components/schemas/UnlinkLoadBalancerBackendMachinesRequest' + "$ref": "#/components/schemas/UnlinkLoadBalancerBackendMachinesRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/UnlinkLoadBalancerBackendMachinesResponse' + "$ref": "#/components/schemas/UnlinkLoadBalancerBackendMachinesResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer - /UnlinkNic: - description: 'Detaches a network interface card (NIC) from a virtual machine (VM).
- - The primary NIC cannot be detached.' + "/UnlinkNic": + description: |- + Detaches a network interface card (NIC) from a virtual machine (VM).
+ The primary NIC cannot be detached. post: operationId: UnlinkNic requestBody: content: application/json: schema: - $ref: '#/components/schemas/UnlinkNicRequest' + "$ref": "#/components/schemas/UnlinkNicRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/UnlinkNicResponse' + "$ref": "#/components/schemas/UnlinkNicResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - Nic - /UnlinkPrivateIps: - description: Unassigns one or more secondary private IPs from a network interface card (NIC). + "/UnlinkPrivateIps": + description: Unassigns one or more secondary private IPs from a network interface + card (NIC). post: operationId: UnlinkPrivateIps requestBody: content: application/json: schema: - $ref: '#/components/schemas/UnlinkPrivateIpsRequest' + "$ref": "#/components/schemas/UnlinkPrivateIpsRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/UnlinkPrivateIpsResponse' + "$ref": "#/components/schemas/UnlinkPrivateIpsResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - Nic - /UnlinkPublicIp: - description: 'Disassociates a public IP from the virtual machine (VM) or network interface card (NIC) it is associated with.

- + "/UnlinkPublicIp": + description: |- + Disassociates a public IP from the virtual machine (VM) or network interface card (NIC) it is associated with.

**[NOTE]**
- - To disassociate the public IP from a NAT service, you need to delete the NAT service. For more information, see the [DeleteNatService](#deletenatservice) method.' + 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: operationId: UnlinkPublicIp requestBody: content: application/json: schema: - $ref: '#/components/schemas/UnlinkPublicIpRequest' + "$ref": "#/components/schemas/UnlinkPublicIpRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/UnlinkPublicIpResponse' + "$ref": "#/components/schemas/UnlinkPublicIpResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). 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.' + "/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: operationId: UnlinkRouteTable requestBody: content: application/json: schema: - $ref: '#/components/schemas/UnlinkRouteTableRequest' + "$ref": "#/components/schemas/UnlinkRouteTableRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/UnlinkRouteTableResponse' + "$ref": "#/components/schemas/UnlinkRouteTableResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). 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.' + "/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: operationId: UnlinkVirtualGateway requestBody: content: application/json: schema: - $ref: '#/components/schemas/UnlinkVirtualGatewayRequest' + "$ref": "#/components/schemas/UnlinkVirtualGatewayRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/UnlinkVirtualGatewayResponse' + "$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.' + "/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: operationId: UnlinkVolume requestBody: content: application/json: schema: - $ref: '#/components/schemas/UnlinkVolumeRequest' + "$ref": "#/components/schemas/UnlinkVolumeRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/UnlinkVolumeResponse' + "$ref": "#/components/schemas/UnlinkVolumeResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - Volume - /UpdateAccessKey: - description: 'Modifies the attributes of the specified access key of your account.

- + "/UpdateAccessKey": + description: |- + Modifies the attributes of the specified access key of either your root account or an EIM user.

**[NOTE]**
- - To protect against brute force attacks, the number of requests allowed for this method in a given time period is limited.' + To protect against brute force attacks, the number of requests allowed for this method in a given time period is limited. post: operationId: UpdateAccessKey requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateAccessKeyRequest' + "$ref": "#/components/schemas/UpdateAccessKeyRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/UpdateAccessKeyResponse' + "$ref": "#/components/schemas/UpdateAccessKeyResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] - BasicAuth: [] tags: - AccessKey - /UpdateAccount: + "/UpdateAccount": description: Updates the account information for the account that sends the request. post: operationId: UpdateAccount @@ -14225,103 +15004,108 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UpdateAccountRequest' + "$ref": "#/components/schemas/UpdateAccountRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/UpdateAccountResponse' + "$ref": "#/components/schemas/UpdateAccountResponse" description: The HTTP 200 response (OK). tags: - Account - /UpdateApiAccessPolicy: - description: 'Updates the API access policy of your account.

- + "/UpdateApiAccessPolicy": + description: |- + Updates the API access policy of your account.

**[NOTE]**
- - Only one API access policy can be associated with your account.' + Only one API access policy can be associated with your account. post: operationId: UpdateApiAccessPolicy requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateApiAccessPolicyRequest' + "$ref": "#/components/schemas/UpdateApiAccessPolicyRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/UpdateApiAccessPolicyResponse' + "$ref": "#/components/schemas/UpdateApiAccessPolicyResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). security: - ApiKeyAuthSec: [] - BasicAuth: [] tags: - ApiAccessPolicy - /UpdateApiAccessRule: - description: "Modifies a specified API access rule.

\n\n**[NOTE]**
\n- The new rule you specify fully replaces the old rule. Therefore, for a parameter that is not specified, any previously set value is deleted.
\n- 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)." + "/UpdateApiAccessRule": + description: "Modifies a specified API access rule.

\n\n**[NOTE]**
\n- The new rule you specify fully replaces the old rule. Therefore, for + a parameter that is not specified, any previously set value is deleted.
\n- + 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: operationId: UpdateApiAccessRule requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateApiAccessRuleRequest' + "$ref": "#/components/schemas/UpdateApiAccessRuleRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/UpdateApiAccessRuleResponse' + "$ref": "#/components/schemas/UpdateApiAccessRuleResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] - BasicAuth: [] tags: - ApiAccessRule - /UpdateCa: - description: Modifies the specified attribute of a Client Certificate Authority (CA). + "/UpdateCa": + description: Modifies the specified attribute of a Client Certificate Authority + (CA). post: operationId: UpdateCa requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateCaRequest' + "$ref": "#/components/schemas/UpdateCaRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/UpdateCaResponse' + "$ref": "#/components/schemas/UpdateCaResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] - BasicAuth: [] tags: - Ca - /UpdateDirectLinkInterface: + "/UpdateDirectLinkInterface": description: Modifies the maximum transmission unit (MTU) of a DirectLink interface. post: operationId: UpdateDirectLinkInterface @@ -14329,17 +15113,17 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UpdateDirectLinkInterfaceRequest' + "$ref": "#/components/schemas/UpdateDirectLinkInterfaceRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/UpdateDirectLinkInterfaceResponse' + "$ref": "#/components/schemas/UpdateDirectLinkInterfaceResponse" description: The HTTP 200 response (OK). tags: - DirectLinkInterface - /UpdateFlexibleGpu: + "/UpdateFlexibleGpu": description: Modifies a flexible GPU (fGPU) behavior. post: operationId: UpdateFlexibleGpu @@ -14347,105 +15131,101 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UpdateFlexibleGpuRequest' + "$ref": "#/components/schemas/UpdateFlexibleGpuRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/UpdateFlexibleGpuResponse' + "$ref": "#/components/schemas/UpdateFlexibleGpuResponse" description: The HTTP 200 response (OK). tags: - FlexibleGpu - /UpdateImage: - description: 'Modifies the access permissions for an OUTSCALE machine image (OMI).
- + "/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).' + 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: operationId: UpdateImage requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateImageRequest' + "$ref": "#/components/schemas/UpdateImageRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/UpdateImageResponse' + "$ref": "#/components/schemas/UpdateImageResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - Image - /UpdateListenerRule: - description: 'Updates the pattern of the listener rule.
- - This call updates the pattern matching algorithm for incoming traffic.' + "/UpdateListenerRule": + description: |- + Updates the pattern of the listener rule.
+ This call updates the pattern matching algorithm for incoming traffic. post: operationId: UpdateListenerRule requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateListenerRuleRequest' + "$ref": "#/components/schemas/UpdateListenerRuleRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/UpdateListenerRuleResponse' + "$ref": "#/components/schemas/UpdateListenerRuleResponse" 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.

- + "/UpdateLoadBalancer": + 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 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.' + If the `PolicyNames` parameter is empty, the currently enabled policy is disabled. post: operationId: UpdateLoadBalancer requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateLoadBalancerRequest' + "$ref": "#/components/schemas/UpdateLoadBalancerRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/UpdateLoadBalancerResponse' + "$ref": "#/components/schemas/UpdateLoadBalancerResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer - /UpdateNet: + "/UpdateNet": description: Associates a DHCP options set with a specified Net. post: operationId: UpdateNet @@ -14453,163 +15233,158 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UpdateNetRequest' + "$ref": "#/components/schemas/UpdateNetRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/UpdateNetResponse' + "$ref": "#/components/schemas/UpdateNetResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). 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.' + "/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: operationId: UpdateNetAccessPoint requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateNetAccessPointRequest' + "$ref": "#/components/schemas/UpdateNetAccessPointRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/UpdateNetAccessPointResponse' + "$ref": "#/components/schemas/UpdateNetAccessPointResponse" 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. + "/UpdateNic": + description: Modifies the specified network interface card (NIC). You can specify + only one attribute at a time. post: operationId: UpdateNic requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateNicRequest' + "$ref": "#/components/schemas/UpdateNicRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/UpdateNicResponse' + "$ref": "#/components/schemas/UpdateNicResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - Nic - /UpdateRoute: - description: 'Replaces an existing route within a route table in a Net.
- + "/UpdateRoute": + 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)

- - The routing algorithm is based on the most specific match.' + The routing algorithm is based on the most specific match. post: operationId: UpdateRoute requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateRouteRequest' + "$ref": "#/components/schemas/UpdateRouteRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/UpdateRouteResponse' + "$ref": "#/components/schemas/UpdateRouteResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - Route - /UpdateRoutePropagation: - description: Configures the propagation of routes to a specified route table of a Net by a virtual gateway. + "/UpdateRoutePropagation": + description: Configures the propagation of routes to a specified route table of + a Net by a virtual gateway. post: operationId: UpdateRoutePropagation requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateRoutePropagationRequest' + "$ref": "#/components/schemas/UpdateRoutePropagationRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/UpdateRoutePropagationResponse' + "$ref": "#/components/schemas/UpdateRoutePropagationResponse" description: The HTTP 200 response (OK). tags: - VirtualGateway - /UpdateServerCertificate: + "/UpdateServerCertificate": description: Modifies the name and/or the path of a specified server certificate. post: operationId: UpdateServerCertificate @@ -14617,57 +15392,56 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UpdateServerCertificateRequest' + "$ref": "#/components/schemas/UpdateServerCertificateRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/UpdateServerCertificateResponse' + "$ref": "#/components/schemas/UpdateServerCertificateResponse" description: The HTTP 200 response (OK). tags: - ServerCertificate - /UpdateSnapshot: - description: 'Modifies the permissions for a specified snapshot.
- + "/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).' + 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: operationId: UpdateSnapshot requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateSnapshotRequest' + "$ref": "#/components/schemas/UpdateSnapshotRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/UpdateSnapshotResponse' + "$ref": "#/components/schemas/UpdateSnapshotResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - Snapshot - /UpdateSubnet: + "/UpdateSubnet": description: Modifies the specified attribute of a Subnet. post: operationId: UpdateSubnet @@ -14675,188 +15449,198 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UpdateSubnetRequest' + "$ref": "#/components/schemas/UpdateSubnetRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/UpdateSubnetResponse' + "$ref": "#/components/schemas/UpdateSubnetResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - Subnet - /UpdateVm: - description: 'Modifies the specified attributes of a virtual machine (VM).
- + "/UpdateUser": + description: Modifies the name and/or the path of a specified EIM user. + post: + operationId: UpdateUser + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/UpdateUserRequest" + responses: + '200': + content: + application/json: + schema: + "$ref": "#/components/schemas/UpdateUserResponse" + description: The HTTP 200 response (OK). + tags: + - User + "/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`' + * `VmType` post: operationId: UpdateVm requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateVmRequest' + "$ref": "#/components/schemas/UpdateVmRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/UpdateVmResponse' + "$ref": "#/components/schemas/UpdateVmResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - Vm - /UpdateVmGroup: - description: '> [WARNING]
- + "/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).' + Modifies the specified attributes of a group of virtual machines (VMs). post: operationId: UpdateVmGroup requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateVmGroupRequest' + "$ref": "#/components/schemas/UpdateVmGroupRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/UpdateVmGroupResponse' + "$ref": "#/components/schemas/UpdateVmGroupResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - VmGroup - /UpdateVmTemplate: - description: '> [WARNING]
- + "/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).' + Modifies the specified attributes of a template of virtual machines (VMs). post: operationId: UpdateVmTemplate requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateVmTemplateRequest' + "$ref": "#/components/schemas/UpdateVmTemplateRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/UpdateVmTemplateResponse' + "$ref": "#/components/schemas/UpdateVmTemplateResponse" description: The HTTP 200 response (OK). tags: - VmTemplate - /UpdateVolume: - description: 'Modifies the specified attributes of a volume.
- + "/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.' + 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: operationId: UpdateVolume requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateVolumeRequest' + "$ref": "#/components/schemas/UpdateVolumeRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/UpdateVolumeResponse' + "$ref": "#/components/schemas/UpdateVolumeResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - Volume - /UpdateVpnConnection: + "/UpdateVpnConnection": description: Modifies the specified attributes of a VPN connection. post: operationId: UpdateVpnConnection @@ -14864,31 +15648,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UpdateVpnConnectionRequest' + "$ref": "#/components/schemas/UpdateVpnConnectionRequest" responses: '200': content: application/json: schema: - $ref: '#/components/schemas/UpdateVpnConnectionResponse' + "$ref": "#/components/schemas/UpdateVpnConnectionResponse" description: The HTTP 200 response (OK). '400': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + "$ref": "#/components/schemas/ErrorResponse" description: The HTTP 500 response (Internal Server Error). tags: - VpnConnection diff --git a/outscale-java.yaml b/outscale-java.yaml index ea843b6..9029ef5 100644 --- a/outscale-java.yaml +++ b/outscale-java.yaml @@ -177,10 +177,9 @@ components: format: int64 type: integer RequireTrustedEnv: - description: If true, a trusted session is activated, allowing you to bypass - Certificate Authorities (CAs) enforcement. For more information, see the - `ApiKeyAuth` authentication scheme in the [Authentication](#authentication) - section. + description: |- + If true, a trusted session is activated, allowing you to bypass Certificate Authorities (CAs) enforcement. For more information, see [About Your API Access Policy](https://docs.outscale.com/en/userguide/About-Your-API-Access-Policy.html).
+ If this is enabled, it is required that you and all your users log in to Cockpit v2 using the WebAuthn method for multi-factor authentication. For more information, see [About Authentication > Multi-Factor Authentication](https://docs.outscale.com/en/userguide/About-Authentication.html#_multi_factor_authentication). type: boolean type: object ApiAccessRule: @@ -529,6 +528,12 @@ components: description: The ID of the TINA account which is billed for your consumption. It can be different from your account in the `AccountId` parameter. type: string + Price: + description: The total price of the consumed resource during the specified + time period, in the currency of the catalog of the Region where the API + method was used. + format: double + type: number Service: description: The service of the API call (`TinaOS-FCU`, `TinaOS-LBU`, `TinaOS-DirectLink`, `TinaOS-OOS`, or `TinaOS-OSU`). @@ -546,6 +551,11 @@ components: Type: description: The type of resource, depending on the API call. type: string + UnitPrice: + description: The unit price of the consumed resource, in the currency of + the catalog of the Region where the API method was used. + format: double + type: number Value: description: The consumed amount for the resource. The unit depends on the resource type. For more information, see the `Title` element. @@ -719,9 +729,9 @@ components: additionalProperties: false properties: BgpAsn: - description: The Autonomous System Number (ASN) used by the Border Gateway - Protocol (BGP) to find the path to your client gateway through the Internet. - This number must be between `1` and `4294967295`. + description: |- + The Autonomous System Number (ASN) used by the Border Gateway Protocol (BGP) to find the path to your client gateway through the Internet.
+ This number must be between `1` and `4294967295`. If you do not have an ASN, you can choose one between 64512 and 65534, or between 4200000000 and 4294967294. type: integer ConnectionType: description: The communication protocol used to establish tunnel with your @@ -747,6 +757,36 @@ components: ResponseContext: "$ref": "#/components/schemas/ResponseContext" type: object + CreateDedicatedGroupRequest: + additionalProperties: false + properties: + CpuGeneration: + description: The processor generation for the VMs in the dedicated group + (for example, `4`). + type: integer + DryRun: + description: If true, checks whether you have the required permissions to + perform the action. + type: boolean + Name: + description: A name for the dedicated group. + type: string + SubregionName: + description: The Subregion in which you want to create the dedicated group. + type: string + required: + - CpuGeneration + - Name + - SubregionName + type: object + CreateDedicatedGroupResponse: + additionalProperties: false + properties: + DedicatedGroup: + "$ref": "#/components/schemas/DedicatedGroup" + ResponseContext: + "$ref": "#/components/schemas/ResponseContext" + type: object CreateDhcpOptionsRequest: additionalProperties: false properties: @@ -910,11 +950,12 @@ components: additionalProperties: false properties: Architecture: - description: The architecture of the OMI (by default, `i386` if you specified - the `FileLocation` or `RootDeviceName` parameter). + description: "**(when registering from a snapshot, or from a bucket without + using a manifest file)** The architecture of the OMI (`i386` or `x84_64`)." type: string BlockDeviceMappings: - description: One or more block device mappings. + description: "**(when registering from a snapshot, or from a bucket without + using a manifest file)** One or more block device mappings." items: "$ref": "#/components/schemas/BlockDeviceMappingImage" type: array @@ -926,19 +967,18 @@ components: perform the action. type: boolean FileLocation: - description: 'The pre-signed URL of the OMI manifest file, or the full path - to the OMI stored in a bucket. If you specify this parameter, a copy of - the OMI is created in your account. You must specify only one of the following - parameters: `FileLocation`, `RootDeviceName`, `SourceImageId` or `VmId`.' + description: |- + **(when registering from a bucket by using a manifest file)** The pre-signed URL of the manifest file for the OMI you want to register. For more information, see [Configuring a Pre-signed URL](https://docs.outscale.com/en/userguide/Configuring-a-Pre-signed-URL.html) or [Managing Access to Your Buckets and Objects](https://docs.outscale.com/en/userguide/Managing-Access-to-Your-Buckets-and-Objects.html).
+ You can also specify the normal URL of the OMI if you have permission on the OOS bucket, without using the manifest file, but in that case, you need to manually specify through the other parameters all the information that would otherwise be read from the manifest file. type: string ImageName: description: |- A unique name for the new OMI.
- Constraints: 3-128 alphanumeric characters, underscores (_), spaces ( ), parentheses (()), slashes (/), periods (.), or dashes (-). + Constraints: 3-128 alphanumeric characters, underscores (`_`), spaces (` `), parentheses (`()`), slashes (`/`), periods (`.`), or dashes (`-`). type: string NoReboot: - description: If false, the VM shuts down before creating the OMI and then - reboots. If true, the VM does not. + description: "**(when creating from a VM)** If false, the VM shuts down + before creating the OMI and then reboots. If true, the VM does not." type: boolean ProductCodes: description: The product codes associated with the OMI. @@ -946,23 +986,19 @@ components: type: string type: array RootDeviceName: - description: 'The name of the root device. You must specify only one of - the following parameters: `FileLocation`, `RootDeviceName`, `SourceImageId` - or `VmId`.' + description: "**(when registering from a snapshot, or from a bucket without + using a manifest file)** The name of the root device for the new OMI." type: string SourceImageId: - description: 'The ID of the OMI you want to copy. You must specify only - one of the following parameters: `FileLocation`, `RootDeviceName`, `SourceImageId` - or `VmId`.' + description: "**(when copying an OMI)** The ID of the OMI you want to copy." type: string SourceRegionName: - description: The name of the source Region, which must be the same as the - Region of your account. + description: "**(when copying an OMI)** The name of the source Region (always + the same as the Region of your account)." type: string VmId: - description: 'The ID of the VM from which you want to create the OMI. You - must specify only one of the following parameters: `FileLocation`, `RootDeviceName`, - `SourceImageId` or `VmId`.' + description: "**(when creating from a VM)** The ID of the VM from which + you want to create the OMI." type: string type: object CreateImageResponse: @@ -1001,7 +1037,8 @@ components: [ASCII printable characters](https://en.wikipedia.org/wiki/ASCII#Printable_characters). type: string PublicKey: - description: The public key. It must be Base64-encoded. + description: The public key to import in your account, if you are importing + an existing keypair. This value must be Base64-encoded. type: string required: - KeypairName @@ -1297,9 +1334,11 @@ components: description: The IP range for the Net, in CIDR notation (for example, `10.0.0.0/16`). type: string Tenancy: - description: The tenancy options for the VMs (`default` if a VM created - in a Net can be launched with any tenancy, `dedicated` if it can be launched - with dedicated tenancy VMs running on single-tenant hardware). + description: |- + The tenancy options for the VMs:
+ - `default` if a VM created in a Net can be launched with any tenancy.
+ - `dedicated` if it can be launched with dedicated tenancy VMs running on single-tenant hardware.
+ - `dedicated group ID`: if it can be launched in a dedicated group on single-tenant hardware. type: string required: - IpRange @@ -1349,6 +1388,89 @@ components: ResponseContext: "$ref": "#/components/schemas/ResponseContext" type: object + CreatePolicyRequest: + additionalProperties: false + properties: + Description: + description: A description for the policy. + type: string + Document: + description: The policy document, corresponding to a JSON string that contains + the policy. For more information, see [EIM Reference Information](https://docs.outscale.com/en/userguide/EIM-Reference-Information.html). + type: string + DryRun: + description: If true, checks whether you have the required permissions to + perform the action. + type: boolean + Path: + description: The path of the policy. + type: string + PolicyName: + description: The name of the policy. + type: string + required: + - Document + - PolicyName + type: object + CreatePolicyResponse: + additionalProperties: false + properties: + Policy: + "$ref": "#/components/schemas/Policy" + ResponseContext: + "$ref": "#/components/schemas/ResponseContext" + type: object + CreatePolicyVersionRequest: + additionalProperties: false + properties: + Document: + description: The policy document, corresponding to a JSON string that contains + the policy. For more information, see [EIM Reference Information](https://docs.outscale.com/en/userguide/EIM-Reference-Information.html). + type: string + PolicyOrn: + description: The OUTSCALE Resource Name (ORN) of the policy. For more information, + see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). + type: string + SetAsDefault: + description: If set to true, the new policy version is set as the default + version and becomes the operative one. + type: boolean + required: + - Document + - PolicyOrn + type: object + CreatePolicyVersionResponse: + additionalProperties: false + properties: + PolicyVersion: + "$ref": "#/components/schemas/PolicyVersion" + ResponseContext: + "$ref": "#/components/schemas/ResponseContext" + type: object + CreateProductTypeRequest: + additionalProperties: false + properties: + Description: + description: The description of the product type. + type: string + DryRun: + description: If true, checks whether you have the required permissions to + perform the action. + type: boolean + Vendor: + description: The vendor of the product type. + type: string + required: + - Description + type: object + CreateProductTypeResponse: + additionalProperties: false + properties: + ProductType: + "$ref": "#/components/schemas/ProductType" + ResponseContext: + "$ref": "#/components/schemas/ResponseContext" + type: object CreatePublicIpRequest: additionalProperties: false properties: @@ -1432,8 +1554,9 @@ components: additionalProperties: false properties: Description: - description: A description for the security group, with a maximum length - of 255 [ASCII printable characters](https://en.wikipedia.org/wiki/ASCII#Printable_characters). + description: |- + A description for the security group.
+ This description can contain between 1 and 255 characters. Allowed characters are `a-z`, `A-Z`, `0-9`, accented letters, spaces, and `_.-:/()#,@[]+=&;{}!$*`. type: string DryRun: description: If true, checks whether you have the required permissions to @@ -1445,8 +1568,8 @@ components: SecurityGroupName: description: |- The name of the security group.
- This name must not start with `sg-`.
- This name must be unique and contain between 1 and 255 ASCII characters. Accented letters are not allowed. + This name must not start with `sg-`.
+ This name must be unique and contain between 1 and 255 characters. Allowed characters are `a-z`, `A-Z`, `0-9`, spaces, and `_.-:/()#,@[]+=&;{}!$*`. type: string required: - Description @@ -1604,27 +1727,29 @@ components: perform the action. type: boolean FileLocation: - description: "(When importing) The pre-signed URL of the snapshot you want - to import, or the normal URL of the snapshot if you have permission on - the OOS bucket. For more information, see [Configuring a Pre-signed URL](https://docs.outscale.com/en/userguide/Configuring-a-Pre-signed-URL.html) + description: "**(when importing from a bucket)** The pre-signed URL of the + snapshot you want to import, or the normal URL of the snapshot if you + have permission on the OOS bucket. For more information, see [Configuring + a Pre-signed URL](https://docs.outscale.com/en/userguide/Configuring-a-Pre-signed-URL.html) or [Managing Access to Your Buckets and Objects](https://docs.outscale.com/en/userguide/Managing-Access-to-Your-Buckets-and-Objects.html)." type: string SnapshotSize: - description: "(When importing) The size of the snapshot you want to create - in your account, in bytes. This size must be greater than or equal to - the size of the original, uncompressed snapshot." + description: "**(when importing from a bucket)** The size of the snapshot + you want to create in your account, in bytes. This size must be greater + than or equal to the size of the original, uncompressed snapshot." format: int64 type: integer SourceRegionName: - description: "(When copying) The name of the source Region, which must be - the same as the Region of your account." + description: "**(when copying a snapshot)** The name of the source Region, + which must be the same as the Region of your account." type: string SourceSnapshotId: - description: "(When copying) The ID of the snapshot you want to copy." + description: "**(when copying a snapshot)** The ID of the snapshot you want + to copy." type: string VolumeId: - description: "(When creating) The ID of the volume you want to create a - snapshot of." + description: "**(when creating from a volume)** The ID of the volume you + want to create a snapshot of." type: string type: object CreateSnapshotResponse: @@ -1645,7 +1770,7 @@ components: IpRange: description: |- The IP range in the Subnet, in CIDR notation (for example, `10.0.0.0/16`).
- The IP range of the Subnet can be either the same as the Net one if you create only a single Subnet in this Net, or a subset of the Net one. In case of several Subnets in a Net, their IP ranges must not overlap. The smallest Subnet you can create uses a /29 netmask (eight IPs). For more information, see [About VPCs](https://docs.outscale.com/en/userguide/About-VPCs.html). + The IP range of the Subnet can be either the same as the Net one if you create only a single Subnet in this Net, or a subset of the Net one. In case of several Subnets in a Net, their IP ranges must not overlap. The smallest Subnet you can create uses a /29 netmask (eight IPs). For more information, see [About Nets](https://docs.outscale.com/en/userguide/About-Nets.html). type: string NetId: description: The ID of the Net for which you want to create a Subnet. @@ -1701,9 +1826,14 @@ components: type: boolean Path: description: The path to the EIM user you want to create (by default, `/`). + This path name must begin and end with a slash (/), and contain between + 1 and 512 alphanumeric characters and/or slashes (/), or underscores (_). type: string UserName: - description: The name of the EIM user you want to create. + description: The name of the EIM user you want to create. This user name + must contain between 1 and 64 alphanumeric characters and/or pluses (+), + equals (=), commas (,), periods (.), at signs (@), dashes (-), or underscores + (_). type: string required: - UserName @@ -1956,7 +2086,7 @@ components: VmType: description: |- The type of VM. You can specify a TINA type (in the `tinavW.cXrYpZ` or `tinavW.cXrY` format), or an AWS type (for example, `t2.small`, which is the default value).
- If you specify an AWS type, it is converted in the background to its corresponding TINA type, but the AWS type is still returned. If the specified or converted TINA type includes a performance flag, this performance flag is applied regardless of the value you may have provided in the `Performance` parameter. For more information, see [Instance Types](https://docs.outscale.com/en/userguide/Instance-Types.html). + If you specify an AWS type, it is converted in the background to its corresponding TINA type, but the AWS type is still returned. If the specified or converted TINA type includes a performance flag, this performance flag is applied regardless of the value you may have provided in the `Performance` parameter. For more information, see [VM Types](https://docs.outscale.com/en/userguide/VM-Types.html). type: string required: - ImageId @@ -2026,10 +2156,11 @@ components: perform the action. type: boolean StaticRoutesOnly: - description: If false, the VPN connection uses dynamic routing with Border - Gateway Protocol (BGP). If true, routing is controlled using static routes. - For more information about how to create and delete static routes, see - [CreateVpnConnectionRoute](#createvpnconnectionroute) and [DeleteVpnConnectionRoute](#deletevpnconnectionroute). + description: By default or if false, the VPN connection uses dynamic routing + with Border Gateway Protocol (BGP). If true, routing is controlled using + static routes. For more information about how to create and delete static + routes, see [CreateVpnConnectionRoute](#createvpnconnectionroute) and + [DeleteVpnConnectionRoute](#deletevpnconnectionroute). type: boolean VirtualGatewayId: description: The ID of the virtual gateway. @@ -2071,6 +2202,36 @@ components: ResponseContext: "$ref": "#/components/schemas/ResponseContext" type: object + DedicatedGroup: + additionalProperties: false + description: Information about the dedicated group. + properties: + AccountId: + description: The account ID of the owners of the dedicated group. + type: string + CpuGeneration: + description: The processor generation. + type: integer + DedicatedGroupId: + description: The ID of the dedicated group. + type: string + Name: + description: The name of the dedicated group. + type: string + NetIds: + description: The IDs of the Nets in the dedicated group. + items: + type: string + type: array + SubregionName: + description: The name of the Subregion in which the dedicated group is located. + type: string + VmIds: + description: The IDs of the VMs in the dedicated group. + items: + type: string + type: array + type: object DeleteAccessKeyRequest: additionalProperties: false properties: @@ -2152,6 +2313,29 @@ components: ResponseContext: "$ref": "#/components/schemas/ResponseContext" type: object + DeleteDedicatedGroupRequest: + additionalProperties: false + properties: + DedicatedGroupId: + description: The ID of the dedicated group you want to delete. + type: string + DryRun: + description: If true, checks whether you have the required permissions to + perform the action. + type: boolean + Force: + description: If true, forces the deletion of the dedicated group and all + its dependencies. + type: boolean + required: + - DedicatedGroupId + type: object + DeleteDedicatedGroupResponse: + additionalProperties: false + properties: + ResponseContext: + "$ref": "#/components/schemas/ResponseContext" + type: object DeleteDhcpOptionsRequest: additionalProperties: false properties: @@ -2518,6 +2702,46 @@ components: ResponseContext: "$ref": "#/components/schemas/ResponseContext" type: object + DeletePolicyRequest: + additionalProperties: false + properties: + DryRun: + description: If true, checks whether you have the required permissions to + perform the action. + type: boolean + PolicyOrn: + description: The OUTSCALE Resource Name (ORN) of the policy you want to + delete. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). + type: string + required: + - PolicyOrn + type: object + DeletePolicyResponse: + additionalProperties: false + properties: + ResponseContext: + "$ref": "#/components/schemas/ResponseContext" + type: object + DeletePolicyVersionRequest: + additionalProperties: false + properties: + PolicyOrn: + description: The OUTSCALE Resource Name (ORN) of the policy. For more information, + see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). + type: string + VersionId: + description: The ID of the version of the policy you want to delete. + type: string + required: + - PolicyOrn + - VersionId + type: object + DeletePolicyVersionResponse: + additionalProperties: false + properties: + ResponseContext: + "$ref": "#/components/schemas/ResponseContext" + type: object DeletePublicIpRequest: additionalProperties: false properties: @@ -3026,7 +3250,8 @@ components: description: The ID of the target virtual gateway. type: string Vlan: - description: The VLAN number associated with the DirectLink interface. + description: The VLAN number associated with the DirectLink interface. This + number must be unique and be between `2` and `4094`. type: integer required: - BgpAsn @@ -3299,6 +3524,33 @@ components: type: string type: array type: object + FiltersDedicatedGroup: + additionalProperties: false + description: One or more filters. + properties: + CpuGenerations: + description: The processor generation for the VMs in the dedicated group + (for example, `4`). + items: + type: integer + type: array + DedicatedGroupIds: + description: The IDs of the dedicated groups. + items: + type: string + type: array + Names: + description: The names of the dedicated groups. + items: + type: string + type: array + SubregionNames: + description: The names of the Subregions in which the dedicated groups are + located. + items: + type: string + type: array + type: object FiltersDhcpOptions: additionalProperties: false description: One or more filters. @@ -3497,8 +3749,7 @@ components: type: string type: array PermissionsToLaunchAccountIds: - description: The account IDs of the users who have launch permissions for - the OMIs. + description: The account IDs which have launch permissions for the OMIs. items: type: string type: array @@ -3506,6 +3757,11 @@ components: description: If true, lists all public OMIs. If false, lists all private OMIs. type: boolean + ProductCodeNames: + description: The names of the product codes associated with the OMI. + items: + type: string + type: array ProductCodes: description: The product codes associated with the OMI. items: @@ -3517,7 +3773,7 @@ components: type: string type: array RootDeviceTypes: - description: The types of root device used by the OMIs (always `bsu`). + description: The types of root device used by the OMIs (`bsu` or `ebs`). items: type: string type: array @@ -3565,7 +3821,7 @@ components: LinkStates: description: The current states of the attachments between the Internet services and the Nets (only `available`, if the Internet gateway is attached - to a VPC). + to a Net). items: type: string type: array @@ -3600,6 +3856,12 @@ components: items: type: string type: array + KeypairTypes: + description: The types of the keypairs (`ssh-rsa`, `ssh-ed25519`, `ecdsa-sha2-nistp256`, + `ecdsa-sha2-nistp384`, or `ecdsa-sha2-nistp521`). + items: + type: string + type: array type: object FiltersListenerRule: additionalProperties: false @@ -3687,7 +3949,7 @@ components: type: string type: array States: - description: The states of the Nets (`pending` \| `available` \| `deleted`). + description: The states of the Nets (`pending` \| `available` \| `deleting`). items: type: string type: array @@ -3770,6 +4032,13 @@ components: items: type: string type: array + ExpirationDates: + description: The dates and times at which the Net peerings expire, in ISO + 8601 date-time format (for example, `2020-06-14T00:00:00.000Z`). + items: + format: date-time + type: string + type: array NetPeeringIds: description: The IDs of the Net peerings. items: @@ -4159,11 +4428,6 @@ components: additionalProperties: false description: One or more filters. properties: - AccountIds: - description: The account IDs of the owners of the security groups. - items: - type: string - type: array Descriptions: description: The descriptions of the security groups. items: @@ -4330,8 +4594,7 @@ components: format: date-time type: string PermissionsToCreateVolumeAccountIds: - description: The account IDs of one or more users who have permissions to - create volumes. + description: The account IDs which have permissions to create volumes. items: type: string type: array @@ -4443,6 +4706,16 @@ components: additionalProperties: false description: One or more filters. properties: + RegionNames: + description: The names of the Regions containing the Subregions. + items: + type: string + type: array + States: + description: The states of the Subregions. + items: + type: string + type: array SubregionNames: description: The names of the Subregions. items: @@ -4535,87 +4808,398 @@ components: additionalProperties: false description: One or more filters. properties: - TagKeys: - description: The keys of the tags associated with the VMs. + Architectures: + description: The architectures of the VMs (`i386` \| `x86_64`). items: type: string type: array - TagValues: - description: The values of the tags associated with the VMs. + BlockDeviceMappingDeleteOnVmDeletion: + description: Whether the BSU volumes are deleted when terminating the VMs. + type: boolean + BlockDeviceMappingDeviceNames: + description: The device names for the BSU volumes (in the format `/dev/sdX`, + `/dev/sdXX`, `/dev/xvdX`, or `/dev/xvdXX`). items: type: string type: array - Tags: - description: 'The key/value combination of the tags associated with the - VMs, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' - items: - type: string + BlockDeviceMappingLinkDates: + description: The link dates for the BSU volumes mapped to the VMs (for example, + `2016-01-23T18:45:30.000Z`). + items: string type: array - VmIds: - description: One or more IDs of VMs. + BlockDeviceMappingStates: + description: The states for the BSU volumes (`attaching` \| `attached` \| + `detaching` \| `detached`). items: type: string type: array - type: object - FiltersVmGroup: - additionalProperties: false - description: One or more filters. - properties: - Descriptions: - description: The descriptions of the VM groups. + BlockDeviceMappingVolumeIds: + description: The volume IDs of the BSU volumes. items: type: string type: array - SecurityGroupIds: - description: The IDs of the security groups. + ClientTokens: + description: The idempotency tokens provided when launching the VMs. items: type: string type: array - SubnetIds: - description: The IDs of the Subnets. - items: - type: string + CreationDates: + description: The dates when the VMs were launched. + items: string type: array - TagKeys: - description: The keys of the tags associated with the VM groups. + ImageIds: + description: The IDs of the OMIs used to launch the VMs. items: type: string type: array - TagValues: - description: The values of the tags associated with the VM groups. + IsSourceDestChecked: + description: Whether the source/destination checking is enabled (true) or + disabled (false). + type: boolean + KeypairNames: + description: The names of the keypairs used when launching the VMs. items: type: string type: array - Tags: - description: 'The key/value combination of the tags associated with the - VMs, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' + LaunchNumbers: + description: The numbers for the VMs when launching a group of several VMs + (for example, `0`, `1`, `2`, and so on). items: - type: string + type: integer type: array - VmCounts: - description: The number of VMs in the VM group. + Lifecycles: + description: Whether the VMs are Spot Instances (spot). items: - type: integer + type: string type: array - VmGroupIds: - description: The IDs of the VM groups. + NetIds: + description: The IDs of the Nets in which the VMs are running. items: type: string type: array - VmGroupNames: - description: The names of the VM groups. + NicAccountIds: + description: The IDs of the NICs. items: type: string type: array - VmTemplateIds: - description: The IDs of the VM templates. + NicDescriptions: + description: The descriptions of the NICs. items: type: string type: array - type: object - FiltersVmTemplate: - additionalProperties: false - description: One or more filters. + NicIsSourceDestChecked: + description: Whether the source/destination checking is enabled (true) or + disabled (false). + type: boolean + NicLinkNicDeleteOnVmDeletion: + description: Whether the NICs are deleted when the VMs they are attached + to are deleted. + type: boolean + NicLinkNicDeviceNumbers: + description: The device numbers the NICs are attached to. + items: + type: integer + type: array + NicLinkNicLinkNicDates: + description: The dates and time when the NICs were attached to the VMs. + items: string + type: array + NicLinkNicLinkNicIds: + description: The IDs of the NIC attachments. + items: + type: string + type: array + NicLinkNicStates: + description: The states of the attachments. + items: + type: string + type: array + NicLinkNicVmAccountIds: + description: The account IDs of the owners of the VMs the NICs are attached + to. + items: + type: string + type: array + NicLinkNicVmIds: + description: The IDs of the VMs the NICs are attached to. + items: + type: string + type: array + NicLinkPublicIpAccountIds: + description: The account IDs of the owners of the public IPs associated + with the NICs. + items: + type: string + type: array + NicLinkPublicIpLinkPublicIpIds: + description: The association IDs returned when the public IPs were associated + with the NICs. + items: + type: string + type: array + NicLinkPublicIpPublicIpIds: + description: The allocation IDs returned when the public IPs were allocated + to their accounts. + items: + type: string + type: array + NicLinkPublicIpPublicIps: + description: The public IPs associated with the NICs. + items: + type: string + type: array + NicMacAddresses: + description: The Media Access Control (MAC) addresses of the NICs. + items: + type: string + type: array + NicNetIds: + description: The IDs of the Nets where the NICs are located. + items: + type: string + type: array + NicNicIds: + description: The IDs of the NICs. + items: + type: string + type: array + NicPrivateIpsLinkPublicIpAccountIds: + description: The account IDs of the owner of the public IPs associated with + the private IPs. + items: + type: string + type: array + NicPrivateIpsLinkPublicIpIds: + description: The public IPs associated with the private IPs. + items: + type: string + type: array + NicPrivateIpsPrimaryIp: + description: Whether the private IPs are the primary IPs associated with + the NICs. + type: boolean + NicPrivateIpsPrivateIps: + description: The private IPs of the NICs. + items: + type: string + type: array + NicSecurityGroupIds: + description: The IDs of the security groups associated with the NICs. + items: + type: string + type: array + NicSecurityGroupNames: + description: The names of the security groups associated with the NICs. + items: + type: string + type: array + NicStates: + description: The states of the NICs (`available` \| `in-use`). + items: + type: string + type: array + NicSubnetIds: + description: The IDs of the Subnets for the NICs. + items: + type: string + type: array + NicSubregionNames: + description: The Subregions where the NICs are located. + items: + type: string + type: array + Platforms: + description: The platforms. Use windows if you have Windows VMs. Otherwise, + leave this filter blank. + items: + type: string + type: array + PrivateIps: + description: The private IPs of the VMs. + items: + type: string + type: array + ProductCodes: + description: The product codes associated with the OMI used to create the + VMs. + items: + type: string + type: array + PublicIps: + description: The public IPs of the VMs. + items: + type: string + type: array + ReservationIds: + description: The IDs of the reservation of the VMs, created every time you + launch VMs. These reservation IDs can be associated with several VMs when + you lauch a group of VMs using the same launch request. + items: + type: string + type: array + RootDeviceNames: + description: The names of the root devices for the VMs (for example, `/dev/sda1`) + items: + type: string + type: array + RootDeviceTypes: + description: The root devices types used by the VMs (always `ebs`) + items: + type: string + type: array + SecurityGroupIds: + description: The IDs of the security groups for the VMs (only in the public + Cloud). + items: + type: string + type: array + SecurityGroupNames: + description: The names of the security groups for the VMs (only in the public + Cloud). + items: + type: string + type: array + StateReasonCodes: + description: The reason codes for the state changes. + items: + type: integer + type: array + StateReasonMessages: + description: The messages describing the state changes. + items: + type: string + type: array + StateReasons: + description: The reasons explaining the current states of the VMs. This + filter is like the `StateReasonCodes` one. + items: + type: string + type: array + SubnetIds: + description: The IDs of the Subnets for the VMs. + items: + type: string + type: array + SubregionNames: + description: The names of the Subregions of the VMs. + items: + type: string + type: array + TagKeys: + description: The keys of the tags associated with the VMs. + items: + type: string + type: array + TagValues: + description: The values of the tags associated with the VMs. + items: + type: string + type: array + Tags: + description: 'The key/value combination of the tags associated with the + VMs, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' + items: + type: string + type: array + Tenancies: + description: The tenancies of the VMs (`dedicated` \| `default` \| `host`). + items: + type: string + type: array + VmIds: + description: One or more IDs of VMs. + items: + type: string + type: array + VmSecurityGroupIds: + description: The IDs of the security groups for the VMs. + items: + type: string + type: array + VmSecurityGroupNames: + description: The names of the security group for the VMs. + items: + type: string + type: array + VmStateCodes: + description: 'The state codes of the VMs: `-1` (quarantine), `0` (pending), + `16` (running), `32` (shutting-down), `48` (terminated), `64` (stopping), + and `80` (stopped).' + items: + type: integer + type: array + VmStateNames: + description: The state names of the VMs (`pending` \| `running` \| `stopping` + \| `stopped` \| `shutting-down` \| `terminated` \| `quarantine`). + items: + type: string + type: array + VmTypes: + description: The VM types (for example, t2.micro). For more information, + see [VM Types](https://docs.outscale.com/en/userguide/VM-Types.html). + items: + type: string + type: array + type: object + FiltersVmGroup: + additionalProperties: false + description: One or more filters. + properties: + Descriptions: + description: The descriptions of the VM groups. + items: + type: string + type: array + SecurityGroupIds: + description: The IDs of the security groups. + items: + type: string + type: array + SubnetIds: + description: The IDs of the Subnets. + items: + type: string + type: array + TagKeys: + description: The keys of the tags associated with the VM groups. + items: + type: string + type: array + TagValues: + description: The values of the tags associated with the VM groups. + items: + type: string + type: array + Tags: + description: 'The key/value combination of the tags associated with the + VMs, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' + items: + type: string + type: array + VmCounts: + description: The number of VMs in the VM group. + items: + type: integer + type: array + VmGroupIds: + description: The IDs of the VM groups. + items: + type: string + type: array + VmGroupNames: + description: The names of the VM groups. + items: + type: string + type: array + VmTemplateIds: + description: The IDs of the VM templates. + items: + type: string + type: array + type: object + FiltersVmTemplate: + additionalProperties: false + description: One or more filters. properties: CpuCores: description: The number of vCores. @@ -4664,7 +5248,7 @@ components: type: array Tags: description: 'The key/value combination of the tags associated with the - VM templates, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' + VM templates, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' items: type: string type: array @@ -4687,6 +5271,21 @@ components: description: This parameter is not available. It is present in our API for the sake of historical compatibility with AWS. type: boolean + EphemeralsTypes: + description: The types of ephemeral storage disk. + items: + type: string + type: array + Eths: + description: The number of Ethernet interfaces available. + items: + type: integer + type: array + Gpus: + description: The number of GPUs available. + items: + type: integer + type: array MemorySizes: description: The amounts of memory, in gibibytes (GiB). items: @@ -4699,8 +5298,7 @@ components: type: integer type: array VmTypeNames: - description: The names of the VM types. For more information, see [Instance - Types](https://docs.outscale.com/en/userguide/Instance-Types.html). + description: The names of the VM types. For more information, see [VM Types](https://docs.outscale.com/en/userguide/VM-Types.html). items: type: string type: array @@ -4966,15 +5564,15 @@ components: description: Information about the health check configuration. properties: CheckInterval: - description: The number of seconds between two pings (between `5` and `600` - both included). + description: The number of seconds between two requests (between `5` and + `600` both included). type: integer HealthyThreshold: - description: The number of consecutive successful pings before considering + description: The number of consecutive successful requests before considering the VM as healthy (between `2` and `10` both included). type: integer Path: - description: If you use the HTTP or HTTPS protocols, the ping path. + description: If you use the HTTP or HTTPS protocols, the request URL path. type: string Port: description: The port number (between `1` and `65535`, both included). @@ -4988,8 +5586,8 @@ components: the VM as unhealthy, in seconds (between `2` and `60` both included). type: integer UnhealthyThreshold: - description: The number of consecutive failed pings before considering the - VM as unhealthy (between `2` and `10` both included). + description: The number of consecutive failed requests before considering + the VM as unhealthy (between `2` and `10` both included). type: integer required: - CheckInterval @@ -5010,7 +5608,7 @@ components: description: The account ID of the owner of the OMI. type: string Architecture: - description: The architecture of the OMI (by default, `i386`). + description: The architecture of the OMI. type: string BlockDeviceMappings: description: One or more block device mappings. @@ -5026,7 +5624,7 @@ components: description: The description of the OMI. type: string FileLocation: - description: The location of the bucket where the OMI files are stored. + description: The location from which the OMI files were created. type: string ImageId: description: The ID of the OMI. @@ -5120,21 +5718,30 @@ components: KeypairName: description: The name of the keypair. type: string + KeypairType: + description: The type of the keypair (`ssh-rsa`, `ssh-ed25519`, `ecdsa-sha2-nistp256`, + `ecdsa-sha2-nistp384`, or `ecdsa-sha2-nistp521`). + type: string type: object KeypairCreated: additionalProperties: false description: Information about the created keypair. properties: KeypairFingerprint: - description: The MD5 public key fingerprint as specified in section 4 of + description: The MD5 public key fingerprint, as specified in section 4 of RFC 4716. type: string KeypairName: description: The name of the keypair. type: string + KeypairType: + description: The type of the keypair (`ssh-rsa`, `ssh-ed25519`, `ecdsa-sha2-nistp256`, + `ecdsa-sha2-nistp384`, or `ecdsa-sha2-nistp521`). + type: string PrivateKey: - description: The private key. When saving the private key in a .rsa file, - replace the `\n` escape sequences with line breaks. + description: The private key, returned only if you are creating a keypair + (not if you are importing). When you save this private key in a .rsa file, + make sure you replace the `\n` escape sequences with real line breaks. type: string type: object LinkFlexibleGpuRequest: @@ -5301,6 +5908,31 @@ components: description: The ID of the NIC attachment. type: string type: object + LinkPolicyRequest: + additionalProperties: false + properties: + DryRun: + description: If true, checks whether you have the required permissions to + perform the action. + type: boolean + PolicyOrn: + description: The OUTSCALE Resource Name (ORN) of the policy. For more information, + see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). + type: string + UserName: + description: The name of the user you want to link the policy to (between + 1 and 64 characters). + type: string + required: + - PolicyOrn + - UserName + type: object + LinkPolicyResponse: + additionalProperties: false + properties: + ResponseContext: + "$ref": "#/components/schemas/ResponseContext" + type: object LinkPrivateIpsRequest: additionalProperties: false properties: @@ -5374,9 +6006,9 @@ components: AllowRelink: description: If true, allows the public IP to be associated with the VM or NIC that you specify even if it is already associated with another - VM or NIC. If false, prevents the EIP from being associated with the VM - or NIC that you specify if it is already associated with another VM or - NIC. (By default, true in the public Cloud, false in a Net.) + VM or NIC. If false, prevents the public IP from being associated with + the VM or NIC that you specify if it is already associated with another + VM or NIC. (By default, true in the public Cloud, false in a Net.) type: boolean DryRun: description: If true, checks whether you have the required permissions to @@ -5427,6 +6059,9 @@ components: Main: description: If true, the route table is the main one. type: boolean + NetId: + description: The ID of the Net. + type: string RouteTableId: description: The ID of the route table. type: string @@ -5515,6 +6150,29 @@ components: ResponseContext: "$ref": "#/components/schemas/ResponseContext" type: object + LinkedPolicy: + additionalProperties: false + description: Information about the attached policy. + properties: + CreationDate: + description: The date and time of creation of the attached policy. + format: date-time + type: string + LastModificationDate: + description: The date and time at which the attached policy was last modified. + format: date-time + type: string + Orn: + description: The Outscale Resource Name (ORN) of the policy. For more information, + see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). + type: string + PolicyId: + description: The ID of the policy. + type: string + PolicyName: + description: The name of the policy. + type: string + type: object LinkedVolume: additionalProperties: false description: Information about volume attachment. @@ -5918,7 +6576,7 @@ components: description: The ID of the Net. type: string State: - description: The state of the Net (`pending` \| `available` \| `deleted`). + description: The state of the Net (`pending` \| `available` \| `deleting`). type: string Tags: description: One or more tags associated with the Net. @@ -5964,6 +6622,11 @@ components: properties: AccepterNet: "$ref": "#/components/schemas/AccepterNet" + ExpirationDate: + description: The date and time at which the Net peerings expire. + format: date-time + nullable: true + type: string NetPeeringId: description: The ID of the Net peering. type: string @@ -6336,6 +6999,16 @@ components: any character except line breaks and double quotes ("). type: string type: object + Phase2OptionsToUpdate: + additionalProperties: false + description: 'Information about Phase 2 of the Internet Key Exchange (IKE) negotiation. ' + properties: + PreSharedKey: + description: The pre-shared key to establish the initial authentication + between the client gateway and the virtual gateway. This key can contain + any character except line breaks and double quotes ("). + type: string + type: object Placement: additionalProperties: false description: Information about the placement of the VM. @@ -6345,7 +7018,65 @@ components: must not specify the `Nics` parameter. type: string Tenancy: - description: The tenancy of the VM (`default` \| `dedicated`). + description: The tenancy of the VM (`default`, `dedicated`, or a dedicated + group ID). + type: string + type: object + Policy: + additionalProperties: false + description: Information about the policy. + properties: + CreationDate: + description: The date and time of creation of the policy. + format: date-time + type: string + Description: + description: A friendly name for the policy (between 0 and 1000 characters). + type: string + IsLinkable: + description: Indicates whether the policy can be linked to a group or an + EIM user. + type: boolean + LastModificationDate: + description: The date and time at which the policy was last modified. + format: date-time + type: string + Orn: + description: The OUTSCALE Resource Name (ORN) of the policy. For more information, + see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). + type: string + Path: + description: The path to the policy. + type: string + PolicyDefaultVersionId: + description: The ID of the policy default version. + type: string + PolicyId: + description: The ID of the policy. + type: string + PolicyName: + description: The name of the policy. + type: string + ResourcesCount: + description: The number of resources attached to the policy. + type: integer + type: object + PolicyVersion: + additionalProperties: false + description: Information about the policy version. + properties: + Body: + description: The policy document as a json string. + type: string + CreationDate: + description: The date and time of creation of the version. + format: date-time + type: string + DefaultVersion: + description: If true, the version is the default one. + type: boolean + VersionId: + description: The ID of the version. type: string type: object PrivateIp: @@ -6460,8 +7191,8 @@ components: description: The description of the quota. type: string MaxValue: - description: The maximum value of the quota for the OUTSCALE user account - (if there is no limit, `0`). + description: The maximum value of the quota for the account (if there is + no limit, `0`). type: integer Name: description: The unique name of the quota. @@ -6473,7 +7204,7 @@ components: description: The description of the quota. type: string UsedValue: - description: The limit value currently used by the OUTSCALE user account. + description: The limit value currently used by the account. type: integer type: object QuotaTypes: @@ -6485,7 +7216,7 @@ components: if it is not. type: string Quotas: - description: One or more quotas associated with the user. + description: One or more quotas associated with the account. items: "$ref": "#/components/schemas/Quota" type: array @@ -6680,7 +7411,6 @@ components: type: boolean Filters: "$ref": "#/components/schemas/FiltersCatalogs" - description: ReadCatalogsRequest_Filters type: object ReadCatalogsResponse: additionalProperties: false @@ -6762,6 +7492,13 @@ components: 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: By default or if false, returns only the consumption of the + specific account that sends this request. If true, returns the unit price + of the consumed resource, and the total price of the consumed resource + during the specified time period in the currency of the catalog of the + Region where the API method was used. + type: boolean ToDate: description: The end of the time period, in ISO 8601 date format (for example, `2020-06-30`). The date-time format is also accepted, but only with a @@ -6784,6 +7521,27 @@ components: ResponseContext: "$ref": "#/components/schemas/ResponseContext" type: object + ReadDedicatedGroupsRequest: + additionalProperties: false + properties: + DryRun: + description: If true, checks whether you have the required permissions to + perform the action. + type: boolean + Filters: + "$ref": "#/components/schemas/FiltersDedicatedGroup" + type: object + ReadDedicatedGroupsResponse: + additionalProperties: false + properties: + DedicatedGroups: + description: Information about one or more dedicated groups. + items: + "$ref": "#/components/schemas/DedicatedGroup" + type: array + ResponseContext: + "$ref": "#/components/schemas/ResponseContext" + type: object ReadDhcpOptionsRequest: additionalProperties: false properties: @@ -6793,6 +7551,15 @@ components: type: boolean Filters: "$ref": "#/components/schemas/FiltersDhcpOptions" + NextPageToken: + description: The token to request the next page of results. Each token refers + to a specific page. + format: byte + type: string + ResultsPerPage: + description: The maximum number of logs returned in a single response (between + `1`and `1000`, both included). By default, `100`. + type: integer type: object ReadDhcpOptionsResponse: additionalProperties: false @@ -6802,6 +7569,11 @@ components: items: "$ref": "#/components/schemas/DhcpOptionsSet" type: array + NextPageToken: + description: The token to request the next page of results. Each token refers + to a specific page. + format: byte + type: string ResponseContext: "$ref": "#/components/schemas/ResponseContext" type: object @@ -6918,6 +7690,15 @@ components: type: boolean Filters: "$ref": "#/components/schemas/FiltersImage" + NextPageToken: + description: The token to request the next page of results. Each token refers + to a specific page. + format: byte + type: string + ResultsPerPage: + description: The maximum number of logs returned in a single response (between + `1`and `1000`, both included). By default, `100`. + type: integer type: object ReadImagesResponse: additionalProperties: false @@ -6927,6 +7708,11 @@ components: items: "$ref": "#/components/schemas/Image" type: array + NextPageToken: + description: The token to request the next page of results. Each token refers + to a specific page. + format: byte + type: string ResponseContext: "$ref": "#/components/schemas/ResponseContext" type: object @@ -6969,6 +7755,53 @@ components: items: "$ref": "#/components/schemas/Keypair" type: array + ReadLinkedPoliciesFilters: + additionalProperties: false + description: One or more filters. + properties: + PathPrefix: + description: The path prefix of the policies, set to a slash (`/`) by default. + type: string + type: object + ReadLinkedPoliciesRequest: + additionalProperties: false + properties: + DryRun: + description: If true, checks whether you have the required permissions to + perform the action. + type: boolean + Filters: + "$ref": "#/components/schemas/ReadLinkedPoliciesFilters" + FirstItem: + description: The item starting the list of policies requested. + type: integer + ResultsPerPage: + description: The maximum number of items that can be returned in a single + response (by default, 100). + type: integer + UserName: + description: The name of the user the policies are linked to. + type: string + type: object + ReadLinkedPoliciesResponse: + additionalProperties: false + properties: + HasMoreItems: + description: If true, there are more items to return using the `FirstItem` + parameter in a new request. + type: boolean + MaxResultsLimit: + description: Indicates maximum results defined for the operation. + type: integer + MaxResultsTruncated: + description: If true, indicates whether requested page size is more than + allowed. + type: boolean + Policies: + description: One or more policies linked to the specified user. + items: + "$ref": "#/components/schemas/LinkedPolicy" + type: array ResponseContext: "$ref": "#/components/schemas/ResponseContext" type: object @@ -7068,6 +7901,15 @@ components: type: boolean Filters: "$ref": "#/components/schemas/FiltersNatService" + NextPageToken: + description: The token to request the next page of results. Each token refers + to a specific page. + format: byte + type: string + ResultsPerPage: + description: The maximum number of logs returned in a single response (between + `1`and `1000`, both included). By default, `100`. + type: integer type: object ReadNatServicesResponse: additionalProperties: false @@ -7077,6 +7919,11 @@ components: items: "$ref": "#/components/schemas/NatService" type: array + NextPageToken: + description: The token to request the next page of results. Each token refers + to a specific page. + format: byte + type: string ResponseContext: "$ref": "#/components/schemas/ResponseContext" type: object @@ -7110,6 +7957,15 @@ components: type: boolean Filters: "$ref": "#/components/schemas/FiltersNetAccessPoint" + NextPageToken: + description: The token to request the next page of results. Each token refers + to a specific page. + format: byte + type: string + ResultsPerPage: + description: The maximum number of logs returned in a single response (between + `1`and `1000`, both included). By default, `100`. + type: integer type: object ReadNetAccessPointsResponse: additionalProperties: false @@ -7119,6 +7975,11 @@ components: items: "$ref": "#/components/schemas/NetAccessPoint" type: array + NextPageToken: + description: The token to request the next page of results. Each token refers + to a specific page. + format: byte + type: string ResponseContext: "$ref": "#/components/schemas/ResponseContext" type: object @@ -7131,6 +7992,15 @@ components: type: boolean Filters: "$ref": "#/components/schemas/FiltersNetPeering" + NextPageToken: + description: The token to request the next page of results. Each token refers + to a specific page. + format: byte + type: string + ResultsPerPage: + description: The maximum number of logs returned in a single response (between + `1`and `1000`, both included). By default, `100`. + type: integer type: object ReadNetPeeringsResponse: additionalProperties: false @@ -7140,6 +8010,11 @@ components: items: "$ref": "#/components/schemas/NetPeering" type: array + NextPageToken: + description: The token to request the next page of results. Each token refers + to a specific page. + format: byte + type: string ResponseContext: "$ref": "#/components/schemas/ResponseContext" type: object @@ -7185,6 +8060,138 @@ components: ResponseContext: "$ref": "#/components/schemas/ResponseContext" type: object + ReadPoliciesFilters: + additionalProperties: false + description: One or more filters. + properties: + OnlyLinked: + description: If set to true, lists only the policies attached to a user. + type: boolean + PathPrefix: + description: The path prefix you can use to filter the results, set to a + slash (`/`) by default. + type: string + Scope: + description: The scope to filter policies (`ALL` \| `OWS` \| `local`). + enum: + - LOCAL + - OWS + type: string + type: object + ReadPoliciesRequest: + additionalProperties: false + properties: + DryRun: + description: If true, checks whether you have the required permissions to + perform the action. + type: boolean + Filters: + "$ref": "#/components/schemas/ReadPoliciesFilters" + FirstItem: + description: The item starting the list of policies requested. + type: integer + ResultsPerPage: + description: The maximum number of items that can be returned in a single + response (by default, 100). + type: integer + type: object + ReadPoliciesResponse: + additionalProperties: false + properties: + HasMoreItems: + description: If true, there are more items to return using the `FirstItem` + parameter in a new request. + type: boolean + MaxResultsLimit: + description: Indicates maximum results defined for the operation. + type: integer + MaxResultsTruncated: + description: If true, indicates whether requested page size is more than + allowed. + type: boolean + Policies: + description: Information about one or more policies. + items: + "$ref": "#/components/schemas/Policy" + type: array + ResponseContext: + "$ref": "#/components/schemas/ResponseContext" + type: object + ReadPolicyRequest: + additionalProperties: false + properties: + PolicyOrn: + description: The OUTSCALE Resource Name (ORN) of the policy. For more information, + see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). + type: string + required: + - PolicyOrn + type: object + ReadPolicyResponse: + additionalProperties: false + properties: + Policy: + "$ref": "#/components/schemas/Policy" + ResponseContext: + "$ref": "#/components/schemas/ResponseContext" + type: object + ReadPolicyVersionRequest: + additionalProperties: false + properties: + PolicyOrn: + description: The OUTSCALE Resource Name (ORN) of the policy. For more information, + see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). + type: string + VersionId: + description: The ID of the policy version. + type: string + required: + - PolicyOrn + - VersionId + type: object + ReadPolicyVersionResponse: + additionalProperties: false + properties: + PolicyVersion: + "$ref": "#/components/schemas/PolicyVersion" + ResponseContext: + "$ref": "#/components/schemas/ResponseContext" + type: object + ReadPolicyVersionsRequest: + additionalProperties: false + properties: + FirstItem: + description: The item starting the list of policies requested. + type: integer + PolicyOrn: + description: The OUTSCALE Resource Name (ORN) of the policy. For more information, + see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). + type: string + ResultsPerPage: + description: The maximum number of items that can be returned in a single + response (by default, 100). + type: integer + required: + - PolicyOrn + type: object + ReadPolicyVersionsResponse: + additionalProperties: false + properties: + HasMoreItems: + description: If true, there are more items to return using the `FirstItem` + parameter in a new request. + type: boolean + MaxResultsLimit: + description: Indicates maximum results defined for the operation. + type: integer + PolicyVersions: + description: A list of all the versions of the policy. + items: + "$ref": "#/components/schemas/PolicyVersion" + type: array + ResponseContext: + "$ref": "#/components/schemas/ResponseContext" + type: object ReadProductTypesRequest: additionalProperties: false properties: @@ -7251,10 +8258,24 @@ components: type: boolean Filters: "$ref": "#/components/schemas/FiltersPublicIp" + NextPageToken: + description: The token to request the next page of results. Each token refers + to a specific page. + format: byte + type: string + ResultsPerPage: + description: The maximum number of logs returned in a single response (between + `1`and `1000`, both included). By default, `100`. + type: integer type: object ReadPublicIpsResponse: additionalProperties: false properties: + NextPageToken: + description: The token to request the next page of results. Each token refers + to a specific page. + format: byte + type: string PublicIps: description: Information about one or more public IPs. items: @@ -7312,10 +8333,24 @@ components: type: boolean Filters: "$ref": "#/components/schemas/FiltersRouteTable" + NextPageToken: + description: The token to request the next page of results. Each token refers + to a specific page. + format: byte + type: string + ResultsPerPage: + description: The maximum number of logs returned in a single response (between + `1`and `1000`, both included). By default, `100`. + type: integer type: object ReadRouteTablesResponse: additionalProperties: false properties: + NextPageToken: + description: The token to request the next page of results. Each token refers + to a specific page. + format: byte + type: string ResponseContext: "$ref": "#/components/schemas/ResponseContext" RouteTables: @@ -7520,10 +8555,24 @@ components: type: boolean Filters: "$ref": "#/components/schemas/FiltersVirtualGateway" + NextPageToken: + description: The token to request the next page of results. Each token refers + to a specific page. + format: byte + type: string + ResultsPerPage: + description: The maximum number of logs returned in a single response (between + `1`and `1000`, both included). By default, `100`. + type: integer type: object ReadVirtualGatewaysResponse: additionalProperties: false properties: + NextPageToken: + description: The token to request the next page of results. Each token refers + to a specific page. + format: byte + type: string ResponseContext: "$ref": "#/components/schemas/ResponseContext" VirtualGateways: @@ -7541,7 +8590,6 @@ components: type: boolean Filters: "$ref": "#/components/schemas/FiltersVmGroup" - description: ReadVmGroupsRequest_Filters type: object ReadVmGroupsResponse: additionalProperties: false @@ -7634,10 +8682,24 @@ components: type: boolean Filters: "$ref": "#/components/schemas/FiltersVm" + NextPageToken: + description: The token to request the next page of results. Each token refers + to a specific page. + format: byte + type: string + ResultsPerPage: + description: The maximum number of logs returned in a single response (between + `1`and `1000`, both included). By default, `100`. + type: integer type: object ReadVmsResponse: additionalProperties: false properties: + NextPageToken: + description: The token to request the next page of results. Each token refers + to a specific page. + format: byte + type: string ResponseContext: "$ref": "#/components/schemas/ResponseContext" Vms: @@ -7681,10 +8743,24 @@ components: type: boolean Filters: "$ref": "#/components/schemas/FiltersVolume" + NextPageToken: + description: The token to request the next page of results. Each token refers + to a specific page. + format: byte + type: string + ResultsPerPage: + description: The maximum number of logs returned in a single response (between + `1`and `1000`, both included). By default, `100`. + type: integer type: object ReadVolumesResponse: additionalProperties: false properties: + NextPageToken: + description: The token to request the next page of results. Each token refers + to a specific page. + format: byte + type: string ResponseContext: "$ref": "#/components/schemas/ResponseContext" Volumes: @@ -7702,10 +8778,24 @@ components: type: boolean Filters: "$ref": "#/components/schemas/FiltersVpnConnection" + NextPageToken: + description: The token to request the next page of results. Each token refers + to a specific page. + format: byte + type: string + ResultsPerPage: + description: The maximum number of logs returned in a single response (between + `1`and `1000`, both included). By default, `100`. + type: integer type: object ReadVpnConnectionsResponse: additionalProperties: false properties: + NextPageToken: + description: The token to request the next page of results. Each token refers + to a specific page. + format: byte + type: string ResponseContext: "$ref": "#/components/schemas/ResponseContext" VpnConnections: @@ -7792,30 +8882,6 @@ components: ResponseContext: "$ref": "#/components/schemas/ResponseContext" type: object - ResetAccountPasswordRequest: - additionalProperties: false - properties: - DryRun: - description: If true, checks whether you have the required permissions to - perform the action. - type: boolean - Password: - description: The new password for the account. - type: string - Token: - description: The token you received at the email address provided for the - account. - type: string - required: - - Password - - Token - type: object - ResetAccountPasswordResponse: - additionalProperties: false - properties: - ResponseContext: - "$ref": "#/components/schemas/ResponseContext" - type: object ResourceLoadBalancerTag: additionalProperties: false description: Information about the tag. @@ -7992,7 +9058,7 @@ components: description: Information about the security group. properties: AccountId: - description: The account ID of a user that has been granted permission. + description: The account ID that has been granted permission. type: string Description: description: The description of the security group. @@ -8086,25 +9152,6 @@ components: group that you want to link to the security group of the rule." type: string type: object - SendResetPasswordEmailRequest: - additionalProperties: false - properties: - DryRun: - description: If true, checks whether you have the required permissions to - perform the action. - type: boolean - Email: - description: The email address provided for the account. - type: string - required: - - Email - type: object - SendResetPasswordEmailResponse: - additionalProperties: false - properties: - ResponseContext: - "$ref": "#/components/schemas/ResponseContext" - type: object ServerCertificate: additionalProperties: false description: Information about the server certificate. @@ -8148,6 +9195,26 @@ components: description: The name of the service. type: string type: object + SetDefaultPolicyVersionRequest: + additionalProperties: false + properties: + PolicyOrn: + description: The OUTSCALE Resource Name (ORN) of the policy. For more information, + see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). + type: string + VersionId: + description: The ID of the version. + type: string + required: + - PolicyOrn + - VersionId + type: object + SetDefaultPolicyVersionResponse: + additionalProperties: false + properties: + ResponseContext: + "$ref": "#/components/schemas/ResponseContext" + type: object Snapshot: additionalProperties: false description: Information about the snapshot. @@ -8355,8 +9422,7 @@ components: description: The name of the Region containing the Subregion. type: string State: - description: The state of the Subregion (`available` \| `information` \| - `impaired` \| `unavailable`). + description: The state of the Subregion. type: string SubregionName: description: The name of the Subregion. @@ -8470,6 +9536,30 @@ components: ResponseContext: "$ref": "#/components/schemas/ResponseContext" type: object + UnlinkPolicyRequest: + additionalProperties: false + properties: + DryRun: + description: If true, checks whether you have the required permissions to + perform the action. + type: boolean + PolicyOrn: + description: The OUTSCALE Resource Name (ORN) of the policy. For more information, + see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). + type: string + UserName: + description: The name of the user you want to detach the policy from. + type: string + required: + - PolicyOrn + - UserName + type: object + UnlinkPolicyResponse: + additionalProperties: false + properties: + ResponseContext: + "$ref": "#/components/schemas/ResponseContext" + type: object UnlinkPrivateIpsRequest: additionalProperties: false properties: @@ -8607,9 +9697,10 @@ components: requests. When set to `INACTIVE`, the access key is disabled. type: string UserName: - description: The name of the EIM the access key you want to modify is associated - with. If you do not specify a user name, this action modifies the access - key of the user who sends the request (which can be the root account). + description: The name of the EIM user that the access key you want to modify + is associated with. If you do not specify a user name, this action modifies + the access key of the user who sends the request (which can be the root + account). type: string required: - AccessKeyId @@ -8702,9 +9793,9 @@ components: format: int64 type: integer RequireTrustedEnv: - description: If true, a trusted session is activated, provided that you - specify the `MaxAccessKeyExpirationSeconds` parameter with a value greater - than `0`. + description: |- + If true, a trusted session is activated, provided that you specify the `MaxAccessKeyExpirationSeconds` parameter with a value greater than `0`.
+ Enabling this will require you and all your users to log in to Cockpit v2 using the WebAuthn method for multi-factor authentication. For more information, see [About Authentication > Multi-Factor Authentication](https://docs.outscale.com/en/userguide/About-Authentication.html#_multi_factor_authentication). type: boolean required: - MaxAccessKeyExpirationSeconds @@ -8781,6 +9872,31 @@ components: ResponseContext: "$ref": "#/components/schemas/ResponseContext" type: object + UpdateDedicatedGroupRequest: + additionalProperties: false + properties: + DedicatedGroupId: + description: The ID of the dedicated group you want to update. + type: string + DryRun: + description: If true, checks whether you have the required permissions to + perform the action. + type: boolean + Name: + description: The new name of the dedicated group. + type: string + required: + - DedicatedGroupId + - Name + type: object + UpdateDedicatedGroupResponse: + additionalProperties: false + properties: + DedicatedGroup: + "$ref": "#/components/schemas/DedicatedGroup" + ResponseContext: + "$ref": "#/components/schemas/ResponseContext" + type: object UpdateDirectLinkInterfaceRequest: additionalProperties: false properties: @@ -9098,22 +10214,48 @@ components: description: The ID of a network interface card (NIC). type: string RouteTableId: - description: The ID of the route table. - type: string - VmId: - description: The ID of a NAT VM in your Net. + description: The ID of the route table. + type: string + VmId: + description: The ID of a NAT VM in your Net. + type: string + required: + - RouteTableId + - DestinationIpRange + type: object + UpdateRouteResponse: + additionalProperties: false + properties: + ResponseContext: + "$ref": "#/components/schemas/ResponseContext" + RouteTable: + "$ref": "#/components/schemas/RouteTable" + type: object + UpdateRouteTableLinkRequest: + additionalProperties: false + properties: + DryRun: + description: If true, checks whether you have the required permissions to + perform the action. + type: boolean + LinkRouteTableId: + description: The ID of the current route table link. + type: string + RouteTableId: + description: The ID of the new route table to associate with the Subnet. type: string required: - RouteTableId - - DestinationIpRange + - LinkRouteTableId type: object - UpdateRouteResponse: + UpdateRouteTableLinkResponse: additionalProperties: false properties: + LinkRouteTableId: + description: The ID of the association between the route table and the Subnet. + type: string ResponseContext: "$ref": "#/components/schemas/ResponseContext" - RouteTable: - "$ref": "#/components/schemas/RouteTable" type: object UpdateServerCertificateRequest: additionalProperties: false @@ -9282,7 +10424,7 @@ components: KeypairName: description: |- The name of a keypair you want to associate with the VM.
- When you replace the keypair of a VM with another one, the metadata of the VM is modified to reflect the new public key, but the replacement is still not effective in the operating system of the VM. To complete the replacement and effectively apply the new keypair, you need to perform other actions inside the VM. For more information, see [Modifying the Keypair of an Instance](https://docs.outscale.com/en/userguide/Modifying-the-Keypair-of-an-Instance.html). + When you replace the keypair of a VM with another one, the metadata of the VM is modified to reflect the new public key, but the replacement is still not effective in the operating system of the VM. To complete the replacement and effectively apply the new keypair, you need to perform other actions inside the VM. For more information, see [Modifying the Keypair of a VM](https://docs.outscale.com/en/userguide/Modifying-the-Keypair-of-a-VM.html). type: string NestedVirtualization: description: "(dedicated tenancy only) If true, nested virtualization is @@ -9313,7 +10455,7 @@ components: If set to `terminate`, the VM stops and is terminated. type: string VmType: - description: The type of VM. For more information, see [Instance Types](https://docs.outscale.com/en/userguide/Instance-Types.html). + description: The type of VM. For more information, see [VM Types](https://docs.outscale.com/en/userguide/VM-Types.html). type: string required: - VmId @@ -9366,24 +10508,23 @@ components: perform the action. type: boolean Iops: - description: The new number of I/O operations per second (IOPS). This parameter - can be specified only if you update an `io1` volume. The maximum number - of IOPS allowed for `io1` volumes is `13000` with a maximum performance - ratio of 300 IOPS per gibibyte. This modification is instantaneous on - a cold volume, not on a hot one. + description: |- + **Cold volume**: the new number of I/O operations per second (IOPS). This parameter can be specified only if you update an `io1` volume or if you change the type of the volume for an `io1`. This modification is instantaneous.
+ **Hot volume**: the new number of I/O operations per second (IOPS). This parameter can be specified only if you update an `io1` volume. This modification is not instantaneous.

+ The maximum number of IOPS allowed for `io1` volumes is `13000` with a maximum performance ratio of 300 IOPS per gibibyte. type: integer Size: - description: "(cold volume only) The new size of the volume, in gibibytes - (GiB). This value must be equal to or greater than the current size of - the volume. This modification is not instantaneous." + description: |- + **Cold volume**: the new size of the volume, in gibibytes (GiB). This value must be equal to or greater than the current size of the volume. This modification is not instantaneous.
+ **Hot volume**: you cannot change the size of a hot volume. type: integer VolumeId: description: The ID of the volume you want to update. type: string VolumeType: - description: "(cold volume only) The new type of the volume (`standard` - \\| `io1` \\| `gp2`). This modification is instantaneous. If you update - to an `io1` volume, you must also specify the `Iops` parameter." + description: |- + **Cold volume**: the new type of the volume (`standard` \| `io1` \| `gp2`). This modification is instantaneous. If you update to an `io1` volume, you must also specify the `Iops` parameter.
+ **Hot volume**: you cannot change the type of a hot volume. type: string required: - VolumeId @@ -9413,7 +10554,7 @@ components: description: The ID of the VPN connection you want to modify. type: string VpnOptions: - "$ref": "#/components/schemas/VpnOptions" + "$ref": "#/components/schemas/VpnOptionsToUpdate" required: - VpnConnectionId type: object @@ -9575,7 +10716,7 @@ components: description: The reservation ID of the VM. type: string RootDeviceName: - description: The name of the root device for the VM (for example, `/dev/vda1`). + description: The name of the root device for the VM (for example, `/dev/sda1`). type: string RootDeviceType: description: The type of root device used by the VM (always `bsu`). @@ -9612,7 +10753,7 @@ components: If set to `terminate`, the VM stops and is deleted. type: string VmType: - description: The type of VM. For more information, see [Instance Types](https://docs.outscale.com/en/userguide/Instance-Types.html). + description: The type of VM. For more information, see [VM Types](https://docs.outscale.com/en/userguide/VM-Types.html). type: string type: object VmGroup: @@ -9775,6 +10916,15 @@ components: description: This parameter is not available. It is present in our API for the sake of historical compatibility with AWS. type: boolean + EphemeralsType: + description: The type of ephemeral storage disk. + type: string + Eth: + description: The number of Ethernet interface available. + type: integer + Gpu: + description: The number of GPU available. + type: integer MaxPrivateIps: description: The maximum number of private IPs per network interface card (NIC). @@ -9904,6 +11054,17 @@ components: CIDR block from the 169.254.254.0/24 range. type: string type: object + VpnOptionsToUpdate: + additionalProperties: false + description: Information about the VPN options. + properties: + Phase2Options: + "$ref": "#/components/schemas/Phase2OptionsToUpdate" + TunnelInsideIpRange: + description: The range of inside IPs for the tunnel. This must be a /30 + CIDR block from the 169.254.254.0/24 range. + type: string + type: object With: additionalProperties: false description: The information to display in each returned log. @@ -10006,25 +11167,61 @@ components: info: contact: email: support@outscale.com - description: |- - Welcome to the OUTSCALE API documentation.
- The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

- You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

- Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
- You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

- An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + description: "Welcome to the OUTSCALE API documentation.
\nThe OUTSCALE API + enables you to manage your resources in the OUTSCALE Cloud. This documentation + describes the different actions available along with code examples.

\nThrottling: + To protect against overloads, the number of identical requests allowed in a given + time period is limited.
\nBrute force: To protect against brute force attacks, + the number of failed authentication attempts in a given time period is limited.

\nYou can learn more about errors returned by the API in the dedicated + [errors page](api/errors).

\nNote that the OUTSCALE Cloud is compatible + with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) + between AWS and the OUTSCALE API.
\nYou can also manage your resources using + the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

\nAn OpenAPI description of the OUTSCALE API is also available in this + [GitHub repository](https://github.com/outscale/osc-api).
\n# Authentication + Schemes\n### Access Key/Secret Key\nThe main way to authenticate your requests + to the OUTSCALE API is to use an access key and a secret key.
\nThe mechanism + behind this is based on AWS Signature Version 4, whose technical implementation + details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

\nIn practice, the way to specify your access key and secret key depends + on the tool or SDK you want to use to interact with the API.
\n\n> For example, + if you use OSC CLI:\n> 1. You need to create an **~/.osc/config.json** file to + specify your access key, secret key, and the Region of your account.\n> 2. You + then specify the `--profile` option when executing OSC CLI commands.\n> \n> For + more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html).\n\nSee + the code samples in each section of this documentation for specific examples in + different programming languages.
\nFor more information about access keys, + see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html).\n### + Login/Password\nFor certain API actions, you can also use basic authentication + with the login (email address) and password of your TINA account.
\nThis + is useful only in special circumstances, for example if you do not know your access + key/secret key and want to retrieve them programmatically.
\nIn most cases, + however, you can use the Cockpit web interface to retrieve them.
\n\n> For + example, if you use OSC CLI:\n> 1. You need to create an **~/.osc/config.json** + file to specify the Region of your account, but you leave the access key value + and secret key value empty (`""`).\n> 2. You then specify the `--profile`, + `--authentication-method`, `--login`, and `--password` options when executing + OSC CLI commands.\n\nSee the code samples in each section of this documentation + for specific examples in different programming languages.\n### No Authentication\nA + few API actions do not require any authentication. They are indicated as such + in this documentation.
\n### Other Security Mechanisms\nIn parallel with + the authentication schemes, you can add other security mechanisms to your OUTSCALE + account, for example to restrict API requests by IP or other criteria.
\nFor + more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html)." license: name: BSD 3 Clause url: https://opensource.org/licenses/BSD-3-Clause termsOfService: https://en.outscale.com/terms-of-service/ title: 3DS OUTSCALE API - version: '1.27' + version: 1.28.5 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: @@ -10034,12 +11231,35 @@ paths: application/json: schema: "$ref": "#/components/schemas/AcceptNetPeeringRequest" + examples: + ex1: + value: + NetPeeringId: pcx-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/AcceptNetPeeringResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + NetPeering: + Tags: [] + SourceNet: + NetId: vpc-12345678 + IpRange: 10.0.0.0/16 + AccountId: '123456789012' + NetPeeringId: pcx-12345678 + AccepterNet: + NetId: vpc-12345678 + IpRange: 172.16.0.0/16 + AccountId: '123456789012' + State: + Name: active + Message: Active description: The HTTP 200 response (OK). '400': content: @@ -10076,18 +11296,29 @@ paths: application/json: schema: "$ref": "#/components/schemas/CheckAuthenticationRequest" + examples: + ex1: + value: + Login: example@example.com + Password: "$OSC_PASSWORD" responses: '200': content: application/json: schema: "$ref": "#/components/schemas/CheckAuthenticationResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 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`. + 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: operationId: CreateAccessKey requestBody: @@ -10095,12 +11326,28 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateAccessKeyRequest" + examples: + ex1: + value: + ExpirationDate: '2063-04-05' 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 + SecretKey: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + LastModificationDate: 2010-10-01 12:34:56.789000000 +00:00 description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -10111,9 +11358,11 @@ paths: description: |- Creates an OUTSCALE account.

- **[NOTE]**
+ **[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: operationId: CreateAccount requestBody: @@ -10121,12 +11370,37 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateAccountRequest" + examples: + ex1: + value: + City: SAINT-CLOUD + CompanyName: EXAMPLE SAS + Country: FRANCE + CustomerId: '87654321' + Email: example@example.com + FirstName: JEAN + LastName: DUPONT + ZipCode: '92210' responses: '200': content: application/json: schema: "$ref": "#/components/schemas/CreateAccountResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Account: + ZipCode: '92210' + CompanyName: EXAMPLE SAS + FirstName: JEAN + City: SAINT-CLOUD + Country: FRANCE + LastName: DUPONT + AccountId: '123456789012' + Email: example@example.com description: The HTTP 200 response (OK). tags: - Account @@ -10136,7 +11410,8 @@ paths: 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). + 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: operationId: CreateApiAccessRule requestBody: @@ -10144,12 +11419,59 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateApiAccessRuleRequest" + examples: + ex1: + summary: Creating an API access rule based on IPs + value: + 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: + IpRanges: + - 192.0.2.0 + - 198.51.100.0/24 + 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 + 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 description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -10157,7 +11479,9 @@ paths: tags: - ApiAccessRule "/CreateCa": - description: Creates a Client Certificate Authority (CA). + 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: operationId: CreateCa requestBody: @@ -10165,12 +11489,26 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateCaRequest" + examples: + ex1: + value: + CaPem: XXXX + Description: CA example responses: '200': content: application/json: schema: "$ref": "#/components/schemas/CreateCaResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Ca: + Description: CA example + CaId: ca-fedcba0987654321fedcba0987654321 + CaFingerprint: 1234567890abcdef1234567890abcdef12345678 description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -10181,7 +11519,8 @@ paths: 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). + 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: operationId: CreateClientGateway requestBody: @@ -10189,18 +11528,97 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateClientGatewayRequest" + examples: + ex1: + value: + ConnectionType: ipsec.1 + PublicIp: 192.0.2.0 + 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 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: + operationId: CreateDedicatedGroup + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/CreateDedicatedGroupRequest" + examples: + ex1: + value: + CpuGeneration: 4 + Name: dedicated-group-example + SubregionName: eu-west-2a + 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 + Name: dedicated-group-example + SubregionName: eu-west-2a + DedicatedGroupId: ded-12345678 + description: The HTTP 200 response (OK). + '400': + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + description: The HTTP 400 response (Bad Request). + '401': + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + description: The HTTP 401 response (Unauthorized). + '500': + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + description: The HTTP 500 response (Internal Server Error). + tags: + - DedicatedGroup "/CreateDhcpOptions": - description: Creates a set of DHCP options, that you can then associate with a - Net using the [UpdateNet](#updatenet) method. + 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: operationId: CreateDhcpOptions requestBody: @@ -10208,18 +11626,45 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateDhcpOptionsRequest" + examples: + ex1: + value: + DomainName: example.com + DomainNameServers: + - 192.0.2.0 + - 198.51.100.0 + NtpServers: + - 203.0.113.0 + - 203.0.113.1 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 description: The HTTP 200 response (OK). tags: - DhcpOption "/CreateDirectLink": - description: Creates a DirectLink between a customer network and a specified DirectLink - location. + 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: operationId: CreateDirectLink requestBody: @@ -10227,19 +11672,39 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateDirectLinkRequest" + examples: + ex1: + value: + Location: PAR1 + Bandwidth: 1Gbps + DirectLinkName: Connection to Outscale 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 + DirectLinkId: dxcon-12345678 + DirectLinkName: Connection to Outscale + Location: PAR1 + RegionName: eu-west-2 + State: requested 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. + 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: operationId: CreateDirectLinkInterface requestBody: @@ -10247,19 +11712,51 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateDirectLinkInterfaceRequest" + examples: + ex1: + value: + DirectLinkId: dxcon-12345678 + DirectLinkInterface: + DirectLinkInterfaceName: MyDirectLinkInterface + Vlan: 101 + BgpAsn: 65000 + BgpKey: tgyn26example + OutscalePrivateIp: 172.16.0.4/30 + ClientPrivateIp: 172.16.0.5/30 + VirtualGatewayId: vgw-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/CreateDirectLinkInterfaceResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + DirectLinkInterface: + Vlan: 101 + OutscalePrivateIp: 172.16.0.4/30 + DirectLinkInterfaceId: dxvif-12345678 + BgpAsn: 65000 + AccountId: '123456789012' + ClientPrivateIp: 172.16.0.5/30 + VirtualGatewayId: vgw-12345678 + DirectLinkInterfaceName: MyDirectLinkInterface + DirectLinkId: dxcon-12345678 + Mtu: 1500 + State: pending + 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). + 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: operationId: CreateFlexibleGpu requestBody: @@ -10267,28 +11764,48 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateFlexibleGpuRequest" + examples: + ex1: + value: + ModelName: nvidia-p100 + Generation: v5 + SubregionName: eu-west-2a + 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 + Generation: v5 + ModelName: nvidia-p100 + State: allocated + FlexibleGpuId: fgpu-12345678 description: The HTTP 200 response (OK). tags: - FlexibleGpu "/CreateImage": description: |- - Creates an OUTSCALE machine image (OMI) from an existing virtual machine (VM) which is either running or stopped.
- This action also creates a snapshot of the root volume of the VM, as well as a snapshot of each Block Storage Unit (BSU) volume attached to the VM. For more information, see [About OMIs](https://docs.outscale.com/en/userguide/About-OMIs.html).

+ Creates an OUTSCALE machine image (OMI).
+ You can use this method in different ways: + * **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 or Access Control Lists. For more information, see [Managing Access to Your Buckets and Objects](https://docs.outscale.com/en/userguide/Managing-Access-to-Your-Buckets-and-Objects.html).
+ * **Registering from a bucket without using a manifest file**: This is similar to the previous case but you manually specify all the information that would be in a manifest file instead of using a manifest file. - You can also use this method to copy an OMI to your account, from an account in the same Region. To do so, the owner of the source OMI must share it with your account. For more information about how to share an OMI with another account in the same Region, see [UpdateImage](#updateimage).
- To copy an OMI between accounts in different Regions, the owner of the source OMI must first export it to an OUTSCALE Object Storage (OOS) bucket using the [CreateImageExportTask](#createimageexporttask) method, and then you need to create a copy of the image in your account.
- The copy of the source OMI is independent and belongs to you.

+ **[TIP]**
+ Registering from a bucket enables you to copy an OMI across Regions. - You can also use this method to register an OMI to finalize its creation process.
- You can register an OMI from a snapshot of a root device to create an OMI based on this snapshot. You can also register an OMI that has been exported to an S3-compatible bucket to create a copy of it in your account. For more information about OMI export to an OOS bucket, see [CreateImageExportTask](#createimageexporttask).
- You can register an OMI using a pre-signed URL of the manifest file of the OMI. You do not need any permission for this OMI, or the bucket in which it is contained. The manifest file is obsolete seven days after a completed export as it contains pre-signed URLs to the appropriate snapshots (pre-signed URLs are valid for only seven days).
- Once the OMI is registered, you can launch a VM from this OMI. The copy of the source OMI is independent and belongs to you. + For more information, see [About OMIs](https://docs.outscale.com/en/userguide/About-OMIs.html). post: operationId: CreateImage requestBody: @@ -10296,12 +11813,169 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateImageRequest" + examples: + ex1: + summary: Creating from a VM + value: + ImageName: create-image-example + VmId: i-12345678 + NoReboot: true + ex2: + summary: Copying an OMI + value: + ImageName: copy-image-example + SourceImageId: ami-12345678 + SourceRegionName: eu-west-2 + ex3: + summary: Registering from a snapshot + value: + ImageName: register-image-from-snapshot-example + BlockDeviceMappings: + - DeviceName: "/dev/sda1" + Bsu: + SnapshotId: snap-12345678 + VolumeSize: 120 + VolumeType: io1 + Iops: 150 + DeleteOnVmDeletion: true + RootDeviceName: "/dev/sda1" + ex4: + summary: Registering from a bucket by using a manifest file + value: + ImageName: register-image-from-bucket-example + 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' + Tags: [] + Description: '' + ImageId: ami-12345678 + BlockDeviceMappings: + - DeviceName: "/dev/sda1" + Bsu: + VolumeType: standard + DeleteOnVmDeletion: true + VolumeSize: 50 + SnapshotId: snap-12345678 + ImageType: machine + CreationDate: '2010-10-01T12:34:56.789Z' + FileLocation: 123456789012/create-image-example + Architecture: x86_64 + ImageName: create-image-example + 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' + Tags: [] + Description: '' + ImageId: ami-12345678 + BlockDeviceMappings: + - DeviceName: "/dev/sda1" + Bsu: + VolumeType: standard + DeleteOnVmDeletion: true + VolumeSize: 50 + SnapshotId: snap-12345678 + ImageType: machine + CreationDate: '2010-10-01T12:34:56.789Z' + FileLocation: 123456789012/copy-image-example + Architecture: x86_64 + ImageName: copy-image-example + 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' + Tags: [] + Description: '' + ImageId: ami-12345678 + BlockDeviceMappings: + - DeviceName: "/dev/sda1" + Bsu: + VolumeType: io1 + DeleteOnVmDeletion: true + VolumeSize: 120 + Iops: 150 + SnapshotId: snap-12345678 + ImageType: machine + CreationDate: '2010-10-01T12:34:56.789Z' + FileLocation: 123456789012/register-image-from-snapshot-example + Architecture: x86_64 + ImageName: register-image-from-snapshot-example + 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' + Tags: [] + Description: '' + ImageId: ami-12345678 + BlockDeviceMappings: + - DeviceName: "/dev/sda1" + Bsu: + VolumeType: standard + DeleteOnVmDeletion: true + VolumeSize: 50 + SnapshotId: snap-12345678 + ImageType: machine + CreationDate: '2010-10-01T12:34:56.789Z' + FileLocation: https://oos.eu-west-2.outscale.com/BUCKET/KEY?AWSAccessKeyId=ABCDEFGHIJ0123456789&Expires=1493372309&Signature=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + Architecture: x86_64 + ImageName: register-image-from-bucket-example description: The HTTP 200 response (OK). '400': content: @@ -10329,8 +12003,9 @@ paths: This action enables you to copy an OMI between accounts in different Regions. To copy an OMI in the same Region, you can also use the [CreateImage](#createimage) method.
The copy of the OMI belongs to you and is independent from the source OMI.

- **[NOTE]**
- 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. + **[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: operationId: CreateImageExportTask requestBody: @@ -10338,19 +12013,44 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateImageExportTaskRequest" + examples: + ex1: + value: + ImageId: ami-12345678 + OsuExport: + DiskImageFormat: qcow2 + OsuBucket: BUCKET + OsuPrefix: PREFIX responses: '200': content: application/json: schema: "$ref": "#/components/schemas/CreateImageExportTaskResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ImageExportTask: + Tags: [] + ImageId: ami-12345678 + TaskId: image-export-12345678 + Comment: Export of image ami-12345678 + OsuExport: + OsuPrefix: PREFIX/ami-12345678/ + OsuBucket: BUCKET + DiskImageFormat: qcow2 + State: pending/queued + 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 your virtual machines (VMs) launched in a Net to connect to the Internet. By default, a Net includes an Internet service, and each Subnet is public. Every VM launched within a default Subnet has a private IP and a public IP. + An Internet service enables your virtual machines (VMs) launched in a Net to connect to the Internet. By default, a Net includes an Internet service, and each Subnet is public. Every VM launched within a default Subnet has a private IP and a public IP.

+ For more information, see [About Internet Services](https://docs.outscale.com/en/userguide/About-Internet-Services.html). post: operationId: CreateInternetService requestBody: @@ -10358,12 +12058,23 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateInternetServiceRequest" + examples: + ex1: + value: {} responses: '200': content: application/json: schema: "$ref": "#/components/schemas/CreateInternetServiceResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + InternetService: + Tags: [] + InternetServiceId: igw-12345678 description: The HTTP 200 response (OK). '400': content: @@ -10387,11 +12098,13 @@ paths: - InternetService "/CreateKeypair": description: |- - Creates a 2048-bit RSA keypair with a specified name.
- This action returns the private key that you need to save. The public key is stored by 3DS OUTSCALE.

+ 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), ECDSA (256 bits), and Ed25519. The following formats can be used: PEM, PKCS8, RFC4716, and OpenSSH. - You can also import a public key. The following types of key can be imported: RSA (minimum 2048 bits, recommended 4096 bits), ECDSA (minimum and recommended 256 bits), and Ed25519. The following formats can be used: PEM, PKCS8, RFC4716, and OpenSSH.
- This action imports the public key of a keypair created by a third-party tool and uses it to create a keypair. The private key is never provided to 3DS OUTSCALE. + For more information, see [About Keypairs](https://docs.outscale.com/en/userguide/About-Keypairs.html). post: operationId: CreateKeypair requestBody: @@ -10399,12 +12112,43 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateKeypairRequest" + examples: + ex1: + summary: Creating a keypair + value: + KeypairName: create-keypair-example + ex2: + summary: Importing a keypair created locally + value: + KeypairName: import-keypair-example + PublicKey: "..." 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: + PrivateKey: |- + -----BEGIN RSA PRIVATE KEY----- + ... + -----END RSA PRIVATE KEY----- + KeypairName: create-keypair-example + 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: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Keypair: + KeypairName: create-keypair-example + 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: @@ -10435,7 +12179,8 @@ paths: "/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. + 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: operationId: CreateListenerRule requestBody: @@ -10443,12 +12188,68 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateListenerRuleRequest" + examples: + ex1: + summary: Creating a listener rule based on a host pattern + value: + Listener: + LoadBalancerName: example-lbu + LoadBalancerPort: 80 + ListenerRule: + Action: forward + HostNamePattern: "*.example.com" + ListenerRuleName: example-listener-rule + Priority: 10 + VmIds: + - i-12345678 + ex2: + summary: Creating a listener rule based on a path pattern + value: + Listener: + LoadBalancerName: example-lbu + LoadBalancerPort: 80 + ListenerRule: + Action: forward + PathPattern: "/docs/*" + ListenerRuleName: example-listener-rule + Priority: 100 + VmIds: + - i-12345678 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: + Priority: 10 + VmIds: + - i-12345678 + 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: + Priority: 100 + VmIds: + - i-12345678 + ListenerRuleName: example-listener-rule + Action: forward + ListenerId: 123456 + PathPattern: "/docs/*" + ListenerRuleId: 1234 description: The HTTP 200 response (OK). tags: - Listener @@ -10457,7 +12258,8 @@ paths: 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. + 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: operationId: CreateLoadBalancer requestBody: @@ -10465,17 +12267,178 @@ paths: 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 + 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 + 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 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: + PublicationInterval: 60 + 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 + LoadBalancerStickyCookiePolicies: [] + SubregionNames: + - eu-west-2a + Listeners: + - BackendPort: 80 + BackendProtocol: TCP + LoadBalancerPort: 80 + LoadBalancerProtocol: TCP + LoadBalancerName: private-lb-example + ex2: + summary: Creating an internet-facing load balancer in a Net + 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: + 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 + 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: + PublicationInterval: 60 + 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 + LoadBalancerStickyCookiePolicies: [] + SubregionNames: + - eu-west-2a + Listeners: + - BackendPort: 8080 + BackendProtocol: HTTP + LoadBalancerPort: 8080 + LoadBalancerProtocol: HTTP + LoadBalancerName: public-lb-example description: The HTTP 200 response (OK). tags: - LoadBalancer "/CreateLoadBalancerListeners": - description: Creates one or more listeners for a specified load balancer. + 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: operationId: CreateLoadBalancerListeners requestBody: @@ -10483,12 +12446,64 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateLoadBalancerListenersRequest" + examples: + ex1: + value: + LoadBalancerName: example-lbu + Listeners: + - BackendPort: 58 + BackendProtocol: TCP + LoadBalancerPort: 62 + LoadBalancerProtocol: TCP 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: + PublicationInterval: 60 + 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 + LoadBalancerStickyCookiePolicies: [] + SubregionNames: + - eu-west-2a + Listeners: + - BackendPort: 58 + BackendProtocol: TCP + LoadBalancerPort: 62 + LoadBalancerProtocol: TCP + - BackendPort: 80 + BackendProtocol: TCP + LoadBalancerPort: 80 + LoadBalancerProtocol: TCP + LoadBalancerName: example-lbu description: The HTTP 200 response (OK). tags: - Listener @@ -10500,7 +12515,8 @@ paths: 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. + 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: operationId: CreateLoadBalancerPolicy requestBody: @@ -10508,19 +12524,115 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateLoadBalancerPolicyRequest" + examples: + ex1: + summary: Creating a load balancer policy based on browser + value: + LoadBalancerName: example-lbu + PolicyName: example-browser-policy + PolicyType: load_balancer + ex2: + summary: Creating a load balancer policy based on application cookie + value: + LoadBalancerName: example-lbu + PolicyName: example-app-policy + PolicyType: app + 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: + PublicationInterval: 60 + 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 + LoadBalancerStickyCookiePolicies: + - PolicyName: example-browser-policy + CookieExpirationPeriod: 1 + SubregionNames: + - eu-west-2a + Listeners: + - BackendPort: 80 + BackendProtocol: HTTP + LoadBalancerPort: 80 + LoadBalancerProtocol: HTTP + LoadBalancerName: example-lbu + 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: + PublicationInterval: 60 + 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 + LoadBalancerStickyCookiePolicies: [] + SubregionNames: + - eu-west-2a + Listeners: + - BackendPort: 80 + BackendProtocol: HTTP + LoadBalancerPort: 80 + LoadBalancerProtocol: HTTP + LoadBalancerName: example-lbu 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. + 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: operationId: CreateLoadBalancerTags requestBody: @@ -10528,12 +12640,25 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateLoadBalancerTagsRequest" + examples: + ex1: + value: + LoadBalancerNames: + - private-lb-example + Tags: + - Key: key1 + Value: value1 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/CreateLoadBalancerTagsResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - LoadBalancer @@ -10544,8 +12669,9 @@ paths: 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).

- **[NOTE]**
- 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. + **[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: operationId: CreateNatService requestBody: @@ -10553,12 +12679,31 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateNatServiceRequest" + examples: + ex1: + value: + SubnetId: subnet-12345678 + PublicIpId: eipalloc-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/CreateNatServiceResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + NatService: + Tags: [] + SubnetId: subnet-12345678 + NatServiceId: nat-12345678 + PublicIps: + - PublicIpId: eipalloc-12345678 + PublicIp: 192.0.2.0 + NetId: vpc-12345678 + State: available description: The HTTP 200 response (OK). '400': content: @@ -10583,7 +12728,8 @@ paths: "/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). + 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: operationId: CreateNet requestBody: @@ -10591,12 +12737,28 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateNetRequest" + examples: + ex1: + value: + IpRange: 10.0.0.0/16 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 description: The HTTP 200 response (OK). '400': content: @@ -10628,7 +12790,8 @@ paths: 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. + 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.

+ For more information, see [About Net Access Points](https://docs.outscale.com/en/userguide/About-Net-Access-Points.html). post: operationId: CreateNetAccessPoint requestBody: @@ -10636,12 +12799,32 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateNetAccessPointRequest" + examples: + ex1: + value: + NetId: vpc-12345678 + RouteTableIds: + - rtb-12345678 + ServiceName: com.outscale.eu-west-2.oos 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 + RouteTableIds: + - rtb-12345678 + State: pending + NetId: vpc-12345678 + ServiceName: com.outscale.eu-west-2.oos description: The HTTP 200 response (OK). tags: - NetAccessPoint @@ -10650,10 +12833,12 @@ paths: 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).

- **[NOTE]**
+ **[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. Therefore, you do not need to create a B-to-A connection if an A-to-B connection is created and accepted. + + For more information, see [About Net Peerings](https://docs.outscale.com/en/userguide/About-Net-Peerings.html). post: operationId: CreateNetPeering requestBody: @@ -10661,12 +12846,36 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateNetPeeringRequest" + examples: + ex1: + value: + SourceNetId: vpc-12345678 + AccepterNetId: vpc-87654321 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/CreateNetPeeringResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + NetPeering: + Tags: [] + SourceNet: + NetId: vpc-12345678 + IpRange: 10.0.0.0/16 + AccountId: '123456789012' + NetPeeringId: pcx-12345678 + AccepterNet: + NetId: vpc-12345678 + IpRange: 172.16.0.0/16 + AccountId: '123456789012' + State: + Name: pending-acceptance + Message: Pending acceptance by 123456789012 description: The HTTP 200 response (OK). '400': content: @@ -10689,7 +12898,9 @@ paths: tags: - NetPeering "/CreateNic": - description: Creates a network interface card (NIC) in the specified Subnet. + 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: operationId: CreateNic requestBody: @@ -10697,12 +12908,83 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateNicRequest" + examples: + ex1: + summary: Creating a NIC + value: + SubnetId: subnet-12345678 + SecurityGroupIds: + - sg-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 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: + 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 + PrivateIps: + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + PrivateIp: 10.0.0.4 + IsPrimary: true + ex2: + summary: Creating a NIC with specific private IPs + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Nic: + 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 + PrivateIps: + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + PrivateIp: 10.0.0.4 + IsPrimary: true + - PrivateDnsName: ip-10-0-0-5.eu-west-2.compute.internal + PrivateIp: 10.0.0.5 + IsPrimary: false description: The HTTP 200 response (OK). '400': content: @@ -10724,10 +13006,126 @@ paths: description: The HTTP 500 response (Internal Server Error). 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: + operationId: CreatePolicy + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/CreatePolicyRequest" + examples: + ex1: + value: + Description: Example of description + Document: '{"Statement": [ {"Action": ["*"],"Effect","Allow","Resource": + ["*"]} ]}' + Path: "/example/" + PolicyName: example-user-policy + responses: + '200': + content: + application/json: + schema: + "$ref": "#/components/schemas/CreatePolicyResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Policy: + CreationDate: '2010-10-01T12:34:56.789Z' + Description: Example of description + IsLinkable: true + LastModificationDate: '2010-10-01T12:34:56.789Z' + Orn: orn:ows:idauth::012345678910:user-policy/Policy + Path: "/example/" + PolicyDefaultVersionId: version-12345678 + PolicyId: policy-12345678 + PolicyName: example-user-policy + ResourcesCount: 0 + 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: + operationId: CreatePolicyVersion + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/CreatePolicyVersionRequest" + examples: + ex1: + value: + Document: '{"Statement": [ {"Action": ["*"],"Effect","Allow","Resource": + ["*"]} ]}' + PolicyOrn: orn:ows:idauth::012345678910:user-policy/Policy + SetAsDefault: true + responses: + '200': + content: + application/json: + schema: + "$ref": "#/components/schemas/CreatePolicyVersionResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + PolicyVersion: + Body: '{"Statement": [ {"Action": ["*"],"Effect","Allow","Resource": + ["*"]} ]}' + CreationDate: '2010-10-01T12:34:56.789Z' + DefaultVersion: true + VersionId: version-12345678 + 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: + operationId: CreateProductType + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/CreateProductTypeRequest" + examples: + ex1: + value: + Vendor: vendor-name + Description: Example of description + responses: + '200': + content: + application/json: + schema: + "$ref": "#/components/schemas/CreateProductTypeResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + 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. + 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: operationId: CreatePublicIp requestBody: @@ -10735,12 +13133,24 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreatePublicIpRequest" + examples: + ex1: + value: {} responses: '200': content: application/json: schema: "$ref": "#/components/schemas/CreatePublicIpResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + PublicIp: + Tags: [] + PublicIpId: eipalloc-12345678 + PublicIp: 192.0.2.0 description: The HTTP 200 response (OK). '400': content: @@ -10774,7 +13184,8 @@ paths: * NAT service
* Network interface card (NIC)

- The routing algorithm is based on the most specific match. + 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: operationId: CreateRoute requestBody: @@ -10782,12 +13193,39 @@ paths: 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 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/CreateRouteResponse" + examples: + ex1: + summary: Creating a route to an Internet service + value: + RouteTable: + Routes: + - DestinationIpRange: 10.0.0.0/16 + CreationMethod: CreateRouteTable + State: active + - GatewayId: igw-12345678 + DestinationIpRange: 0.0.0.0/0 + CreationMethod: CreateRoute + State: active + LinkRouteTables: [] + NetId: vpc-12345678 + Tags: [] + RoutePropagatingVirtualGateways: [] + RouteTableId: rtb-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -10812,7 +13250,8 @@ paths: "/CreateRouteTable": description: |- Creates a route table for a specified Net.
- You can then add routes and associate this route table with a Subnet. + 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: operationId: CreateRouteTable requestBody: @@ -10820,12 +13259,31 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateRouteTableRequest" + examples: + ex1: + value: + NetId: vpc-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/CreateRouteTableResponse" + examples: + ex1: + value: + RouteTable: + Routes: + - DestinationIpRange: 10.0.0.0/16 + CreationMethod: CreateRouteTable + State: active + LinkRouteTables: [] + NetId: vpc-12345678 + Tags: [] + RoutePropagatingVirtualGateways: [] + RouteTableId: rtb-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -10854,7 +13312,8 @@ paths: 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. + 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: operationId: CreateSecurityGroup requestBody: @@ -10862,12 +13321,37 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateSecurityGroupRequest" + examples: + ex1: + value: + NetId: vpc-12345678 + SecurityGroupName: security-group-example + Description: Security group example responses: '200': content: application/json: schema: "$ref": "#/components/schemas/CreateSecurityGroupResponse" + examples: + ex1: + value: + 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: [] + NetId: vpc-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -10905,6 +13389,8 @@ paths: **[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: operationId: CreateSecurityGroupRule requestBody: @@ -10912,12 +13398,85 @@ paths: 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 + 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 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/CreateSecurityGroupRuleResponse" + examples: + ex1: + summary: Creating an inbound rule from an IP range + value: + 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 + 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 + SecurityGroupId: sg-12345678 + AccountId: '123456789012' + Description: Example of security group + InboundRules: + - FromPortRange: 22 + IpProtocol: tcp + ToPortRange: 22 + SecurityGroupsMembers: + - SecurityGroupName: another-security-group + SecurityGroupId: sg-87654321 + AccountId: '987654321098' + NetId: vpc-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -10946,7 +13505,8 @@ paths: 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 the 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. + 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: operationId: CreateServerCertificate requestBody: @@ -10954,12 +13514,30 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateServerCertificateRequest" + examples: + ex1: + value: + Name: server-cert-example + Body: "..." + Chain: "..." + PrivateKey: "..." + Path: "/example/" responses: '200': content: application/json: schema: "$ref": "#/components/schemas/CreateServerCertificateResponse" + examples: + ex1: + value: + ServerCertificate: + Path: "/example/" + Id: ABCDEFGHIJKLMNOPQRSTUVWXYZ1234 + Orn: orn:ows:idauth::012345678910:server-certificate/example/server-cert-example + Name: server-cert-example + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - ServerCertificate @@ -10967,9 +13545,11 @@ paths: 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**: You create a snapshot from one of your volumes.
- * **Copying**: 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**: You import a snapshot located in an OUTSCALE Object Storage (OOS) bucket. First, the owner of the source snapshot must export it to the bucket by using the [CreateSnapshotExportTask](#createsnapshotexporttask) method. Then, they must grant you read permission on the bucket via a pre-signed URL or Access Control Lists. For more information, see [Managing Access to Your Buckets and Objects](https://docs.outscale.com/en/userguide/Managing-Access-to-Your-Buckets-and-Objects.html). + * **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 the bucket by using the [CreateSnapshotExportTask](#createsnapshotexporttask) method. Then, they must grant you permission to read the snapshot via a pre-signed URL or Access Control Lists. For more information, see [Managing Access to Your Buckets and Objects](https://docs.outscale.com/en/userguide/Managing-Access-to-Your-Buckets-and-Objects.html). + + For more information, see [About Snapshots](https://docs.outscale.com/en/userguide/About-Snapshots.html). post: operationId: CreateSnapshot requestBody: @@ -10977,12 +13557,85 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateSnapshotRequest" + examples: + ex1: + summary: Creating from a volume + value: + VolumeId: vol-12345678 + Description: Snapshot created from a volume + ex2: + summary: Copying a snapshot + value: + SourceSnapshotId: snap-12345678 + SourceRegionName: eu-west-2 + Description: Snapshot created from another snapshot + ex3: + summary: Importing from a bucket + value: + FileLocation: https://oos.eu-west-2.outscale.com/BUCKET/KEY?AWSAccessKeyId=ABCDEFGHIJ0123456789&Expires=1493372309&Signature=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + SnapshotSize: 10737418240 + Description: Snapshot imported from a bucket responses: '200': content: application/json: schema: "$ref": "#/components/schemas/CreateSnapshotResponse" + examples: + ex1: + summary: Creating from a volume + value: + Snapshot: + VolumeSize: 10 + AccountId: '123456789012' + VolumeId: vol-12345678 + CreationDate: '2010-10-01T12:34:56.789Z' + PermissionsToCreateVolume: + GlobalPermission: false + AccountIds: [] + Progress: 0 + SnapshotId: snap-12345678 + State: pending/queued + Description: Snapshot created from a volume + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + summary: Copying a snapshot + value: + Snapshot: + VolumeSize: 10 + AccountId: '123456789012' + VolumeId: vol-12345678 + CreationDate: '2010-10-01T12:34:56.789Z' + PermissionsToCreateVolume: + GlobalPermission: false + AccountIds: [] + Progress: 100 + SnapshotId: snap-12345678 + State: completed + Description: Snapshot copied from another snapshot + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex3: + summary: Importing from a bucket + value: + Snapshot: + VolumeSize: 10 + AccountId: '123456789012' + VolumeId: vol-12345678 + CreationDate: '2010-10-01T12:34:56.789Z' + PermissionsToCreateVolume: + GlobalPermission: false + AccountIds: [] + Progress: 0 + SnapshotId: snap-12345678 + State: importing + Description: Snapshot imported from a bucket + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -11007,8 +13660,9 @@ paths: "/CreateSnapshotExportTask": description: |- Exports a snapshot to an OUTSCALE Object Storage (OOS) bucket.
- This action enables you to create a backup of your snapshot or to copy it to another account. You, or other users you send a pre-signed URL to, can then download this snapshot from the bucket using the [CreateSnapshot](#createsnapshot) method.
- This procedure enables you to copy a snapshot between accounts within the same Region or in different Regions. To copy a snapshot within the same Region, you can also use the [CreateSnapshot](#createsnapshot) direct method. The copy of the source snapshot is independent and belongs to you. + This action enables you to create a backup of your snapshot or to copy it to another account. You, or other accounts you send a pre-signed URL to, can then download this snapshot from the bucket using the [CreateSnapshot](#createsnapshot) method.
+ This procedure enables you to copy a snapshot between accounts within the same Region or in different Regions. To copy a snapshot within the same Region, you can also use the [CreateSnapshot](#createsnapshot) direct method. The copy of the source snapshot is independent and belongs to you.

+ For more information, see [About Snapshots](https://docs.outscale.com/en/userguide/About-Snapshots.html). post: operationId: CreateSnapshotExportTask requestBody: @@ -11016,19 +13670,44 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateSnapshotExportTaskRequest" + examples: + ex1: + value: + SnapshotId: snap-12345678 + OsuExport: + DiskImageFormat: qcow2 + OsuBucket: BUCKET + OsuPrefix: PREFIX responses: '200': content: application/json: schema: "$ref": "#/components/schemas/CreateSnapshotExportTaskResponse" + examples: + ex1: + value: + SnapshotExportTask: + Tags: [] + TaskId: snap-export-12345678 + Comment: Export of snapshot snap-12345678 + OsuExport: + OsuPrefix: PREFIX + OsuBucket: BUCKET + DiskImageFormat: qcow2 + State: pending + 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. + 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: operationId: CreateSubnet requestBody: @@ -11036,12 +13715,31 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateSubnetRequest" + examples: + ex1: + value: + NetId: vpc-12345678 + IpRange: 10.0.0.0/18 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/CreateSubnetResponse" + examples: + ex1: + value: + Subnet: + Tags: [] + SubregionName: eu-west-2a + SubnetId: subnet-12345678 + AvailableIpsCount: 16379 + IpRange: 10.0.0.0/18 + MapPublicIpOnLaunch: false + State: available + NetId: vpc-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -11095,6 +13793,8 @@ paths: * DHCP options (dopt-xxxxxxxx)
* OMI export tasks (image-export-xxxxxxxx)
* Snapshot export tasks (snap-export-xxxxxxxx) + + For more information, see [About Tags](https://docs.outscale.com/en/userguide/About-Tags.html). post: operationId: CreateTags requestBody: @@ -11102,12 +13802,25 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateTagsRequest" + examples: + ex1: + value: + ResourceIds: + - i-12345678 + Tags: + - Key: key1 + Value: value1 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/CreateTagsResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -11130,7 +13843,9 @@ paths: tags: - Tag "/CreateUser": - description: Creates an EIM user for your account. + 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: operationId: CreateUser requestBody: @@ -11138,19 +13853,34 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateUserRequest" + examples: + ex1: + value: + UserName: example-user + Path: "/documentation/" responses: '200': content: application/json: schema: "$ref": "#/components/schemas/CreateUserResponse" + examples: + ex1: + value: + User: + UserName: example-user + UserId: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 + Path: "/documentation/" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - User "/CreateVirtualGateway": description: |- Creates a virtual gateway.
- A virtual gateway is the access point on the Net side of a VPN connection. + 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: operationId: CreateVirtualGateway requestBody: @@ -11158,12 +13888,27 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateVirtualGatewayRequest" + examples: + ex1: + value: + ConnectionType: ipsec.1 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/CreateVirtualGatewayResponse" + examples: + ex1: + value: + VirtualGateway: + VirtualGatewayId: vgw-12345678 + ConnectionType: ipsec.1 + NetToVirtualGatewayLinks: [] + State: available + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - VirtualGateway @@ -11181,12 +13926,47 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateVmGroupRequest" + examples: + ex1: + value: + Description: Production log collector + PositioningStrategy: attract + SecurityGroupIds: + - sg-12345678 + SubnetId: subnet-12345678 + Tags: + - Key: key1 + Value: value1 + VmCount: 2 + VmGroupName: ClusterLog-PPD01 + VmTemplateId: vmtemplate-98765432109876543210987654321012 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/CreateVmGroupResponse" + examples: + ex1: + value: + VmGroup: + CreationDate: '2010-10-01T12:34:56.789Z' + Description: Production log collector + PositioningStrategy: attract + SecurityGroupIds: + - sg-12345678 + State: available + SubnetId: subnet-12345678 + Tags: + - Key: key1 + Value: value1 + VmCount: 2 + VmGroupId: vmgroup-12345678901234567890123456789012 + VmGroupName: ClusterLog-PPD01 + VmIds: [] + VmTemplateId: vmtemplate-98765432109876543210987654321012 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -11222,12 +14002,43 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateVmTemplateRequest" + examples: + ex1: + value: + CpuCores: 2 + CpuGeneration: v4 + CpuPerformance: high + Description: Log collector template + ImageId: ami-12345678 + KeypairName: keypair-example + Ram: 2 + Tags: + - Key: key1 + Value: value1 + VmTemplateName: vmtemplate-example responses: '200': content: application/json: schema: "$ref": "#/components/schemas/CreateVmTemplateResponse" + examples: + ex1: + value: + VmTemplateName: vmtemplate-example + CpuPerformance: high + CreationDate: 2010-10-01 12:34:56.789000000 +00:00 + CpuCores: 2 + Tags: + - Key: key1 + Value: value1 + Description: Log collector template + ImageId: ami-12345678 + CpuGeneration: v4 + VmTemplateId: vmtemplate-98765432109876543210987654321012 + Ram: 2 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - VmTemplate @@ -11238,7 +14049,8 @@ paths: 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. + 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: operationId: CreateVms requestBody: @@ -11246,12 +14058,312 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateVmsRequest" + examples: + ex1: + summary: Creating a VM (minimal syntax) + value: + ImageId: ami-12345678 + ex2: + summary: Creating a VM in a Net + value: + ImageId: ami-12345678 + VmType: tinav5.c1r1p2 + KeypairName: keypair-example + SecurityGroupIds: + - sg-12345678 + SubnetId: subnet-12345678 + UserData: "..." + ex3: + summary: Creating a VM with block device mappings + value: + ImageId: ami-12345678 + VmType: tinav5.c1r1p2 + KeypairName: keypair-example + SecurityGroupIds: + - sg-12345678 + SubnetId: subnet-12345678 + UserData: "..." + 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 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/CreateVmsResponse" + examples: + ex1: + summary: Creating a VM (minimal syntax) + value: + Vms: + - VmType: t2.small + VmInitiatedShutdownBehavior: stop + State: pending + StateReason: '' + RootDeviceType: ebs + RootDeviceName: "/dev/sda1" + IsSourceDestChecked: true + ImageId: ami-12345678 + DeletionProtection: false + Architecture: x86_64 + NestedVirtualization: false + BlockDeviceMappings: + - DeviceName: "/dev/sda1" + Bsu: + VolumeId: vol-12345678 + State: attaching + 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: "..." + PrivateIp: 10.0.0.4 + SecurityGroups: + - SecurityGroupName: default + SecurityGroupId: sg-12345678 + BsuOptimized: false + LaunchNumber: 0 + Performance: medium + Tags: [] + 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: + Vms: + - VmType: tinav5.c1r1p2 + VmInitiatedShutdownBehavior: stop + State: pending + StateReason: '' + RootDeviceType: ebs + RootDeviceName: "/dev/sda1" + IsSourceDestChecked: true + KeypairName: keypair-example + ImageId: ami-12345678 + DeletionProtection: false + Architecture: x86_64 + NestedVirtualization: false + BlockDeviceMappings: + - DeviceName: "/dev/sda1" + Bsu: + VolumeId: vol-12345678 + State: attaching + 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 + NetId: vpc-12345678 + Nics: + - SubnetId: subnet-12345678 + State: in-use + LinkNic: + State: attached + DeviceNumber: 0 + LinkNicId: eni-attach-12345678 + 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 + PrivateIps: + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + PrivateIp: 10.0.0.4 + IsPrimary: true + Performance: high + Tags: [] + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + 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 + RootDeviceName: "/dev/sda1" + IsSourceDestChecked: true + KeypairName: keypair-example + ImageId: ami-12345678 + DeletionProtection: false + Architecture: x86_64 + NestedVirtualization: false + BlockDeviceMappings: + - DeviceName: "/dev/sda1" + Bsu: + VolumeId: vol-12345678 + State: attaching + LinkDate: '2010-10-01T12:34:56.789Z' + DeleteOnVmDeletion: true + - DeviceName: "/dev/sda1" + Bsu: + VolumeId: vol-87654321 + State: attaching + 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 + NetId: vpc-12345678 + Nics: + - SubnetId: subnet-12345678 + State: in-use + LinkNic: + State: attached + DeviceNumber: 0 + LinkNicId: eni-attach-12345678 + 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 + PrivateIps: + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + PrivateIp: 10.0.0.4 + IsPrimary: true + Performance: high + Tags: [] + 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: + Vms: + - VmType: tinav5.c1r1p2 + VmInitiatedShutdownBehavior: stop + State: pending + StateReason: '' + RootDeviceType: ebs + RootDeviceName: "/dev/sda1" + IsSourceDestChecked: true + KeypairName: keypair-example + ImageId: ami-12345678 + DeletionProtection: false + Architecture: x86_64 + NestedVirtualization: false + BlockDeviceMappings: + - DeviceName: "/dev/sda1" + Bsu: + VolumeId: vol-12345678 + State: attaching + 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 + NetId: vpc-12345678 + Nics: + - SubnetId: subnet-12345678 + State: in-use + LinkNic: + State: attached + DeviceNumber: 0 + LinkNicId: eni-attach-12345678 + 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 + PrivateIps: + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + PrivateIp: 10.0.0.4 + IsPrimary: true + Performance: high + Tags: [] + 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: @@ -11277,7 +14389,8 @@ paths: 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. + 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: operationId: CreateVolume requestBody: @@ -11285,12 +14398,59 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateVolumeRequest" + examples: + ex1: + summary: Creating an io1 volume + value: + VolumeType: io1 + SubregionName: eu-west-2a + Size: 10 + Iops: 100 + ex2: + summary: Creating a volume from a snapshot + value: + SnapshotId: snap-12345678 + VolumeType: gp2 + SubregionName: eu-west-2a + Size: 10 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/CreateVolumeResponse" + examples: + ex1: + summary: Creating an io1 volume + value: + 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 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + summary: Creating a volume from a snapshot + value: + 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 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -11315,7 +14475,11 @@ paths: "/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. + 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: operationId: CreateVpnConnection requestBody: @@ -11323,19 +14487,47 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateVpnConnectionRequest" + examples: + ex1: + value: + ClientGatewayId: cgw-12345678 + VirtualGatewayId: vgw-12345678 + ConnectionType: ipsec.1 + StaticRoutesOnly: true responses: '200': content: application/json: schema: "$ref": "#/components/schemas/CreateVpnConnectionResponse" + examples: + ex1: + value: + VpnConnection: + Routes: [] + Tags: [] + ClientGatewayConfiguration: "..." + StaticRoutesOnly: true + VirtualGatewayId: vgw-12345678 + ConnectionType: ipsec.1 + ClientGatewayId: cgw-12345678 + State: pending + VgwTelemetries: + - StateDescription: IPSEC IS DOWN + AcceptedRouteCount: 0 + LastStateChangeDate: '2017-05-10T12:34:56.789Z' + OutsideIpAddress: 192.0.2.0 + VpnConnectionId: vpn-12345678 + 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. + 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: operationId: CreateVpnConnectionRoute requestBody: @@ -11343,21 +14535,29 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateVpnConnectionRouteRequest" + examples: + ex1: + value: + VpnConnectionId: vpn-12345678 + 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 description: The HTTP 200 response (OK). tags: - VpnConnection "/DeleteAccessKey": description: |- Deletes the specified access key of either your root account or an EIM user.

- - **[NOTE]**
- To protect against brute force attacks, the number of requests allowed for this method in a given time period is limited. + The access key of an EIM user must be in the `INACTIVE` state to be deleted. post: operationId: DeleteAccessKey requestBody: @@ -11365,12 +14565,28 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteAccessKeyRequest" + examples: + ex1: + summary: Deleting one of your own access keys (if you are the root + account or an EIM user) + value: + AccessKeyId: ABCDEFGHIJ0123456789 + ex2: + summary: Deleting the access key of a specific EIM user + value: + AccessKeyId: ABCDEFGHIJ0123456789 + UserName: example-user responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteAccessKeyResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -11378,7 +14594,7 @@ paths: tags: - AccessKey "/DeleteApiAccessRule": - description: "Deletes a specified API access rule.

\n\n**[NOTE]**

\n\n**[IMPORTANT]**
\nYou 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)." @@ -11389,12 +14605,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteApiAccessRuleRequest" + examples: + ex1: + value: + ApiAccessRuleId: aar-1234567890abcdef1234567890abcdef responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteApiAccessRuleResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -11410,12 +14635,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteCaRequest" + examples: + ex1: + value: + CaId: ca-fedcba0987654321fedcba0987654321 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteCaResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -11433,21 +14667,92 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteClientGatewayRequest" + examples: + ex1: + value: + ClientGatewayId: cgw-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteClientGatewayResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - ClientGateway + "/DeleteDedicatedGroup": + description: |- + > [WARNING]
+ > This feature is currently in beta.
+ + 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: + operationId: DeleteDedicatedGroup + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/DeleteDedicatedGroupRequest" + examples: + ex1: + summary: Deleting a dedicated group without any resource in it. + value: + DedicatedGroupId: ded-12345678 + ex2: + summary: Forcing the deletion of a dedicated group and all resources + in it. + value: + DedicatedGroupId: ded-12345678 + Force: true + responses: + '200': + content: + application/json: + schema: + "$ref": "#/components/schemas/DeleteDedicatedGroupResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + description: The HTTP 200 response (OK). + '400': + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + description: The HTTP 400 response (Bad Request). + '401': + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + description: The HTTP 401 response (Unauthorized). + '500': + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + description: The HTTP 500 response (Internal Server Error). + 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.

- **[NOTE]**
+ **[IMPORTANT]**
You cannot delete the `default` set. post: operationId: DeleteDhcpOptions @@ -11456,12 +14761,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteDhcpOptionsRequest" + examples: + ex1: + value: + DhcpOptionsSetId: dopt-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteDhcpOptionsResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - DhcpOption @@ -11476,12 +14790,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteDirectLinkRequest" + examples: + ex1: + value: + DirectLinkId: dxcon-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteDirectLinkResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - DirectLink @@ -11494,12 +14817,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteDirectLinkInterfaceRequest" + examples: + ex1: + value: + DirectLinkInterfaceId: dxvif-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteDirectLinkInterfaceResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - DirectLinkInterface @@ -11514,12 +14846,32 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteExportTaskRequest" + examples: + ex1: + summary: Deleting an image export task + value: + ExportTaskId: image-export-12345678 + ex2: + summary: Deleting a snapshot export task + value: + ExportTaskId: snap-export-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteExportTaskResponse" + examples: + ex1: + summary: Deleting an image export task + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + summary: Deleting a snapshot export task + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - Task @@ -11534,12 +14886,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteFlexibleGpuRequest" + examples: + ex1: + value: + FlexibleGpuId: fgpu-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteFlexibleGpuResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - FlexibleGpu @@ -11554,12 +14915,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteImageRequest" + examples: + ex1: + value: + ImageId: ami-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteImageResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -11592,12 +14962,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteInternetServiceRequest" + examples: + ex1: + value: + InternetServiceId: igw-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteInternetServiceResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -11630,12 +15009,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteKeypairRequest" + examples: + ex1: + value: + KeypairName: keypair-example responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteKeypairResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -11668,12 +15056,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteListenerRuleRequest" + examples: + ex1: + value: + ListenerRuleName: example-listener-rule responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteListenerRuleResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - Listener @@ -11686,12 +15083,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteLoadBalancerRequest" + examples: + ex1: + value: + LoadBalancerName: example-lbu responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteLoadBalancerResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - LoadBalancer @@ -11704,12 +15110,53 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteLoadBalancerListenersRequest" + examples: + ex1: + value: + LoadBalancerName: example-lbu + LoadBalancerPorts: + - 80 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: + PublicationInterval: 60 + 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 + LoadBalancerStickyCookiePolicies: [] + SubregionNames: + - eu-west-2a + Listeners: [] + LoadBalancerName: example-lbu description: The HTTP 200 response (OK). tags: - Listener @@ -11724,12 +15171,57 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteLoadBalancerPolicyRequest" + examples: + ex1: + value: + LoadBalancerName: example-lbu + PolicyName: example-browser-policy 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: + PublicationInterval: 60 + 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 + LoadBalancerStickyCookiePolicies: [] + SubregionNames: + - eu-west-2a + Listeners: + - BackendPort: 80 + BackendProtocol: HTTP + LoadBalancerPort: 80 + LoadBalancerProtocol: HTTP + LoadBalancerName: example-lbu description: The HTTP 200 response (OK). tags: - LoadBalancerPolicy @@ -11742,12 +15234,24 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteLoadBalancerTagsRequest" + examples: + ex1: + value: + LoadBalancerNames: + - example-lbu + Tags: + - Key: key1 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteLoadBalancerTagsResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - LoadBalancer @@ -11762,12 +15266,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteNatServiceRequest" + examples: + ex1: + value: + NatServiceId: nat-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteNatServiceResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -11810,12 +15323,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteNetRequest" + examples: + ex1: + value: + NetId: vpc-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteNetResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -11848,12 +15370,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteNetAccessPointRequest" + examples: + ex1: + value: + NetAccessPointId: vpce-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteNetAccessPointResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - NetAccessPoint @@ -11870,12 +15401,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteNetPeeringRequest" + examples: + ex1: + value: + NetPeeringId: pcx-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteNetPeeringResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -11914,12 +15454,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteNicRequest" + examples: + ex1: + value: + NicId: eni-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteNicResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -11941,6 +15490,64 @@ paths: description: The HTTP 500 response (Internal Server Error). 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 using the `DeletePolicyVersion` method. + post: + operationId: DeletePolicy + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/DeletePolicyRequest" + examples: + ex1: + value: + PolicyOrn: orn:ows:idauth::012345678910:user-policy/Policy + responses: + '200': + content: + application/json: + schema: + "$ref": "#/components/schemas/DeletePolicyResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + 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: + operationId: DeletePolicyVersion + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/DeletePolicyVersionRequest" + examples: + ex1: + value: + PolicyOrn: orn:ows:idauth::012345678910:user-policy/Policy + VersionId: version-12345678 + responses: + '200': + content: + application/json: + schema: + "$ref": "#/components/schemas/DeletePolicyVersionResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + description: The HTTP 200 response (OK). + tags: + - Policy "/DeletePublicIp": description: |- Releases a public IP.
@@ -11952,12 +15559,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeletePublicIpRequest" + examples: + ex1: + value: + PublicIp: 192.0.2.0 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeletePublicIpResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -11988,12 +15604,32 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteRouteRequest" + examples: + ex1: + value: + RouteTableId: rtb-12345678 + DestinationIpRange: 198.51.100.0/24 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteRouteResponse" + examples: + ex1: + value: + RouteTable: + Routes: + - DestinationIpRange: 10.0.0.0/16 + CreationMethod: CreateRouteTable + State: active + LinkRouteTables: [] + NetId: vpc-12345678 + Tags: [] + RoutePropagatingVirtualGateways: [] + RouteTableId: rtb-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -12026,12 +15662,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteRouteTableRequest" + examples: + ex1: + value: + RouteTableId: rtb-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteRouteTableResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -12065,12 +15710,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteSecurityGroupRequest" + examples: + ex1: + value: + SecurityGroupId: sg-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteSecurityGroupResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -12105,12 +15759,73 @@ paths: 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 + 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 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteSecurityGroupRuleResponse" + examples: + ex1: + summary: Deleting an inbound rule from an IP range + value: + 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: [] + 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 + SecurityGroupId: sg-12345678 + 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: @@ -12141,12 +15856,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteServerCertificateRequest" + examples: + ex1: + value: + Name: server-cert-example responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteServerCertificateResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - ServerCertificate @@ -12161,12 +15885,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteSnapshotRequest" + examples: + ex1: + value: + SnapshotId: snap-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteSnapshotResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -12195,7 +15928,7 @@ paths: * Virtual machines (VMs)
* Network Interface Cards (NICs)
- * Network Address Translation (NAT) gateways
+ * NAT services
* Load balancers post: operationId: DeleteSubnet @@ -12204,12 +15937,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteSubnetRequest" + examples: + ex1: + value: + SubnetId: subnet-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteSubnetResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -12240,12 +15982,25 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteTagsRequest" + examples: + ex1: + value: + ResourceIds: + - i-12345678 + Tags: + - Key: key1 + Value: value1 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteTagsResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -12269,7 +16024,7 @@ paths: - Tag "/DeleteUser": description: Deletes a specified EIM user. The EIM user must not belong to any - group and have any key, signing certificate or attached policy. + group, nor have any key or attached policy. post: operationId: DeleteUser requestBody: @@ -12277,12 +16032,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteUserRequest" + examples: + ex1: + value: + UserName: example-user responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteUserResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - User @@ -12297,12 +16061,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteVirtualGatewayRequest" + examples: + ex1: + value: + VirtualGatewayId: vgw-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteVirtualGatewayResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - VirtualGateway @@ -12319,12 +16092,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteVmGroupRequest" + examples: + ex1: + value: + VmGroupId: vmgroup-12345678901234567890123456789012 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteVmGroupResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -12360,12 +16142,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteVmTemplateRequest" + examples: + ex1: + value: + VmTemplateId: vmtemplate-98765432109876543210987654321012 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteVmTemplateResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - VmTemplate @@ -12380,12 +16171,26 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteVmsRequest" + examples: + ex1: + value: + VmIds: + - i-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteVmsResponse" + examples: + ex1: + value: + Vms: + - VmId: i-12345678 + PreviousState: running + CurrentState: shutting-down + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -12418,12 +16223,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteVolumeRequest" + examples: + ex1: + value: + VolumeId: vol-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteVolumeResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -12456,12 +16270,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteVpnConnectionRequest" + examples: + ex1: + value: + VpnConnectionId: vpn-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteVpnConnectionResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - VpnConnection @@ -12475,12 +16298,22 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteVpnConnectionRouteRequest" + examples: + ex1: + value: + VpnConnectionId: vpn-12345678 + 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 description: The HTTP 200 response (OK). tags: - VpnConnection @@ -12493,12 +16326,24 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeregisterVmsInLoadBalancerRequest" + examples: + ex1: + value: + LoadBalancerName: example-lbu + BackendVmIds: + - i-12345678 + - i-87654321 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 @@ -12513,12 +16358,22 @@ paths: application/json: schema: "$ref": "#/components/schemas/LinkFlexibleGpuRequest" + examples: + ex1: + value: + FlexibleGpuId: fgpu-12345678 + VmId: i-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/LinkFlexibleGpuResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - FlexibleGpu @@ -12533,12 +16388,22 @@ paths: application/json: schema: "$ref": "#/components/schemas/LinkInternetServiceRequest" + examples: + ex1: + value: + InternetServiceId: igw-12345678 + NetId: vpc-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/LinkInternetServiceResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -12571,19 +16436,45 @@ paths: 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 + ex2: + summary: Linking public IPs to a load balancer + value: + LoadBalancerName: example-lbu + BackendIps: + - 192.0.2.0 + - 198.51.100.0 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/LinkLoadBalancerBackendMachinesResponse" + examples: + ex1: + summary: Linking VMs to a load balancer + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + summary: Linking public IPs to a load balancer + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - LoadBalancer "/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 an FNI to an Instance](https://docs.outscale.com/en/userguide/Attaching-an-FNI-to-an-Instance.html). + 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: operationId: LinkNic requestBody: @@ -12591,12 +16482,24 @@ paths: application/json: schema: "$ref": "#/components/schemas/LinkNicRequest" + examples: + ex1: + value: + NicId: eni-12345678 + VmId: i-12345678 + DeviceNumber: 1 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/LinkNicResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + LinkNicId: eni-attach-12345678 description: The HTTP 200 response (OK). '400': content: @@ -12618,6 +16521,34 @@ paths: description: The HTTP 500 response (Internal Server Error). tags: - Nic + "/LinkPolicy": + description: Links a managed policy to a specific user. + post: + operationId: LinkPolicy + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/LinkPolicyRequest" + examples: + ex1: + value: + PolicyOrn: orn:ows:idauth::012345678910:user-policy/Policy + UserName: example-user + responses: + '200': + content: + application/json: + schema: + "$ref": "#/components/schemas/LinkPolicyResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + 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 @@ -12633,12 +16564,30 @@ paths: application/json: schema: "$ref": "#/components/schemas/LinkPrivateIpsRequest" + examples: + ex1: + summary: Linking specific secondary private IPs to a NIC + value: + NicId: eni-12345678 + PrivateIps: + - 10.0.0.6 + - 10.0.0.7 + ex2: + summary: Linking a number of random secondary private IPs to a NIC + value: + NicId: eni-12345678 + SecondaryPrivateIpCount: 3 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/LinkPrivateIpsResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -12666,7 +16615,7 @@ paths: 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.

- **[NOTE]**
+ **[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: operationId: LinkPublicIp @@ -12675,12 +16624,36 @@ paths: application/json: schema: "$ref": "#/components/schemas/LinkPublicIpRequest" + examples: + ex1: + summary: Linking a public IP to a VM + value: + PublicIp: 192.0.2.0 + VmId: i-12345678 + ex2: + summary: Linking a public IP to a NIC + value: + PublicIp: 192.0.2.0 + NicId: eni-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/LinkPublicIpResponse" + examples: + ex1: + summary: Linking a public IP to a VM + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + LinkPublicIpId: eipassoc-12345678 + ex2: + summary: Linking a public IP to a NIC + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + LinkPublicIpId: eipassoc-12345678 description: The HTTP 200 response (OK). '400': content: @@ -12713,12 +16686,23 @@ paths: application/json: schema: "$ref": "#/components/schemas/LinkRouteTableRequest" + examples: + ex1: + value: + RouteTableId: rtb-12345678 + SubnetId: subnet-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/LinkRouteTableResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + LinkRouteTableId: rtbassoc-12345678 description: The HTTP 200 response (OK). '400': content: @@ -12741,7 +16725,11 @@ paths: tags: - RouteTable "/LinkVirtualGateway": - description: Attaches a virtual gateway to a Net. + 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: operationId: LinkVirtualGateway requestBody: @@ -12749,12 +16737,25 @@ paths: application/json: schema: "$ref": "#/components/schemas/LinkVirtualGatewayRequest" + examples: + ex1: + value: + VirtualGatewayId: vgw-12345678 + NetId: vpc-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/LinkVirtualGatewayResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + NetToVirtualGatewayLink: + State: attached + NetId: vpc-12345678 description: The HTTP 200 response (OK). tags: - VirtualGateway @@ -12769,12 +16770,23 @@ paths: application/json: schema: "$ref": "#/components/schemas/LinkVolumeRequest" + examples: + ex1: + value: + VolumeId: vol-12345678 + 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 description: The HTTP 200 response (OK). '400': content: @@ -12805,12 +16817,29 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadAccessKeysRequest" + examples: + ex1: + value: + Filters: + States: + - ACTIVE responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadAccessKeysResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + AccessKeys: + - 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 description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -12826,12 +16855,30 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadAccountsRequest" + examples: + ex1: + value: {} responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadAccountsResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Accounts: + - ZipCode: '92210' + CompanyName: EXAMPLE SAS + FirstName: JEAN + City: SAINT-CLOUD + Country: FRANCE + LastName: DUPONT + AccountId: '123456789012' + CustomerId: '87654321' + Email: example@example.com description: The HTTP 200 response (OK). tags: - Account @@ -12840,8 +16887,9 @@ paths: 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.

- **[NOTE]**
- The administrator password is generated only on the first boot of the Windows VM. It is not returned after the first boot. + **[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: operationId: ReadAdminPassword requestBody: @@ -12849,12 +16897,23 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadAdminPasswordRequest" + examples: + ex1: + value: + VmId: i-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadAdminPasswordResponse" + examples: + ex1: + value: + VmId: i-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + AdminPassword: "..." description: The HTTP 200 response (OK). '400': content: @@ -12877,7 +16936,9 @@ paths: tags: - Vm "/ReadApiAccessPolicy": - description: Gets information about the API access policy of your account. + 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: operationId: ReadApiAccessPolicy requestBody: @@ -12885,12 +16946,23 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadApiAccessPolicyRequest" + examples: + ex1: + value: {} responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadApiAccessPolicyResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ApiAccessPolicy: + RequireTrustedEnv: false + MaxAccessKeyExpirationSeconds: 0 description: The HTTP 200 response (OK). '400': content: @@ -12924,12 +16996,36 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadApiAccessRulesRequest" + examples: + ex1: + value: + Filters: + ApiAccessRuleIds: + - aar-1234567890abcdef1234567890abcdef responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadApiAccessRulesResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ApiAccessRules: + - IpRanges: + - 0.0.0.0/0 + ApiAccessRuleId: aar-1234567890abcdef1234567890abcdef + CaIds: [] + Cns: [] + Description: Allows all IPv4 domain + - IpRanges: + - 46.231.144.178/32 + ApiAccessRuleId: aar-abcdef1234567890abcdef1234567890 + CaIds: [] + Cns: [] + Description: Allows Outscale Cockpit of this region description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -12938,11 +17034,12 @@ paths: - ApiAccessRule "/ReadApiLogs": description: |- - Lists the logs of the API calls you have performed with this account. For more information, see [About OUTSCALE Monitoring Services (OMS)](https://docs.outscale.com/en/userguide/About-OUTSCALE-Monitoring-Services-(OMS).html).

+ Lists the logs of the API calls you have performed with this account. - **[NOTE]**
+ **[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. + 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 OUTSCALE Monitoring Services (OMS)](https://docs.outscale.com/en/userguide/About-OUTSCALE-Monitoring-Services-OMS.html). post: operationId: ReadApiLogs requestBody: @@ -12950,12 +17047,47 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadApiLogsRequest" + examples: + ex1: + value: + Filters: + QueryIpAddresses: + - 192.0.2.0 + - 198.51.100.0 + 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: + - 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' description: The HTTP 200 response (OK). tags: - ApiLog @@ -12969,12 +17101,27 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadCasRequest" + examples: + ex1: + value: + Filters: + CaIds: + - ca-fedcba0987654321fedcba0987654321 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadCasResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Cas: + - Description: CA example + CaId: ca-fedcba0987654321fedcba0987654321 + CaFingerprint: 1234567890abcdef1234567890abcdef12345678 description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -12982,8 +17129,7 @@ paths: tags: - Ca "/ReadCatalog": - description: Returns the price list of OUTSCALE products and services for the - current Region. + description: Returns the price list of OUTSCALE services for the current Region. post: operationId: ReadCatalog requestBody: @@ -12991,18 +17137,36 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadCatalogRequest" + examples: + ex1: + value: {} responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadCatalogResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Catalog: + 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 "/ReadCatalogs": - description: Returns the price list of OUTSCALE products and services for the - current Region within a specific time period. + description: Returns the price list of OUTSCALE services for the current Region + within a specific time period. post: operationId: ReadCatalogs requestBody: @@ -13010,21 +17174,41 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadCatalogsRequest" + examples: + ex1: + value: + Filters: + CurrentCatalogOnly: true + FromDate: '2021-01-01' + ToDate: '2023-01-01' responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadCatalogsResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + 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.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + description: Lists one or more of your client gateways. post: operationId: ReadClientGateways requestBody: @@ -13032,12 +17216,38 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadClientGatewaysRequest" + examples: + ex1: + value: + Filters: + ClientGatewayIds: + - cgw-12345678 + ex2: + value: + Filters: + BgpAsns: + - 65000 + PublicIps: + - 192.0.2.0 + - 198.51.100.0 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadClientGatewaysResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ClientGateways: + - State: available + BgpAsn: 65000 + Tags: [] + ClientGatewayId: cgw-12345678 + ConnectionType: ipsec.1 + PublicIp: 192.0.2.0 description: The HTTP 200 response (OK). tags: - ClientGateway @@ -13045,7 +17255,7 @@ paths: description: |- Gets the console output for a virtual machine (VM). This console provides the most recent 64 KiB output.

- **[NOTE]**
+ **[IMPORTANT]**
On Windows VMs, the console is handled only on the first boot. It returns no output after the first boot. post: operationId: ReadConsoleOutput @@ -13054,12 +17264,23 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadConsoleOutputRequest" + examples: + ex1: + value: + VmId: i-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadConsoleOutputResponse" + examples: + ex1: + value: + VmId: i-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ConsoleOutput: "..." description: The HTTP 200 response (OK). '400': content: @@ -13082,11 +17303,8 @@ paths: tags: - Vm "/ReadConsumptionAccount": - description: |- - Gets information about the consumption of your account for each billable resource within the specified time period.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `Throttling` error message is returned. + description: Gets information about the consumption of your account for each billable + resource within the specified time period. post: operationId: ReadConsumptionAccount requestBody: @@ -13094,21 +17312,109 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadConsumptionAccountRequest" + examples: + ex1: + value: + FromDate: '2023-06-01' + ToDate: '2023-07-01' responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadConsumptionAccountResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ConsumptionEntries: + - FromDate: 2023-06-01 00:00:00.000000000 +00:00 + SubregionName: eu-west-2a + Value: 720.0 + Title: Instance - On demand - tinav4.c2r4 high performance - + par heure + Category: compute + ToDate: 2023-06-30 00:00:00.000000000 +00:00 + Service: TinaOS-FCU + AccountId: '123456789012' + PayingAccountId: '123456789012' + Operation: RunInstances-OD + Type: BoxUsage:tinav4.c2r4p2 description: The HTTP 200 response (OK). tags: - Account - "/ReadDhcpOptions": + "/ReadDedicatedGroups": description: |- - Gets information about the content of one or more DHCP options sets.

+ > [WARNING]
+ > This feature is currently in beta.
- **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + List one or more dedicated groups of virtual machines (VMs). + post: + operationId: ReadDedicatedGroups + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/ReadDedicatedGroupsRequest" + examples: + ex1: + summary: Filtering on a specific dedicated group + value: + Filters: + DedicatedGroupIds: + - ded-12345678 + ex2: + summary: Filtering on a specific Subregion and CPU generation + value: + Filters: + SubregionNames: + - eu-west-2a + CpuGenerations: + - 4 + responses: + '200': + content: + application/json: + schema: + "$ref": "#/components/schemas/ReadDedicatedGroupsResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + DedicatedGroups: + - VmIds: + - i-12345678 + NetIds: [] + AccountId: '123456789012' + CpuGeneration: 4 + Name: dedicated-group-example + SubregionName: eu-west-2a + DedicatedGroupId: ded-12345678 + description: The HTTP 200 response (OK). + '400': + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + description: The HTTP 400 response (Bad Request). + '401': + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + description: The HTTP 401 response (Unauthorized). + '500': + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + description: The HTTP 500 response (Internal Server Error). + tags: + - DedicatedGroup + "/ReadDhcpOptions": + description: Gets information about the content of one or more DHCP options sets. post: operationId: ReadDhcpOptions requestBody: @@ -13116,21 +17422,47 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadDhcpOptionsRequest" + examples: + ex1: + value: + Filters: + DhcpOptionsSetIds: + - dopt-12345678 + ex2: + value: + Filters: + DomainNameServers: + - 192.0.2.0 + - 198.51.100.0 + DomainNames: + - example.com responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadDhcpOptionsResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + DhcpOptionsSets: + - 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 description: The HTTP 200 response (OK). tags: - DhcpOption "/ReadDirectLinkInterfaces": - description: |- - Lists one or more of your DirectLink interfaces.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `Throttling` error message is returned. + description: Lists one or more of your DirectLink interfaces. post: operationId: ReadDirectLinkInterfaces requestBody: @@ -13138,21 +17470,42 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadDirectLinkInterfacesRequest" + examples: + ex1: + value: + Filters: + DirectLinkInterfaceIds: + - dxvif-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadDirectLinkInterfacesResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + DirectLinkInterfaces: + - Vlan: 101 + OutscalePrivateIp: 172.16.0.4/30 + DirectLinkInterfaceId: dxvif-12345678 + BgpAsn: 65000 + AccountId: '123456789012' + ClientPrivateIp: 172.16.0.5/30 + VirtualGatewayId: vgw-12345678 + DirectLinkInterfaceName: MyDirectLinkInterface + DirectLinkId: dxcon-12345678 + Mtu: 1500 + State: available + InterfaceType: private + Location: PAR1 description: The HTTP 200 response (OK). tags: - DirectLinkInterface "/ReadDirectLinks": - description: |- - Lists all DirectLinks in the Region.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `Throttling` error message is returned. + description: Lists all DirectLinks in the Region. post: operationId: ReadDirectLinks requestBody: @@ -13160,21 +17513,36 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadDirectLinksRequest" + examples: + ex1: + value: + Filters: + DirectLinkIds: + - dxcon-12345678 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 + DirectLinkId: dxcon-12345678 + DirectLinkName: Connection to Outscale + Location: PAR1 + RegionName: eu-west-2 + State: available description: The HTTP 200 response (OK). tags: - DirectLink "/ReadFlexibleGpuCatalog": - description: |- - Lists all flexible GPUs available in the public catalog.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + description: Lists all flexible GPUs available in the public catalog. post: operationId: ReadFlexibleGpuCatalog requestBody: @@ -13182,22 +17550,33 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadFlexibleGpuCatalogRequest" + examples: + ex1: + value: {} responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadFlexibleGpuCatalogResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + FlexibleGpuCatalog: + - VRam: 16000 + Generations: + - v5 + MaxCpu: 80 + MaxRam: 512 + ModelName: nvidia-p100 description: The HTTP 200 response (OK). security: [] tags: - FlexibleGpu "/ReadFlexibleGpus": - description: |- - Lists one or more flexible GPUs (fGPUs) allocated to your account.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + description: Lists one or more flexible GPUs (fGPUs) allocated to your account. post: operationId: ReadFlexibleGpus requestBody: @@ -13205,21 +17584,44 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadFlexibleGpusRequest" + examples: + ex1: + value: + Filters: + FlexibleGpuIds: + - fgpu-12345678 + ex2: + value: + Filters: + ModelNames: + - nvidia-p6 + - nvidia-p100 + States: + - attached 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 + Generation: v5 + ModelName: nvidia-p100 + State: attached + SubregionName: eu-west-2a + VmId: i-12345678 description: The HTTP 200 response (OK). tags: - FlexibleGpu "/ReadImageExportTasks": - description: |- - Lists one or more image export tasks.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + description: Lists one or more image export tasks. post: operationId: ReadImageExportTasks requestBody: @@ -13227,21 +17629,39 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadImageExportTasksRequest" + examples: + ex1: + value: + Filters: + TaskIds: + - image-export-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadImageExportTasksResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ImageExportTasks: + - Tags: [] + ImageId: ami-12345678 + TaskId: image-export-12345678 + Comment: Export of image ami-12345678 + OsuExport: + OsuPrefix: PREFIX/ami-12345678/ + OsuBucket: BUCKET + DiskImageFormat: qcow2 + State: pending/queued + Progress: 0 description: The HTTP 200 response (OK). tags: - Image "/ReadImages": - description: |- - Lists one or more OUTSCALE machine images (OMIs) you can use.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + description: Lists one or more OUTSCALE machine images (OMIs) you can use. post: operationId: ReadImages requestBody: @@ -13249,12 +17669,118 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadImagesRequest" + examples: + ex1: + summary: Reading a specific image + value: + Filters: + ImageIds: + - ami-12345678 + ex2: + summary: Reading Ubuntu and RockyLinux images created by Outscale + value: + Filters: + AccountAliases: + - Outscale + ImageNames: + - Ubuntu* + - RockyLinux* 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: + - StateComment: {} + State: available + RootDeviceType: bsu + RootDeviceName: "/dev/sda1" + ProductCodes: + - '0001' + PermissionsToLaunch: + GlobalPermission: false + AccountIds: [] + AccountId: '123456789012' + Tags: [] + Description: '' + ImageId: ami-12345678 + BlockDeviceMappings: + - DeviceName: "/dev/sda1" + Bsu: + VolumeType: standard + DeleteOnVmDeletion: true + VolumeSize: 50 + SnapshotId: snap-12345678 + ImageType: machine + CreationDate: '2010-10-01T12:34:56.789Z' + 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: + - StateComment: {} + State: available + RootDeviceType: bsu + RootDeviceName: "/dev/sda1" + ProductCodes: + - '0001' + PermissionsToLaunch: + GlobalPermission: true + AccountIds: [] + AccountId: '123456789012' + Tags: [] + Description: '' + ImageId: ami-12345678 + BlockDeviceMappings: + - DeviceName: "/dev/sda1" + Bsu: + VolumeType: standard + DeleteOnVmDeletion: true + VolumeSize: 10 + SnapshotId: snap-12345678 + ImageType: machine + AccountAlias: Outscale + CreationDate: '2010-10-01T12:34:56.789Z' + FileLocation: Outscale/Ubuntu-2010.10.01-0 + Architecture: x86_64 + ImageName: Ubuntu-2010.10.01-0 + - StateComment: {} + State: available + RootDeviceType: bsu + RootDeviceName: "/dev/sda1" + ProductCodes: + - '0001' + PermissionsToLaunch: + GlobalPermission: true + AccountIds: [] + AccountId: '123456789012' + Tags: [] + Description: '' + ImageId: ami-12345678 + BlockDeviceMappings: + - DeviceName: "/dev/sda1" + Bsu: + VolumeType: standard + DeleteOnVmDeletion: true + VolumeSize: 10 + SnapshotId: snap-12345678 + ImageType: machine + AccountAlias: Outscale + CreationDate: '2010-10-01T12:34:56.789Z' + FileLocation: Outscale/RockyLinux-2010.10.01-0 + Architecture: x86_64 + ImageName: RockyLinux-2010.10.01-0 description: The HTTP 200 response (OK). '400': content: @@ -13279,10 +17805,7 @@ paths: "/ReadInternetServices": description: |- Lists one or more of your Internet services.
- An Internet service enables your virtual machines (VMs) launched in a Net to connect to the Internet. By default, a Net includes an Internet service, and each Subnet is public. Every VM launched within a default Subnet has a private IP and a public IP.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + An Internet service enables your virtual machines (VMs) launched in a Net to connect to the Internet. By default, a Net includes an Internet service, and each Subnet is public. Every VM launched within a default Subnet has a private IP and a public IP. post: operationId: ReadInternetServices requestBody: @@ -13290,12 +17813,38 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadInternetServicesRequest" + examples: + ex1: + value: + Filters: + InternetServiceIds: + - igw-12345678 + ex2: + value: + Filters: + TagKeys: + - env + TagValues: + - prod + - test responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadInternetServicesResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + InternetServices: + - Tags: + - Value: prod + Key: env + State: available + NetId: vpc-12345678 + InternetServiceId: igw-12345678 description: The HTTP 200 response (OK). '400': content: @@ -13318,11 +17867,7 @@ paths: tags: - InternetService "/ReadKeypairs": - description: |- - Lists one or more of your keypairs.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + description: Lists one or more of your keypairs. post: operationId: ReadKeypairs requestBody: @@ -13330,12 +17875,26 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadKeypairsRequest" + examples: + ex1: + value: + Filters: + KeypairNames: + - keypair-example responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadKeypairsResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Keypairs: + - KeypairName: keypair-example + 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: @@ -13357,6 +17916,47 @@ paths: description: The HTTP 500 response (Internal Server Error). tags: - Keypair + "/ReadLinkedPolicies": + description: Lists the managed policies linked to a specified user. + post: + operationId: ReadLinkedPolicies + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/ReadLinkedPoliciesRequest" + examples: + ex1: + value: + Filters: + PathPrefix: + - "/" + FirstItem: 1 + ResultsPerPage: 30 + UserName: example-user + responses: + '200': + content: + application/json: + schema: + "$ref": "#/components/schemas/ReadLinkedPoliciesResponse" + examples: + ex1: + value: + HasMoreItems: true + MaxResultsLimit: 30 + MaxResultsTruncated: false + Policies: + CreationDate: '2010-10-01T12:34:56.789Z' + LastModificationDate: '2010-10-01T12:34:56.789Z' + Orn: orn:ows:idauth::012345678910:user-policy/Policy + PolicyId: policy-12345678 + PolicyName: example-user-policy + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + 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. @@ -13367,21 +17967,37 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadListenerRulesRequest" + examples: + ex1: + value: + Filters: + ListenerRuleNames: + - example-listener-rule responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadListenerRulesResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ListenerRules: + - Priority: 10 + VmIds: + - i-12345678 + 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.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `Throttling` error message is returned. + description: Lists the tags associated with one or more specified load balancers. post: operationId: ReadLoadBalancerTags requestBody: @@ -13389,21 +18005,31 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadLoadBalancerTagsRequest" + examples: + ex1: + value: + LoadBalancerNames: + - private-lb-example responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadLoadBalancerTagsResponse" + examples: + ex1: + value: + Tags: + - Value: value1 + LoadBalancerName: private-lb-example + 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.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + description: Lists one or more load balancers and their attributes. post: operationId: ReadLoadBalancers requestBody: @@ -13411,21 +18037,66 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadLoadBalancersRequest" + examples: + ex1: + value: + Filters: + LoadBalancerNames: + - private* responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadLoadBalancersResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + LoadBalancers: + - 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 + LoadBalancerStickyCookiePolicies: [] + SubregionNames: + - eu-west-2a + Listeners: + - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate + BackendPort: 80 + BackendProtocol: HTTP + LoadBalancerPort: 443 + LoadBalancerProtocol: HTTPS + LoadBalancerName: private-lb-example description: The HTTP 200 response (OK). tags: - LoadBalancer "/ReadLocations": description: |- Lists the locations, corresponding to datacenters, where you can set up a DirectLink.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `Throttling` error message is returned. + For more information, see [About DirectLink](https://docs.outscale.com/en/userguide/About-DirectLink.html). post: operationId: ReadLocations requestBody: @@ -13433,22 +18104,31 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadLocationsRequest" + examples: + ex1: + value: {} responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadLocationsResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Locations: + - Name: Telehouse 3, France + Code: PAR1 + - Name: Equinix Pantin, France + Code: PAR4 description: The HTTP 200 response (OK). security: [] tags: - Location "/ReadNatServices": - description: |- - Lists one or more network address translation (NAT) services.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + description: Lists one or more network address translation (NAT) services. post: operationId: ReadNatServices requestBody: @@ -13456,12 +18136,40 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadNatServicesRequest" + examples: + ex1: + value: + Filters: + NatServiceIds: + - nat-12345678 + ex2: + value: + Filters: + NetIds: + - vpc-12345678 + - vpc-87654321 + SubnetIds: + - subnet-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadNatServicesResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + NatServices: + - Tags: [] + SubnetId: subnet-12345678 + NatServiceId: nat-12345678 + PublicIps: + - PublicIpId: eipalloc-12345678 + PublicIp: 192.0.2.0 + NetId: vpc-12345678 + State: available description: The HTTP 200 response (OK). '400': content: @@ -13486,10 +18194,7 @@ paths: "/ReadNetAccessPointServices": description: |- Lists OUTSCALE services available to create Net access points.
- For more information, see [CreateNetAccessPoint](#createnetaccesspoint).

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + For more information, see [CreateNetAccessPoint](#createnetaccesspoint). post: operationId: ReadNetAccessPointServices requestBody: @@ -13497,22 +18202,61 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadNetAccessPointServicesRequest" + examples: + ex1: + summary: Listing one or more services according to their service IDs + value: + Filters: + ServiceIds: + - pl-12345678 + - pl-87654321 + ex2: + summary: Listing one or more services according to their service names + value: + Filters: + ServiceNames: + - com.outscale.eu-west-2.api responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadNetAccessPointServicesResponse" + examples: + ex1: + summary: Listing one or more services according to their service + IDs + value: + Services: + - ServiceName: com.outscale.eu-west-2.api + ServiceId: pl-12345678 + 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 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + summary: Listing one or more services according to their service + names + value: + Services: + - ServiceName: com.outscale.eu-west-2.api + ServiceId: pl-12345678 + 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.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + description: Lists one or more Net access points. post: operationId: ReadNetAccessPoints requestBody: @@ -13520,21 +18264,43 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadNetAccessPointsRequest" + examples: + ex1: + value: + Filters: + NetAccessPointIds: + - vpce-12345678 + ex2: + value: + Filters: + NetIds: + - vpc-12345678 + States: + - available responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadNetAccessPointsResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + NetAccessPoints: + - Tags: [] + NetAccessPointId: vpce-12345678 + RouteTableIds: + - rtb-12345678 + State: available + 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.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + description: Lists one or more peering connections between two Nets. post: operationId: ReadNetPeerings requestBody: @@ -13542,12 +18308,45 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadNetPeeringsRequest" + examples: + ex1: + value: + Filters: + NetPeeringIds: + - pcx-12345678 + ex2: + value: + Filters: + SourceNetNetIds: + - vpc-12345678 + StateNames: + - active + - pending-acceptance responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadNetPeeringsResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + NetPeerings: + - Tags: [] + SourceNet: + NetId: vpc-12345678 + IpRange: 10.0.0.0/16 + AccountId: '123456789012' + NetPeeringId: pcx-12345678 + AccepterNet: + NetId: vpc-12345678 + IpRange: 172.16.0.0/16 + AccountId: '123456789012' + State: + Name: active + Message: Active description: The HTTP 200 response (OK). '400': content: @@ -13570,11 +18369,7 @@ paths: tags: - NetPeering "/ReadNets": - description: |- - Lists one or more Nets.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + description: Lists one or more Nets. post: operationId: ReadNets requestBody: @@ -13582,12 +18377,35 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadNetsRequest" + examples: + ex1: + value: + Filters: + NetIds: + - vpc-12345678 + ex2: + value: + Filters: + States: + - available responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadNetsResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Nets: + - Tags: [] + DhcpOptionsSetId: dopt-12345678 + IpRange: 10.0.0.0/16 + Tenancy: default + NetId: vpc-12345678 + State: available description: The HTTP 200 response (OK). '400': content: @@ -13612,10 +18430,7 @@ paths: "/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.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + A NIC is a virtual network interface that you can attach to a virtual machine (VM) in a Net. post: operationId: ReadNics requestBody: @@ -13623,12 +18438,54 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadNicsRequest" + examples: + ex1: + value: + Filters: + NicIds: + - eni-12345678 + ex2: + value: + Filters: + LinkNicVmIds: + - i-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadNicsResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Nics: + - SubregionName: eu-west-2a + SubnetId: subnet-12345678 + State: in-use + LinkNic: + VmId: i-12345678 + LinkNicId: eni-attach-12345678 + VmAccountId: '123456789012' + DeleteOnVmDeletion: false + DeviceNumber: 0 + State: attached + 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 + PrivateIps: + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + PrivateIp: 10.0.0.4 + IsPrimary: true description: The HTTP 200 response (OK). '400': content: @@ -13650,12 +18507,167 @@ paths: description: The HTTP 500 response (Internal Server Error). tags: - Nic + "/ReadPolicies": + description: Lists all the managed policies available for your account. + post: + operationId: ReadPolicies + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/ReadPoliciesRequest" + examples: + ex1: + value: + Filters: + OnlyLinked: + - true + PathPrefix: + - "/" + Scope: + - ALL + FirstItem: 1 + ResultsPerPage: 30 + responses: + '200': + content: + application/json: + schema: + "$ref": "#/components/schemas/ReadPoliciesResponse" + examples: + ex1: + value: + HasMoreItems: true + MaxResultsLimit: 30 + MaxResultsTruncated: false + Policies: + CreationDate: '2010-10-01T12:34:56.789Z' + Description: Example of description + IsLinkable: true + LastModificationDate: '2010-10-01T12:34:56.789Z' + Orn: orn:ows:idauth::012345678910:user-policy/Policy + Path: "/example/" + PolicyDefaultVersionId: version-12345678 + PolicyId: policy-12345678 + PolicyName: example-user-policy + ResourcesCount: 0 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + description: The HTTP 200 response (OK). + tags: + - Policy + "/ReadPolicy": + description: Lists information about a specified managed policy. + post: + operationId: ReadPolicy + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/ReadPolicyRequest" + examples: + ex1: + value: + PolicyOrn: orn:ows:idauth::012345678910:user-policy/Policy + responses: + '200': + content: + application/json: + schema: + "$ref": "#/components/schemas/ReadPolicyResponse" + examples: + ex1: + value: + Policy: + CreationDate: '2010-10-01T12:34:56.789Z' + Description: Example of description + IsLinkable: true + LastModificationDate: '2010-10-01T12:34:56.789Z' + Orn: orn:ows:idauth::012345678910:user-policy/Policy + Path: "/example/" + PolicyDefaultVersionId: version-12345678 + PolicyId: policy-12345678 + PolicyName: example-user-policy + ResourcesCount: 0 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + description: The HTTP 200 response (OK). + tags: + - Policy + "/ReadPolicyVersion": + description: Lists information about a specified version of a managed policy. + post: + operationId: ReadPolicyVersion + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/ReadPolicyVersionRequest" + examples: + ex1: + value: + PolicyOrn: orn:ows:idauth::012345678910:user-policy/Policy + VersionId: version-12345678 + responses: + '200': + content: + application/json: + schema: + "$ref": "#/components/schemas/ReadPolicyVersionResponse" + examples: + ex1: + value: + PolicyVersion: + Body: '{"Statement": [ {"Action": ["*"],"Effect","Allow","Resource": + ["*"]} ]}' + CreationDate: '2010-10-01T12:34:56.789Z' + DefaultVersion: true + VersionId: version-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + description: The HTTP 200 response (OK). + tags: + - Policy + "/ReadPolicyVersions": + description: Lists information about all the policy versions of a specified managed + policy. + post: + operationId: ReadPolicyVersions + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/ReadPolicyVersionsRequest" + examples: + ex1: + value: + FirstItem: 1 + PolicyOrn: orn:ows:idauth::012345678910:user-policy/Policy + ResultsPerPage: 30 + responses: + '200': + content: + application/json: + schema: + "$ref": "#/components/schemas/ReadPolicyVersionsResponse" + examples: + ex1: + value: + HasMoreItems: true + MaxResultsLimit: 30 + PolicyVersions: + Body: '{"Statement": [ {"Action": ["*"],"Effect","Allow","Resource": + ["*"]} ]}' + CreationDate: '2010-10-01T12:34:56.789Z' + DefaultVersion: true + VersionId: version-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + description: The HTTP 200 response (OK). + tags: + - Policy "/ReadProductTypes": - description: |- - Lists one or more product types.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + description: Lists one or more product types. post: operationId: ReadProductTypes requestBody: @@ -13663,12 +18675,26 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadProductTypesRequest" + examples: + ex1: + value: + Filters: + ProductTypeIds: + - '0001' responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadProductTypesResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ProductTypes: + - ProductTypeId: '0001' + Description: Linux description: The HTTP 200 response (OK). security: [] tags: @@ -13676,7 +18702,7 @@ paths: "/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 [Regions, - Endpoints and Availability Zones Reference](https://docs.outscale.com/en/userguide/Regions-Endpoints-and-Availability-Zones-Reference.html). + Endpoints, and Subregions Reference](https://docs.outscale.com/en/userguide/Regions-Endpoints-and-Subregions-Reference.html). post: operationId: ReadPublicCatalog requestBody: @@ -13684,20 +18710,38 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadPublicCatalogRequest" + examples: + ex1: + value: {} responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadPublicCatalogResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Catalog: + 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). 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 [Regions, Endpoints - and Availability Zones Reference](https://docs.outscale.com/en/userguide/Regions-Endpoints-and-Availability-Zones-Reference.html). + in the endpoint of the request. For more information, see [Regions, Endpoints, + and Subregions Reference](https://docs.outscale.com/en/userguide/Regions-Endpoints-and-Subregions-Reference.html). post: operationId: ReadPublicIpRanges requestBody: @@ -13705,12 +18749,23 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadPublicIpRangesRequest" + examples: + ex1: + value: {} 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 description: The HTTP 200 response (OK). security: [] tags: @@ -13718,10 +18773,7 @@ paths: "/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.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + 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: operationId: ReadPublicIps requestBody: @@ -13729,12 +18781,37 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadPublicIpsRequest" + examples: + ex1: + value: + Filters: + PublicIps: + - 192.0.2.0 + ex2: + value: + Filters: + VmIds: + - i-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadPublicIpsResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + PublicIps: + - 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 description: The HTTP 200 response (OK). '400': content: @@ -13759,9 +18836,7 @@ paths: "/ReadQuotas": description: |- Lists one or more of your quotas.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + For more information, see [About Your Account](https://docs.outscale.com/en/userguide/About-Your-Account.html). post: operationId: ReadQuotas requestBody: @@ -13769,17 +18844,72 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadQuotasRequest" + examples: + ex1: + summary: Reading specific quota + value: + Filters: + QuotaNames: + - lb_limit + ex2: + summary: Reading collection of quotas + value: + Filters: + Collections: + - VPC 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: + - Quotas: + - ShortDescription: Load Balancer Limit + QuotaCollection: LBU + AccountId: '123456789012' + Description: Maximum number of load balancers per region + MaxValue: 20 + UsedValue: 0 + Name: lb_limit + QuotaType: global + ex2: + summary: Reading collection of quotas + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + QuotaTypes: + - 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 + AccountId: '123456789012' + Description: Maximum number of other examples + MaxValue: 50 + UsedValue: 1 + 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. + description: |- + Lists one or more Regions of the OUTSCALE Cloud.

+ For more information, see [About Regions, Endpoints, and Subregions](https://docs.outscale.com/en/userguide/About-Regions-Endpoints-and-Subregions.html). post: operationId: ReadRegions requestBody: @@ -13787,12 +18917,27 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadRegionsRequest" + examples: + ex1: + value: {} responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadRegionsResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + 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: @@ -13800,10 +18945,7 @@ paths: "/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.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + 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: operationId: ReadRouteTables requestBody: @@ -13811,12 +18953,43 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadRouteTablesRequest" + examples: + ex1: + value: + Filters: + RouteTableIds: + - rtb-12345678 + ex2: + value: + Filters: + NetIds: + - vpc-12345678 + - vpc-87654321 + LinkRouteTableMain: true responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadRouteTablesResponse" + examples: + ex1: + value: + RouteTables: + - Routes: + - DestinationIpRange: 10.0.0.0/16 + CreationMethod: CreateRouteTable + State: active + LinkRouteTables: + - RouteTableId: rtb-12345678 + Main: true + LinkRouteTableId: rtbassoc-12345678 + NetId: vpc-12345678 + Tags: [] + RoutePropagatingVirtualGateways: [] + RouteTableId: rtb-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -13848,12 +19021,28 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadSecretAccessKeyRequest" + examples: + ex1: + value: + AccessKeyId: ABCDEFGHIJ0123456789 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadSecretAccessKeyResponse" + 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 + SecretKey: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + LastModificationDate: 2010-10-01 12:34:56.789000000 +00:00 description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -13863,10 +19052,7 @@ paths: "/ReadSecurityGroups": description: |- Lists one or more security groups.
- You can specify either the name of the security groups or their IDs.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + You can specify either the name of the security groups or their IDs. post: operationId: ReadSecurityGroups requestBody: @@ -13874,12 +19060,48 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadSecurityGroupsRequest" + examples: + ex1: + value: + Filters: + SecurityGroupIds: + - sg-12345678 + ex2: + value: + Filters: + InboundRuleIpRanges: + - 192.0.2.0 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadSecurityGroupsResponse" + examples: + ex1: + value: + SecurityGroups: + - 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 + NetId: vpc-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -13910,21 +19132,33 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadServerCertificatesRequest" + examples: + ex1: + value: + Filters: + Paths: + - "/example/" responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadServerCertificatesResponse" + examples: + ex1: + value: + ServerCertificates: + - Path: "/example/" + Id: ABCDEFGHIJKLMNOPQRSTUVWXYZ1234 + Orn: orn:ows:idauth::012345678910:server-certificate/example/server-cert-example + 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.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + description: Lists one or more snapshot export tasks. post: operationId: ReadSnapshotExportTasks requestBody: @@ -13932,21 +19166,40 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadSnapshotExportTasksRequest" + examples: + ex1: + value: + Filters: + TaskIds: + - snap-export-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadSnapshotExportTasksResponse" + examples: + ex1: + value: + SnapshotExportTasks: + - Tags: [] + TaskId: snap-export-12345678 + Comment: Export of snapshot snap-12345678 + OsuExport: + OsuPrefix: PREFIX + OsuBucket: BUCKET + DiskImageFormat: qcow2 + State: pending + 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.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + description: Lists one or more snapshots that are available to you and the permissions + to create volumes from them. post: operationId: ReadSnapshots requestBody: @@ -13954,12 +19207,63 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadSnapshotsRequest" + examples: + ex1: + value: + Filters: + SnapshotIds: + - snap-12345678 + ex2: + value: + Filters: + TagKeys: + - env + TagValues: + - prod + - test responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadSnapshotsResponse" + examples: + ex1: + value: + Snapshots: + - VolumeSize: 10 + AccountId: '123456789012' + VolumeId: vol-12345678 + CreationDate: '2010-10-01T12:34:56.789Z' + PermissionsToCreateVolume: + GlobalPermission: false + AccountIds: [] + Progress: 100 + SnapshotId: snap-12345678 + State: completed + Description: Snapshot created from a volume + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + value: + Snapshots: + - VolumeSize: 10 + AccountId: '123456789012' + VolumeId: vol-12345678 + CreationDate: '2010-10-01T12:34:56.789Z' + PermissionsToCreateVolume: + GlobalPermission: false + AccountIds: [] + Progress: 100 + SnapshotId: snap-12345678 + State: completed + Description: Test snapshot + Tags: + - Value: test + Key: env + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -13984,10 +19288,7 @@ paths: "/ReadSubnets": description: |- Lists one or more of your Subnets.
- If you do not specify any Subnet ID, this action describes all of your Subnets.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + If you do not specify any Subnet ID, this action describes all of your Subnets. post: operationId: ReadSubnets requestBody: @@ -13995,12 +19296,40 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadSubnetsRequest" + examples: + ex1: + value: + Filters: + NetIds: + - vpc-12345678 + ex2: + value: + Filters: + States: + - available + - pending + SubregionNames: + - eu-west-2a responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadSubnetsResponse" + examples: + ex1: + value: + Subnets: + - Tags: [] + SubregionName: eu-west-2a + SubnetId: subnet-12345678 + AvailableIpsCount: 16379 + IpRange: 10.0.0.0/18 + MapPublicIpOnLaunch: false + State: available + NetId: vpc-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -14026,9 +19355,7 @@ paths: description: |- Lists one or more of the enabled Subregions that you can access in the current Region.

- **[NOTE]**
- - If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned.
- - You can use this command to get information about Subregions only in a Region for which you have an account. Otherwise, the `AuthFailure` error message is returned. + For more information, see [About Regions, Endpoints, and Subregions](https://docs.outscale.com/en/userguide/About-Regions-Endpoints-and-Subregions.html). post: operationId: ReadSubregions requestBody: @@ -14036,21 +19363,56 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadSubregionsRequest" + examples: + ex1: + summary: Listing a specific Subregion in the current Region + value: + Filters: + SubregionNames: + - eu-west-2a + ex2: + summary: Listing two specific Subregions in the current Region + value: + Filters: + SubregionNames: + - eu-west-2a + - eu-west-2b responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadSubregionsResponse" + examples: + ex1: + summary: Listing a specific Subregion in the current Region + value: + Subregions: + - State: available + RegionName: eu-west-2 + SubregionName: eu-west-2a + LocationCode: PAR1 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + summary: Listing two specific Subregions in the current Region + value: + Subregions: + - State: available + RegionName: eu-west-2 + SubregionName: eu-west-2a + LocationCode: PAR1 + - State: available + RegionName: eu-west-2 + SubregionName: eu-west-2b + 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.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + description: Lists one or more tags for your resources. post: operationId: ReadTags requestBody: @@ -14058,12 +19420,30 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadTagsRequest" + examples: + ex1: + value: + Filters: + ResourceTypes: + - snapshot + Keys: + - key1 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadTagsResponse" + examples: + ex1: + value: + Tags: + - Value: value1 + ResourceType: snapshot + ResourceId: snap-12345678 + Key: key1 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -14086,7 +19466,9 @@ paths: tags: - Tag "/ReadUsers": - description: Lists all EIM users that have a specified path.
+ description: |- + Lists all EIM users that have a specified path.
+ If you do not specify a path, this action returns a list of all users in the account (or an empty list if there are none). post: operationId: ReadUsers requestBody: @@ -14094,21 +19476,29 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadUsersRequest" + examples: + ex1: + value: {} responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadUsersResponse" + examples: + ex1: + value: + Users: + - UserName: example-user + 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.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + description: Lists one or more virtual gateways. post: operationId: ReadVirtualGateways requestBody: @@ -14116,12 +19506,49 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadVirtualGatewaysRequest" + examples: + ex1: + value: + Filters: + VirtualGatewayIds: + - vgw-12345678 + ex2: + value: + Filters: + States: + - available + LinkStates: + - attached + - detached responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadVirtualGatewaysResponse" + examples: + ex1: + value: + VirtualGateways: + - VirtualGatewayId: vgw-12345678 + ConnectionType: ipsec.1 + NetToVirtualGatewayLinks: [] + State: available + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + value: + VirtualGateways: + - VirtualGatewayId: vgw-12345678 + ConnectionType: ipsec.1 + NetToVirtualGatewayLinks: + - State: attached + NetId: vpc-12345678 + State: available + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - VirtualGateway @@ -14138,12 +19565,36 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadVmGroupsRequest" + examples: + ex1: + value: + Filters: + VmGroupIds: + - vmgroup-12345678901234567890123456789012 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadVmGroupsResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + VmGroups: + SecurityGroupsIds: sg-87654321 + VmIds: i-12345678 + 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: @@ -14178,21 +19629,44 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadVmTemplatesRequest" + examples: + ex1: + value: + Filters: + VmTemplateNames: + - vmtemplate-example + ex2: + value: + Filters: + CpuCores: + - 2 + CpuGeneration: + - v4 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadVmTemplatesResponse" + examples: + ex1: + value: + VmTemplates: + VmTemplateName: vmtemplate-example + CpuPerformance: high + CreationDate: 2010-10-01 12:34:56.789000000 +00:00 + CpuCores: 2 + Tags: [] + Description: '' + ImageId: ami-12345678 + CpuGeneration: v4 + VmTemplateId: vmtemplate-98765432109876543210987654321012 + Ram: 2 description: The HTTP 200 response (OK). tags: - VmTemplate "/ReadVmTypes": - description: |- - Lists one or more predefined VM types.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + description: Lists one or more predefined VM types. post: operationId: ReadVmTypes requestBody: @@ -14200,12 +19674,30 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadVmTypesRequest" + examples: + ex1: + value: + Filters: + VmTypeNames: + - t2.small responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadVmTypesResponse" + examples: + ex1: + value: + VmTypes: + - VolumeCount: 0 + VmTypeName: t2.small + BsuOptimized: false + MaxPrivateIps: 4 + MemorySize: 2.0 + VcoreCount: 1 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). security: [] tags: @@ -14213,10 +19705,7 @@ paths: "/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.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + 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: operationId: ReadVms requestBody: @@ -14224,12 +19713,96 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadVmsRequest" + examples: + ex1: + value: + Filters: + VmIds: + - i-12345678 + ex2: + value: + Filters: + TagKeys: + - env + TagValues: + - prod + - test responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadVmsResponse" + examples: + ex1: + value: + Vms: + - VmType: tinav5.c1r1p2 + VmInitiatedShutdownBehavior: stop + State: running + StateReason: '' + RootDeviceType: ebs + RootDeviceName: "/dev/sda1" + IsSourceDestChecked: true + KeypairName: keypair-example + ImageId: ami-12345678 + DeletionProtection: false + Architecture: x86_64 + NestedVirtualization: false + BlockDeviceMappings: + - DeviceName: "/dev/sda1" + Bsu: + VolumeId: vol-12345678 + 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 + NetId: vpc-12345678 + Nics: + - SubnetId: subnet-12345678 + State: in-use + LinkNic: + State: attached + DeviceNumber: 0 + LinkNicId: eni-attach-12345678 + 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 + PrivateIps: + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + PrivateIp: 10.0.0.4 + IsPrimary: true + Performance: high + Tags: + - Value: prod + Key: env + 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: @@ -14252,11 +19825,8 @@ paths: tags: - Vm "/ReadVmsHealth": - description: |- - Lists the state of one or more back-end virtual machines (VMs) registered with a specified load balancer.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `Throttling` error message is returned. + description: Lists the state of one or more back-end virtual machines (VMs) registered + with a specified load balancer. post: operationId: ReadVmsHealth requestBody: @@ -14264,21 +19834,36 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadVmsHealthRequest" + examples: + ex1: + value: + LoadBalancerName: example-lbu + BackendVmIds: + - i-12345678 + - i-87654321 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadVmsHealthResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + 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).

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + description: Lists the status of one or more virtual machines (VMs). post: operationId: ReadVmsState requestBody: @@ -14286,12 +19871,44 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadVmsStateRequest" + examples: + ex1: + value: + AllVms: true + ex2: + value: + Filters: + SubregionNames: + - eu-west-2a responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadVmsStateResponse" + examples: + ex1: + value: + VmStates: + - VmId: i-12345678 + VmState: running + SubregionName: eu-west-2a + MaintenanceEvents: [] + - VmId: i-87654321 + VmState: stopped + SubregionName: eu-west-2a + MaintenanceEvents: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + value: + VmStates: + - VmId: i-12345678 + VmState: running + SubregionName: eu-west-2a + MaintenanceEvents: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -14314,11 +19931,7 @@ paths: tags: - Vm "/ReadVolumes": - description: |- - Lists one or more specified Block Storage Unit (BSU) volumes.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + description: Lists one or more specified Block Storage Unit (BSU) volumes. post: operationId: ReadVolumes requestBody: @@ -14326,12 +19939,46 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadVolumesRequest" + examples: + ex1: + value: + Filters: + VolumeIds: + - vol-12345678 + ex2: + value: + Filters: + VolumeStates: + - in-use + VolumeTypes: + - gp2 + - io1 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadVolumesResponse" + examples: + ex1: + value: + Volumes: + - VolumeId: vol-12345678 + Tags: [] + VolumeType: gp2 + SubregionName: eu-west-2a + State: in-use + CreationDate: '2010-10-01T12:34:56.789Z' + Iops: 100 + LinkedVolumes: + - VolumeId: vol-12345678 + DeleteOnVmDeletion: false + DeviceName: "/dev/sdb" + State: attached + VmId: i-12345678 + Size: 10 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -14354,11 +20001,7 @@ paths: tags: - Volume "/ReadVpnConnections": - description: |- - Lists one or more VPN connections.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + description: Lists one or more VPN connections. post: operationId: ReadVpnConnections requestBody: @@ -14366,12 +20009,46 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadVpnConnectionsRequest" + examples: + ex1: + value: + Filters: + VpnConnectionIds: + - vpn-12345678 + ex2: + value: + Filters: + ClientGatewayIds: + - cgw-12345678 + VirtualGatewayIds: + - vgw-12345678 + - vgw-87654321 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadVpnConnectionsResponse" + examples: + ex1: + value: + VpnConnections: + - Routes: [] + Tags: [] + ClientGatewayConfiguration: "..." + StaticRoutesOnly: true + VirtualGatewayId: vgw-12345678 + ConnectionType: ipsec.1 + ClientGatewayId: cgw-12345678 + State: pending + VgwTelemetries: + - StateDescription: IPSEC IS DOWN + AcceptedRouteCount: 0 + LastStateChangeDate: '2017-05-10T12:34:56.789Z' + OutsideIpAddress: 192.0.2.0 + VpnConnectionId: vpn-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - VpnConnection @@ -14386,12 +20063,22 @@ paths: application/json: schema: "$ref": "#/components/schemas/RebootVmsRequest" + examples: + ex1: + value: + VmIds: + - i-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/RebootVmsResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -14424,12 +20111,24 @@ paths: application/json: schema: "$ref": "#/components/schemas/RegisterVmsInLoadBalancerRequest" + examples: + ex1: + value: + LoadBalancerName: example-lbu + BackendVmIds: + - i-12345678 + - i-87654321 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/RegisterVmsInLoadBalancerResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - LoadBalancer @@ -14444,12 +20143,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/RejectNetPeeringRequest" + examples: + ex1: + value: + NetPeeringId: pcx-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/RejectNetPeeringResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -14477,30 +20185,6 @@ paths: description: The HTTP 500 response (Internal Server Error). tags: - NetPeering - "/ResetAccountPassword": - description: |- - Replaces the account password with the new one you provide.
- You must also provide the token you received by email when asking for a password reset using the SendResetPasswordEmail method.

- Password strength is tested through heuristic algorithms. For more information, see the [zxcvbn GitHub](https://github.com/dropbox/zxcvbn).

- **[NOTE]**
- To protect against brute force attacks, the number of requests allowed for this method in a given time period is limited. - post: - operationId: ResetAccountPassword - requestBody: - content: - application/json: - schema: - "$ref": "#/components/schemas/ResetAccountPasswordRequest" - responses: - '200': - content: - application/json: - schema: - "$ref": "#/components/schemas/ResetAccountPasswordResponse" - description: The HTTP 200 response (OK). - security: [] - tags: - - Account "/ScaleDownVmGroup": description: |- > [WARNING]
@@ -14515,12 +20199,23 @@ paths: application/json: schema: "$ref": "#/components/schemas/ScaleDownVmGroupRequest" + examples: + ex1: + summary: Removing 1 VM from a VM group + value: + VmGroupId: vmgroup-12345678901234567890123456789012 + VmSubtraction: 1 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ScaleDownVmGroupResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -14556,12 +20251,23 @@ paths: application/json: schema: "$ref": "#/components/schemas/ScaleUpVmGroupRequest" + examples: + ex1: + summary: Adding 2 VMs in a VM group + value: + VmGroupId: vmgroup-12345678901234567890123456789012 + VmAddition: 2 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ScaleUpVmGroupResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -14583,29 +20289,36 @@ paths: description: The HTTP 500 response (Internal Server Error). tags: - VmGroup - "/SendResetPasswordEmail": + "/SetDefaultPolicyVersion": description: |- - Sends an email to the email address provided for the account with a token to reset your password.
- You need to provide this token when updating the account password using the ResetAccountPassword method.

- **[NOTE]**
- To protect against brute force attacks, the number of requests allowed for this method in a given time period is limited. + 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: - operationId: SendResetPasswordEmail + operationId: SetDefaultPolicyVersion requestBody: content: application/json: schema: - "$ref": "#/components/schemas/SendResetPasswordEmailRequest" + "$ref": "#/components/schemas/SetDefaultPolicyVersionRequest" + examples: + ex1: + value: + PolicyOrn: orn:ows:idauth::012345678910:user-policy/Policy + VersionId: version-12345678 responses: '200': content: application/json: schema: - "$ref": "#/components/schemas/SendResetPasswordEmailResponse" + "$ref": "#/components/schemas/SetDefaultPolicyVersionResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). - security: [] tags: - - Account + - Policy "/StartVms": description: |- Start one or more virtual machines (VMs).
@@ -14617,12 +20330,26 @@ paths: application/json: schema: "$ref": "#/components/schemas/StartVmsRequest" + examples: + ex1: + value: + VmIds: + - i-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/StartVmsResponse" + examples: + ex1: + value: + Vms: + - VmId: i-12345678 + PreviousState: stopped + CurrentState: pending + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -14655,12 +20382,26 @@ paths: application/json: schema: "$ref": "#/components/schemas/StopVmsRequest" + examples: + ex1: + value: + VmIds: + - i-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/StopVmsResponse" + examples: + ex1: + value: + Vms: + - VmId: i-12345678 + PreviousState: running + CurrentState: stopping + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -14693,12 +20434,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/UnlinkFlexibleGpuRequest" + examples: + ex1: + value: + FlexibleGpuId: fgpu-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/UnlinkFlexibleGpuResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - FlexibleGpu @@ -14713,12 +20463,22 @@ paths: application/json: schema: "$ref": "#/components/schemas/UnlinkInternetServiceRequest" + examples: + ex1: + value: + InternetServiceId: igw-12345678 + NetId: vpc-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/UnlinkInternetServiceResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -14751,12 +20511,38 @@ paths: 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 + ex2: + summary: Unlinking public IPs from a load balancer + value: + LoadBalancerName: example-lbu + BackendIps: + - 192.0.2.0 + - 198.51.100.0 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/UnlinkLoadBalancerBackendMachinesResponse" + examples: + ex1: + summary: Unlinking VMs from a load balancer + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + summary: Unlinking public IPs from a load balancer + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - LoadBalancer @@ -14771,12 +20557,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/UnlinkNicRequest" + examples: + ex1: + value: + LinkNicId: eni-attach-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/UnlinkNicResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -14798,6 +20593,34 @@ paths: description: The HTTP 500 response (Internal Server Error). tags: - Nic + "/UnlinkPolicy": + description: Removes a managed policy from a specific user. + post: + operationId: UnlinkPolicy + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/UnlinkPolicyRequest" + examples: + ex1: + value: + PolicyOrn: orn:ows:idauth::012345678910:user-policy/Policy + UserName: example-user + responses: + '200': + content: + application/json: + schema: + "$ref": "#/components/schemas/UnlinkPolicyResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + description: The HTTP 200 response (OK). + tags: + - Policy "/UnlinkPrivateIps": description: Unassigns one or more secondary private IPs from a network interface card (NIC). @@ -14808,12 +20631,24 @@ paths: application/json: schema: "$ref": "#/components/schemas/UnlinkPrivateIpsRequest" + examples: + ex1: + value: + NicId: eni-12345678 + PrivateIps: + - 10.0.0.6 + - 10.0.0.7 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/UnlinkPrivateIpsResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -14839,7 +20674,7 @@ paths: description: |- Disassociates a public IP from the virtual machine (VM) or network interface card (NIC) it is associated with.

- **[NOTE]**
+ **[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: operationId: UnlinkPublicIp @@ -14848,12 +20683,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/UnlinkPublicIpRequest" + examples: + ex1: + value: + PublicIp: 192.0.2.0 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/UnlinkPublicIpResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -14886,12 +20730,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/UnlinkRouteTableRequest" + examples: + ex1: + value: + LinkRouteTableId: rtbassoc-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/UnlinkRouteTableResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -14924,12 +20777,22 @@ paths: application/json: schema: "$ref": "#/components/schemas/UnlinkVirtualGatewayRequest" + examples: + ex1: + value: + VirtualGatewayId: vgw-12345678 + NetId: vpc-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/UnlinkVirtualGatewayResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - VirtualGateway @@ -14944,12 +20807,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/UnlinkVolumeRequest" + examples: + ex1: + value: + VolumeId: vol-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/UnlinkVolumeResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -14972,11 +20844,8 @@ paths: tags: - Volume "/UpdateAccessKey": - description: |- - Modifies the attributes of the specified access key of either your root account or an EIM user.

- - **[NOTE]**
- To protect against brute force attacks, the number of requests allowed for this method in a given time period is limited. + description: Modifies the attributes of the specified access key of either your + root account or an EIM user. post: operationId: UpdateAccessKey requestBody: @@ -14984,12 +20853,42 @@ paths: application/json: schema: "$ref": "#/components/schemas/UpdateAccessKeyRequest" + examples: + ex1: + summary: Updating the expiration date of the access key + value: + AccessKeyId: ABCDEFGHIJ0123456789 + State: ACTIVE + ExpirationDate: '2063-04-05' + ex2: + summary: Updating one of your own access keys (if you are the root + account or an EIM user) + value: + AccessKeyId: ABCDEFGHIJ0123456789 + State: ACTIVE + ex3: + summary: Updating the access key of a specific EIM user + value: + AccessKeyId: ABCDEFGHIJ0123456789 + State: ACTIVE + UserName: example-user responses: '200': content: application/json: schema: "$ref": "#/components/schemas/UpdateAccessKeyResponse" + 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: 2017-05-10 12:34:56.789000000 +00:00 description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -15005,12 +20904,36 @@ paths: application/json: schema: "$ref": "#/components/schemas/UpdateAccountRequest" + examples: + ex1: + value: + AdditionalEmails: + - another@example.com + - yet.another@example.com responses: '200': content: application/json: schema: "$ref": "#/components/schemas/UpdateAccountResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Account: + ZipCode: '92210' + CompanyName: EXAMPLE SAS + FirstName: JEAN + AdditionalEmails: + - another@example.com + - yet.another@example.com + City: SAINT-CLOUD + Country: FRANCE + LastName: DUPONT + AccountId: '123456789012' + CustomerId: '87654321' + Email: example@example.com description: The HTTP 200 response (OK). tags: - Account @@ -15018,7 +20941,7 @@ paths: description: |- Updates the API access policy of your account.

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

\n\n**[NOTE]**

\n\n**[WARNING]**
\n- The new rule you specify fully replaces the old rule. Therefore, for a parameter that is not specified, any previously set value is deleted.
\n- If, as result of your modification, you no longer have access to the APIs, you @@ -15071,12 +21039,31 @@ paths: application/json: schema: "$ref": "#/components/schemas/UpdateApiAccessRuleRequest" + examples: + ex1: + value: + ApiAccessRuleId: aar-1234567890abcdef1234567890abcdef + IpRanges: + - 0.0.0.0/0 + 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 description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -15093,18 +21080,92 @@ paths: application/json: schema: "$ref": "#/components/schemas/UpdateCaRequest" + examples: + ex1: + value: + CaId: ca-fedcba0987654321fedcba0987654321 + Description: New description responses: '200': content: application/json: schema: "$ref": "#/components/schemas/UpdateCaResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Ca: + Description: New description + CaId: ca-fedcba0987654321fedcba0987654321 + CaFingerprint: 1234567890abcdef1234567890abcdef12345678 description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] - BasicAuth: [] tags: - Ca + "/UpdateDedicatedGroup": + description: |- + > [WARNING]
+ > This feature is currently in beta.
+ + Modifies the name of a specified dedicated group.
+ post: + operationId: UpdateDedicatedGroup + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/UpdateDedicatedGroupRequest" + examples: + ex1: + value: + DedicatedGroupId: ded-12345678 + Name: New-dedicated-group-name + 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 + Name: New-dedicated-group-name + SubregionName: eu-west-2a + DedicatedGroupId: ded-12345678 + description: The HTTP 200 response (OK). + '400': + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + description: The HTTP 400 response (Bad Request). + '401': + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + description: The HTTP 401 response (Unauthorized). + '500': + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + description: The HTTP 500 response (Internal Server Error). + tags: + - DedicatedGroup "/UpdateDirectLinkInterface": description: Modifies the maximum transmission unit (MTU) of a DirectLink interface. post: @@ -15114,12 +21175,36 @@ paths: application/json: schema: "$ref": "#/components/schemas/UpdateDirectLinkInterfaceRequest" + examples: + ex1: + value: + DirectLinkInterfaceId: dxvif-12345678 + Mtu: 1500 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/UpdateDirectLinkInterfaceResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + DirectLinkInterface: + Vlan: 101 + OutscalePrivateIp: 172.16.0.4/30 + DirectLinkInterfaceId: dxvif-12345678 + BgpAsn: 65000 + AccountId: '123456789012' + ClientPrivateIp: 172.16.0.5/30 + VirtualGatewayId: vgw-12345678 + DirectLinkInterfaceName: MyDirectLinkInterface + DirectLinkId: dxcon-12345678 + Mtu: 1500 + State: available + InterfaceType: private + Location: PAR1 description: The HTTP 200 response (OK). tags: - DirectLinkInterface @@ -15132,12 +21217,29 @@ paths: application/json: schema: "$ref": "#/components/schemas/UpdateFlexibleGpuRequest" + examples: + ex1: + value: + FlexibleGpuId: fgpu-12345678 + 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 + Generation: v5 + ModelName: nvidia-p100 + State: allocated + SubregionName: eu-west-2a description: The HTTP 200 response (OK). tags: - FlexibleGpu @@ -15153,12 +21255,169 @@ paths: application/json: schema: "$ref": "#/components/schemas/UpdateImageRequest" + examples: + ex1: + summary: Adding permission + value: + ImageId: ami-12345678 + PermissionsToLaunch: + Additions: + AccountIds: + - '987654321098' + ex2: + summary: Removing permission + value: + ImageId: ami-12345678 + PermissionsToLaunch: + Removals: + AccountIds: + - '987654321098' + ex3: + summary: Making an image public to everyone + value: + ImageId: ami-12345678 + PermissionsToLaunch: + Additions: + GlobalPermission: true + ex4: + summary: Making an image private to everyone + value: + ImageId: ami-12345678 + PermissionsToLaunch: + Removals: + GlobalPermission: true 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' + Tags: [] + Description: '' + ImageId: ami-12345678 + BlockDeviceMappings: + - DeviceName: "/dev/sda1" + Bsu: + VolumeType: standard + DeleteOnVmDeletion: true + VolumeSize: 50 + SnapshotId: snap-12345678 + ImageType: machine + CreationDate: '2010-10-01T12:34:56.789Z' + FileLocation: 123456789012/image-example + Architecture: x86_64 + ImageName: image-example + 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' + Tags: [] + Description: '' + ImageId: ami-12345678 + BlockDeviceMappings: + - DeviceName: "/dev/sda1" + Bsu: + VolumeType: standard + DeleteOnVmDeletion: true + VolumeSize: 50 + SnapshotId: snap-12345678 + ImageType: machine + CreationDate: '2010-10-01T12:34:56.789Z' + FileLocation: 123456789012/image-example + Architecture: x86_64 + ImageName: image-example + 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' + Tags: [] + Description: '' + ImageId: ami-12345678 + BlockDeviceMappings: + - DeviceName: "/dev/sda1" + Bsu: + VolumeType: standard + DeleteOnVmDeletion: true + VolumeSize: 50 + SnapshotId: snap-12345678 + ImageType: machine + CreationDate: '2010-10-01T12:34:56.789Z' + FileLocation: 123456789012/image-example + Architecture: x86_64 + ImageName: image-example + 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' + Tags: [] + Description: '' + ImageId: ami-12345678 + BlockDeviceMappings: + - DeviceName: "/dev/sda1" + Bsu: + VolumeType: standard + DeleteOnVmDeletion: true + VolumeSize: 50 + SnapshotId: snap-12345678 + ImageType: machine + CreationDate: '2010-10-01T12:34:56.789Z' + FileLocation: 123456789012/image-example + Architecture: x86_64 + ImageName: image-example description: The HTTP 200 response (OK). '400': content: @@ -15191,12 +21450,31 @@ paths: application/json: schema: "$ref": "#/components/schemas/UpdateListenerRuleRequest" + examples: + ex1: + value: + ListenerRuleName: example-listener-rule + HostPattern: "*.newhost.com" responses: '200': content: application/json: schema: "$ref": "#/components/schemas/UpdateListenerRuleResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ListenerRule: + Priority: 10 + VmIds: + - i-12345678 + ListenerRuleName: example-listener-rule + Action: forward + ListenerId: 123456 + HostNamePattern: "*.newhost.com" + ListenerRuleId: 1234 description: The HTTP 200 response (OK). tags: - Listener @@ -15216,12 +21494,217 @@ paths: application/json: schema: "$ref": "#/components/schemas/UpdateLoadBalancerRequest" + examples: + ex1: + summary: Updating health checks + value: + LoadBalancerName: private-lb-example + HealthCheck: + HealthyThreshold: 10 + CheckInterval: 30 + Path: "/index.html" + Port: 8080 + Protocol: HTTPS + Timeout: 5 + UnhealthyThreshold: 5 + ex2: + summary: Updating access logs + value: + LoadBalancerName: private-lb-example + AccessLog: + PublicationInterval: 5 + IsEnabled: true + OsuBucketName: BUCKET + OsuBucketPrefix: PREFIX + ex3: + summary: Updating policies + value: + LoadBalancerName: private-lb-example + LoadBalancerPort: 443 + PolicyNames: + - example-browser-policy + ex4: + summary: Updating SSL certificate + value: + LoadBalancerName: private-lb-example + LoadBalancerPort: 443 + ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/AnotherCertificate 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: + PublicationInterval: 60 + IsEnabled: false + DnsName: private-lb-example.123456789.eu-west-2.lbu.outscale.com + HealthCheck: + UnhealthyThreshold: 5 + Timeout: 5 + CheckInterval: 30 + Path: "/index.html" + Protocol: HTTPS + HealthyThreshold: 10 + Port: 8080 + LoadBalancerStickyCookiePolicies: [] + SubregionNames: + - eu-west-2a + Listeners: + - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate + BackendPort: 80 + BackendProtocol: HTTP + LoadBalancerPort: 443 + LoadBalancerProtocol: HTTPS + LoadBalancerName: private-lb-example + 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: + PublicationInterval: 5 + 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 + LoadBalancerStickyCookiePolicies: [] + SubregionNames: + - eu-west-2a + Listeners: + - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate + BackendPort: 80 + BackendProtocol: HTTP + LoadBalancerPort: 443 + LoadBalancerProtocol: HTTPS + LoadBalancerName: private-lb-example + 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: + 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: + - PolicyName: example-browser-policy + CookieExpirationPeriod: 1 + SubregionNames: + - eu-west-2a + Listeners: + - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate + BackendPort: 80 + BackendProtocol: HTTP + LoadBalancerPort: 443 + LoadBalancerProtocol: HTTPS + LoadBalancerName: private-lb-example + 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: + 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 + Listeners: + - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/AnotherCertificate + BackendPort: 80 + BackendProtocol: HTTP + LoadBalancerPort: 443 + LoadBalancerProtocol: HTTPS + LoadBalancerName: private-lb-example description: The HTTP 200 response (OK). tags: - LoadBalancer @@ -15234,12 +21717,29 @@ paths: application/json: schema: "$ref": "#/components/schemas/UpdateNetRequest" + examples: + ex1: + value: + NetId: vpc-12345678 + 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 description: The HTTP 200 response (OK). '400': content: @@ -15272,12 +21772,52 @@ paths: application/json: schema: "$ref": "#/components/schemas/UpdateNetAccessPointRequest" + examples: + ex1: + summary: Adding a route table + value: + NetAccessPointId: vpce-12345678 + AddRouteTableIds: + - rtb-87654321 + ex2: + summary: Removing a route table + value: + NetAccessPointId: vpce-12345678 + RemoveRouteTableIds: + - rtb-12345678 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 + RouteTableIds: + - rtb-12345678 + - rtb-87654321 + State: available + 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 + RouteTableIds: [] + State: available + NetId: vpc-12345678 + ServiceName: com.outscale.eu-west-2.oos description: The HTTP 200 response (OK). tags: - NetAccessPoint @@ -15291,12 +21831,125 @@ paths: 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 + ex2: + summary: Modifying the security groups of a NIC + value: + NicId: eni-12345678 + SecurityGroupIds: + - sg-12345678 + ex3: + summary: Modifying the description of a NIC + value: + NicId: eni-12345678 + 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: + SubregionName: eu-west-2a + SubnetId: subnet-12345678 + State: in-use + LinkNic: + VmId: i-12345678 + LinkNicId: eni-attach-12345678 + VmAccountId: '123456789012' + DeleteOnVmDeletion: false + DeviceNumber: 0 + State: attached + 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 + PrivateIps: + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + PrivateIp: 10.0.0.4 + IsPrimary: true + ex2: + summary: Modifying the security groups of a NIC + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Nic: + SubregionName: eu-west-2a + SubnetId: subnet-12345678 + State: in-use + LinkNic: + VmId: i-12345678 + LinkNicId: eni-attach-12345678 + VmAccountId: '123456789012' + DeleteOnVmDeletion: true + DeviceNumber: 0 + State: attached + 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 + PrivateIps: + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + PrivateIp: 10.0.0.4 + IsPrimary: true + ex3: + summary: Modifying the description of a NIC + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Nic: + SubregionName: eu-west-2a + SubnetId: subnet-12345678 + State: in-use + LinkNic: + VmId: i-12345678 + LinkNicId: eni-attach-12345678 + VmAccountId: '123456789012' + DeleteOnVmDeletion: true + DeviceNumber: 0 + State: attached + 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 + PrivateIps: + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + PrivateIp: 10.0.0.4 + IsPrimary: true description: The HTTP 200 response (OK). '400': content: @@ -15338,12 +21991,43 @@ paths: 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 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/UpdateRouteResponse" + examples: + ex1: + summary: Updating a route to a virtual gateway + value: + 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: + - RouteTableId: rtb-12345678 + Main: false + SubnetId: subnet-12345678 + LinkRouteTableId: rtbassoc-12345678 + NetId: vpc-12345678 + Tags: [] + RoutePropagatingVirtualGateways: [] + RouteTableId: rtb-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -15375,15 +22059,89 @@ paths: application/json: schema: "$ref": "#/components/schemas/UpdateRoutePropagationRequest" + examples: + ex1: + value: + VirtualGatewayId: vgw-12345678 + RouteTableId: rtb-12345678 + Enable: true responses: '200': content: application/json: schema: "$ref": "#/components/schemas/UpdateRoutePropagationResponse" + examples: + ex1: + value: + RouteTable: + Routes: + - DestinationIpRange: 10.0.0.0/16 + CreationMethod: CreateRouteTable + State: active + LinkRouteTables: + - RouteTableId: rtb-12345678 + Main: true + LinkRouteTableId: rtbassoc-12345678 + NetId: vpc-12345678 + Tags: [] + RoutePropagatingVirtualGateways: + - VirtualGatewayId: vgw-12345678 + RouteTableId: rtb-12345678 + 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: + operationId: UpdateRouteTableLink + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/UpdateRouteTableLinkRequest" + examples: + ex1: + value: + LinkRouteTableId: rtbassoc-12345678 + RouteTableId: rtb-12345678 + responses: + '200': + content: + application/json: + schema: + "$ref": "#/components/schemas/UpdateRouteTableLinkResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + LinkRouteTableId: rtbassoc-12345678 + description: The HTTP 200 response (OK). + '400': + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + description: The HTTP 400 response (Bad Request). + '401': + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + description: The HTTP 401 response (Unauthorized). + '500': + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + description: The HTTP 500 response (Internal Server Error). + tags: + - RouteTable "/UpdateServerCertificate": description: Modifies the name and/or the path of a specified server certificate. post: @@ -15393,12 +22151,26 @@ paths: application/json: schema: "$ref": "#/components/schemas/UpdateServerCertificateRequest" + examples: + ex1: + value: + Name: server-cert-example + NewName: new-name responses: '200': content: application/json: schema: "$ref": "#/components/schemas/UpdateServerCertificateResponse" + examples: + ex1: + value: + ServerCertificate: + Path: "/example/" + Id: ABCDEFGHIJKLMNOPQRSTUVWXYZ1234 + Name: new-name + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - ServerCertificate @@ -15414,12 +22186,117 @@ paths: application/json: schema: "$ref": "#/components/schemas/UpdateSnapshotRequest" + examples: + ex1: + summary: Adding permission + value: + SnapshotId: snap-12345678 + PermissionsToCreateVolume: + Additions: + AccountIds: + - '987654321098' + ex2: + summary: Removing permission + value: + SnapshotId: snap-12345678 + PermissionsToCreateVolume: + Removals: + AccountIds: + - '987654321098' + ex3: + summary: Making an image public to everyone + value: + SnapshotId: snap-12345678 + PermissionsToCreateVolume: + Additions: + GlobalPermission: true + ex4: + summary: Making an image private to everyone + value: + SnapshotId: snap-12345678 + PermissionsToCreateVolume: + Removals: + GlobalPermission: true responses: '200': content: application/json: schema: "$ref": "#/components/schemas/UpdateSnapshotResponse" + examples: + ex1: + summary: Adding permission + value: + Snapshot: + VolumeSize: 10 + AccountId: '123456789012' + VolumeId: vol-12345678 + CreationDate: '2010-10-01T12:34:56.789Z' + PermissionsToCreateVolume: + GlobalPermission: false + AccountIds: + - '987654321098' + Progress: 100 + SnapshotId: snap-12345678 + State: completed + Description: Snapshot created from a volume + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + summary: Removing permission + value: + Snapshot: + VolumeSize: 10 + AccountId: '123456789012' + VolumeId: vol-12345678 + CreationDate: '2010-10-01T12:34:56.789Z' + PermissionsToCreateVolume: + GlobalPermission: false + AccountIds: [] + Progress: 100 + SnapshotId: snap-12345678 + State: completed + Description: Snapshot created from a volume + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex3: + summary: Making an image public to everyone + value: + Snapshot: + VolumeSize: 10 + AccountId: '123456789012' + VolumeId: vol-12345678 + CreationDate: '2010-10-01T12:34:56.789Z' + PermissionsToCreateVolume: + GlobalPermission: true + AccountIds: [] + Progress: 100 + SnapshotId: snap-12345678 + State: completed + Description: Snapshot created from a volume + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex4: + summary: Making an image private to everyone + value: + Snapshot: + VolumeSize: 10 + AccountId: '123456789012' + VolumeId: vol-12345678 + CreationDate: '2010-10-01T12:34:56.789Z' + PermissionsToCreateVolume: + GlobalPermission: false + AccountIds: [] + Progress: 100 + SnapshotId: snap-12345678 + State: completed + Description: Snapshot created from a volume + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -15450,12 +22327,31 @@ paths: application/json: schema: "$ref": "#/components/schemas/UpdateSubnetRequest" + examples: + ex1: + value: + SubnetId: subnet-12345678 + MapPublicIpOnLaunch: true responses: '200': content: application/json: schema: "$ref": "#/components/schemas/UpdateSubnetResponse" + examples: + ex1: + value: + Subnet: + Tags: [] + SubregionName: eu-west-2a + SubnetId: subnet-12345678 + AvailableIpsCount: 16379 + IpRange: 10.0.0.0/18 + MapPublicIpOnLaunch: true + State: available + NetId: vpc-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -15486,12 +22382,27 @@ paths: application/json: schema: "$ref": "#/components/schemas/UpdateUserRequest" + examples: + ex1: + value: + UserName: example-user + NewUserName: test-user + NewPath: "/product/" responses: '200': content: application/json: schema: "$ref": "#/components/schemas/UpdateUserResponse" + examples: + ex1: + value: + User: + UserName: test-user + UserId: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 + Path: "/product/" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - User @@ -15510,12 +22421,160 @@ paths: application/json: schema: "$ref": "#/components/schemas/UpdateVmRequest" + examples: + ex1: + value: + VmId: i-12345678 + VmType: tinav5.c2r2p2 + ex2: + value: + VmId: i-12345678 + UserData: "..." responses: '200': content: application/json: schema: "$ref": "#/components/schemas/UpdateVmResponse" + examples: + ex1: + value: + Vm: + 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: + - DeviceName: "/dev/sda1" + Bsu: + VolumeId: vol-12345678 + 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 + NetId: vpc-12345678 + Nics: + - SubnetId: subnet-12345678 + State: in-use + LinkNic: + State: attached + DeviceNumber: 0 + LinkNicId: eni-attach-12345678 + 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 + PrivateIps: + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + PrivateIp: 10.0.0.4 + IsPrimary: true + Performance: high + Tags: + - Value: prod + Key: env + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + value: + Vm: + 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: + - DeviceName: "/dev/sda1" + Bsu: + VolumeId: vol-12345678 + 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 + NetId: vpc-12345678 + Nics: + - SubnetId: subnet-12345678 + State: in-use + LinkNic: + State: attached + DeviceNumber: 0 + LinkNicId: eni-attach-12345678 + 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 + PrivateIps: + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + PrivateIp: 10.0.0.4 + IsPrimary: true + Performance: high + Tags: + - Value: prod + Key: env + 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: @@ -15550,12 +22609,43 @@ paths: application/json: schema: "$ref": "#/components/schemas/UpdateVmGroupRequest" + examples: + ex1: + summary: Updating the name and description of a VM group + value: + 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 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/UpdateVmGroupResponse" + examples: + ex1: + value: + VmGroup: + VmTemplateId: vmtemplate-98765432109876543210987654321012 + SecurityGroupIds: + - sg-12345678 + VmIds: [] + CreationDate: 2010-10-01 12:34:56.789000000 +00:00 + VmCount: 2 + VmGroupName: new-name + 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: @@ -15590,12 +22680,33 @@ paths: application/json: schema: "$ref": "#/components/schemas/UpdateVmTemplateRequest" + examples: + ex1: + value: + Description: The new description of the VM template + VmTemplateId: vmtemplate-98765432109876543210987654321012 + VmTemplateName: second-name responses: '200': content: application/json: schema: "$ref": "#/components/schemas/UpdateVmTemplateResponse" + examples: + ex1: + value: + 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 + CpuGeneration: v4 + VmTemplateId: vmtemplate-98765432109876543210987654321012 + Ram: 2 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - VmTemplate @@ -15613,12 +22724,55 @@ paths: application/json: schema: "$ref": "#/components/schemas/UpdateVolumeRequest" + examples: + ex1: + summary: Updating the size of a volume + value: + VolumeId: vol-12345678 + Size: 50 + ex2: + summary: Updating the type of a volume to io1 + value: + VolumeId: vol-12345678 + VolumeType: io1 + Iops: 200 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/UpdateVolumeResponse" + examples: + ex1: + summary: Updating the size of a volume + value: + 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 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + summary: Updating the type of a volume to io1 + value: + 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 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -15649,12 +22803,40 @@ paths: application/json: schema: "$ref": "#/components/schemas/UpdateVpnConnectionRequest" + examples: + ex1: + value: + VpnConnectionId: vpn-12345678 + VpnOptions: + TunnelInsideIpRange: 169.254.254.22/30 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/UpdateVpnConnectionResponse" + examples: + ex1: + value: + VpnConnection: + VpnOptions: + TunnelInsideIpRange: 169.254.254.22/30 + Routes: [] + Tags: [] + ClientGatewayConfiguration: "..." + StaticRoutesOnly: true + VirtualGatewayId: vgw-12345678 + ConnectionType: ipsec.1 + ClientGatewayId: cgw-12345678 + State: pending + VgwTelemetries: + - StateDescription: IPSEC IS DOWN + AcceptedRouteCount: 0 + LastStateChangeDate: '2017-05-10T12:34:56.789Z' + OutsideIpAddress: 192.0.2.0 + VpnConnectionId: vpn-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -15689,9 +22871,3 @@ servers: - eu-west-2 - us-east-2 - us-west-1 -- url: https://api.{region}.outscale.jp/api/v1 - variables: - region: - default: ap-northeast-1 - enum: - - ap-northeast-1 diff --git a/outscale.yaml b/outscale.yaml index 2b82876..e7ba088 100644 --- a/outscale.yaml +++ b/outscale.yaml @@ -177,10 +177,9 @@ components: format: int64 type: integer RequireTrustedEnv: - description: If true, a trusted session is activated, allowing you to bypass - Certificate Authorities (CAs) enforcement. For more information, see the - `ApiKeyAuth` authentication scheme in the [Authentication](#authentication) - section. + description: |- + If true, a trusted session is activated, allowing you to bypass Certificate Authorities (CAs) enforcement. For more information, see [About Your API Access Policy](https://docs.outscale.com/en/userguide/About-Your-API-Access-Policy.html).
+ If this is enabled, it is required that you and all your users log in to Cockpit v2 using the WebAuthn method for multi-factor authentication. For more information, see [About Authentication > Multi-Factor Authentication](https://docs.outscale.com/en/userguide/About-Authentication.html#_multi_factor_authentication). type: boolean type: object ApiAccessRule: @@ -529,6 +528,12 @@ components: description: The ID of the TINA account which is billed for your consumption. It can be different from your account in the `AccountId` parameter. type: string + Price: + description: The total price of the consumed resource during the specified + time period, in the currency of the catalog of the Region where the API + method was used. + format: double + type: number Service: description: The service of the API call (`TinaOS-FCU`, `TinaOS-LBU`, `TinaOS-DirectLink`, `TinaOS-OOS`, or `TinaOS-OSU`). @@ -546,6 +551,11 @@ components: Type: description: The type of resource, depending on the API call. type: string + UnitPrice: + description: The unit price of the consumed resource, in the currency of + the catalog of the Region where the API method was used. + format: double + type: number Value: description: The consumed amount for the resource. The unit depends on the resource type. For more information, see the `Title` element. @@ -719,9 +729,9 @@ components: additionalProperties: false properties: BgpAsn: - description: The Autonomous System Number (ASN) used by the Border Gateway - Protocol (BGP) to find the path to your client gateway through the Internet. - This number must be between `1` and `4294967295`. + description: |- + The Autonomous System Number (ASN) used by the Border Gateway Protocol (BGP) to find the path to your client gateway through the Internet.
+ This number must be between `1` and `4294967295`. If you do not have an ASN, you can choose one between 64512 and 65534, or between 4200000000 and 4294967294. type: integer ConnectionType: description: The communication protocol used to establish tunnel with your @@ -747,6 +757,36 @@ components: ResponseContext: "$ref": "#/components/schemas/ResponseContext" type: object + CreateDedicatedGroupRequest: + additionalProperties: false + properties: + CpuGeneration: + description: The processor generation for the VMs in the dedicated group + (for example, `4`). + type: integer + DryRun: + description: If true, checks whether you have the required permissions to + perform the action. + type: boolean + Name: + description: A name for the dedicated group. + type: string + SubregionName: + description: The Subregion in which you want to create the dedicated group. + type: string + required: + - CpuGeneration + - Name + - SubregionName + type: object + CreateDedicatedGroupResponse: + additionalProperties: false + properties: + DedicatedGroup: + "$ref": "#/components/schemas/DedicatedGroup" + ResponseContext: + "$ref": "#/components/schemas/ResponseContext" + type: object CreateDhcpOptionsRequest: additionalProperties: false properties: @@ -910,11 +950,12 @@ components: additionalProperties: false properties: Architecture: - description: The architecture of the OMI (by default, `i386` if you specified - the `FileLocation` or `RootDeviceName` parameter). + description: "**(when registering from a snapshot, or from a bucket without + using a manifest file)** The architecture of the OMI (`i386` or `x84_64`)." type: string BlockDeviceMappings: - description: One or more block device mappings. + description: "**(when registering from a snapshot, or from a bucket without + using a manifest file)** One or more block device mappings." items: "$ref": "#/components/schemas/BlockDeviceMappingImage" type: array @@ -926,19 +967,18 @@ components: perform the action. type: boolean FileLocation: - description: 'The pre-signed URL of the OMI manifest file, or the full path - to the OMI stored in a bucket. If you specify this parameter, a copy of - the OMI is created in your account. You must specify only one of the following - parameters: `FileLocation`, `RootDeviceName`, `SourceImageId` or `VmId`.' + description: |- + **(when registering from a bucket by using a manifest file)** The pre-signed URL of the manifest file for the OMI you want to register. For more information, see [Configuring a Pre-signed URL](https://docs.outscale.com/en/userguide/Configuring-a-Pre-signed-URL.html) or [Managing Access to Your Buckets and Objects](https://docs.outscale.com/en/userguide/Managing-Access-to-Your-Buckets-and-Objects.html).
+ You can also specify the normal URL of the OMI if you have permission on the OOS bucket, without using the manifest file, but in that case, you need to manually specify through the other parameters all the information that would otherwise be read from the manifest file. type: string ImageName: description: |- A unique name for the new OMI.
- Constraints: 3-128 alphanumeric characters, underscores (_), spaces ( ), parentheses (()), slashes (/), periods (.), or dashes (-). + Constraints: 3-128 alphanumeric characters, underscores (`_`), spaces (` `), parentheses (`()`), slashes (`/`), periods (`.`), or dashes (`-`). type: string NoReboot: - description: If false, the VM shuts down before creating the OMI and then - reboots. If true, the VM does not. + description: "**(when creating from a VM)** If false, the VM shuts down + before creating the OMI and then reboots. If true, the VM does not." type: boolean ProductCodes: description: The product codes associated with the OMI. @@ -946,23 +986,19 @@ components: type: string type: array RootDeviceName: - description: 'The name of the root device. You must specify only one of - the following parameters: `FileLocation`, `RootDeviceName`, `SourceImageId` - or `VmId`.' + description: "**(when registering from a snapshot, or from a bucket without + using a manifest file)** The name of the root device for the new OMI." type: string SourceImageId: - description: 'The ID of the OMI you want to copy. You must specify only - one of the following parameters: `FileLocation`, `RootDeviceName`, `SourceImageId` - or `VmId`.' + description: "**(when copying an OMI)** The ID of the OMI you want to copy." type: string SourceRegionName: - description: The name of the source Region, which must be the same as the - Region of your account. + description: "**(when copying an OMI)** The name of the source Region (always + the same as the Region of your account)." type: string VmId: - description: 'The ID of the VM from which you want to create the OMI. You - must specify only one of the following parameters: `FileLocation`, `RootDeviceName`, - `SourceImageId` or `VmId`.' + description: "**(when creating from a VM)** The ID of the VM from which + you want to create the OMI." type: string type: object CreateImageResponse: @@ -1001,7 +1037,8 @@ components: [ASCII printable characters](https://en.wikipedia.org/wiki/ASCII#Printable_characters). type: string PublicKey: - description: The public key. It must be Base64-encoded. + description: The public key to import in your account, if you are importing + an existing keypair. This value must be Base64-encoded. type: string required: - KeypairName @@ -1297,9 +1334,11 @@ components: description: The IP range for the Net, in CIDR notation (for example, `10.0.0.0/16`). type: string Tenancy: - description: The tenancy options for the VMs (`default` if a VM created - in a Net can be launched with any tenancy, `dedicated` if it can be launched - with dedicated tenancy VMs running on single-tenant hardware). + description: |- + The tenancy options for the VMs:
+ - `default` if a VM created in a Net can be launched with any tenancy.
+ - `dedicated` if it can be launched with dedicated tenancy VMs running on single-tenant hardware.
+ - `dedicated group ID`: if it can be launched in a dedicated group on single-tenant hardware. type: string required: - IpRange @@ -1349,6 +1388,89 @@ components: ResponseContext: "$ref": "#/components/schemas/ResponseContext" type: object + CreatePolicyRequest: + additionalProperties: false + properties: + Description: + description: A description for the policy. + type: string + Document: + description: The policy document, corresponding to a JSON string that contains + the policy. For more information, see [EIM Reference Information](https://docs.outscale.com/en/userguide/EIM-Reference-Information.html). + type: string + DryRun: + description: If true, checks whether you have the required permissions to + perform the action. + type: boolean + Path: + description: The path of the policy. + type: string + PolicyName: + description: The name of the policy. + type: string + required: + - Document + - PolicyName + type: object + CreatePolicyResponse: + additionalProperties: false + properties: + Policy: + "$ref": "#/components/schemas/Policy" + ResponseContext: + "$ref": "#/components/schemas/ResponseContext" + type: object + CreatePolicyVersionRequest: + additionalProperties: false + properties: + Document: + description: The policy document, corresponding to a JSON string that contains + the policy. For more information, see [EIM Reference Information](https://docs.outscale.com/en/userguide/EIM-Reference-Information.html). + type: string + PolicyOrn: + description: The OUTSCALE Resource Name (ORN) of the policy. For more information, + see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). + type: string + SetAsDefault: + description: If set to true, the new policy version is set as the default + version and becomes the operative one. + type: boolean + required: + - Document + - PolicyOrn + type: object + CreatePolicyVersionResponse: + additionalProperties: false + properties: + PolicyVersion: + "$ref": "#/components/schemas/PolicyVersion" + ResponseContext: + "$ref": "#/components/schemas/ResponseContext" + type: object + CreateProductTypeRequest: + additionalProperties: false + properties: + Description: + description: The description of the product type. + type: string + DryRun: + description: If true, checks whether you have the required permissions to + perform the action. + type: boolean + Vendor: + description: The vendor of the product type. + type: string + required: + - Description + type: object + CreateProductTypeResponse: + additionalProperties: false + properties: + ProductType: + "$ref": "#/components/schemas/ProductType" + ResponseContext: + "$ref": "#/components/schemas/ResponseContext" + type: object CreatePublicIpRequest: additionalProperties: false properties: @@ -1432,8 +1554,9 @@ components: additionalProperties: false properties: Description: - description: A description for the security group, with a maximum length - of 255 [ASCII printable characters](https://en.wikipedia.org/wiki/ASCII#Printable_characters). + description: |- + A description for the security group.
+ This description can contain between 1 and 255 characters. Allowed characters are `a-z`, `A-Z`, `0-9`, accented letters, spaces, and `_.-:/()#,@[]+=&;{}!$*`. type: string DryRun: description: If true, checks whether you have the required permissions to @@ -1445,8 +1568,8 @@ components: SecurityGroupName: description: |- The name of the security group.
- This name must not start with `sg-`.
- This name must be unique and contain between 1 and 255 ASCII characters. Accented letters are not allowed. + This name must not start with `sg-`.
+ This name must be unique and contain between 1 and 255 characters. Allowed characters are `a-z`, `A-Z`, `0-9`, spaces, and `_.-:/()#,@[]+=&;{}!$*`. type: string required: - Description @@ -1604,27 +1727,29 @@ components: perform the action. type: boolean FileLocation: - description: "(When importing) The pre-signed URL of the snapshot you want - to import, or the normal URL of the snapshot if you have permission on - the OOS bucket. For more information, see [Configuring a Pre-signed URL](https://docs.outscale.com/en/userguide/Configuring-a-Pre-signed-URL.html) + description: "**(when importing from a bucket)** The pre-signed URL of the + snapshot you want to import, or the normal URL of the snapshot if you + have permission on the OOS bucket. For more information, see [Configuring + a Pre-signed URL](https://docs.outscale.com/en/userguide/Configuring-a-Pre-signed-URL.html) or [Managing Access to Your Buckets and Objects](https://docs.outscale.com/en/userguide/Managing-Access-to-Your-Buckets-and-Objects.html)." type: string SnapshotSize: - description: "(When importing) The size of the snapshot you want to create - in your account, in bytes. This size must be greater than or equal to - the size of the original, uncompressed snapshot." + description: "**(when importing from a bucket)** The size of the snapshot + you want to create in your account, in bytes. This size must be greater + than or equal to the size of the original, uncompressed snapshot." format: int64 type: integer SourceRegionName: - description: "(When copying) The name of the source Region, which must be - the same as the Region of your account." + description: "**(when copying a snapshot)** The name of the source Region, + which must be the same as the Region of your account." type: string SourceSnapshotId: - description: "(When copying) The ID of the snapshot you want to copy." + description: "**(when copying a snapshot)** The ID of the snapshot you want + to copy." type: string VolumeId: - description: "(When creating) The ID of the volume you want to create a - snapshot of." + description: "**(when creating from a volume)** The ID of the volume you + want to create a snapshot of." type: string type: object CreateSnapshotResponse: @@ -1645,7 +1770,7 @@ components: IpRange: description: |- The IP range in the Subnet, in CIDR notation (for example, `10.0.0.0/16`).
- The IP range of the Subnet can be either the same as the Net one if you create only a single Subnet in this Net, or a subset of the Net one. In case of several Subnets in a Net, their IP ranges must not overlap. The smallest Subnet you can create uses a /29 netmask (eight IPs). For more information, see [About VPCs](https://docs.outscale.com/en/userguide/About-VPCs.html). + The IP range of the Subnet can be either the same as the Net one if you create only a single Subnet in this Net, or a subset of the Net one. In case of several Subnets in a Net, their IP ranges must not overlap. The smallest Subnet you can create uses a /29 netmask (eight IPs). For more information, see [About Nets](https://docs.outscale.com/en/userguide/About-Nets.html). type: string NetId: description: The ID of the Net for which you want to create a Subnet. @@ -1701,9 +1826,14 @@ components: type: boolean Path: description: The path to the EIM user you want to create (by default, `/`). + This path name must begin and end with a slash (/), and contain between + 1 and 512 alphanumeric characters and/or slashes (/), or underscores (_). type: string UserName: - description: The name of the EIM user you want to create. + description: The name of the EIM user you want to create. This user name + must contain between 1 and 64 alphanumeric characters and/or pluses (+), + equals (=), commas (,), periods (.), at signs (@), dashes (-), or underscores + (_). type: string required: - UserName @@ -1956,7 +2086,7 @@ components: VmType: description: |- The type of VM. You can specify a TINA type (in the `tinavW.cXrYpZ` or `tinavW.cXrY` format), or an AWS type (for example, `t2.small`, which is the default value).
- If you specify an AWS type, it is converted in the background to its corresponding TINA type, but the AWS type is still returned. If the specified or converted TINA type includes a performance flag, this performance flag is applied regardless of the value you may have provided in the `Performance` parameter. For more information, see [Instance Types](https://docs.outscale.com/en/userguide/Instance-Types.html). + If you specify an AWS type, it is converted in the background to its corresponding TINA type, but the AWS type is still returned. If the specified or converted TINA type includes a performance flag, this performance flag is applied regardless of the value you may have provided in the `Performance` parameter. For more information, see [VM Types](https://docs.outscale.com/en/userguide/VM-Types.html). type: string required: - ImageId @@ -2026,10 +2156,11 @@ components: perform the action. type: boolean StaticRoutesOnly: - description: If false, the VPN connection uses dynamic routing with Border - Gateway Protocol (BGP). If true, routing is controlled using static routes. - For more information about how to create and delete static routes, see - [CreateVpnConnectionRoute](#createvpnconnectionroute) and [DeleteVpnConnectionRoute](#deletevpnconnectionroute). + description: By default or if false, the VPN connection uses dynamic routing + with Border Gateway Protocol (BGP). If true, routing is controlled using + static routes. For more information about how to create and delete static + routes, see [CreateVpnConnectionRoute](#createvpnconnectionroute) and + [DeleteVpnConnectionRoute](#deletevpnconnectionroute). type: boolean VirtualGatewayId: description: The ID of the virtual gateway. @@ -2071,6 +2202,36 @@ components: ResponseContext: "$ref": "#/components/schemas/ResponseContext" type: object + DedicatedGroup: + additionalProperties: false + description: Information about the dedicated group. + properties: + AccountId: + description: The account ID of the owners of the dedicated group. + type: string + CpuGeneration: + description: The processor generation. + type: integer + DedicatedGroupId: + description: The ID of the dedicated group. + type: string + Name: + description: The name of the dedicated group. + type: string + NetIds: + description: The IDs of the Nets in the dedicated group. + items: + type: string + type: array + SubregionName: + description: The name of the Subregion in which the dedicated group is located. + type: string + VmIds: + description: The IDs of the VMs in the dedicated group. + items: + type: string + type: array + type: object DeleteAccessKeyRequest: additionalProperties: false properties: @@ -2152,6 +2313,29 @@ components: ResponseContext: "$ref": "#/components/schemas/ResponseContext" type: object + DeleteDedicatedGroupRequest: + additionalProperties: false + properties: + DedicatedGroupId: + description: The ID of the dedicated group you want to delete. + type: string + DryRun: + description: If true, checks whether you have the required permissions to + perform the action. + type: boolean + Force: + description: If true, forces the deletion of the dedicated group and all + its dependencies. + type: boolean + required: + - DedicatedGroupId + type: object + DeleteDedicatedGroupResponse: + additionalProperties: false + properties: + ResponseContext: + "$ref": "#/components/schemas/ResponseContext" + type: object DeleteDhcpOptionsRequest: additionalProperties: false properties: @@ -2518,6 +2702,46 @@ components: ResponseContext: "$ref": "#/components/schemas/ResponseContext" type: object + DeletePolicyRequest: + additionalProperties: false + properties: + DryRun: + description: If true, checks whether you have the required permissions to + perform the action. + type: boolean + PolicyOrn: + description: The OUTSCALE Resource Name (ORN) of the policy you want to + delete. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). + type: string + required: + - PolicyOrn + type: object + DeletePolicyResponse: + additionalProperties: false + properties: + ResponseContext: + "$ref": "#/components/schemas/ResponseContext" + type: object + DeletePolicyVersionRequest: + additionalProperties: false + properties: + PolicyOrn: + description: The OUTSCALE Resource Name (ORN) of the policy. For more information, + see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). + type: string + VersionId: + description: The ID of the version of the policy you want to delete. + type: string + required: + - PolicyOrn + - VersionId + type: object + DeletePolicyVersionResponse: + additionalProperties: false + properties: + ResponseContext: + "$ref": "#/components/schemas/ResponseContext" + type: object DeletePublicIpRequest: additionalProperties: false properties: @@ -3026,7 +3250,8 @@ components: description: The ID of the target virtual gateway. type: string Vlan: - description: The VLAN number associated with the DirectLink interface. + description: The VLAN number associated with the DirectLink interface. This + number must be unique and be between `2` and `4094`. type: integer required: - BgpAsn @@ -3299,6 +3524,33 @@ components: type: string type: array type: object + FiltersDedicatedGroup: + additionalProperties: false + description: One or more filters. + properties: + CpuGenerations: + description: The processor generation for the VMs in the dedicated group + (for example, `4`). + items: + type: integer + type: array + DedicatedGroupIds: + description: The IDs of the dedicated groups. + items: + type: string + type: array + Names: + description: The names of the dedicated groups. + items: + type: string + type: array + SubregionNames: + description: The names of the Subregions in which the dedicated groups are + located. + items: + type: string + type: array + type: object FiltersDhcpOptions: additionalProperties: false description: One or more filters. @@ -3497,8 +3749,7 @@ components: type: string type: array PermissionsToLaunchAccountIds: - description: The account IDs of the users who have launch permissions for - the OMIs. + description: The account IDs which have launch permissions for the OMIs. items: type: string type: array @@ -3506,6 +3757,11 @@ components: description: If true, lists all public OMIs. If false, lists all private OMIs. type: boolean + ProductCodeNames: + description: The names of the product codes associated with the OMI. + items: + type: string + type: array ProductCodes: description: The product codes associated with the OMI. items: @@ -3517,7 +3773,7 @@ components: type: string type: array RootDeviceTypes: - description: The types of root device used by the OMIs (always `bsu`). + description: The types of root device used by the OMIs (`bsu` or `ebs`). items: type: string type: array @@ -3565,7 +3821,7 @@ components: LinkStates: description: The current states of the attachments between the Internet services and the Nets (only `available`, if the Internet gateway is attached - to a VPC). + to a Net). items: type: string type: array @@ -3600,6 +3856,12 @@ components: items: type: string type: array + KeypairTypes: + description: The types of the keypairs (`ssh-rsa`, `ssh-ed25519`, `ecdsa-sha2-nistp256`, + `ecdsa-sha2-nistp384`, or `ecdsa-sha2-nistp521`). + items: + type: string + type: array type: object FiltersListenerRule: additionalProperties: false @@ -3687,7 +3949,7 @@ components: type: string type: array States: - description: The states of the Nets (`pending` \| `available` \| `deleted`). + description: The states of the Nets (`pending` \| `available` \| `deleting`). items: type: string type: array @@ -3770,6 +4032,13 @@ components: items: type: string type: array + ExpirationDates: + description: The dates and times at which the Net peerings expire, in ISO + 8601 date-time format (for example, `2020-06-14T00:00:00.000Z`). + items: + format: date-time + type: string + type: array NetPeeringIds: description: The IDs of the Net peerings. items: @@ -4159,11 +4428,6 @@ components: additionalProperties: false description: One or more filters. properties: - AccountIds: - description: The account IDs of the owners of the security groups. - items: - type: string - type: array Descriptions: description: The descriptions of the security groups. items: @@ -4330,8 +4594,7 @@ components: format: date-time type: string PermissionsToCreateVolumeAccountIds: - description: The account IDs of one or more users who have permissions to - create volumes. + description: The account IDs which have permissions to create volumes. items: type: string type: array @@ -4443,6 +4706,16 @@ components: additionalProperties: false description: One or more filters. properties: + RegionNames: + description: The names of the Regions containing the Subregions. + items: + type: string + type: array + States: + description: The states of the Subregions. + items: + type: string + type: array SubregionNames: description: The names of the Subregions. items: @@ -4535,88 +4808,399 @@ components: additionalProperties: false description: One or more filters. properties: - TagKeys: - description: The keys of the tags associated with the VMs. + Architectures: + description: The architectures of the VMs (`i386` \| `x86_64`). items: type: string type: array - TagValues: - description: The values of the tags associated with the VMs. + BlockDeviceMappingDeleteOnVmDeletion: + description: Whether the BSU volumes are deleted when terminating the VMs. + type: boolean + BlockDeviceMappingDeviceNames: + description: The device names for the BSU volumes (in the format `/dev/sdX`, + `/dev/sdXX`, `/dev/xvdX`, or `/dev/xvdXX`). items: type: string type: array - Tags: - description: 'The key/value combination of the tags associated with the - VMs, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' - items: - type: string + BlockDeviceMappingLinkDates: + description: The link dates for the BSU volumes mapped to the VMs (for example, + `2016-01-23T18:45:30.000Z`). + items: string type: array - VmIds: - description: One or more IDs of VMs. + BlockDeviceMappingStates: + description: The states for the BSU volumes (`attaching` \| `attached` \| + `detaching` \| `detached`). items: type: string type: array - type: object - FiltersVmGroup: - additionalProperties: false - description: One or more filters. - properties: - Descriptions: - description: The descriptions of the VM groups. + BlockDeviceMappingVolumeIds: + description: The volume IDs of the BSU volumes. items: type: string type: array - SecurityGroupIds: - description: The IDs of the security groups. + ClientTokens: + description: The idempotency tokens provided when launching the VMs. items: type: string type: array - SubnetIds: - description: The IDs of the Subnets. - items: - type: string + CreationDates: + description: The dates when the VMs were launched. + items: string type: array - TagKeys: - description: The keys of the tags associated with the VM groups. + ImageIds: + description: The IDs of the OMIs used to launch the VMs. items: type: string type: array - TagValues: - description: The values of the tags associated with the VM groups. + IsSourceDestChecked: + description: Whether the source/destination checking is enabled (true) or + disabled (false). + type: boolean + KeypairNames: + description: The names of the keypairs used when launching the VMs. items: type: string type: array - Tags: - description: 'The key/value combination of the tags associated with the - VMs, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' + LaunchNumbers: + description: The numbers for the VMs when launching a group of several VMs + (for example, `0`, `1`, `2`, and so on). items: - type: string + type: integer type: array - VmCounts: - description: The number of VMs in the VM group. + Lifecycles: + description: Whether the VMs are Spot Instances (spot). items: - type: integer + type: string type: array - VmGroupIds: - description: The IDs of the VM groups. + NetIds: + description: The IDs of the Nets in which the VMs are running. items: type: string type: array - VmGroupNames: - description: The names of the VM groups. + NicAccountIds: + description: The IDs of the NICs. items: type: string type: array - VmTemplateIds: - description: The IDs of the VM templates. + NicDescriptions: + description: The descriptions of the NICs. items: type: string type: array - type: object - FiltersVmTemplate: - additionalProperties: false - description: One or more filters. - properties: + NicIsSourceDestChecked: + description: Whether the source/destination checking is enabled (true) or + disabled (false). + type: boolean + NicLinkNicDeleteOnVmDeletion: + description: Whether the NICs are deleted when the VMs they are attached + to are deleted. + type: boolean + NicLinkNicDeviceNumbers: + description: The device numbers the NICs are attached to. + items: + type: integer + type: array + NicLinkNicLinkNicDates: + description: The dates and time when the NICs were attached to the VMs. + items: string + type: array + NicLinkNicLinkNicIds: + description: The IDs of the NIC attachments. + items: + type: string + type: array + NicLinkNicStates: + description: The states of the attachments. + items: + type: string + type: array + NicLinkNicVmAccountIds: + description: The account IDs of the owners of the VMs the NICs are attached + to. + items: + type: string + type: array + NicLinkNicVmIds: + description: The IDs of the VMs the NICs are attached to. + items: + type: string + type: array + NicLinkPublicIpAccountIds: + description: The account IDs of the owners of the public IPs associated + with the NICs. + items: + type: string + type: array + NicLinkPublicIpLinkPublicIpIds: + description: The association IDs returned when the public IPs were associated + with the NICs. + items: + type: string + type: array + NicLinkPublicIpPublicIpIds: + description: The allocation IDs returned when the public IPs were allocated + to their accounts. + items: + type: string + type: array + NicLinkPublicIpPublicIps: + description: The public IPs associated with the NICs. + items: + type: string + type: array + NicMacAddresses: + description: The Media Access Control (MAC) addresses of the NICs. + items: + type: string + type: array + NicNetIds: + description: The IDs of the Nets where the NICs are located. + items: + type: string + type: array + NicNicIds: + description: The IDs of the NICs. + items: + type: string + type: array + NicPrivateIpsLinkPublicIpAccountIds: + description: The account IDs of the owner of the public IPs associated with + the private IPs. + items: + type: string + type: array + NicPrivateIpsLinkPublicIpIds: + description: The public IPs associated with the private IPs. + items: + type: string + type: array + NicPrivateIpsPrimaryIp: + description: Whether the private IPs are the primary IPs associated with + the NICs. + type: boolean + NicPrivateIpsPrivateIps: + description: The private IPs of the NICs. + items: + type: string + type: array + NicSecurityGroupIds: + description: The IDs of the security groups associated with the NICs. + items: + type: string + type: array + NicSecurityGroupNames: + description: The names of the security groups associated with the NICs. + items: + type: string + type: array + NicStates: + description: The states of the NICs (`available` \| `in-use`). + items: + type: string + type: array + NicSubnetIds: + description: The IDs of the Subnets for the NICs. + items: + type: string + type: array + NicSubregionNames: + description: The Subregions where the NICs are located. + items: + type: string + type: array + Platforms: + description: The platforms. Use windows if you have Windows VMs. Otherwise, + leave this filter blank. + items: + type: string + type: array + PrivateIps: + description: The private IPs of the VMs. + items: + type: string + type: array + ProductCodes: + description: The product codes associated with the OMI used to create the + VMs. + items: + type: string + type: array + PublicIps: + description: The public IPs of the VMs. + items: + type: string + type: array + ReservationIds: + description: The IDs of the reservation of the VMs, created every time you + launch VMs. These reservation IDs can be associated with several VMs when + you lauch a group of VMs using the same launch request. + items: + type: string + type: array + RootDeviceNames: + description: The names of the root devices for the VMs (for example, `/dev/sda1`) + items: + type: string + type: array + RootDeviceTypes: + description: The root devices types used by the VMs (always `ebs`) + items: + type: string + type: array + SecurityGroupIds: + description: The IDs of the security groups for the VMs (only in the public + Cloud). + items: + type: string + type: array + SecurityGroupNames: + description: The names of the security groups for the VMs (only in the public + Cloud). + items: + type: string + type: array + StateReasonCodes: + description: The reason codes for the state changes. + items: + type: integer + type: array + StateReasonMessages: + description: The messages describing the state changes. + items: + type: string + type: array + StateReasons: + description: The reasons explaining the current states of the VMs. This + filter is like the `StateReasonCodes` one. + items: + type: string + type: array + SubnetIds: + description: The IDs of the Subnets for the VMs. + items: + type: string + type: array + SubregionNames: + description: The names of the Subregions of the VMs. + items: + type: string + type: array + TagKeys: + description: The keys of the tags associated with the VMs. + items: + type: string + type: array + TagValues: + description: The values of the tags associated with the VMs. + items: + type: string + type: array + Tags: + description: 'The key/value combination of the tags associated with the + VMs, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' + items: + type: string + type: array + Tenancies: + description: The tenancies of the VMs (`dedicated` \| `default` \| `host`). + items: + type: string + type: array + VmIds: + description: One or more IDs of VMs. + items: + type: string + type: array + VmSecurityGroupIds: + description: The IDs of the security groups for the VMs. + items: + type: string + type: array + VmSecurityGroupNames: + description: The names of the security group for the VMs. + items: + type: string + type: array + VmStateCodes: + description: 'The state codes of the VMs: `-1` (quarantine), `0` (pending), + `16` (running), `32` (shutting-down), `48` (terminated), `64` (stopping), + and `80` (stopped).' + items: + type: integer + type: array + VmStateNames: + description: The state names of the VMs (`pending` \| `running` \| `stopping` + \| `stopped` \| `shutting-down` \| `terminated` \| `quarantine`). + items: + type: string + type: array + VmTypes: + description: The VM types (for example, t2.micro). For more information, + see [VM Types](https://docs.outscale.com/en/userguide/VM-Types.html). + items: + type: string + type: array + type: object + FiltersVmGroup: + additionalProperties: false + description: One or more filters. + properties: + Descriptions: + description: The descriptions of the VM groups. + items: + type: string + type: array + SecurityGroupIds: + description: The IDs of the security groups. + items: + type: string + type: array + SubnetIds: + description: The IDs of the Subnets. + items: + type: string + type: array + TagKeys: + description: The keys of the tags associated with the VM groups. + items: + type: string + type: array + TagValues: + description: The values of the tags associated with the VM groups. + items: + type: string + type: array + Tags: + description: 'The key/value combination of the tags associated with the + VMs, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' + items: + type: string + type: array + VmCounts: + description: The number of VMs in the VM group. + items: + type: integer + type: array + VmGroupIds: + description: The IDs of the VM groups. + items: + type: string + type: array + VmGroupNames: + description: The names of the VM groups. + items: + type: string + type: array + VmTemplateIds: + description: The IDs of the VM templates. + items: + type: string + type: array + type: object + FiltersVmTemplate: + additionalProperties: false + description: One or more filters. + properties: CpuCores: description: The number of vCores. items: @@ -4664,7 +5248,7 @@ components: type: array Tags: description: 'The key/value combination of the tags associated with the - VM templates, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' + VM templates, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' items: type: string type: array @@ -4687,6 +5271,21 @@ components: description: This parameter is not available. It is present in our API for the sake of historical compatibility with AWS. type: boolean + EphemeralsTypes: + description: The types of ephemeral storage disk. + items: + type: string + type: array + Eths: + description: The number of Ethernet interfaces available. + items: + type: integer + type: array + Gpus: + description: The number of GPUs available. + items: + type: integer + type: array MemorySizes: description: The amounts of memory, in gibibytes (GiB). items: @@ -4699,8 +5298,7 @@ components: type: integer type: array VmTypeNames: - description: The names of the VM types. For more information, see [Instance - Types](https://docs.outscale.com/en/userguide/Instance-Types.html). + description: The names of the VM types. For more information, see [VM Types](https://docs.outscale.com/en/userguide/VM-Types.html). items: type: string type: array @@ -4966,15 +5564,15 @@ components: description: Information about the health check configuration. properties: CheckInterval: - description: The number of seconds between two pings (between `5` and `600` - both included). + description: The number of seconds between two requests (between `5` and + `600` both included). type: integer HealthyThreshold: - description: The number of consecutive successful pings before considering + description: The number of consecutive successful requests before considering the VM as healthy (between `2` and `10` both included). type: integer Path: - description: If you use the HTTP or HTTPS protocols, the ping path. + description: If you use the HTTP or HTTPS protocols, the request URL path. type: string Port: description: The port number (between `1` and `65535`, both included). @@ -4988,8 +5586,8 @@ components: the VM as unhealthy, in seconds (between `2` and `60` both included). type: integer UnhealthyThreshold: - description: The number of consecutive failed pings before considering the - VM as unhealthy (between `2` and `10` both included). + description: The number of consecutive failed requests before considering + the VM as unhealthy (between `2` and `10` both included). type: integer required: - CheckInterval @@ -5010,7 +5608,7 @@ components: description: The account ID of the owner of the OMI. type: string Architecture: - description: The architecture of the OMI (by default, `i386`). + description: The architecture of the OMI. type: string BlockDeviceMappings: description: One or more block device mappings. @@ -5026,7 +5624,7 @@ components: description: The description of the OMI. type: string FileLocation: - description: The location of the bucket where the OMI files are stored. + description: The location from which the OMI files were created. type: string ImageId: description: The ID of the OMI. @@ -5120,21 +5718,30 @@ components: KeypairName: description: The name of the keypair. type: string + KeypairType: + description: The type of the keypair (`ssh-rsa`, `ssh-ed25519`, `ecdsa-sha2-nistp256`, + `ecdsa-sha2-nistp384`, or `ecdsa-sha2-nistp521`). + type: string type: object KeypairCreated: additionalProperties: false description: Information about the created keypair. properties: KeypairFingerprint: - description: The MD5 public key fingerprint as specified in section 4 of + description: The MD5 public key fingerprint, as specified in section 4 of RFC 4716. type: string KeypairName: description: The name of the keypair. type: string + KeypairType: + description: The type of the keypair (`ssh-rsa`, `ssh-ed25519`, `ecdsa-sha2-nistp256`, + `ecdsa-sha2-nistp384`, or `ecdsa-sha2-nistp521`). + type: string PrivateKey: - description: The private key. When saving the private key in a .rsa file, - replace the `\n` escape sequences with line breaks. + description: The private key, returned only if you are creating a keypair + (not if you are importing). When you save this private key in a .rsa file, + make sure you replace the `\n` escape sequences with real line breaks. type: string type: object LinkFlexibleGpuRequest: @@ -5301,6 +5908,31 @@ components: description: The ID of the NIC attachment. type: string type: object + LinkPolicyRequest: + additionalProperties: false + properties: + DryRun: + description: If true, checks whether you have the required permissions to + perform the action. + type: boolean + PolicyOrn: + description: The OUTSCALE Resource Name (ORN) of the policy. For more information, + see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). + type: string + UserName: + description: The name of the user you want to link the policy to (between + 1 and 64 characters). + type: string + required: + - PolicyOrn + - UserName + type: object + LinkPolicyResponse: + additionalProperties: false + properties: + ResponseContext: + "$ref": "#/components/schemas/ResponseContext" + type: object LinkPrivateIpsRequest: additionalProperties: false properties: @@ -5374,9 +6006,9 @@ components: AllowRelink: description: If true, allows the public IP to be associated with the VM or NIC that you specify even if it is already associated with another - VM or NIC. If false, prevents the EIP from being associated with the VM - or NIC that you specify if it is already associated with another VM or - NIC. (By default, true in the public Cloud, false in a Net.) + VM or NIC. If false, prevents the public IP from being associated with + the VM or NIC that you specify if it is already associated with another + VM or NIC. (By default, true in the public Cloud, false in a Net.) type: boolean DryRun: description: If true, checks whether you have the required permissions to @@ -5427,6 +6059,9 @@ components: Main: description: If true, the route table is the main one. type: boolean + NetId: + description: The ID of the Net. + type: string RouteTableId: description: The ID of the route table. type: string @@ -5515,6 +6150,29 @@ components: ResponseContext: "$ref": "#/components/schemas/ResponseContext" type: object + LinkedPolicy: + additionalProperties: false + description: Information about the attached policy. + properties: + CreationDate: + description: The date and time of creation of the attached policy. + format: date-time + type: string + LastModificationDate: + description: The date and time at which the attached policy was last modified. + format: date-time + type: string + Orn: + description: The Outscale Resource Name (ORN) of the policy. For more information, + see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). + type: string + PolicyId: + description: The ID of the policy. + type: string + PolicyName: + description: The name of the policy. + type: string + type: object LinkedVolume: additionalProperties: false description: Information about volume attachment. @@ -5918,7 +6576,7 @@ components: description: The ID of the Net. type: string State: - description: The state of the Net (`pending` \| `available` \| `deleted`). + description: The state of the Net (`pending` \| `available` \| `deleting`). type: string Tags: description: One or more tags associated with the Net. @@ -5964,6 +6622,11 @@ components: properties: AccepterNet: "$ref": "#/components/schemas/AccepterNet" + ExpirationDate: + description: The date and time at which the Net peerings expire. + format: date-time + nullable: true + type: string NetPeeringId: description: The ID of the Net peering. type: string @@ -6336,6 +6999,16 @@ components: any character except line breaks and double quotes ("). type: string type: object + Phase2OptionsToUpdate: + additionalProperties: false + description: 'Information about Phase 2 of the Internet Key Exchange (IKE) negotiation. ' + properties: + PreSharedKey: + description: The pre-shared key to establish the initial authentication + between the client gateway and the virtual gateway. This key can contain + any character except line breaks and double quotes ("). + type: string + type: object Placement: additionalProperties: false description: Information about the placement of the VM. @@ -6345,7 +7018,65 @@ components: must not specify the `Nics` parameter. type: string Tenancy: - description: The tenancy of the VM (`default` \| `dedicated`). + description: The tenancy of the VM (`default`, `dedicated`, or a dedicated + group ID). + type: string + type: object + Policy: + additionalProperties: false + description: Information about the policy. + properties: + CreationDate: + description: The date and time of creation of the policy. + format: date-time + type: string + Description: + description: A friendly name for the policy (between 0 and 1000 characters). + type: string + IsLinkable: + description: Indicates whether the policy can be linked to a group or an + EIM user. + type: boolean + LastModificationDate: + description: The date and time at which the policy was last modified. + format: date-time + type: string + Orn: + description: The OUTSCALE Resource Name (ORN) of the policy. For more information, + see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). + type: string + Path: + description: The path to the policy. + type: string + PolicyDefaultVersionId: + description: The ID of the policy default version. + type: string + PolicyId: + description: The ID of the policy. + type: string + PolicyName: + description: The name of the policy. + type: string + ResourcesCount: + description: The number of resources attached to the policy. + type: integer + type: object + PolicyVersion: + additionalProperties: false + description: Information about the policy version. + properties: + Body: + description: The policy document as a json string. + type: string + CreationDate: + description: The date and time of creation of the version. + format: date-time + type: string + DefaultVersion: + description: If true, the version is the default one. + type: boolean + VersionId: + description: The ID of the version. type: string type: object PrivateIp: @@ -6460,8 +7191,8 @@ components: description: The description of the quota. type: string MaxValue: - description: The maximum value of the quota for the OUTSCALE user account - (if there is no limit, `0`). + description: The maximum value of the quota for the account (if there is + no limit, `0`). type: integer Name: description: The unique name of the quota. @@ -6473,7 +7204,7 @@ components: description: The description of the quota. type: string UsedValue: - description: The limit value currently used by the OUTSCALE user account. + description: The limit value currently used by the account. type: integer type: object QuotaTypes: @@ -6485,7 +7216,7 @@ components: if it is not. type: string Quotas: - description: One or more quotas associated with the user. + description: One or more quotas associated with the account. items: "$ref": "#/components/schemas/Quota" type: array @@ -6680,7 +7411,6 @@ components: type: boolean Filters: "$ref": "#/components/schemas/FiltersCatalogs" - description: ReadCatalogsRequest_Filters type: object ReadCatalogsResponse: additionalProperties: false @@ -6762,6 +7492,13 @@ components: 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: By default or if false, returns only the consumption of the + specific account that sends this request. If true, returns the unit price + of the consumed resource, and the total price of the consumed resource + during the specified time period in the currency of the catalog of the + Region where the API method was used. + type: boolean ToDate: description: The end of the time period, in ISO 8601 date format (for example, `2020-06-30`). The date-time format is also accepted, but only with a @@ -6784,6 +7521,27 @@ components: ResponseContext: "$ref": "#/components/schemas/ResponseContext" type: object + ReadDedicatedGroupsRequest: + additionalProperties: false + properties: + DryRun: + description: If true, checks whether you have the required permissions to + perform the action. + type: boolean + Filters: + "$ref": "#/components/schemas/FiltersDedicatedGroup" + type: object + ReadDedicatedGroupsResponse: + additionalProperties: false + properties: + DedicatedGroups: + description: Information about one or more dedicated groups. + items: + "$ref": "#/components/schemas/DedicatedGroup" + type: array + ResponseContext: + "$ref": "#/components/schemas/ResponseContext" + type: object ReadDhcpOptionsRequest: additionalProperties: false properties: @@ -6793,6 +7551,15 @@ components: type: boolean Filters: "$ref": "#/components/schemas/FiltersDhcpOptions" + NextPageToken: + description: The token to request the next page of results. Each token refers + to a specific page. + format: byte + type: string + ResultsPerPage: + description: The maximum number of logs returned in a single response (between + `1`and `1000`, both included). By default, `100`. + type: integer type: object ReadDhcpOptionsResponse: additionalProperties: false @@ -6802,6 +7569,11 @@ components: items: "$ref": "#/components/schemas/DhcpOptionsSet" type: array + NextPageToken: + description: The token to request the next page of results. Each token refers + to a specific page. + format: byte + type: string ResponseContext: "$ref": "#/components/schemas/ResponseContext" type: object @@ -6918,6 +7690,15 @@ components: type: boolean Filters: "$ref": "#/components/schemas/FiltersImage" + NextPageToken: + description: The token to request the next page of results. Each token refers + to a specific page. + format: byte + type: string + ResultsPerPage: + description: The maximum number of logs returned in a single response (between + `1`and `1000`, both included). By default, `100`. + type: integer type: object ReadImagesResponse: additionalProperties: false @@ -6927,6 +7708,11 @@ components: items: "$ref": "#/components/schemas/Image" type: array + NextPageToken: + description: The token to request the next page of results. Each token refers + to a specific page. + format: byte + type: string ResponseContext: "$ref": "#/components/schemas/ResponseContext" type: object @@ -6969,6 +7755,53 @@ components: items: "$ref": "#/components/schemas/Keypair" type: array + ReadLinkedPoliciesFilters: + additionalProperties: false + description: One or more filters. + properties: + PathPrefix: + description: The path prefix of the policies, set to a slash (`/`) by default. + type: string + type: object + ReadLinkedPoliciesRequest: + additionalProperties: false + properties: + DryRun: + description: If true, checks whether you have the required permissions to + perform the action. + type: boolean + Filters: + "$ref": "#/components/schemas/ReadLinkedPoliciesFilters" + FirstItem: + description: The item starting the list of policies requested. + type: integer + ResultsPerPage: + description: The maximum number of items that can be returned in a single + response (by default, 100). + type: integer + UserName: + description: The name of the user the policies are linked to. + type: string + type: object + ReadLinkedPoliciesResponse: + additionalProperties: false + properties: + HasMoreItems: + description: If true, there are more items to return using the `FirstItem` + parameter in a new request. + type: boolean + MaxResultsLimit: + description: Indicates maximum results defined for the operation. + type: integer + MaxResultsTruncated: + description: If true, indicates whether requested page size is more than + allowed. + type: boolean + Policies: + description: One or more policies linked to the specified user. + items: + "$ref": "#/components/schemas/LinkedPolicy" + type: array ResponseContext: "$ref": "#/components/schemas/ResponseContext" type: object @@ -7068,6 +7901,15 @@ components: type: boolean Filters: "$ref": "#/components/schemas/FiltersNatService" + NextPageToken: + description: The token to request the next page of results. Each token refers + to a specific page. + format: byte + type: string + ResultsPerPage: + description: The maximum number of logs returned in a single response (between + `1`and `1000`, both included). By default, `100`. + type: integer type: object ReadNatServicesResponse: additionalProperties: false @@ -7077,6 +7919,11 @@ components: items: "$ref": "#/components/schemas/NatService" type: array + NextPageToken: + description: The token to request the next page of results. Each token refers + to a specific page. + format: byte + type: string ResponseContext: "$ref": "#/components/schemas/ResponseContext" type: object @@ -7110,6 +7957,15 @@ components: type: boolean Filters: "$ref": "#/components/schemas/FiltersNetAccessPoint" + NextPageToken: + description: The token to request the next page of results. Each token refers + to a specific page. + format: byte + type: string + ResultsPerPage: + description: The maximum number of logs returned in a single response (between + `1`and `1000`, both included). By default, `100`. + type: integer type: object ReadNetAccessPointsResponse: additionalProperties: false @@ -7119,6 +7975,11 @@ components: items: "$ref": "#/components/schemas/NetAccessPoint" type: array + NextPageToken: + description: The token to request the next page of results. Each token refers + to a specific page. + format: byte + type: string ResponseContext: "$ref": "#/components/schemas/ResponseContext" type: object @@ -7131,6 +7992,15 @@ components: type: boolean Filters: "$ref": "#/components/schemas/FiltersNetPeering" + NextPageToken: + description: The token to request the next page of results. Each token refers + to a specific page. + format: byte + type: string + ResultsPerPage: + description: The maximum number of logs returned in a single response (between + `1`and `1000`, both included). By default, `100`. + type: integer type: object ReadNetPeeringsResponse: additionalProperties: false @@ -7140,6 +8010,11 @@ components: items: "$ref": "#/components/schemas/NetPeering" type: array + NextPageToken: + description: The token to request the next page of results. Each token refers + to a specific page. + format: byte + type: string ResponseContext: "$ref": "#/components/schemas/ResponseContext" type: object @@ -7185,6 +8060,138 @@ components: ResponseContext: "$ref": "#/components/schemas/ResponseContext" type: object + ReadPoliciesFilters: + additionalProperties: false + description: One or more filters. + properties: + OnlyLinked: + description: If set to true, lists only the policies attached to a user. + type: boolean + PathPrefix: + description: The path prefix you can use to filter the results, set to a + slash (`/`) by default. + type: string + Scope: + description: The scope to filter policies (`ALL` \| `OWS` \| `local`). + enum: + - LOCAL + - OWS + type: string + type: object + ReadPoliciesRequest: + additionalProperties: false + properties: + DryRun: + description: If true, checks whether you have the required permissions to + perform the action. + type: boolean + Filters: + "$ref": "#/components/schemas/ReadPoliciesFilters" + FirstItem: + description: The item starting the list of policies requested. + type: integer + ResultsPerPage: + description: The maximum number of items that can be returned in a single + response (by default, 100). + type: integer + type: object + ReadPoliciesResponse: + additionalProperties: false + properties: + HasMoreItems: + description: If true, there are more items to return using the `FirstItem` + parameter in a new request. + type: boolean + MaxResultsLimit: + description: Indicates maximum results defined for the operation. + type: integer + MaxResultsTruncated: + description: If true, indicates whether requested page size is more than + allowed. + type: boolean + Policies: + description: Information about one or more policies. + items: + "$ref": "#/components/schemas/Policy" + type: array + ResponseContext: + "$ref": "#/components/schemas/ResponseContext" + type: object + ReadPolicyRequest: + additionalProperties: false + properties: + PolicyOrn: + description: The OUTSCALE Resource Name (ORN) of the policy. For more information, + see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). + type: string + required: + - PolicyOrn + type: object + ReadPolicyResponse: + additionalProperties: false + properties: + Policy: + "$ref": "#/components/schemas/Policy" + ResponseContext: + "$ref": "#/components/schemas/ResponseContext" + type: object + ReadPolicyVersionRequest: + additionalProperties: false + properties: + PolicyOrn: + description: The OUTSCALE Resource Name (ORN) of the policy. For more information, + see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). + type: string + VersionId: + description: The ID of the policy version. + type: string + required: + - PolicyOrn + - VersionId + type: object + ReadPolicyVersionResponse: + additionalProperties: false + properties: + PolicyVersion: + "$ref": "#/components/schemas/PolicyVersion" + ResponseContext: + "$ref": "#/components/schemas/ResponseContext" + type: object + ReadPolicyVersionsRequest: + additionalProperties: false + properties: + FirstItem: + description: The item starting the list of policies requested. + type: integer + PolicyOrn: + description: The OUTSCALE Resource Name (ORN) of the policy. For more information, + see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). + type: string + ResultsPerPage: + description: The maximum number of items that can be returned in a single + response (by default, 100). + type: integer + required: + - PolicyOrn + type: object + ReadPolicyVersionsResponse: + additionalProperties: false + properties: + HasMoreItems: + description: If true, there are more items to return using the `FirstItem` + parameter in a new request. + type: boolean + MaxResultsLimit: + description: Indicates maximum results defined for the operation. + type: integer + PolicyVersions: + description: A list of all the versions of the policy. + items: + "$ref": "#/components/schemas/PolicyVersion" + type: array + ResponseContext: + "$ref": "#/components/schemas/ResponseContext" + type: object ReadProductTypesRequest: additionalProperties: false properties: @@ -7251,10 +8258,24 @@ components: type: boolean Filters: "$ref": "#/components/schemas/FiltersPublicIp" + NextPageToken: + description: The token to request the next page of results. Each token refers + to a specific page. + format: byte + type: string + ResultsPerPage: + description: The maximum number of logs returned in a single response (between + `1`and `1000`, both included). By default, `100`. + type: integer type: object ReadPublicIpsResponse: additionalProperties: false properties: + NextPageToken: + description: The token to request the next page of results. Each token refers + to a specific page. + format: byte + type: string PublicIps: description: Information about one or more public IPs. items: @@ -7312,10 +8333,24 @@ components: type: boolean Filters: "$ref": "#/components/schemas/FiltersRouteTable" + NextPageToken: + description: The token to request the next page of results. Each token refers + to a specific page. + format: byte + type: string + ResultsPerPage: + description: The maximum number of logs returned in a single response (between + `1`and `1000`, both included). By default, `100`. + type: integer type: object ReadRouteTablesResponse: additionalProperties: false properties: + NextPageToken: + description: The token to request the next page of results. Each token refers + to a specific page. + format: byte + type: string ResponseContext: "$ref": "#/components/schemas/ResponseContext" RouteTables: @@ -7520,10 +8555,24 @@ components: type: boolean Filters: "$ref": "#/components/schemas/FiltersVirtualGateway" + NextPageToken: + description: The token to request the next page of results. Each token refers + to a specific page. + format: byte + type: string + ResultsPerPage: + description: The maximum number of logs returned in a single response (between + `1`and `1000`, both included). By default, `100`. + type: integer type: object ReadVirtualGatewaysResponse: additionalProperties: false properties: + NextPageToken: + description: The token to request the next page of results. Each token refers + to a specific page. + format: byte + type: string ResponseContext: "$ref": "#/components/schemas/ResponseContext" VirtualGateways: @@ -7541,7 +8590,6 @@ components: type: boolean Filters: "$ref": "#/components/schemas/FiltersVmGroup" - description: ReadVmGroupsRequest_Filters type: object ReadVmGroupsResponse: additionalProperties: false @@ -7634,10 +8682,24 @@ components: type: boolean Filters: "$ref": "#/components/schemas/FiltersVm" + NextPageToken: + description: The token to request the next page of results. Each token refers + to a specific page. + format: byte + type: string + ResultsPerPage: + description: The maximum number of logs returned in a single response (between + `1`and `1000`, both included). By default, `100`. + type: integer type: object ReadVmsResponse: additionalProperties: false properties: + NextPageToken: + description: The token to request the next page of results. Each token refers + to a specific page. + format: byte + type: string ResponseContext: "$ref": "#/components/schemas/ResponseContext" Vms: @@ -7681,10 +8743,24 @@ components: type: boolean Filters: "$ref": "#/components/schemas/FiltersVolume" + NextPageToken: + description: The token to request the next page of results. Each token refers + to a specific page. + format: byte + type: string + ResultsPerPage: + description: The maximum number of logs returned in a single response (between + `1`and `1000`, both included). By default, `100`. + type: integer type: object ReadVolumesResponse: additionalProperties: false properties: + NextPageToken: + description: The token to request the next page of results. Each token refers + to a specific page. + format: byte + type: string ResponseContext: "$ref": "#/components/schemas/ResponseContext" Volumes: @@ -7702,10 +8778,24 @@ components: type: boolean Filters: "$ref": "#/components/schemas/FiltersVpnConnection" + NextPageToken: + description: The token to request the next page of results. Each token refers + to a specific page. + format: byte + type: string + ResultsPerPage: + description: The maximum number of logs returned in a single response (between + `1`and `1000`, both included). By default, `100`. + type: integer type: object ReadVpnConnectionsResponse: additionalProperties: false properties: + NextPageToken: + description: The token to request the next page of results. Each token refers + to a specific page. + format: byte + type: string ResponseContext: "$ref": "#/components/schemas/ResponseContext" VpnConnections: @@ -7792,30 +8882,6 @@ components: ResponseContext: "$ref": "#/components/schemas/ResponseContext" type: object - ResetAccountPasswordRequest: - additionalProperties: false - properties: - DryRun: - description: If true, checks whether you have the required permissions to - perform the action. - type: boolean - Password: - description: The new password for the account. - type: string - Token: - description: The token you received at the email address provided for the - account. - type: string - required: - - Password - - Token - type: object - ResetAccountPasswordResponse: - additionalProperties: false - properties: - ResponseContext: - "$ref": "#/components/schemas/ResponseContext" - type: object ResourceLoadBalancerTag: additionalProperties: false description: Information about the tag. @@ -7992,7 +9058,7 @@ components: description: Information about the security group. properties: AccountId: - description: The account ID of a user that has been granted permission. + description: The account ID that has been granted permission. type: string Description: description: The description of the security group. @@ -8086,25 +9152,6 @@ components: group that you want to link to the security group of the rule." type: string type: object - SendResetPasswordEmailRequest: - additionalProperties: false - properties: - DryRun: - description: If true, checks whether you have the required permissions to - perform the action. - type: boolean - Email: - description: The email address provided for the account. - type: string - required: - - Email - type: object - SendResetPasswordEmailResponse: - additionalProperties: false - properties: - ResponseContext: - "$ref": "#/components/schemas/ResponseContext" - type: object ServerCertificate: additionalProperties: false description: Information about the server certificate. @@ -8148,6 +9195,26 @@ components: description: The name of the service. type: string type: object + SetDefaultPolicyVersionRequest: + additionalProperties: false + properties: + PolicyOrn: + description: The OUTSCALE Resource Name (ORN) of the policy. For more information, + see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). + type: string + VersionId: + description: The ID of the version. + type: string + required: + - PolicyOrn + - VersionId + type: object + SetDefaultPolicyVersionResponse: + additionalProperties: false + properties: + ResponseContext: + "$ref": "#/components/schemas/ResponseContext" + type: object Snapshot: additionalProperties: false description: Information about the snapshot. @@ -8355,8 +9422,7 @@ components: description: The name of the Region containing the Subregion. type: string State: - description: The state of the Subregion (`available` \| `information` \| - `impaired` \| `unavailable`). + description: The state of the Subregion. type: string SubregionName: description: The name of the Subregion. @@ -8470,6 +9536,30 @@ components: ResponseContext: "$ref": "#/components/schemas/ResponseContext" type: object + UnlinkPolicyRequest: + additionalProperties: false + properties: + DryRun: + description: If true, checks whether you have the required permissions to + perform the action. + type: boolean + PolicyOrn: + description: The OUTSCALE Resource Name (ORN) of the policy. For more information, + see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). + type: string + UserName: + description: The name of the user you want to detach the policy from. + type: string + required: + - PolicyOrn + - UserName + type: object + UnlinkPolicyResponse: + additionalProperties: false + properties: + ResponseContext: + "$ref": "#/components/schemas/ResponseContext" + type: object UnlinkPrivateIpsRequest: additionalProperties: false properties: @@ -8607,9 +9697,10 @@ components: requests. When set to `INACTIVE`, the access key is disabled. type: string UserName: - description: The name of the EIM the access key you want to modify is associated - with. If you do not specify a user name, this action modifies the access - key of the user who sends the request (which can be the root account). + description: The name of the EIM user that the access key you want to modify + is associated with. If you do not specify a user name, this action modifies + the access key of the user who sends the request (which can be the root + account). type: string required: - AccessKeyId @@ -8702,9 +9793,9 @@ components: format: int64 type: integer RequireTrustedEnv: - description: If true, a trusted session is activated, provided that you - specify the `MaxAccessKeyExpirationSeconds` parameter with a value greater - than `0`. + description: |- + If true, a trusted session is activated, provided that you specify the `MaxAccessKeyExpirationSeconds` parameter with a value greater than `0`.
+ Enabling this will require you and all your users to log in to Cockpit v2 using the WebAuthn method for multi-factor authentication. For more information, see [About Authentication > Multi-Factor Authentication](https://docs.outscale.com/en/userguide/About-Authentication.html#_multi_factor_authentication). type: boolean required: - MaxAccessKeyExpirationSeconds @@ -8781,6 +9872,31 @@ components: ResponseContext: "$ref": "#/components/schemas/ResponseContext" type: object + UpdateDedicatedGroupRequest: + additionalProperties: false + properties: + DedicatedGroupId: + description: The ID of the dedicated group you want to update. + type: string + DryRun: + description: If true, checks whether you have the required permissions to + perform the action. + type: boolean + Name: + description: The new name of the dedicated group. + type: string + required: + - DedicatedGroupId + - Name + type: object + UpdateDedicatedGroupResponse: + additionalProperties: false + properties: + DedicatedGroup: + "$ref": "#/components/schemas/DedicatedGroup" + ResponseContext: + "$ref": "#/components/schemas/ResponseContext" + type: object UpdateDirectLinkInterfaceRequest: additionalProperties: false properties: @@ -9098,22 +10214,48 @@ components: description: The ID of a network interface card (NIC). type: string RouteTableId: - description: The ID of the route table. - type: string - VmId: - description: The ID of a NAT VM in your Net. + description: The ID of the route table. + type: string + VmId: + description: The ID of a NAT VM in your Net. + type: string + required: + - RouteTableId + - DestinationIpRange + type: object + UpdateRouteResponse: + additionalProperties: false + properties: + ResponseContext: + "$ref": "#/components/schemas/ResponseContext" + RouteTable: + "$ref": "#/components/schemas/RouteTable" + type: object + UpdateRouteTableLinkRequest: + additionalProperties: false + properties: + DryRun: + description: If true, checks whether you have the required permissions to + perform the action. + type: boolean + LinkRouteTableId: + description: The ID of the current route table link. + type: string + RouteTableId: + description: The ID of the new route table to associate with the Subnet. type: string required: - RouteTableId - - DestinationIpRange + - LinkRouteTableId type: object - UpdateRouteResponse: + UpdateRouteTableLinkResponse: additionalProperties: false properties: + LinkRouteTableId: + description: The ID of the association between the route table and the Subnet. + type: string ResponseContext: "$ref": "#/components/schemas/ResponseContext" - RouteTable: - "$ref": "#/components/schemas/RouteTable" type: object UpdateServerCertificateRequest: additionalProperties: false @@ -9282,7 +10424,7 @@ components: KeypairName: description: |- The name of a keypair you want to associate with the VM.
- When you replace the keypair of a VM with another one, the metadata of the VM is modified to reflect the new public key, but the replacement is still not effective in the operating system of the VM. To complete the replacement and effectively apply the new keypair, you need to perform other actions inside the VM. For more information, see [Modifying the Keypair of an Instance](https://docs.outscale.com/en/userguide/Modifying-the-Keypair-of-an-Instance.html). + When you replace the keypair of a VM with another one, the metadata of the VM is modified to reflect the new public key, but the replacement is still not effective in the operating system of the VM. To complete the replacement and effectively apply the new keypair, you need to perform other actions inside the VM. For more information, see [Modifying the Keypair of a VM](https://docs.outscale.com/en/userguide/Modifying-the-Keypair-of-a-VM.html). type: string NestedVirtualization: description: "(dedicated tenancy only) If true, nested virtualization is @@ -9313,7 +10455,7 @@ components: If set to `terminate`, the VM stops and is terminated. type: string VmType: - description: The type of VM. For more information, see [Instance Types](https://docs.outscale.com/en/userguide/Instance-Types.html). + description: The type of VM. For more information, see [VM Types](https://docs.outscale.com/en/userguide/VM-Types.html). type: string required: - VmId @@ -9366,24 +10508,23 @@ components: perform the action. type: boolean Iops: - description: The new number of I/O operations per second (IOPS). This parameter - can be specified only if you update an `io1` volume. The maximum number - of IOPS allowed for `io1` volumes is `13000` with a maximum performance - ratio of 300 IOPS per gibibyte. This modification is instantaneous on - a cold volume, not on a hot one. + description: |- + **Cold volume**: the new number of I/O operations per second (IOPS). This parameter can be specified only if you update an `io1` volume or if you change the type of the volume for an `io1`. This modification is instantaneous.
+ **Hot volume**: the new number of I/O operations per second (IOPS). This parameter can be specified only if you update an `io1` volume. This modification is not instantaneous.

+ The maximum number of IOPS allowed for `io1` volumes is `13000` with a maximum performance ratio of 300 IOPS per gibibyte. type: integer Size: - description: "(cold volume only) The new size of the volume, in gibibytes - (GiB). This value must be equal to or greater than the current size of - the volume. This modification is not instantaneous." + description: |- + **Cold volume**: the new size of the volume, in gibibytes (GiB). This value must be equal to or greater than the current size of the volume. This modification is not instantaneous.
+ **Hot volume**: you cannot change the size of a hot volume. type: integer VolumeId: description: The ID of the volume you want to update. type: string VolumeType: - description: "(cold volume only) The new type of the volume (`standard` - \\| `io1` \\| `gp2`). This modification is instantaneous. If you update - to an `io1` volume, you must also specify the `Iops` parameter." + description: |- + **Cold volume**: the new type of the volume (`standard` \| `io1` \| `gp2`). This modification is instantaneous. If you update to an `io1` volume, you must also specify the `Iops` parameter.
+ **Hot volume**: you cannot change the type of a hot volume. type: string required: - VolumeId @@ -9413,7 +10554,7 @@ components: description: The ID of the VPN connection you want to modify. type: string VpnOptions: - "$ref": "#/components/schemas/VpnOptions" + "$ref": "#/components/schemas/VpnOptionsToUpdate" required: - VpnConnectionId type: object @@ -9575,7 +10716,7 @@ components: description: The reservation ID of the VM. type: string RootDeviceName: - description: The name of the root device for the VM (for example, `/dev/vda1`). + description: The name of the root device for the VM (for example, `/dev/sda1`). type: string RootDeviceType: description: The type of root device used by the VM (always `bsu`). @@ -9612,7 +10753,7 @@ components: If set to `terminate`, the VM stops and is deleted. type: string VmType: - description: The type of VM. For more information, see [Instance Types](https://docs.outscale.com/en/userguide/Instance-Types.html). + description: The type of VM. For more information, see [VM Types](https://docs.outscale.com/en/userguide/VM-Types.html). type: string type: object VmGroup: @@ -9775,6 +10916,15 @@ components: description: This parameter is not available. It is present in our API for the sake of historical compatibility with AWS. type: boolean + EphemeralsType: + description: The type of ephemeral storage disk. + type: string + Eth: + description: The number of Ethernet interface available. + type: integer + Gpu: + description: The number of GPU available. + type: integer MaxPrivateIps: description: The maximum number of private IPs per network interface card (NIC). @@ -9904,6 +11054,17 @@ components: CIDR block from the 169.254.254.0/24 range. type: string type: object + VpnOptionsToUpdate: + additionalProperties: false + description: Information about the VPN options. + properties: + Phase2Options: + "$ref": "#/components/schemas/Phase2OptionsToUpdate" + TunnelInsideIpRange: + description: The range of inside IPs for the tunnel. This must be a /30 + CIDR block from the 169.254.254.0/24 range. + type: string + type: object With: additionalProperties: false description: The information to display in each returned log. @@ -10006,25 +11167,61 @@ components: info: contact: email: support@outscale.com - description: |- - Welcome to the OUTSCALE API documentation.
- The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

- You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

- Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
- You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

- An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + description: "Welcome to the OUTSCALE API documentation.
\nThe OUTSCALE API + enables you to manage your resources in the OUTSCALE Cloud. This documentation + describes the different actions available along with code examples.

\nThrottling: + To protect against overloads, the number of identical requests allowed in a given + time period is limited.
\nBrute force: To protect against brute force attacks, + the number of failed authentication attempts in a given time period is limited.

\nYou can learn more about errors returned by the API in the dedicated + [errors page](api/errors).

\nNote that the OUTSCALE Cloud is compatible + with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) + between AWS and the OUTSCALE API.
\nYou can also manage your resources using + the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

\nAn OpenAPI description of the OUTSCALE API is also available in this + [GitHub repository](https://github.com/outscale/osc-api).
\n# Authentication + Schemes\n### Access Key/Secret Key\nThe main way to authenticate your requests + to the OUTSCALE API is to use an access key and a secret key.
\nThe mechanism + behind this is based on AWS Signature Version 4, whose technical implementation + details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

\nIn practice, the way to specify your access key and secret key depends + on the tool or SDK you want to use to interact with the API.
\n\n> For example, + if you use OSC CLI:\n> 1. You need to create an **~/.osc/config.json** file to + specify your access key, secret key, and the Region of your account.\n> 2. You + then specify the `--profile` option when executing OSC CLI commands.\n> \n> For + more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html).\n\nSee + the code samples in each section of this documentation for specific examples in + different programming languages.
\nFor more information about access keys, + see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html).\n### + Login/Password\nFor certain API actions, you can also use basic authentication + with the login (email address) and password of your TINA account.
\nThis + is useful only in special circumstances, for example if you do not know your access + key/secret key and want to retrieve them programmatically.
\nIn most cases, + however, you can use the Cockpit web interface to retrieve them.
\n\n> For + example, if you use OSC CLI:\n> 1. You need to create an **~/.osc/config.json** + file to specify the Region of your account, but you leave the access key value + and secret key value empty (`""`).\n> 2. You then specify the `--profile`, + `--authentication-method`, `--login`, and `--password` options when executing + OSC CLI commands.\n\nSee the code samples in each section of this documentation + for specific examples in different programming languages.\n### No Authentication\nA + few API actions do not require any authentication. They are indicated as such + in this documentation.
\n### Other Security Mechanisms\nIn parallel with + the authentication schemes, you can add other security mechanisms to your OUTSCALE + account, for example to restrict API requests by IP or other criteria.
\nFor + more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html)." license: name: BSD 3 Clause url: https://opensource.org/licenses/BSD-3-Clause termsOfService: https://en.outscale.com/terms-of-service/ title: 3DS OUTSCALE API - version: '1.27' + version: 1.28.5 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: @@ -10034,12 +11231,35 @@ paths: application/json: schema: "$ref": "#/components/schemas/AcceptNetPeeringRequest" + examples: + ex1: + value: + NetPeeringId: pcx-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/AcceptNetPeeringResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + NetPeering: + Tags: [] + SourceNet: + NetId: vpc-12345678 + IpRange: 10.0.0.0/16 + AccountId: '123456789012' + NetPeeringId: pcx-12345678 + AccepterNet: + NetId: vpc-12345678 + IpRange: 172.16.0.0/16 + AccountId: '123456789012' + State: + Name: active + Message: Active description: The HTTP 200 response (OK). '400': content: @@ -10076,18 +11296,29 @@ paths: application/json: schema: "$ref": "#/components/schemas/CheckAuthenticationRequest" + examples: + ex1: + value: + Login: example@example.com + Password: "$OSC_PASSWORD" responses: '200': content: application/json: schema: "$ref": "#/components/schemas/CheckAuthenticationResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 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`. + 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: operationId: CreateAccessKey requestBody: @@ -10095,12 +11326,28 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateAccessKeyRequest" + examples: + ex1: + value: + ExpirationDate: '2063-04-05' 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 + SecretKey: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + LastModificationDate: 2010-10-01 12:34:56.789000000 +00:00 description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -10111,9 +11358,11 @@ paths: description: |- Creates an OUTSCALE account.

- **[NOTE]**
+ **[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: operationId: CreateAccount requestBody: @@ -10121,12 +11370,37 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateAccountRequest" + examples: + ex1: + value: + City: SAINT-CLOUD + CompanyName: EXAMPLE SAS + Country: FRANCE + CustomerId: '87654321' + Email: example@example.com + FirstName: JEAN + LastName: DUPONT + ZipCode: '92210' responses: '200': content: application/json: schema: "$ref": "#/components/schemas/CreateAccountResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Account: + ZipCode: '92210' + CompanyName: EXAMPLE SAS + FirstName: JEAN + City: SAINT-CLOUD + Country: FRANCE + LastName: DUPONT + AccountId: '123456789012' + Email: example@example.com description: The HTTP 200 response (OK). tags: - Account @@ -10136,7 +11410,8 @@ paths: 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). + 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: operationId: CreateApiAccessRule requestBody: @@ -10144,12 +11419,59 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateApiAccessRuleRequest" + examples: + ex1: + summary: Creating an API access rule based on IPs + value: + 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: + IpRanges: + - 192.0.2.0 + - 198.51.100.0/24 + 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 + 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 description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -10157,7 +11479,9 @@ paths: tags: - ApiAccessRule "/CreateCa": - description: Creates a Client Certificate Authority (CA). + 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: operationId: CreateCa requestBody: @@ -10165,12 +11489,26 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateCaRequest" + examples: + ex1: + value: + CaPem: XXXX + Description: CA example responses: '200': content: application/json: schema: "$ref": "#/components/schemas/CreateCaResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Ca: + Description: CA example + CaId: ca-fedcba0987654321fedcba0987654321 + CaFingerprint: 1234567890abcdef1234567890abcdef12345678 description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -10181,7 +11519,8 @@ paths: 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). + 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: operationId: CreateClientGateway requestBody: @@ -10189,18 +11528,97 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateClientGatewayRequest" + examples: + ex1: + value: + ConnectionType: ipsec.1 + PublicIp: 192.0.2.0 + 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 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: + operationId: CreateDedicatedGroup + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/CreateDedicatedGroupRequest" + examples: + ex1: + value: + CpuGeneration: 4 + Name: dedicated-group-example + SubregionName: eu-west-2a + 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 + Name: dedicated-group-example + SubregionName: eu-west-2a + DedicatedGroupId: ded-12345678 + description: The HTTP 200 response (OK). + '400': + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + description: The HTTP 400 response (Bad Request). + '401': + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + description: The HTTP 401 response (Unauthorized). + '500': + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + description: The HTTP 500 response (Internal Server Error). + tags: + - DedicatedGroup "/CreateDhcpOptions": - description: Creates a set of DHCP options, that you can then associate with a - Net using the [UpdateNet](#updatenet) method. + 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: operationId: CreateDhcpOptions requestBody: @@ -10208,18 +11626,45 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateDhcpOptionsRequest" + examples: + ex1: + value: + DomainName: example.com + DomainNameServers: + - 192.0.2.0 + - 198.51.100.0 + NtpServers: + - 203.0.113.0 + - 203.0.113.1 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 description: The HTTP 200 response (OK). tags: - DhcpOption "/CreateDirectLink": - description: Creates a DirectLink between a customer network and a specified DirectLink - location. + 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: operationId: CreateDirectLink requestBody: @@ -10227,19 +11672,39 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateDirectLinkRequest" + examples: + ex1: + value: + Location: PAR1 + Bandwidth: 1Gbps + DirectLinkName: Connection to Outscale 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 + DirectLinkId: dxcon-12345678 + DirectLinkName: Connection to Outscale + Location: PAR1 + RegionName: eu-west-2 + State: requested 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. + 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: operationId: CreateDirectLinkInterface requestBody: @@ -10247,19 +11712,51 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateDirectLinkInterfaceRequest" + examples: + ex1: + value: + DirectLinkId: dxcon-12345678 + DirectLinkInterface: + DirectLinkInterfaceName: MyDirectLinkInterface + Vlan: 101 + BgpAsn: 65000 + BgpKey: tgyn26example + OutscalePrivateIp: 172.16.0.4/30 + ClientPrivateIp: 172.16.0.5/30 + VirtualGatewayId: vgw-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/CreateDirectLinkInterfaceResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + DirectLinkInterface: + Vlan: 101 + OutscalePrivateIp: 172.16.0.4/30 + DirectLinkInterfaceId: dxvif-12345678 + BgpAsn: 65000 + AccountId: '123456789012' + ClientPrivateIp: 172.16.0.5/30 + VirtualGatewayId: vgw-12345678 + DirectLinkInterfaceName: MyDirectLinkInterface + DirectLinkId: dxcon-12345678 + Mtu: 1500 + State: pending + 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). + 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: operationId: CreateFlexibleGpu requestBody: @@ -10267,28 +11764,48 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateFlexibleGpuRequest" + examples: + ex1: + value: + ModelName: nvidia-p100 + Generation: v5 + SubregionName: eu-west-2a + 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 + Generation: v5 + ModelName: nvidia-p100 + State: allocated + FlexibleGpuId: fgpu-12345678 description: The HTTP 200 response (OK). tags: - FlexibleGpu "/CreateImage": description: |- - Creates an OUTSCALE machine image (OMI) from an existing virtual machine (VM) which is either running or stopped.
- This action also creates a snapshot of the root volume of the VM, as well as a snapshot of each Block Storage Unit (BSU) volume attached to the VM. For more information, see [About OMIs](https://docs.outscale.com/en/userguide/About-OMIs.html).

+ Creates an OUTSCALE machine image (OMI).
+ You can use this method in different ways: + * **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 or Access Control Lists. For more information, see [Managing Access to Your Buckets and Objects](https://docs.outscale.com/en/userguide/Managing-Access-to-Your-Buckets-and-Objects.html).
+ * **Registering from a bucket without using a manifest file**: This is similar to the previous case but you manually specify all the information that would be in a manifest file instead of using a manifest file. - You can also use this method to copy an OMI to your account, from an account in the same Region. To do so, the owner of the source OMI must share it with your account. For more information about how to share an OMI with another account in the same Region, see [UpdateImage](#updateimage).
- To copy an OMI between accounts in different Regions, the owner of the source OMI must first export it to an OUTSCALE Object Storage (OOS) bucket using the [CreateImageExportTask](#createimageexporttask) method, and then you need to create a copy of the image in your account.
- The copy of the source OMI is independent and belongs to you.

+ **[TIP]**
+ Registering from a bucket enables you to copy an OMI across Regions. - You can also use this method to register an OMI to finalize its creation process.
- You can register an OMI from a snapshot of a root device to create an OMI based on this snapshot. You can also register an OMI that has been exported to an S3-compatible bucket to create a copy of it in your account. For more information about OMI export to an OOS bucket, see [CreateImageExportTask](#createimageexporttask).
- You can register an OMI using a pre-signed URL of the manifest file of the OMI. You do not need any permission for this OMI, or the bucket in which it is contained. The manifest file is obsolete seven days after a completed export as it contains pre-signed URLs to the appropriate snapshots (pre-signed URLs are valid for only seven days).
- Once the OMI is registered, you can launch a VM from this OMI. The copy of the source OMI is independent and belongs to you. + For more information, see [About OMIs](https://docs.outscale.com/en/userguide/About-OMIs.html). post: operationId: CreateImage requestBody: @@ -10296,12 +11813,169 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateImageRequest" + examples: + ex1: + summary: Creating from a VM + value: + ImageName: create-image-example + VmId: i-12345678 + NoReboot: true + ex2: + summary: Copying an OMI + value: + ImageName: copy-image-example + SourceImageId: ami-12345678 + SourceRegionName: eu-west-2 + ex3: + summary: Registering from a snapshot + value: + ImageName: register-image-from-snapshot-example + BlockDeviceMappings: + - DeviceName: "/dev/sda1" + Bsu: + SnapshotId: snap-12345678 + VolumeSize: 120 + VolumeType: io1 + Iops: 150 + DeleteOnVmDeletion: true + RootDeviceName: "/dev/sda1" + ex4: + summary: Registering from a bucket by using a manifest file + value: + ImageName: register-image-from-bucket-example + 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' + Tags: [] + Description: '' + ImageId: ami-12345678 + BlockDeviceMappings: + - DeviceName: "/dev/sda1" + Bsu: + VolumeType: standard + DeleteOnVmDeletion: true + VolumeSize: 50 + SnapshotId: snap-12345678 + ImageType: machine + CreationDate: '2010-10-01T12:34:56.789Z' + FileLocation: 123456789012/create-image-example + Architecture: x86_64 + ImageName: create-image-example + 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' + Tags: [] + Description: '' + ImageId: ami-12345678 + BlockDeviceMappings: + - DeviceName: "/dev/sda1" + Bsu: + VolumeType: standard + DeleteOnVmDeletion: true + VolumeSize: 50 + SnapshotId: snap-12345678 + ImageType: machine + CreationDate: '2010-10-01T12:34:56.789Z' + FileLocation: 123456789012/copy-image-example + Architecture: x86_64 + ImageName: copy-image-example + 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' + Tags: [] + Description: '' + ImageId: ami-12345678 + BlockDeviceMappings: + - DeviceName: "/dev/sda1" + Bsu: + VolumeType: io1 + DeleteOnVmDeletion: true + VolumeSize: 120 + Iops: 150 + SnapshotId: snap-12345678 + ImageType: machine + CreationDate: '2010-10-01T12:34:56.789Z' + FileLocation: 123456789012/register-image-from-snapshot-example + Architecture: x86_64 + ImageName: register-image-from-snapshot-example + 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' + Tags: [] + Description: '' + ImageId: ami-12345678 + BlockDeviceMappings: + - DeviceName: "/dev/sda1" + Bsu: + VolumeType: standard + DeleteOnVmDeletion: true + VolumeSize: 50 + SnapshotId: snap-12345678 + ImageType: machine + CreationDate: '2010-10-01T12:34:56.789Z' + FileLocation: https://oos.eu-west-2.outscale.com/BUCKET/KEY?AWSAccessKeyId=ABCDEFGHIJ0123456789&Expires=1493372309&Signature=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + Architecture: x86_64 + ImageName: register-image-from-bucket-example description: The HTTP 200 response (OK). '400': content: @@ -10329,8 +12003,9 @@ paths: This action enables you to copy an OMI between accounts in different Regions. To copy an OMI in the same Region, you can also use the [CreateImage](#createimage) method.
The copy of the OMI belongs to you and is independent from the source OMI.

- **[NOTE]**
- 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. + **[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: operationId: CreateImageExportTask requestBody: @@ -10338,19 +12013,44 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateImageExportTaskRequest" + examples: + ex1: + value: + ImageId: ami-12345678 + OsuExport: + DiskImageFormat: qcow2 + OsuBucket: BUCKET + OsuPrefix: PREFIX responses: '200': content: application/json: schema: "$ref": "#/components/schemas/CreateImageExportTaskResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ImageExportTask: + Tags: [] + ImageId: ami-12345678 + TaskId: image-export-12345678 + Comment: Export of image ami-12345678 + OsuExport: + OsuPrefix: PREFIX/ami-12345678/ + OsuBucket: BUCKET + DiskImageFormat: qcow2 + State: pending/queued + 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 your virtual machines (VMs) launched in a Net to connect to the Internet. By default, a Net includes an Internet service, and each Subnet is public. Every VM launched within a default Subnet has a private IP and a public IP. + An Internet service enables your virtual machines (VMs) launched in a Net to connect to the Internet. By default, a Net includes an Internet service, and each Subnet is public. Every VM launched within a default Subnet has a private IP and a public IP.

+ For more information, see [About Internet Services](https://docs.outscale.com/en/userguide/About-Internet-Services.html). post: operationId: CreateInternetService requestBody: @@ -10358,12 +12058,23 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateInternetServiceRequest" + examples: + ex1: + value: {} responses: '200': content: application/json: schema: "$ref": "#/components/schemas/CreateInternetServiceResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + InternetService: + Tags: [] + InternetServiceId: igw-12345678 description: The HTTP 200 response (OK). '400': content: @@ -10387,11 +12098,13 @@ paths: - InternetService "/CreateKeypair": description: |- - Creates a 2048-bit RSA keypair with a specified name.
- This action returns the private key that you need to save. The public key is stored by 3DS OUTSCALE.

+ 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), ECDSA (256 bits), and Ed25519. The following formats can be used: PEM, PKCS8, RFC4716, and OpenSSH. - You can also import a public key. The following types of key can be imported: RSA (minimum 2048 bits, recommended 4096 bits), ECDSA (minimum and recommended 256 bits), and Ed25519. The following formats can be used: PEM, PKCS8, RFC4716, and OpenSSH.
- This action imports the public key of a keypair created by a third-party tool and uses it to create a keypair. The private key is never provided to 3DS OUTSCALE. + For more information, see [About Keypairs](https://docs.outscale.com/en/userguide/About-Keypairs.html). post: operationId: CreateKeypair requestBody: @@ -10399,12 +12112,43 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateKeypairRequest" + examples: + ex1: + summary: Creating a keypair + value: + KeypairName: create-keypair-example + ex2: + summary: Importing a keypair created locally + value: + KeypairName: import-keypair-example + PublicKey: "..." 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: + PrivateKey: |- + -----BEGIN RSA PRIVATE KEY----- + ... + -----END RSA PRIVATE KEY----- + KeypairName: create-keypair-example + 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: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Keypair: + KeypairName: create-keypair-example + 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: @@ -10435,7 +12179,8 @@ paths: "/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. + 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: operationId: CreateListenerRule requestBody: @@ -10443,12 +12188,68 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateListenerRuleRequest" + examples: + ex1: + summary: Creating a listener rule based on a host pattern + value: + Listener: + LoadBalancerName: example-lbu + LoadBalancerPort: 80 + ListenerRule: + Action: forward + HostNamePattern: "*.example.com" + ListenerRuleName: example-listener-rule + Priority: 10 + VmIds: + - i-12345678 + ex2: + summary: Creating a listener rule based on a path pattern + value: + Listener: + LoadBalancerName: example-lbu + LoadBalancerPort: 80 + ListenerRule: + Action: forward + PathPattern: "/docs/*" + ListenerRuleName: example-listener-rule + Priority: 100 + VmIds: + - i-12345678 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: + Priority: 10 + VmIds: + - i-12345678 + 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: + Priority: 100 + VmIds: + - i-12345678 + ListenerRuleName: example-listener-rule + Action: forward + ListenerId: 123456 + PathPattern: "/docs/*" + ListenerRuleId: 1234 description: The HTTP 200 response (OK). tags: - Listener @@ -10457,7 +12258,8 @@ paths: 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. + 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: operationId: CreateLoadBalancer requestBody: @@ -10465,17 +12267,178 @@ paths: 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 + 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 + 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 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: + PublicationInterval: 60 + 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 + LoadBalancerStickyCookiePolicies: [] + SubregionNames: + - eu-west-2a + Listeners: + - BackendPort: 80 + BackendProtocol: TCP + LoadBalancerPort: 80 + LoadBalancerProtocol: TCP + LoadBalancerName: private-lb-example + ex2: + summary: Creating an internet-facing load balancer in a Net + 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: + 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 + 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: + PublicationInterval: 60 + 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 + LoadBalancerStickyCookiePolicies: [] + SubregionNames: + - eu-west-2a + Listeners: + - BackendPort: 8080 + BackendProtocol: HTTP + LoadBalancerPort: 8080 + LoadBalancerProtocol: HTTP + LoadBalancerName: public-lb-example description: The HTTP 200 response (OK). tags: - LoadBalancer "/CreateLoadBalancerListeners": - description: Creates one or more listeners for a specified load balancer. + 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: operationId: CreateLoadBalancerListeners requestBody: @@ -10483,12 +12446,64 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateLoadBalancerListenersRequest" + examples: + ex1: + value: + LoadBalancerName: example-lbu + Listeners: + - BackendPort: 58 + BackendProtocol: TCP + LoadBalancerPort: 62 + LoadBalancerProtocol: TCP 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: + PublicationInterval: 60 + 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 + LoadBalancerStickyCookiePolicies: [] + SubregionNames: + - eu-west-2a + Listeners: + - BackendPort: 58 + BackendProtocol: TCP + LoadBalancerPort: 62 + LoadBalancerProtocol: TCP + - BackendPort: 80 + BackendProtocol: TCP + LoadBalancerPort: 80 + LoadBalancerProtocol: TCP + LoadBalancerName: example-lbu description: The HTTP 200 response (OK). tags: - Listener @@ -10500,7 +12515,8 @@ paths: 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. + 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: operationId: CreateLoadBalancerPolicy requestBody: @@ -10508,19 +12524,115 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateLoadBalancerPolicyRequest" + examples: + ex1: + summary: Creating a load balancer policy based on browser + value: + LoadBalancerName: example-lbu + PolicyName: example-browser-policy + PolicyType: load_balancer + ex2: + summary: Creating a load balancer policy based on application cookie + value: + LoadBalancerName: example-lbu + PolicyName: example-app-policy + PolicyType: app + 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: + PublicationInterval: 60 + 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 + LoadBalancerStickyCookiePolicies: + - PolicyName: example-browser-policy + CookieExpirationPeriod: 1 + SubregionNames: + - eu-west-2a + Listeners: + - BackendPort: 80 + BackendProtocol: HTTP + LoadBalancerPort: 80 + LoadBalancerProtocol: HTTP + LoadBalancerName: example-lbu + 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: + PublicationInterval: 60 + 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 + LoadBalancerStickyCookiePolicies: [] + SubregionNames: + - eu-west-2a + Listeners: + - BackendPort: 80 + BackendProtocol: HTTP + LoadBalancerPort: 80 + LoadBalancerProtocol: HTTP + LoadBalancerName: example-lbu 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. + 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: operationId: CreateLoadBalancerTags requestBody: @@ -10528,12 +12640,25 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateLoadBalancerTagsRequest" + examples: + ex1: + value: + LoadBalancerNames: + - private-lb-example + Tags: + - Key: key1 + Value: value1 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/CreateLoadBalancerTagsResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - LoadBalancer @@ -10544,8 +12669,9 @@ paths: 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).

- **[NOTE]**
- 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. + **[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: operationId: CreateNatService requestBody: @@ -10553,12 +12679,31 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateNatServiceRequest" + examples: + ex1: + value: + SubnetId: subnet-12345678 + PublicIpId: eipalloc-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/CreateNatServiceResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + NatService: + Tags: [] + SubnetId: subnet-12345678 + NatServiceId: nat-12345678 + PublicIps: + - PublicIpId: eipalloc-12345678 + PublicIp: 192.0.2.0 + NetId: vpc-12345678 + State: available description: The HTTP 200 response (OK). '400': content: @@ -10583,7 +12728,8 @@ paths: "/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). + 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: operationId: CreateNet requestBody: @@ -10591,12 +12737,28 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateNetRequest" + examples: + ex1: + value: + IpRange: 10.0.0.0/16 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 description: The HTTP 200 response (OK). '400': content: @@ -10628,7 +12790,8 @@ paths: 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. + 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.

+ For more information, see [About Net Access Points](https://docs.outscale.com/en/userguide/About-Net-Access-Points.html). post: operationId: CreateNetAccessPoint requestBody: @@ -10636,12 +12799,32 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateNetAccessPointRequest" + examples: + ex1: + value: + NetId: vpc-12345678 + RouteTableIds: + - rtb-12345678 + ServiceName: com.outscale.eu-west-2.oos 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 + RouteTableIds: + - rtb-12345678 + State: pending + NetId: vpc-12345678 + ServiceName: com.outscale.eu-west-2.oos description: The HTTP 200 response (OK). tags: - NetAccessPoint @@ -10650,10 +12833,12 @@ paths: 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).

- **[NOTE]**
+ **[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. Therefore, you do not need to create a B-to-A connection if an A-to-B connection is created and accepted. + + For more information, see [About Net Peerings](https://docs.outscale.com/en/userguide/About-Net-Peerings.html). post: operationId: CreateNetPeering requestBody: @@ -10661,12 +12846,36 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateNetPeeringRequest" + examples: + ex1: + value: + SourceNetId: vpc-12345678 + AccepterNetId: vpc-87654321 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/CreateNetPeeringResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + NetPeering: + Tags: [] + SourceNet: + NetId: vpc-12345678 + IpRange: 10.0.0.0/16 + AccountId: '123456789012' + NetPeeringId: pcx-12345678 + AccepterNet: + NetId: vpc-12345678 + IpRange: 172.16.0.0/16 + AccountId: '123456789012' + State: + Name: pending-acceptance + Message: Pending acceptance by 123456789012 description: The HTTP 200 response (OK). '400': content: @@ -10689,7 +12898,9 @@ paths: tags: - NetPeering "/CreateNic": - description: Creates a network interface card (NIC) in the specified Subnet. + 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: operationId: CreateNic requestBody: @@ -10697,12 +12908,83 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateNicRequest" + examples: + ex1: + summary: Creating a NIC + value: + SubnetId: subnet-12345678 + SecurityGroupIds: + - sg-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 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: + 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 + PrivateIps: + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + PrivateIp: 10.0.0.4 + IsPrimary: true + ex2: + summary: Creating a NIC with specific private IPs + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Nic: + 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 + PrivateIps: + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + PrivateIp: 10.0.0.4 + IsPrimary: true + - PrivateDnsName: ip-10-0-0-5.eu-west-2.compute.internal + PrivateIp: 10.0.0.5 + IsPrimary: false description: The HTTP 200 response (OK). '400': content: @@ -10724,10 +13006,126 @@ paths: description: The HTTP 500 response (Internal Server Error). 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: + operationId: CreatePolicy + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/CreatePolicyRequest" + examples: + ex1: + value: + Description: Example of description + Document: '{"Statement": [ {"Action": ["*"],"Effect","Allow","Resource": + ["*"]} ]}' + Path: "/example/" + PolicyName: example-user-policy + responses: + '200': + content: + application/json: + schema: + "$ref": "#/components/schemas/CreatePolicyResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Policy: + CreationDate: '2010-10-01T12:34:56.789Z' + Description: Example of description + IsLinkable: true + LastModificationDate: '2010-10-01T12:34:56.789Z' + Orn: orn:ows:idauth::012345678910:user-policy/Policy + Path: "/example/" + PolicyDefaultVersionId: version-12345678 + PolicyId: policy-12345678 + PolicyName: example-user-policy + ResourcesCount: 0 + 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: + operationId: CreatePolicyVersion + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/CreatePolicyVersionRequest" + examples: + ex1: + value: + Document: '{"Statement": [ {"Action": ["*"],"Effect","Allow","Resource": + ["*"]} ]}' + PolicyOrn: orn:ows:idauth::012345678910:user-policy/Policy + SetAsDefault: true + responses: + '200': + content: + application/json: + schema: + "$ref": "#/components/schemas/CreatePolicyVersionResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + PolicyVersion: + Body: '{"Statement": [ {"Action": ["*"],"Effect","Allow","Resource": + ["*"]} ]}' + CreationDate: '2010-10-01T12:34:56.789Z' + DefaultVersion: true + VersionId: version-12345678 + 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: + operationId: CreateProductType + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/CreateProductTypeRequest" + examples: + ex1: + value: + Vendor: vendor-name + Description: Example of description + responses: + '200': + content: + application/json: + schema: + "$ref": "#/components/schemas/CreateProductTypeResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + 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. + 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: operationId: CreatePublicIp requestBody: @@ -10735,12 +13133,24 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreatePublicIpRequest" + examples: + ex1: + value: {} responses: '200': content: application/json: schema: "$ref": "#/components/schemas/CreatePublicIpResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + PublicIp: + Tags: [] + PublicIpId: eipalloc-12345678 + PublicIp: 192.0.2.0 description: The HTTP 200 response (OK). '400': content: @@ -10774,7 +13184,8 @@ paths: * NAT service
* Network interface card (NIC)

- The routing algorithm is based on the most specific match. + 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: operationId: CreateRoute requestBody: @@ -10782,12 +13193,39 @@ paths: 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 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/CreateRouteResponse" + examples: + ex1: + summary: Creating a route to an Internet service + value: + RouteTable: + Routes: + - DestinationIpRange: 10.0.0.0/16 + CreationMethod: CreateRouteTable + State: active + - GatewayId: igw-12345678 + DestinationIpRange: 0.0.0.0/0 + CreationMethod: CreateRoute + State: active + LinkRouteTables: [] + NetId: vpc-12345678 + Tags: [] + RoutePropagatingVirtualGateways: [] + RouteTableId: rtb-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -10812,7 +13250,8 @@ paths: "/CreateRouteTable": description: |- Creates a route table for a specified Net.
- You can then add routes and associate this route table with a Subnet. + 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: operationId: CreateRouteTable requestBody: @@ -10820,12 +13259,31 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateRouteTableRequest" + examples: + ex1: + value: + NetId: vpc-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/CreateRouteTableResponse" + examples: + ex1: + value: + RouteTable: + Routes: + - DestinationIpRange: 10.0.0.0/16 + CreationMethod: CreateRouteTable + State: active + LinkRouteTables: [] + NetId: vpc-12345678 + Tags: [] + RoutePropagatingVirtualGateways: [] + RouteTableId: rtb-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -10854,7 +13312,8 @@ paths: 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. + 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: operationId: CreateSecurityGroup requestBody: @@ -10862,12 +13321,37 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateSecurityGroupRequest" + examples: + ex1: + value: + NetId: vpc-12345678 + SecurityGroupName: security-group-example + Description: Security group example responses: '200': content: application/json: schema: "$ref": "#/components/schemas/CreateSecurityGroupResponse" + examples: + ex1: + value: + 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: [] + NetId: vpc-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -10905,6 +13389,8 @@ paths: **[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: operationId: CreateSecurityGroupRule requestBody: @@ -10912,12 +13398,85 @@ paths: 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 + 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 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/CreateSecurityGroupRuleResponse" + examples: + ex1: + summary: Creating an inbound rule from an IP range + value: + 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 + 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 + SecurityGroupId: sg-12345678 + AccountId: '123456789012' + Description: Example of security group + InboundRules: + - FromPortRange: 22 + IpProtocol: tcp + ToPortRange: 22 + SecurityGroupsMembers: + - SecurityGroupName: another-security-group + SecurityGroupId: sg-87654321 + AccountId: '987654321098' + NetId: vpc-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -10946,7 +13505,8 @@ paths: 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 the 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. + 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: operationId: CreateServerCertificate requestBody: @@ -10954,12 +13514,30 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateServerCertificateRequest" + examples: + ex1: + value: + Name: server-cert-example + Body: "..." + Chain: "..." + PrivateKey: "..." + Path: "/example/" responses: '200': content: application/json: schema: "$ref": "#/components/schemas/CreateServerCertificateResponse" + examples: + ex1: + value: + ServerCertificate: + Path: "/example/" + Id: ABCDEFGHIJKLMNOPQRSTUVWXYZ1234 + Orn: orn:ows:idauth::012345678910:server-certificate/example/server-cert-example + Name: server-cert-example + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - ServerCertificate @@ -10967,9 +13545,11 @@ paths: 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**: You create a snapshot from one of your volumes.
- * **Copying**: 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**: You import a snapshot located in an OUTSCALE Object Storage (OOS) bucket. First, the owner of the source snapshot must export it to the bucket by using the [CreateSnapshotExportTask](#createsnapshotexporttask) method. Then, they must grant you read permission on the bucket via a pre-signed URL or Access Control Lists. For more information, see [Managing Access to Your Buckets and Objects](https://docs.outscale.com/en/userguide/Managing-Access-to-Your-Buckets-and-Objects.html). + * **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 the bucket by using the [CreateSnapshotExportTask](#createsnapshotexporttask) method. Then, they must grant you permission to read the snapshot via a pre-signed URL or Access Control Lists. For more information, see [Managing Access to Your Buckets and Objects](https://docs.outscale.com/en/userguide/Managing-Access-to-Your-Buckets-and-Objects.html). + + For more information, see [About Snapshots](https://docs.outscale.com/en/userguide/About-Snapshots.html). post: operationId: CreateSnapshot requestBody: @@ -10977,12 +13557,85 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateSnapshotRequest" + examples: + ex1: + summary: Creating from a volume + value: + VolumeId: vol-12345678 + Description: Snapshot created from a volume + ex2: + summary: Copying a snapshot + value: + SourceSnapshotId: snap-12345678 + SourceRegionName: eu-west-2 + Description: Snapshot created from another snapshot + ex3: + summary: Importing from a bucket + value: + FileLocation: https://oos.eu-west-2.outscale.com/BUCKET/KEY?AWSAccessKeyId=ABCDEFGHIJ0123456789&Expires=1493372309&Signature=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + SnapshotSize: 10737418240 + Description: Snapshot imported from a bucket responses: '200': content: application/json: schema: "$ref": "#/components/schemas/CreateSnapshotResponse" + examples: + ex1: + summary: Creating from a volume + value: + Snapshot: + VolumeSize: 10 + AccountId: '123456789012' + VolumeId: vol-12345678 + CreationDate: '2010-10-01T12:34:56.789Z' + PermissionsToCreateVolume: + GlobalPermission: false + AccountIds: [] + Progress: 0 + SnapshotId: snap-12345678 + State: pending/queued + Description: Snapshot created from a volume + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + summary: Copying a snapshot + value: + Snapshot: + VolumeSize: 10 + AccountId: '123456789012' + VolumeId: vol-12345678 + CreationDate: '2010-10-01T12:34:56.789Z' + PermissionsToCreateVolume: + GlobalPermission: false + AccountIds: [] + Progress: 100 + SnapshotId: snap-12345678 + State: completed + Description: Snapshot copied from another snapshot + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex3: + summary: Importing from a bucket + value: + Snapshot: + VolumeSize: 10 + AccountId: '123456789012' + VolumeId: vol-12345678 + CreationDate: '2010-10-01T12:34:56.789Z' + PermissionsToCreateVolume: + GlobalPermission: false + AccountIds: [] + Progress: 0 + SnapshotId: snap-12345678 + State: importing + Description: Snapshot imported from a bucket + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -11007,8 +13660,9 @@ paths: "/CreateSnapshotExportTask": description: |- Exports a snapshot to an OUTSCALE Object Storage (OOS) bucket.
- This action enables you to create a backup of your snapshot or to copy it to another account. You, or other users you send a pre-signed URL to, can then download this snapshot from the bucket using the [CreateSnapshot](#createsnapshot) method.
- This procedure enables you to copy a snapshot between accounts within the same Region or in different Regions. To copy a snapshot within the same Region, you can also use the [CreateSnapshot](#createsnapshot) direct method. The copy of the source snapshot is independent and belongs to you. + This action enables you to create a backup of your snapshot or to copy it to another account. You, or other accounts you send a pre-signed URL to, can then download this snapshot from the bucket using the [CreateSnapshot](#createsnapshot) method.
+ This procedure enables you to copy a snapshot between accounts within the same Region or in different Regions. To copy a snapshot within the same Region, you can also use the [CreateSnapshot](#createsnapshot) direct method. The copy of the source snapshot is independent and belongs to you.

+ For more information, see [About Snapshots](https://docs.outscale.com/en/userguide/About-Snapshots.html). post: operationId: CreateSnapshotExportTask requestBody: @@ -11016,19 +13670,44 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateSnapshotExportTaskRequest" + examples: + ex1: + value: + SnapshotId: snap-12345678 + OsuExport: + DiskImageFormat: qcow2 + OsuBucket: BUCKET + OsuPrefix: PREFIX responses: '200': content: application/json: schema: "$ref": "#/components/schemas/CreateSnapshotExportTaskResponse" + examples: + ex1: + value: + SnapshotExportTask: + Tags: [] + TaskId: snap-export-12345678 + Comment: Export of snapshot snap-12345678 + OsuExport: + OsuPrefix: PREFIX + OsuBucket: BUCKET + DiskImageFormat: qcow2 + State: pending + 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. + 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: operationId: CreateSubnet requestBody: @@ -11036,12 +13715,31 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateSubnetRequest" + examples: + ex1: + value: + NetId: vpc-12345678 + IpRange: 10.0.0.0/18 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/CreateSubnetResponse" + examples: + ex1: + value: + Subnet: + Tags: [] + SubregionName: eu-west-2a + SubnetId: subnet-12345678 + AvailableIpsCount: 16379 + IpRange: 10.0.0.0/18 + MapPublicIpOnLaunch: false + State: available + NetId: vpc-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -11095,6 +13793,8 @@ paths: * DHCP options (dopt-xxxxxxxx)
* OMI export tasks (image-export-xxxxxxxx)
* Snapshot export tasks (snap-export-xxxxxxxx) + + For more information, see [About Tags](https://docs.outscale.com/en/userguide/About-Tags.html). post: operationId: CreateTags requestBody: @@ -11102,12 +13802,25 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateTagsRequest" + examples: + ex1: + value: + ResourceIds: + - i-12345678 + Tags: + - Key: key1 + Value: value1 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/CreateTagsResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -11130,7 +13843,9 @@ paths: tags: - Tag "/CreateUser": - description: Creates an EIM user for your account. + 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: operationId: CreateUser requestBody: @@ -11138,19 +13853,34 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateUserRequest" + examples: + ex1: + value: + UserName: example-user + Path: "/documentation/" responses: '200': content: application/json: schema: "$ref": "#/components/schemas/CreateUserResponse" + examples: + ex1: + value: + User: + UserName: example-user + UserId: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 + Path: "/documentation/" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - User "/CreateVirtualGateway": description: |- Creates a virtual gateway.
- A virtual gateway is the access point on the Net side of a VPN connection. + 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: operationId: CreateVirtualGateway requestBody: @@ -11158,12 +13888,27 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateVirtualGatewayRequest" + examples: + ex1: + value: + ConnectionType: ipsec.1 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/CreateVirtualGatewayResponse" + examples: + ex1: + value: + VirtualGateway: + VirtualGatewayId: vgw-12345678 + ConnectionType: ipsec.1 + NetToVirtualGatewayLinks: [] + State: available + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - VirtualGateway @@ -11181,12 +13926,47 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateVmGroupRequest" + examples: + ex1: + value: + Description: Production log collector + PositioningStrategy: attract + SecurityGroupIds: + - sg-12345678 + SubnetId: subnet-12345678 + Tags: + - Key: key1 + Value: value1 + VmCount: 2 + VmGroupName: ClusterLog-PPD01 + VmTemplateId: vmtemplate-98765432109876543210987654321012 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/CreateVmGroupResponse" + examples: + ex1: + value: + VmGroup: + CreationDate: '2010-10-01T12:34:56.789Z' + Description: Production log collector + PositioningStrategy: attract + SecurityGroupIds: + - sg-12345678 + State: available + SubnetId: subnet-12345678 + Tags: + - Key: key1 + Value: value1 + VmCount: 2 + VmGroupId: vmgroup-12345678901234567890123456789012 + VmGroupName: ClusterLog-PPD01 + VmIds: [] + VmTemplateId: vmtemplate-98765432109876543210987654321012 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -11222,12 +14002,43 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateVmTemplateRequest" + examples: + ex1: + value: + CpuCores: 2 + CpuGeneration: v4 + CpuPerformance: high + Description: Log collector template + ImageId: ami-12345678 + KeypairName: keypair-example + Ram: 2 + Tags: + - Key: key1 + Value: value1 + VmTemplateName: vmtemplate-example responses: '200': content: application/json: schema: "$ref": "#/components/schemas/CreateVmTemplateResponse" + examples: + ex1: + value: + VmTemplateName: vmtemplate-example + CpuPerformance: high + CreationDate: 2010-10-01 12:34:56.789000000 +00:00 + CpuCores: 2 + Tags: + - Key: key1 + Value: value1 + Description: Log collector template + ImageId: ami-12345678 + CpuGeneration: v4 + VmTemplateId: vmtemplate-98765432109876543210987654321012 + Ram: 2 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - VmTemplate @@ -11238,7 +14049,8 @@ paths: 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. + 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: operationId: CreateVms requestBody: @@ -11246,12 +14058,312 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateVmsRequest" + examples: + ex1: + summary: Creating a VM (minimal syntax) + value: + ImageId: ami-12345678 + ex2: + summary: Creating a VM in a Net + value: + ImageId: ami-12345678 + VmType: tinav5.c1r1p2 + KeypairName: keypair-example + SecurityGroupIds: + - sg-12345678 + SubnetId: subnet-12345678 + UserData: "..." + ex3: + summary: Creating a VM with block device mappings + value: + ImageId: ami-12345678 + VmType: tinav5.c1r1p2 + KeypairName: keypair-example + SecurityGroupIds: + - sg-12345678 + SubnetId: subnet-12345678 + UserData: "..." + 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 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/CreateVmsResponse" + examples: + ex1: + summary: Creating a VM (minimal syntax) + value: + Vms: + - VmType: t2.small + VmInitiatedShutdownBehavior: stop + State: pending + StateReason: '' + RootDeviceType: ebs + RootDeviceName: "/dev/sda1" + IsSourceDestChecked: true + ImageId: ami-12345678 + DeletionProtection: false + Architecture: x86_64 + NestedVirtualization: false + BlockDeviceMappings: + - DeviceName: "/dev/sda1" + Bsu: + VolumeId: vol-12345678 + State: attaching + 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: "..." + PrivateIp: 10.0.0.4 + SecurityGroups: + - SecurityGroupName: default + SecurityGroupId: sg-12345678 + BsuOptimized: false + LaunchNumber: 0 + Performance: medium + Tags: [] + 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: + Vms: + - VmType: tinav5.c1r1p2 + VmInitiatedShutdownBehavior: stop + State: pending + StateReason: '' + RootDeviceType: ebs + RootDeviceName: "/dev/sda1" + IsSourceDestChecked: true + KeypairName: keypair-example + ImageId: ami-12345678 + DeletionProtection: false + Architecture: x86_64 + NestedVirtualization: false + BlockDeviceMappings: + - DeviceName: "/dev/sda1" + Bsu: + VolumeId: vol-12345678 + State: attaching + 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 + NetId: vpc-12345678 + Nics: + - SubnetId: subnet-12345678 + State: in-use + LinkNic: + State: attached + DeviceNumber: 0 + LinkNicId: eni-attach-12345678 + 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 + PrivateIps: + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + PrivateIp: 10.0.0.4 + IsPrimary: true + Performance: high + Tags: [] + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + 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 + RootDeviceName: "/dev/sda1" + IsSourceDestChecked: true + KeypairName: keypair-example + ImageId: ami-12345678 + DeletionProtection: false + Architecture: x86_64 + NestedVirtualization: false + BlockDeviceMappings: + - DeviceName: "/dev/sda1" + Bsu: + VolumeId: vol-12345678 + State: attaching + LinkDate: '2010-10-01T12:34:56.789Z' + DeleteOnVmDeletion: true + - DeviceName: "/dev/sda1" + Bsu: + VolumeId: vol-87654321 + State: attaching + 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 + NetId: vpc-12345678 + Nics: + - SubnetId: subnet-12345678 + State: in-use + LinkNic: + State: attached + DeviceNumber: 0 + LinkNicId: eni-attach-12345678 + 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 + PrivateIps: + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + PrivateIp: 10.0.0.4 + IsPrimary: true + Performance: high + Tags: [] + 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: + Vms: + - VmType: tinav5.c1r1p2 + VmInitiatedShutdownBehavior: stop + State: pending + StateReason: '' + RootDeviceType: ebs + RootDeviceName: "/dev/sda1" + IsSourceDestChecked: true + KeypairName: keypair-example + ImageId: ami-12345678 + DeletionProtection: false + Architecture: x86_64 + NestedVirtualization: false + BlockDeviceMappings: + - DeviceName: "/dev/sda1" + Bsu: + VolumeId: vol-12345678 + State: attaching + 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 + NetId: vpc-12345678 + Nics: + - SubnetId: subnet-12345678 + State: in-use + LinkNic: + State: attached + DeviceNumber: 0 + LinkNicId: eni-attach-12345678 + 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 + PrivateIps: + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + PrivateIp: 10.0.0.4 + IsPrimary: true + Performance: high + Tags: [] + 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: @@ -11277,7 +14389,8 @@ paths: 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. + 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: operationId: CreateVolume requestBody: @@ -11285,12 +14398,59 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateVolumeRequest" + examples: + ex1: + summary: Creating an io1 volume + value: + VolumeType: io1 + SubregionName: eu-west-2a + Size: 10 + Iops: 100 + ex2: + summary: Creating a volume from a snapshot + value: + SnapshotId: snap-12345678 + VolumeType: gp2 + SubregionName: eu-west-2a + Size: 10 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/CreateVolumeResponse" + examples: + ex1: + summary: Creating an io1 volume + value: + 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 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + summary: Creating a volume from a snapshot + value: + 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 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -11315,7 +14475,11 @@ paths: "/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. + 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: operationId: CreateVpnConnection requestBody: @@ -11323,19 +14487,47 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateVpnConnectionRequest" + examples: + ex1: + value: + ClientGatewayId: cgw-12345678 + VirtualGatewayId: vgw-12345678 + ConnectionType: ipsec.1 + StaticRoutesOnly: true responses: '200': content: application/json: schema: "$ref": "#/components/schemas/CreateVpnConnectionResponse" + examples: + ex1: + value: + VpnConnection: + Routes: [] + Tags: [] + ClientGatewayConfiguration: "..." + StaticRoutesOnly: true + VirtualGatewayId: vgw-12345678 + ConnectionType: ipsec.1 + ClientGatewayId: cgw-12345678 + State: pending + VgwTelemetries: + - StateDescription: IPSEC IS DOWN + AcceptedRouteCount: 0 + LastStateChangeDate: '2017-05-10T12:34:56.789Z' + OutsideIpAddress: 192.0.2.0 + VpnConnectionId: vpn-12345678 + 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. + 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: operationId: CreateVpnConnectionRoute requestBody: @@ -11343,21 +14535,29 @@ paths: application/json: schema: "$ref": "#/components/schemas/CreateVpnConnectionRouteRequest" + examples: + ex1: + value: + VpnConnectionId: vpn-12345678 + 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 description: The HTTP 200 response (OK). tags: - VpnConnection "/DeleteAccessKey": description: |- Deletes the specified access key of either your root account or an EIM user.

- - **[NOTE]**
- To protect against brute force attacks, the number of requests allowed for this method in a given time period is limited. + The access key of an EIM user must be in the `INACTIVE` state to be deleted. post: operationId: DeleteAccessKey requestBody: @@ -11365,12 +14565,28 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteAccessKeyRequest" + examples: + ex1: + summary: Deleting one of your own access keys (if you are the root + account or an EIM user) + value: + AccessKeyId: ABCDEFGHIJ0123456789 + ex2: + summary: Deleting the access key of a specific EIM user + value: + AccessKeyId: ABCDEFGHIJ0123456789 + UserName: example-user responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteAccessKeyResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -11378,7 +14594,7 @@ paths: tags: - AccessKey "/DeleteApiAccessRule": - description: "Deletes a specified API access rule.

\n\n**[NOTE]**

\n\n**[IMPORTANT]**
\nYou 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)." @@ -11389,12 +14605,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteApiAccessRuleRequest" + examples: + ex1: + value: + ApiAccessRuleId: aar-1234567890abcdef1234567890abcdef responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteApiAccessRuleResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -11410,12 +14635,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteCaRequest" + examples: + ex1: + value: + CaId: ca-fedcba0987654321fedcba0987654321 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteCaResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -11433,21 +14667,92 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteClientGatewayRequest" + examples: + ex1: + value: + ClientGatewayId: cgw-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteClientGatewayResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - ClientGateway + "/DeleteDedicatedGroup": + description: |- + > [WARNING]
+ > This feature is currently in beta.
+ + 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: + operationId: DeleteDedicatedGroup + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/DeleteDedicatedGroupRequest" + examples: + ex1: + summary: Deleting a dedicated group without any resource in it. + value: + DedicatedGroupId: ded-12345678 + ex2: + summary: Forcing the deletion of a dedicated group and all resources + in it. + value: + DedicatedGroupId: ded-12345678 + Force: true + responses: + '200': + content: + application/json: + schema: + "$ref": "#/components/schemas/DeleteDedicatedGroupResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + description: The HTTP 200 response (OK). + '400': + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + description: The HTTP 400 response (Bad Request). + '401': + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + description: The HTTP 401 response (Unauthorized). + '500': + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + description: The HTTP 500 response (Internal Server Error). + 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.

- **[NOTE]**
+ **[IMPORTANT]**
You cannot delete the `default` set. post: operationId: DeleteDhcpOptions @@ -11456,12 +14761,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteDhcpOptionsRequest" + examples: + ex1: + value: + DhcpOptionsSetId: dopt-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteDhcpOptionsResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - DhcpOption @@ -11476,12 +14790,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteDirectLinkRequest" + examples: + ex1: + value: + DirectLinkId: dxcon-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteDirectLinkResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - DirectLink @@ -11494,12 +14817,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteDirectLinkInterfaceRequest" + examples: + ex1: + value: + DirectLinkInterfaceId: dxvif-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteDirectLinkInterfaceResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - DirectLinkInterface @@ -11514,12 +14846,32 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteExportTaskRequest" + examples: + ex1: + summary: Deleting an image export task + value: + ExportTaskId: image-export-12345678 + ex2: + summary: Deleting a snapshot export task + value: + ExportTaskId: snap-export-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteExportTaskResponse" + examples: + ex1: + summary: Deleting an image export task + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + summary: Deleting a snapshot export task + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - Task @@ -11534,12 +14886,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteFlexibleGpuRequest" + examples: + ex1: + value: + FlexibleGpuId: fgpu-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteFlexibleGpuResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - FlexibleGpu @@ -11554,12 +14915,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteImageRequest" + examples: + ex1: + value: + ImageId: ami-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteImageResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -11592,12 +14962,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteInternetServiceRequest" + examples: + ex1: + value: + InternetServiceId: igw-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteInternetServiceResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -11630,12 +15009,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteKeypairRequest" + examples: + ex1: + value: + KeypairName: keypair-example responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteKeypairResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -11668,12 +15056,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteListenerRuleRequest" + examples: + ex1: + value: + ListenerRuleName: example-listener-rule responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteListenerRuleResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - Listener @@ -11686,12 +15083,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteLoadBalancerRequest" + examples: + ex1: + value: + LoadBalancerName: example-lbu responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteLoadBalancerResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - LoadBalancer @@ -11704,12 +15110,53 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteLoadBalancerListenersRequest" + examples: + ex1: + value: + LoadBalancerName: example-lbu + LoadBalancerPorts: + - 80 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: + PublicationInterval: 60 + 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 + LoadBalancerStickyCookiePolicies: [] + SubregionNames: + - eu-west-2a + Listeners: [] + LoadBalancerName: example-lbu description: The HTTP 200 response (OK). tags: - Listener @@ -11724,12 +15171,57 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteLoadBalancerPolicyRequest" + examples: + ex1: + value: + LoadBalancerName: example-lbu + PolicyName: example-browser-policy 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: + PublicationInterval: 60 + 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 + LoadBalancerStickyCookiePolicies: [] + SubregionNames: + - eu-west-2a + Listeners: + - BackendPort: 80 + BackendProtocol: HTTP + LoadBalancerPort: 80 + LoadBalancerProtocol: HTTP + LoadBalancerName: example-lbu description: The HTTP 200 response (OK). tags: - LoadBalancerPolicy @@ -11742,12 +15234,24 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteLoadBalancerTagsRequest" + examples: + ex1: + value: + LoadBalancerNames: + - example-lbu + Tags: + - Key: key1 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteLoadBalancerTagsResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - LoadBalancer @@ -11762,12 +15266,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteNatServiceRequest" + examples: + ex1: + value: + NatServiceId: nat-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteNatServiceResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -11810,12 +15323,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteNetRequest" + examples: + ex1: + value: + NetId: vpc-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteNetResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -11848,12 +15370,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteNetAccessPointRequest" + examples: + ex1: + value: + NetAccessPointId: vpce-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteNetAccessPointResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - NetAccessPoint @@ -11870,12 +15401,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteNetPeeringRequest" + examples: + ex1: + value: + NetPeeringId: pcx-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteNetPeeringResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -11914,12 +15454,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteNicRequest" + examples: + ex1: + value: + NicId: eni-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteNicResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -11941,6 +15490,64 @@ paths: description: The HTTP 500 response (Internal Server Error). 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 using the `DeletePolicyVersion` method. + post: + operationId: DeletePolicy + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/DeletePolicyRequest" + examples: + ex1: + value: + PolicyOrn: orn:ows:idauth::012345678910:user-policy/Policy + responses: + '200': + content: + application/json: + schema: + "$ref": "#/components/schemas/DeletePolicyResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + 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: + operationId: DeletePolicyVersion + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/DeletePolicyVersionRequest" + examples: + ex1: + value: + PolicyOrn: orn:ows:idauth::012345678910:user-policy/Policy + VersionId: version-12345678 + responses: + '200': + content: + application/json: + schema: + "$ref": "#/components/schemas/DeletePolicyVersionResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + description: The HTTP 200 response (OK). + tags: + - Policy "/DeletePublicIp": description: |- Releases a public IP.
@@ -11952,12 +15559,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeletePublicIpRequest" + examples: + ex1: + value: + PublicIp: 192.0.2.0 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeletePublicIpResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -11988,12 +15604,32 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteRouteRequest" + examples: + ex1: + value: + RouteTableId: rtb-12345678 + DestinationIpRange: 198.51.100.0/24 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteRouteResponse" + examples: + ex1: + value: + RouteTable: + Routes: + - DestinationIpRange: 10.0.0.0/16 + CreationMethod: CreateRouteTable + State: active + LinkRouteTables: [] + NetId: vpc-12345678 + Tags: [] + RoutePropagatingVirtualGateways: [] + RouteTableId: rtb-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -12026,12 +15662,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteRouteTableRequest" + examples: + ex1: + value: + RouteTableId: rtb-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteRouteTableResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -12065,12 +15710,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteSecurityGroupRequest" + examples: + ex1: + value: + SecurityGroupId: sg-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteSecurityGroupResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -12105,12 +15759,73 @@ paths: 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 + 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 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteSecurityGroupRuleResponse" + examples: + ex1: + summary: Deleting an inbound rule from an IP range + value: + 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: [] + 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 + SecurityGroupId: sg-12345678 + 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: @@ -12141,12 +15856,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteServerCertificateRequest" + examples: + ex1: + value: + Name: server-cert-example responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteServerCertificateResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - ServerCertificate @@ -12161,12 +15885,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteSnapshotRequest" + examples: + ex1: + value: + SnapshotId: snap-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteSnapshotResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -12195,7 +15928,7 @@ paths: * Virtual machines (VMs)
* Network Interface Cards (NICs)
- * Network Address Translation (NAT) gateways
+ * NAT services
* Load balancers post: operationId: DeleteSubnet @@ -12204,12 +15937,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteSubnetRequest" + examples: + ex1: + value: + SubnetId: subnet-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteSubnetResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -12240,12 +15982,25 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteTagsRequest" + examples: + ex1: + value: + ResourceIds: + - i-12345678 + Tags: + - Key: key1 + Value: value1 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteTagsResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -12269,7 +16024,7 @@ paths: - Tag "/DeleteUser": description: Deletes a specified EIM user. The EIM user must not belong to any - group and have any key, signing certificate or attached policy. + group, nor have any key or attached policy. post: operationId: DeleteUser requestBody: @@ -12277,12 +16032,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteUserRequest" + examples: + ex1: + value: + UserName: example-user responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteUserResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - User @@ -12297,12 +16061,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteVirtualGatewayRequest" + examples: + ex1: + value: + VirtualGatewayId: vgw-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteVirtualGatewayResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - VirtualGateway @@ -12319,12 +16092,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteVmGroupRequest" + examples: + ex1: + value: + VmGroupId: vmgroup-12345678901234567890123456789012 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteVmGroupResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -12360,12 +16142,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteVmTemplateRequest" + examples: + ex1: + value: + VmTemplateId: vmtemplate-98765432109876543210987654321012 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteVmTemplateResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - VmTemplate @@ -12380,12 +16171,26 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteVmsRequest" + examples: + ex1: + value: + VmIds: + - i-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteVmsResponse" + examples: + ex1: + value: + Vms: + - VmId: i-12345678 + PreviousState: running + CurrentState: shutting-down + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -12418,12 +16223,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteVolumeRequest" + examples: + ex1: + value: + VolumeId: vol-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteVolumeResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -12456,12 +16270,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteVpnConnectionRequest" + examples: + ex1: + value: + VpnConnectionId: vpn-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/DeleteVpnConnectionResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - VpnConnection @@ -12475,12 +16298,22 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeleteVpnConnectionRouteRequest" + examples: + ex1: + value: + VpnConnectionId: vpn-12345678 + 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 description: The HTTP 200 response (OK). tags: - VpnConnection @@ -12493,12 +16326,24 @@ paths: application/json: schema: "$ref": "#/components/schemas/DeregisterVmsInLoadBalancerRequest" + examples: + ex1: + value: + LoadBalancerName: example-lbu + BackendVmIds: + - i-12345678 + - i-87654321 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 @@ -12513,12 +16358,22 @@ paths: application/json: schema: "$ref": "#/components/schemas/LinkFlexibleGpuRequest" + examples: + ex1: + value: + FlexibleGpuId: fgpu-12345678 + VmId: i-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/LinkFlexibleGpuResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - FlexibleGpu @@ -12533,12 +16388,22 @@ paths: application/json: schema: "$ref": "#/components/schemas/LinkInternetServiceRequest" + examples: + ex1: + value: + InternetServiceId: igw-12345678 + NetId: vpc-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/LinkInternetServiceResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -12571,19 +16436,45 @@ paths: 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 + ex2: + summary: Linking public IPs to a load balancer + value: + LoadBalancerName: example-lbu + BackendIps: + - 192.0.2.0 + - 198.51.100.0 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/LinkLoadBalancerBackendMachinesResponse" + examples: + ex1: + summary: Linking VMs to a load balancer + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + summary: Linking public IPs to a load balancer + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - LoadBalancer "/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 an FNI to an Instance](https://docs.outscale.com/en/userguide/Attaching-an-FNI-to-an-Instance.html). + 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: operationId: LinkNic requestBody: @@ -12591,12 +16482,24 @@ paths: application/json: schema: "$ref": "#/components/schemas/LinkNicRequest" + examples: + ex1: + value: + NicId: eni-12345678 + VmId: i-12345678 + DeviceNumber: 1 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/LinkNicResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + LinkNicId: eni-attach-12345678 description: The HTTP 200 response (OK). '400': content: @@ -12618,6 +16521,34 @@ paths: description: The HTTP 500 response (Internal Server Error). tags: - Nic + "/LinkPolicy": + description: Links a managed policy to a specific user. + post: + operationId: LinkPolicy + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/LinkPolicyRequest" + examples: + ex1: + value: + PolicyOrn: orn:ows:idauth::012345678910:user-policy/Policy + UserName: example-user + responses: + '200': + content: + application/json: + schema: + "$ref": "#/components/schemas/LinkPolicyResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + 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 @@ -12633,12 +16564,30 @@ paths: application/json: schema: "$ref": "#/components/schemas/LinkPrivateIpsRequest" + examples: + ex1: + summary: Linking specific secondary private IPs to a NIC + value: + NicId: eni-12345678 + PrivateIps: + - 10.0.0.6 + - 10.0.0.7 + ex2: + summary: Linking a number of random secondary private IPs to a NIC + value: + NicId: eni-12345678 + SecondaryPrivateIpCount: 3 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/LinkPrivateIpsResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -12666,7 +16615,7 @@ paths: 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.

- **[NOTE]**
+ **[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: operationId: LinkPublicIp @@ -12675,12 +16624,36 @@ paths: application/json: schema: "$ref": "#/components/schemas/LinkPublicIpRequest" + examples: + ex1: + summary: Linking a public IP to a VM + value: + PublicIp: 192.0.2.0 + VmId: i-12345678 + ex2: + summary: Linking a public IP to a NIC + value: + PublicIp: 192.0.2.0 + NicId: eni-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/LinkPublicIpResponse" + examples: + ex1: + summary: Linking a public IP to a VM + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + LinkPublicIpId: eipassoc-12345678 + ex2: + summary: Linking a public IP to a NIC + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + LinkPublicIpId: eipassoc-12345678 description: The HTTP 200 response (OK). '400': content: @@ -12713,12 +16686,23 @@ paths: application/json: schema: "$ref": "#/components/schemas/LinkRouteTableRequest" + examples: + ex1: + value: + RouteTableId: rtb-12345678 + SubnetId: subnet-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/LinkRouteTableResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + LinkRouteTableId: rtbassoc-12345678 description: The HTTP 200 response (OK). '400': content: @@ -12741,7 +16725,11 @@ paths: tags: - RouteTable "/LinkVirtualGateway": - description: Attaches a virtual gateway to a Net. + 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: operationId: LinkVirtualGateway requestBody: @@ -12749,12 +16737,25 @@ paths: application/json: schema: "$ref": "#/components/schemas/LinkVirtualGatewayRequest" + examples: + ex1: + value: + VirtualGatewayId: vgw-12345678 + NetId: vpc-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/LinkVirtualGatewayResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + NetToVirtualGatewayLink: + State: attached + NetId: vpc-12345678 description: The HTTP 200 response (OK). tags: - VirtualGateway @@ -12769,12 +16770,23 @@ paths: application/json: schema: "$ref": "#/components/schemas/LinkVolumeRequest" + examples: + ex1: + value: + VolumeId: vol-12345678 + 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 description: The HTTP 200 response (OK). '400': content: @@ -12805,12 +16817,29 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadAccessKeysRequest" + examples: + ex1: + value: + Filters: + States: + - ACTIVE responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadAccessKeysResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + AccessKeys: + - 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 description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -12826,12 +16855,30 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadAccountsRequest" + examples: + ex1: + value: {} responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadAccountsResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Accounts: + - ZipCode: '92210' + CompanyName: EXAMPLE SAS + FirstName: JEAN + City: SAINT-CLOUD + Country: FRANCE + LastName: DUPONT + AccountId: '123456789012' + CustomerId: '87654321' + Email: example@example.com description: The HTTP 200 response (OK). tags: - Account @@ -12840,8 +16887,9 @@ paths: 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.

- **[NOTE]**
- The administrator password is generated only on the first boot of the Windows VM. It is not returned after the first boot. + **[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: operationId: ReadAdminPassword requestBody: @@ -12849,12 +16897,23 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadAdminPasswordRequest" + examples: + ex1: + value: + VmId: i-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadAdminPasswordResponse" + examples: + ex1: + value: + VmId: i-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + AdminPassword: "..." description: The HTTP 200 response (OK). '400': content: @@ -12877,7 +16936,9 @@ paths: tags: - Vm "/ReadApiAccessPolicy": - description: Gets information about the API access policy of your account. + 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: operationId: ReadApiAccessPolicy requestBody: @@ -12885,12 +16946,23 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadApiAccessPolicyRequest" + examples: + ex1: + value: {} responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadApiAccessPolicyResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ApiAccessPolicy: + RequireTrustedEnv: false + MaxAccessKeyExpirationSeconds: 0 description: The HTTP 200 response (OK). '400': content: @@ -12924,12 +16996,36 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadApiAccessRulesRequest" + examples: + ex1: + value: + Filters: + ApiAccessRuleIds: + - aar-1234567890abcdef1234567890abcdef responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadApiAccessRulesResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ApiAccessRules: + - IpRanges: + - 0.0.0.0/0 + ApiAccessRuleId: aar-1234567890abcdef1234567890abcdef + CaIds: [] + Cns: [] + Description: Allows all IPv4 domain + - IpRanges: + - 46.231.144.178/32 + ApiAccessRuleId: aar-abcdef1234567890abcdef1234567890 + CaIds: [] + Cns: [] + Description: Allows Outscale Cockpit of this region description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -12938,11 +17034,12 @@ paths: - ApiAccessRule "/ReadApiLogs": description: |- - Lists the logs of the API calls you have performed with this account. For more information, see [About OUTSCALE Monitoring Services (OMS)](https://docs.outscale.com/en/userguide/About-OUTSCALE-Monitoring-Services-(OMS).html).

+ Lists the logs of the API calls you have performed with this account. - **[NOTE]**
+ **[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. + 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 OUTSCALE Monitoring Services (OMS)](https://docs.outscale.com/en/userguide/About-OUTSCALE-Monitoring-Services-OMS.html). post: operationId: ReadApiLogs requestBody: @@ -12950,12 +17047,47 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadApiLogsRequest" + examples: + ex1: + value: + Filters: + QueryIpAddresses: + - 192.0.2.0 + - 198.51.100.0 + 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: + - 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' description: The HTTP 200 response (OK). tags: - ApiLog @@ -12969,12 +17101,27 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadCasRequest" + examples: + ex1: + value: + Filters: + CaIds: + - ca-fedcba0987654321fedcba0987654321 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadCasResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Cas: + - Description: CA example + CaId: ca-fedcba0987654321fedcba0987654321 + CaFingerprint: 1234567890abcdef1234567890abcdef12345678 description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -12982,8 +17129,7 @@ paths: tags: - Ca "/ReadCatalog": - description: Returns the price list of OUTSCALE products and services for the - current Region. + description: Returns the price list of OUTSCALE services for the current Region. post: operationId: ReadCatalog requestBody: @@ -12991,18 +17137,36 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadCatalogRequest" + examples: + ex1: + value: {} responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadCatalogResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Catalog: + 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 "/ReadCatalogs": - description: Returns the price list of OUTSCALE products and services for the - current Region within a specific time period. + description: Returns the price list of OUTSCALE services for the current Region + within a specific time period. post: operationId: ReadCatalogs requestBody: @@ -13010,21 +17174,41 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadCatalogsRequest" + examples: + ex1: + value: + Filters: + CurrentCatalogOnly: true + FromDate: '2021-01-01' + ToDate: '2023-01-01' responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadCatalogsResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + 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.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + description: Lists one or more of your client gateways. post: operationId: ReadClientGateways requestBody: @@ -13032,12 +17216,38 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadClientGatewaysRequest" + examples: + ex1: + value: + Filters: + ClientGatewayIds: + - cgw-12345678 + ex2: + value: + Filters: + BgpAsns: + - 65000 + PublicIps: + - 192.0.2.0 + - 198.51.100.0 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadClientGatewaysResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ClientGateways: + - State: available + BgpAsn: 65000 + Tags: [] + ClientGatewayId: cgw-12345678 + ConnectionType: ipsec.1 + PublicIp: 192.0.2.0 description: The HTTP 200 response (OK). tags: - ClientGateway @@ -13045,7 +17255,7 @@ paths: description: |- Gets the console output for a virtual machine (VM). This console provides the most recent 64 KiB output.

- **[NOTE]**
+ **[IMPORTANT]**
On Windows VMs, the console is handled only on the first boot. It returns no output after the first boot. post: operationId: ReadConsoleOutput @@ -13054,12 +17264,23 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadConsoleOutputRequest" + examples: + ex1: + value: + VmId: i-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadConsoleOutputResponse" + examples: + ex1: + value: + VmId: i-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ConsoleOutput: "..." description: The HTTP 200 response (OK). '400': content: @@ -13082,11 +17303,8 @@ paths: tags: - Vm "/ReadConsumptionAccount": - description: |- - Gets information about the consumption of your account for each billable resource within the specified time period.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `Throttling` error message is returned. + description: Gets information about the consumption of your account for each billable + resource within the specified time period. post: operationId: ReadConsumptionAccount requestBody: @@ -13094,21 +17312,109 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadConsumptionAccountRequest" + examples: + ex1: + value: + FromDate: '2023-06-01' + ToDate: '2023-07-01' responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadConsumptionAccountResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ConsumptionEntries: + - FromDate: 2023-06-01 00:00:00.000000000 +00:00 + SubregionName: eu-west-2a + Value: 720.0 + Title: Instance - On demand - tinav4.c2r4 high performance - + par heure + Category: compute + ToDate: 2023-06-30 00:00:00.000000000 +00:00 + Service: TinaOS-FCU + AccountId: '123456789012' + PayingAccountId: '123456789012' + Operation: RunInstances-OD + Type: BoxUsage:tinav4.c2r4p2 description: The HTTP 200 response (OK). tags: - Account - "/ReadDhcpOptions": + "/ReadDedicatedGroups": description: |- - Gets information about the content of one or more DHCP options sets.

+ > [WARNING]
+ > This feature is currently in beta.
- **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + List one or more dedicated groups of virtual machines (VMs). + post: + operationId: ReadDedicatedGroups + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/ReadDedicatedGroupsRequest" + examples: + ex1: + summary: Filtering on a specific dedicated group + value: + Filters: + DedicatedGroupIds: + - ded-12345678 + ex2: + summary: Filtering on a specific Subregion and CPU generation + value: + Filters: + SubregionNames: + - eu-west-2a + CpuGenerations: + - 4 + responses: + '200': + content: + application/json: + schema: + "$ref": "#/components/schemas/ReadDedicatedGroupsResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + DedicatedGroups: + - VmIds: + - i-12345678 + NetIds: [] + AccountId: '123456789012' + CpuGeneration: 4 + Name: dedicated-group-example + SubregionName: eu-west-2a + DedicatedGroupId: ded-12345678 + description: The HTTP 200 response (OK). + '400': + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + description: The HTTP 400 response (Bad Request). + '401': + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + description: The HTTP 401 response (Unauthorized). + '500': + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + description: The HTTP 500 response (Internal Server Error). + tags: + - DedicatedGroup + "/ReadDhcpOptions": + description: Gets information about the content of one or more DHCP options sets. post: operationId: ReadDhcpOptions requestBody: @@ -13116,21 +17422,47 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadDhcpOptionsRequest" + examples: + ex1: + value: + Filters: + DhcpOptionsSetIds: + - dopt-12345678 + ex2: + value: + Filters: + DomainNameServers: + - 192.0.2.0 + - 198.51.100.0 + DomainNames: + - example.com responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadDhcpOptionsResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + DhcpOptionsSets: + - 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 description: The HTTP 200 response (OK). tags: - DhcpOption "/ReadDirectLinkInterfaces": - description: |- - Lists one or more of your DirectLink interfaces.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `Throttling` error message is returned. + description: Lists one or more of your DirectLink interfaces. post: operationId: ReadDirectLinkInterfaces requestBody: @@ -13138,21 +17470,42 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadDirectLinkInterfacesRequest" + examples: + ex1: + value: + Filters: + DirectLinkInterfaceIds: + - dxvif-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadDirectLinkInterfacesResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + DirectLinkInterfaces: + - Vlan: 101 + OutscalePrivateIp: 172.16.0.4/30 + DirectLinkInterfaceId: dxvif-12345678 + BgpAsn: 65000 + AccountId: '123456789012' + ClientPrivateIp: 172.16.0.5/30 + VirtualGatewayId: vgw-12345678 + DirectLinkInterfaceName: MyDirectLinkInterface + DirectLinkId: dxcon-12345678 + Mtu: 1500 + State: available + InterfaceType: private + Location: PAR1 description: The HTTP 200 response (OK). tags: - DirectLinkInterface "/ReadDirectLinks": - description: |- - Lists all DirectLinks in the Region.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `Throttling` error message is returned. + description: Lists all DirectLinks in the Region. post: operationId: ReadDirectLinks requestBody: @@ -13160,21 +17513,36 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadDirectLinksRequest" + examples: + ex1: + value: + Filters: + DirectLinkIds: + - dxcon-12345678 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 + DirectLinkId: dxcon-12345678 + DirectLinkName: Connection to Outscale + Location: PAR1 + RegionName: eu-west-2 + State: available description: The HTTP 200 response (OK). tags: - DirectLink "/ReadFlexibleGpuCatalog": - description: |- - Lists all flexible GPUs available in the public catalog.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + description: Lists all flexible GPUs available in the public catalog. post: operationId: ReadFlexibleGpuCatalog requestBody: @@ -13182,22 +17550,33 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadFlexibleGpuCatalogRequest" + examples: + ex1: + value: {} responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadFlexibleGpuCatalogResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + FlexibleGpuCatalog: + - VRam: 16000 + Generations: + - v5 + MaxCpu: 80 + MaxRam: 512 + ModelName: nvidia-p100 description: The HTTP 200 response (OK). security: [] tags: - FlexibleGpu "/ReadFlexibleGpus": - description: |- - Lists one or more flexible GPUs (fGPUs) allocated to your account.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + description: Lists one or more flexible GPUs (fGPUs) allocated to your account. post: operationId: ReadFlexibleGpus requestBody: @@ -13205,21 +17584,44 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadFlexibleGpusRequest" + examples: + ex1: + value: + Filters: + FlexibleGpuIds: + - fgpu-12345678 + ex2: + value: + Filters: + ModelNames: + - nvidia-p6 + - nvidia-p100 + States: + - attached 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 + Generation: v5 + ModelName: nvidia-p100 + State: attached + SubregionName: eu-west-2a + VmId: i-12345678 description: The HTTP 200 response (OK). tags: - FlexibleGpu "/ReadImageExportTasks": - description: |- - Lists one or more image export tasks.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + description: Lists one or more image export tasks. post: operationId: ReadImageExportTasks requestBody: @@ -13227,21 +17629,39 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadImageExportTasksRequest" + examples: + ex1: + value: + Filters: + TaskIds: + - image-export-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadImageExportTasksResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ImageExportTasks: + - Tags: [] + ImageId: ami-12345678 + TaskId: image-export-12345678 + Comment: Export of image ami-12345678 + OsuExport: + OsuPrefix: PREFIX/ami-12345678/ + OsuBucket: BUCKET + DiskImageFormat: qcow2 + State: pending/queued + Progress: 0 description: The HTTP 200 response (OK). tags: - Image "/ReadImages": - description: |- - Lists one or more OUTSCALE machine images (OMIs) you can use.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + description: Lists one or more OUTSCALE machine images (OMIs) you can use. post: operationId: ReadImages requestBody: @@ -13249,12 +17669,118 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadImagesRequest" + examples: + ex1: + summary: Reading a specific image + value: + Filters: + ImageIds: + - ami-12345678 + ex2: + summary: Reading Ubuntu and RockyLinux images created by Outscale + value: + Filters: + AccountAliases: + - Outscale + ImageNames: + - Ubuntu* + - RockyLinux* 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: + - StateComment: {} + State: available + RootDeviceType: bsu + RootDeviceName: "/dev/sda1" + ProductCodes: + - '0001' + PermissionsToLaunch: + GlobalPermission: false + AccountIds: [] + AccountId: '123456789012' + Tags: [] + Description: '' + ImageId: ami-12345678 + BlockDeviceMappings: + - DeviceName: "/dev/sda1" + Bsu: + VolumeType: standard + DeleteOnVmDeletion: true + VolumeSize: 50 + SnapshotId: snap-12345678 + ImageType: machine + CreationDate: '2010-10-01T12:34:56.789Z' + 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: + - StateComment: {} + State: available + RootDeviceType: bsu + RootDeviceName: "/dev/sda1" + ProductCodes: + - '0001' + PermissionsToLaunch: + GlobalPermission: true + AccountIds: [] + AccountId: '123456789012' + Tags: [] + Description: '' + ImageId: ami-12345678 + BlockDeviceMappings: + - DeviceName: "/dev/sda1" + Bsu: + VolumeType: standard + DeleteOnVmDeletion: true + VolumeSize: 10 + SnapshotId: snap-12345678 + ImageType: machine + AccountAlias: Outscale + CreationDate: '2010-10-01T12:34:56.789Z' + FileLocation: Outscale/Ubuntu-2010.10.01-0 + Architecture: x86_64 + ImageName: Ubuntu-2010.10.01-0 + - StateComment: {} + State: available + RootDeviceType: bsu + RootDeviceName: "/dev/sda1" + ProductCodes: + - '0001' + PermissionsToLaunch: + GlobalPermission: true + AccountIds: [] + AccountId: '123456789012' + Tags: [] + Description: '' + ImageId: ami-12345678 + BlockDeviceMappings: + - DeviceName: "/dev/sda1" + Bsu: + VolumeType: standard + DeleteOnVmDeletion: true + VolumeSize: 10 + SnapshotId: snap-12345678 + ImageType: machine + AccountAlias: Outscale + CreationDate: '2010-10-01T12:34:56.789Z' + FileLocation: Outscale/RockyLinux-2010.10.01-0 + Architecture: x86_64 + ImageName: RockyLinux-2010.10.01-0 description: The HTTP 200 response (OK). '400': content: @@ -13279,10 +17805,7 @@ paths: "/ReadInternetServices": description: |- Lists one or more of your Internet services.
- An Internet service enables your virtual machines (VMs) launched in a Net to connect to the Internet. By default, a Net includes an Internet service, and each Subnet is public. Every VM launched within a default Subnet has a private IP and a public IP.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + An Internet service enables your virtual machines (VMs) launched in a Net to connect to the Internet. By default, a Net includes an Internet service, and each Subnet is public. Every VM launched within a default Subnet has a private IP and a public IP. post: operationId: ReadInternetServices requestBody: @@ -13290,12 +17813,38 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadInternetServicesRequest" + examples: + ex1: + value: + Filters: + InternetServiceIds: + - igw-12345678 + ex2: + value: + Filters: + TagKeys: + - env + TagValues: + - prod + - test responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadInternetServicesResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + InternetServices: + - Tags: + - Value: prod + Key: env + State: available + NetId: vpc-12345678 + InternetServiceId: igw-12345678 description: The HTTP 200 response (OK). '400': content: @@ -13318,11 +17867,7 @@ paths: tags: - InternetService "/ReadKeypairs": - description: |- - Lists one or more of your keypairs.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + description: Lists one or more of your keypairs. post: operationId: ReadKeypairs requestBody: @@ -13330,12 +17875,26 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadKeypairsRequest" + examples: + ex1: + value: + Filters: + KeypairNames: + - keypair-example responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadKeypairsResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Keypairs: + - KeypairName: keypair-example + 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: @@ -13357,6 +17916,47 @@ paths: description: The HTTP 500 response (Internal Server Error). tags: - Keypair + "/ReadLinkedPolicies": + description: Lists the managed policies linked to a specified user. + post: + operationId: ReadLinkedPolicies + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/ReadLinkedPoliciesRequest" + examples: + ex1: + value: + Filters: + PathPrefix: + - "/" + FirstItem: 1 + ResultsPerPage: 30 + UserName: example-user + responses: + '200': + content: + application/json: + schema: + "$ref": "#/components/schemas/ReadLinkedPoliciesResponse" + examples: + ex1: + value: + HasMoreItems: true + MaxResultsLimit: 30 + MaxResultsTruncated: false + Policies: + CreationDate: '2010-10-01T12:34:56.789Z' + LastModificationDate: '2010-10-01T12:34:56.789Z' + Orn: orn:ows:idauth::012345678910:user-policy/Policy + PolicyId: policy-12345678 + PolicyName: example-user-policy + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + 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. @@ -13367,21 +17967,37 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadListenerRulesRequest" + examples: + ex1: + value: + Filters: + ListenerRuleNames: + - example-listener-rule responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadListenerRulesResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ListenerRules: + - Priority: 10 + VmIds: + - i-12345678 + 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.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `Throttling` error message is returned. + description: Lists the tags associated with one or more specified load balancers. post: operationId: ReadLoadBalancerTags requestBody: @@ -13389,21 +18005,31 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadLoadBalancerTagsRequest" + examples: + ex1: + value: + LoadBalancerNames: + - private-lb-example responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadLoadBalancerTagsResponse" + examples: + ex1: + value: + Tags: + - Value: value1 + LoadBalancerName: private-lb-example + 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.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + description: Lists one or more load balancers and their attributes. post: operationId: ReadLoadBalancers requestBody: @@ -13411,21 +18037,66 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadLoadBalancersRequest" + examples: + ex1: + value: + Filters: + LoadBalancerNames: + - private* responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadLoadBalancersResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + LoadBalancers: + - 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 + LoadBalancerStickyCookiePolicies: [] + SubregionNames: + - eu-west-2a + Listeners: + - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate + BackendPort: 80 + BackendProtocol: HTTP + LoadBalancerPort: 443 + LoadBalancerProtocol: HTTPS + LoadBalancerName: private-lb-example description: The HTTP 200 response (OK). tags: - LoadBalancer "/ReadLocations": description: |- Lists the locations, corresponding to datacenters, where you can set up a DirectLink.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `Throttling` error message is returned. + For more information, see [About DirectLink](https://docs.outscale.com/en/userguide/About-DirectLink.html). post: operationId: ReadLocations requestBody: @@ -13433,22 +18104,31 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadLocationsRequest" + examples: + ex1: + value: {} responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadLocationsResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Locations: + - Name: Telehouse 3, France + Code: PAR1 + - Name: Equinix Pantin, France + Code: PAR4 description: The HTTP 200 response (OK). security: [] tags: - Location "/ReadNatServices": - description: |- - Lists one or more network address translation (NAT) services.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + description: Lists one or more network address translation (NAT) services. post: operationId: ReadNatServices requestBody: @@ -13456,12 +18136,40 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadNatServicesRequest" + examples: + ex1: + value: + Filters: + NatServiceIds: + - nat-12345678 + ex2: + value: + Filters: + NetIds: + - vpc-12345678 + - vpc-87654321 + SubnetIds: + - subnet-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadNatServicesResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + NatServices: + - Tags: [] + SubnetId: subnet-12345678 + NatServiceId: nat-12345678 + PublicIps: + - PublicIpId: eipalloc-12345678 + PublicIp: 192.0.2.0 + NetId: vpc-12345678 + State: available description: The HTTP 200 response (OK). '400': content: @@ -13486,10 +18194,7 @@ paths: "/ReadNetAccessPointServices": description: |- Lists OUTSCALE services available to create Net access points.
- For more information, see [CreateNetAccessPoint](#createnetaccesspoint).

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + For more information, see [CreateNetAccessPoint](#createnetaccesspoint). post: operationId: ReadNetAccessPointServices requestBody: @@ -13497,22 +18202,61 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadNetAccessPointServicesRequest" + examples: + ex1: + summary: Listing one or more services according to their service IDs + value: + Filters: + ServiceIds: + - pl-12345678 + - pl-87654321 + ex2: + summary: Listing one or more services according to their service names + value: + Filters: + ServiceNames: + - com.outscale.eu-west-2.api responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadNetAccessPointServicesResponse" + examples: + ex1: + summary: Listing one or more services according to their service + IDs + value: + Services: + - ServiceName: com.outscale.eu-west-2.api + ServiceId: pl-12345678 + 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 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + summary: Listing one or more services according to their service + names + value: + Services: + - ServiceName: com.outscale.eu-west-2.api + ServiceId: pl-12345678 + 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.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + description: Lists one or more Net access points. post: operationId: ReadNetAccessPoints requestBody: @@ -13520,21 +18264,43 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadNetAccessPointsRequest" + examples: + ex1: + value: + Filters: + NetAccessPointIds: + - vpce-12345678 + ex2: + value: + Filters: + NetIds: + - vpc-12345678 + States: + - available responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadNetAccessPointsResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + NetAccessPoints: + - Tags: [] + NetAccessPointId: vpce-12345678 + RouteTableIds: + - rtb-12345678 + State: available + 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.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + description: Lists one or more peering connections between two Nets. post: operationId: ReadNetPeerings requestBody: @@ -13542,12 +18308,45 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadNetPeeringsRequest" + examples: + ex1: + value: + Filters: + NetPeeringIds: + - pcx-12345678 + ex2: + value: + Filters: + SourceNetNetIds: + - vpc-12345678 + StateNames: + - active + - pending-acceptance responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadNetPeeringsResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + NetPeerings: + - Tags: [] + SourceNet: + NetId: vpc-12345678 + IpRange: 10.0.0.0/16 + AccountId: '123456789012' + NetPeeringId: pcx-12345678 + AccepterNet: + NetId: vpc-12345678 + IpRange: 172.16.0.0/16 + AccountId: '123456789012' + State: + Name: active + Message: Active description: The HTTP 200 response (OK). '400': content: @@ -13570,11 +18369,7 @@ paths: tags: - NetPeering "/ReadNets": - description: |- - Lists one or more Nets.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + description: Lists one or more Nets. post: operationId: ReadNets requestBody: @@ -13582,12 +18377,35 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadNetsRequest" + examples: + ex1: + value: + Filters: + NetIds: + - vpc-12345678 + ex2: + value: + Filters: + States: + - available responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadNetsResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Nets: + - Tags: [] + DhcpOptionsSetId: dopt-12345678 + IpRange: 10.0.0.0/16 + Tenancy: default + NetId: vpc-12345678 + State: available description: The HTTP 200 response (OK). '400': content: @@ -13612,10 +18430,7 @@ paths: "/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.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + A NIC is a virtual network interface that you can attach to a virtual machine (VM) in a Net. post: operationId: ReadNics requestBody: @@ -13623,12 +18438,54 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadNicsRequest" + examples: + ex1: + value: + Filters: + NicIds: + - eni-12345678 + ex2: + value: + Filters: + LinkNicVmIds: + - i-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadNicsResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Nics: + - SubregionName: eu-west-2a + SubnetId: subnet-12345678 + State: in-use + LinkNic: + VmId: i-12345678 + LinkNicId: eni-attach-12345678 + VmAccountId: '123456789012' + DeleteOnVmDeletion: false + DeviceNumber: 0 + State: attached + 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 + PrivateIps: + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + PrivateIp: 10.0.0.4 + IsPrimary: true description: The HTTP 200 response (OK). '400': content: @@ -13650,12 +18507,167 @@ paths: description: The HTTP 500 response (Internal Server Error). tags: - Nic + "/ReadPolicies": + description: Lists all the managed policies available for your account. + post: + operationId: ReadPolicies + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/ReadPoliciesRequest" + examples: + ex1: + value: + Filters: + OnlyLinked: + - true + PathPrefix: + - "/" + Scope: + - ALL + FirstItem: 1 + ResultsPerPage: 30 + responses: + '200': + content: + application/json: + schema: + "$ref": "#/components/schemas/ReadPoliciesResponse" + examples: + ex1: + value: + HasMoreItems: true + MaxResultsLimit: 30 + MaxResultsTruncated: false + Policies: + CreationDate: '2010-10-01T12:34:56.789Z' + Description: Example of description + IsLinkable: true + LastModificationDate: '2010-10-01T12:34:56.789Z' + Orn: orn:ows:idauth::012345678910:user-policy/Policy + Path: "/example/" + PolicyDefaultVersionId: version-12345678 + PolicyId: policy-12345678 + PolicyName: example-user-policy + ResourcesCount: 0 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + description: The HTTP 200 response (OK). + tags: + - Policy + "/ReadPolicy": + description: Lists information about a specified managed policy. + post: + operationId: ReadPolicy + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/ReadPolicyRequest" + examples: + ex1: + value: + PolicyOrn: orn:ows:idauth::012345678910:user-policy/Policy + responses: + '200': + content: + application/json: + schema: + "$ref": "#/components/schemas/ReadPolicyResponse" + examples: + ex1: + value: + Policy: + CreationDate: '2010-10-01T12:34:56.789Z' + Description: Example of description + IsLinkable: true + LastModificationDate: '2010-10-01T12:34:56.789Z' + Orn: orn:ows:idauth::012345678910:user-policy/Policy + Path: "/example/" + PolicyDefaultVersionId: version-12345678 + PolicyId: policy-12345678 + PolicyName: example-user-policy + ResourcesCount: 0 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + description: The HTTP 200 response (OK). + tags: + - Policy + "/ReadPolicyVersion": + description: Lists information about a specified version of a managed policy. + post: + operationId: ReadPolicyVersion + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/ReadPolicyVersionRequest" + examples: + ex1: + value: + PolicyOrn: orn:ows:idauth::012345678910:user-policy/Policy + VersionId: version-12345678 + responses: + '200': + content: + application/json: + schema: + "$ref": "#/components/schemas/ReadPolicyVersionResponse" + examples: + ex1: + value: + PolicyVersion: + Body: '{"Statement": [ {"Action": ["*"],"Effect","Allow","Resource": + ["*"]} ]}' + CreationDate: '2010-10-01T12:34:56.789Z' + DefaultVersion: true + VersionId: version-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + description: The HTTP 200 response (OK). + tags: + - Policy + "/ReadPolicyVersions": + description: Lists information about all the policy versions of a specified managed + policy. + post: + operationId: ReadPolicyVersions + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/ReadPolicyVersionsRequest" + examples: + ex1: + value: + FirstItem: 1 + PolicyOrn: orn:ows:idauth::012345678910:user-policy/Policy + ResultsPerPage: 30 + responses: + '200': + content: + application/json: + schema: + "$ref": "#/components/schemas/ReadPolicyVersionsResponse" + examples: + ex1: + value: + HasMoreItems: true + MaxResultsLimit: 30 + PolicyVersions: + Body: '{"Statement": [ {"Action": ["*"],"Effect","Allow","Resource": + ["*"]} ]}' + CreationDate: '2010-10-01T12:34:56.789Z' + DefaultVersion: true + VersionId: version-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + description: The HTTP 200 response (OK). + tags: + - Policy "/ReadProductTypes": - description: |- - Lists one or more product types.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + description: Lists one or more product types. post: operationId: ReadProductTypes requestBody: @@ -13663,12 +18675,26 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadProductTypesRequest" + examples: + ex1: + value: + Filters: + ProductTypeIds: + - '0001' responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadProductTypesResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ProductTypes: + - ProductTypeId: '0001' + Description: Linux description: The HTTP 200 response (OK). security: [] tags: @@ -13676,7 +18702,7 @@ paths: "/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 [Regions, - Endpoints and Availability Zones Reference](https://docs.outscale.com/en/userguide/Regions-Endpoints-and-Availability-Zones-Reference.html). + Endpoints, and Subregions Reference](https://docs.outscale.com/en/userguide/Regions-Endpoints-and-Subregions-Reference.html). post: operationId: ReadPublicCatalog requestBody: @@ -13684,20 +18710,38 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadPublicCatalogRequest" + examples: + ex1: + value: {} responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadPublicCatalogResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Catalog: + 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). 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 [Regions, Endpoints - and Availability Zones Reference](https://docs.outscale.com/en/userguide/Regions-Endpoints-and-Availability-Zones-Reference.html). + in the endpoint of the request. For more information, see [Regions, Endpoints, + and Subregions Reference](https://docs.outscale.com/en/userguide/Regions-Endpoints-and-Subregions-Reference.html). post: operationId: ReadPublicIpRanges requestBody: @@ -13705,12 +18749,23 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadPublicIpRangesRequest" + examples: + ex1: + value: {} 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 description: The HTTP 200 response (OK). security: [] tags: @@ -13718,10 +18773,7 @@ paths: "/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.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + 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: operationId: ReadPublicIps requestBody: @@ -13729,12 +18781,37 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadPublicIpsRequest" + examples: + ex1: + value: + Filters: + PublicIps: + - 192.0.2.0 + ex2: + value: + Filters: + VmIds: + - i-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadPublicIpsResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + PublicIps: + - 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 description: The HTTP 200 response (OK). '400': content: @@ -13759,9 +18836,7 @@ paths: "/ReadQuotas": description: |- Lists one or more of your quotas.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + For more information, see [About Your Account](https://docs.outscale.com/en/userguide/About-Your-Account.html). post: operationId: ReadQuotas requestBody: @@ -13769,17 +18844,72 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadQuotasRequest" + examples: + ex1: + summary: Reading specific quota + value: + Filters: + QuotaNames: + - lb_limit + ex2: + summary: Reading collection of quotas + value: + Filters: + Collections: + - VPC 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: + - Quotas: + - ShortDescription: Load Balancer Limit + QuotaCollection: LBU + AccountId: '123456789012' + Description: Maximum number of load balancers per region + MaxValue: 20 + UsedValue: 0 + Name: lb_limit + QuotaType: global + ex2: + summary: Reading collection of quotas + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + QuotaTypes: + - 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 + AccountId: '123456789012' + Description: Maximum number of other examples + MaxValue: 50 + UsedValue: 1 + 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. + description: |- + Lists one or more Regions of the OUTSCALE Cloud.

+ For more information, see [About Regions, Endpoints, and Subregions](https://docs.outscale.com/en/userguide/About-Regions-Endpoints-and-Subregions.html). post: operationId: ReadRegions requestBody: @@ -13787,12 +18917,27 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadRegionsRequest" + examples: + ex1: + value: {} responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadRegionsResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + 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: @@ -13800,10 +18945,7 @@ paths: "/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.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + 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: operationId: ReadRouteTables requestBody: @@ -13811,12 +18953,43 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadRouteTablesRequest" + examples: + ex1: + value: + Filters: + RouteTableIds: + - rtb-12345678 + ex2: + value: + Filters: + NetIds: + - vpc-12345678 + - vpc-87654321 + LinkRouteTableMain: true responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadRouteTablesResponse" + examples: + ex1: + value: + RouteTables: + - Routes: + - DestinationIpRange: 10.0.0.0/16 + CreationMethod: CreateRouteTable + State: active + LinkRouteTables: + - RouteTableId: rtb-12345678 + Main: true + LinkRouteTableId: rtbassoc-12345678 + NetId: vpc-12345678 + Tags: [] + RoutePropagatingVirtualGateways: [] + RouteTableId: rtb-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -13848,12 +19021,28 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadSecretAccessKeyRequest" + examples: + ex1: + value: + AccessKeyId: ABCDEFGHIJ0123456789 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadSecretAccessKeyResponse" + 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 + SecretKey: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + LastModificationDate: 2010-10-01 12:34:56.789000000 +00:00 description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -13863,10 +19052,7 @@ paths: "/ReadSecurityGroups": description: |- Lists one or more security groups.
- You can specify either the name of the security groups or their IDs.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + You can specify either the name of the security groups or their IDs. post: operationId: ReadSecurityGroups requestBody: @@ -13874,12 +19060,48 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadSecurityGroupsRequest" + examples: + ex1: + value: + Filters: + SecurityGroupIds: + - sg-12345678 + ex2: + value: + Filters: + InboundRuleIpRanges: + - 192.0.2.0 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadSecurityGroupsResponse" + examples: + ex1: + value: + SecurityGroups: + - 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 + NetId: vpc-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -13910,21 +19132,33 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadServerCertificatesRequest" + examples: + ex1: + value: + Filters: + Paths: + - "/example/" responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadServerCertificatesResponse" + examples: + ex1: + value: + ServerCertificates: + - Path: "/example/" + Id: ABCDEFGHIJKLMNOPQRSTUVWXYZ1234 + Orn: orn:ows:idauth::012345678910:server-certificate/example/server-cert-example + 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.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + description: Lists one or more snapshot export tasks. post: operationId: ReadSnapshotExportTasks requestBody: @@ -13932,21 +19166,40 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadSnapshotExportTasksRequest" + examples: + ex1: + value: + Filters: + TaskIds: + - snap-export-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadSnapshotExportTasksResponse" + examples: + ex1: + value: + SnapshotExportTasks: + - Tags: [] + TaskId: snap-export-12345678 + Comment: Export of snapshot snap-12345678 + OsuExport: + OsuPrefix: PREFIX + OsuBucket: BUCKET + DiskImageFormat: qcow2 + State: pending + 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.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + description: Lists one or more snapshots that are available to you and the permissions + to create volumes from them. post: operationId: ReadSnapshots requestBody: @@ -13954,12 +19207,63 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadSnapshotsRequest" + examples: + ex1: + value: + Filters: + SnapshotIds: + - snap-12345678 + ex2: + value: + Filters: + TagKeys: + - env + TagValues: + - prod + - test responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadSnapshotsResponse" + examples: + ex1: + value: + Snapshots: + - VolumeSize: 10 + AccountId: '123456789012' + VolumeId: vol-12345678 + CreationDate: '2010-10-01T12:34:56.789Z' + PermissionsToCreateVolume: + GlobalPermission: false + AccountIds: [] + Progress: 100 + SnapshotId: snap-12345678 + State: completed + Description: Snapshot created from a volume + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + value: + Snapshots: + - VolumeSize: 10 + AccountId: '123456789012' + VolumeId: vol-12345678 + CreationDate: '2010-10-01T12:34:56.789Z' + PermissionsToCreateVolume: + GlobalPermission: false + AccountIds: [] + Progress: 100 + SnapshotId: snap-12345678 + State: completed + Description: Test snapshot + Tags: + - Value: test + Key: env + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -13984,10 +19288,7 @@ paths: "/ReadSubnets": description: |- Lists one or more of your Subnets.
- If you do not specify any Subnet ID, this action describes all of your Subnets.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + If you do not specify any Subnet ID, this action describes all of your Subnets. post: operationId: ReadSubnets requestBody: @@ -13995,12 +19296,40 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadSubnetsRequest" + examples: + ex1: + value: + Filters: + NetIds: + - vpc-12345678 + ex2: + value: + Filters: + States: + - available + - pending + SubregionNames: + - eu-west-2a responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadSubnetsResponse" + examples: + ex1: + value: + Subnets: + - Tags: [] + SubregionName: eu-west-2a + SubnetId: subnet-12345678 + AvailableIpsCount: 16379 + IpRange: 10.0.0.0/18 + MapPublicIpOnLaunch: false + State: available + NetId: vpc-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -14026,9 +19355,7 @@ paths: description: |- Lists one or more of the enabled Subregions that you can access in the current Region.

- **[NOTE]**
- - If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned.
- - You can use this command to get information about Subregions only in a Region for which you have an account. Otherwise, the `AuthFailure` error message is returned. + For more information, see [About Regions, Endpoints, and Subregions](https://docs.outscale.com/en/userguide/About-Regions-Endpoints-and-Subregions.html). post: operationId: ReadSubregions requestBody: @@ -14036,21 +19363,56 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadSubregionsRequest" + examples: + ex1: + summary: Listing a specific Subregion in the current Region + value: + Filters: + SubregionNames: + - eu-west-2a + ex2: + summary: Listing two specific Subregions in the current Region + value: + Filters: + SubregionNames: + - eu-west-2a + - eu-west-2b responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadSubregionsResponse" + examples: + ex1: + summary: Listing a specific Subregion in the current Region + value: + Subregions: + - State: available + RegionName: eu-west-2 + SubregionName: eu-west-2a + LocationCode: PAR1 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + summary: Listing two specific Subregions in the current Region + value: + Subregions: + - State: available + RegionName: eu-west-2 + SubregionName: eu-west-2a + LocationCode: PAR1 + - State: available + RegionName: eu-west-2 + SubregionName: eu-west-2b + 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.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + description: Lists one or more tags for your resources. post: operationId: ReadTags requestBody: @@ -14058,12 +19420,30 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadTagsRequest" + examples: + ex1: + value: + Filters: + ResourceTypes: + - snapshot + Keys: + - key1 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadTagsResponse" + examples: + ex1: + value: + Tags: + - Value: value1 + ResourceType: snapshot + ResourceId: snap-12345678 + Key: key1 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -14086,7 +19466,9 @@ paths: tags: - Tag "/ReadUsers": - description: Lists all EIM users that have a specified path.
+ description: |- + Lists all EIM users that have a specified path.
+ If you do not specify a path, this action returns a list of all users in the account (or an empty list if there are none). post: operationId: ReadUsers requestBody: @@ -14094,21 +19476,29 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadUsersRequest" + examples: + ex1: + value: {} responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadUsersResponse" + examples: + ex1: + value: + Users: + - UserName: example-user + 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.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + description: Lists one or more virtual gateways. post: operationId: ReadVirtualGateways requestBody: @@ -14116,12 +19506,49 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadVirtualGatewaysRequest" + examples: + ex1: + value: + Filters: + VirtualGatewayIds: + - vgw-12345678 + ex2: + value: + Filters: + States: + - available + LinkStates: + - attached + - detached responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadVirtualGatewaysResponse" + examples: + ex1: + value: + VirtualGateways: + - VirtualGatewayId: vgw-12345678 + ConnectionType: ipsec.1 + NetToVirtualGatewayLinks: [] + State: available + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + value: + VirtualGateways: + - VirtualGatewayId: vgw-12345678 + ConnectionType: ipsec.1 + NetToVirtualGatewayLinks: + - State: attached + NetId: vpc-12345678 + State: available + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - VirtualGateway @@ -14138,12 +19565,36 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadVmGroupsRequest" + examples: + ex1: + value: + Filters: + VmGroupIds: + - vmgroup-12345678901234567890123456789012 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadVmGroupsResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + VmGroups: + SecurityGroupsIds: sg-87654321 + VmIds: i-12345678 + 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: @@ -14178,21 +19629,44 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadVmTemplatesRequest" + examples: + ex1: + value: + Filters: + VmTemplateNames: + - vmtemplate-example + ex2: + value: + Filters: + CpuCores: + - 2 + CpuGeneration: + - v4 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadVmTemplatesResponse" + examples: + ex1: + value: + VmTemplates: + VmTemplateName: vmtemplate-example + CpuPerformance: high + CreationDate: 2010-10-01 12:34:56.789000000 +00:00 + CpuCores: 2 + Tags: [] + Description: '' + ImageId: ami-12345678 + CpuGeneration: v4 + VmTemplateId: vmtemplate-98765432109876543210987654321012 + Ram: 2 description: The HTTP 200 response (OK). tags: - VmTemplate "/ReadVmTypes": - description: |- - Lists one or more predefined VM types.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + description: Lists one or more predefined VM types. post: operationId: ReadVmTypes requestBody: @@ -14200,12 +19674,30 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadVmTypesRequest" + examples: + ex1: + value: + Filters: + VmTypeNames: + - t2.small responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadVmTypesResponse" + examples: + ex1: + value: + VmTypes: + - VolumeCount: 0 + VmTypeName: t2.small + BsuOptimized: false + MaxPrivateIps: 4 + MemorySize: 2.0 + VcoreCount: 1 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). security: [] tags: @@ -14213,10 +19705,7 @@ paths: "/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.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + 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: operationId: ReadVms requestBody: @@ -14224,12 +19713,96 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadVmsRequest" + examples: + ex1: + value: + Filters: + VmIds: + - i-12345678 + ex2: + value: + Filters: + TagKeys: + - env + TagValues: + - prod + - test responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadVmsResponse" + examples: + ex1: + value: + Vms: + - VmType: tinav5.c1r1p2 + VmInitiatedShutdownBehavior: stop + State: running + StateReason: '' + RootDeviceType: ebs + RootDeviceName: "/dev/sda1" + IsSourceDestChecked: true + KeypairName: keypair-example + ImageId: ami-12345678 + DeletionProtection: false + Architecture: x86_64 + NestedVirtualization: false + BlockDeviceMappings: + - DeviceName: "/dev/sda1" + Bsu: + VolumeId: vol-12345678 + 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 + NetId: vpc-12345678 + Nics: + - SubnetId: subnet-12345678 + State: in-use + LinkNic: + State: attached + DeviceNumber: 0 + LinkNicId: eni-attach-12345678 + 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 + PrivateIps: + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + PrivateIp: 10.0.0.4 + IsPrimary: true + Performance: high + Tags: + - Value: prod + Key: env + 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: @@ -14252,11 +19825,8 @@ paths: tags: - Vm "/ReadVmsHealth": - description: |- - Lists the state of one or more back-end virtual machines (VMs) registered with a specified load balancer.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `Throttling` error message is returned. + description: Lists the state of one or more back-end virtual machines (VMs) registered + with a specified load balancer. post: operationId: ReadVmsHealth requestBody: @@ -14264,21 +19834,36 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadVmsHealthRequest" + examples: + ex1: + value: + LoadBalancerName: example-lbu + BackendVmIds: + - i-12345678 + - i-87654321 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadVmsHealthResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + 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).

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + description: Lists the status of one or more virtual machines (VMs). post: operationId: ReadVmsState requestBody: @@ -14286,12 +19871,44 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadVmsStateRequest" + examples: + ex1: + value: + AllVms: true + ex2: + value: + Filters: + SubregionNames: + - eu-west-2a responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadVmsStateResponse" + examples: + ex1: + value: + VmStates: + - VmId: i-12345678 + VmState: running + SubregionName: eu-west-2a + MaintenanceEvents: [] + - VmId: i-87654321 + VmState: stopped + SubregionName: eu-west-2a + MaintenanceEvents: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + value: + VmStates: + - VmId: i-12345678 + VmState: running + SubregionName: eu-west-2a + MaintenanceEvents: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -14314,11 +19931,7 @@ paths: tags: - Vm "/ReadVolumes": - description: |- - Lists one or more specified Block Storage Unit (BSU) volumes.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + description: Lists one or more specified Block Storage Unit (BSU) volumes. post: operationId: ReadVolumes requestBody: @@ -14326,12 +19939,46 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadVolumesRequest" + examples: + ex1: + value: + Filters: + VolumeIds: + - vol-12345678 + ex2: + value: + Filters: + VolumeStates: + - in-use + VolumeTypes: + - gp2 + - io1 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadVolumesResponse" + examples: + ex1: + value: + Volumes: + - VolumeId: vol-12345678 + Tags: [] + VolumeType: gp2 + SubregionName: eu-west-2a + State: in-use + CreationDate: '2010-10-01T12:34:56.789Z' + Iops: 100 + LinkedVolumes: + - VolumeId: vol-12345678 + DeleteOnVmDeletion: false + DeviceName: "/dev/sdb" + State: attached + VmId: i-12345678 + Size: 10 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -14354,11 +20001,7 @@ paths: tags: - Volume "/ReadVpnConnections": - description: |- - Lists one or more VPN connections.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + description: Lists one or more VPN connections. post: operationId: ReadVpnConnections requestBody: @@ -14366,12 +20009,46 @@ paths: application/json: schema: "$ref": "#/components/schemas/ReadVpnConnectionsRequest" + examples: + ex1: + value: + Filters: + VpnConnectionIds: + - vpn-12345678 + ex2: + value: + Filters: + ClientGatewayIds: + - cgw-12345678 + VirtualGatewayIds: + - vgw-12345678 + - vgw-87654321 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ReadVpnConnectionsResponse" + examples: + ex1: + value: + VpnConnections: + - Routes: [] + Tags: [] + ClientGatewayConfiguration: "..." + StaticRoutesOnly: true + VirtualGatewayId: vgw-12345678 + ConnectionType: ipsec.1 + ClientGatewayId: cgw-12345678 + State: pending + VgwTelemetries: + - StateDescription: IPSEC IS DOWN + AcceptedRouteCount: 0 + LastStateChangeDate: '2017-05-10T12:34:56.789Z' + OutsideIpAddress: 192.0.2.0 + VpnConnectionId: vpn-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - VpnConnection @@ -14386,12 +20063,22 @@ paths: application/json: schema: "$ref": "#/components/schemas/RebootVmsRequest" + examples: + ex1: + value: + VmIds: + - i-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/RebootVmsResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -14424,12 +20111,24 @@ paths: application/json: schema: "$ref": "#/components/schemas/RegisterVmsInLoadBalancerRequest" + examples: + ex1: + value: + LoadBalancerName: example-lbu + BackendVmIds: + - i-12345678 + - i-87654321 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/RegisterVmsInLoadBalancerResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - LoadBalancer @@ -14444,12 +20143,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/RejectNetPeeringRequest" + examples: + ex1: + value: + NetPeeringId: pcx-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/RejectNetPeeringResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -14477,30 +20185,6 @@ paths: description: The HTTP 500 response (Internal Server Error). tags: - NetPeering - "/ResetAccountPassword": - description: |- - Replaces the account password with the new one you provide.
- You must also provide the token you received by email when asking for a password reset using the SendResetPasswordEmail method.

- Password strength is tested through heuristic algorithms. For more information, see the [zxcvbn GitHub](https://github.com/dropbox/zxcvbn).

- **[NOTE]**
- To protect against brute force attacks, the number of requests allowed for this method in a given time period is limited. - post: - operationId: ResetAccountPassword - requestBody: - content: - application/json: - schema: - "$ref": "#/components/schemas/ResetAccountPasswordRequest" - responses: - '200': - content: - application/json: - schema: - "$ref": "#/components/schemas/ResetAccountPasswordResponse" - description: The HTTP 200 response (OK). - security: [] - tags: - - Account "/ScaleDownVmGroup": description: |- > [WARNING]
@@ -14515,12 +20199,23 @@ paths: application/json: schema: "$ref": "#/components/schemas/ScaleDownVmGroupRequest" + examples: + ex1: + summary: Removing 1 VM from a VM group + value: + VmGroupId: vmgroup-12345678901234567890123456789012 + VmSubtraction: 1 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ScaleDownVmGroupResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -14556,12 +20251,23 @@ paths: application/json: schema: "$ref": "#/components/schemas/ScaleUpVmGroupRequest" + examples: + ex1: + summary: Adding 2 VMs in a VM group + value: + VmGroupId: vmgroup-12345678901234567890123456789012 + VmAddition: 2 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/ScaleUpVmGroupResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -14583,29 +20289,36 @@ paths: description: The HTTP 500 response (Internal Server Error). tags: - VmGroup - "/SendResetPasswordEmail": + "/SetDefaultPolicyVersion": description: |- - Sends an email to the email address provided for the account with a token to reset your password.
- You need to provide this token when updating the account password using the ResetAccountPassword method.

- **[NOTE]**
- To protect against brute force attacks, the number of requests allowed for this method in a given time period is limited. + 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: - operationId: SendResetPasswordEmail + operationId: SetDefaultPolicyVersion requestBody: content: application/json: schema: - "$ref": "#/components/schemas/SendResetPasswordEmailRequest" + "$ref": "#/components/schemas/SetDefaultPolicyVersionRequest" + examples: + ex1: + value: + PolicyOrn: orn:ows:idauth::012345678910:user-policy/Policy + VersionId: version-12345678 responses: '200': content: application/json: schema: - "$ref": "#/components/schemas/SendResetPasswordEmailResponse" + "$ref": "#/components/schemas/SetDefaultPolicyVersionResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). - security: [] tags: - - Account + - Policy "/StartVms": description: |- Start one or more virtual machines (VMs).
@@ -14617,12 +20330,26 @@ paths: application/json: schema: "$ref": "#/components/schemas/StartVmsRequest" + examples: + ex1: + value: + VmIds: + - i-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/StartVmsResponse" + examples: + ex1: + value: + Vms: + - VmId: i-12345678 + PreviousState: stopped + CurrentState: pending + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -14655,12 +20382,26 @@ paths: application/json: schema: "$ref": "#/components/schemas/StopVmsRequest" + examples: + ex1: + value: + VmIds: + - i-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/StopVmsResponse" + examples: + ex1: + value: + Vms: + - VmId: i-12345678 + PreviousState: running + CurrentState: stopping + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -14693,12 +20434,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/UnlinkFlexibleGpuRequest" + examples: + ex1: + value: + FlexibleGpuId: fgpu-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/UnlinkFlexibleGpuResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - FlexibleGpu @@ -14713,12 +20463,22 @@ paths: application/json: schema: "$ref": "#/components/schemas/UnlinkInternetServiceRequest" + examples: + ex1: + value: + InternetServiceId: igw-12345678 + NetId: vpc-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/UnlinkInternetServiceResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -14751,12 +20511,38 @@ paths: 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 + ex2: + summary: Unlinking public IPs from a load balancer + value: + LoadBalancerName: example-lbu + BackendIps: + - 192.0.2.0 + - 198.51.100.0 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/UnlinkLoadBalancerBackendMachinesResponse" + examples: + ex1: + summary: Unlinking VMs from a load balancer + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + summary: Unlinking public IPs from a load balancer + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - LoadBalancer @@ -14771,12 +20557,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/UnlinkNicRequest" + examples: + ex1: + value: + LinkNicId: eni-attach-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/UnlinkNicResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -14798,6 +20593,34 @@ paths: description: The HTTP 500 response (Internal Server Error). tags: - Nic + "/UnlinkPolicy": + description: Removes a managed policy from a specific user. + post: + operationId: UnlinkPolicy + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/UnlinkPolicyRequest" + examples: + ex1: + value: + PolicyOrn: orn:ows:idauth::012345678910:user-policy/Policy + UserName: example-user + responses: + '200': + content: + application/json: + schema: + "$ref": "#/components/schemas/UnlinkPolicyResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + description: The HTTP 200 response (OK). + tags: + - Policy "/UnlinkPrivateIps": description: Unassigns one or more secondary private IPs from a network interface card (NIC). @@ -14808,12 +20631,24 @@ paths: application/json: schema: "$ref": "#/components/schemas/UnlinkPrivateIpsRequest" + examples: + ex1: + value: + NicId: eni-12345678 + PrivateIps: + - 10.0.0.6 + - 10.0.0.7 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/UnlinkPrivateIpsResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -14839,7 +20674,7 @@ paths: description: |- Disassociates a public IP from the virtual machine (VM) or network interface card (NIC) it is associated with.

- **[NOTE]**
+ **[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: operationId: UnlinkPublicIp @@ -14848,12 +20683,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/UnlinkPublicIpRequest" + examples: + ex1: + value: + PublicIp: 192.0.2.0 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/UnlinkPublicIpResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -14886,12 +20730,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/UnlinkRouteTableRequest" + examples: + ex1: + value: + LinkRouteTableId: rtbassoc-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/UnlinkRouteTableResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -14924,12 +20777,22 @@ paths: application/json: schema: "$ref": "#/components/schemas/UnlinkVirtualGatewayRequest" + examples: + ex1: + value: + VirtualGatewayId: vgw-12345678 + NetId: vpc-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/UnlinkVirtualGatewayResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - VirtualGateway @@ -14944,12 +20807,21 @@ paths: application/json: schema: "$ref": "#/components/schemas/UnlinkVolumeRequest" + examples: + ex1: + value: + VolumeId: vol-12345678 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/UnlinkVolumeResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -14972,11 +20844,8 @@ paths: tags: - Volume "/UpdateAccessKey": - description: |- - Modifies the attributes of the specified access key of either your root account or an EIM user.

- - **[NOTE]**
- To protect against brute force attacks, the number of requests allowed for this method in a given time period is limited. + description: Modifies the attributes of the specified access key of either your + root account or an EIM user. post: operationId: UpdateAccessKey requestBody: @@ -14984,12 +20853,42 @@ paths: application/json: schema: "$ref": "#/components/schemas/UpdateAccessKeyRequest" + examples: + ex1: + summary: Updating the expiration date of the access key + value: + AccessKeyId: ABCDEFGHIJ0123456789 + State: ACTIVE + ExpirationDate: '2063-04-05' + ex2: + summary: Updating one of your own access keys (if you are the root + account or an EIM user) + value: + AccessKeyId: ABCDEFGHIJ0123456789 + State: ACTIVE + ex3: + summary: Updating the access key of a specific EIM user + value: + AccessKeyId: ABCDEFGHIJ0123456789 + State: ACTIVE + UserName: example-user responses: '200': content: application/json: schema: "$ref": "#/components/schemas/UpdateAccessKeyResponse" + 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: 2017-05-10 12:34:56.789000000 +00:00 description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -15005,12 +20904,36 @@ paths: application/json: schema: "$ref": "#/components/schemas/UpdateAccountRequest" + examples: + ex1: + value: + AdditionalEmails: + - another@example.com + - yet.another@example.com responses: '200': content: application/json: schema: "$ref": "#/components/schemas/UpdateAccountResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Account: + ZipCode: '92210' + CompanyName: EXAMPLE SAS + FirstName: JEAN + AdditionalEmails: + - another@example.com + - yet.another@example.com + City: SAINT-CLOUD + Country: FRANCE + LastName: DUPONT + AccountId: '123456789012' + CustomerId: '87654321' + Email: example@example.com description: The HTTP 200 response (OK). tags: - Account @@ -15018,7 +20941,7 @@ paths: description: |- Updates the API access policy of your account.

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

\n\n**[NOTE]**

\n\n**[WARNING]**
\n- The new rule you specify fully replaces the old rule. Therefore, for a parameter that is not specified, any previously set value is deleted.
\n- If, as result of your modification, you no longer have access to the APIs, you @@ -15071,12 +21039,31 @@ paths: application/json: schema: "$ref": "#/components/schemas/UpdateApiAccessRuleRequest" + examples: + ex1: + value: + ApiAccessRuleId: aar-1234567890abcdef1234567890abcdef + IpRanges: + - 0.0.0.0/0 + 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 description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -15093,18 +21080,92 @@ paths: application/json: schema: "$ref": "#/components/schemas/UpdateCaRequest" + examples: + ex1: + value: + CaId: ca-fedcba0987654321fedcba0987654321 + Description: New description responses: '200': content: application/json: schema: "$ref": "#/components/schemas/UpdateCaResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Ca: + Description: New description + CaId: ca-fedcba0987654321fedcba0987654321 + CaFingerprint: 1234567890abcdef1234567890abcdef12345678 description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] - BasicAuth: [] tags: - Ca + "/UpdateDedicatedGroup": + description: |- + > [WARNING]
+ > This feature is currently in beta.
+ + Modifies the name of a specified dedicated group.
+ post: + operationId: UpdateDedicatedGroup + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/UpdateDedicatedGroupRequest" + examples: + ex1: + value: + DedicatedGroupId: ded-12345678 + Name: New-dedicated-group-name + 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 + Name: New-dedicated-group-name + SubregionName: eu-west-2a + DedicatedGroupId: ded-12345678 + description: The HTTP 200 response (OK). + '400': + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + description: The HTTP 400 response (Bad Request). + '401': + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + description: The HTTP 401 response (Unauthorized). + '500': + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + description: The HTTP 500 response (Internal Server Error). + tags: + - DedicatedGroup "/UpdateDirectLinkInterface": description: Modifies the maximum transmission unit (MTU) of a DirectLink interface. post: @@ -15114,12 +21175,36 @@ paths: application/json: schema: "$ref": "#/components/schemas/UpdateDirectLinkInterfaceRequest" + examples: + ex1: + value: + DirectLinkInterfaceId: dxvif-12345678 + Mtu: 1500 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/UpdateDirectLinkInterfaceResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + DirectLinkInterface: + Vlan: 101 + OutscalePrivateIp: 172.16.0.4/30 + DirectLinkInterfaceId: dxvif-12345678 + BgpAsn: 65000 + AccountId: '123456789012' + ClientPrivateIp: 172.16.0.5/30 + VirtualGatewayId: vgw-12345678 + DirectLinkInterfaceName: MyDirectLinkInterface + DirectLinkId: dxcon-12345678 + Mtu: 1500 + State: available + InterfaceType: private + Location: PAR1 description: The HTTP 200 response (OK). tags: - DirectLinkInterface @@ -15132,12 +21217,29 @@ paths: application/json: schema: "$ref": "#/components/schemas/UpdateFlexibleGpuRequest" + examples: + ex1: + value: + FlexibleGpuId: fgpu-12345678 + 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 + Generation: v5 + ModelName: nvidia-p100 + State: allocated + SubregionName: eu-west-2a description: The HTTP 200 response (OK). tags: - FlexibleGpu @@ -15153,12 +21255,169 @@ paths: application/json: schema: "$ref": "#/components/schemas/UpdateImageRequest" + examples: + ex1: + summary: Adding permission + value: + ImageId: ami-12345678 + PermissionsToLaunch: + Additions: + AccountIds: + - '987654321098' + ex2: + summary: Removing permission + value: + ImageId: ami-12345678 + PermissionsToLaunch: + Removals: + AccountIds: + - '987654321098' + ex3: + summary: Making an image public to everyone + value: + ImageId: ami-12345678 + PermissionsToLaunch: + Additions: + GlobalPermission: true + ex4: + summary: Making an image private to everyone + value: + ImageId: ami-12345678 + PermissionsToLaunch: + Removals: + GlobalPermission: true 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' + Tags: [] + Description: '' + ImageId: ami-12345678 + BlockDeviceMappings: + - DeviceName: "/dev/sda1" + Bsu: + VolumeType: standard + DeleteOnVmDeletion: true + VolumeSize: 50 + SnapshotId: snap-12345678 + ImageType: machine + CreationDate: '2010-10-01T12:34:56.789Z' + FileLocation: 123456789012/image-example + Architecture: x86_64 + ImageName: image-example + 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' + Tags: [] + Description: '' + ImageId: ami-12345678 + BlockDeviceMappings: + - DeviceName: "/dev/sda1" + Bsu: + VolumeType: standard + DeleteOnVmDeletion: true + VolumeSize: 50 + SnapshotId: snap-12345678 + ImageType: machine + CreationDate: '2010-10-01T12:34:56.789Z' + FileLocation: 123456789012/image-example + Architecture: x86_64 + ImageName: image-example + 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' + Tags: [] + Description: '' + ImageId: ami-12345678 + BlockDeviceMappings: + - DeviceName: "/dev/sda1" + Bsu: + VolumeType: standard + DeleteOnVmDeletion: true + VolumeSize: 50 + SnapshotId: snap-12345678 + ImageType: machine + CreationDate: '2010-10-01T12:34:56.789Z' + FileLocation: 123456789012/image-example + Architecture: x86_64 + ImageName: image-example + 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' + Tags: [] + Description: '' + ImageId: ami-12345678 + BlockDeviceMappings: + - DeviceName: "/dev/sda1" + Bsu: + VolumeType: standard + DeleteOnVmDeletion: true + VolumeSize: 50 + SnapshotId: snap-12345678 + ImageType: machine + CreationDate: '2010-10-01T12:34:56.789Z' + FileLocation: 123456789012/image-example + Architecture: x86_64 + ImageName: image-example description: The HTTP 200 response (OK). '400': content: @@ -15191,12 +21450,31 @@ paths: application/json: schema: "$ref": "#/components/schemas/UpdateListenerRuleRequest" + examples: + ex1: + value: + ListenerRuleName: example-listener-rule + HostPattern: "*.newhost.com" responses: '200': content: application/json: schema: "$ref": "#/components/schemas/UpdateListenerRuleResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ListenerRule: + Priority: 10 + VmIds: + - i-12345678 + ListenerRuleName: example-listener-rule + Action: forward + ListenerId: 123456 + HostNamePattern: "*.newhost.com" + ListenerRuleId: 1234 description: The HTTP 200 response (OK). tags: - Listener @@ -15216,12 +21494,217 @@ paths: application/json: schema: "$ref": "#/components/schemas/UpdateLoadBalancerRequest" + examples: + ex1: + summary: Updating health checks + value: + LoadBalancerName: private-lb-example + HealthCheck: + HealthyThreshold: 10 + CheckInterval: 30 + Path: "/index.html" + Port: 8080 + Protocol: HTTPS + Timeout: 5 + UnhealthyThreshold: 5 + ex2: + summary: Updating access logs + value: + LoadBalancerName: private-lb-example + AccessLog: + PublicationInterval: 5 + IsEnabled: true + OsuBucketName: BUCKET + OsuBucketPrefix: PREFIX + ex3: + summary: Updating policies + value: + LoadBalancerName: private-lb-example + LoadBalancerPort: 443 + PolicyNames: + - example-browser-policy + ex4: + summary: Updating SSL certificate + value: + LoadBalancerName: private-lb-example + LoadBalancerPort: 443 + ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/AnotherCertificate 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: + PublicationInterval: 60 + IsEnabled: false + DnsName: private-lb-example.123456789.eu-west-2.lbu.outscale.com + HealthCheck: + UnhealthyThreshold: 5 + Timeout: 5 + CheckInterval: 30 + Path: "/index.html" + Protocol: HTTPS + HealthyThreshold: 10 + Port: 8080 + LoadBalancerStickyCookiePolicies: [] + SubregionNames: + - eu-west-2a + Listeners: + - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate + BackendPort: 80 + BackendProtocol: HTTP + LoadBalancerPort: 443 + LoadBalancerProtocol: HTTPS + LoadBalancerName: private-lb-example + 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: + PublicationInterval: 5 + 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 + LoadBalancerStickyCookiePolicies: [] + SubregionNames: + - eu-west-2a + Listeners: + - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate + BackendPort: 80 + BackendProtocol: HTTP + LoadBalancerPort: 443 + LoadBalancerProtocol: HTTPS + LoadBalancerName: private-lb-example + 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: + 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: + - PolicyName: example-browser-policy + CookieExpirationPeriod: 1 + SubregionNames: + - eu-west-2a + Listeners: + - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate + BackendPort: 80 + BackendProtocol: HTTP + LoadBalancerPort: 443 + LoadBalancerProtocol: HTTPS + LoadBalancerName: private-lb-example + 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: + 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 + Listeners: + - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/AnotherCertificate + BackendPort: 80 + BackendProtocol: HTTP + LoadBalancerPort: 443 + LoadBalancerProtocol: HTTPS + LoadBalancerName: private-lb-example description: The HTTP 200 response (OK). tags: - LoadBalancer @@ -15234,12 +21717,29 @@ paths: application/json: schema: "$ref": "#/components/schemas/UpdateNetRequest" + examples: + ex1: + value: + NetId: vpc-12345678 + 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 description: The HTTP 200 response (OK). '400': content: @@ -15272,12 +21772,52 @@ paths: application/json: schema: "$ref": "#/components/schemas/UpdateNetAccessPointRequest" + examples: + ex1: + summary: Adding a route table + value: + NetAccessPointId: vpce-12345678 + AddRouteTableIds: + - rtb-87654321 + ex2: + summary: Removing a route table + value: + NetAccessPointId: vpce-12345678 + RemoveRouteTableIds: + - rtb-12345678 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 + RouteTableIds: + - rtb-12345678 + - rtb-87654321 + State: available + 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 + RouteTableIds: [] + State: available + NetId: vpc-12345678 + ServiceName: com.outscale.eu-west-2.oos description: The HTTP 200 response (OK). tags: - NetAccessPoint @@ -15291,12 +21831,125 @@ paths: 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 + ex2: + summary: Modifying the security groups of a NIC + value: + NicId: eni-12345678 + SecurityGroupIds: + - sg-12345678 + ex3: + summary: Modifying the description of a NIC + value: + NicId: eni-12345678 + 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: + SubregionName: eu-west-2a + SubnetId: subnet-12345678 + State: in-use + LinkNic: + VmId: i-12345678 + LinkNicId: eni-attach-12345678 + VmAccountId: '123456789012' + DeleteOnVmDeletion: false + DeviceNumber: 0 + State: attached + 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 + PrivateIps: + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + PrivateIp: 10.0.0.4 + IsPrimary: true + ex2: + summary: Modifying the security groups of a NIC + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Nic: + SubregionName: eu-west-2a + SubnetId: subnet-12345678 + State: in-use + LinkNic: + VmId: i-12345678 + LinkNicId: eni-attach-12345678 + VmAccountId: '123456789012' + DeleteOnVmDeletion: true + DeviceNumber: 0 + State: attached + 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 + PrivateIps: + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + PrivateIp: 10.0.0.4 + IsPrimary: true + ex3: + summary: Modifying the description of a NIC + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Nic: + SubregionName: eu-west-2a + SubnetId: subnet-12345678 + State: in-use + LinkNic: + VmId: i-12345678 + LinkNicId: eni-attach-12345678 + VmAccountId: '123456789012' + DeleteOnVmDeletion: true + DeviceNumber: 0 + State: attached + 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 + PrivateIps: + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + PrivateIp: 10.0.0.4 + IsPrimary: true description: The HTTP 200 response (OK). '400': content: @@ -15338,12 +21991,43 @@ paths: 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 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/UpdateRouteResponse" + examples: + ex1: + summary: Updating a route to a virtual gateway + value: + 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: + - RouteTableId: rtb-12345678 + Main: false + SubnetId: subnet-12345678 + LinkRouteTableId: rtbassoc-12345678 + NetId: vpc-12345678 + Tags: [] + RoutePropagatingVirtualGateways: [] + RouteTableId: rtb-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -15375,15 +22059,89 @@ paths: application/json: schema: "$ref": "#/components/schemas/UpdateRoutePropagationRequest" + examples: + ex1: + value: + VirtualGatewayId: vgw-12345678 + RouteTableId: rtb-12345678 + Enable: true responses: '200': content: application/json: schema: "$ref": "#/components/schemas/UpdateRoutePropagationResponse" + examples: + ex1: + value: + RouteTable: + Routes: + - DestinationIpRange: 10.0.0.0/16 + CreationMethod: CreateRouteTable + State: active + LinkRouteTables: + - RouteTableId: rtb-12345678 + Main: true + LinkRouteTableId: rtbassoc-12345678 + NetId: vpc-12345678 + Tags: [] + RoutePropagatingVirtualGateways: + - VirtualGatewayId: vgw-12345678 + RouteTableId: rtb-12345678 + 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: + operationId: UpdateRouteTableLink + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/UpdateRouteTableLinkRequest" + examples: + ex1: + value: + LinkRouteTableId: rtbassoc-12345678 + RouteTableId: rtb-12345678 + responses: + '200': + content: + application/json: + schema: + "$ref": "#/components/schemas/UpdateRouteTableLinkResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + LinkRouteTableId: rtbassoc-12345678 + description: The HTTP 200 response (OK). + '400': + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + description: The HTTP 400 response (Bad Request). + '401': + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + description: The HTTP 401 response (Unauthorized). + '500': + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + description: The HTTP 500 response (Internal Server Error). + tags: + - RouteTable "/UpdateServerCertificate": description: Modifies the name and/or the path of a specified server certificate. post: @@ -15393,12 +22151,26 @@ paths: application/json: schema: "$ref": "#/components/schemas/UpdateServerCertificateRequest" + examples: + ex1: + value: + Name: server-cert-example + NewName: new-name responses: '200': content: application/json: schema: "$ref": "#/components/schemas/UpdateServerCertificateResponse" + examples: + ex1: + value: + ServerCertificate: + Path: "/example/" + Id: ABCDEFGHIJKLMNOPQRSTUVWXYZ1234 + Name: new-name + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - ServerCertificate @@ -15414,12 +22186,117 @@ paths: application/json: schema: "$ref": "#/components/schemas/UpdateSnapshotRequest" + examples: + ex1: + summary: Adding permission + value: + SnapshotId: snap-12345678 + PermissionsToCreateVolume: + Additions: + AccountIds: + - '987654321098' + ex2: + summary: Removing permission + value: + SnapshotId: snap-12345678 + PermissionsToCreateVolume: + Removals: + AccountIds: + - '987654321098' + ex3: + summary: Making an image public to everyone + value: + SnapshotId: snap-12345678 + PermissionsToCreateVolume: + Additions: + GlobalPermission: true + ex4: + summary: Making an image private to everyone + value: + SnapshotId: snap-12345678 + PermissionsToCreateVolume: + Removals: + GlobalPermission: true responses: '200': content: application/json: schema: "$ref": "#/components/schemas/UpdateSnapshotResponse" + examples: + ex1: + summary: Adding permission + value: + Snapshot: + VolumeSize: 10 + AccountId: '123456789012' + VolumeId: vol-12345678 + CreationDate: '2010-10-01T12:34:56.789Z' + PermissionsToCreateVolume: + GlobalPermission: false + AccountIds: + - '987654321098' + Progress: 100 + SnapshotId: snap-12345678 + State: completed + Description: Snapshot created from a volume + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + summary: Removing permission + value: + Snapshot: + VolumeSize: 10 + AccountId: '123456789012' + VolumeId: vol-12345678 + CreationDate: '2010-10-01T12:34:56.789Z' + PermissionsToCreateVolume: + GlobalPermission: false + AccountIds: [] + Progress: 100 + SnapshotId: snap-12345678 + State: completed + Description: Snapshot created from a volume + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex3: + summary: Making an image public to everyone + value: + Snapshot: + VolumeSize: 10 + AccountId: '123456789012' + VolumeId: vol-12345678 + CreationDate: '2010-10-01T12:34:56.789Z' + PermissionsToCreateVolume: + GlobalPermission: true + AccountIds: [] + Progress: 100 + SnapshotId: snap-12345678 + State: completed + Description: Snapshot created from a volume + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex4: + summary: Making an image private to everyone + value: + Snapshot: + VolumeSize: 10 + AccountId: '123456789012' + VolumeId: vol-12345678 + CreationDate: '2010-10-01T12:34:56.789Z' + PermissionsToCreateVolume: + GlobalPermission: false + AccountIds: [] + Progress: 100 + SnapshotId: snap-12345678 + State: completed + Description: Snapshot created from a volume + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -15450,12 +22327,31 @@ paths: application/json: schema: "$ref": "#/components/schemas/UpdateSubnetRequest" + examples: + ex1: + value: + SubnetId: subnet-12345678 + MapPublicIpOnLaunch: true responses: '200': content: application/json: schema: "$ref": "#/components/schemas/UpdateSubnetResponse" + examples: + ex1: + value: + Subnet: + Tags: [] + SubregionName: eu-west-2a + SubnetId: subnet-12345678 + AvailableIpsCount: 16379 + IpRange: 10.0.0.0/18 + MapPublicIpOnLaunch: true + State: available + NetId: vpc-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -15486,12 +22382,27 @@ paths: application/json: schema: "$ref": "#/components/schemas/UpdateUserRequest" + examples: + ex1: + value: + UserName: example-user + NewUserName: test-user + NewPath: "/product/" responses: '200': content: application/json: schema: "$ref": "#/components/schemas/UpdateUserResponse" + examples: + ex1: + value: + User: + UserName: test-user + UserId: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 + Path: "/product/" + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - User @@ -15510,12 +22421,160 @@ paths: application/json: schema: "$ref": "#/components/schemas/UpdateVmRequest" + examples: + ex1: + value: + VmId: i-12345678 + VmType: tinav5.c2r2p2 + ex2: + value: + VmId: i-12345678 + UserData: "..." responses: '200': content: application/json: schema: "$ref": "#/components/schemas/UpdateVmResponse" + examples: + ex1: + value: + Vm: + 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: + - DeviceName: "/dev/sda1" + Bsu: + VolumeId: vol-12345678 + 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 + NetId: vpc-12345678 + Nics: + - SubnetId: subnet-12345678 + State: in-use + LinkNic: + State: attached + DeviceNumber: 0 + LinkNicId: eni-attach-12345678 + 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 + PrivateIps: + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + PrivateIp: 10.0.0.4 + IsPrimary: true + Performance: high + Tags: + - Value: prod + Key: env + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + value: + Vm: + 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: + - DeviceName: "/dev/sda1" + Bsu: + VolumeId: vol-12345678 + 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 + NetId: vpc-12345678 + Nics: + - SubnetId: subnet-12345678 + State: in-use + LinkNic: + State: attached + DeviceNumber: 0 + LinkNicId: eni-attach-12345678 + 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 + PrivateIps: + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + PrivateIp: 10.0.0.4 + IsPrimary: true + Performance: high + Tags: + - Value: prod + Key: env + 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: @@ -15550,12 +22609,43 @@ paths: application/json: schema: "$ref": "#/components/schemas/UpdateVmGroupRequest" + examples: + ex1: + summary: Updating the name and description of a VM group + value: + 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 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/UpdateVmGroupResponse" + examples: + ex1: + value: + VmGroup: + VmTemplateId: vmtemplate-98765432109876543210987654321012 + SecurityGroupIds: + - sg-12345678 + VmIds: [] + CreationDate: 2010-10-01 12:34:56.789000000 +00:00 + VmCount: 2 + VmGroupName: new-name + 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: @@ -15590,12 +22680,33 @@ paths: application/json: schema: "$ref": "#/components/schemas/UpdateVmTemplateRequest" + examples: + ex1: + value: + Description: The new description of the VM template + VmTemplateId: vmtemplate-98765432109876543210987654321012 + VmTemplateName: second-name responses: '200': content: application/json: schema: "$ref": "#/components/schemas/UpdateVmTemplateResponse" + examples: + ex1: + value: + 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 + CpuGeneration: v4 + VmTemplateId: vmtemplate-98765432109876543210987654321012 + Ram: 2 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - VmTemplate @@ -15613,12 +22724,55 @@ paths: application/json: schema: "$ref": "#/components/schemas/UpdateVolumeRequest" + examples: + ex1: + summary: Updating the size of a volume + value: + VolumeId: vol-12345678 + Size: 50 + ex2: + summary: Updating the type of a volume to io1 + value: + VolumeId: vol-12345678 + VolumeType: io1 + Iops: 200 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/UpdateVolumeResponse" + examples: + ex1: + summary: Updating the size of a volume + value: + 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 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + summary: Updating the type of a volume to io1 + value: + 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 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -15649,12 +22803,40 @@ paths: application/json: schema: "$ref": "#/components/schemas/UpdateVpnConnectionRequest" + examples: + ex1: + value: + VpnConnectionId: vpn-12345678 + VpnOptions: + TunnelInsideIpRange: 169.254.254.22/30 responses: '200': content: application/json: schema: "$ref": "#/components/schemas/UpdateVpnConnectionResponse" + examples: + ex1: + value: + VpnConnection: + VpnOptions: + TunnelInsideIpRange: 169.254.254.22/30 + Routes: [] + Tags: [] + ClientGatewayConfiguration: "..." + StaticRoutesOnly: true + VirtualGatewayId: vgw-12345678 + ConnectionType: ipsec.1 + ClientGatewayId: cgw-12345678 + State: pending + VgwTelemetries: + - StateDescription: IPSEC IS DOWN + AcceptedRouteCount: 0 + LastStateChangeDate: '2017-05-10T12:34:56.789Z' + OutsideIpAddress: 192.0.2.0 + VpnConnectionId: vpn-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). '400': content: @@ -15689,9 +22871,3 @@ servers: - eu-west-2 - us-east-2 - us-west-1 -- url: https://api.{region}.outscale.jp/api/v1 - variables: - region: - default: ap-northeast-1 - enum: - - ap-northeast-1