From f585267501814c71ee2c13884b78567362f9a951 Mon Sep 17 00:00:00 2001 From: Outscale Bot Date: Thu, 5 Jun 2025 12:02:49 +0000 Subject: [PATCH] osc-sdk-go v1.35.3 Signed-off-by: Outscale Bot --- old-outscale.yaml | 279 +- outscale-go.yaml | 6083 ++++++++++++++++++++++---------------------- outscale-java.yaml | 6082 +++++++++++++++++++++---------------------- outscale.yaml | 6083 ++++++++++++++++++++++---------------------- 4 files changed, 9594 insertions(+), 8933 deletions(-) diff --git a/old-outscale.yaml b/old-outscale.yaml index dc7b3c0..f09aa34 100644 --- a/old-outscale.yaml +++ b/old-outscale.yaml @@ -60,6 +60,9 @@ components: description: The state of the access key (`ACTIVE` if the key is valid for API calls, or `INACTIVE` if not). type: string + Tag: + description: The tag added to the access key. + type: string type: object AccessKeySecretKey: additionalProperties: false @@ -87,6 +90,9 @@ components: description: The state of the access key (`ACTIVE` if the key is valid for API calls, or `INACTIVE` if not). type: string + Tag: + description: A tag added to the access key. + type: string type: object AccessLog: additionalProperties: false @@ -604,6 +610,9 @@ components: without specifying this parameter. format: datetime type: string + Tag: + description: A tag to add to the access key. + 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 @@ -1336,15 +1345,14 @@ components: additionalProperties: false properties: AccepterNetId: - description: "The ID of the Net you want to connect with.

- \nIf the Net does not belong to you, you must also specify the `AccepterOwnerId` - parameter with the account ID owning the Net you want to connect with." + description: |- + The ID of the Net you want to connect with.

+ If the Net does not belong to you, you must also specify the `AccepterOwnerId` parameter with the account ID owning the Net you want to connect with. type: string AccepterOwnerId: - description: "The account ID of the owner of the Net you want to connect - with. By default, the account ID of the owner of the Net from which the - peering request is sent.

\nThis parameter is required if - the Net you want to connect with does not belong to you." + description: |- + The account ID of the owner of the Net you want to connect with. By default, the account ID of the owner of the Net from which the peering request is sent.

+ This parameter is required if the Net you want to connect with does not belong to you. type: string DryRun: description: If true, checks whether you have the required permissions to @@ -3123,6 +3131,30 @@ components: ResponseContext: "$ref": "#/components/schemas/ResponseContext" type: object + DeleteUserPolicyRequest: + additionalProperties: false + properties: + DryRun: + description: If true, checks whether you have the required permissions to + perform the action. + type: boolean + PolicyName: + description: The name of the policy document you want to delete (between + 1 and 128 characters). + type: string + UserName: + description: The name of the user you want to delete the policy from. + type: string + required: + - UserName + - PolicyName + type: object + DeleteUserPolicyResponse: + additionalProperties: false + properties: + ResponseContext: + "$ref": "#/components/schemas/ResponseContext" + type: object DeleteUserRequest: additionalProperties: false properties: @@ -3385,9 +3417,10 @@ 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 `1` and `4294967295`, except `50624`, `53306`, and `132418`.
+ If you do not have an ASN, you can choose one between `64512` and `65534` (both included), or between `4200000000` and `4294967295` (both included). type: integer BgpKey: description: The BGP authentication key. @@ -5061,7 +5094,6 @@ components: CreationDates: description: The dates when the VMs were launched. items: - format: date type: string type: array ImageIds: @@ -7528,6 +7560,35 @@ components: ResponseContext: "$ref": "#/components/schemas/ResponseContext" type: object + PutUserPolicyRequest: + additionalProperties: false + properties: + DryRun: + description: If true, checks whether you have the required permissions to + perform the action. + type: boolean + PolicyDocument: + 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) + and [EIM Policy Generator](https://docs.outscale.com/en/userguide/EIM-Policy-Generator.html). + type: string + PolicyName: + description: The name of the policy (between 1 and 128 characters). + type: string + UserName: + description: The name of the user. + type: string + required: + - PolicyName + - PolicyDocument + - UserName + type: object + PutUserPolicyResponse: + additionalProperties: false + properties: + ResponseContext: + "$ref": "#/components/schemas/ResponseContext" + type: object Quota: additionalProperties: false description: Information about the quota. @@ -7578,6 +7639,9 @@ components: type: boolean Filters: "$ref": "#/components/schemas/FiltersAccessKeys" + Tag: + description: The tag added to the access key. + type: string UserName: description: The name of the EIM user. By default, the user who sends the request (which can be the root account). @@ -9412,6 +9476,58 @@ components: "$ref": "#/components/schemas/UserGroup" type: array type: object + ReadUserPoliciesRequest: + properties: + DryRun: + description: If true, checks whether you have the required permissions to + perform the action. + type: boolean + UserName: + description: The name of the user. + type: string + required: + - UserName + type: object + ReadUserPoliciesResponse: + properties: + PolicyNames: + description: A list of policy names. + items: + type: string + type: array + ResponseContext: + "$ref": "#/components/schemas/ResponseContext" + type: object + ReadUserPolicyRequest: + properties: + DryRun: + description: If true, checks whether you have the required permissions to + perform the action. + type: boolean + PolicyName: + description: The name of the policy. + type: string + UserName: + description: The name of the user. + type: string + required: + - UserName + - PolicyName + type: object + ReadUserPolicyResponse: + properties: + PolicyDocument: + description: The policy document, providing a description of the policy. + type: string + PolicyName: + description: The name of the inline policy. + type: string + ResponseContext: + "$ref": "#/components/schemas/ResponseContext" + UserName: + description: The name of the user in which the inline policy is included. + type: string + type: object ReadUsersRequest: additionalProperties: false properties: @@ -12310,10 +12426,10 @@ info: url: https://opensource.org/licenses/BSD-3-Clause termsOfService: https://en.outscale.com/terms-of-service/ title: 3DS OUTSCALE API - version: 1.34.0 - x-osc-api-oapi: 1.34.0 + version: 1.34.3 x-osc-api-osc-billing: 1.34.0 x-osc-api-osc-cloud-vision: 1.34.0 + x-osc-api-osc-core-iaas: 1.34.4 x-osc-api-type: external openapi: 3.0.0 paths: @@ -12461,6 +12577,8 @@ paths: ex1: value: ExpirationDate: '2063-04-05' + Tag: Group1 + UserName: example-user responses: '200': content: @@ -12479,6 +12597,7 @@ paths: ExpirationDate: 2063-04-05 00:00:00.000000000 +00:00 SecretKey: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX LastModificationDate: 2010-10-01 12:34:56.789000000 +00:00 + Tag: Group1 description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -17380,6 +17499,34 @@ paths: description: The HTTP 200 response (OK). tags: - Policy + "/DeleteUserPolicy": + description: Deletes a specified inline policy from a specific user. + post: + operationId: DeleteUserPolicy + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/DeleteUserPolicyRequest" + examples: + ex1: + value: + PolicyName: example-user-policy + UserName: example-user + responses: + '200': + content: + application/json: + schema: + "$ref": "#/components/schemas/DeleteUserPolicyResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + description: The HTTP 200 response (OK). + tags: + - Policy "/DeleteVirtualGateway": description: |- Deletes a specified virtual gateway.
@@ -17648,7 +17795,11 @@ paths: tags: - VpnConnection "/DeregisterVmsInLoadBalancer": - description: Deregisters a specified virtual machine (VM) from a load balancer. + description: |- + > [WARNING]
+ > Deprecated: This call is deprecated and will be removed.
+ + Deregisters a specified virtual machine (VM) from a load balancer. post: operationId: DeregisterVmsInLoadBalancer requestBody: @@ -18203,6 +18354,38 @@ paths: description: The HTTP 200 response (OK). tags: - Policy + "/PutUserPolicy": + description: |- + Creates or updates an inline policy included in a specified user.
+ The policy is automatically applied to the user after its creation. + post: + operationId: PutUserPolicy + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/PutUserPolicyRequest" + examples: + ex1: + value: + PolicyDocument: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], + "Resource": ["*"]} ]}' + PolicyName: example-user-policy + UserName: example-user + responses: + '200': + content: + application/json: + schema: + "$ref": "#/components/schemas/PutUserPolicyResponse" + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + description: The HTTP 200 response (OK). + tags: + - Policy "/ReadAccessKeys": description: Lists the access key IDs of either your root account or an EIM user. post: @@ -18218,6 +18401,8 @@ paths: Filters: States: - ACTIVE + Tag: Group1 + UserName: example-user responses: '200': content: @@ -18235,6 +18420,7 @@ paths: 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 + Tag: Group1 description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -21155,6 +21341,66 @@ paths: description: The HTTP 200 response (OK). tags: - UserGroup + "/ReadUserPolicies": + description: Lists the names of inline policies included in a specified user. + post: + operationId: ReadUserPolicies + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/ReadUserPoliciesRequest" + examples: + ex1: + value: + UserName: example-user + responses: + '200': + content: + application/json: + schema: + "$ref": "#/components/schemas/ReadUserPoliciesResponse" + examples: + ex1: + value: + PolicyNames: + - example-policy + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + description: The HTTP 200 response (OK). + tags: + - Policy + "/ReadUserPolicy": + description: Returns information about an inline policy included in a specified + user. + post: + operationId: ReadUserPolicy + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/ReadUserPolicyRequest" + examples: + ex1: + value: + UserName: example-user + PolicyName: example-user-policy + responses: + '200': + content: + application/json: + schema: + "$ref": "#/components/schemas/ReadUserPolicyResponse" + examples: + ex1: + value: + PolicyDocument: '{"Statement": [ {"Effect": "Allow", "Action": + ["*"], "Resource": ["*"]} ]}' + PolicyName: example-user-policy + UserName: example-user + description: The HTTP 200 response (OK). + tags: + - Policy "/ReadUsers": description: |- Lists all EIM users in the account.
@@ -21800,6 +22046,9 @@ paths: - Vm "/RegisterVmsInLoadBalancer": description: |- + > [WARNING]
+ > Deprecated: This call is deprecated and will be removed.
+ Registers one or more virtual machines (VMs) with a specified load balancer.
The VMs can be in different Subnets and different Subregions than the load balancer, as long as the VMs and load balancers are all in the public Cloud or all in the same Net. It may take a little time for a VM to be registered with the load balancer. Once the VM is registered with a load balancer, it receives traffic and requests from this load balancer and is called a backend VM. post: @@ -22646,6 +22895,7 @@ paths: 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 + Tag: Group1 ex2: summary: Updating an access key when not using the parameter ExpirationDate value: @@ -22656,6 +22906,7 @@ paths: AccessKeyId: ABCDEFGHIJ0123456789 CreationDate: 2010-10-01 12:34:56.789000000 +00:00 LastModificationDate: 2017-05-10 12:34:56.789000000 +00:00 + Tag: Group1 description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] diff --git a/outscale-go.yaml b/outscale-go.yaml index 877a506..cf03551 100644 --- a/outscale-go.yaml +++ b/outscale-go.yaml @@ -171,6 +171,12 @@ components: description: The ZIP code of the city. type: string type: object + ActionsOnNextBoot: + description: The action to perform on the next boot of the VM. + properties: + SecureBoot: + "$ref": "#/components/schemas/SecureBootAction" + type: object AddUserToUserGroupRequest: additionalProperties: false properties: @@ -344,6 +350,12 @@ components: description: The name of the virtual device (`ephemeralN`). type: string type: object + BootMode: + description: Information about the boot mode of the OMI (`legacy` and/or `uefi`). + enum: + - uefi + - legacy + type: string BsuCreated: additionalProperties: false description: Information about the created BSU volume. @@ -995,6 +1007,11 @@ components: items: "$ref": "#/components/schemas/BlockDeviceMappingImage" type: array + BootModes: + description: The boot modes compatible with the OMI (`legacy` and/or `uefi`). + items: + "$ref": "#/components/schemas/BootMode" + type: array Description: description: A description for the new OMI. type: string @@ -1772,6 +1789,9 @@ components: CreateSnapshotRequest: additionalProperties: false properties: + ClientToken: + description: A unique identifier which enables you to manage the idempotency. + type: string Description: description: A description for the snapshot. type: string @@ -2067,11 +2087,15 @@ components: CreateVmsRequest: additionalProperties: false properties: + ActionsOnNextBoot: + "$ref": "#/components/schemas/ActionsOnNextBoot" BlockDeviceMappings: description: One or more block device mappings. items: "$ref": "#/components/schemas/BlockDeviceMappingVmCreation" type: array + BootMode: + "$ref": "#/components/schemas/BootMode" BootOnCreation: default: true description: By default or if true, the VM is started on creation. If false, @@ -2186,6 +2210,9 @@ components: CreateVolumeRequest: additionalProperties: false properties: + ClientToken: + description: A unique identifier which enables you to manage the idempotency. + type: string DryRun: description: If true, checks whether you have the required permissions to perform the action. @@ -3911,6 +3938,11 @@ components: items: type: string type: array + BootModes: + description: The boot modes compatible with the OMIs (`legacy` and/or `uefi`). + items: + "$ref": "#/components/schemas/BootMode" + type: array Descriptions: description: The descriptions of the OMIs, provided when they were created. items: @@ -3965,6 +3997,9 @@ components: items: type: string type: array + SecureBoot: + description: Whether secure boot is activated or not. + type: boolean States: description: The states of the OMIs (`pending` \| `available` \| `failed`). items: @@ -4802,6 +4837,11 @@ components: items: type: string type: array + ClientTokens: + description: The idempotency tokens provided when creating the snapshots. + items: + type: string + type: array Descriptions: description: The descriptions of the snapshots. items: @@ -5082,6 +5122,11 @@ components: items: type: string type: array + BootModes: + description: The boot modes of the VMs (`legacy` \| `uefi`). + items: + "$ref": "#/components/schemas/BootMode" + type: array ClientTokens: description: The idempotency tokens provided when launching the VMs. items: @@ -5090,6 +5135,7 @@ components: CreationDates: description: The dates when the VMs were launched. items: + format: date type: string type: array ImageIds: @@ -5608,6 +5654,11 @@ components: additionalProperties: false description: One or more filters. properties: + ClientTokens: + description: The idempotency tokens provided when creating the volumes. + items: + type: string + type: array CreationDates: description: The dates and times at which the volumes were created, in ISO 8601 date-time format (for example, `2020-06-30T00:00:00.000Z`). @@ -5821,6 +5872,7 @@ components: type: integer Path: description: If you use the HTTP or HTTPS protocols, the request URL path. + Always starts with a slash (`/`). type: string Port: description: The port number (between `1` and `65535`, both included). @@ -5863,6 +5915,11 @@ components: items: "$ref": "#/components/schemas/BlockDeviceMappingImage" type: array + BootModes: + description: The boot modes compatible with the OMI (`legacy` and/or `uefi`). + items: + "$ref": "#/components/schemas/BootMode" + type: array CreationDate: description: The date and time (UTC) at which the OMI was created. format: date @@ -5895,6 +5952,9 @@ components: RootDeviceType: description: The type of root device used by the OMI (always `bsu`). type: string + SecureBoot: + description: Whether secure boot is activated or not. + type: boolean State: description: The state of the OMI (`pending` \| `available` \| `failed`). type: string @@ -8678,10 +8738,24 @@ components: type: boolean Filters: "$ref": "#/components/schemas/FiltersNic" + 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 ReadNicsResponse: 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 Nics: description: Information about one or more NICs. items: @@ -9955,7 +10029,7 @@ components: description: Information about the tag. properties: Key: - description: The key of the tag, with a minimum of 1 character. + description: The key of the tag, between 1 and 128 characters. type: string required: - Key @@ -10123,6 +10197,15 @@ components: ResponseContext: "$ref": "#/components/schemas/ResponseContext" type: object + SecureBootAction: + description: One action to perform on the next boot of the VM (`enable` | `disable` + | `setup-mode` |`none`). + enum: + - enable + - disable + - setup-mode + - none + type: string SecurityGroup: additionalProperties: false description: Information about the security group. @@ -10296,6 +10379,9 @@ components: AccountId: description: The account ID of the owner of the snapshot. type: string + ClientToken: + description: The idempotency token provided when creating the snapshot. + type: string CreationDate: description: The date and time (UTC) at which the snapshot was created. format: datetime @@ -11093,6 +11179,13 @@ components: type: string PermissionsToLaunch: "$ref": "#/components/schemas/PermissionsOnResourceCreation" + ProductCodes: + description: The product codes associated with the OMI. Any previously set + value is deleted. Make sure to specify all product codes you want to associate + with the OMI. + items: + type: string + type: array required: - ImageId type: object @@ -11570,6 +11663,8 @@ components: UpdateVmRequest: additionalProperties: false properties: + ActionsOnNextBoot: + "$ref": "#/components/schemas/ActionsOnNextBoot" BlockDeviceMappings: description: One or more block device mappings of the VM. items: @@ -11837,6 +11932,8 @@ components: additionalProperties: false description: Information about the VM. properties: + ActionsOnNextBoot: + "$ref": "#/components/schemas/ActionsOnNextBoot" Architecture: description: The architecture of the VM (`i386` \| `x86_64`). type: string @@ -11845,6 +11942,8 @@ components: items: "$ref": "#/components/schemas/BlockDeviceMappingCreated" type: array + BootMode: + "$ref": "#/components/schemas/BootMode" BsuOptimized: description: This parameter is not available. It is present in our API for the sake of historical compatibility with AWS. @@ -12153,6 +12252,9 @@ components: additionalProperties: false description: Information about the volume. properties: + ClientToken: + description: The idempotency token provided when creating the volume. + type: string CreationDate: description: The date and time (UTC) at which the volume was created. format: datetime @@ -12411,10 +12513,10 @@ info: url: https://opensource.org/licenses/BSD-3-Clause termsOfService: https://en.outscale.com/terms-of-service/ title: 3DS OUTSCALE API - version: 1.34.3 - x-osc-api-osc-billing: 1.34.0 - x-osc-api-osc-cloud-vision: 1.34.0 - x-osc-api-osc-core-iaas: 1.34.4 + version: 1.35.3 + x-osc-api-osc-billing: 1.35.0 + x-osc-api-osc-cloud-vision: 1.35.0 + x-osc-api-osc-core-iaas: 1.35.3 x-osc-api-type: external openapi: 3.0.0 paths: @@ -12430,38 +12532,38 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/AcceptNetPeeringRequest" examples: ex1: value: NetPeeringId: pcx-12345678 + schema: + "$ref": "#/components/schemas/AcceptNetPeeringRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/AcceptNetPeeringResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 NetPeering: - Tags: [] - State: - Name: active - Message: Active AccepterNet: - NetId: vpc-12345678 - IpRange: 172.16.0.0/16 AccountId: '123456789012' + IpRange: 172.16.0.0/16 + NetId: vpc-12345678 ExpirationDate: '2063-04-05T00:00:00.000Z' + NetPeeringId: pcx-12345678 SourceNet: - NetId: vpc-12345678 - IpRange: 10.0.0.0/16 AccountId: '123456789012' - NetPeeringId: pcx-12345678 + IpRange: 10.0.0.0/16 + NetId: vpc-12345678 + State: + Message: Active + Name: active + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/AcceptNetPeeringResponse" description: The HTTP 200 response (OK). '400': content: @@ -12496,8 +12598,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/AddUserToUserGroupRequest" examples: ex1: value: @@ -12505,17 +12605,19 @@ paths: UserGroupPath: "/example/" UserName: example-user UserPath: "/example/" + schema: + "$ref": "#/components/schemas/AddUserToUserGroupRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/AddUserToUserGroupResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/AddUserToUserGroupResponse" description: The HTTP 200 response (OK). tags: - UserGroup @@ -12526,24 +12628,24 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CheckAuthenticationRequest" examples: ex1: value: Login: example@example.com Password: "$OSC_PASSWORD" + schema: + "$ref": "#/components/schemas/CheckAuthenticationRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CheckAuthenticationResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CheckAuthenticationResponse" description: The HTTP 200 response (OK). tags: - Account @@ -12556,33 +12658,33 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateAccessKeyRequest" examples: ex1: value: ExpirationDate: '2063-04-05' Tag: Group1 UserName: example-user + schema: + "$ref": "#/components/schemas/CreateAccessKeyRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateAccessKeyResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 AccessKey: - State: ACTIVE AccessKeyId: ABCDEFGHIJ0123456789 CreationDate: 2010-10-01 12:34:56.789000000 +00:00 ExpirationDate: 2063-04-05 00:00:00.000000000 +00:00 - SecretKey: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX LastModificationDate: 2010-10-01 12:34:56.789000000 +00:00 + SecretKey: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + State: ACTIVE Tag: Group1 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateAccessKeyResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -12603,8 +12705,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateAccountRequest" examples: ex1: value: @@ -12616,26 +12716,28 @@ paths: FirstName: JEAN LastName: DUPONT ZipCode: '92210' + schema: + "$ref": "#/components/schemas/CreateAccountRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateAccountResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Account: - ZipCode: '92210' - CompanyName: EXAMPLE SAS - FirstName: JEAN + AccountId: '123456789012' City: SAINT-CLOUD + CompanyName: EXAMPLE SAS Country: FRANCE - LastName: DUPONT - AccountId: '123456789012' Email: example@example.com + FirstName: JEAN + LastName: DUPONT + ZipCode: '92210' + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateAccountResponse" description: The HTTP 200 response (OK). tags: - Account @@ -12652,61 +12754,61 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateApiAccessRuleRequest" examples: ex1: summary: Creating an API access rule based on IPs value: + Description: Basic API Access Rule with IPs IpRanges: - 192.0.2.0 - 198.51.100.0/24 - Description: Basic API Access Rule with IPs ex2: summary: Creating an API access rule based on IPs and Certificate Authority (CA) value: - IpRanges: - - 192.0.2.0 - - 198.51.100.0/24 CaIds: - ca-fedcba0987654321fedcba0987654321 Description: API Access Rule with IPs and CA + IpRanges: + - 192.0.2.0 + - 198.51.100.0/24 + schema: + "$ref": "#/components/schemas/CreateApiAccessRuleRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateApiAccessRuleResponse" examples: ex1: summary: Creating an API access rule based on IPs value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ApiAccessRule: - IpRanges: - - 192.0.2.0 - - 198.51.100.0/24 ApiAccessRuleId: aar-fedcba0987654321fedcba0987654321 CaIds: [] Cns: [] Description: Basic API Access Rule with IPs + IpRanges: + - 192.0.2.0 + - 198.51.100.0/24 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Creating an API access rule based on IPs and Certificate Authority (CA) value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ApiAccessRule: - IpRanges: - - 192.0.2.0 - - 198.51.100.0/24 ApiAccessRuleId: aar-fedcba0987654321fedcba0987654321 CaIds: - ca-fedcba0987654321fedcba0987654321 Cns: [] Description: API Access Rule with IPs and CA + IpRanges: + - 192.0.2.0 + - 198.51.100.0/24 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateApiAccessRuleResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -12722,28 +12824,28 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateCaRequest" examples: ex1: value: CaPem: XXXX Description: CA example + schema: + "$ref": "#/components/schemas/CreateCaRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateCaResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Ca: - Description: CA example - CaId: ca-fedcba0987654321fedcba0987654321 CaFingerprint: 1234567890abcdef1234567890abcdef12345678 + CaId: ca-fedcba0987654321fedcba0987654321 + Description: CA example + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateCaResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -12761,32 +12863,32 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateClientGatewayRequest" examples: ex1: value: + BgpAsn: 65000 ConnectionType: ipsec.1 PublicIp: 192.0.2.0 - BgpAsn: 65000 + schema: + "$ref": "#/components/schemas/CreateClientGatewayRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateClientGatewayResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ClientGateway: - State: available BgpAsn: 65000 - Tags: [] ClientGatewayId: cgw-12345678 ConnectionType: ipsec.1 PublicIp: 192.0.2.0 + State: available + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateClientGatewayResponse" description: The HTTP 200 response (OK). tags: - ClientGateway @@ -12802,33 +12904,33 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateDedicatedGroupRequest" examples: ex1: value: CpuGeneration: 4 Name: dedicated-group-example SubregionName: eu-west-2a + schema: + "$ref": "#/components/schemas/CreateDedicatedGroupRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateDedicatedGroupResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 DedicatedGroup: - VmIds: [] - NetIds: [] AccountId: '123456789012' CpuGeneration: 4 + DedicatedGroupId: ded-12345678 Name: dedicated-group-example + NetIds: [] SubregionName: eu-west-2a - DedicatedGroupId: ded-12345678 + VmIds: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateDedicatedGroupResponse" description: The HTTP 200 response (OK). '400': content: @@ -12859,8 +12961,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateDhcpOptionsRequest" examples: ex1: value: @@ -12871,28 +12971,30 @@ paths: NtpServers: - 203.0.113.0 - 203.0.113.1 + schema: + "$ref": "#/components/schemas/CreateDhcpOptionsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateDhcpOptionsResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 DhcpOptionsSet: - Tags: [] - NtpServers: - - 203.0.113.0 - - 203.0.113.1 Default: false DhcpOptionsSetId: dopt-12345678 DomainName: example.com DomainNameServers: - 192.0.2.0 - 198.51.100.0 + NtpServers: + - 203.0.113.0 + - 203.0.113.1 + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateDhcpOptionsResponse" description: The HTTP 200 response (OK). tags: - DhcpOption @@ -12905,25 +13007,21 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateDirectLinkRequest" examples: ex1: value: - Location: PAR1 Bandwidth: 1Gbps DirectLinkName: Connection to Outscale + Location: PAR1 + schema: + "$ref": "#/components/schemas/CreateDirectLinkRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateDirectLinkResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 DirectLink: AccountId: '123456789012' Bandwidth: 1Gbps @@ -12932,8 +13030,12 @@ paths: Location: PAR1 RegionName: eu-west-2 State: requested - description: The HTTP 200 response (OK). - tags: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateDirectLinkResponse" + description: The HTTP 200 response (OK). + tags: - DirectLink "/CreateDirectLinkInterface": description: |- @@ -12945,45 +13047,45 @@ paths: requestBody: content: 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 + DirectLinkInterfaceName: MyDirectLinkInterface + OutscalePrivateIp: 172.16.0.4/30 VirtualGatewayId: vgw-12345678 + Vlan: 101 + schema: + "$ref": "#/components/schemas/CreateDirectLinkInterfaceRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateDirectLinkInterfaceResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 DirectLinkInterface: - Vlan: 101 - OutscalePrivateIp: 172.16.0.4/30 - DirectLinkInterfaceId: dxvif-12345678 - BgpAsn: 65000 AccountId: '123456789012' + BgpAsn: 65000 ClientPrivateIp: 172.16.0.5/30 - VirtualGatewayId: vgw-12345678 - DirectLinkInterfaceName: MyDirectLinkInterface DirectLinkId: dxcon-12345678 - Mtu: 1500 - State: pending + DirectLinkInterfaceId: dxvif-12345678 + DirectLinkInterfaceName: MyDirectLinkInterface InterfaceType: private Location: PAR1 + Mtu: 1500 + OutscalePrivateIp: 172.16.0.4/30 + State: pending + VirtualGatewayId: vgw-12345678 + Vlan: 101 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateDirectLinkInterfaceResponse" description: The HTTP 200 response (OK). tags: - DirectLinkInterface @@ -12997,33 +13099,33 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateFlexibleGpuRequest" examples: ex1: value: - ModelName: nvidia-p100 + DeleteOnVmDeletion: true Generation: v5 + ModelName: nvidia-p100 SubregionName: eu-west-2a - DeleteOnVmDeletion: true + schema: + "$ref": "#/components/schemas/CreateFlexibleGpuRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateFlexibleGpuResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 FlexibleGpu: - SubregionName: eu-west-2a DeleteOnVmDeletion: true + FlexibleGpuId: fgpu-12345678 Generation: v5 ModelName: nvidia-p100 State: allocated - FlexibleGpuId: fgpu-12345678 + SubregionName: eu-west-2a + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateFlexibleGpuResponse" description: The HTTP 200 response (OK). tags: - FlexibleGpu @@ -13045,15 +13147,13 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateImageRequest" examples: ex1: summary: Creating from a VM value: ImageName: create-image-example - VmId: i-12345678 NoReboot: true + VmId: i-12345678 ex2: summary: Copying an OMI value: @@ -13063,153 +13163,163 @@ paths: ex3: summary: Registering from a snapshot value: - ImageName: register-image-from-snapshot-example BlockDeviceMappings: - - DeviceName: "/dev/sda1" - Bsu: + - Bsu: + DeleteOnVmDeletion: true + Iops: 150 SnapshotId: snap-12345678 VolumeSize: 120 VolumeType: io1 - Iops: 150 - DeleteOnVmDeletion: true + DeviceName: "/dev/sda1" + ImageName: register-image-from-snapshot-example 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 + ImageName: register-image-from-bucket-example + schema: + "$ref": "#/components/schemas/CreateImageRequest" 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 + Architecture: x86_64 BlockDeviceMappings: - - DeviceName: "/dev/sda1" - Bsu: - VolumeType: standard + - Bsu: DeleteOnVmDeletion: true - VolumeSize: 50 SnapshotId: snap-12345678 - ImageType: machine + VolumeSize: 50 + VolumeType: standard + DeviceName: "/dev/sda1" + BootModes: + - legacy CreationDate: '2010-10-01T12:34:56.789Z' + Description: '' FileLocation: 123456789012/create-image-example - Architecture: x86_64 + ImageId: ami-12345678 ImageName: create-image-example + ImageType: machine + PermissionsToLaunch: + AccountIds: [] + GlobalPermission: false + ProductCodes: + - '0001' + RootDeviceName: "/dev/sda1" + RootDeviceType: bsu + State: pending + StateComment: {} + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Copying an OMI value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Image: - StateComment: {} - State: available - RootDeviceType: bsu - RootDeviceName: "/dev/sda1" - ProductCodes: - - '0001' - PermissionsToLaunch: - GlobalPermission: false - AccountIds: [] AccountId: '123456789012' - Tags: [] - Description: '' - ImageId: ami-12345678 + Architecture: x86_64 BlockDeviceMappings: - - DeviceName: "/dev/sda1" - Bsu: - VolumeType: standard + - Bsu: DeleteOnVmDeletion: true - VolumeSize: 50 SnapshotId: snap-12345678 - ImageType: machine + VolumeSize: 50 + VolumeType: standard + DeviceName: "/dev/sda1" + BootModes: + - legacy CreationDate: '2010-10-01T12:34:56.789Z' + Description: '' FileLocation: 123456789012/copy-image-example - Architecture: x86_64 + ImageId: ami-12345678 ImageName: copy-image-example + ImageType: machine + PermissionsToLaunch: + AccountIds: [] + GlobalPermission: false + ProductCodes: + - '0001' + RootDeviceName: "/dev/sda1" + RootDeviceType: bsu + State: available + StateComment: {} + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex3: summary: Registering from a snapshot value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Image: - StateComment: {} - State: available - RootDeviceType: bsu - RootDeviceName: "/dev/sda1" - ProductCodes: - - '0001' - PermissionsToLaunch: - GlobalPermission: false - AccountIds: [] AccountId: '123456789012' - Tags: [] - Description: '' - ImageId: ami-12345678 + Architecture: x86_64 BlockDeviceMappings: - - DeviceName: "/dev/sda1" - Bsu: - VolumeType: io1 + - Bsu: DeleteOnVmDeletion: true - VolumeSize: 120 Iops: 150 SnapshotId: snap-12345678 - ImageType: machine + VolumeSize: 120 + VolumeType: io1 + DeviceName: "/dev/sda1" + BootModes: + - legacy CreationDate: '2010-10-01T12:34:56.789Z' + Description: '' FileLocation: 123456789012/register-image-from-snapshot-example - Architecture: x86_64 + ImageId: ami-12345678 ImageName: register-image-from-snapshot-example + ImageType: machine + PermissionsToLaunch: + AccountIds: [] + GlobalPermission: false + ProductCodes: + - '0001' + RootDeviceName: "/dev/sda1" + RootDeviceType: bsu + State: available + StateComment: {} + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex4: summary: Registering from a bucket by using a manifest file value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Image: - StateComment: {} - State: pending - RootDeviceType: bsu - RootDeviceName: "/dev/sda1" - ProductCodes: - - '0001' - PermissionsToLaunch: - GlobalPermission: false - AccountIds: [] AccountId: '123456789012' - Tags: [] - Description: '' - ImageId: ami-12345678 + Architecture: x86_64 BlockDeviceMappings: - - DeviceName: "/dev/sda1" - Bsu: - VolumeType: standard + - Bsu: DeleteOnVmDeletion: true - VolumeSize: 50 SnapshotId: snap-12345678 - ImageType: machine + VolumeSize: 50 + VolumeType: standard + DeviceName: "/dev/sda1" + BootModes: + - legacy CreationDate: '2010-10-01T12:34:56.789Z' + Description: '' FileLocation: https://oos.eu-west-2.outscale.com/BUCKET/KEY?AWSAccessKeyId=ABCDEFGHIJ0123456789&Expires=1493372309&Signature=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - Architecture: x86_64 + ImageId: ami-12345678 ImageName: register-image-from-bucket-example + ImageType: machine + PermissionsToLaunch: + AccountIds: [] + GlobalPermission: false + ProductCodes: + - '0001' + RootDeviceName: "/dev/sda1" + RootDeviceType: bsu + State: pending + StateComment: {} + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateImageResponse" description: The HTTP 200 response (OK). '400': content: @@ -13246,8 +13356,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateImageExportTaskRequest" examples: ex1: value: @@ -13256,28 +13364,30 @@ paths: DiskImageFormat: qcow2 OsuBucket: BUCKET OsuPrefix: PREFIX + schema: + "$ref": "#/components/schemas/CreateImageExportTaskRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateImageExportTaskResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ImageExportTask: - Tags: [] - ImageId: ami-12345678 - TaskId: image-export-12345678 Comment: Export of image ami-12345678 + ImageId: ami-12345678 OsuExport: - OsuPrefix: PREFIX/ami-12345678/ - OsuBucket: BUCKET DiskImageFormat: qcow2 - State: pending/queued + OsuBucket: BUCKET + OsuPrefix: PREFIX/ami-12345678/ Progress: 0 + State: pending/queued + Tags: [] + TaskId: image-export-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateImageExportTaskResponse" description: The HTTP 200 response (OK). tags: - Image @@ -13291,26 +13401,26 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateInternetServiceRequest" examples: ex1: value: {} + schema: + "$ref": "#/components/schemas/CreateInternetServiceRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateInternetServiceResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 InternetService: - Tags: [] InternetServiceId: igw-12345678 - description: The HTTP 200 response (OK). + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateInternetServiceResponse" + description: The HTTP 200 response (OK). '400': content: application/json: @@ -13345,8 +13455,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateKeypairRequest" examples: ex1: summary: Creating a keypair @@ -13357,37 +13465,39 @@ paths: value: KeypairName: import-keypair-example PublicKey: "..." + schema: + "$ref": "#/components/schemas/CreateKeypairRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateKeypairResponse" examples: ex1: summary: Creating a keypair value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Keypair: + KeypairFingerprint: 11:22:33:44:55:66:77:88:99:00:aa:bb:cc:dd:ee:ff + KeypairId: key-abcdef1234567890abcdef1234567890 + KeypairName: create-keypair-example + KeypairType: ssh-rsa PrivateKey: |- -----BEGIN RSA PRIVATE KEY----- ... -----END RSA PRIVATE KEY----- - KeypairType: ssh-rsa - KeypairName: create-keypair-example - KeypairId: key-abcdef1234567890abcdef1234567890 - KeypairFingerprint: 11:22:33:44:55:66:77:88:99:00:aa:bb:cc:dd:ee:ff + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Importing a keypair created locally value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Keypair: - KeypairType: ssh-rsa - KeypairName: create-keypair-example - KeypairId: key-abcdef1234567890abcdef1234567890 KeypairFingerprint: 11:22:33:44:55:66:77:88:99:00:aa:bb:cc:dd:ee:ff + KeypairId: key-abcdef1234567890abcdef1234567890 + KeypairName: create-keypair-example + KeypairType: ssh-rsa + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateKeypairResponse" description: The HTTP 200 response (OK). '400': content: @@ -13425,8 +13535,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateListenerRuleRequest" examples: ex1: summary: Creating a listener rule based on a host pattern @@ -13449,46 +13557,48 @@ paths: LoadBalancerPort: 80 ListenerRule: Action: forward - PathPattern: "/docs/*" ListenerRuleName: example-listener-rule + PathPattern: "/docs/*" Priority: 100 VmIds: - i-12345678 + schema: + "$ref": "#/components/schemas/CreateListenerRuleRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateListenerRuleResponse" examples: ex1: summary: Creating a listener rule based on a host pattern value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ListenerRule: - Priority: 10 - VmIds: - - i-12345678 - ListenerRuleName: example-listener-rule Action: forward - ListenerId: 123456 HostNamePattern: "*.example.com" + ListenerId: 123456 ListenerRuleId: 1234 + ListenerRuleName: example-listener-rule + Priority: 10 + VmIds: + - i-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 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 + ListenerRuleName: example-listener-rule + PathPattern: "/docs/*" + Priority: 100 + VmIds: + - i-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateListenerRuleResponse" description: The HTTP 200 response (OK). tags: - Listener @@ -13504,173 +13614,173 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateLoadBalancerRequest" examples: ex1: summary: Creating an internal load balancer in a Net value: - LoadBalancerName: private-lb-example Listeners: - BackendPort: 80 BackendProtocol: TCP LoadBalancerPort: 80 LoadBalancerProtocol: TCP - Subnets: - - subnet-12345678 + LoadBalancerName: private-lb-example + LoadBalancerType: internal SecurityGroups: - sg-12345678 - LoadBalancerType: internal + Subnets: + - subnet-12345678 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 + LoadBalancerName: private-lb-example LoadBalancerType: internet-facing PublicIp: 192.0.2.0 + SecurityGroups: + - sg-12345678 + Subnets: + - subnet-12345678 ex3: summary: Creating an internet-facing load balancer in the public Cloud value: - LoadBalancerName: public-lb-example - SubregionNames: - - eu-west-2a Listeners: - BackendPort: 8080 BackendProtocol: HTTP LoadBalancerPort: 8080 LoadBalancerProtocol: HTTP + LoadBalancerName: public-lb-example + SubregionNames: + - eu-west-2a + schema: + "$ref": "#/components/schemas/CreateLoadBalancerRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateLoadBalancerResponse" examples: ex1: summary: Creating an internal load balancer in a Net value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 LoadBalancer: - Tags: [] - SourceSecurityGroup: - SecurityGroupName: security-group-example - SecurityGroupAccountId: '123456789012' - SecuredCookies: false - Subnets: - - subnet-12345678 - NetId: vpc-12345678 - BackendVmIds: [] - ApplicationStickyCookiePolicies: [] - SecurityGroups: - - sg-12345678 - LoadBalancerType: internal AccessLog: - PublicationInterval: 60 IsEnabled: false + PublicationInterval: 60 + ApplicationStickyCookiePolicies: [] + BackendVmIds: [] 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 + Protocol: TCP + Timeout: 5 + UnhealthyThreshold: 2 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: [] + LoadBalancerStickyCookiePolicies: [] + LoadBalancerType: internal + NetId: vpc-12345678 + SecuredCookies: false + SecurityGroups: + - sg-12345678 SourceSecurityGroup: - SecurityGroupName: security-group-example SecurityGroupAccountId: '123456789012' - SecuredCookies: false - PublicIp: 192.0.2.0 + SecurityGroupName: security-group-example Subnets: - subnet-12345678 - NetId: vpc-12345678 - BackendVmIds: [] - ApplicationStickyCookiePolicies: [] - SecurityGroups: - - sg-12345678 - LoadBalancerType: internet-facing + SubregionNames: + - eu-west-2a + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + summary: Creating an internet-facing load balancer in a Net + value: + LoadBalancer: AccessLog: - PublicationInterval: 60 IsEnabled: false + PublicationInterval: 60 + ApplicationStickyCookiePolicies: [] + BackendVmIds: [] 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 + Protocol: TCP + Timeout: 5 + UnhealthyThreshold: 2 Listeners: - - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate - BackendPort: 80 + - BackendPort: 80 BackendProtocol: HTTP LoadBalancerPort: 443 LoadBalancerProtocol: HTTPS + ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate LoadBalancerName: private-lb-example + LoadBalancerStickyCookiePolicies: [] + LoadBalancerType: internet-facing + NetId: vpc-12345678 + PublicIp: 192.0.2.0 + SecuredCookies: false + SecurityGroups: + - sg-12345678 + SourceSecurityGroup: + SecurityGroupAccountId: '123456789012' + SecurityGroupName: security-group-example + Subnets: + - subnet-12345678 + SubregionNames: + - eu-west-2a + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex3: summary: 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 + PublicationInterval: 60 + ApplicationStickyCookiePolicies: [] + BackendVmIds: [] 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 + Protocol: TCP + Timeout: 5 + UnhealthyThreshold: 2 Listeners: - BackendPort: 8080 BackendProtocol: HTTP LoadBalancerPort: 8080 LoadBalancerProtocol: HTTP LoadBalancerName: public-lb-example + LoadBalancerStickyCookiePolicies: [] + LoadBalancerType: internet-facing + SecuredCookies: false + SourceSecurityGroup: + SecurityGroupAccountId: outscale-elb + SecurityGroupName: outscale-elb-sg + Subnets: [] + SubregionNames: + - eu-west-2a + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateLoadBalancerResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer @@ -13683,56 +13793,38 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateLoadBalancerListenersRequest" examples: ex1: value: - LoadBalancerName: example-lbu Listeners: - BackendPort: 58 BackendProtocol: TCP LoadBalancerPort: 62 LoadBalancerProtocol: TCP + LoadBalancerName: example-lbu + schema: + "$ref": "#/components/schemas/CreateLoadBalancerListenersRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateLoadBalancerListenersResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 LoadBalancer: - Tags: [] - SourceSecurityGroup: - SecurityGroupName: security-group-example - SecurityGroupAccountId: '123456789012' - SecuredCookies: false - Subnets: - - subnet-12345678 - NetId: vpc-12345678 - BackendVmIds: [] - ApplicationStickyCookiePolicies: [] - SecurityGroups: - - sg-12345678 - LoadBalancerType: internal AccessLog: - PublicationInterval: 60 IsEnabled: false + PublicationInterval: 60 + ApplicationStickyCookiePolicies: [] + BackendVmIds: [] 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 + Protocol: TCP + Timeout: 5 + UnhealthyThreshold: 2 Listeners: - BackendPort: 58 BackendProtocol: TCP @@ -13743,6 +13835,24 @@ paths: LoadBalancerPort: 80 LoadBalancerProtocol: TCP LoadBalancerName: example-lbu + LoadBalancerStickyCookiePolicies: [] + LoadBalancerType: internal + NetId: vpc-12345678 + SecuredCookies: false + SecurityGroups: + - sg-12345678 + SourceSecurityGroup: + SecurityGroupAccountId: '123456789012' + SecurityGroupName: security-group-example + Subnets: + - subnet-12345678 + SubregionNames: + - eu-west-2a + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateLoadBalancerListenersResponse" description: The HTTP 200 response (OK). tags: - Listener @@ -13761,8 +13871,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateLoadBalancerPolicyRequest" examples: ex1: summary: Creating a load balancer policy based on browser @@ -13773,97 +13881,99 @@ paths: ex2: summary: Creating a load balancer policy based on application cookie value: + CookieName: example-cookie LoadBalancerName: example-lbu PolicyName: example-app-policy PolicyType: app - CookieName: example-cookie + schema: + "$ref": "#/components/schemas/CreateLoadBalancerPolicyRequest" 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 + PublicationInterval: 60 + ApplicationStickyCookiePolicies: [] + BackendVmIds: [] 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 + Protocol: TCP + Timeout: 5 + UnhealthyThreshold: 2 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: [] + LoadBalancerStickyCookiePolicies: + - CookieExpirationPeriod: 1 + PolicyName: example-browser-policy + LoadBalancerType: internet-facing + NetId: vpc-12345678 + SecurityGroups: + - sg-12345678 SourceSecurityGroup: - SecurityGroupName: default SecurityGroupAccountId: '123456789012' + SecurityGroupName: default Subnets: - subnet-12345678 - NetId: vpc-12345678 - BackendVmIds: [] - ApplicationStickyCookiePolicies: - - PolicyName: example-app-policy - CookieName: example-cookie - SecurityGroups: - - sg-12345678 - LoadBalancerType: internet-facing + SubregionNames: + - eu-west-2a + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + summary: Creating a load balancer policy based on application cookie + value: + LoadBalancer: AccessLog: - PublicationInterval: 60 IsEnabled: false + PublicationInterval: 60 + ApplicationStickyCookiePolicies: + - CookieName: example-cookie + PolicyName: example-app-policy + BackendVmIds: [] 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 + Protocol: TCP + Timeout: 5 + UnhealthyThreshold: 2 Listeners: - BackendPort: 80 BackendProtocol: HTTP LoadBalancerPort: 80 LoadBalancerProtocol: HTTP LoadBalancerName: example-lbu + LoadBalancerStickyCookiePolicies: [] + LoadBalancerType: internet-facing + NetId: vpc-12345678 + SecurityGroups: + - sg-12345678 + SourceSecurityGroup: + SecurityGroupAccountId: '123456789012' + SecurityGroupName: default + Subnets: + - subnet-12345678 + SubregionNames: + - eu-west-2a + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateLoadBalancerPolicyResponse" description: The HTTP 200 response (OK). tags: - LoadBalancerPolicy @@ -13877,8 +13987,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateLoadBalancerTagsRequest" examples: ex1: value: @@ -13887,17 +13995,19 @@ paths: Tags: - Key: key1 Value: value1 + schema: + "$ref": "#/components/schemas/CreateLoadBalancerTagsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateLoadBalancerTagsResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateLoadBalancerTagsResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer @@ -13916,33 +14026,33 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateNatServiceRequest" examples: ex1: value: - SubnetId: subnet-12345678 PublicIpId: eipalloc-12345678 + SubnetId: subnet-12345678 + schema: + "$ref": "#/components/schemas/CreateNatServiceRequest" 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 + PublicIps: + - PublicIp: 192.0.2.0 + PublicIpId: eipalloc-12345678 State: available + SubnetId: subnet-12345678 + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateNatServiceResponse" description: The HTTP 200 response (OK). '400': content: @@ -13974,30 +14084,30 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateNetRequest" examples: ex1: value: IpRange: 10.0.0.0/16 + schema: + "$ref": "#/components/schemas/CreateNetRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateNetResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Net: - Tags: [] DhcpOptionsSetId: dopt-12345678 IpRange: 10.0.0.0/16 - Tenancy: default NetId: vpc-12345678 State: available + Tags: [] + Tenancy: default + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateNetResponse" description: The HTTP 200 response (OK). '400': content: @@ -14037,8 +14147,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateNetAccessPointRequest" examples: ex1: value: @@ -14046,25 +14154,27 @@ paths: RouteTableIds: - rtb-12345678 ServiceName: com.outscale.eu-west-2.oos + schema: + "$ref": "#/components/schemas/CreateNetAccessPointRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateNetAccessPointResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 NetAccessPoint: - Tags: [] NetAccessPointId: vpce-12345678 + NetId: vpc-12345678 RouteTableIds: - rtb-12345678 - State: pending - NetId: vpc-12345678 ServiceName: com.outscale.eu-west-2.oos + State: pending + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateNetAccessPointResponse" description: The HTTP 200 response (OK). tags: - NetAccessPoint @@ -14084,67 +14194,67 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateNetPeeringRequest" examples: ex1: summary: Creating a Net peering between two Nets belonging to you value: - SourceNetId: vpc-12345678 AccepterNetId: vpc-87654321 + SourceNetId: vpc-12345678 ex2: summary: Creating a Net peering with a Net that belongs to another account value: - SourceNetId: vpc-12345678 AccepterNetId: vpc-87654321 AccepterOwnerId: '987654321098' + SourceNetId: vpc-12345678 + schema: + "$ref": "#/components/schemas/CreateNetPeeringRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateNetPeeringResponse" examples: ex1: summary: Creating a Net peering between two Nets belonging to you value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 NetPeering: - Tags: [] - State: - Name: pending-acceptance - Message: Pending acceptance by 123456789012 AccepterNet: - NetId: vpc-12345678 - IpRange: 172.16.0.0/16 AccountId: '123456789012' + IpRange: 172.16.0.0/16 + NetId: vpc-12345678 + NetPeeringId: pcx-12345678 SourceNet: - NetId: vpc-87654321 - IpRange: 10.0.0.0/16 AccountId: '123456789012' - NetPeeringId: pcx-12345678 + IpRange: 10.0.0.0/16 + NetId: vpc-87654321 + State: + Message: Pending acceptance by 123456789012 + Name: pending-acceptance + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Creating a Net peering with a Net that belongs to another account value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 NetPeering: - Tags: [] - State: - Name: pending-acceptance - Message: Pending acceptance by 123456789012 AccepterNet: - NetId: vpc-87654321 - IpRange: 172.16.0.0/16 AccountId: '987654321098' + IpRange: 172.16.0.0/16 + NetId: vpc-87654321 + NetPeeringId: pcx-12345678 SourceNet: - NetId: vpc-12345678 - IpRange: 10.0.0.0/16 AccountId: '123456789012' - NetPeeringId: pcx-12345678 + IpRange: 10.0.0.0/16 + NetId: vpc-12345678 + State: + Message: Pending acceptance by 123456789012 + Name: pending-acceptance + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateNetPeeringResponse" description: The HTTP 200 response (OK). '400': content: @@ -14175,85 +14285,85 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateNicRequest" examples: ex1: summary: Creating a NIC value: - SubnetId: subnet-12345678 SecurityGroupIds: - sg-12345678 + SubnetId: subnet-12345678 ex2: summary: Creating a NIC with specific private IPs value: Description: Terraform nic with private IPs - SubnetId: subnet-12345678 - SecurityGroupIds: - - sg-12345678 PrivateIps: - IsPrimary: true PrivateIp: 10.0.0.4 - IsPrimary: false PrivateIp: 10.0.0.5 + SecurityGroupIds: + - sg-12345678 + SubnetId: subnet-12345678 + schema: + "$ref": "#/components/schemas/CreateNicRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateNicResponse" examples: ex1: summary: Creating a NIC value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Nic: - 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 + Description: '' + IsSourceDestChecked: true MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - IsPrimary: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - IsPrimary: true + SecurityGroups: + - SecurityGroupId: sg-12345678 + SecurityGroupName: security-group-example + State: available + SubnetId: subnet-12345678 + SubregionName: eu-west-2a + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 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 + Description: '' + IsSourceDestChecked: true MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - IsPrimary: true + 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 + - IsPrimary: false + PrivateDnsName: ip-10-0-0-5.eu-west-2.compute.internal PrivateIp: 10.0.0.5 - IsPrimary: false + SecurityGroups: + - SecurityGroupId: sg-12345678 + SecurityGroupName: security-group-example + State: available + SubnetId: subnet-12345678 + SubregionName: eu-west-2a + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateNicResponse" description: The HTTP 200 response (OK). '400': content: @@ -14284,8 +14394,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreatePolicyRequest" examples: ex1: value: @@ -14294,28 +14402,30 @@ paths: "Resource": ["*"]} ]}' Path: "/example/" PolicyName: example-user-policy + schema: + "$ref": "#/components/schemas/CreatePolicyRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreatePolicyResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Policy: - ResourcesCount: 0 - PolicyName: example-user-policy - PolicyDefaultVersionId: v1 - Path: "/example/" CreationDate: 2010-10-01 12:34:56.789000000 +00:00 Description: Example of description - PolicyId: ABCDEFGHIJKLMNOPQRSTUVWXYZ01234 - Orn: orn:ows:idauth::012345678910:policy/example/example-user-policy IsLinkable: true LastModificationDate: 2010-10-01 12:34:56.789000000 +00:00 + Orn: orn:ows:idauth::012345678910:policy/example/example-user-policy + Path: "/example/" + PolicyDefaultVersionId: v1 + PolicyId: ABCDEFGHIJKLMNOPQRSTUVWXYZ01234 + PolicyName: example-user-policy + ResourcesCount: 0 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreatePolicyResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -14328,8 +14438,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreatePolicyVersionRequest" examples: ex1: value: @@ -14337,23 +14445,25 @@ paths: "Resource": ["*"]} ]}' PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy SetAsDefault: true + schema: + "$ref": "#/components/schemas/CreatePolicyVersionRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreatePolicyVersionResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 PolicyVersion: - VersionId: v2 - DefaultVersion: true - CreationDate: 2017-05-10 12:34:56.789000000 +00:00 Body: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], "Resource": ["*"]} ]}' + CreationDate: 2017-05-10 12:34:56.789000000 +00:00 + DefaultVersion: true + VersionId: v2 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreatePolicyVersionResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -14365,28 +14475,28 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateProductTypeRequest" examples: ex1: value: - Vendor: vendor-name Description: Example of description + Vendor: vendor-name + schema: + "$ref": "#/components/schemas/CreateProductTypeRequest" 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 + ProductTypeId: pty-12345678 + Vendor: vendor-name + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateProductTypeResponse" description: The HTTP 200 response (OK). tags: - ProductType @@ -14400,26 +14510,26 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreatePublicIpRequest" examples: ex1: value: {} + schema: + "$ref": "#/components/schemas/CreatePublicIpRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreatePublicIpResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 PublicIp: - Tags: [] - PublicIpId: eipalloc-12345678 PublicIp: 192.0.2.0 + PublicIpId: eipalloc-12345678 + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreatePublicIpResponse" description: The HTTP 200 response (OK). '400': content: @@ -14460,41 +14570,41 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateRouteRequest" examples: ex1: summary: Creating a route to an Internet service value: - RouteTableId: rtb-12345678 DestinationIpRange: 0.0.0.0/0 GatewayId: igw-12345678 + RouteTableId: rtb-12345678 + schema: + "$ref": "#/components/schemas/CreateRouteRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateRouteResponse" examples: ex1: summary: Creating a route to an Internet service value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 RouteTable: + LinkRouteTables: [] + NetId: vpc-12345678 + RoutePropagatingVirtualGateways: [] + RouteTableId: rtb-12345678 Routes: - - DestinationIpRange: 10.0.0.0/16 - CreationMethod: CreateRouteTable + - CreationMethod: CreateRouteTable + DestinationIpRange: 10.0.0.0/16 State: active - - GatewayId: igw-12345678 + - CreationMethod: CreateRoute DestinationIpRange: 0.0.0.0/0 - CreationMethod: CreateRoute + GatewayId: igw-12345678 State: active - LinkRouteTables: [] - NetId: vpc-12345678 Tags: [] - RoutePropagatingVirtualGateways: [] - RouteTableId: rtb-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateRouteResponse" description: The HTTP 200 response (OK). '400': content: @@ -14526,33 +14636,33 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateRouteTableRequest" examples: ex1: value: NetId: vpc-12345678 + schema: + "$ref": "#/components/schemas/CreateRouteTableRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateRouteTableResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 RouteTable: - Routes: - - DestinationIpRange: 10.0.0.0/16 - CreationMethod: CreateRouteTable - State: active LinkRouteTables: [] NetId: vpc-12345678 - Tags: [] RoutePropagatingVirtualGateways: [] RouteTableId: rtb-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Routes: + - CreationMethod: CreateRouteTable + DestinationIpRange: 10.0.0.0/16 + State: active + Tags: [] + schema: + "$ref": "#/components/schemas/CreateRouteTableResponse" description: The HTTP 200 response (OK). '400': content: @@ -14588,39 +14698,39 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateSecurityGroupRequest" examples: ex1: value: + Description: Security group example NetId: vpc-12345678 SecurityGroupName: security-group-example - Description: Security group example + schema: + "$ref": "#/components/schemas/CreateSecurityGroupRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateSecurityGroupResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 SecurityGroup: - Tags: [] - SecurityGroupName: security-group-example + AccountId: '123456789012' + Description: Example of security group + InboundRules: [] + NetId: vpc-12345678 OutboundRules: - FromPortRange: -1 IpProtocol: "-1" - ToPortRange: -1 IpRanges: - 0.0.0.0/0 + ToPortRange: -1 SecurityGroupId: sg-12345678 - AccountId: '123456789012' - Description: Example of security group - InboundRules: [] - NetId: vpc-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + SecurityGroupName: security-group-example + Tags: [] + schema: + "$ref": "#/components/schemas/CreateSecurityGroupResponse" description: The HTTP 200 response (OK). '400': content: @@ -14665,87 +14775,87 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateSecurityGroupRuleRequest" examples: ex1: summary: Creating an inbound rule from an IP range value: Flow: Inbound - SecurityGroupId: sg-12345678 FromPortRange: 80 - ToPortRange: 80 IpProtocol: tcp IpRange: 10.0.0.0/16 + SecurityGroupId: sg-12345678 + ToPortRange: 80 ex2: summary: Creating an inbound rule from another security group value: Flow: Inbound - SecurityGroupId: sg-12345678 Rules: - FromPortRange: 22 - ToPortRange: 22 IpProtocol: tcp SecurityGroupsMembers: - AccountId: '123456789012' SecurityGroupName: another-security-group + ToPortRange: 22 + SecurityGroupId: sg-12345678 + schema: + "$ref": "#/components/schemas/CreateSecurityGroupRuleRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateSecurityGroupRuleResponse" examples: ex1: summary: Creating an inbound rule from an IP range value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 SecurityGroup: - Tags: [] - SecurityGroupName: security-group-example - OutboundRules: - - FromPortRange: -1 - IpProtocol: "-1" - ToPortRange: -1 - IpRanges: - - 0.0.0.0/0 - SecurityGroupId: sg-12345678 AccountId: '123456789012' Description: Example of security group InboundRules: - FromPortRange: 80 IpProtocol: tcp - ToPortRange: 80 IpRanges: - 10.0.0.0/16 + ToPortRange: 80 NetId: vpc-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - ex2: - summary: Creating an inbound rule from another security group - value: - SecurityGroup: - Tags: [] - SecurityGroupName: security-group-example OutboundRules: - FromPortRange: -1 IpProtocol: "-1" - ToPortRange: -1 IpRanges: - 0.0.0.0/0 + ToPortRange: -1 SecurityGroupId: sg-12345678 + SecurityGroupName: security-group-example + Tags: [] + ex2: + summary: Creating an inbound rule from another security group + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + SecurityGroup: AccountId: '123456789012' Description: Example of security group InboundRules: - FromPortRange: 22 IpProtocol: tcp - ToPortRange: 22 SecurityGroupsMembers: - - SecurityGroupName: another-security-group + - AccountId: '987654321098' SecurityGroupId: sg-87654321 - AccountId: '987654321098' + SecurityGroupName: another-security-group + ToPortRange: 22 NetId: vpc-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + OutboundRules: + - FromPortRange: -1 + IpProtocol: "-1" + IpRanges: + - 0.0.0.0/0 + ToPortRange: -1 + SecurityGroupId: sg-12345678 + SecurityGroupName: security-group-example + Tags: [] + schema: + "$ref": "#/components/schemas/CreateSecurityGroupRuleResponse" description: The HTTP 200 response (OK). '400': content: @@ -14781,32 +14891,32 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateServerCertificateRequest" examples: ex1: value: - Name: server-cert-example Body: "..." Chain: "..." - PrivateKey: "..." + Name: server-cert-example Path: "/example/" + PrivateKey: "..." + schema: + "$ref": "#/components/schemas/CreateServerCertificateRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateServerCertificateResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ServerCertificate: - Path: "/example/" Id: ABCDEFGHIJKLMNOPQRSTUVWXYZ1234 - Orn: orn:ows:idauth::012345678910:server-certificate/example/server-cert-example Name: server-cert-example - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Orn: orn:ows:idauth::012345678910:server-certificate/example/server-cert-example + Path: "/example/" + schema: + "$ref": "#/components/schemas/CreateServerCertificateResponse" description: The HTTP 200 response (OK). tags: - ServerCertificate @@ -14827,87 +14937,87 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateSnapshotRequest" examples: ex1: summary: Creating from a volume value: - VolumeId: vol-12345678 Description: Snapshot created from a volume + VolumeId: vol-12345678 ex2: summary: Copying a snapshot value: - SourceSnapshotId: snap-12345678 - SourceRegionName: eu-west-2 Description: Snapshot created from another snapshot + SourceRegionName: eu-west-2 + SourceSnapshotId: snap-12345678 ex3: summary: Importing from a bucket value: + Description: Snapshot imported from a bucket FileLocation: https://oos.eu-west-2.outscale.com/BUCKET/KEY?AWSAccessKeyId=ABCDEFGHIJ0123456789&Expires=1493372309&Signature=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX SnapshotSize: 10737418240 - Description: Snapshot imported from a bucket + schema: + "$ref": "#/components/schemas/CreateSnapshotRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateSnapshotResponse" examples: ex1: summary: Creating from a volume value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Snapshot: - VolumeSize: 10 AccountId: '123456789012' - VolumeId: vol-12345678 CreationDate: '2010-10-01T12:34:56.789Z' + Description: Snapshot created from a volume PermissionsToCreateVolume: - GlobalPermission: false AccountIds: [] + GlobalPermission: false Progress: 0 SnapshotId: snap-12345678 State: pending/queued - Description: Snapshot created from a volume Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + VolumeId: vol-12345678 + VolumeSize: 10 ex2: summary: Copying a snapshot value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Snapshot: - VolumeSize: 10 AccountId: '123456789012' - VolumeId: vol-12345678 CreationDate: '2010-10-01T12:34:56.789Z' + Description: Snapshot copied from another snapshot PermissionsToCreateVolume: - GlobalPermission: false AccountIds: [] + GlobalPermission: false Progress: 100 SnapshotId: snap-12345678 State: completed - Description: Snapshot copied from another snapshot Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + VolumeId: vol-12345678 + VolumeSize: 10 ex3: summary: Importing from a bucket value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Snapshot: - VolumeSize: 10 AccountId: '123456789012' - VolumeId: vol-12345678 CreationDate: '2010-10-01T12:34:56.789Z' + Description: Snapshot imported from a bucket PermissionsToCreateVolume: - GlobalPermission: false AccountIds: [] + GlobalPermission: false Progress: 0 SnapshotId: snap-12345678 State: importing - Description: Snapshot imported from a bucket Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + VolumeId: vol-12345678 + VolumeSize: 10 + schema: + "$ref": "#/components/schemas/CreateSnapshotResponse" description: The HTTP 200 response (OK). '400': content: @@ -14939,38 +15049,38 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateSnapshotExportTaskRequest" examples: ex1: value: - SnapshotId: snap-12345678 OsuExport: DiskImageFormat: qcow2 OsuBucket: BUCKET OsuPrefix: PREFIX + SnapshotId: snap-12345678 + schema: + "$ref": "#/components/schemas/CreateSnapshotExportTaskRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateSnapshotExportTaskResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 SnapshotExportTask: - Tags: [] - TaskId: snap-export-12345678 Comment: Export of snapshot snap-12345678 OsuExport: - OsuPrefix: PREFIX - OsuBucket: BUCKET DiskImageFormat: qcow2 - State: pending - SnapshotId: snap-12345678 + OsuBucket: BUCKET + OsuPrefix: PREFIX Progress: 0 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + SnapshotId: snap-12345678 + State: pending + Tags: [] + TaskId: snap-export-12345678 + schema: + "$ref": "#/components/schemas/CreateSnapshotExportTaskResponse" description: The HTTP 200 response (OK). tags: - Snapshot @@ -14984,33 +15094,33 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateSubnetRequest" examples: ex1: value: - NetId: vpc-12345678 IpRange: 10.0.0.0/18 + NetId: vpc-12345678 + schema: + "$ref": "#/components/schemas/CreateSubnetRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateSubnetResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Subnet: - Tags: [] - SubregionName: eu-west-2a - SubnetId: subnet-12345678 AvailableIpsCount: 16379 IpRange: 10.0.0.0/18 MapPublicIpOnLaunch: false - State: available NetId: vpc-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + State: available + SubnetId: subnet-12345678 + SubregionName: eu-west-2a + Tags: [] + schema: + "$ref": "#/components/schemas/CreateSubnetResponse" description: The HTTP 200 response (OK). '400': content: @@ -15073,8 +15183,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateTagsRequest" examples: ex1: value: @@ -15083,17 +15191,19 @@ paths: Tags: - Key: key1 Value: value1 + schema: + "$ref": "#/components/schemas/CreateTagsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateTagsResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateTagsResponse" description: The HTTP 200 response (OK). '400': content: @@ -15124,32 +15234,32 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateUserRequest" examples: ex1: value: + Path: "/documentation/" UserEmail: user@example.com UserName: example-user - Path: "/documentation/" + schema: + "$ref": "#/components/schemas/CreateUserRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateUserResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 User: CreationDate: 2010-10-01 12:34:56.789000000 +00:00 LastModificationDate: 2017-05-10 12:34:56.789000000 +00:00 + Path: "/documentation/" UserEmail: user@example.com - UserName: example-user UserId: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 - Path: "/documentation/" - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + UserName: example-user + schema: + "$ref": "#/components/schemas/CreateUserResponse" description: The HTTP 200 response (OK). tags: - User @@ -15162,19 +15272,17 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateUserGroupRequest" examples: ex1: value: Path: "/example/" UserGroupName: example-usergroup + schema: + "$ref": "#/components/schemas/CreateUserGroupRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateUserGroupResponse" examples: ex1: value: @@ -15187,6 +15295,8 @@ paths: Orn: orn:ows:idauth::012345678910:usergroup/example/usergroup-example Path: "/example/" UserGroupId: ug-12345678 + schema: + "$ref": "#/components/schemas/CreateUserGroupResponse" description: The HTTP 200 response (OK). tags: - UserGroup @@ -15200,29 +15310,29 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateVirtualGatewayRequest" examples: ex1: value: ConnectionType: ipsec.1 + schema: + "$ref": "#/components/schemas/CreateVirtualGatewayRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateVirtualGatewayResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VirtualGateway: - VirtualGatewayId: vgw-12345678 ConnectionType: ipsec.1 NetToVirtualGatewayLinks: [] State: available Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + VirtualGatewayId: vgw-12345678 + schema: + "$ref": "#/components/schemas/CreateVirtualGatewayResponse" description: The HTTP 200 response (OK). tags: - VirtualGateway @@ -15238,8 +15348,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateVmGroupRequest" examples: ex1: value: @@ -15254,15 +15362,17 @@ paths: VmCount: 2 VmGroupName: ClusterLog-PPD01 VmTemplateId: vmtemplate-98765432109876543210987654321012 + schema: + "$ref": "#/components/schemas/CreateVmGroupRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateVmGroupResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VmGroup: CreationDate: '2010-10-01T12:34:56.789Z' Description: Production log collector @@ -15279,8 +15389,8 @@ paths: VmGroupName: ClusterLog-PPD01 VmIds: [] VmTemplateId: vmtemplate-98765432109876543210987654321012 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateVmGroupResponse" description: The HTTP 200 response (OK). '400': content: @@ -15314,8 +15424,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateVmTemplateRequest" examples: ex1: value: @@ -15330,30 +15438,32 @@ paths: - Key: key1 Value: value1 VmTemplateName: vmtemplate-example + schema: + "$ref": "#/components/schemas/CreateVmTemplateRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateVmTemplateResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VmTemplate: - VmTemplateName: vmtemplate-example + CpuCores: 2 + CpuGeneration: v4 CpuPerformance: high CreationDate: 2010-10-01 12:34:56.789000000 +00:00 - CpuCores: 2 + Description: Log collector template + ImageId: ami-12345678 + Ram: 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 + VmTemplateName: vmtemplate-example + schema: + "$ref": "#/components/schemas/CreateVmTemplateResponse" description: The HTTP 200 response (OK). tags: - VmTemplate @@ -15371,8 +15481,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateVmsRequest" examples: ex1: summary: Creating a VM (minimal syntax) @@ -15382,303 +15490,317 @@ paths: summary: Creating a VM in a Net value: ImageId: ami-12345678 - VmType: tinav5.c1r1p2 KeypairName: keypair-example SecurityGroupIds: - sg-12345678 SubnetId: subnet-12345678 UserData: "..." + VmType: tinav5.c1r1p2 ex3: summary: Creating a VM with block device mappings value: - ImageId: ami-12345678 - VmType: tinav5.c1r1p2 - KeypairName: keypair-example - SecurityGroupIds: - - sg-12345678 - SubnetId: subnet-12345678 - UserData: "..." BlockDeviceMappings: - - DeviceName: "/dev/sda1" - Bsu: + - Bsu: VolumeSize: 15 VolumeType: gp2 - - DeviceName: "/dev/sdb" - Bsu: + DeviceName: "/dev/sda1" + - Bsu: + Iops: 150 SnapshotId: snap-12345678 VolumeSize: 22 VolumeType: io1 - Iops: 150 + DeviceName: "/dev/sdb" + ImageId: ami-12345678 + KeypairName: keypair-example + SecurityGroupIds: + - sg-12345678 + SubnetId: subnet-12345678 + UserData: "..." + VmType: tinav5.c1r1p2 ex4: summary: Creating a VM with a NIC value: ImageId: ami-12345678 - VmType: tinav5.c1r1p2 KeypairName: keypair-example - UserData: "..." Nics: - DeviceNumber: 0 NicId: eni-12345678 + UserData: "..." + VmType: tinav5.c1r1p2 + schema: + "$ref": "#/components/schemas/CreateVmsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateVmsResponse" examples: ex1: summary: Creating a VM (minimal syntax) value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Vms: - - VmType: t2.small - VmInitiatedShutdownBehavior: stop - State: pending - StateReason: '' - RootDeviceType: ebs - RootDeviceName: "/dev/sda1" - IsSourceDestChecked: true - ImageId: ami-12345678 - DeletionProtection: false + - ActionsOnNextBoot: + SecureBoot: none Architecture: x86_64 - NestedVirtualization: false BlockDeviceMappings: - - DeviceName: "/dev/sda1" - Bsu: - VolumeId: vol-12345678 - State: attaching - LinkDate: '2010-10-01T12:34:56.789Z' + - Bsu: DeleteOnVmDeletion: true - VmId: i-12345678 - ReservationId: r-12345678 + LinkDate: '2010-10-01T12:34:56.789Z' + State: attaching + VolumeId: vol-12345678 + DeviceName: "/dev/sda1" + BootMode: legacy + BsuOptimized: false + CreationDate: '2010-10-01T12:34:56.789Z' + DeletionProtection: false Hypervisor: xen + ImageId: ami-12345678 + IsSourceDestChecked: true + LaunchNumber: 0 + NestedVirtualization: false + Performance: medium Placement: - Tenancy: default SubregionName: eu-west-2a - ProductCodes: - - '0001' - CreationDate: '2010-10-01T12:34:56.789Z' - UserData: "..." + Tenancy: default + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 + ProductCodes: + - '0001' + ReservationId: r-12345678 + RootDeviceName: "/dev/sda1" + RootDeviceType: ebs SecurityGroups: - - SecurityGroupName: default - SecurityGroupId: sg-12345678 - BsuOptimized: false - LaunchNumber: 0 - Performance: medium + - SecurityGroupId: sg-12345678 + SecurityGroupName: default + State: pending + StateReason: '' Tags: [] - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + UserData: "..." + VmId: i-12345678 + VmInitiatedShutdownBehavior: stop + VmType: t2.small ex2: summary: Creating a VM in a Net value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Vms: - - VmType: tinav5.c1r1p2 - VmInitiatedShutdownBehavior: stop - State: pending - StateReason: '' - RootDeviceType: ebs - RootDeviceName: "/dev/sda1" - IsSourceDestChecked: true - KeypairName: keypair-example - ImageId: ami-12345678 - DeletionProtection: false + - ActionsOnNextBoot: + SecureBoot: none Architecture: x86_64 - NestedVirtualization: false BlockDeviceMappings: - - DeviceName: "/dev/sda1" - Bsu: - VolumeId: vol-12345678 - State: attaching - LinkDate: '2010-10-01T12:34:56.789Z' + - Bsu: 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 + LinkDate: '2010-10-01T12:34:56.789Z' + State: attaching + VolumeId: vol-12345678 + DeviceName: "/dev/sda1" + BootMode: legacy BsuOptimized: false + CreationDate: '2010-10-01T12:34:56.789Z' + DeletionProtection: false + Hypervisor: xen + ImageId: ami-12345678 + IsSourceDestChecked: true + KeypairName: keypair-example LaunchNumber: 0 + NestedVirtualization: false NetId: vpc-12345678 Nics: - - SubnetId: subnet-12345678 - State: in-use + - AccountId: '123456789012' + Description: Primary network interface + IsSourceDestChecked: true LinkNic: - State: attached + DeleteOnVmDeletion: true 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 + State: attached MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - IsPrimary: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - IsPrimary: true + SecurityGroups: + - SecurityGroupId: sg-12345678 + SecurityGroupName: security-group-example + State: in-use + SubnetId: subnet-12345678 Performance: high - Tags: [] + Placement: + SubregionName: eu-west-2a + Tenancy: default PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + PrivateIp: 10.0.0.4 + ProductCodes: + - '0001' + ReservationId: r-12345678 + RootDeviceName: "/dev/sda1" + RootDeviceType: ebs + SecurityGroups: + - SecurityGroupId: sg-12345678 + SecurityGroupName: security-group-example + State: pending + StateReason: '' + SubnetId: subnet-12345678 + Tags: [] + UserData: "..." + VmId: i-12345678 + VmInitiatedShutdownBehavior: stop + VmType: tinav5.c1r1p2 ex3: summary: Creating a VM with block device mappings value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Vms: - - VmType: tinav5.c1r1p2 - VmInitiatedShutdownBehavior: stop - State: pending - StateReason: '' - RootDeviceType: ebs - RootDeviceName: "/dev/sda1" - IsSourceDestChecked: true - KeypairName: keypair-example - ImageId: ami-12345678 - DeletionProtection: false + - ActionsOnNextBoot: + SecureBoot: none Architecture: x86_64 - NestedVirtualization: false BlockDeviceMappings: - - DeviceName: "/dev/sda1" - Bsu: - VolumeId: vol-12345678 - State: attaching - LinkDate: '2010-10-01T12:34:56.789Z' + - Bsu: DeleteOnVmDeletion: true - - DeviceName: "/dev/sda1" - Bsu: - VolumeId: vol-87654321 - State: attaching LinkDate: '2010-10-01T12:34:56.789Z' + State: attaching + VolumeId: vol-12345678 + DeviceName: "/dev/sda1" + - Bsu: 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 + LinkDate: '2010-10-01T12:34:56.789Z' + State: attaching + VolumeId: vol-87654321 + DeviceName: "/dev/sda1" + BootMode: legacy BsuOptimized: false + CreationDate: '2010-10-01T12:34:56.789Z' + DeletionProtection: false + Hypervisor: xen + ImageId: ami-12345678 + IsSourceDestChecked: true + KeypairName: keypair-example LaunchNumber: 0 + NestedVirtualization: false NetId: vpc-12345678 Nics: - - SubnetId: subnet-12345678 - State: in-use + - AccountId: '123456789012' + Description: Primary network interface + IsSourceDestChecked: true LinkNic: - State: attached + DeleteOnVmDeletion: true 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 + State: attached MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - IsPrimary: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - IsPrimary: true + SecurityGroups: + - SecurityGroupId: sg-12345678 + SecurityGroupName: security-group-example + State: in-use + SubnetId: subnet-12345678 Performance: high - Tags: [] + Placement: + SubregionName: eu-west-2a + Tenancy: default PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + PrivateIp: 10.0.0.4 + ProductCodes: + - '0001' + ReservationId: r-12345678 + RootDeviceName: "/dev/sda1" + RootDeviceType: ebs + SecurityGroups: + - SecurityGroupId: sg-12345678 + SecurityGroupName: security-group-example + State: pending + StateReason: '' + SubnetId: subnet-12345678 + Tags: [] + UserData: "..." + VmId: i-12345678 + VmInitiatedShutdownBehavior: stop + VmType: tinav5.c1r1p2 ex4: summary: Creating a VM with a NIC value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Vms: - - VmType: tinav5.c1r1p2 - VmInitiatedShutdownBehavior: stop - State: pending - StateReason: '' - RootDeviceType: ebs - RootDeviceName: "/dev/sda1" - IsSourceDestChecked: true - KeypairName: keypair-example - ImageId: ami-12345678 - DeletionProtection: false + - ActionsOnNextBoot: + SecureBoot: none Architecture: x86_64 - NestedVirtualization: false BlockDeviceMappings: - - DeviceName: "/dev/sda1" - Bsu: - VolumeId: vol-12345678 - State: attaching - LinkDate: '2010-10-01T12:34:56.789Z' + - Bsu: 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 + LinkDate: '2010-10-01T12:34:56.789Z' + State: attaching + VolumeId: vol-12345678 + DeviceName: "/dev/sda1" + BootMode: legacy BsuOptimized: false + CreationDate: '2010-10-01T12:34:56.789Z' + DeletionProtection: false + Hypervisor: xen + ImageId: ami-12345678 + IsSourceDestChecked: true + KeypairName: keypair-example LaunchNumber: 0 + NestedVirtualization: false NetId: vpc-12345678 Nics: - - SubnetId: subnet-12345678 - State: in-use + - AccountId: '123456789012' + Description: Example NIC + IsSourceDestChecked: true LinkNic: - State: attached + DeleteOnVmDeletion: true 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 + State: attached MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - IsPrimary: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - IsPrimary: true + SecurityGroups: + - SecurityGroupId: sg-12345678 + SecurityGroupName: security-group-example + State: in-use + SubnetId: subnet-12345678 Performance: high - Tags: [] + Placement: + SubregionName: eu-west-2a + Tenancy: default PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + PrivateIp: 10.0.0.4 + ProductCodes: + - '0001' + ReservationId: r-12345678 + RootDeviceName: "/dev/sda1" + RootDeviceType: ebs + SecurityGroups: + - SecurityGroupId: sg-12345678 + SecurityGroupName: security-group-example + State: pending + StateReason: '' + SubnetId: subnet-12345678 + Tags: [] + UserData: "..." + VmId: i-12345678 + VmInitiatedShutdownBehavior: stop + VmType: tinav5.c1r1p2 + schema: + "$ref": "#/components/schemas/CreateVmsResponse" description: The HTTP 200 response (OK). '400': content: @@ -15711,61 +15833,61 @@ paths: requestBody: content: 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 + Size: 10 + SubregionName: eu-west-2a + VolumeType: io1 ex2: summary: Creating a volume from a snapshot value: + Size: 10 SnapshotId: snap-12345678 - VolumeType: gp2 SubregionName: eu-west-2a - Size: 10 + VolumeType: gp2 + schema: + "$ref": "#/components/schemas/CreateVolumeRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateVolumeResponse" examples: ex1: summary: Creating an io1 volume value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Volume: - VolumeId: vol-12345678 - Tags: [] - VolumeType: io1 - SubregionName: eu-west-2a - State: creating CreationDate: '2010-10-01T12:34:56.789Z' Iops: 100 LinkedVolumes: [] Size: 10 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + State: creating + SubregionName: eu-west-2a + Tags: [] + VolumeId: vol-12345678 + VolumeType: io1 ex2: summary: Creating a volume from a snapshot value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Volume: - VolumeId: vol-12345678 - Tags: [] - VolumeType: gp2 - SubregionName: eu-west-2a - State: creating - SnapshotId: snap-12345678 CreationDate: '2010-10-01T12:34:56.789Z' Iops: 100 LinkedVolumes: [] Size: 10 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + SnapshotId: snap-12345678 + State: creating + SubregionName: eu-west-2a + Tags: [] + VolumeId: vol-12345678 + VolumeType: gp2 + schema: + "$ref": "#/components/schemas/CreateVolumeResponse" description: The HTTP 200 response (OK). '400': content: @@ -15800,41 +15922,41 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateVpnConnectionRequest" examples: ex1: value: ClientGatewayId: cgw-12345678 - VirtualGatewayId: vgw-12345678 ConnectionType: ipsec.1 StaticRoutesOnly: true + VirtualGatewayId: vgw-12345678 + schema: + "$ref": "#/components/schemas/CreateVpnConnectionRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateVpnConnectionResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VpnConnection: - Routes: [] - Tags: [] ClientGatewayConfiguration: "..." - StaticRoutesOnly: true - VirtualGatewayId: vgw-12345678 - ConnectionType: ipsec.1 ClientGatewayId: cgw-12345678 + ConnectionType: ipsec.1 + Routes: [] State: pending + StaticRoutesOnly: true + Tags: [] VgwTelemetries: - - StateDescription: IPSEC IS DOWN - AcceptedRouteCount: 0 + - AcceptedRouteCount: 0 LastStateChangeDate: '2017-05-10T12:34:56.789Z' OutsideIpAddress: 192.0.2.0 + StateDescription: IPSEC IS DOWN + VirtualGatewayId: vgw-12345678 VpnConnectionId: vpn-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateVpnConnectionResponse" description: The HTTP 200 response (OK). tags: - VpnConnection @@ -15848,24 +15970,24 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateVpnConnectionRouteRequest" examples: ex1: value: - VpnConnectionId: vpn-12345678 DestinationIpRange: 10.0.0.0/16 + VpnConnectionId: vpn-12345678 + schema: + "$ref": "#/components/schemas/CreateVpnConnectionRouteRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateVpnConnectionRouteResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateVpnConnectionRouteResponse" description: The HTTP 200 response (OK). tags: - VpnConnection @@ -15878,8 +16000,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteAccessKeyRequest" examples: ex1: summary: Deleting one of your own access keys (if you are the root @@ -15891,17 +16011,19 @@ paths: value: AccessKeyId: ABCDEFGHIJ0123456789 UserName: example-user + schema: + "$ref": "#/components/schemas/DeleteAccessKeyRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteAccessKeyResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteAccessKeyResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -15919,23 +16041,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteApiAccessRuleRequest" examples: ex1: value: ApiAccessRuleId: aar-1234567890abcdef1234567890abcdef + schema: + "$ref": "#/components/schemas/DeleteApiAccessRuleRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteApiAccessRuleResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteApiAccessRuleResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -15949,23 +16071,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteCaRequest" examples: ex1: value: CaId: ca-fedcba0987654321fedcba0987654321 + schema: + "$ref": "#/components/schemas/DeleteCaRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteCaResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteCaResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -15981,23 +16103,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteClientGatewayRequest" examples: ex1: value: ClientGatewayId: cgw-12345678 + schema: + "$ref": "#/components/schemas/DeleteClientGatewayRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteClientGatewayResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteClientGatewayResponse" description: The HTTP 200 response (OK). tags: - ClientGateway @@ -16018,8 +16140,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteDedicatedGroupRequest" examples: ex1: summary: Deleting a dedicated group without any resource in it. @@ -16031,17 +16151,19 @@ paths: value: DedicatedGroupId: ded-12345678 Force: true + schema: + "$ref": "#/components/schemas/DeleteDedicatedGroupRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteDedicatedGroupResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteDedicatedGroupResponse" description: The HTTP 200 response (OK). '400': content: @@ -16075,23 +16197,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteDhcpOptionsRequest" examples: ex1: value: DhcpOptionsSetId: dopt-12345678 + schema: + "$ref": "#/components/schemas/DeleteDhcpOptionsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteDhcpOptionsResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteDhcpOptionsResponse" description: The HTTP 200 response (OK). tags: - DhcpOption @@ -16104,23 +16226,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteDirectLinkRequest" examples: ex1: value: DirectLinkId: dxcon-12345678 + schema: + "$ref": "#/components/schemas/DeleteDirectLinkRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteDirectLinkResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteDirectLinkResponse" description: The HTTP 200 response (OK). tags: - DirectLink @@ -16131,23 +16253,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteDirectLinkInterfaceRequest" examples: ex1: value: DirectLinkInterfaceId: dxvif-12345678 + schema: + "$ref": "#/components/schemas/DeleteDirectLinkInterfaceRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteDirectLinkInterfaceResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteDirectLinkInterfaceResponse" description: The HTTP 200 response (OK). tags: - DirectLinkInterface @@ -16160,8 +16282,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteExportTaskRequest" examples: ex1: summary: Deleting an image export task @@ -16171,12 +16291,12 @@ paths: summary: Deleting a snapshot export task value: ExportTaskId: snap-export-12345678 + schema: + "$ref": "#/components/schemas/DeleteExportTaskRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteExportTaskResponse" examples: ex1: summary: Deleting an image export task @@ -16188,6 +16308,8 @@ paths: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteExportTaskResponse" description: The HTTP 200 response (OK). tags: - Task @@ -16200,23 +16322,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteFlexibleGpuRequest" examples: ex1: value: FlexibleGpuId: fgpu-12345678 + schema: + "$ref": "#/components/schemas/DeleteFlexibleGpuRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteFlexibleGpuResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteFlexibleGpuResponse" description: The HTTP 200 response (OK). tags: - FlexibleGpu @@ -16229,23 +16351,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteImageRequest" examples: ex1: value: ImageId: ami-12345678 + schema: + "$ref": "#/components/schemas/DeleteImageRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteImageResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteImageResponse" description: The HTTP 200 response (OK). '400': content: @@ -16276,23 +16398,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteInternetServiceRequest" examples: ex1: value: InternetServiceId: igw-12345678 + schema: + "$ref": "#/components/schemas/DeleteInternetServiceRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteInternetServiceResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteInternetServiceResponse" description: The HTTP 200 response (OK). '400': content: @@ -16323,8 +16445,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteKeypairRequest" examples: ex1: summary: Deleting a keypair with its name @@ -16334,17 +16454,19 @@ paths: summary: Deleting a keypair with its ID value: KeypairId: key-abcdef1234567890abcdef1234567890 + schema: + "$ref": "#/components/schemas/DeleteKeypairRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteKeypairResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteKeypairResponse" description: The HTTP 200 response (OK). '400': content: @@ -16375,23 +16497,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteListenerRuleRequest" examples: ex1: value: ListenerRuleName: example-listener-rule + schema: + "$ref": "#/components/schemas/DeleteListenerRuleRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteListenerRuleResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteListenerRuleResponse" description: The HTTP 200 response (OK). tags: - Listener @@ -16402,23 +16524,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteLoadBalancerRequest" examples: ex1: value: LoadBalancerName: example-lbu + schema: + "$ref": "#/components/schemas/DeleteLoadBalancerRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteLoadBalancerResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteLoadBalancerResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer @@ -16429,55 +16551,55 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteLoadBalancerListenersRequest" examples: ex1: value: LoadBalancerName: example-lbu LoadBalancerPorts: - 80 + schema: + "$ref": "#/components/schemas/DeleteLoadBalancerListenersRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteLoadBalancerListenersResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 LoadBalancer: - Tags: [] - SourceSecurityGroup: - SecurityGroupName: security-group-example - SecurityGroupAccountId: '123456789012' - SecuredCookies: false - Subnets: - - subnet-12345678 - NetId: vpc-12345678 - BackendVmIds: [] - ApplicationStickyCookiePolicies: [] - SecurityGroups: - - sg-12345678 - LoadBalancerType: internal AccessLog: - PublicationInterval: 60 IsEnabled: false + PublicationInterval: 60 + ApplicationStickyCookiePolicies: [] + BackendVmIds: [] DnsName: internal-example-lbu.123456789.eu-west-2.lbu.outscale.com HealthCheck: - UnhealthyThreshold: 2 - Timeout: 5 CheckInterval: 30 - Protocol: TCP HealthyThreshold: 10 Port: 80 + Protocol: TCP + Timeout: 5 + UnhealthyThreshold: 2 + Listeners: [] + LoadBalancerName: example-lbu LoadBalancerStickyCookiePolicies: [] + LoadBalancerType: internal + NetId: vpc-12345678 + SecuredCookies: false + SecurityGroups: + - sg-12345678 + SourceSecurityGroup: + SecurityGroupAccountId: '123456789012' + SecurityGroupName: security-group-example + Subnets: + - subnet-12345678 SubregionNames: - eu-west-2a - Listeners: [] - LoadBalancerName: example-lbu + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteLoadBalancerListenersResponse" description: The HTTP 200 response (OK). tags: - Listener @@ -16490,59 +16612,59 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteLoadBalancerPolicyRequest" examples: ex1: value: LoadBalancerName: example-lbu PolicyName: example-browser-policy + schema: + "$ref": "#/components/schemas/DeleteLoadBalancerPolicyRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteLoadBalancerPolicyResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 LoadBalancer: - Tags: [] - SourceSecurityGroup: - SecurityGroupName: default - SecurityGroupAccountId: '123456789012' - SecuredCookies: false - PublicIp: 192.0.2.0 - Subnets: - - subnet-12345678 - NetId: vpc-12345678 - BackendVmIds: [] - ApplicationStickyCookiePolicies: [] - SecurityGroups: - - sg-12345678 - LoadBalancerType: internet-facing AccessLog: - PublicationInterval: 60 IsEnabled: false + PublicationInterval: 60 + ApplicationStickyCookiePolicies: [] + BackendVmIds: [] 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 + Protocol: TCP + Timeout: 5 + UnhealthyThreshold: 2 Listeners: - BackendPort: 80 BackendProtocol: HTTP LoadBalancerPort: 80 LoadBalancerProtocol: HTTP LoadBalancerName: example-lbu + LoadBalancerStickyCookiePolicies: [] + LoadBalancerType: internet-facing + NetId: vpc-12345678 + PublicIp: 192.0.2.0 + SecuredCookies: false + SecurityGroups: + - sg-12345678 + SourceSecurityGroup: + SecurityGroupAccountId: '123456789012' + SecurityGroupName: default + Subnets: + - subnet-12345678 + SubregionNames: + - eu-west-2a + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteLoadBalancerPolicyResponse" description: The HTTP 200 response (OK). tags: - LoadBalancerPolicy @@ -16553,8 +16675,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteLoadBalancerTagsRequest" examples: ex1: value: @@ -16562,17 +16682,19 @@ paths: - example-lbu Tags: - Key: key1 + schema: + "$ref": "#/components/schemas/DeleteLoadBalancerTagsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteLoadBalancerTagsResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteLoadBalancerTagsResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer @@ -16585,23 +16707,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteNatServiceRequest" examples: ex1: value: NatServiceId: nat-12345678 + schema: + "$ref": "#/components/schemas/DeleteNatServiceRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteNatServiceResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteNatServiceResponse" description: The HTTP 200 response (OK). '400': content: @@ -16642,23 +16764,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteNetRequest" examples: ex1: value: NetId: vpc-12345678 + schema: + "$ref": "#/components/schemas/DeleteNetRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteNetResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteNetResponse" description: The HTTP 200 response (OK). '400': content: @@ -16689,23 +16811,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteNetAccessPointRequest" examples: ex1: value: NetAccessPointId: vpce-12345678 + schema: + "$ref": "#/components/schemas/DeleteNetAccessPointRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteNetAccessPointResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteNetAccessPointResponse" description: The HTTP 200 response (OK). tags: - NetAccessPoint @@ -16719,24 +16841,24 @@ paths: operationId: DeleteNetPeering requestBody: content: - application/json: - schema: - "$ref": "#/components/schemas/DeleteNetPeeringRequest" + application/json: examples: ex1: value: NetPeeringId: pcx-12345678 + schema: + "$ref": "#/components/schemas/DeleteNetPeeringRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteNetPeeringResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteNetPeeringResponse" description: The HTTP 200 response (OK). '400': content: @@ -16773,23 +16895,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteNicRequest" examples: ex1: value: NicId: eni-12345678 + schema: + "$ref": "#/components/schemas/DeleteNicRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteNicResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteNicResponse" description: The HTTP 200 response (OK). '400': content: @@ -16820,23 +16942,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeletePolicyRequest" examples: ex1: value: PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy + schema: + "$ref": "#/components/schemas/DeletePolicyRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeletePolicyResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeletePolicyResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -16848,24 +16970,24 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeletePolicyVersionRequest" examples: ex1: value: PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy VersionId: v1 + schema: + "$ref": "#/components/schemas/DeletePolicyVersionRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeletePolicyVersionResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeletePolicyVersionResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -16881,23 +17003,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteProductTypeRequest" examples: ex1: value: ProductTypeId: pty-12345678 + schema: + "$ref": "#/components/schemas/DeleteProductTypeRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteProductTypeResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteProductTypeResponse" description: The HTTP 200 response (OK). '400': content: @@ -16928,23 +17050,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeletePublicIpRequest" examples: ex1: value: PublicIp: 192.0.2.0 + schema: + "$ref": "#/components/schemas/DeletePublicIpRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeletePublicIpResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeletePublicIpResponse" description: The HTTP 200 response (OK). '400': content: @@ -16973,34 +17095,34 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteRouteRequest" examples: ex1: value: - RouteTableId: rtb-12345678 DestinationIpRange: 198.51.100.0/24 + RouteTableId: rtb-12345678 + schema: + "$ref": "#/components/schemas/DeleteRouteRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteRouteResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 RouteTable: - Routes: - - DestinationIpRange: 10.0.0.0/16 - CreationMethod: CreateRouteTable - State: active LinkRouteTables: [] NetId: vpc-12345678 - Tags: [] RoutePropagatingVirtualGateways: [] RouteTableId: rtb-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Routes: + - CreationMethod: CreateRouteTable + DestinationIpRange: 10.0.0.0/16 + State: active + Tags: [] + schema: + "$ref": "#/components/schemas/DeleteRouteResponse" description: The HTTP 200 response (OK). '400': content: @@ -17031,23 +17153,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteRouteTableRequest" examples: ex1: value: RouteTableId: rtb-12345678 + schema: + "$ref": "#/components/schemas/DeleteRouteTableRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteRouteTableResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteRouteTableResponse" description: The HTTP 200 response (OK). '400': content: @@ -17079,23 +17201,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteSecurityGroupRequest" examples: ex1: value: SecurityGroupId: sg-12345678 + schema: + "$ref": "#/components/schemas/DeleteSecurityGroupRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteSecurityGroupResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteSecurityGroupResponse" description: The HTTP 200 response (OK). '400': content: @@ -17128,75 +17250,75 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteSecurityGroupRuleRequest" examples: ex1: summary: Deleting an inbound rule from an IP range value: Flow: Inbound - SecurityGroupId: sg-12345678 FromPortRange: 80 - ToPortRange: 80 IpProtocol: tcp IpRange: 10.0.0.0/16 + SecurityGroupId: sg-12345678 + ToPortRange: 80 ex2: summary: Deleting an inbound rule from another security group value: Flow: Inbound - SecurityGroupId: sg-12345678 Rules: - FromPortRange: 22 - ToPortRange: 22 IpProtocol: tcp SecurityGroupsMembers: - AccountId: '123456789012' SecurityGroupName: another-security-group + ToPortRange: 22 + SecurityGroupId: sg-12345678 + schema: + "$ref": "#/components/schemas/DeleteSecurityGroupRuleRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteSecurityGroupRuleResponse" examples: ex1: summary: Deleting an inbound rule from an IP range value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 SecurityGroup: - Tags: [] - SecurityGroupName: security-group-example + AccountId: '123456789012' + Description: Example of security group + InboundRules: [] + NetId: vpc-12345678 OutboundRules: - FromPortRange: -1 IpProtocol: "-1" - ToPortRange: -1 IpRanges: - 0.0.0.0/0 + ToPortRange: -1 SecurityGroupId: sg-12345678 - AccountId: '123456789012' - Description: Example of security group - InboundRules: [] - NetId: vpc-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + SecurityGroupName: security-group-example + Tags: [] ex2: summary: Creating an inbound rule from another security group value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 SecurityGroup: - Tags: [] - SecurityGroupName: security-group-example + AccountId: '123456789012' + Description: Example of security group + InboundRules: [] + NetId: vpc-12345678 OutboundRules: - FromPortRange: -1 IpProtocol: "-1" - ToPortRange: -1 IpRanges: - 0.0.0.0/0 + ToPortRange: -1 SecurityGroupId: sg-12345678 - AccountId: '123456789012' - Description: Example of security group - InboundRules: [] - NetId: vpc-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + SecurityGroupName: security-group-example + Tags: [] + schema: + "$ref": "#/components/schemas/DeleteSecurityGroupRuleResponse" description: The HTTP 200 response (OK). '400': content: @@ -17225,23 +17347,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteServerCertificateRequest" examples: ex1: value: Name: server-cert-example + schema: + "$ref": "#/components/schemas/DeleteServerCertificateRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteServerCertificateResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteServerCertificateResponse" description: The HTTP 200 response (OK). tags: - ServerCertificate @@ -17254,23 +17376,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteSnapshotRequest" examples: ex1: value: SnapshotId: snap-12345678 + schema: + "$ref": "#/components/schemas/DeleteSnapshotRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteSnapshotResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteSnapshotResponse" description: The HTTP 200 response (OK). '400': content: @@ -17306,23 +17428,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteSubnetRequest" examples: ex1: value: SubnetId: subnet-12345678 + schema: + "$ref": "#/components/schemas/DeleteSubnetRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteSubnetResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteSubnetResponse" description: The HTTP 200 response (OK). '400': content: @@ -17351,8 +17473,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteTagsRequest" examples: ex1: value: @@ -17361,17 +17481,19 @@ paths: Tags: - Key: key1 Value: value1 + schema: + "$ref": "#/components/schemas/DeleteTagsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteTagsResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteTagsResponse" description: The HTTP 200 response (OK). '400': content: @@ -17401,23 +17523,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteUserRequest" examples: ex1: value: UserName: example-user + schema: + "$ref": "#/components/schemas/DeleteUserRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteUserResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteUserResponse" description: The HTTP 200 response (OK). tags: - User @@ -17433,25 +17555,25 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteUserGroupRequest" examples: ex1: value: Force: false Path: "/example/" UserGroupName: example-usergroup + schema: + "$ref": "#/components/schemas/DeleteUserGroupRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteUserGroupResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteUserGroupResponse" description: The HTTP 200 response (OK). tags: - UserGroup @@ -17462,25 +17584,25 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteUserGroupPolicyRequest" examples: ex1: value: PolicyName: example-usergroup-policy UserGroupName: example-usergroup UserGroupPath: "/example/" + schema: + "$ref": "#/components/schemas/DeleteUserGroupPolicyRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteUserGroupPolicyResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteUserGroupPolicyResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -17491,24 +17613,24 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteUserPolicyRequest" examples: ex1: value: PolicyName: example-user-policy UserName: example-user + schema: + "$ref": "#/components/schemas/DeleteUserPolicyRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteUserPolicyResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteUserPolicyResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -17521,23 +17643,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteVirtualGatewayRequest" examples: ex1: value: VirtualGatewayId: vgw-12345678 + schema: + "$ref": "#/components/schemas/DeleteVirtualGatewayRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteVirtualGatewayResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteVirtualGatewayResponse" description: The HTTP 200 response (OK). tags: - VirtualGateway @@ -17552,23 +17674,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteVmGroupRequest" examples: ex1: value: VmGroupId: vmgroup-12345678901234567890123456789012 + schema: + "$ref": "#/components/schemas/DeleteVmGroupRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteVmGroupResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteVmGroupResponse" description: The HTTP 200 response (OK). '400': content: @@ -17602,23 +17724,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteVmTemplateRequest" examples: ex1: value: VmTemplateId: vmtemplate-98765432109876543210987654321012 + schema: + "$ref": "#/components/schemas/DeleteVmTemplateRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteVmTemplateResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteVmTemplateResponse" description: The HTTP 200 response (OK). tags: - VmTemplate @@ -17631,28 +17753,28 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteVmsRequest" examples: ex1: value: VmIds: - i-12345678 + schema: + "$ref": "#/components/schemas/DeleteVmsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteVmsResponse" examples: ex1: value: - Vms: - - VmId: i-12345678 - PreviousState: running - CurrentState: shutting-down ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Vms: + - CurrentState: shutting-down + PreviousState: running + VmId: i-12345678 + schema: + "$ref": "#/components/schemas/DeleteVmsResponse" description: The HTTP 200 response (OK). '400': content: @@ -17683,23 +17805,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteVolumeRequest" examples: ex1: value: VolumeId: vol-12345678 + schema: + "$ref": "#/components/schemas/DeleteVolumeRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteVolumeResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteVolumeResponse" description: The HTTP 200 response (OK). '400': content: @@ -17730,23 +17852,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteVpnConnectionRequest" examples: ex1: value: VpnConnectionId: vpn-12345678 + schema: + "$ref": "#/components/schemas/DeleteVpnConnectionRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteVpnConnectionResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteVpnConnectionResponse" description: The HTTP 200 response (OK). tags: - VpnConnection @@ -17758,24 +17880,24 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteVpnConnectionRouteRequest" examples: ex1: value: - VpnConnectionId: vpn-12345678 DestinationIpRange: 10.0.0.0/16 + VpnConnectionId: vpn-12345678 + schema: + "$ref": "#/components/schemas/DeleteVpnConnectionRouteRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteVpnConnectionRouteResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteVpnConnectionRouteResponse" description: The HTTP 200 response (OK). tags: - VpnConnection @@ -17790,26 +17912,26 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeregisterVmsInLoadBalancerRequest" examples: ex1: value: - LoadBalancerName: example-lbu BackendVmIds: - i-12345678 - i-87654321 + LoadBalancerName: example-lbu + schema: + "$ref": "#/components/schemas/DeregisterVmsInLoadBalancerRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeregisterVmsInLoadBalancerResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeregisterVmsInLoadBalancerResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer @@ -17825,24 +17947,24 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/LinkFlexibleGpuRequest" examples: ex1: value: FlexibleGpuId: fgpu-12345678 VmId: i-12345678 + schema: + "$ref": "#/components/schemas/LinkFlexibleGpuRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/LinkFlexibleGpuResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/LinkFlexibleGpuResponse" description: The HTTP 200 response (OK). tags: - FlexibleGpu @@ -17855,24 +17977,24 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/LinkInternetServiceRequest" examples: ex1: value: InternetServiceId: igw-12345678 NetId: vpc-12345678 + schema: + "$ref": "#/components/schemas/LinkInternetServiceRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/LinkInternetServiceResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/LinkInternetServiceResponse" description: The HTTP 200 response (OK). '400': content: @@ -17903,29 +18025,27 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/LinkLoadBalancerBackendMachinesRequest" examples: ex1: summary: Linking VMs to a load balancer value: - LoadBalancerName: example-lbu BackendVmIds: - i-12345678 - i-87654321 + LoadBalancerName: example-lbu ex2: summary: Linking public IPs to a load balancer value: - LoadBalancerName: example-lbu BackendIps: - 192.0.2.0 - 198.51.100.0 + LoadBalancerName: example-lbu + schema: + "$ref": "#/components/schemas/LinkLoadBalancerBackendMachinesRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/LinkLoadBalancerBackendMachinesResponse" examples: ex1: summary: Linking VMs to a load balancer @@ -17937,6 +18057,8 @@ paths: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/LinkLoadBalancerBackendMachinesResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer @@ -17948,24 +18070,24 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/LinkManagedPolicyToUserGroupRequest" examples: ex1: value: PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy UserGroupName: example-usergroup + schema: + "$ref": "#/components/schemas/LinkManagedPolicyToUserGroupRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/LinkManagedPolicyToUserGroupResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/LinkManagedPolicyToUserGroupResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -17978,26 +18100,26 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/LinkNicRequest" examples: ex1: value: + DeviceNumber: 1 NicId: eni-12345678 VmId: i-12345678 - DeviceNumber: 1 + schema: + "$ref": "#/components/schemas/LinkNicRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/LinkNicResponse" examples: ex1: value: + LinkNicId: eni-attach-12345678 ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - LinkNicId: eni-attach-12345678 + schema: + "$ref": "#/components/schemas/LinkNicResponse" description: The HTTP 200 response (OK). '400': content: @@ -18026,24 +18148,24 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/LinkPolicyRequest" examples: ex1: value: PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy UserName: example-user + schema: + "$ref": "#/components/schemas/LinkPolicyRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/LinkPolicyResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/LinkPolicyResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -18060,8 +18182,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/LinkPrivateIpsRequest" examples: ex1: summary: Linking specific secondary private IPs to a NIC @@ -18075,17 +18195,19 @@ paths: value: NicId: eni-12345678 SecondaryPrivateIpCount: 3 + schema: + "$ref": "#/components/schemas/LinkPrivateIpsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/LinkPrivateIpsResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/LinkPrivateIpsResponse" description: The HTTP 200 response (OK). '400': content: @@ -18120,8 +18242,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/LinkPublicIpRequest" examples: ex1: summary: Linking a public IP to a VM @@ -18131,27 +18251,29 @@ paths: ex2: summary: Linking a public IP to a NIC value: - PublicIp: 192.0.2.0 NicId: eni-12345678 + PublicIp: 192.0.2.0 + schema: + "$ref": "#/components/schemas/LinkPublicIpRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/LinkPublicIpResponse" examples: ex1: summary: Linking a public IP to a VM value: + LinkPublicIpId: eipassoc-12345678 ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - LinkPublicIpId: eipassoc-12345678 ex2: summary: Linking a public IP to a NIC value: + LinkPublicIpId: eipassoc-12345678 ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - LinkPublicIpId: eipassoc-12345678 + schema: + "$ref": "#/components/schemas/LinkPublicIpResponse" description: The HTTP 200 response (OK). '400': content: @@ -18182,25 +18304,25 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/LinkRouteTableRequest" examples: ex1: value: RouteTableId: rtb-12345678 SubnetId: subnet-12345678 + schema: + "$ref": "#/components/schemas/LinkRouteTableRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/LinkRouteTableResponse" examples: ex1: value: + LinkRouteTableId: rtbassoc-12345678 ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - LinkRouteTableId: rtbassoc-12345678 + schema: + "$ref": "#/components/schemas/LinkRouteTableResponse" description: The HTTP 200 response (OK). '400': content: @@ -18233,27 +18355,27 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/LinkVirtualGatewayRequest" examples: ex1: value: - VirtualGatewayId: vgw-12345678 NetId: vpc-12345678 + VirtualGatewayId: vgw-12345678 + schema: + "$ref": "#/components/schemas/LinkVirtualGatewayRequest" 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 + State: attached + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/LinkVirtualGatewayResponse" description: The HTTP 200 response (OK). tags: - VirtualGateway @@ -18266,25 +18388,25 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/LinkVolumeRequest" examples: ex1: value: - VolumeId: vol-12345678 - VmId: i-12345678 DeviceName: "/dev/sdb" + VmId: i-12345678 + VolumeId: vol-12345678 + schema: + "$ref": "#/components/schemas/LinkVolumeRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/LinkVolumeResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/LinkVolumeResponse" description: The HTTP 200 response (OK). '400': content: @@ -18315,8 +18437,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/PutUserGroupPolicyRequest" examples: ex1: value: @@ -18325,17 +18445,19 @@ paths: PolicyName: example-usergroup-policy UserGroupName: example-usergroup UserGroupPath: "/example/" + schema: + "$ref": "#/components/schemas/PutUserGroupPolicyRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/PutUserGroupPolicyResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/PutUserGroupPolicyResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -18348,8 +18470,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/PutUserPolicyRequest" examples: ex1: value: @@ -18357,17 +18477,19 @@ paths: "Resource": ["*"]} ]}' PolicyName: example-user-policy UserName: example-user + schema: + "$ref": "#/components/schemas/PutUserPolicyRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/PutUserPolicyResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/PutUserPolicyResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -18378,8 +18500,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadAccessKeysRequest" examples: ex1: value: @@ -18388,24 +18508,26 @@ paths: - ACTIVE Tag: Group1 UserName: example-user + schema: + "$ref": "#/components/schemas/ReadAccessKeysRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadAccessKeysResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 AccessKeys: - - State: ACTIVE - AccessKeyId: ABCDEFGHIJ0123456789 + - AccessKeyId: ABCDEFGHIJ0123456789 CreationDate: 2010-10-01 12:34:56.789000000 +00:00 ExpirationDate: 2063-04-05 00:00:00.000000000 +00:00 LastModificationDate: 2010-10-01 12:34:56.789000000 +00:00 + State: ACTIVE Tag: Group1 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadAccessKeysResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -18419,32 +18541,32 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadAccountsRequest" examples: ex1: value: {} + schema: + "$ref": "#/components/schemas/ReadAccountsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadAccountsResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Accounts: - - ZipCode: '92210' - CompanyName: EXAMPLE SAS - FirstName: JEAN + - AccountId: '123456789012' City: SAINT-CLOUD + CompanyName: EXAMPLE SAS Country: FRANCE - LastName: DUPONT - AccountId: '123456789012' CustomerId: '87654321' Email: example@example.com + FirstName: JEAN + LastName: DUPONT + ZipCode: '92210' + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadAccountsResponse" description: The HTTP 200 response (OK). tags: - Account @@ -18461,25 +18583,25 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadAdminPasswordRequest" examples: ex1: value: VmId: i-12345678 + schema: + "$ref": "#/components/schemas/ReadAdminPasswordRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadAdminPasswordResponse" examples: ex1: value: - VmId: i-12345678 + AdminPassword: "..." ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - AdminPassword: "..." + VmId: i-12345678 + schema: + "$ref": "#/components/schemas/ReadAdminPasswordResponse" description: The HTTP 200 response (OK). '400': content: @@ -18510,25 +18632,25 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadApiAccessPolicyRequest" examples: ex1: value: {} + schema: + "$ref": "#/components/schemas/ReadApiAccessPolicyRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadApiAccessPolicyResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ApiAccessPolicy: - RequireTrustedEnv: false MaxAccessKeyExpirationSeconds: 0 + RequireTrustedEnv: false + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadApiAccessPolicyResponse" description: The HTTP 200 response (OK). '400': content: @@ -18560,38 +18682,38 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadApiAccessRulesRequest" examples: ex1: value: Filters: ApiAccessRuleIds: - aar-1234567890abcdef1234567890abcdef + schema: + "$ref": "#/components/schemas/ReadApiAccessRulesRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadApiAccessRulesResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ApiAccessRules: - - IpRanges: - - 0.0.0.0/0 - ApiAccessRuleId: aar-1234567890abcdef1234567890abcdef + - ApiAccessRuleId: aar-1234567890abcdef1234567890abcdef CaIds: [] Cns: [] Description: Allows all IPv4 domain - - IpRanges: - - 46.231.144.178/32 - ApiAccessRuleId: aar-abcdef1234567890abcdef1234567890 + IpRanges: + - 0.0.0.0/0 + - ApiAccessRuleId: aar-abcdef1234567890abcdef1234567890 CaIds: [] Cns: [] Description: Allows Outscale Cockpit of this region + IpRanges: + - 46.231.144.178/32 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadApiAccessRulesResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -18611,49 +18733,49 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadApiLogsRequest" examples: ex1: value: Filters: + QueryDateAfter: '2017-05-10' + QueryDateBefore: '2017-05-10' QueryIpAddresses: - 192.0.2.0 - 198.51.100.0 - QueryDateAfter: '2017-05-10' - QueryDateBefore: '2017-05-10' + schema: + "$ref": "#/components/schemas/ReadApiLogsRequest" 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 + - AccountId: '123456789012' CallDuration: 47 - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + QueryAccessKey: ABCDEFGHIJ0123456789 + QueryApiName: oapi QueryApiVersion: '1.27' - AccountId: '123456789012' - QueryPayloadSize: 2 QueryCallName: ReadAccessKeys - QueryAccessKey: ABCDEFGHIJ0123456789 - QueryHeaderSize: 287 QueryDate: '2017-05-10T12:34:56.789Z' QueryHeaderRaw: 'Host: api.eu-west-2.outscale.com\nAccept: */*\nConnection: close\nUser-Agent: oAPI CLI v0.1 - 2018-09-28\nX-Osc-Date: 20170510T000000Z\nContent-Type: application/json; charset=utf-8\nAuthorization: *****\nContent-Length: 2\nAccept-Encoding: gzip, deflate\nX-Forwarded-For: 192.0.2.0' + QueryHeaderSize: 287 + QueryIpAddress: 192.0.2.0 + QueryPayloadRaw: "{}" + QueryPayloadSize: 2 + QueryUserAgent: oAPI CLI v0.1 - 2018-09-28 + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ResponseSize: 1887 + ResponseStatusCode: 200 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadApiLogsResponse" description: The HTTP 200 response (OK). tags: - ApiLog @@ -18665,29 +18787,29 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadCasRequest" examples: ex1: value: Filters: CaIds: - ca-fedcba0987654321fedcba0987654321 + schema: + "$ref": "#/components/schemas/ReadCasRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadCasResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Cas: - - Description: CA example + - CaFingerprint: 1234567890abcdef1234567890abcdef12345678 CaId: ca-fedcba0987654321fedcba0987654321 - CaFingerprint: 1234567890abcdef1234567890abcdef12345678 + Description: CA example + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadCasResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -18701,32 +18823,32 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadCatalogRequest" examples: ex1: value: {} + schema: + "$ref": "#/components/schemas/ReadCatalogRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadCatalogResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Catalog: Entries: - - UnitPrice: 0.04 - Type: CustomCore:v5-p1 + - Category: compute + Operation: RunInstances-OD + Service: TinaOS-FCU + SubregionName: eu-west-2 Title: Instance - On demand - Unite de vCore pour une instance Tina v5 CxRy Performance highest - par heure - SubregionName: eu-west-2 - Category: compute - Service: TinaOS-FCU - Operation: RunInstances-OD + Type: CustomCore:v5-p1 + UnitPrice: 0.04 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadCatalogResponse" description: The HTTP 200 response (OK). tags: - Catalog @@ -18738,8 +18860,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadCatalogsRequest" examples: ex1: value: @@ -18747,29 +18867,31 @@ paths: CurrentCatalogOnly: true FromDate: '2021-01-01' ToDate: '2023-01-01' + schema: + "$ref": "#/components/schemas/ReadCatalogsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadCatalogsResponse" examples: ex1: value: - 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 + - Entries: + - Category: compute + Operation: RunInstances-OD + Service: TinaOS-FCU + SubregionName: eu-west-2 Title: Instance - On demand - Unite de vCore pour une instance Tina v5 CxRy Performance highest - par heure - SubregionName: eu-west-2 - Category: compute - Service: TinaOS-FCU - Operation: RunInstances-OD + Type: CustomCore:v5-p1 + UnitPrice: 0.04 + FromDate: 2021-01-01 00:00:00.000000000 +00:00 + State: CURRENT + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadCatalogsResponse" description: The HTTP 200 response (OK). tags: - Catalog @@ -18780,8 +18902,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadClientGatewaysRequest" examples: ex1: value: @@ -18796,24 +18916,26 @@ paths: PublicIps: - 192.0.2.0 - 198.51.100.0 + schema: + "$ref": "#/components/schemas/ReadClientGatewaysRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadClientGatewaysResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ClientGateways: - - State: available - BgpAsn: 65000 - Tags: [] + - BgpAsn: 65000 ClientGatewayId: cgw-12345678 ConnectionType: ipsec.1 PublicIp: 192.0.2.0 + State: available + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadClientGatewaysResponse" description: The HTTP 200 response (OK). tags: - ClientGateway @@ -18828,25 +18950,25 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadConsoleOutputRequest" examples: ex1: value: VmId: i-12345678 + schema: + "$ref": "#/components/schemas/ReadConsoleOutputRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadConsoleOutputResponse" examples: ex1: value: - VmId: i-12345678 + ConsoleOutput: "..." ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - ConsoleOutput: "..." + VmId: i-12345678 + schema: + "$ref": "#/components/schemas/ReadConsoleOutputResponse" description: The HTTP 200 response (OK). '400': content: @@ -18876,41 +18998,41 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadConsumptionAccountRequest" examples: ex1: value: FromDate: '2023-06-01' - ToDate: '2023-07-01' ShowPrice: true + ToDate: '2023-07-01' + schema: + "$ref": "#/components/schemas/ReadConsumptionAccountRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadConsumptionAccountResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ConsumptionEntries: - - UnitPrice: 0.044 - Type: BoxUsage:tinav4.c1r1p2 + - AccountId: '123456789012' + Category: compute + FromDate: 2023-06-01 00:00:00.000000000 +00:00 Operation: RunInstances-OD + PayingAccountId: '123456789012' + Price: 61.248 + Service: TinaOS-FCU SubregionName: eu-west-2a - Value: 1392 Title: Instance - On demand - tinav4.c1r1 high performance - par heure - Category: compute ToDate: 2023-06-30 00:00:00.000000000 +00:00 - Service: TinaOS-FCU - AccountId: '123456789012' - PayingAccountId: '123456789012' - FromDate: 2023-06-01 00:00:00.000000000 +00:00 - Price: 61.248 + Type: BoxUsage:tinav4.c1r1p2 + UnitPrice: 0.044 + Value: 1392 Currency: EUR + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadConsumptionAccountResponse" description: The HTTP 200 response (OK). tags: - Account @@ -18925,8 +19047,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadDedicatedGroupsRequest" examples: ex1: summary: Filtering on a specific dedicated group @@ -18938,30 +19058,32 @@ paths: summary: Filtering on a specific Subregion and CPU generation value: Filters: - SubregionNames: - - eu-west-2a CpuGenerations: - 4 + SubregionNames: + - eu-west-2a + schema: + "$ref": "#/components/schemas/ReadDedicatedGroupsRequest" 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' + - AccountId: '123456789012' CpuGeneration: 4 + DedicatedGroupId: ded-12345678 Name: dedicated-group-example + NetIds: [] SubregionName: eu-west-2a - DedicatedGroupId: ded-12345678 + VmIds: + - i-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadDedicatedGroupsResponse" description: The HTTP 200 response (OK). '400': content: @@ -18990,8 +19112,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadDhcpOptionsRequest" examples: ex1: value: @@ -19006,28 +19126,30 @@ paths: - 198.51.100.0 DomainNames: - example.com + schema: + "$ref": "#/components/schemas/ReadDhcpOptionsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadDhcpOptionsResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 DhcpOptionsSets: - - Tags: [] - NtpServers: - - 203.0.113.0 - - 203.0.113.1 - Default: false + - Default: false DhcpOptionsSetId: dopt-12345678 DomainName: example.com DomainNameServers: - 192.0.2.0 - 198.51.100.0 + NtpServers: + - 203.0.113.0 + - 203.0.113.1 + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadDhcpOptionsResponse" description: The HTTP 200 response (OK). tags: - DhcpOption @@ -19038,39 +19160,39 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadDirectLinkInterfacesRequest" examples: ex1: value: Filters: DirectLinkInterfaceIds: - dxvif-12345678 + schema: + "$ref": "#/components/schemas/ReadDirectLinkInterfacesRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadDirectLinkInterfacesResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 DirectLinkInterfaces: - - Vlan: 101 - OutscalePrivateIp: 172.16.0.4/30 - DirectLinkInterfaceId: dxvif-12345678 + - AccountId: '123456789012' BgpAsn: 65000 - AccountId: '123456789012' ClientPrivateIp: 172.16.0.5/30 - VirtualGatewayId: vgw-12345678 - DirectLinkInterfaceName: MyDirectLinkInterface DirectLinkId: dxcon-12345678 - Mtu: 1500 - State: available + DirectLinkInterfaceId: dxvif-12345678 + DirectLinkInterfaceName: MyDirectLinkInterface InterfaceType: private Location: PAR1 + Mtu: 1500 + OutscalePrivateIp: 172.16.0.4/30 + State: available + VirtualGatewayId: vgw-12345678 + Vlan: 101 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadDirectLinkInterfacesResponse" description: The HTTP 200 response (OK). tags: - DirectLinkInterface @@ -19081,25 +19203,21 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadDirectLinksRequest" examples: ex1: value: Filters: DirectLinkIds: - dxcon-12345678 + schema: + "$ref": "#/components/schemas/ReadDirectLinksRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadDirectLinksResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 DirectLinks: - AccountId: '123456789012' Bandwidth: 1Gbps @@ -19108,6 +19226,10 @@ paths: Location: PAR1 RegionName: eu-west-2 State: available + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadDirectLinksResponse" description: The HTTP 200 response (OK). tags: - DirectLink @@ -19119,8 +19241,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadEntitiesLinkedToPolicyRequest" examples: ex1: summary: Reading all entities linked to a specific policy @@ -19133,23 +19253,17 @@ paths: EntitiesType: - USER PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy + schema: + "$ref": "#/components/schemas/ReadEntitiesLinkedToPolicyRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadEntitiesLinkedToPolicyResponse" examples: ex1: summary: Reading all entities linked to a specific policy value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 PolicyEntities: - Users: - - Id: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 - Name: example-user - Orn: orn:ows:idauth::012345678910:user/example/user-example Groups: - Id: ug-12345678 Name: example-usergroup @@ -19158,16 +19272,24 @@ paths: ItemsCount: 3 MaxResultsLimit: 100 MaxResultsTruncated: false + Users: + - Id: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 + Name: example-user + Orn: orn:ows:idauth::012345678910:user/example/user-example + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Reading only users linked to a specific policy value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 PolicyEntities: Users: - Id: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 Name: example-user Orn: orn:ows:idauth::012345678910:user/example/user-example + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadEntitiesLinkedToPolicyResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -19178,29 +19300,29 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadFlexibleGpuCatalogRequest" examples: ex1: value: {} + schema: + "$ref": "#/components/schemas/ReadFlexibleGpuCatalogRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadFlexibleGpuCatalogResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 FlexibleGpuCatalog: - - VRam: 16000 - Generations: + - Generations: - v5 MaxCpu: 80 MaxRam: 512 ModelName: nvidia-p100 + VRam: 16000 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadFlexibleGpuCatalogResponse" description: The HTTP 200 response (OK). security: [] tags: @@ -19212,8 +19334,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadFlexibleGpusRequest" examples: ex1: value: @@ -19228,17 +19348,15 @@ paths: - nvidia-p100 States: - attached + schema: + "$ref": "#/components/schemas/ReadFlexibleGpusRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadFlexibleGpusResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 FlexibleGpus: - DeleteOnVmDeletion: true FlexibleGpuId: fgpu-12345678 @@ -19247,6 +19365,10 @@ paths: State: attached SubregionName: eu-west-2a VmId: i-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadFlexibleGpusResponse" description: The HTTP 200 response (OK). tags: - FlexibleGpu @@ -19257,36 +19379,36 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadImageExportTasksRequest" examples: ex1: value: Filters: TaskIds: - image-export-12345678 + schema: + "$ref": "#/components/schemas/ReadImageExportTasksRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadImageExportTasksResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ImageExportTasks: - - Tags: [] + - Comment: Export of image ami-12345678 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 + OsuBucket: BUCKET + OsuPrefix: PREFIX/ami-12345678/ Progress: 0 + State: pending/queued + Tags: [] + TaskId: image-export-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadImageExportTasksResponse" description: The HTTP 200 response (OK). tags: - Image @@ -19297,8 +19419,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadImagesRequest" examples: ex1: summary: Reading a specific image @@ -19315,102 +19435,110 @@ paths: ImageNames: - Ubuntu* - RockyLinux* + schema: + "$ref": "#/components/schemas/ReadImagesRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadImagesResponse" examples: ex1: summary: Reading a specific image value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Images: - - StateComment: {} - State: available - RootDeviceType: bsu - RootDeviceName: "/dev/sda1" - ProductCodes: - - '0001' - PermissionsToLaunch: - GlobalPermission: false - AccountIds: [] - AccountId: '123456789012' - Tags: [] - Description: '' - ImageId: ami-12345678 + - AccountId: '123456789012' + Architecture: x86_64 BlockDeviceMappings: - - DeviceName: "/dev/sda1" - Bsu: - VolumeType: standard + - Bsu: DeleteOnVmDeletion: true - VolumeSize: 50 SnapshotId: snap-12345678 - ImageType: machine + VolumeSize: 50 + VolumeType: standard + DeviceName: "/dev/sda1" + BootModes: + - legacy CreationDate: '2010-10-01T12:34:56.789Z' + Description: '' FileLocation: 123456789012/create-image-example - Architecture: x86_64 + ImageId: ami-12345678 ImageName: create-image-example + ImageType: machine + PermissionsToLaunch: + AccountIds: [] + GlobalPermission: false + ProductCodes: + - '0001' + RootDeviceName: "/dev/sda1" + RootDeviceType: bsu + SecureBoot: false + State: available + StateComment: {} + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 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: [] + - AccountAlias: Outscale AccountId: '123456789012' - Tags: [] - Description: '' - ImageId: ami-12345678 + Architecture: x86_64 BlockDeviceMappings: - - DeviceName: "/dev/sda1" - Bsu: - VolumeType: standard + - Bsu: DeleteOnVmDeletion: true - VolumeSize: 10 SnapshotId: snap-12345678 - ImageType: machine - AccountAlias: Outscale + VolumeSize: 10 + VolumeType: standard + DeviceName: "/dev/sda1" CreationDate: '2010-10-01T12:34:56.789Z' + Description: '' FileLocation: Outscale/Ubuntu-2010.10.01-0 - Architecture: x86_64 + ImageId: ami-12345678 ImageName: Ubuntu-2010.10.01-0 - - StateComment: {} - State: available - RootDeviceType: bsu - RootDeviceName: "/dev/sda1" - ProductCodes: - - '0001' + ImageType: machine PermissionsToLaunch: - GlobalPermission: true AccountIds: [] - AccountId: '123456789012' + GlobalPermission: true + ProductCodes: + - '0001' + RootDeviceName: "/dev/sda1" + RootDeviceType: bsu + State: available + StateComment: {} Tags: [] - Description: '' - ImageId: ami-12345678 + - AccountAlias: Outscale + AccountId: '123456789012' + Architecture: x86_64 BlockDeviceMappings: - - DeviceName: "/dev/sda1" - Bsu: - VolumeType: standard + - Bsu: DeleteOnVmDeletion: true - VolumeSize: 10 SnapshotId: snap-12345678 - ImageType: machine - AccountAlias: Outscale + VolumeSize: 10 + VolumeType: standard + DeviceName: "/dev/sda1" + BootModes: + - legacy CreationDate: '2010-10-01T12:34:56.789Z' + Description: '' FileLocation: Outscale/RockyLinux-2010.10.01-0 - Architecture: x86_64 + ImageId: ami-12345678 ImageName: RockyLinux-2010.10.01-0 + ImageType: machine + PermissionsToLaunch: + AccountIds: [] + GlobalPermission: true + ProductCodes: + - '0001' + RootDeviceName: "/dev/sda1" + RootDeviceType: bsu + SecureBoot: false + State: available + StateComment: {} + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadImagesResponse" description: The HTTP 200 response (OK). '400': content: @@ -19441,8 +19569,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadInternetServicesRequest" examples: ex1: value: @@ -19457,24 +19583,26 @@ paths: TagValues: - prod - test + schema: + "$ref": "#/components/schemas/ReadInternetServicesRequest" 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 + - InternetServiceId: igw-12345678 NetId: vpc-12345678 - InternetServiceId: igw-12345678 + State: available + Tags: + - Key: env + Value: prod + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadInternetServicesResponse" description: The HTTP 200 response (OK). '400': content: @@ -19503,30 +19631,30 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadKeypairsRequest" examples: ex1: value: Filters: KeypairNames: - keypair-example + schema: + "$ref": "#/components/schemas/ReadKeypairsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadKeypairsResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Keypairs: - - KeypairType: ssh-rsa - KeypairName: keypair-example + - KeypairFingerprint: 11:22:33:44:55:66:77:88:99:00:aa:bb:cc:dd:ee:ff KeypairId: key-abcdef1234567890abcdef1234567890 - KeypairFingerprint: 11:22:33:44:55:66:77:88:99:00:aa:bb:cc:dd:ee:ff + KeypairName: keypair-example + KeypairType: ssh-rsa + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadKeypairsResponse" description: The HTTP 200 response (OK). '400': content: @@ -19555,8 +19683,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadLinkedPoliciesRequest" examples: ex1: value: @@ -19565,26 +19691,28 @@ paths: FirstItem: 1 ResultsPerPage: 30 UserName: example-user + schema: + "$ref": "#/components/schemas/ReadLinkedPoliciesRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadLinkedPoliciesResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 HasMoreItems: true + MaxResultsLimit: 30 + MaxResultsTruncated: false Policies: - - PolicyName: example-user-policy - CreationDate: 2010-10-01 12:34:56.789000000 +00:00 + - CreationDate: 2010-10-01 12:34:56.789000000 +00:00 LastModificationDate: 2010-10-01 12:34:56.789000000 +00:00 Orn: orn:ows:idauth::012345678910:policy/example/example-user-policy PolicyId: ABCDEFGHIJKLMNOPQRSTUVWXYZ01234 - MaxResultsLimit: 30 - MaxResultsTruncated: false + PolicyName: example-user-policy + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadLinkedPoliciesResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -19596,34 +19724,34 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadListenerRulesRequest" examples: ex1: value: Filters: ListenerRuleNames: - example-listener-rule + schema: + "$ref": "#/components/schemas/ReadListenerRulesRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadListenerRulesResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ListenerRules: - - Priority: 10 - VmIds: - - i-12345678 - ListenerRuleName: example-listener-rule - Action: forward - ListenerId: 123456 + - Action: forward HostNamePattern: "*.example.com" + ListenerId: 123456 ListenerRuleId: 1234 + ListenerRuleName: example-listener-rule + Priority: 10 + VmIds: + - i-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadListenerRulesResponse" description: The HTTP 200 response (OK). tags: - Listener @@ -19634,28 +19762,28 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadLoadBalancerTagsRequest" examples: ex1: value: LoadBalancerNames: - private-lb-example + schema: + "$ref": "#/components/schemas/ReadLoadBalancerTagsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadLoadBalancerTagsResponse" examples: ex1: value: - Tags: - - Value: value1 - LoadBalancerName: private-lb-example - Key: key1 ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Tags: + - Key: key1 + LoadBalancerName: private-lb-example + Value: value1 + schema: + "$ref": "#/components/schemas/ReadLoadBalancerTagsResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer @@ -19666,61 +19794,61 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadLoadBalancersRequest" examples: ex1: value: Filters: LoadBalancerNames: - private* + schema: + "$ref": "#/components/schemas/ReadLoadBalancersRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadLoadBalancersResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 LoadBalancers: - - 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 + - AccessLog: IsEnabled: false + PublicationInterval: 60 + ApplicationStickyCookiePolicies: [] + BackendVmIds: [] DnsName: private-lb-example.123456789.eu-west-2.lbu.outscale.com HealthCheck: - UnhealthyThreshold: 2 - Timeout: 5 CheckInterval: 30 - Protocol: TCP HealthyThreshold: 10 Port: 80 + Protocol: TCP + Timeout: 5 + UnhealthyThreshold: 2 + Listeners: + - BackendPort: 80 + BackendProtocol: HTTP + LoadBalancerPort: 443 + LoadBalancerProtocol: HTTPS + ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate + LoadBalancerName: private-lb-example LoadBalancerStickyCookiePolicies: [] + LoadBalancerType: internet-facing + NetId: vpc-12345678 + PublicIp: 192.0.2.0 + SecuredCookies: false + SecurityGroups: + - sg-12345678 + SourceSecurityGroup: + SecurityGroupAccountId: '123456789012' + SecurityGroupName: security-group-example + Subnets: + - subnet-12345678 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 + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadLoadBalancersResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer @@ -19733,27 +19861,27 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadLocationsRequest" examples: ex1: value: {} + schema: + "$ref": "#/components/schemas/ReadLocationsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadLocationsResponse" examples: ex1: value: + Locations: + - Code: PAR1 + Name: Telehouse 3, France + - Code: PAR4 + Name: Equinix Pantin, France ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - Locations: - - Name: Telehouse 3, France - Code: PAR1 - - Name: Equinix Pantin, France - Code: PAR4 + schema: + "$ref": "#/components/schemas/ReadLocationsResponse" description: The HTTP 200 response (OK). security: [] tags: @@ -19765,8 +19893,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadManagedPoliciesLinkedToUserGroupRequest" examples: ex1: value: @@ -19777,17 +19903,15 @@ paths: FirstItem: 1 ResultsPerPage: 30 UserGroupName: example-usergroup + schema: + "$ref": "#/components/schemas/ReadManagedPoliciesLinkedToUserGroupRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadManagedPoliciesLinkedToUserGroupResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 HasMoreItems: true MaxResultsLimit: 30 MaxResultsTruncated: true @@ -19797,6 +19921,10 @@ paths: Orn: orn:ows:idauth::012345678910:policy/example/example-user-policy PolicyId: ABCDEFGHIJKLMNOPQRSTUVWXYZ01234 PolicyName: example-policy + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadManagedPoliciesLinkedToUserGroupResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -19807,8 +19935,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadNatServicesRequest" examples: ex1: value: @@ -19823,26 +19949,28 @@ paths: - vpc-87654321 SubnetIds: - subnet-12345678 + schema: + "$ref": "#/components/schemas/ReadNatServicesRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadNatServicesResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 NatServices: - - Tags: [] - SubnetId: subnet-12345678 - NatServiceId: nat-12345678 - PublicIps: - - PublicIpId: eipalloc-12345678 - PublicIp: 192.0.2.0 + - NatServiceId: nat-12345678 NetId: vpc-12345678 + PublicIps: + - PublicIp: 192.0.2.0 + PublicIpId: eipalloc-12345678 State: available + SubnetId: subnet-12345678 + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadNatServicesResponse" description: The HTTP 200 response (OK). '400': content: @@ -19873,8 +20001,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadNetAccessPointServicesRequest" examples: ex1: summary: Listing one or more services according to their service IDs @@ -19889,41 +20015,43 @@ paths: Filters: ServiceNames: - com.outscale.eu-west-2.api + schema: + "$ref": "#/components/schemas/ReadNetAccessPointServicesRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadNetAccessPointServicesResponse" examples: ex1: summary: Listing one or more services according to their service IDs value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Services: - - ServiceName: com.outscale.eu-west-2.api - ServiceId: pl-12345678 - IpRanges: + - IpRanges: - 192.0.2.0 - - ServiceName: com.outscale.eu-west-2.oos - ServiceId: pl-87654321 - IpRanges: + ServiceId: pl-12345678 + ServiceName: com.outscale.eu-west-2.api + - IpRanges: - 198.51.100.0 - 203.0.113.0 - 203.0.113.1 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ServiceId: pl-87654321 + ServiceName: com.outscale.eu-west-2.oos 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 + Services: + - IpRanges: + - 192.0.2.0 + ServiceId: pl-12345678 + ServiceName: com.outscale.eu-west-2.api + schema: + "$ref": "#/components/schemas/ReadNetAccessPointServicesResponse" description: The HTTP 200 response (OK). security: [] tags: @@ -19935,8 +20063,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadNetAccessPointsRequest" examples: ex1: value: @@ -19950,25 +20076,27 @@ paths: - vpc-12345678 States: - available + schema: + "$ref": "#/components/schemas/ReadNetAccessPointsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadNetAccessPointsResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 NetAccessPoints: - - Tags: [] - NetAccessPointId: vpce-12345678 + - NetAccessPointId: vpce-12345678 + NetId: vpc-12345678 RouteTableIds: - rtb-12345678 - State: available - NetId: vpc-12345678 ServiceName: com.outscale.eu-west-2.oos + State: available + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadNetAccessPointsResponse" description: The HTTP 200 response (OK). tags: - NetAccessPoint @@ -19979,8 +20107,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadNetPeeringsRequest" examples: ex1: value: @@ -19995,31 +20121,33 @@ paths: StateNames: - active - pending-acceptance + schema: + "$ref": "#/components/schemas/ReadNetPeeringsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadNetPeeringsResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 NetPeerings: - - Tags: [] - State: - Name: active - Message: Active - AccepterNet: - NetId: vpc-12345678 - IpRange: 172.16.0.0/16 + - AccepterNet: AccountId: '123456789012' - SourceNet: + IpRange: 172.16.0.0/16 NetId: vpc-12345678 - IpRange: 10.0.0.0/16 - AccountId: '123456789012' NetPeeringId: pcx-12345678 + SourceNet: + AccountId: '123456789012' + IpRange: 10.0.0.0/16 + NetId: vpc-12345678 + State: + Message: Active + Name: active + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadNetPeeringsResponse" description: The HTTP 200 response (OK). '400': content: @@ -20048,8 +20176,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadNetsRequest" examples: ex1: value: @@ -20061,24 +20187,26 @@ paths: Filters: States: - available + schema: + "$ref": "#/components/schemas/ReadNetsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadNetsResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Nets: - - Tags: [] - DhcpOptionsSetId: dopt-12345678 + - DhcpOptionsSetId: dopt-12345678 IpRange: 10.0.0.0/16 - Tenancy: default NetId: vpc-12345678 State: available + Tags: [] + Tenancy: default + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadNetsResponse" description: The HTTP 200 response (OK). '400': content: @@ -20109,8 +20237,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadNicsRequest" examples: ex1: value: @@ -20122,43 +20248,45 @@ paths: Filters: LinkNicVmIds: - i-12345678 + schema: + "$ref": "#/components/schemas/ReadNicsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadNicsResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Nics: - - SubregionName: eu-west-2a - SubnetId: subnet-12345678 - State: in-use + - AccountId: '123456789012' + Description: Primary network interface + IsSourceDestChecked: true LinkNic: - VmId: i-12345678 - LinkNicId: eni-attach-12345678 - VmAccountId: '123456789012' DeleteOnVmDeletion: false DeviceNumber: 0 + LinkNicId: eni-attach-12345678 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 + VmAccountId: '123456789012' + VmId: i-12345678 MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - IsPrimary: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - IsPrimary: true + SecurityGroups: + - SecurityGroupId: sg-12345678 + SecurityGroupName: security-group-example + State: in-use + SubnetId: subnet-12345678 + SubregionName: eu-west-2a + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadNicsResponse" description: The HTTP 200 response (OK). '400': content: @@ -20187,8 +20315,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadPoliciesRequest" examples: ex1: value: @@ -20198,31 +20324,33 @@ paths: Scope: OWS FirstItem: 1 ResultsPerPage: 30 + schema: + "$ref": "#/components/schemas/ReadPoliciesRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadPoliciesResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 HasMoreItems: true + MaxResultsLimit: 30 + MaxResultsTruncated: false Policies: - - ResourcesCount: 1 - PolicyName: example-user-policy - PolicyDefaultVersionId: v1 - Path: "/example/" - CreationDate: 2010-10-01 12:34:56.789000000 +00:00 + - CreationDate: 2010-10-01 12:34:56.789000000 +00:00 Description: Example of description - PolicyId: ABCDEFGHIJKLMNOPQRSTUVWXYZ01234 - Orn: orn:ows:idauth::012345678910:policy/example/example-user-policy IsLinkable: true LastModificationDate: 2010-10-01 12:34:56.789000000 +00:00 - MaxResultsLimit: 30 - MaxResultsTruncated: false + Orn: orn:ows:idauth::012345678910:policy/example/example-user-policy + Path: "/example/" + PolicyDefaultVersionId: v1 + PolicyId: ABCDEFGHIJKLMNOPQRSTUVWXYZ01234 + PolicyName: example-user-policy + ResourcesCount: 1 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadPoliciesResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -20233,34 +20361,34 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadPolicyRequest" examples: ex1: value: PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy + schema: + "$ref": "#/components/schemas/ReadPolicyRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadPolicyResponse" examples: ex1: value: Policy: - ResourcesCount: 0 - PolicyName: example-user-policy - PolicyDefaultVersionId: v1 - Path: "/example/" CreationDate: 2010-10-01 12:34:56.789000000 +00:00 Description: Example of description - PolicyId: ABCDEFGHIJKLMNOPQRSTUVWXYZ01234 - Orn: orn:ows:idauth::012345678910:policy/example/example-user-policy IsLinkable: true LastModificationDate: 2010-10-01 12:34:56.789000000 +00:00 + Orn: orn:ows:idauth::012345678910:policy/example/example-user-policy + Path: "/example/" + PolicyDefaultVersionId: v1 + PolicyId: ABCDEFGHIJKLMNOPQRSTUVWXYZ01234 + PolicyName: example-user-policy + ResourcesCount: 0 ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadPolicyResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -20271,30 +20399,30 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadPolicyVersionRequest" examples: ex1: value: PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy VersionId: v1 + schema: + "$ref": "#/components/schemas/ReadPolicyVersionRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadPolicyVersionResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 PolicyVersion: - VersionId: v1 - DefaultVersion: true - CreationDate: 2010-10-01 12:34:56.789000000 +00:00 Body: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], "Resource": ["*"]} ]}' + CreationDate: 2010-10-01 12:34:56.789000000 +00:00 + DefaultVersion: true + VersionId: v1 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadPolicyVersionResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -20306,33 +20434,33 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadPolicyVersionsRequest" examples: ex1: value: FirstItem: 1 PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy ResultsPerPage: 30 + schema: + "$ref": "#/components/schemas/ReadPolicyVersionsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadPolicyVersionsResponse" examples: ex1: value: + HasMoreItems: true MaxResultsLimit: 30 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 PolicyVersions: - - VersionId: v1 - DefaultVersion: true - CreationDate: 2010-10-01 12:34:56.789000000 +00:00 - Body: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], + - Body: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], "Resource": ["*"]} ]}' - HasMoreItems: true + CreationDate: 2010-10-01 12:34:56.789000000 +00:00 + DefaultVersion: true + VersionId: v1 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadPolicyVersionsResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -20343,28 +20471,28 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadProductTypesRequest" examples: ex1: value: Filters: ProductTypeIds: - '0001' + schema: + "$ref": "#/components/schemas/ReadProductTypesRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadProductTypesResponse" examples: ex1: value: + ProductTypes: + - Description: Linux + ProductTypeId: '0001' ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - ProductTypes: - - ProductTypeId: '0001' - Description: Linux + schema: + "$ref": "#/components/schemas/ReadProductTypesResponse" description: The HTTP 200 response (OK). security: [] tags: @@ -20378,32 +20506,32 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadPublicCatalogRequest" examples: ex1: value: {} + schema: + "$ref": "#/components/schemas/ReadPublicCatalogRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadPublicCatalogResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Catalog: Entries: - - UnitPrice: 0.04 - Type: CustomCore:v5-p1 + - Category: compute + Operation: RunInstances-OD + Service: TinaOS-FCU + SubregionName: eu-west-2 Title: Instance - On demand - Unite de vCore pour une instance Tina v5 CxRy Performance highest - par heure - SubregionName: eu-west-2 - Category: compute - Service: TinaOS-FCU - Operation: RunInstances-OD + Type: CustomCore:v5-p1 + UnitPrice: 0.04 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadPublicCatalogResponse" description: The HTTP 200 response (OK). security: [] tags: @@ -20417,25 +20545,25 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadPublicIpRangesRequest" examples: ex1: value: {} + schema: + "$ref": "#/components/schemas/ReadPublicIpRangesRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadPublicIpRangesResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 PublicIps: - 198.51.100.0/24 - 203.0.113.0/24 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadPublicIpRangesResponse" description: The HTTP 200 response (OK). security: [] tags: @@ -20449,8 +20577,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadPublicIpsRequest" examples: ex1: value: @@ -20462,26 +20588,28 @@ paths: Filters: VmIds: - i-12345678 + schema: + "$ref": "#/components/schemas/ReadPublicIpsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadPublicIpsResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 PublicIps: - - VmId: i-12345678 - Tags: [] - PublicIpId: eipalloc-12345678 - PublicIp: 192.0.2.0 - LinkPublicIpId: eipassoc-12345678 + - LinkPublicIpId: eipassoc-12345678 NicAccountId: '123456789012' NicId: eni-12345678 PrivateIp: 10.0.0.4 + PublicIp: 192.0.2.0 + PublicIpId: eipalloc-12345678 + Tags: [] + VmId: i-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadPublicIpsResponse" description: The HTTP 200 response (OK). '400': content: @@ -20512,8 +20640,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadQuotasRequest" examples: ex1: summary: Reading specific quota @@ -20527,52 +20653,54 @@ paths: Filters: Collections: - VPC + schema: + "$ref": "#/components/schemas/ReadQuotasRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadQuotasResponse" examples: ex1: summary: Reading specific quota value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 QuotaTypes: - - Quotas: - - ShortDescription: Load Balancer Limit - QuotaCollection: LBU - AccountId: '123456789012' + - QuotaType: global + Quotas: + - AccountId: '123456789012' Description: Maximum number of load balancers per region MaxValue: 20 - UsedValue: 0 Name: lb_limit - QuotaType: global + QuotaCollection: LBU + ShortDescription: Load Balancer Limit + UsedValue: 0 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Reading collection of quotas value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 QuotaTypes: - - Quotas: - - ShortDescription: Example Limit - QuotaCollection: VPC - AccountId: '123456789012' + - QuotaType: global + Quotas: + - 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' + ShortDescription: Example Limit + UsedValue: 0 + - QuotaType: vpc-12345678 + Quotas: + - AccountId: '123456789012' Description: Maximum number of other examples MaxValue: 50 - UsedValue: 1 Name: other_example_limit - QuotaType: vpc-12345678 + QuotaCollection: VPC + ShortDescription: Other Example Limit + UsedValue: 1 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadQuotasResponse" description: The HTTP 200 response (OK). tags: - Quota @@ -20585,29 +20713,29 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadRegionsRequest" examples: ex1: value: {} + schema: + "$ref": "#/components/schemas/ReadRegionsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadRegionsResponse" examples: ex1: value: + Regions: + - Endpoint: api.eu-west-2.outscale.com + RegionName: eu-west-2 + - Endpoint: api.us-east-2.outscale.com + RegionName: us-east-2 + - Endpoint: api.us-west-1.outscale.com + RegionName: us-west-1 ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - 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 + schema: + "$ref": "#/components/schemas/ReadRegionsResponse" description: The HTTP 200 response (OK). security: [] tags: @@ -20621,8 +20749,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadRouteTablesRequest" examples: ex1: value: @@ -20632,35 +20758,37 @@ paths: ex2: value: Filters: + LinkRouteTableMain: true NetIds: - vpc-12345678 - vpc-87654321 - LinkRouteTableMain: true + schema: + "$ref": "#/components/schemas/ReadRouteTablesRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadRouteTablesResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 RouteTables: - - Routes: - - DestinationIpRange: 10.0.0.0/16 - CreationMethod: CreateRouteTable - State: active - LinkRouteTables: - - Main: true - LinkRouteTableId: rtbassoc-12345678 - RouteTableId: rtb-12345678 + - LinkRouteTables: + - LinkRouteTableId: rtbassoc-12345678 + Main: true NetId: vpc-12345678 + RouteTableId: rtb-12345678 NetId: vpc-12345678 - Tags: [] RoutePropagatingVirtualGateways: [] RouteTableId: rtb-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Routes: + - CreationMethod: CreateRouteTable + DestinationIpRange: 10.0.0.0/16 + State: active + Tags: [] + schema: + "$ref": "#/components/schemas/ReadRouteTablesResponse" description: The HTTP 200 response (OK). '400': content: @@ -20691,8 +20819,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadSecurityGroupsRequest" examples: ex1: value: @@ -20704,37 +20830,39 @@ paths: Filters: InboundRuleIpRanges: - 192.0.2.0 + schema: + "$ref": "#/components/schemas/ReadSecurityGroupsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadSecurityGroupsResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 SecurityGroups: - - Tags: [] - SecurityGroupName: security-group-example - OutboundRules: - - FromPortRange: -1 - IpProtocol: "-1" - ToPortRange: -1 - IpRanges: - - 0.0.0.0/0 - SecurityGroupId: sg-12345678 - AccountId: '123456789012' + - AccountId: '123456789012' Description: Example of security group InboundRules: - FromPortRange: 22 IpProtocol: tcp - ToPortRange: 22 IpRanges: - 192.0.2.0 - 198.51.100.0 + ToPortRange: 22 NetId: vpc-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + OutboundRules: + - FromPortRange: -1 + IpProtocol: "-1" + IpRanges: + - 0.0.0.0/0 + ToPortRange: -1 + SecurityGroupId: sg-12345678 + SecurityGroupName: security-group-example + Tags: [] + schema: + "$ref": "#/components/schemas/ReadSecurityGroupsResponse" description: The HTTP 200 response (OK). '400': content: @@ -20763,30 +20891,30 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadServerCertificatesRequest" examples: ex1: value: Filters: Paths: - "/example/" + schema: + "$ref": "#/components/schemas/ReadServerCertificatesRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadServerCertificatesResponse" examples: ex1: value: - 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 + ServerCertificates: + - Id: ABCDEFGHIJKLMNOPQRSTUVWXYZ1234 + Name: server-cert-example + Orn: orn:ows:idauth::012345678910:server-certificate/example/server-cert-example + Path: "/example/" + schema: + "$ref": "#/components/schemas/ReadServerCertificatesResponse" description: The HTTP 200 response (OK). tags: - ServerCertificate @@ -20797,36 +20925,36 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadSnapshotExportTasksRequest" examples: ex1: value: Filters: TaskIds: - snap-export-12345678 + schema: + "$ref": "#/components/schemas/ReadSnapshotExportTasksRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadSnapshotExportTasksResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 SnapshotExportTasks: - - Tags: [] - TaskId: snap-export-12345678 - Comment: Export of snapshot snap-12345678 + - Comment: Export of snapshot snap-12345678 OsuExport: - OsuPrefix: PREFIX - OsuBucket: BUCKET DiskImageFormat: qcow2 - State: pending - SnapshotId: snap-12345678 + OsuBucket: BUCKET + OsuPrefix: PREFIX Progress: 99 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + SnapshotId: snap-12345678 + State: pending + Tags: [] + TaskId: snap-export-12345678 + schema: + "$ref": "#/components/schemas/ReadSnapshotExportTasksResponse" description: The HTTP 200 response (OK). tags: - Snapshot @@ -20838,8 +20966,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadSnapshotsRequest" examples: ex1: value: @@ -20854,49 +20980,51 @@ paths: TagValues: - prod - test + schema: + "$ref": "#/components/schemas/ReadSnapshotsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadSnapshotsResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Snapshots: - - VolumeSize: 10 - AccountId: '123456789012' - VolumeId: vol-12345678 + - AccountId: '123456789012' CreationDate: '2010-10-01T12:34:56.789Z' + Description: Snapshot created from a volume PermissionsToCreateVolume: - GlobalPermission: false AccountIds: [] + GlobalPermission: false Progress: 100 SnapshotId: snap-12345678 State: completed - Description: Snapshot created from a volume Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + VolumeId: vol-12345678 + VolumeSize: 10 ex2: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Snapshots: - - VolumeSize: 10 - AccountId: '123456789012' - VolumeId: vol-12345678 + - AccountId: '123456789012' CreationDate: '2010-10-01T12:34:56.789Z' + Description: Test snapshot PermissionsToCreateVolume: - GlobalPermission: false AccountIds: [] + GlobalPermission: false Progress: 100 SnapshotId: snap-12345678 State: completed - Description: Test snapshot Tags: - - Value: test - Key: env - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + - Key: env + Value: test + VolumeId: vol-12345678 + VolumeSize: 10 + schema: + "$ref": "#/components/schemas/ReadSnapshotsResponse" description: The HTTP 200 response (OK). '400': content: @@ -20927,8 +21055,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadSubnetsRequest" examples: ex1: value: @@ -20943,26 +21069,28 @@ paths: - pending SubregionNames: - eu-west-2a + schema: + "$ref": "#/components/schemas/ReadSubnetsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadSubnetsResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Subnets: - - Tags: [] - SubregionName: eu-west-2a - SubnetId: subnet-12345678 - AvailableIpsCount: 16379 + - AvailableIpsCount: 16379 IpRange: 10.0.0.0/18 MapPublicIpOnLaunch: false - State: available NetId: vpc-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + State: available + SubnetId: subnet-12345678 + SubregionName: eu-west-2a + Tags: [] + schema: + "$ref": "#/components/schemas/ReadSubnetsResponse" description: The HTTP 200 response (OK). '400': content: @@ -20994,8 +21122,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadSubregionsRequest" examples: ex1: summary: Listing a specific Subregion in the current Region @@ -21010,37 +21136,39 @@ paths: SubregionNames: - eu-west-2a - eu-west-2b + schema: + "$ref": "#/components/schemas/ReadSubregionsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadSubregionsResponse" examples: ex1: summary: Listing a specific Subregion in the current Region value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Subregions: - - State: available + - LocationCode: PAR1 RegionName: eu-west-2 + State: available SubregionName: eu-west-2a - LocationCode: PAR1 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Listing two specific Subregions in the current Region value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Subregions: - - State: available + - LocationCode: PAR1 RegionName: eu-west-2 + State: available SubregionName: eu-west-2a - LocationCode: PAR1 - - State: available + - LocationCode: PAR4 RegionName: eu-west-2 + State: available SubregionName: eu-west-2b - LocationCode: PAR4 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadSubregionsResponse" description: The HTTP 200 response (OK). tags: - Subregion @@ -21051,32 +21179,32 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadTagsRequest" examples: ex1: value: Filters: - ResourceTypes: - - snapshot Keys: - key1 + ResourceTypes: + - snapshot + schema: + "$ref": "#/components/schemas/ReadTagsRequest" 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 + Tags: + - Key: key1 + ResourceId: snap-12345678 + ResourceType: snapshot + Value: value1 + schema: + "$ref": "#/components/schemas/ReadTagsResponse" description: The HTTP 200 response (OK). '400': content: @@ -21105,32 +21233,32 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadUnitPriceRequest" examples: ex1: value: Operation: CreateVolume Service: TinaOS-FCU Type: BSU:VolumeIOPS:io1 + schema: + "$ref": "#/components/schemas/ReadUnitPriceRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadUnitPriceResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 UnitPriceEntry: - UnitPrice: 0.01 - Unit: PER_IOPS_PER_MONTH Currency: EUR Operation: CreateVolume - Type: BSU:VolumeIOPS:io1 Service: TinaOS-FCU + Type: BSU:VolumeIOPS:io1 + Unit: PER_IOPS_PER_MONTH + UnitPrice: 0.01 + schema: + "$ref": "#/components/schemas/ReadUnitPriceResponse" description: The HTTP 200 response (OK). tags: - Catalog @@ -21141,19 +21269,17 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadUserGroupRequest" examples: ex1: value: Path: "/example/" UserGroupName: example-usergroup + schema: + "$ref": "#/components/schemas/ReadUserGroupRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadUserGroupResponse" examples: ex1: value: @@ -21173,6 +21299,8 @@ paths: UserEmail: user@example.com UserId: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 UserName: example-user + schema: + "$ref": "#/components/schemas/ReadUserGroupResponse" description: The HTTP 200 response (OK). tags: - UserGroup @@ -21183,8 +21311,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadUserGroupPoliciesRequest" examples: ex1: value: @@ -21192,17 +21318,15 @@ paths: ResultsPerPage: 30 UserGroupName: example-usergroup UserGroupPath: "/example/" + schema: + "$ref": "#/components/schemas/ReadUserGroupPoliciesRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadUserGroupPoliciesResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 HasMoreItems: true MaxResultsLimit: 30 MaxResultsTruncated: true @@ -21210,6 +21334,10 @@ paths: - Body: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], "Resource": ["*"]} ]}' Name: example-policy + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadUserGroupPoliciesResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -21221,29 +21349,29 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadUserGroupPolicyRequest" examples: ex1: value: PolicyName: example-policy UserGroupName: example-usergroup UserGroupPath: "/example/" + schema: + "$ref": "#/components/schemas/ReadUserGroupPolicyRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadUserGroupPolicyResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Policy: Body: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], "Resource": ["*"]} ]}' Name: example-policy + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadUserGroupPolicyResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -21256,8 +21384,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadUserGroupsRequest" examples: ex1: value: @@ -21267,20 +21393,20 @@ paths: - ug-12345678 FirstItem: 1 ResultsPerPage: 30 + schema: + "$ref": "#/components/schemas/ReadUserGroupsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadUserGroupsResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 HasMoreItems: true MaxResultsLimit: 30 MaxResultsTruncated: true + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 UserGroups: - CreationDate: '2010-10-01T12:34:56.789Z' LastModificationDate: '2010-10-01T12:34:56.789Z' @@ -21288,6 +21414,8 @@ paths: Orn: orn:ows:idauth::012345678910:usergroup/example/usergroup-example Path: "/example/" UserGroupId: ug-12345678 + schema: + "$ref": "#/components/schemas/ReadUserGroupsResponse" description: The HTTP 200 response (OK). tags: - UserGroup @@ -21298,19 +21426,17 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadUserGroupsPerUserRequest" examples: ex1: value: UserName: example-user UserPath: "/example/" + schema: + "$ref": "#/components/schemas/ReadUserGroupsPerUserRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadUserGroupsPerUserResponse" examples: ex1: value: @@ -21323,6 +21449,8 @@ paths: Orn: orn:ows:idauth::012345678910:usergroup/example/usergroup-example Path: "/example/" UserGroupId: ug-12345678 + schema: + "$ref": "#/components/schemas/ReadUserGroupsPerUserResponse" description: The HTTP 200 response (OK). tags: - UserGroup @@ -21333,18 +21461,16 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadUserPoliciesRequest" examples: ex1: value: UserName: example-user + schema: + "$ref": "#/components/schemas/ReadUserPoliciesRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadUserPoliciesResponse" examples: ex1: value: @@ -21352,6 +21478,8 @@ paths: - example-policy ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadUserPoliciesResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -21363,19 +21491,17 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadUserPolicyRequest" examples: ex1: value: - UserName: example-user PolicyName: example-user-policy + UserName: example-user + schema: + "$ref": "#/components/schemas/ReadUserPolicyRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadUserPolicyResponse" examples: ex1: value: @@ -21383,6 +21509,8 @@ paths: ["*"], "Resource": ["*"]} ]}' PolicyName: example-user-policy UserName: example-user + schema: + "$ref": "#/components/schemas/ReadUserPolicyResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -21395,30 +21523,30 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadUsersRequest" examples: ex1: value: Filters: UserIds: - ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 + schema: + "$ref": "#/components/schemas/ReadUsersRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadUsersResponse" examples: ex1: value: - Users: - - UserEmail: user@example.com - UserName: example-user - UserId: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 - Path: "/documentation/" ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Users: + - Path: "/documentation/" + UserEmail: user@example.com + UserId: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 + UserName: example-user + schema: + "$ref": "#/components/schemas/ReadUsersResponse" description: The HTTP 200 response (OK). tags: - User @@ -21429,8 +21557,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadVirtualGatewaysRequest" examples: ex1: value: @@ -21440,40 +21566,42 @@ paths: ex2: value: Filters: - States: - - available LinkStates: - attached - detached + States: + - available + schema: + "$ref": "#/components/schemas/ReadVirtualGatewaysRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadVirtualGatewaysResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VirtualGateways: - - VirtualGatewayId: vgw-12345678 - ConnectionType: ipsec.1 + - ConnectionType: ipsec.1 NetToVirtualGatewayLinks: [] State: available Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + VirtualGatewayId: vgw-12345678 ex2: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VirtualGateways: - - VirtualGatewayId: vgw-12345678 - ConnectionType: ipsec.1 + - ConnectionType: ipsec.1 NetToVirtualGatewayLinks: - - State: attached - NetId: vpc-12345678 + - NetId: vpc-12345678 + State: attached State: available Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + VirtualGatewayId: vgw-12345678 + schema: + "$ref": "#/components/schemas/ReadVirtualGatewaysResponse" description: The HTTP 200 response (OK). tags: - VirtualGateway @@ -21488,40 +21616,40 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadVmGroupsRequest" examples: ex1: value: Filters: VmGroupIds: - vmgroup-12345678901234567890123456789012 + schema: + "$ref": "#/components/schemas/ReadVmGroupsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadVmGroupsResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VmGroups: - - SecurityGroupIds: - - sg-87654321 - VmIds: - - i-12345678 - CreationDate: 2010-10-01 12:34:56.789000000 +00:00 - VmCount: 1 - VmGroupName: ClusterLog-PPD01 - SubnetId: subnet-12345678 + - CreationDate: 2010-10-01 12:34:56.789000000 +00:00 PositioningStrategy: attract + SecurityGroupIds: + - sg-87654321 State: available - VmGroupId: vmgroup-12345678901234567890123456789012 + SubnetId: subnet-12345678 Tags: - - Value: value1 - Key: key1 + - Key: key1 + Value: value1 + VmCount: 1 + VmGroupId: vmgroup-12345678901234567890123456789012 + VmGroupName: ClusterLog-PPD01 + VmIds: + - i-12345678 + schema: + "$ref": "#/components/schemas/ReadVmGroupsResponse" description: The HTTP 200 response (OK). '400': content: @@ -21554,8 +21682,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadVmTemplatesRequest" examples: ex1: value: @@ -21569,28 +21695,30 @@ paths: - 2 CpuGenerations: - v4 + schema: + "$ref": "#/components/schemas/ReadVmTemplatesRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadVmTemplatesResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VmTemplates: - - VmTemplateName: vmtemplate-example + - CpuCores: 2 + CpuGeneration: v4 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 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Tags: [] + VmTemplateId: vmtemplate-98765432109876543210987654321012 + VmTemplateName: vmtemplate-example + schema: + "$ref": "#/components/schemas/ReadVmTemplatesResponse" description: The HTTP 200 response (OK). tags: - VmTemplate @@ -21601,32 +21729,32 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadVmTypesRequest" examples: ex1: value: Filters: VmTypeNames: - t2.small + schema: + "$ref": "#/components/schemas/ReadVmTypesRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadVmTypesResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VmTypes: - - VolumeCount: 0 - VmTypeName: t2.small - BsuOptimized: false + - BsuOptimized: false MaxPrivateIps: 4 MemorySize: 2 VcoreCount: 1 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + VmTypeName: t2.small + VolumeCount: 0 + schema: + "$ref": "#/components/schemas/ReadVmTypesResponse" description: The HTTP 200 response (OK). security: [] tags: @@ -21640,8 +21768,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadVmsRequest" examples: ex1: value: @@ -21656,82 +21782,87 @@ paths: TagValues: - prod - test + schema: + "$ref": "#/components/schemas/ReadVmsRequest" 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 + application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Vms: + - ActionsOnNextBoot: + SecureBoot: none Architecture: x86_64 - NestedVirtualization: false BlockDeviceMappings: - - DeviceName: "/dev/sda1" - Bsu: - VolumeId: vol-12345678 - State: attached - LinkDate: '2010-10-01T12:34:56.789Z' + - Bsu: 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 + LinkDate: '2010-10-01T12:34:56.789Z' + State: attached + VolumeId: vol-12345678 + DeviceName: "/dev/sda1" + BootMode: legacy BsuOptimized: false + CreationDate: '2010-10-01T12:34:56.789Z' + DeletionProtection: false + Hypervisor: xen + ImageId: ami-12345678 + IsSourceDestChecked: true + KeypairName: keypair-example LaunchNumber: 0 + NestedVirtualization: false NetId: vpc-12345678 Nics: - - SubnetId: subnet-12345678 - State: in-use + - AccountId: '123456789012' + Description: Primary network interface + IsSourceDestChecked: true LinkNic: - State: attached + DeleteOnVmDeletion: true 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 + State: attached MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - IsPrimary: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - IsPrimary: true + SecurityGroups: + - SecurityGroupId: sg-12345678 + SecurityGroupName: security-group-example + State: in-use + SubnetId: subnet-12345678 Performance: high - Tags: - - Value: prod - Key: env + Placement: + SubregionName: eu-west-2a + Tenancy: default PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + PrivateIp: 10.0.0.4 + ProductCodes: + - '0001' + ReservationId: r-12345678 + RootDeviceName: "/dev/sda1" + RootDeviceType: ebs + SecurityGroups: + - SecurityGroupId: sg-12345678 + SecurityGroupName: security-group-example + State: running + StateReason: '' + SubnetId: subnet-12345678 + Tags: + - Key: env + Value: prod + UserData: '' + VmId: i-12345678 + VmInitiatedShutdownBehavior: stop + VmType: tinav5.c1r1p2 + schema: + "$ref": "#/components/schemas/ReadVmsResponse" description: The HTTP 200 response (OK). '400': content: @@ -21761,33 +21892,33 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadVmsHealthRequest" examples: ex1: value: - LoadBalancerName: example-lbu BackendVmIds: - i-12345678 - i-87654321 + LoadBalancerName: example-lbu + schema: + "$ref": "#/components/schemas/ReadVmsHealthRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadVmsHealthResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 BackendVmHealth: - - VmId: i-12345678 - State: UP - - VmId: i-87654321 - StateReason: ELB + - State: UP + VmId: i-12345678 + - Description: Instance registration is pending State: DOWN - Description: Instance registration is pending + StateReason: ELB + VmId: i-87654321 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadVmsHealthResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer @@ -21798,8 +21929,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadVmsStateRequest" examples: ex1: value: @@ -21809,35 +21938,37 @@ paths: Filters: SubregionNames: - eu-west-2a + schema: + "$ref": "#/components/schemas/ReadVmsStateRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadVmsStateResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VmStates: - - VmId: i-12345678 + - MaintenanceEvents: [] + SubregionName: eu-west-2a + VmId: i-12345678 VmState: running + - MaintenanceEvents: [] SubregionName: eu-west-2a - MaintenanceEvents: [] - - VmId: i-87654321 + 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 + VmStates: + - MaintenanceEvents: [] + SubregionName: eu-west-2a + VmId: i-12345678 + VmState: running + schema: + "$ref": "#/components/schemas/ReadVmsStateResponse" description: The HTTP 200 response (OK). '400': content: @@ -21866,8 +21997,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadVolumesRequest" examples: ex1: value: @@ -21882,32 +22011,34 @@ paths: VolumeTypes: - gp2 - io1 + schema: + "$ref": "#/components/schemas/ReadVolumesRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadVolumesResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Volumes: - - VolumeId: vol-12345678 - Tags: [] - VolumeType: gp2 - SubregionName: eu-west-2a - State: in-use - CreationDate: '2010-10-01T12:34:56.789Z' + - CreationDate: '2010-10-01T12:34:56.789Z' Iops: 100 LinkedVolumes: - - VolumeId: vol-12345678 - DeleteOnVmDeletion: false + - DeleteOnVmDeletion: false DeviceName: "/dev/sdb" State: attached VmId: i-12345678 + VolumeId: vol-12345678 Size: 10 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + State: in-use + SubregionName: eu-west-2a + Tags: [] + VolumeId: vol-12345678 + VolumeType: gp2 + schema: + "$ref": "#/components/schemas/ReadVolumesResponse" description: The HTTP 200 response (OK). '400': content: @@ -21936,8 +22067,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadVpnConnectionsRequest" examples: ex1: value: @@ -21952,32 +22081,34 @@ paths: VirtualGatewayIds: - vgw-12345678 - vgw-87654321 + schema: + "$ref": "#/components/schemas/ReadVpnConnectionsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadVpnConnectionsResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VpnConnections: - - Routes: [] - Tags: [] - ClientGatewayConfiguration: "..." - StaticRoutesOnly: true - VirtualGatewayId: vgw-12345678 - ConnectionType: ipsec.1 + - ClientGatewayConfiguration: "..." ClientGatewayId: cgw-12345678 + ConnectionType: ipsec.1 + Routes: [] State: pending + StaticRoutesOnly: true + Tags: [] VgwTelemetries: - - StateDescription: IPSEC IS DOWN - AcceptedRouteCount: 0 + - AcceptedRouteCount: 0 LastStateChangeDate: '2017-05-10T12:34:56.789Z' OutsideIpAddress: 192.0.2.0 + StateDescription: IPSEC IS DOWN + VirtualGatewayId: vgw-12345678 VpnConnectionId: vpn-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadVpnConnectionsResponse" description: The HTTP 200 response (OK). tags: - VpnConnection @@ -21990,24 +22121,24 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/RebootVmsRequest" examples: ex1: value: VmIds: - i-12345678 + schema: + "$ref": "#/components/schemas/RebootVmsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/RebootVmsResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/RebootVmsResponse" description: The HTTP 200 response (OK). '400': content: @@ -22041,26 +22172,26 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/RegisterVmsInLoadBalancerRequest" examples: ex1: value: - LoadBalancerName: example-lbu BackendVmIds: - i-12345678 - i-87654321 + LoadBalancerName: example-lbu + schema: + "$ref": "#/components/schemas/RegisterVmsInLoadBalancerRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/RegisterVmsInLoadBalancerResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/RegisterVmsInLoadBalancerResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer @@ -22073,23 +22204,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/RejectNetPeeringRequest" examples: ex1: value: NetPeeringId: pcx-12345678 + schema: + "$ref": "#/components/schemas/RejectNetPeeringRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/RejectNetPeeringResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/RejectNetPeeringResponse" description: The HTTP 200 response (OK). '400': content: @@ -22124,8 +22255,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/RemoveUserFromUserGroupRequest" examples: ex1: value: @@ -22133,17 +22262,19 @@ paths: UserGroupPath: "/example/" UserName: example-user UserPath: "/example/" + schema: + "$ref": "#/components/schemas/RemoveUserFromUserGroupRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/RemoveUserFromUserGroupResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/RemoveUserFromUserGroupResponse" description: The HTTP 200 response (OK). tags: - UserGroup @@ -22159,25 +22290,25 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ScaleDownVmGroupRequest" examples: ex1: summary: Removing 1 VM from a VM group value: VmGroupId: vmgroup-12345678901234567890123456789012 VmSubtraction: 1 + schema: + "$ref": "#/components/schemas/ScaleDownVmGroupRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ScaleDownVmGroupResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ScaleDownVmGroupResponse" description: The HTTP 200 response (OK). '400': content: @@ -22211,25 +22342,25 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ScaleUpVmGroupRequest" examples: ex1: summary: Adding 2 VMs in a VM group value: - VmGroupId: vmgroup-12345678901234567890123456789012 VmAddition: 2 + VmGroupId: vmgroup-12345678901234567890123456789012 + schema: + "$ref": "#/components/schemas/ScaleUpVmGroupRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ScaleUpVmGroupResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ScaleUpVmGroupResponse" description: The HTTP 200 response (OK). '400': content: @@ -22260,24 +22391,24 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/SetDefaultPolicyVersionRequest" examples: ex1: value: PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy VersionId: v1 + schema: + "$ref": "#/components/schemas/SetDefaultPolicyVersionRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/SetDefaultPolicyVersionResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/SetDefaultPolicyVersionResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -22290,28 +22421,28 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/StartVmsRequest" examples: ex1: value: VmIds: - i-12345678 + schema: + "$ref": "#/components/schemas/StartVmsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/StartVmsResponse" examples: ex1: value: - Vms: - - VmId: i-12345678 - PreviousState: stopped - CurrentState: pending ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Vms: + - CurrentState: pending + PreviousState: stopped + VmId: i-12345678 + schema: + "$ref": "#/components/schemas/StartVmsResponse" description: The HTTP 200 response (OK). '400': content: @@ -22342,28 +22473,28 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/StopVmsRequest" examples: ex1: value: VmIds: - i-12345678 + schema: + "$ref": "#/components/schemas/StopVmsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/StopVmsResponse" examples: ex1: value: - Vms: - - VmId: i-12345678 - PreviousState: running - CurrentState: stopping ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Vms: + - CurrentState: stopping + PreviousState: running + VmId: i-12345678 + schema: + "$ref": "#/components/schemas/StopVmsResponse" description: The HTTP 200 response (OK). '400': content: @@ -22394,23 +22525,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkFlexibleGpuRequest" examples: ex1: value: FlexibleGpuId: fgpu-12345678 + schema: + "$ref": "#/components/schemas/UnlinkFlexibleGpuRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkFlexibleGpuResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UnlinkFlexibleGpuResponse" description: The HTTP 200 response (OK). tags: - FlexibleGpu @@ -22422,25 +22553,25 @@ paths: operationId: UnlinkInternetService requestBody: content: - application/json: - schema: - "$ref": "#/components/schemas/UnlinkInternetServiceRequest" + application/json: examples: ex1: value: InternetServiceId: igw-12345678 NetId: vpc-12345678 + schema: + "$ref": "#/components/schemas/UnlinkInternetServiceRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkInternetServiceResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UnlinkInternetServiceResponse" description: The HTTP 200 response (OK). '400': content: @@ -22470,29 +22601,27 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkLoadBalancerBackendMachinesRequest" examples: ex1: summary: Unlinking VMs from a load balancer value: - LoadBalancerName: example-lbu BackendVmIds: - i-12345678 - i-87654321 + LoadBalancerName: example-lbu ex2: summary: Unlinking public IPs from a load balancer value: - LoadBalancerName: example-lbu BackendIps: - 192.0.2.0 - 198.51.100.0 + LoadBalancerName: example-lbu + schema: + "$ref": "#/components/schemas/UnlinkLoadBalancerBackendMachinesRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkLoadBalancerBackendMachinesResponse" examples: ex1: summary: Unlinking VMs from a load balancer @@ -22504,6 +22633,8 @@ paths: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UnlinkLoadBalancerBackendMachinesResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer @@ -22514,24 +22645,24 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkManagedPolicyFromUserGroupRequest" examples: ex1: value: PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy UserGroupName: example-usergroup + schema: + "$ref": "#/components/schemas/UnlinkManagedPolicyFromUserGroupRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkManagedPolicyFromUserGroupResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UnlinkManagedPolicyFromUserGroupResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -22544,23 +22675,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkNicRequest" examples: ex1: value: LinkNicId: eni-attach-12345678 + schema: + "$ref": "#/components/schemas/UnlinkNicRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkNicResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UnlinkNicResponse" description: The HTTP 200 response (OK). '400': content: @@ -22589,24 +22720,24 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkPolicyRequest" examples: ex1: value: PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy UserName: example-user + schema: + "$ref": "#/components/schemas/UnlinkPolicyRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkPolicyResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UnlinkPolicyResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -22618,8 +22749,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkPrivateIpsRequest" examples: ex1: value: @@ -22627,17 +22756,19 @@ paths: PrivateIps: - 10.0.0.6 - 10.0.0.7 + schema: + "$ref": "#/components/schemas/UnlinkPrivateIpsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkPrivateIpsResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UnlinkPrivateIpsResponse" description: The HTTP 200 response (OK). '400': content: @@ -22670,23 +22801,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkPublicIpRequest" examples: ex1: value: PublicIp: 192.0.2.0 + schema: + "$ref": "#/components/schemas/UnlinkPublicIpRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkPublicIpResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UnlinkPublicIpResponse" description: The HTTP 200 response (OK). '400': content: @@ -22717,23 +22848,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkRouteTableRequest" examples: ex1: value: LinkRouteTableId: rtbassoc-12345678 + schema: + "$ref": "#/components/schemas/UnlinkRouteTableRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkRouteTableResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UnlinkRouteTableResponse" description: The HTTP 200 response (OK). '400': content: @@ -22764,24 +22895,24 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkVirtualGatewayRequest" examples: ex1: value: - VirtualGatewayId: vgw-12345678 NetId: vpc-12345678 + VirtualGatewayId: vgw-12345678 + schema: + "$ref": "#/components/schemas/UnlinkVirtualGatewayRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkVirtualGatewayResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UnlinkVirtualGatewayResponse" description: The HTTP 200 response (OK). tags: - VirtualGateway @@ -22794,23 +22925,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkVolumeRequest" examples: ex1: value: VolumeId: vol-12345678 + schema: + "$ref": "#/components/schemas/UnlinkVolumeRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkVolumeResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UnlinkVolumeResponse" description: The HTTP 200 response (OK). '400': content: @@ -22841,15 +22972,13 @@ paths: requestBody: content: 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' + State: ACTIVE ex2: summary: Updating the state of one of your own access keys (if you are the root account or an EIM user) @@ -22862,36 +22991,38 @@ paths: AccessKeyId: ABCDEFGHIJ0123456789 State: ACTIVE UserName: example-user + schema: + "$ref": "#/components/schemas/UpdateAccessKeyRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateAccessKeyResponse" examples: ex1: summary: Updating an access key when using the parameter ExpirationDate value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 AccessKey: - State: ACTIVE AccessKeyId: ABCDEFGHIJ0123456789 CreationDate: 2010-10-01 12:34:56.789000000 +00:00 ExpirationDate: 2063-04-05 00:00:00.000000000 +00:00 LastModificationDate: 2017-05-10 12:34:56.789000000 +00:00 + State: ACTIVE Tag: Group1 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Updating an access key when not using the parameter ExpirationDate value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 AccessKey: - State: ACTIVE AccessKeyId: ABCDEFGHIJ0123456789 CreationDate: 2010-10-01 12:34:56.789000000 +00:00 LastModificationDate: 2017-05-10 12:34:56.789000000 +00:00 + State: ACTIVE Tag: Group1 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UpdateAccessKeyResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -22905,38 +23036,38 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateAccountRequest" examples: ex1: value: AdditionalEmails: - another@example.com - yet.another@example.com + schema: + "$ref": "#/components/schemas/UpdateAccountRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateAccountResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Account: - ZipCode: '92210' - CompanyName: EXAMPLE SAS - FirstName: JEAN + AccountId: '123456789012' AdditionalEmails: - another@example.com - yet.another@example.com City: SAINT-CLOUD + CompanyName: EXAMPLE SAS Country: FRANCE - LastName: DUPONT - AccountId: '123456789012' CustomerId: '87654321' Email: example@example.com + FirstName: JEAN + LastName: DUPONT + ZipCode: '92210' + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UpdateAccountResponse" description: The HTTP 200 response (OK). tags: - Account @@ -22951,8 +23082,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateApiAccessPolicyRequest" examples: ex1: summary: Require expiration dates of maximum 1 year @@ -22971,39 +23100,41 @@ paths: value: MaxAccessKeyExpirationSeconds: 0 RequireTrustedEnv: false + schema: + "$ref": "#/components/schemas/UpdateApiAccessPolicyRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateApiAccessPolicyResponse" examples: ex1: summary: Require expiration dates of maximum 1 year value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ApiAccessPolicy: - RequireTrustedEnv: false MaxAccessKeyExpirationSeconds: 31536000 + RequireTrustedEnv: false + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 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 + RequireTrustedEnv: true + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 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 + RequireTrustedEnv: false + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UpdateApiAccessPolicyResponse" description: The HTTP 200 response (OK). '400': content: @@ -23040,33 +23171,33 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateApiAccessRuleRequest" examples: ex1: value: ApiAccessRuleId: aar-1234567890abcdef1234567890abcdef + Description: Allows all Ipv4 domain IpRanges: - 0.0.0.0/0 - Description: Allows all Ipv4 domain + schema: + "$ref": "#/components/schemas/UpdateApiAccessRuleRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateApiAccessRuleResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ApiAccessRule: - IpRanges: - - 0.0.0.0/0 ApiAccessRuleId: aar-1234567890abcdef1234567890abcdef CaIds: [] Cns: [] Description: Allows all IPv4 domain + IpRanges: + - 0.0.0.0/0 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UpdateApiAccessRuleResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -23081,28 +23212,28 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateCaRequest" examples: ex1: value: CaId: ca-fedcba0987654321fedcba0987654321 Description: New description + schema: + "$ref": "#/components/schemas/UpdateCaRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateCaResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Ca: - Description: New description - CaId: ca-fedcba0987654321fedcba0987654321 CaFingerprint: 1234567890abcdef1234567890abcdef12345678 + CaId: ca-fedcba0987654321fedcba0987654321 + Description: New description + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UpdateCaResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -23120,34 +23251,34 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateDedicatedGroupRequest" examples: ex1: value: DedicatedGroupId: ded-12345678 Name: New-dedicated-group-name + schema: + "$ref": "#/components/schemas/UpdateDedicatedGroupRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateDedicatedGroupResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 DedicatedGroup: - VmIds: - - i-12345678 - NetIds: - - vpc-12345678 AccountId: '123456789012' CpuGeneration: 4 + DedicatedGroupId: ded-12345678 Name: New-dedicated-group-name + NetIds: + - vpc-12345678 SubregionName: eu-west-2a - DedicatedGroupId: ded-12345678 + VmIds: + - i-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UpdateDedicatedGroupResponse" description: The HTTP 200 response (OK). '400': content: @@ -23176,38 +23307,38 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateDirectLinkInterfaceRequest" examples: ex1: value: DirectLinkInterfaceId: dxvif-12345678 Mtu: 1500 + schema: + "$ref": "#/components/schemas/UpdateDirectLinkInterfaceRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateDirectLinkInterfaceResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 DirectLinkInterface: - Vlan: 101 - OutscalePrivateIp: 172.16.0.4/30 - DirectLinkInterfaceId: dxvif-12345678 - BgpAsn: 65000 AccountId: '123456789012' + BgpAsn: 65000 ClientPrivateIp: 172.16.0.5/30 - VirtualGatewayId: vgw-12345678 - DirectLinkInterfaceName: MyDirectLinkInterface DirectLinkId: dxcon-12345678 - Mtu: 1500 - State: available + DirectLinkInterfaceId: dxvif-12345678 + DirectLinkInterfaceName: MyDirectLinkInterface InterfaceType: private Location: PAR1 + Mtu: 1500 + OutscalePrivateIp: 172.16.0.4/30 + State: available + VirtualGatewayId: vgw-12345678 + Vlan: 101 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UpdateDirectLinkInterfaceResponse" description: The HTTP 200 response (OK). tags: - DirectLinkInterface @@ -23218,24 +23349,20 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateFlexibleGpuRequest" examples: ex1: value: - FlexibleGpuId: fgpu-12345678 DeleteOnVmDeletion: false + FlexibleGpuId: fgpu-12345678 + schema: + "$ref": "#/components/schemas/UpdateFlexibleGpuRequest" 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 @@ -23243,6 +23370,10 @@ paths: ModelName: nvidia-p100 State: allocated SubregionName: eu-west-2a + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UpdateFlexibleGpuResponse" description: The HTTP 200 response (OK). tags: - FlexibleGpu @@ -23255,9 +23386,7 @@ paths: operationId: UpdateImage requestBody: content: - application/json: - schema: - "$ref": "#/components/schemas/UpdateImageRequest" + application/json: examples: ex1: summary: Adding permission @@ -23285,143 +23414,145 @@ paths: ex4: summary: Making an image private to everyone value: - ImageId: ami-12345678 Description: Private image + ImageId: ami-12345678 PermissionsToLaunch: Removals: GlobalPermission: true + schema: + "$ref": "#/components/schemas/UpdateImageRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateImageResponse" examples: ex1: summary: Adding permission value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Image: - StateComment: {} - State: available - RootDeviceType: bsu - RootDeviceName: "/dev/sda1" - ProductCodes: - - '0001' - PermissionsToLaunch: - GlobalPermission: false - AccountIds: - - '987654321098' AccountId: '123456789012' - Tags: [] - Description: '' - ImageId: ami-12345678 + Architecture: x86_64 BlockDeviceMappings: - - DeviceName: "/dev/sda1" - Bsu: - VolumeType: standard + - Bsu: DeleteOnVmDeletion: true - VolumeSize: 50 SnapshotId: snap-12345678 - ImageType: machine + VolumeSize: 50 + VolumeType: standard + DeviceName: "/dev/sda1" CreationDate: '2010-10-01T12:34:56.789Z' + Description: '' FileLocation: 123456789012/image-example - Architecture: x86_64 + ImageId: ami-12345678 ImageName: image-example + ImageType: machine + PermissionsToLaunch: + AccountIds: + - '987654321098' + GlobalPermission: false + ProductCodes: + - '0001' + RootDeviceName: "/dev/sda1" + RootDeviceType: bsu + State: available + StateComment: {} + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Removing permission value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Image: - StateComment: {} - State: available - RootDeviceType: bsu - RootDeviceName: "/dev/sda1" - ProductCodes: - - '0001' - PermissionsToLaunch: - GlobalPermission: false - AccountIds: [] AccountId: '123456789012' - Tags: [] - Description: '' - ImageId: ami-12345678 + Architecture: x86_64 BlockDeviceMappings: - - DeviceName: "/dev/sda1" - Bsu: - VolumeType: standard + - Bsu: DeleteOnVmDeletion: true - VolumeSize: 50 SnapshotId: snap-12345678 - ImageType: machine + VolumeSize: 50 + VolumeType: standard + DeviceName: "/dev/sda1" CreationDate: '2010-10-01T12:34:56.789Z' + Description: '' FileLocation: 123456789012/image-example - Architecture: x86_64 + ImageId: ami-12345678 ImageName: image-example + ImageType: machine + PermissionsToLaunch: + AccountIds: [] + GlobalPermission: false + ProductCodes: + - '0001' + RootDeviceName: "/dev/sda1" + RootDeviceType: bsu + State: available + StateComment: {} + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex3: summary: Making an image public to everyone value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Image: - StateComment: {} - State: available - RootDeviceType: bsu - RootDeviceName: "/dev/sda1" - ProductCodes: - - '0001' - PermissionsToLaunch: - GlobalPermission: true - AccountIds: [] AccountId: '123456789012' - Tags: [] - Description: '' - ImageId: ami-12345678 + Architecture: x86_64 BlockDeviceMappings: - - DeviceName: "/dev/sda1" - Bsu: - VolumeType: standard + - Bsu: DeleteOnVmDeletion: true - VolumeSize: 50 SnapshotId: snap-12345678 - ImageType: machine + VolumeSize: 50 + VolumeType: standard + DeviceName: "/dev/sda1" CreationDate: '2010-10-01T12:34:56.789Z' + Description: '' FileLocation: 123456789012/image-example - Architecture: x86_64 + ImageId: ami-12345678 ImageName: image-example + ImageType: machine + PermissionsToLaunch: + AccountIds: [] + GlobalPermission: true + ProductCodes: + - '0001' + RootDeviceName: "/dev/sda1" + RootDeviceType: bsu + State: available + StateComment: {} + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex4: summary: Making an image private to everyone value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Image: - StateComment: {} - State: available - RootDeviceType: bsu - RootDeviceName: "/dev/sda1" - ProductCodes: - - '0001' - PermissionsToLaunch: - GlobalPermission: false - AccountIds: [] AccountId: '123456789012' - Tags: [] - Description: Private image - ImageId: ami-12345678 + Architecture: x86_64 BlockDeviceMappings: - - DeviceName: "/dev/sda1" - Bsu: - VolumeType: standard + - Bsu: DeleteOnVmDeletion: true - VolumeSize: 50 SnapshotId: snap-12345678 - ImageType: machine + VolumeSize: 50 + VolumeType: standard + DeviceName: "/dev/sda1" CreationDate: '2010-10-01T12:34:56.789Z' + Description: Private image FileLocation: 123456789012/image-example - Architecture: x86_64 + ImageId: ami-12345678 ImageName: image-example + ImageType: machine + PermissionsToLaunch: + AccountIds: [] + GlobalPermission: false + ProductCodes: + - '0001' + RootDeviceName: "/dev/sda1" + RootDeviceType: bsu + State: available + StateComment: {} + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UpdateImageResponse" description: The HTTP 200 response (OK). '400': content: @@ -23452,33 +23583,33 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateListenerRuleRequest" examples: ex1: value: - ListenerRuleName: example-listener-rule HostPattern: "*.newhost.com" + ListenerRuleName: example-listener-rule + schema: + "$ref": "#/components/schemas/UpdateListenerRuleRequest" 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" + ListenerId: 123456 ListenerRuleId: 1234 + ListenerRuleName: example-listener-rule + Priority: 10 + VmIds: + - i-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UpdateListenerRuleResponse" description: The HTTP 200 response (OK). tags: - Listener @@ -23496,30 +23627,28 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateLoadBalancerRequest" examples: ex1: summary: Updating health checks value: - LoadBalancerName: private-lb-example HealthCheck: - HealthyThreshold: 10 CheckInterval: 30 + HealthyThreshold: 10 Path: "/index.html" Port: 8080 Protocol: HTTPS Timeout: 5 UnhealthyThreshold: 5 + LoadBalancerName: private-lb-example ex2: summary: Updating access logs value: - LoadBalancerName: private-lb-example AccessLog: - PublicationInterval: 5 IsEnabled: true OsuBucketName: BUCKET OsuBucketPrefix: PREFIX + PublicationInterval: 5 + LoadBalancerName: private-lb-example ex3: summary: Updating policies value: @@ -23533,182 +23662,184 @@ paths: LoadBalancerName: private-lb-example LoadBalancerPort: 443 ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/AnotherCertificate + schema: + "$ref": "#/components/schemas/UpdateLoadBalancerRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateLoadBalancerResponse" examples: ex1: summary: Updating health checks value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 LoadBalancer: - Tags: [] - SourceSecurityGroup: - SecurityGroupName: security-group-example - SecurityGroupAccountId: '123456789012' - SecuredCookies: false - PublicIp: 192.0.2.0 - Subnets: - - subnet-12345678 - NetId: vpc-12345678 - BackendVmIds: [] - ApplicationStickyCookiePolicies: [] - SecurityGroups: - - sg-12345678 - LoadBalancerType: internet-facing AccessLog: - PublicationInterval: 60 IsEnabled: false + PublicationInterval: 60 + ApplicationStickyCookiePolicies: [] + BackendVmIds: [] 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 + Path: "/index.html" Port: 8080 - LoadBalancerStickyCookiePolicies: [] - SubregionNames: - - eu-west-2a + Protocol: HTTPS + Timeout: 5 + UnhealthyThreshold: 5 Listeners: - - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate - BackendPort: 80 + - BackendPort: 80 BackendProtocol: HTTP LoadBalancerPort: 443 LoadBalancerProtocol: HTTPS + ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate LoadBalancerName: private-lb-example - ex2: - summary: Updating access logs - value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - LoadBalancer: - Tags: [] + LoadBalancerStickyCookiePolicies: [] + LoadBalancerType: internet-facing + NetId: vpc-12345678 + PublicIp: 192.0.2.0 + SecuredCookies: false + SecurityGroups: + - sg-12345678 SourceSecurityGroup: - SecurityGroupName: security-group-example SecurityGroupAccountId: '123456789012' - SecuredCookies: false - PublicIp: 192.0.2.0 + SecurityGroupName: security-group-example Subnets: - subnet-12345678 - NetId: vpc-12345678 - BackendVmIds: [] - ApplicationStickyCookiePolicies: [] - SecurityGroups: - - sg-12345678 - LoadBalancerType: internet-facing + SubregionNames: + - eu-west-2a + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + summary: Updating access logs + value: + LoadBalancer: AccessLog: - PublicationInterval: 5 - OsuBucketPrefix: PREFIX - OsuBucketName: BUCKET IsEnabled: true + OsuBucketName: BUCKET + OsuBucketPrefix: PREFIX + PublicationInterval: 5 + ApplicationStickyCookiePolicies: [] + BackendVmIds: [] 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 + Protocol: TCP + Timeout: 5 + UnhealthyThreshold: 2 Listeners: - - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate - BackendPort: 80 + - BackendPort: 80 BackendProtocol: HTTP LoadBalancerPort: 443 LoadBalancerProtocol: HTTPS + ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate LoadBalancerName: private-lb-example - ex3: - summary: Updating policies - value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - LoadBalancer: - Tags: [] + LoadBalancerStickyCookiePolicies: [] + LoadBalancerType: internet-facing + NetId: vpc-12345678 + PublicIp: 192.0.2.0 + SecuredCookies: false + SecurityGroups: + - sg-12345678 SourceSecurityGroup: - SecurityGroupName: security-group-example SecurityGroupAccountId: '123456789012' - SecuredCookies: false - PublicIp: 192.0.2.0 + SecurityGroupName: security-group-example Subnets: - subnet-12345678 - NetId: vpc-12345678 - BackendVmIds: [] - ApplicationStickyCookiePolicies: [] - SecurityGroups: - - sg-12345678 - LoadBalancerType: internet-facing + SubregionNames: + - eu-west-2a + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex3: + summary: Updating policies + value: + LoadBalancer: AccessLog: - PublicationInterval: 60 IsEnabled: false + PublicationInterval: 60 + ApplicationStickyCookiePolicies: [] + BackendVmIds: [] 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 + Protocol: TCP + Timeout: 5 + UnhealthyThreshold: 2 Listeners: - - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate - BackendPort: 80 + - BackendPort: 80 BackendProtocol: HTTP LoadBalancerPort: 443 LoadBalancerProtocol: HTTPS + ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate LoadBalancerName: private-lb-example - ex4: - summary: Updating SSL certificate - value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - LoadBalancer: - Tags: [] + LoadBalancerStickyCookiePolicies: + - CookieExpirationPeriod: 1 + PolicyName: example-browser-policy + LoadBalancerType: internet-facing + NetId: vpc-12345678 + PublicIp: 192.0.2.0 + SecuredCookies: false + SecurityGroups: + - sg-12345678 SourceSecurityGroup: - SecurityGroupName: security-group-example SecurityGroupAccountId: '123456789012' - SecuredCookies: false - PublicIp: 192.0.2.0 + SecurityGroupName: security-group-example Subnets: - subnet-12345678 - NetId: vpc-12345678 - BackendVmIds: [] - ApplicationStickyCookiePolicies: [] - SecurityGroups: - - sg-12345678 - LoadBalancerType: internet-facing + SubregionNames: + - eu-west-2a + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex4: + summary: Updating SSL certificate + value: + LoadBalancer: AccessLog: - PublicationInterval: 60 IsEnabled: false + PublicationInterval: 60 + ApplicationStickyCookiePolicies: [] + BackendVmIds: [] 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 + Protocol: TCP + Timeout: 5 + UnhealthyThreshold: 2 Listeners: - - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/AnotherCertificate - BackendPort: 80 + - BackendPort: 80 BackendProtocol: HTTP LoadBalancerPort: 443 LoadBalancerProtocol: HTTPS + ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/AnotherCertificate LoadBalancerName: private-lb-example + LoadBalancerStickyCookiePolicies: [] + LoadBalancerType: internet-facing + NetId: vpc-12345678 + PublicIp: 192.0.2.0 + SecuredCookies: false + SecurityGroups: + - sg-12345678 + SourceSecurityGroup: + SecurityGroupAccountId: '123456789012' + SecurityGroupName: security-group-example + Subnets: + - subnet-12345678 + SubregionNames: + - eu-west-2a + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UpdateLoadBalancerResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer @@ -23719,31 +23850,31 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateNetRequest" examples: ex1: value: - NetId: vpc-12345678 DhcpOptionsSetId: dopt-12345678 + NetId: vpc-12345678 + schema: + "$ref": "#/components/schemas/UpdateNetRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateNetResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Net: - Tags: [] DhcpOptionsSetId: dopt-12345678 IpRange: 10.0.0.0/16 - Tenancy: default NetId: vpc-12345678 State: available + Tags: [] + Tenancy: default + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UpdateNetResponse" description: The HTTP 200 response (OK). '400': content: @@ -23774,54 +23905,54 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateNetAccessPointRequest" examples: ex1: summary: Adding a route table value: - NetAccessPointId: vpce-12345678 AddRouteTableIds: - rtb-87654321 + NetAccessPointId: vpce-12345678 ex2: summary: Removing a route table value: NetAccessPointId: vpce-12345678 RemoveRouteTableIds: - rtb-12345678 + schema: + "$ref": "#/components/schemas/UpdateNetAccessPointRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateNetAccessPointResponse" examples: ex1: summary: Adding a route table value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 NetAccessPoint: - Tags: [] NetAccessPointId: vpce-12345678 + NetId: vpc-12345678 RouteTableIds: - rtb-12345678 - rtb-87654321 - State: available - NetId: vpc-12345678 ServiceName: com.outscale.eu-west-2.oos + State: available + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 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 + RouteTableIds: [] ServiceName: com.outscale.eu-west-2.oos + State: available + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UpdateNetAccessPointResponse" description: The HTTP 200 response (OK). tags: - NetAccessPoint @@ -23833,16 +23964,14 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateNicRequest" examples: ex1: summary: Modifying the DeleteOnVmDeletion value of a NIC value: - NicId: eni-12345678 LinkNic: DeleteOnVmDeletion: false LinkNicId: eni-attach-12345678 + NicId: eni-12345678 ex2: summary: Modifying the security groups of a NIC value: @@ -23852,108 +23981,110 @@ paths: ex3: summary: Modifying the description of a NIC value: - NicId: eni-12345678 Description: Example of description + NicId: eni-12345678 + schema: + "$ref": "#/components/schemas/UpdateNicRequest" 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 + AccountId: '123456789012' + Description: Primary network interface + IsSourceDestChecked: true LinkNic: - VmId: i-12345678 - LinkNicId: eni-attach-12345678 - VmAccountId: '123456789012' DeleteOnVmDeletion: false DeviceNumber: 0 + LinkNicId: eni-attach-12345678 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 + VmAccountId: '123456789012' + VmId: i-12345678 MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - IsPrimary: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - IsPrimary: true + SecurityGroups: + - SecurityGroupId: sg-12345678 + SecurityGroupName: default + State: in-use + SubnetId: subnet-12345678 + SubregionName: eu-west-2a + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 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 + AccountId: '123456789012' + Description: Primary network interface + IsSourceDestChecked: true LinkNic: - VmId: i-12345678 - LinkNicId: eni-attach-12345678 - VmAccountId: '123456789012' DeleteOnVmDeletion: true DeviceNumber: 0 + LinkNicId: eni-attach-12345678 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 + VmAccountId: '123456789012' + VmId: i-12345678 MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - IsPrimary: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - IsPrimary: true + SecurityGroups: + - SecurityGroupId: sg-12345678 + SecurityGroupName: security-group-example + State: in-use + SubnetId: subnet-12345678 + SubregionName: eu-west-2a + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 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 + AccountId: '123456789012' + Description: Example of description + IsSourceDestChecked: true LinkNic: - VmId: i-12345678 - LinkNicId: eni-attach-12345678 - VmAccountId: '123456789012' DeleteOnVmDeletion: true DeviceNumber: 0 + LinkNicId: eni-attach-12345678 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 + VmAccountId: '123456789012' + VmId: i-12345678 MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - IsPrimary: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - IsPrimary: true + SecurityGroups: + - SecurityGroupId: sg-12345678 + SecurityGroupName: default + State: in-use + SubnetId: subnet-12345678 + SubregionName: eu-west-2a + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UpdateNicResponse" description: The HTTP 200 response (OK). '400': content: @@ -23993,45 +24124,45 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateRouteRequest" examples: ex1: summary: Updating a route to a virtual gateway value: - RouteTableId: rtb-12345678 DestinationIpRange: 198.51.100.0/24 GatewayId: vgw-12345678 + RouteTableId: rtb-12345678 + schema: + "$ref": "#/components/schemas/UpdateRouteRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateRouteResponse" examples: ex1: summary: Updating a route to a virtual gateway value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 RouteTable: - Routes: - - DestinationIpRange: 10.0.0.0/16 - CreationMethod: CreateRouteTable - State: active - - GatewayId: vgw-12345678 - DestinationIpRange: 198.51.100.0/24 - CreationMethod: CreateRoute - State: active LinkRouteTables: - - RouteTableId: rtb-12345678 + - LinkRouteTableId: rtbassoc-12345678 Main: false + RouteTableId: rtb-12345678 SubnetId: subnet-12345678 - LinkRouteTableId: rtbassoc-12345678 NetId: vpc-12345678 - Tags: [] RoutePropagatingVirtualGateways: [] RouteTableId: rtb-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Routes: + - CreationMethod: CreateRouteTable + DestinationIpRange: 10.0.0.0/16 + State: active + - CreationMethod: CreateRoute + DestinationIpRange: 198.51.100.0/24 + GatewayId: vgw-12345678 + State: active + Tags: [] + schema: + "$ref": "#/components/schemas/UpdateRouteResponse" description: The HTTP 200 response (OK). '400': content: @@ -24061,39 +24192,39 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateRoutePropagationRequest" examples: ex1: value: - VirtualGatewayId: vgw-12345678 - RouteTableId: rtb-12345678 Enable: true + RouteTableId: rtb-12345678 + VirtualGatewayId: vgw-12345678 + schema: + "$ref": "#/components/schemas/UpdateRoutePropagationRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateRoutePropagationResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 RouteTable: - Routes: - - DestinationIpRange: 10.0.0.0/16 - CreationMethod: CreateRouteTable - State: active LinkRouteTables: - - RouteTableId: rtb-12345678 + - LinkRouteTableId: rtbassoc-12345678 Main: true - LinkRouteTableId: rtbassoc-12345678 + RouteTableId: rtb-12345678 NetId: vpc-12345678 - Tags: [] RoutePropagatingVirtualGateways: - VirtualGatewayId: vgw-12345678 RouteTableId: rtb-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Routes: + - CreationMethod: CreateRouteTable + DestinationIpRange: 10.0.0.0/16 + State: active + Tags: [] + schema: + "$ref": "#/components/schemas/UpdateRoutePropagationResponse" description: The HTTP 200 response (OK). tags: - VirtualGateway @@ -24106,25 +24237,25 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateRouteTableLinkRequest" examples: ex1: value: LinkRouteTableId: rtbassoc-12345678 RouteTableId: rtb-12345678 + schema: + "$ref": "#/components/schemas/UpdateRouteTableLinkRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateRouteTableLinkResponse" examples: ex1: value: + LinkRouteTableId: rtbassoc-12345678 ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - LinkRouteTableId: rtbassoc-12345678 + schema: + "$ref": "#/components/schemas/UpdateRouteTableLinkResponse" description: The HTTP 200 response (OK). '400': content: @@ -24153,28 +24284,28 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateServerCertificateRequest" examples: ex1: value: Name: server-cert-example NewName: new-name + schema: + "$ref": "#/components/schemas/UpdateServerCertificateRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateServerCertificateResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ServerCertificate: - Path: "/example/" Id: ABCDEFGHIJKLMNOPQRSTUVWXYZ1234 Name: new-name - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Path: "/example/" + schema: + "$ref": "#/components/schemas/UpdateServerCertificateResponse" description: The HTTP 200 response (OK). tags: - ServerCertificate @@ -24188,119 +24319,119 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateSnapshotRequest" examples: ex1: summary: Adding permission value: - SnapshotId: snap-12345678 PermissionsToCreateVolume: Additions: AccountIds: - '987654321098' + SnapshotId: snap-12345678 ex2: summary: Removing permission value: - SnapshotId: snap-12345678 PermissionsToCreateVolume: Removals: AccountIds: - '987654321098' + SnapshotId: snap-12345678 ex3: summary: Making an image public to everyone value: - SnapshotId: snap-12345678 PermissionsToCreateVolume: Additions: GlobalPermission: true + SnapshotId: snap-12345678 ex4: summary: Making an image private to everyone value: - SnapshotId: snap-12345678 PermissionsToCreateVolume: Removals: GlobalPermission: true + SnapshotId: snap-12345678 + schema: + "$ref": "#/components/schemas/UpdateSnapshotRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateSnapshotResponse" examples: ex1: summary: Adding permission value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Snapshot: - VolumeSize: 10 AccountId: '123456789012' - VolumeId: vol-12345678 CreationDate: '2010-10-01T12:34:56.789Z' + Description: Snapshot created from a volume PermissionsToCreateVolume: - GlobalPermission: false AccountIds: - '987654321098' + GlobalPermission: false Progress: 100 SnapshotId: snap-12345678 State: completed - Description: Snapshot created from a volume Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + VolumeId: vol-12345678 + VolumeSize: 10 ex2: summary: Removing permission value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Snapshot: - VolumeSize: 10 AccountId: '123456789012' - VolumeId: vol-12345678 CreationDate: '2010-10-01T12:34:56.789Z' + Description: Snapshot created from a volume PermissionsToCreateVolume: - GlobalPermission: false AccountIds: [] + GlobalPermission: false Progress: 100 SnapshotId: snap-12345678 State: completed - Description: Snapshot created from a volume Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + VolumeId: vol-12345678 + VolumeSize: 10 ex3: summary: Making an image public to everyone value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Snapshot: - VolumeSize: 10 AccountId: '123456789012' - VolumeId: vol-12345678 CreationDate: '2010-10-01T12:34:56.789Z' + Description: Snapshot created from a volume PermissionsToCreateVolume: - GlobalPermission: true AccountIds: [] + GlobalPermission: true Progress: 100 SnapshotId: snap-12345678 State: completed - Description: Snapshot created from a volume Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + VolumeId: vol-12345678 + VolumeSize: 10 ex4: summary: Making an image private to everyone value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Snapshot: - VolumeSize: 10 AccountId: '123456789012' - VolumeId: vol-12345678 CreationDate: '2010-10-01T12:34:56.789Z' + Description: Snapshot created from a volume PermissionsToCreateVolume: - GlobalPermission: false AccountIds: [] + GlobalPermission: false Progress: 100 SnapshotId: snap-12345678 State: completed - Description: Snapshot created from a volume Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + VolumeId: vol-12345678 + VolumeSize: 10 + schema: + "$ref": "#/components/schemas/UpdateSnapshotResponse" description: The HTTP 200 response (OK). '400': content: @@ -24329,33 +24460,33 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateSubnetRequest" examples: ex1: value: - SubnetId: subnet-12345678 MapPublicIpOnLaunch: true + SubnetId: subnet-12345678 + schema: + "$ref": "#/components/schemas/UpdateSubnetRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateSubnetResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Subnet: - Tags: [] - SubregionName: eu-west-2a - SubnetId: subnet-12345678 AvailableIpsCount: 16379 IpRange: 10.0.0.0/18 MapPublicIpOnLaunch: true - State: available NetId: vpc-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + State: available + SubnetId: subnet-12345678 + SubregionName: eu-west-2a + Tags: [] + schema: + "$ref": "#/components/schemas/UpdateSubnetResponse" description: The HTTP 200 response (OK). '400': content: @@ -24384,33 +24515,33 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateUserRequest" examples: ex1: value: - UserName: example-user + NewPath: "/product/" NewUserEmail: user@example.com NewUserName: test-user - NewPath: "/product/" + UserName: example-user + schema: + "$ref": "#/components/schemas/UpdateUserRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateUserResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 User: CreationDate: 2010-10-01 12:34:56.789000000 +00:00 LastModificationDate: 2017-05-10 12:34:56.789000000 +00:00 + Path: "/product/" UserEmail: user@example.com - UserName: test-user UserId: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 - Path: "/product/" - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + UserName: test-user + schema: + "$ref": "#/components/schemas/UpdateUserResponse" description: The HTTP 200 response (OK). tags: - User @@ -24421,8 +24552,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateUserGroupRequest" examples: ex1: value: @@ -24430,12 +24559,12 @@ paths: NewUserGroupName: new-usergroup Path: "/example/" UserGroupName: example-usergroup + schema: + "$ref": "#/components/schemas/UpdateUserGroupRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateUserGroupResponse" examples: ex1: value: @@ -24455,6 +24584,8 @@ paths: UserEmail: user@example.com UserId: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 UserName: example-user + schema: + "$ref": "#/components/schemas/UpdateUserGroupResponse" description: The HTTP 200 response (OK). tags: - UserGroup @@ -24466,13 +24597,13 @@ paths: * `Performance`
* `UserData`
* `VmType` + + To complete the update of secure boot, you need to do a stop/start of the VM. A simple restart is not sufficient, as the update is done when the VM goes through the stopped state. For the difference between stop/start and restart, see [About VM Lifecycle](https://docs.outscale.com/en/userguide/About-VM-Lifecycle.html). post: operationId: UpdateVm requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateVmRequest" examples: ex1: value: @@ -24480,153 +24611,159 @@ paths: VmType: tinav5.c2r2p2 ex2: value: - VmId: i-12345678 UserData: "..." + VmId: i-12345678 + schema: + "$ref": "#/components/schemas/UpdateVmRequest" 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 + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Vm: + ActionsOnNextBoot: + SecureBoot: none + Architecture: x86_64 + BlockDeviceMappings: + - Bsu: + DeleteOnVmDeletion: true + LinkDate: '2010-10-01T12:34:56.789Z' + State: attached + VolumeId: vol-12345678 + DeviceName: "/dev/sda1" BsuOptimized: false + CreationDate: '2010-10-01T12:34:56.789Z' + DeletionProtection: false + Hypervisor: xen + ImageId: ami-12345678 + IsSourceDestChecked: true + KeypairName: keypair-example LaunchNumber: 0 + NestedVirtualization: false NetId: vpc-12345678 Nics: - - SubnetId: subnet-12345678 - State: in-use + - AccountId: '123456789012' + Description: Primary network interface + IsSourceDestChecked: true LinkNic: - State: attached + DeleteOnVmDeletion: true 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 + State: attached MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - IsPrimary: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - IsPrimary: true + SecurityGroups: + - SecurityGroupId: sg-12345678 + SecurityGroupName: security-group-example + State: in-use + SubnetId: subnet-12345678 Performance: high - Tags: - - Value: prod - Key: env + Placement: + SubregionName: eu-west-2a + Tenancy: default PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + PrivateIp: 10.0.0.4 + ProductCodes: + - '0001' + ReservationId: r-12345678 + RootDeviceName: "/dev/sda1" + RootDeviceType: ebs + SecurityGroups: + - SecurityGroupId: sg-12345678 + SecurityGroupName: security-group-example + State: stopped + StateReason: '' + SubnetId: subnet-12345678 + Tags: + - Key: env + Value: prod + UserData: '' + VmId: i-12345678 + VmInitiatedShutdownBehavior: stop + VmType: tinav5.c2r2p2 ex2: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Vm: - VmType: tinav5.c1r1p2 - VmInitiatedShutdownBehavior: stop - State: stopped - StateReason: '' - RootDeviceType: ebs - RootDeviceName: "/dev/sda1" - IsSourceDestChecked: true - KeypairName: keypair-example - ImageId: ami-12345678 - DeletionProtection: true + ActionsOnNextBoot: + SecureBoot: none Architecture: x86_64 - NestedVirtualization: false BlockDeviceMappings: - - DeviceName: "/dev/sda1" - Bsu: - VolumeId: vol-12345678 - State: attached - LinkDate: '2010-10-01T12:34:56.789Z' + - Bsu: 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 + LinkDate: '2010-10-01T12:34:56.789Z' + State: attached + VolumeId: vol-12345678 + DeviceName: "/dev/sda1" BsuOptimized: false + CreationDate: '2010-10-01T12:34:56.789Z' + DeletionProtection: true + Hypervisor: xen + ImageId: ami-12345678 + IsSourceDestChecked: true + KeypairName: keypair-example LaunchNumber: 0 + NestedVirtualization: false NetId: vpc-12345678 Nics: - - SubnetId: subnet-12345678 - State: in-use + - AccountId: '123456789012' + Description: Primary network interface + IsSourceDestChecked: true LinkNic: - State: attached + DeleteOnVmDeletion: true 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 + State: attached MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - IsPrimary: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - IsPrimary: true + SecurityGroups: + - SecurityGroupId: sg-12345678 + SecurityGroupName: security-group-example + State: in-use + SubnetId: subnet-12345678 Performance: high - Tags: - - Value: prod - Key: env + Placement: + SubregionName: eu-west-2a + Tenancy: default PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + PrivateIp: 10.0.0.4 + ProductCodes: + - '0001' + ReservationId: r-12345678 + RootDeviceName: "/dev/sda1" + RootDeviceType: ebs + SecurityGroups: + - SecurityGroupId: sg-12345678 + SecurityGroupName: security-group-example + State: stopped + StateReason: '' + SubnetId: subnet-12345678 + Tags: + - Key: env + Value: prod + UserData: "..." + VmId: i-12345678 + VmInitiatedShutdownBehavior: stop + VmType: tinav5.c1r1p2 + schema: + "$ref": "#/components/schemas/UpdateVmResponse" description: The HTTP 200 response (OK). '400': content: @@ -24659,45 +24796,45 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateVmGroupRequest" examples: ex1: summary: Updating the name and description of a VM group value: + Description: New description of the VM group VmGroupId: vmgroup-12345678901234567890123456789012 VmGroupName: new-name - Description: New description of the VM group ex2: summary: Updating the VM template of a VM group value: VmGroupId: vmgroup-12345678901234567890123456789012 VmTemplateId: vmtemplate-98765432109876543210987654321012 + schema: + "$ref": "#/components/schemas/UpdateVmGroupRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateVmGroupResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VmGroup: - 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 + Description: New description of the VM group PositioningStrategy: attract + SecurityGroupIds: + - sg-12345678 State: available - VmGroupId: vmgroup-12345678901234567890123456789012 - Description: New description of the VM group + SubnetId: subnet-12345678 Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + VmCount: 2 + VmGroupId: vmgroup-12345678901234567890123456789012 + VmGroupName: new-name + VmIds: [] + VmTemplateId: vmtemplate-98765432109876543210987654321012 + schema: + "$ref": "#/components/schemas/UpdateVmGroupResponse" description: The HTTP 200 response (OK). '400': content: @@ -24730,36 +24867,36 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateVmTemplateRequest" examples: ex1: value: Description: The new description of the VM template VmTemplateId: vmtemplate-98765432109876543210987654321012 VmTemplateName: second-name + schema: + "$ref": "#/components/schemas/UpdateVmTemplateRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateVmTemplateResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VmTemplate: - VmTemplateName: second-name + CpuCores: 2 + CpuGeneration: v4 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 + Tags: [] + VmTemplateId: vmtemplate-98765432109876543210987654321012 + VmTemplateName: second-name + schema: + "$ref": "#/components/schemas/UpdateVmTemplateResponse" description: The HTTP 200 response (OK). tags: - VmTemplate @@ -24775,57 +24912,57 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateVolumeRequest" examples: ex1: summary: Updating the size of a volume value: - VolumeId: vol-12345678 Size: 50 + VolumeId: vol-12345678 ex2: summary: Updating the type of a volume to io1 value: + Iops: 200 VolumeId: vol-12345678 VolumeType: io1 - Iops: 200 + schema: + "$ref": "#/components/schemas/UpdateVolumeRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateVolumeResponse" examples: ex1: summary: Updating the size of a volume value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Volume: - VolumeId: vol-12345678 - Tags: [] - VolumeType: gp2 - SubregionName: eu-west-2a - State: available CreationDate: '2010-10-01T12:34:56.789Z' Iops: 100 LinkedVolumes: [] Size: 10 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + State: available + SubregionName: eu-west-2a + Tags: [] + VolumeId: vol-12345678 + VolumeType: gp2 ex2: summary: Updating the type of a volume to io1 value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Volume: - VolumeId: vol-12345678 - Tags: [] - VolumeType: io1 - SubregionName: eu-west-2a - State: available CreationDate: '2010-10-01T12:34:56.789Z' Iops: 200 LinkedVolumes: [] Size: 10 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + State: available + SubregionName: eu-west-2a + Tags: [] + VolumeId: vol-12345678 + VolumeType: io1 + schema: + "$ref": "#/components/schemas/UpdateVolumeResponse" description: The HTTP 200 response (OK). '400': content: @@ -24854,42 +24991,42 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateVpnConnectionRequest" examples: ex1: value: VpnConnectionId: vpn-12345678 VpnOptions: TunnelInsideIpRange: 169.254.254.22/30 + schema: + "$ref": "#/components/schemas/UpdateVpnConnectionRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateVpnConnectionResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VpnConnection: - VpnOptions: - TunnelInsideIpRange: 169.254.254.22/30 - Routes: [] - Tags: [] ClientGatewayConfiguration: "..." - StaticRoutesOnly: true - VirtualGatewayId: vgw-12345678 - ConnectionType: ipsec.1 ClientGatewayId: cgw-12345678 + ConnectionType: ipsec.1 + Routes: [] State: pending + StaticRoutesOnly: true + Tags: [] VgwTelemetries: - - StateDescription: IPSEC IS DOWN - AcceptedRouteCount: 0 + - AcceptedRouteCount: 0 LastStateChangeDate: '2017-05-10T12:34:56.789Z' OutsideIpAddress: 192.0.2.0 + StateDescription: IPSEC IS DOWN + VirtualGatewayId: vgw-12345678 VpnConnectionId: vpn-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + VpnOptions: + TunnelInsideIpRange: 169.254.254.22/30 + schema: + "$ref": "#/components/schemas/UpdateVpnConnectionResponse" description: The HTTP 200 response (OK). '400': content: diff --git a/outscale-java.yaml b/outscale-java.yaml index 702db4d..3161c1c 100644 --- a/outscale-java.yaml +++ b/outscale-java.yaml @@ -171,6 +171,12 @@ components: description: The ZIP code of the city. type: string type: object + ActionsOnNextBoot: + description: The action to perform on the next boot of the VM. + properties: + SecureBoot: + "$ref": "#/components/schemas/SecureBootAction" + type: object AddUserToUserGroupRequest: additionalProperties: false properties: @@ -344,6 +350,12 @@ components: description: The name of the virtual device (`ephemeralN`). type: string type: object + BootMode: + description: Information about the boot mode of the OMI (`legacy` and/or `uefi`). + enum: + - uefi + - legacy + type: string BsuCreated: additionalProperties: false description: Information about the created BSU volume. @@ -997,6 +1009,11 @@ components: items: "$ref": "#/components/schemas/BlockDeviceMappingImage" type: array + BootModes: + description: The boot modes compatible with the OMI (`legacy` and/or `uefi`). + items: + "$ref": "#/components/schemas/BootMode" + type: array Description: description: A description for the new OMI. type: string @@ -1774,6 +1791,9 @@ components: CreateSnapshotRequest: additionalProperties: false properties: + ClientToken: + description: A unique identifier which enables you to manage the idempotency. + type: string Description: description: A description for the snapshot. type: string @@ -2069,11 +2089,15 @@ components: CreateVmsRequest: additionalProperties: false properties: + ActionsOnNextBoot: + "$ref": "#/components/schemas/ActionsOnNextBoot" BlockDeviceMappings: description: One or more block device mappings. items: "$ref": "#/components/schemas/BlockDeviceMappingVmCreation" type: array + BootMode: + "$ref": "#/components/schemas/BootMode" BootOnCreation: default: true description: By default or if true, the VM is started on creation. If false, @@ -2188,6 +2212,9 @@ components: CreateVolumeRequest: additionalProperties: false properties: + ClientToken: + description: A unique identifier which enables you to manage the idempotency. + type: string DryRun: description: If true, checks whether you have the required permissions to perform the action. @@ -3913,6 +3940,11 @@ components: items: type: string type: array + BootModes: + description: The boot modes compatible with the OMIs (`legacy` and/or `uefi`). + items: + "$ref": "#/components/schemas/BootMode" + type: array Descriptions: description: The descriptions of the OMIs, provided when they were created. items: @@ -3967,6 +3999,9 @@ components: items: type: string type: array + SecureBoot: + description: Whether secure boot is activated or not. + type: boolean States: description: The states of the OMIs (`pending` \| `available` \| `failed`). items: @@ -4804,6 +4839,11 @@ components: items: type: string type: array + ClientTokens: + description: The idempotency tokens provided when creating the snapshots. + items: + type: string + type: array Descriptions: description: The descriptions of the snapshots. items: @@ -5086,6 +5126,11 @@ components: items: type: string type: array + BootModes: + description: The boot modes of the VMs (`legacy` \| `uefi`). + items: + "$ref": "#/components/schemas/BootMode" + type: array ClientTokens: description: The idempotency tokens provided when launching the VMs. items: @@ -5613,6 +5658,11 @@ components: additionalProperties: false description: One or more filters. properties: + ClientTokens: + description: The idempotency tokens provided when creating the volumes. + items: + type: string + type: array CreationDates: description: The dates and times at which the volumes were created, in ISO 8601 date-time format (for example, `2020-06-30T00:00:00.000Z`). @@ -5826,6 +5876,7 @@ components: type: integer Path: description: If you use the HTTP or HTTPS protocols, the request URL path. + Always starts with a slash (`/`). type: string Port: description: The port number (between `1` and `65535`, both included). @@ -5868,6 +5919,11 @@ components: items: "$ref": "#/components/schemas/BlockDeviceMappingImage" type: array + BootModes: + description: The boot modes compatible with the OMI (`legacy` and/or `uefi`). + items: + "$ref": "#/components/schemas/BootMode" + type: array CreationDate: description: The date and time (UTC) at which the OMI was created. format: date-time @@ -5900,6 +5956,9 @@ components: RootDeviceType: description: The type of root device used by the OMI (always `bsu`). type: string + SecureBoot: + description: Whether secure boot is activated or not. + type: boolean State: description: The state of the OMI (`pending` \| `available` \| `failed`). type: string @@ -8689,10 +8748,24 @@ components: type: boolean Filters: "$ref": "#/components/schemas/FiltersNic" + 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 ReadNicsResponse: 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 Nics: description: Information about one or more NICs. items: @@ -9966,7 +10039,7 @@ components: description: Information about the tag. properties: Key: - description: The key of the tag, with a minimum of 1 character. + description: The key of the tag, between 1 and 128 characters. type: string required: - Key @@ -10134,6 +10207,15 @@ components: ResponseContext: "$ref": "#/components/schemas/ResponseContext" type: object + SecureBootAction: + description: One action to perform on the next boot of the VM (`enable` | `disable` + | `setup-mode` |`none`). + enum: + - enable + - disable + - setup-mode + - none + type: string SecurityGroup: additionalProperties: false description: Information about the security group. @@ -10307,6 +10389,9 @@ components: AccountId: description: The account ID of the owner of the snapshot. type: string + ClientToken: + description: The idempotency token provided when creating the snapshot. + type: string CreationDate: description: The date and time (UTC) at which the snapshot was created. format: date-time @@ -11104,6 +11189,13 @@ components: type: string PermissionsToLaunch: "$ref": "#/components/schemas/PermissionsOnResourceCreation" + ProductCodes: + description: The product codes associated with the OMI. Any previously set + value is deleted. Make sure to specify all product codes you want to associate + with the OMI. + items: + type: string + type: array required: - ImageId type: object @@ -11581,6 +11673,8 @@ components: UpdateVmRequest: additionalProperties: false properties: + ActionsOnNextBoot: + "$ref": "#/components/schemas/ActionsOnNextBoot" BlockDeviceMappings: description: One or more block device mappings of the VM. items: @@ -11852,6 +11946,8 @@ components: additionalProperties: false description: Information about the VM. properties: + ActionsOnNextBoot: + "$ref": "#/components/schemas/ActionsOnNextBoot" Architecture: description: The architecture of the VM (`i386` \| `x86_64`). type: string @@ -11860,6 +11956,8 @@ components: items: "$ref": "#/components/schemas/BlockDeviceMappingCreated" type: array + BootMode: + "$ref": "#/components/schemas/BootMode" BsuOptimized: description: This parameter is not available. It is present in our API for the sake of historical compatibility with AWS. @@ -12169,6 +12267,9 @@ components: additionalProperties: false description: Information about the volume. properties: + ClientToken: + description: The idempotency token provided when creating the volume. + type: string CreationDate: description: The date and time (UTC) at which the volume was created. format: date-time @@ -12427,10 +12528,10 @@ info: url: https://opensource.org/licenses/BSD-3-Clause termsOfService: https://en.outscale.com/terms-of-service/ title: 3DS OUTSCALE API - version: 1.34.3 - x-osc-api-osc-billing: 1.34.0 - x-osc-api-osc-cloud-vision: 1.34.0 - x-osc-api-osc-core-iaas: 1.34.4 + version: 1.35.3 + x-osc-api-osc-billing: 1.35.0 + x-osc-api-osc-cloud-vision: 1.35.0 + x-osc-api-osc-core-iaas: 1.35.3 x-osc-api-type: external openapi: 3.0.0 paths: @@ -12446,38 +12547,38 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/AcceptNetPeeringRequest" examples: ex1: value: NetPeeringId: pcx-12345678 + schema: + "$ref": "#/components/schemas/AcceptNetPeeringRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/AcceptNetPeeringResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 NetPeering: - Tags: [] - State: - Name: active - Message: Active AccepterNet: - NetId: vpc-12345678 - IpRange: 172.16.0.0/16 AccountId: '123456789012' + IpRange: 172.16.0.0/16 + NetId: vpc-12345678 ExpirationDate: '2063-04-05T00:00:00.000Z' + NetPeeringId: pcx-12345678 SourceNet: - NetId: vpc-12345678 - IpRange: 10.0.0.0/16 AccountId: '123456789012' - NetPeeringId: pcx-12345678 + IpRange: 10.0.0.0/16 + NetId: vpc-12345678 + State: + Message: Active + Name: active + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/AcceptNetPeeringResponse" description: The HTTP 200 response (OK). '400': content: @@ -12512,8 +12613,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/AddUserToUserGroupRequest" examples: ex1: value: @@ -12521,17 +12620,19 @@ paths: UserGroupPath: "/example/" UserName: example-user UserPath: "/example/" + schema: + "$ref": "#/components/schemas/AddUserToUserGroupRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/AddUserToUserGroupResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/AddUserToUserGroupResponse" description: The HTTP 200 response (OK). tags: - UserGroup @@ -12542,24 +12643,24 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CheckAuthenticationRequest" examples: ex1: value: Login: example@example.com Password: "$OSC_PASSWORD" + schema: + "$ref": "#/components/schemas/CheckAuthenticationRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CheckAuthenticationResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CheckAuthenticationResponse" description: The HTTP 200 response (OK). tags: - Account @@ -12572,33 +12673,33 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateAccessKeyRequest" examples: ex1: value: ExpirationDate: '2063-04-05' Tag: Group1 UserName: example-user + schema: + "$ref": "#/components/schemas/CreateAccessKeyRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateAccessKeyResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 AccessKey: - State: ACTIVE AccessKeyId: ABCDEFGHIJ0123456789 CreationDate: 2010-10-01 12:34:56.789000000 +00:00 ExpirationDate: 2063-04-05 00:00:00.000000000 +00:00 - SecretKey: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX LastModificationDate: 2010-10-01 12:34:56.789000000 +00:00 + SecretKey: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + State: ACTIVE Tag: Group1 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateAccessKeyResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -12619,8 +12720,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateAccountRequest" examples: ex1: value: @@ -12632,26 +12731,28 @@ paths: FirstName: JEAN LastName: DUPONT ZipCode: '92210' + schema: + "$ref": "#/components/schemas/CreateAccountRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateAccountResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Account: - ZipCode: '92210' - CompanyName: EXAMPLE SAS - FirstName: JEAN + AccountId: '123456789012' City: SAINT-CLOUD + CompanyName: EXAMPLE SAS Country: FRANCE - LastName: DUPONT - AccountId: '123456789012' Email: example@example.com + FirstName: JEAN + LastName: DUPONT + ZipCode: '92210' + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateAccountResponse" description: The HTTP 200 response (OK). tags: - Account @@ -12668,61 +12769,61 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateApiAccessRuleRequest" examples: ex1: summary: Creating an API access rule based on IPs value: + Description: Basic API Access Rule with IPs IpRanges: - 192.0.2.0 - 198.51.100.0/24 - Description: Basic API Access Rule with IPs ex2: summary: Creating an API access rule based on IPs and Certificate Authority (CA) value: - IpRanges: - - 192.0.2.0 - - 198.51.100.0/24 CaIds: - ca-fedcba0987654321fedcba0987654321 Description: API Access Rule with IPs and CA + IpRanges: + - 192.0.2.0 + - 198.51.100.0/24 + schema: + "$ref": "#/components/schemas/CreateApiAccessRuleRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateApiAccessRuleResponse" examples: ex1: summary: Creating an API access rule based on IPs value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ApiAccessRule: - IpRanges: - - 192.0.2.0 - - 198.51.100.0/24 ApiAccessRuleId: aar-fedcba0987654321fedcba0987654321 CaIds: [] Cns: [] Description: Basic API Access Rule with IPs + IpRanges: + - 192.0.2.0 + - 198.51.100.0/24 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Creating an API access rule based on IPs and Certificate Authority (CA) value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ApiAccessRule: - IpRanges: - - 192.0.2.0 - - 198.51.100.0/24 ApiAccessRuleId: aar-fedcba0987654321fedcba0987654321 CaIds: - ca-fedcba0987654321fedcba0987654321 Cns: [] Description: API Access Rule with IPs and CA + IpRanges: + - 192.0.2.0 + - 198.51.100.0/24 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateApiAccessRuleResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -12738,28 +12839,28 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateCaRequest" examples: ex1: value: CaPem: XXXX Description: CA example + schema: + "$ref": "#/components/schemas/CreateCaRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateCaResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Ca: - Description: CA example - CaId: ca-fedcba0987654321fedcba0987654321 CaFingerprint: 1234567890abcdef1234567890abcdef12345678 + CaId: ca-fedcba0987654321fedcba0987654321 + Description: CA example + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateCaResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -12777,32 +12878,32 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateClientGatewayRequest" examples: ex1: value: + BgpAsn: 65000 ConnectionType: ipsec.1 PublicIp: 192.0.2.0 - BgpAsn: 65000 + schema: + "$ref": "#/components/schemas/CreateClientGatewayRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateClientGatewayResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ClientGateway: - State: available BgpAsn: 65000 - Tags: [] ClientGatewayId: cgw-12345678 ConnectionType: ipsec.1 PublicIp: 192.0.2.0 + State: available + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateClientGatewayResponse" description: The HTTP 200 response (OK). tags: - ClientGateway @@ -12818,33 +12919,33 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateDedicatedGroupRequest" examples: ex1: value: CpuGeneration: 4 Name: dedicated-group-example SubregionName: eu-west-2a + schema: + "$ref": "#/components/schemas/CreateDedicatedGroupRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateDedicatedGroupResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 DedicatedGroup: - VmIds: [] - NetIds: [] AccountId: '123456789012' CpuGeneration: 4 + DedicatedGroupId: ded-12345678 Name: dedicated-group-example + NetIds: [] SubregionName: eu-west-2a - DedicatedGroupId: ded-12345678 + VmIds: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateDedicatedGroupResponse" description: The HTTP 200 response (OK). '400': content: @@ -12875,8 +12976,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateDhcpOptionsRequest" examples: ex1: value: @@ -12887,28 +12986,30 @@ paths: NtpServers: - 203.0.113.0 - 203.0.113.1 + schema: + "$ref": "#/components/schemas/CreateDhcpOptionsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateDhcpOptionsResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 DhcpOptionsSet: - Tags: [] - NtpServers: - - 203.0.113.0 - - 203.0.113.1 Default: false DhcpOptionsSetId: dopt-12345678 DomainName: example.com DomainNameServers: - 192.0.2.0 - 198.51.100.0 + NtpServers: + - 203.0.113.0 + - 203.0.113.1 + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateDhcpOptionsResponse" description: The HTTP 200 response (OK). tags: - DhcpOption @@ -12921,25 +13022,21 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateDirectLinkRequest" examples: ex1: value: - Location: PAR1 Bandwidth: 1Gbps DirectLinkName: Connection to Outscale + Location: PAR1 + schema: + "$ref": "#/components/schemas/CreateDirectLinkRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateDirectLinkResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 DirectLink: AccountId: '123456789012' Bandwidth: 1Gbps @@ -12948,9 +13045,13 @@ paths: Location: PAR1 RegionName: eu-west-2 State: requested - description: The HTTP 200 response (OK). - tags: - - DirectLink + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateDirectLinkResponse" + description: The HTTP 200 response (OK). + tags: + - DirectLink "/CreateDirectLinkInterface": description: |- Creates a DirectLink interface.
@@ -12961,45 +13062,45 @@ paths: requestBody: content: 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 + DirectLinkInterfaceName: MyDirectLinkInterface + OutscalePrivateIp: 172.16.0.4/30 VirtualGatewayId: vgw-12345678 + Vlan: 101 + schema: + "$ref": "#/components/schemas/CreateDirectLinkInterfaceRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateDirectLinkInterfaceResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 DirectLinkInterface: - Vlan: 101 - OutscalePrivateIp: 172.16.0.4/30 - DirectLinkInterfaceId: dxvif-12345678 - BgpAsn: 65000 AccountId: '123456789012' + BgpAsn: 65000 ClientPrivateIp: 172.16.0.5/30 - VirtualGatewayId: vgw-12345678 - DirectLinkInterfaceName: MyDirectLinkInterface DirectLinkId: dxcon-12345678 - Mtu: 1500 - State: pending + DirectLinkInterfaceId: dxvif-12345678 + DirectLinkInterfaceName: MyDirectLinkInterface InterfaceType: private Location: PAR1 + Mtu: 1500 + OutscalePrivateIp: 172.16.0.4/30 + State: pending + VirtualGatewayId: vgw-12345678 + Vlan: 101 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateDirectLinkInterfaceResponse" description: The HTTP 200 response (OK). tags: - DirectLinkInterface @@ -13013,33 +13114,33 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateFlexibleGpuRequest" examples: ex1: value: - ModelName: nvidia-p100 + DeleteOnVmDeletion: true Generation: v5 + ModelName: nvidia-p100 SubregionName: eu-west-2a - DeleteOnVmDeletion: true + schema: + "$ref": "#/components/schemas/CreateFlexibleGpuRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateFlexibleGpuResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 FlexibleGpu: - SubregionName: eu-west-2a DeleteOnVmDeletion: true + FlexibleGpuId: fgpu-12345678 Generation: v5 ModelName: nvidia-p100 State: allocated - FlexibleGpuId: fgpu-12345678 + SubregionName: eu-west-2a + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateFlexibleGpuResponse" description: The HTTP 200 response (OK). tags: - FlexibleGpu @@ -13061,15 +13162,13 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateImageRequest" examples: ex1: summary: Creating from a VM value: ImageName: create-image-example - VmId: i-12345678 NoReboot: true + VmId: i-12345678 ex2: summary: Copying an OMI value: @@ -13079,153 +13178,163 @@ paths: ex3: summary: Registering from a snapshot value: - ImageName: register-image-from-snapshot-example BlockDeviceMappings: - - DeviceName: "/dev/sda1" - Bsu: + - Bsu: + DeleteOnVmDeletion: true + Iops: 150 SnapshotId: snap-12345678 VolumeSize: 120 VolumeType: io1 - Iops: 150 - DeleteOnVmDeletion: true + DeviceName: "/dev/sda1" + ImageName: register-image-from-snapshot-example 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 + ImageName: register-image-from-bucket-example + schema: + "$ref": "#/components/schemas/CreateImageRequest" 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 + Architecture: x86_64 BlockDeviceMappings: - - DeviceName: "/dev/sda1" - Bsu: - VolumeType: standard + - Bsu: DeleteOnVmDeletion: true - VolumeSize: 50 SnapshotId: snap-12345678 - ImageType: machine + VolumeSize: 50 + VolumeType: standard + DeviceName: "/dev/sda1" + BootModes: + - legacy CreationDate: '2010-10-01T12:34:56.789Z' + Description: '' FileLocation: 123456789012/create-image-example - Architecture: x86_64 + ImageId: ami-12345678 ImageName: create-image-example + ImageType: machine + PermissionsToLaunch: + AccountIds: [] + GlobalPermission: false + ProductCodes: + - '0001' + RootDeviceName: "/dev/sda1" + RootDeviceType: bsu + State: pending + StateComment: {} + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Copying an OMI value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Image: - StateComment: {} - State: available - RootDeviceType: bsu - RootDeviceName: "/dev/sda1" - ProductCodes: - - '0001' - PermissionsToLaunch: - GlobalPermission: false - AccountIds: [] AccountId: '123456789012' - Tags: [] - Description: '' - ImageId: ami-12345678 + Architecture: x86_64 BlockDeviceMappings: - - DeviceName: "/dev/sda1" - Bsu: - VolumeType: standard + - Bsu: DeleteOnVmDeletion: true - VolumeSize: 50 SnapshotId: snap-12345678 - ImageType: machine + VolumeSize: 50 + VolumeType: standard + DeviceName: "/dev/sda1" + BootModes: + - legacy CreationDate: '2010-10-01T12:34:56.789Z' + Description: '' FileLocation: 123456789012/copy-image-example - Architecture: x86_64 + ImageId: ami-12345678 ImageName: copy-image-example + ImageType: machine + PermissionsToLaunch: + AccountIds: [] + GlobalPermission: false + ProductCodes: + - '0001' + RootDeviceName: "/dev/sda1" + RootDeviceType: bsu + State: available + StateComment: {} + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex3: summary: Registering from a snapshot value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Image: - StateComment: {} - State: available - RootDeviceType: bsu - RootDeviceName: "/dev/sda1" - ProductCodes: - - '0001' - PermissionsToLaunch: - GlobalPermission: false - AccountIds: [] AccountId: '123456789012' - Tags: [] - Description: '' - ImageId: ami-12345678 + Architecture: x86_64 BlockDeviceMappings: - - DeviceName: "/dev/sda1" - Bsu: - VolumeType: io1 + - Bsu: DeleteOnVmDeletion: true - VolumeSize: 120 Iops: 150 SnapshotId: snap-12345678 - ImageType: machine + VolumeSize: 120 + VolumeType: io1 + DeviceName: "/dev/sda1" + BootModes: + - legacy CreationDate: '2010-10-01T12:34:56.789Z' + Description: '' FileLocation: 123456789012/register-image-from-snapshot-example - Architecture: x86_64 + ImageId: ami-12345678 ImageName: register-image-from-snapshot-example + ImageType: machine + PermissionsToLaunch: + AccountIds: [] + GlobalPermission: false + ProductCodes: + - '0001' + RootDeviceName: "/dev/sda1" + RootDeviceType: bsu + State: available + StateComment: {} + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex4: summary: Registering from a bucket by using a manifest file value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Image: - StateComment: {} - State: pending - RootDeviceType: bsu - RootDeviceName: "/dev/sda1" - ProductCodes: - - '0001' - PermissionsToLaunch: - GlobalPermission: false - AccountIds: [] AccountId: '123456789012' - Tags: [] - Description: '' - ImageId: ami-12345678 + Architecture: x86_64 BlockDeviceMappings: - - DeviceName: "/dev/sda1" - Bsu: - VolumeType: standard + - Bsu: DeleteOnVmDeletion: true - VolumeSize: 50 SnapshotId: snap-12345678 - ImageType: machine + VolumeSize: 50 + VolumeType: standard + DeviceName: "/dev/sda1" + BootModes: + - legacy CreationDate: '2010-10-01T12:34:56.789Z' + Description: '' FileLocation: https://oos.eu-west-2.outscale.com/BUCKET/KEY?AWSAccessKeyId=ABCDEFGHIJ0123456789&Expires=1493372309&Signature=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - Architecture: x86_64 + ImageId: ami-12345678 ImageName: register-image-from-bucket-example + ImageType: machine + PermissionsToLaunch: + AccountIds: [] + GlobalPermission: false + ProductCodes: + - '0001' + RootDeviceName: "/dev/sda1" + RootDeviceType: bsu + State: pending + StateComment: {} + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateImageResponse" description: The HTTP 200 response (OK). '400': content: @@ -13262,8 +13371,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateImageExportTaskRequest" examples: ex1: value: @@ -13272,28 +13379,30 @@ paths: DiskImageFormat: qcow2 OsuBucket: BUCKET OsuPrefix: PREFIX + schema: + "$ref": "#/components/schemas/CreateImageExportTaskRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateImageExportTaskResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ImageExportTask: - Tags: [] - ImageId: ami-12345678 - TaskId: image-export-12345678 Comment: Export of image ami-12345678 + ImageId: ami-12345678 OsuExport: - OsuPrefix: PREFIX/ami-12345678/ - OsuBucket: BUCKET DiskImageFormat: qcow2 - State: pending/queued + OsuBucket: BUCKET + OsuPrefix: PREFIX/ami-12345678/ Progress: 0 + State: pending/queued + Tags: [] + TaskId: image-export-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateImageExportTaskResponse" description: The HTTP 200 response (OK). tags: - Image @@ -13307,25 +13416,25 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateInternetServiceRequest" examples: ex1: value: {} + schema: + "$ref": "#/components/schemas/CreateInternetServiceRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateInternetServiceResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 InternetService: - Tags: [] InternetServiceId: igw-12345678 + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateInternetServiceResponse" description: The HTTP 200 response (OK). '400': content: @@ -13361,8 +13470,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateKeypairRequest" examples: ex1: summary: Creating a keypair @@ -13373,37 +13480,39 @@ paths: value: KeypairName: import-keypair-example PublicKey: "..." + schema: + "$ref": "#/components/schemas/CreateKeypairRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateKeypairResponse" examples: ex1: summary: Creating a keypair value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Keypair: + KeypairFingerprint: 11:22:33:44:55:66:77:88:99:00:aa:bb:cc:dd:ee:ff + KeypairId: key-abcdef1234567890abcdef1234567890 + KeypairName: create-keypair-example + KeypairType: ssh-rsa PrivateKey: |- -----BEGIN RSA PRIVATE KEY----- ... -----END RSA PRIVATE KEY----- - KeypairType: ssh-rsa - KeypairName: create-keypair-example - KeypairId: key-abcdef1234567890abcdef1234567890 - KeypairFingerprint: 11:22:33:44:55:66:77:88:99:00:aa:bb:cc:dd:ee:ff + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Importing a keypair created locally value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Keypair: - KeypairType: ssh-rsa - KeypairName: create-keypair-example - KeypairId: key-abcdef1234567890abcdef1234567890 KeypairFingerprint: 11:22:33:44:55:66:77:88:99:00:aa:bb:cc:dd:ee:ff + KeypairId: key-abcdef1234567890abcdef1234567890 + KeypairName: create-keypair-example + KeypairType: ssh-rsa + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateKeypairResponse" description: The HTTP 200 response (OK). '400': content: @@ -13441,8 +13550,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateListenerRuleRequest" examples: ex1: summary: Creating a listener rule based on a host pattern @@ -13465,46 +13572,48 @@ paths: LoadBalancerPort: 80 ListenerRule: Action: forward - PathPattern: "/docs/*" ListenerRuleName: example-listener-rule + PathPattern: "/docs/*" Priority: 100 VmIds: - i-12345678 + schema: + "$ref": "#/components/schemas/CreateListenerRuleRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateListenerRuleResponse" examples: ex1: summary: Creating a listener rule based on a host pattern value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ListenerRule: - Priority: 10 - VmIds: - - i-12345678 - ListenerRuleName: example-listener-rule Action: forward - ListenerId: 123456 HostNamePattern: "*.example.com" + ListenerId: 123456 ListenerRuleId: 1234 + ListenerRuleName: example-listener-rule + Priority: 10 + VmIds: + - i-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 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 + ListenerRuleName: example-listener-rule + PathPattern: "/docs/*" + Priority: 100 + VmIds: + - i-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateListenerRuleResponse" description: The HTTP 200 response (OK). tags: - Listener @@ -13520,173 +13629,173 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateLoadBalancerRequest" examples: ex1: summary: Creating an internal load balancer in a Net value: - LoadBalancerName: private-lb-example Listeners: - BackendPort: 80 BackendProtocol: TCP LoadBalancerPort: 80 LoadBalancerProtocol: TCP - Subnets: - - subnet-12345678 + LoadBalancerName: private-lb-example + LoadBalancerType: internal SecurityGroups: - sg-12345678 - LoadBalancerType: internal + Subnets: + - subnet-12345678 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 + LoadBalancerName: private-lb-example LoadBalancerType: internet-facing PublicIp: 192.0.2.0 + SecurityGroups: + - sg-12345678 + Subnets: + - subnet-12345678 ex3: summary: Creating an internet-facing load balancer in the public Cloud value: - LoadBalancerName: public-lb-example - SubregionNames: - - eu-west-2a Listeners: - BackendPort: 8080 BackendProtocol: HTTP LoadBalancerPort: 8080 LoadBalancerProtocol: HTTP + LoadBalancerName: public-lb-example + SubregionNames: + - eu-west-2a + schema: + "$ref": "#/components/schemas/CreateLoadBalancerRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateLoadBalancerResponse" examples: ex1: summary: Creating an internal load balancer in a Net value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 LoadBalancer: - Tags: [] - SourceSecurityGroup: - SecurityGroupName: security-group-example - SecurityGroupAccountId: '123456789012' - SecuredCookies: false - Subnets: - - subnet-12345678 - NetId: vpc-12345678 - BackendVmIds: [] - ApplicationStickyCookiePolicies: [] - SecurityGroups: - - sg-12345678 - LoadBalancerType: internal AccessLog: - PublicationInterval: 60 IsEnabled: false + PublicationInterval: 60 + ApplicationStickyCookiePolicies: [] + BackendVmIds: [] 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 + Protocol: TCP + Timeout: 5 + UnhealthyThreshold: 2 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: [] + LoadBalancerStickyCookiePolicies: [] + LoadBalancerType: internal + NetId: vpc-12345678 + SecuredCookies: false + SecurityGroups: + - sg-12345678 SourceSecurityGroup: - SecurityGroupName: security-group-example SecurityGroupAccountId: '123456789012' - SecuredCookies: false - PublicIp: 192.0.2.0 + SecurityGroupName: security-group-example Subnets: - subnet-12345678 - NetId: vpc-12345678 - BackendVmIds: [] - ApplicationStickyCookiePolicies: [] - SecurityGroups: - - sg-12345678 - LoadBalancerType: internet-facing + SubregionNames: + - eu-west-2a + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + summary: Creating an internet-facing load balancer in a Net + value: + LoadBalancer: AccessLog: - PublicationInterval: 60 IsEnabled: false + PublicationInterval: 60 + ApplicationStickyCookiePolicies: [] + BackendVmIds: [] 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 + Protocol: TCP + Timeout: 5 + UnhealthyThreshold: 2 Listeners: - - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate - BackendPort: 80 + - BackendPort: 80 BackendProtocol: HTTP LoadBalancerPort: 443 LoadBalancerProtocol: HTTPS + ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate LoadBalancerName: private-lb-example + LoadBalancerStickyCookiePolicies: [] + LoadBalancerType: internet-facing + NetId: vpc-12345678 + PublicIp: 192.0.2.0 + SecuredCookies: false + SecurityGroups: + - sg-12345678 + SourceSecurityGroup: + SecurityGroupAccountId: '123456789012' + SecurityGroupName: security-group-example + Subnets: + - subnet-12345678 + SubregionNames: + - eu-west-2a + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex3: summary: 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 + PublicationInterval: 60 + ApplicationStickyCookiePolicies: [] + BackendVmIds: [] 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 + Protocol: TCP + Timeout: 5 + UnhealthyThreshold: 2 Listeners: - BackendPort: 8080 BackendProtocol: HTTP LoadBalancerPort: 8080 LoadBalancerProtocol: HTTP LoadBalancerName: public-lb-example + LoadBalancerStickyCookiePolicies: [] + LoadBalancerType: internet-facing + SecuredCookies: false + SourceSecurityGroup: + SecurityGroupAccountId: outscale-elb + SecurityGroupName: outscale-elb-sg + Subnets: [] + SubregionNames: + - eu-west-2a + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateLoadBalancerResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer @@ -13699,56 +13808,38 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateLoadBalancerListenersRequest" examples: ex1: value: - LoadBalancerName: example-lbu Listeners: - BackendPort: 58 BackendProtocol: TCP LoadBalancerPort: 62 LoadBalancerProtocol: TCP + LoadBalancerName: example-lbu + schema: + "$ref": "#/components/schemas/CreateLoadBalancerListenersRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateLoadBalancerListenersResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 LoadBalancer: - Tags: [] - SourceSecurityGroup: - SecurityGroupName: security-group-example - SecurityGroupAccountId: '123456789012' - SecuredCookies: false - Subnets: - - subnet-12345678 - NetId: vpc-12345678 - BackendVmIds: [] - ApplicationStickyCookiePolicies: [] - SecurityGroups: - - sg-12345678 - LoadBalancerType: internal AccessLog: - PublicationInterval: 60 IsEnabled: false + PublicationInterval: 60 + ApplicationStickyCookiePolicies: [] + BackendVmIds: [] 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 + Protocol: TCP + Timeout: 5 + UnhealthyThreshold: 2 Listeners: - BackendPort: 58 BackendProtocol: TCP @@ -13759,6 +13850,24 @@ paths: LoadBalancerPort: 80 LoadBalancerProtocol: TCP LoadBalancerName: example-lbu + LoadBalancerStickyCookiePolicies: [] + LoadBalancerType: internal + NetId: vpc-12345678 + SecuredCookies: false + SecurityGroups: + - sg-12345678 + SourceSecurityGroup: + SecurityGroupAccountId: '123456789012' + SecurityGroupName: security-group-example + Subnets: + - subnet-12345678 + SubregionNames: + - eu-west-2a + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateLoadBalancerListenersResponse" description: The HTTP 200 response (OK). tags: - Listener @@ -13777,8 +13886,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateLoadBalancerPolicyRequest" examples: ex1: summary: Creating a load balancer policy based on browser @@ -13789,97 +13896,99 @@ paths: ex2: summary: Creating a load balancer policy based on application cookie value: + CookieName: example-cookie LoadBalancerName: example-lbu PolicyName: example-app-policy PolicyType: app - CookieName: example-cookie + schema: + "$ref": "#/components/schemas/CreateLoadBalancerPolicyRequest" 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 + PublicationInterval: 60 + ApplicationStickyCookiePolicies: [] + BackendVmIds: [] 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 + Protocol: TCP + Timeout: 5 + UnhealthyThreshold: 2 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: [] + LoadBalancerStickyCookiePolicies: + - CookieExpirationPeriod: 1 + PolicyName: example-browser-policy + LoadBalancerType: internet-facing + NetId: vpc-12345678 + SecurityGroups: + - sg-12345678 SourceSecurityGroup: - SecurityGroupName: default SecurityGroupAccountId: '123456789012' + SecurityGroupName: default Subnets: - subnet-12345678 - NetId: vpc-12345678 - BackendVmIds: [] - ApplicationStickyCookiePolicies: - - PolicyName: example-app-policy - CookieName: example-cookie - SecurityGroups: - - sg-12345678 - LoadBalancerType: internet-facing + SubregionNames: + - eu-west-2a + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + summary: Creating a load balancer policy based on application cookie + value: + LoadBalancer: AccessLog: - PublicationInterval: 60 IsEnabled: false + PublicationInterval: 60 + ApplicationStickyCookiePolicies: + - CookieName: example-cookie + PolicyName: example-app-policy + BackendVmIds: [] 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 + Protocol: TCP + Timeout: 5 + UnhealthyThreshold: 2 Listeners: - BackendPort: 80 BackendProtocol: HTTP LoadBalancerPort: 80 LoadBalancerProtocol: HTTP LoadBalancerName: example-lbu + LoadBalancerStickyCookiePolicies: [] + LoadBalancerType: internet-facing + NetId: vpc-12345678 + SecurityGroups: + - sg-12345678 + SourceSecurityGroup: + SecurityGroupAccountId: '123456789012' + SecurityGroupName: default + Subnets: + - subnet-12345678 + SubregionNames: + - eu-west-2a + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateLoadBalancerPolicyResponse" description: The HTTP 200 response (OK). tags: - LoadBalancerPolicy @@ -13893,8 +14002,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateLoadBalancerTagsRequest" examples: ex1: value: @@ -13903,17 +14010,19 @@ paths: Tags: - Key: key1 Value: value1 + schema: + "$ref": "#/components/schemas/CreateLoadBalancerTagsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateLoadBalancerTagsResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateLoadBalancerTagsResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer @@ -13932,33 +14041,33 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateNatServiceRequest" examples: ex1: value: - SubnetId: subnet-12345678 PublicIpId: eipalloc-12345678 + SubnetId: subnet-12345678 + schema: + "$ref": "#/components/schemas/CreateNatServiceRequest" 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 + PublicIps: + - PublicIp: 192.0.2.0 + PublicIpId: eipalloc-12345678 State: available + SubnetId: subnet-12345678 + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateNatServiceResponse" description: The HTTP 200 response (OK). '400': content: @@ -13990,30 +14099,30 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateNetRequest" examples: ex1: value: IpRange: 10.0.0.0/16 + schema: + "$ref": "#/components/schemas/CreateNetRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateNetResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Net: - Tags: [] DhcpOptionsSetId: dopt-12345678 IpRange: 10.0.0.0/16 - Tenancy: default NetId: vpc-12345678 State: available + Tags: [] + Tenancy: default + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateNetResponse" description: The HTTP 200 response (OK). '400': content: @@ -14053,8 +14162,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateNetAccessPointRequest" examples: ex1: value: @@ -14062,25 +14169,27 @@ paths: RouteTableIds: - rtb-12345678 ServiceName: com.outscale.eu-west-2.oos + schema: + "$ref": "#/components/schemas/CreateNetAccessPointRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateNetAccessPointResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 NetAccessPoint: - Tags: [] NetAccessPointId: vpce-12345678 + NetId: vpc-12345678 RouteTableIds: - rtb-12345678 - State: pending - NetId: vpc-12345678 ServiceName: com.outscale.eu-west-2.oos + State: pending + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateNetAccessPointResponse" description: The HTTP 200 response (OK). tags: - NetAccessPoint @@ -14100,67 +14209,67 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateNetPeeringRequest" examples: ex1: summary: Creating a Net peering between two Nets belonging to you value: - SourceNetId: vpc-12345678 AccepterNetId: vpc-87654321 + SourceNetId: vpc-12345678 ex2: summary: Creating a Net peering with a Net that belongs to another account value: - SourceNetId: vpc-12345678 AccepterNetId: vpc-87654321 AccepterOwnerId: '987654321098' + SourceNetId: vpc-12345678 + schema: + "$ref": "#/components/schemas/CreateNetPeeringRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateNetPeeringResponse" examples: ex1: summary: Creating a Net peering between two Nets belonging to you value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 NetPeering: - Tags: [] - State: - Name: pending-acceptance - Message: Pending acceptance by 123456789012 AccepterNet: - NetId: vpc-12345678 - IpRange: 172.16.0.0/16 AccountId: '123456789012' + IpRange: 172.16.0.0/16 + NetId: vpc-12345678 + NetPeeringId: pcx-12345678 SourceNet: - NetId: vpc-87654321 - IpRange: 10.0.0.0/16 AccountId: '123456789012' - NetPeeringId: pcx-12345678 + IpRange: 10.0.0.0/16 + NetId: vpc-87654321 + State: + Message: Pending acceptance by 123456789012 + Name: pending-acceptance + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Creating a Net peering with a Net that belongs to another account value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 NetPeering: - Tags: [] - State: - Name: pending-acceptance - Message: Pending acceptance by 123456789012 AccepterNet: - NetId: vpc-87654321 - IpRange: 172.16.0.0/16 AccountId: '987654321098' + IpRange: 172.16.0.0/16 + NetId: vpc-87654321 + NetPeeringId: pcx-12345678 SourceNet: - NetId: vpc-12345678 - IpRange: 10.0.0.0/16 AccountId: '123456789012' - NetPeeringId: pcx-12345678 + IpRange: 10.0.0.0/16 + NetId: vpc-12345678 + State: + Message: Pending acceptance by 123456789012 + Name: pending-acceptance + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateNetPeeringResponse" description: The HTTP 200 response (OK). '400': content: @@ -14191,85 +14300,85 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateNicRequest" examples: ex1: summary: Creating a NIC value: - SubnetId: subnet-12345678 SecurityGroupIds: - sg-12345678 + SubnetId: subnet-12345678 ex2: summary: Creating a NIC with specific private IPs value: Description: Terraform nic with private IPs - SubnetId: subnet-12345678 - SecurityGroupIds: - - sg-12345678 PrivateIps: - IsPrimary: true PrivateIp: 10.0.0.4 - IsPrimary: false PrivateIp: 10.0.0.5 + SecurityGroupIds: + - sg-12345678 + SubnetId: subnet-12345678 + schema: + "$ref": "#/components/schemas/CreateNicRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateNicResponse" examples: ex1: summary: Creating a NIC value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Nic: - 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 + Description: '' + IsSourceDestChecked: true MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - IsPrimary: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - IsPrimary: true + SecurityGroups: + - SecurityGroupId: sg-12345678 + SecurityGroupName: security-group-example + State: available + SubnetId: subnet-12345678 + SubregionName: eu-west-2a + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 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 + Description: '' + IsSourceDestChecked: true MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - IsPrimary: true + 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 + - IsPrimary: false + PrivateDnsName: ip-10-0-0-5.eu-west-2.compute.internal PrivateIp: 10.0.0.5 - IsPrimary: false + SecurityGroups: + - SecurityGroupId: sg-12345678 + SecurityGroupName: security-group-example + State: available + SubnetId: subnet-12345678 + SubregionName: eu-west-2a + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateNicResponse" description: The HTTP 200 response (OK). '400': content: @@ -14300,8 +14409,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreatePolicyRequest" examples: ex1: value: @@ -14310,28 +14417,30 @@ paths: "Resource": ["*"]} ]}' Path: "/example/" PolicyName: example-user-policy + schema: + "$ref": "#/components/schemas/CreatePolicyRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreatePolicyResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Policy: - ResourcesCount: 0 - PolicyName: example-user-policy - PolicyDefaultVersionId: v1 - Path: "/example/" CreationDate: 2010-10-01 12:34:56.789000000 +00:00 Description: Example of description - PolicyId: ABCDEFGHIJKLMNOPQRSTUVWXYZ01234 - Orn: orn:ows:idauth::012345678910:policy/example/example-user-policy IsLinkable: true LastModificationDate: 2010-10-01 12:34:56.789000000 +00:00 + Orn: orn:ows:idauth::012345678910:policy/example/example-user-policy + Path: "/example/" + PolicyDefaultVersionId: v1 + PolicyId: ABCDEFGHIJKLMNOPQRSTUVWXYZ01234 + PolicyName: example-user-policy + ResourcesCount: 0 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreatePolicyResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -14344,8 +14453,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreatePolicyVersionRequest" examples: ex1: value: @@ -14353,23 +14460,25 @@ paths: "Resource": ["*"]} ]}' PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy SetAsDefault: true + schema: + "$ref": "#/components/schemas/CreatePolicyVersionRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreatePolicyVersionResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 PolicyVersion: - VersionId: v2 - DefaultVersion: true - CreationDate: 2017-05-10 12:34:56.789000000 +00:00 Body: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], "Resource": ["*"]} ]}' + CreationDate: 2017-05-10 12:34:56.789000000 +00:00 + DefaultVersion: true + VersionId: v2 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreatePolicyVersionResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -14381,28 +14490,28 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateProductTypeRequest" examples: ex1: value: - Vendor: vendor-name Description: Example of description + Vendor: vendor-name + schema: + "$ref": "#/components/schemas/CreateProductTypeRequest" 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 + ProductTypeId: pty-12345678 + Vendor: vendor-name + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateProductTypeResponse" description: The HTTP 200 response (OK). tags: - ProductType @@ -14416,26 +14525,26 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreatePublicIpRequest" examples: ex1: value: {} + schema: + "$ref": "#/components/schemas/CreatePublicIpRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreatePublicIpResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 PublicIp: - Tags: [] - PublicIpId: eipalloc-12345678 PublicIp: 192.0.2.0 + PublicIpId: eipalloc-12345678 + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreatePublicIpResponse" description: The HTTP 200 response (OK). '400': content: @@ -14476,41 +14585,41 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateRouteRequest" examples: ex1: summary: Creating a route to an Internet service value: - RouteTableId: rtb-12345678 DestinationIpRange: 0.0.0.0/0 GatewayId: igw-12345678 + RouteTableId: rtb-12345678 + schema: + "$ref": "#/components/schemas/CreateRouteRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateRouteResponse" examples: ex1: summary: Creating a route to an Internet service value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 RouteTable: + LinkRouteTables: [] + NetId: vpc-12345678 + RoutePropagatingVirtualGateways: [] + RouteTableId: rtb-12345678 Routes: - - DestinationIpRange: 10.0.0.0/16 - CreationMethod: CreateRouteTable + - CreationMethod: CreateRouteTable + DestinationIpRange: 10.0.0.0/16 State: active - - GatewayId: igw-12345678 + - CreationMethod: CreateRoute DestinationIpRange: 0.0.0.0/0 - CreationMethod: CreateRoute + GatewayId: igw-12345678 State: active - LinkRouteTables: [] - NetId: vpc-12345678 Tags: [] - RoutePropagatingVirtualGateways: [] - RouteTableId: rtb-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateRouteResponse" description: The HTTP 200 response (OK). '400': content: @@ -14542,33 +14651,33 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateRouteTableRequest" examples: ex1: value: NetId: vpc-12345678 + schema: + "$ref": "#/components/schemas/CreateRouteTableRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateRouteTableResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 RouteTable: - Routes: - - DestinationIpRange: 10.0.0.0/16 - CreationMethod: CreateRouteTable - State: active LinkRouteTables: [] NetId: vpc-12345678 - Tags: [] RoutePropagatingVirtualGateways: [] RouteTableId: rtb-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Routes: + - CreationMethod: CreateRouteTable + DestinationIpRange: 10.0.0.0/16 + State: active + Tags: [] + schema: + "$ref": "#/components/schemas/CreateRouteTableResponse" description: The HTTP 200 response (OK). '400': content: @@ -14604,39 +14713,39 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateSecurityGroupRequest" examples: ex1: value: + Description: Security group example NetId: vpc-12345678 SecurityGroupName: security-group-example - Description: Security group example + schema: + "$ref": "#/components/schemas/CreateSecurityGroupRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateSecurityGroupResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 SecurityGroup: - Tags: [] - SecurityGroupName: security-group-example + AccountId: '123456789012' + Description: Example of security group + InboundRules: [] + NetId: vpc-12345678 OutboundRules: - FromPortRange: -1 IpProtocol: "-1" - ToPortRange: -1 IpRanges: - 0.0.0.0/0 + ToPortRange: -1 SecurityGroupId: sg-12345678 - AccountId: '123456789012' - Description: Example of security group - InboundRules: [] - NetId: vpc-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + SecurityGroupName: security-group-example + Tags: [] + schema: + "$ref": "#/components/schemas/CreateSecurityGroupResponse" description: The HTTP 200 response (OK). '400': content: @@ -14681,87 +14790,87 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateSecurityGroupRuleRequest" examples: ex1: summary: Creating an inbound rule from an IP range value: Flow: Inbound - SecurityGroupId: sg-12345678 FromPortRange: 80 - ToPortRange: 80 IpProtocol: tcp IpRange: 10.0.0.0/16 + SecurityGroupId: sg-12345678 + ToPortRange: 80 ex2: summary: Creating an inbound rule from another security group value: Flow: Inbound - SecurityGroupId: sg-12345678 Rules: - FromPortRange: 22 - ToPortRange: 22 IpProtocol: tcp SecurityGroupsMembers: - AccountId: '123456789012' SecurityGroupName: another-security-group + ToPortRange: 22 + SecurityGroupId: sg-12345678 + schema: + "$ref": "#/components/schemas/CreateSecurityGroupRuleRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateSecurityGroupRuleResponse" examples: ex1: summary: Creating an inbound rule from an IP range value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 SecurityGroup: - Tags: [] - SecurityGroupName: security-group-example - OutboundRules: - - FromPortRange: -1 - IpProtocol: "-1" - ToPortRange: -1 - IpRanges: - - 0.0.0.0/0 - SecurityGroupId: sg-12345678 AccountId: '123456789012' Description: Example of security group InboundRules: - FromPortRange: 80 IpProtocol: tcp - ToPortRange: 80 IpRanges: - 10.0.0.0/16 + ToPortRange: 80 NetId: vpc-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - ex2: - summary: Creating an inbound rule from another security group - value: - SecurityGroup: - Tags: [] - SecurityGroupName: security-group-example OutboundRules: - FromPortRange: -1 IpProtocol: "-1" - ToPortRange: -1 IpRanges: - 0.0.0.0/0 + ToPortRange: -1 SecurityGroupId: sg-12345678 + SecurityGroupName: security-group-example + Tags: [] + ex2: + summary: Creating an inbound rule from another security group + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + SecurityGroup: AccountId: '123456789012' Description: Example of security group InboundRules: - FromPortRange: 22 IpProtocol: tcp - ToPortRange: 22 SecurityGroupsMembers: - - SecurityGroupName: another-security-group + - AccountId: '987654321098' SecurityGroupId: sg-87654321 - AccountId: '987654321098' + SecurityGroupName: another-security-group + ToPortRange: 22 NetId: vpc-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + OutboundRules: + - FromPortRange: -1 + IpProtocol: "-1" + IpRanges: + - 0.0.0.0/0 + ToPortRange: -1 + SecurityGroupId: sg-12345678 + SecurityGroupName: security-group-example + Tags: [] + schema: + "$ref": "#/components/schemas/CreateSecurityGroupRuleResponse" description: The HTTP 200 response (OK). '400': content: @@ -14797,32 +14906,32 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateServerCertificateRequest" examples: ex1: value: - Name: server-cert-example Body: "..." Chain: "..." - PrivateKey: "..." + Name: server-cert-example Path: "/example/" - responses: + PrivateKey: "..." + schema: + "$ref": "#/components/schemas/CreateServerCertificateRequest" + responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateServerCertificateResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ServerCertificate: - Path: "/example/" Id: ABCDEFGHIJKLMNOPQRSTUVWXYZ1234 - Orn: orn:ows:idauth::012345678910:server-certificate/example/server-cert-example Name: server-cert-example - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Orn: orn:ows:idauth::012345678910:server-certificate/example/server-cert-example + Path: "/example/" + schema: + "$ref": "#/components/schemas/CreateServerCertificateResponse" description: The HTTP 200 response (OK). tags: - ServerCertificate @@ -14843,87 +14952,87 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateSnapshotRequest" examples: ex1: summary: Creating from a volume value: - VolumeId: vol-12345678 Description: Snapshot created from a volume + VolumeId: vol-12345678 ex2: summary: Copying a snapshot value: - SourceSnapshotId: snap-12345678 - SourceRegionName: eu-west-2 Description: Snapshot created from another snapshot + SourceRegionName: eu-west-2 + SourceSnapshotId: snap-12345678 ex3: summary: Importing from a bucket value: + Description: Snapshot imported from a bucket FileLocation: https://oos.eu-west-2.outscale.com/BUCKET/KEY?AWSAccessKeyId=ABCDEFGHIJ0123456789&Expires=1493372309&Signature=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX SnapshotSize: 10737418240 - Description: Snapshot imported from a bucket + schema: + "$ref": "#/components/schemas/CreateSnapshotRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateSnapshotResponse" examples: ex1: summary: Creating from a volume value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Snapshot: - VolumeSize: 10 AccountId: '123456789012' - VolumeId: vol-12345678 CreationDate: '2010-10-01T12:34:56.789Z' + Description: Snapshot created from a volume PermissionsToCreateVolume: - GlobalPermission: false AccountIds: [] + GlobalPermission: false Progress: 0 SnapshotId: snap-12345678 State: pending/queued - Description: Snapshot created from a volume Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + VolumeId: vol-12345678 + VolumeSize: 10 ex2: summary: Copying a snapshot value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Snapshot: - VolumeSize: 10 AccountId: '123456789012' - VolumeId: vol-12345678 CreationDate: '2010-10-01T12:34:56.789Z' + Description: Snapshot copied from another snapshot PermissionsToCreateVolume: - GlobalPermission: false AccountIds: [] + GlobalPermission: false Progress: 100 SnapshotId: snap-12345678 State: completed - Description: Snapshot copied from another snapshot Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + VolumeId: vol-12345678 + VolumeSize: 10 ex3: summary: Importing from a bucket value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Snapshot: - VolumeSize: 10 AccountId: '123456789012' - VolumeId: vol-12345678 CreationDate: '2010-10-01T12:34:56.789Z' + Description: Snapshot imported from a bucket PermissionsToCreateVolume: - GlobalPermission: false AccountIds: [] + GlobalPermission: false Progress: 0 SnapshotId: snap-12345678 State: importing - Description: Snapshot imported from a bucket Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + VolumeId: vol-12345678 + VolumeSize: 10 + schema: + "$ref": "#/components/schemas/CreateSnapshotResponse" description: The HTTP 200 response (OK). '400': content: @@ -14955,38 +15064,38 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateSnapshotExportTaskRequest" examples: ex1: value: - SnapshotId: snap-12345678 OsuExport: DiskImageFormat: qcow2 OsuBucket: BUCKET OsuPrefix: PREFIX + SnapshotId: snap-12345678 + schema: + "$ref": "#/components/schemas/CreateSnapshotExportTaskRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateSnapshotExportTaskResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 SnapshotExportTask: - Tags: [] - TaskId: snap-export-12345678 Comment: Export of snapshot snap-12345678 OsuExport: - OsuPrefix: PREFIX - OsuBucket: BUCKET DiskImageFormat: qcow2 - State: pending - SnapshotId: snap-12345678 + OsuBucket: BUCKET + OsuPrefix: PREFIX Progress: 0 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + SnapshotId: snap-12345678 + State: pending + Tags: [] + TaskId: snap-export-12345678 + schema: + "$ref": "#/components/schemas/CreateSnapshotExportTaskResponse" description: The HTTP 200 response (OK). tags: - Snapshot @@ -15000,33 +15109,33 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateSubnetRequest" examples: ex1: value: - NetId: vpc-12345678 IpRange: 10.0.0.0/18 + NetId: vpc-12345678 + schema: + "$ref": "#/components/schemas/CreateSubnetRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateSubnetResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Subnet: - Tags: [] - SubregionName: eu-west-2a - SubnetId: subnet-12345678 AvailableIpsCount: 16379 IpRange: 10.0.0.0/18 MapPublicIpOnLaunch: false - State: available NetId: vpc-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + State: available + SubnetId: subnet-12345678 + SubregionName: eu-west-2a + Tags: [] + schema: + "$ref": "#/components/schemas/CreateSubnetResponse" description: The HTTP 200 response (OK). '400': content: @@ -15089,8 +15198,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateTagsRequest" examples: ex1: value: @@ -15099,17 +15206,19 @@ paths: Tags: - Key: key1 Value: value1 + schema: + "$ref": "#/components/schemas/CreateTagsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateTagsResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateTagsResponse" description: The HTTP 200 response (OK). '400': content: @@ -15140,32 +15249,32 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateUserRequest" examples: ex1: value: + Path: "/documentation/" UserEmail: user@example.com UserName: example-user - Path: "/documentation/" + schema: + "$ref": "#/components/schemas/CreateUserRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateUserResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 User: CreationDate: 2010-10-01 12:34:56.789000000 +00:00 LastModificationDate: 2017-05-10 12:34:56.789000000 +00:00 + Path: "/documentation/" UserEmail: user@example.com - UserName: example-user UserId: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 - Path: "/documentation/" - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + UserName: example-user + schema: + "$ref": "#/components/schemas/CreateUserResponse" description: The HTTP 200 response (OK). tags: - User @@ -15178,19 +15287,17 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateUserGroupRequest" examples: ex1: value: Path: "/example/" UserGroupName: example-usergroup + schema: + "$ref": "#/components/schemas/CreateUserGroupRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateUserGroupResponse" examples: ex1: value: @@ -15203,6 +15310,8 @@ paths: Orn: orn:ows:idauth::012345678910:usergroup/example/usergroup-example Path: "/example/" UserGroupId: ug-12345678 + schema: + "$ref": "#/components/schemas/CreateUserGroupResponse" description: The HTTP 200 response (OK). tags: - UserGroup @@ -15216,29 +15325,29 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateVirtualGatewayRequest" examples: ex1: value: ConnectionType: ipsec.1 + schema: + "$ref": "#/components/schemas/CreateVirtualGatewayRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateVirtualGatewayResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VirtualGateway: - VirtualGatewayId: vgw-12345678 ConnectionType: ipsec.1 NetToVirtualGatewayLinks: [] State: available Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + VirtualGatewayId: vgw-12345678 + schema: + "$ref": "#/components/schemas/CreateVirtualGatewayResponse" description: The HTTP 200 response (OK). tags: - VirtualGateway @@ -15254,8 +15363,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateVmGroupRequest" examples: ex1: value: @@ -15270,15 +15377,17 @@ paths: VmCount: 2 VmGroupName: ClusterLog-PPD01 VmTemplateId: vmtemplate-98765432109876543210987654321012 + schema: + "$ref": "#/components/schemas/CreateVmGroupRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateVmGroupResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VmGroup: CreationDate: '2010-10-01T12:34:56.789Z' Description: Production log collector @@ -15295,8 +15404,8 @@ paths: VmGroupName: ClusterLog-PPD01 VmIds: [] VmTemplateId: vmtemplate-98765432109876543210987654321012 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateVmGroupResponse" description: The HTTP 200 response (OK). '400': content: @@ -15330,8 +15439,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateVmTemplateRequest" examples: ex1: value: @@ -15346,30 +15453,32 @@ paths: - Key: key1 Value: value1 VmTemplateName: vmtemplate-example + schema: + "$ref": "#/components/schemas/CreateVmTemplateRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateVmTemplateResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VmTemplate: - VmTemplateName: vmtemplate-example + CpuCores: 2 + CpuGeneration: v4 CpuPerformance: high CreationDate: 2010-10-01 12:34:56.789000000 +00:00 - CpuCores: 2 + Description: Log collector template + ImageId: ami-12345678 + Ram: 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 + VmTemplateName: vmtemplate-example + schema: + "$ref": "#/components/schemas/CreateVmTemplateResponse" description: The HTTP 200 response (OK). tags: - VmTemplate @@ -15387,8 +15496,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateVmsRequest" examples: ex1: summary: Creating a VM (minimal syntax) @@ -15398,303 +15505,317 @@ paths: summary: Creating a VM in a Net value: ImageId: ami-12345678 - VmType: tinav5.c1r1p2 KeypairName: keypair-example SecurityGroupIds: - sg-12345678 SubnetId: subnet-12345678 UserData: "..." + VmType: tinav5.c1r1p2 ex3: summary: Creating a VM with block device mappings value: - ImageId: ami-12345678 - VmType: tinav5.c1r1p2 - KeypairName: keypair-example - SecurityGroupIds: - - sg-12345678 - SubnetId: subnet-12345678 - UserData: "..." BlockDeviceMappings: - - DeviceName: "/dev/sda1" - Bsu: + - Bsu: VolumeSize: 15 VolumeType: gp2 - - DeviceName: "/dev/sdb" - Bsu: + DeviceName: "/dev/sda1" + - Bsu: + Iops: 150 SnapshotId: snap-12345678 VolumeSize: 22 VolumeType: io1 - Iops: 150 + DeviceName: "/dev/sdb" + ImageId: ami-12345678 + KeypairName: keypair-example + SecurityGroupIds: + - sg-12345678 + SubnetId: subnet-12345678 + UserData: "..." + VmType: tinav5.c1r1p2 ex4: summary: Creating a VM with a NIC value: ImageId: ami-12345678 - VmType: tinav5.c1r1p2 KeypairName: keypair-example - UserData: "..." Nics: - DeviceNumber: 0 NicId: eni-12345678 + UserData: "..." + VmType: tinav5.c1r1p2 + schema: + "$ref": "#/components/schemas/CreateVmsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateVmsResponse" examples: ex1: summary: Creating a VM (minimal syntax) value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Vms: - - VmType: t2.small - VmInitiatedShutdownBehavior: stop - State: pending - StateReason: '' - RootDeviceType: ebs - RootDeviceName: "/dev/sda1" - IsSourceDestChecked: true - ImageId: ami-12345678 - DeletionProtection: false + - ActionsOnNextBoot: + SecureBoot: none Architecture: x86_64 - NestedVirtualization: false BlockDeviceMappings: - - DeviceName: "/dev/sda1" - Bsu: - VolumeId: vol-12345678 - State: attaching - LinkDate: '2010-10-01T12:34:56.789Z' + - Bsu: DeleteOnVmDeletion: true - VmId: i-12345678 - ReservationId: r-12345678 + LinkDate: '2010-10-01T12:34:56.789Z' + State: attaching + VolumeId: vol-12345678 + DeviceName: "/dev/sda1" + BootMode: legacy + BsuOptimized: false + CreationDate: '2010-10-01T12:34:56.789Z' + DeletionProtection: false Hypervisor: xen + ImageId: ami-12345678 + IsSourceDestChecked: true + LaunchNumber: 0 + NestedVirtualization: false + Performance: medium Placement: - Tenancy: default SubregionName: eu-west-2a + Tenancy: default + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + PrivateIp: 10.0.0.4 ProductCodes: - '0001' - CreationDate: '2010-10-01T12:34:56.789Z' - UserData: "..." - PrivateIp: 10.0.0.4 + ReservationId: r-12345678 + RootDeviceName: "/dev/sda1" + RootDeviceType: ebs SecurityGroups: - - SecurityGroupName: default - SecurityGroupId: sg-12345678 - BsuOptimized: false - LaunchNumber: 0 - Performance: medium + - SecurityGroupId: sg-12345678 + SecurityGroupName: default + State: pending + StateReason: '' Tags: [] - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + UserData: "..." + VmId: i-12345678 + VmInitiatedShutdownBehavior: stop + VmType: t2.small ex2: summary: Creating a VM in a Net value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Vms: - - VmType: tinav5.c1r1p2 - VmInitiatedShutdownBehavior: stop - State: pending - StateReason: '' - RootDeviceType: ebs - RootDeviceName: "/dev/sda1" - IsSourceDestChecked: true - KeypairName: keypair-example - ImageId: ami-12345678 - DeletionProtection: false + - ActionsOnNextBoot: + SecureBoot: none Architecture: x86_64 - NestedVirtualization: false BlockDeviceMappings: - - DeviceName: "/dev/sda1" - Bsu: - VolumeId: vol-12345678 - State: attaching - LinkDate: '2010-10-01T12:34:56.789Z' + - Bsu: 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 + LinkDate: '2010-10-01T12:34:56.789Z' + State: attaching + VolumeId: vol-12345678 + DeviceName: "/dev/sda1" + BootMode: legacy BsuOptimized: false + CreationDate: '2010-10-01T12:34:56.789Z' + DeletionProtection: false + Hypervisor: xen + ImageId: ami-12345678 + IsSourceDestChecked: true + KeypairName: keypair-example LaunchNumber: 0 + NestedVirtualization: false NetId: vpc-12345678 Nics: - - SubnetId: subnet-12345678 - State: in-use + - AccountId: '123456789012' + Description: Primary network interface + IsSourceDestChecked: true LinkNic: - State: attached + DeleteOnVmDeletion: true 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 + State: attached MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - IsPrimary: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - IsPrimary: true + SecurityGroups: + - SecurityGroupId: sg-12345678 + SecurityGroupName: security-group-example + State: in-use + SubnetId: subnet-12345678 Performance: high - Tags: [] + Placement: + SubregionName: eu-west-2a + Tenancy: default PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + PrivateIp: 10.0.0.4 + ProductCodes: + - '0001' + ReservationId: r-12345678 + RootDeviceName: "/dev/sda1" + RootDeviceType: ebs + SecurityGroups: + - SecurityGroupId: sg-12345678 + SecurityGroupName: security-group-example + State: pending + StateReason: '' + SubnetId: subnet-12345678 + Tags: [] + UserData: "..." + VmId: i-12345678 + VmInitiatedShutdownBehavior: stop + VmType: tinav5.c1r1p2 ex3: summary: Creating a VM with block device mappings value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Vms: - - VmType: tinav5.c1r1p2 - VmInitiatedShutdownBehavior: stop - State: pending - StateReason: '' - RootDeviceType: ebs - RootDeviceName: "/dev/sda1" - IsSourceDestChecked: true - KeypairName: keypair-example - ImageId: ami-12345678 - DeletionProtection: false + - ActionsOnNextBoot: + SecureBoot: none Architecture: x86_64 - NestedVirtualization: false BlockDeviceMappings: - - DeviceName: "/dev/sda1" - Bsu: - VolumeId: vol-12345678 - State: attaching - LinkDate: '2010-10-01T12:34:56.789Z' + - Bsu: DeleteOnVmDeletion: true - - DeviceName: "/dev/sda1" - Bsu: - VolumeId: vol-87654321 - State: attaching LinkDate: '2010-10-01T12:34:56.789Z' + State: attaching + VolumeId: vol-12345678 + DeviceName: "/dev/sda1" + - Bsu: 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 + LinkDate: '2010-10-01T12:34:56.789Z' + State: attaching + VolumeId: vol-87654321 + DeviceName: "/dev/sda1" + BootMode: legacy BsuOptimized: false + CreationDate: '2010-10-01T12:34:56.789Z' + DeletionProtection: false + Hypervisor: xen + ImageId: ami-12345678 + IsSourceDestChecked: true + KeypairName: keypair-example LaunchNumber: 0 + NestedVirtualization: false NetId: vpc-12345678 Nics: - - SubnetId: subnet-12345678 - State: in-use + - AccountId: '123456789012' + Description: Primary network interface + IsSourceDestChecked: true LinkNic: - State: attached + DeleteOnVmDeletion: true 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 + State: attached MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - IsPrimary: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - IsPrimary: true + SecurityGroups: + - SecurityGroupId: sg-12345678 + SecurityGroupName: security-group-example + State: in-use + SubnetId: subnet-12345678 Performance: high - Tags: [] + Placement: + SubregionName: eu-west-2a + Tenancy: default PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + PrivateIp: 10.0.0.4 + ProductCodes: + - '0001' + ReservationId: r-12345678 + RootDeviceName: "/dev/sda1" + RootDeviceType: ebs + SecurityGroups: + - SecurityGroupId: sg-12345678 + SecurityGroupName: security-group-example + State: pending + StateReason: '' + SubnetId: subnet-12345678 + Tags: [] + UserData: "..." + VmId: i-12345678 + VmInitiatedShutdownBehavior: stop + VmType: tinav5.c1r1p2 ex4: summary: Creating a VM with a NIC value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Vms: - - VmType: tinav5.c1r1p2 - VmInitiatedShutdownBehavior: stop - State: pending - StateReason: '' - RootDeviceType: ebs - RootDeviceName: "/dev/sda1" - IsSourceDestChecked: true - KeypairName: keypair-example - ImageId: ami-12345678 - DeletionProtection: false + - ActionsOnNextBoot: + SecureBoot: none Architecture: x86_64 - NestedVirtualization: false BlockDeviceMappings: - - DeviceName: "/dev/sda1" - Bsu: - VolumeId: vol-12345678 - State: attaching - LinkDate: '2010-10-01T12:34:56.789Z' + - Bsu: 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 + LinkDate: '2010-10-01T12:34:56.789Z' + State: attaching + VolumeId: vol-12345678 + DeviceName: "/dev/sda1" + BootMode: legacy BsuOptimized: false + CreationDate: '2010-10-01T12:34:56.789Z' + DeletionProtection: false + Hypervisor: xen + ImageId: ami-12345678 + IsSourceDestChecked: true + KeypairName: keypair-example LaunchNumber: 0 + NestedVirtualization: false NetId: vpc-12345678 Nics: - - SubnetId: subnet-12345678 - State: in-use + - AccountId: '123456789012' + Description: Example NIC + IsSourceDestChecked: true LinkNic: - State: attached + DeleteOnVmDeletion: true 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 + State: attached MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - IsPrimary: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - IsPrimary: true + SecurityGroups: + - SecurityGroupId: sg-12345678 + SecurityGroupName: security-group-example + State: in-use + SubnetId: subnet-12345678 Performance: high - Tags: [] + Placement: + SubregionName: eu-west-2a + Tenancy: default PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + PrivateIp: 10.0.0.4 + ProductCodes: + - '0001' + ReservationId: r-12345678 + RootDeviceName: "/dev/sda1" + RootDeviceType: ebs + SecurityGroups: + - SecurityGroupId: sg-12345678 + SecurityGroupName: security-group-example + State: pending + StateReason: '' + SubnetId: subnet-12345678 + Tags: [] + UserData: "..." + VmId: i-12345678 + VmInitiatedShutdownBehavior: stop + VmType: tinav5.c1r1p2 + schema: + "$ref": "#/components/schemas/CreateVmsResponse" description: The HTTP 200 response (OK). '400': content: @@ -15727,61 +15848,61 @@ paths: requestBody: content: 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 + Size: 10 + SubregionName: eu-west-2a + VolumeType: io1 ex2: summary: Creating a volume from a snapshot value: + Size: 10 SnapshotId: snap-12345678 - VolumeType: gp2 SubregionName: eu-west-2a - Size: 10 + VolumeType: gp2 + schema: + "$ref": "#/components/schemas/CreateVolumeRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateVolumeResponse" examples: ex1: summary: Creating an io1 volume value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Volume: - VolumeId: vol-12345678 - Tags: [] - VolumeType: io1 - SubregionName: eu-west-2a - State: creating CreationDate: '2010-10-01T12:34:56.789Z' Iops: 100 LinkedVolumes: [] Size: 10 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + State: creating + SubregionName: eu-west-2a + Tags: [] + VolumeId: vol-12345678 + VolumeType: io1 ex2: summary: Creating a volume from a snapshot value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Volume: - VolumeId: vol-12345678 - Tags: [] - VolumeType: gp2 - SubregionName: eu-west-2a - State: creating - SnapshotId: snap-12345678 CreationDate: '2010-10-01T12:34:56.789Z' Iops: 100 LinkedVolumes: [] Size: 10 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + SnapshotId: snap-12345678 + State: creating + SubregionName: eu-west-2a + Tags: [] + VolumeId: vol-12345678 + VolumeType: gp2 + schema: + "$ref": "#/components/schemas/CreateVolumeResponse" description: The HTTP 200 response (OK). '400': content: @@ -15816,41 +15937,41 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateVpnConnectionRequest" examples: ex1: value: ClientGatewayId: cgw-12345678 - VirtualGatewayId: vgw-12345678 ConnectionType: ipsec.1 StaticRoutesOnly: true + VirtualGatewayId: vgw-12345678 + schema: + "$ref": "#/components/schemas/CreateVpnConnectionRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateVpnConnectionResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VpnConnection: - Routes: [] - Tags: [] ClientGatewayConfiguration: "..." - StaticRoutesOnly: true - VirtualGatewayId: vgw-12345678 - ConnectionType: ipsec.1 ClientGatewayId: cgw-12345678 + ConnectionType: ipsec.1 + Routes: [] State: pending + StaticRoutesOnly: true + Tags: [] VgwTelemetries: - - StateDescription: IPSEC IS DOWN - AcceptedRouteCount: 0 + - AcceptedRouteCount: 0 LastStateChangeDate: '2017-05-10T12:34:56.789Z' OutsideIpAddress: 192.0.2.0 + StateDescription: IPSEC IS DOWN + VirtualGatewayId: vgw-12345678 VpnConnectionId: vpn-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateVpnConnectionResponse" description: The HTTP 200 response (OK). tags: - VpnConnection @@ -15864,24 +15985,24 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateVpnConnectionRouteRequest" examples: ex1: value: - VpnConnectionId: vpn-12345678 DestinationIpRange: 10.0.0.0/16 + VpnConnectionId: vpn-12345678 + schema: + "$ref": "#/components/schemas/CreateVpnConnectionRouteRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateVpnConnectionRouteResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateVpnConnectionRouteResponse" description: The HTTP 200 response (OK). tags: - VpnConnection @@ -15894,8 +16015,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteAccessKeyRequest" examples: ex1: summary: Deleting one of your own access keys (if you are the root @@ -15907,17 +16026,19 @@ paths: value: AccessKeyId: ABCDEFGHIJ0123456789 UserName: example-user + schema: + "$ref": "#/components/schemas/DeleteAccessKeyRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteAccessKeyResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteAccessKeyResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -15935,23 +16056,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteApiAccessRuleRequest" examples: ex1: value: ApiAccessRuleId: aar-1234567890abcdef1234567890abcdef + schema: + "$ref": "#/components/schemas/DeleteApiAccessRuleRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteApiAccessRuleResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteApiAccessRuleResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -15965,23 +16086,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteCaRequest" examples: ex1: value: CaId: ca-fedcba0987654321fedcba0987654321 + schema: + "$ref": "#/components/schemas/DeleteCaRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteCaResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteCaResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -15997,23 +16118,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteClientGatewayRequest" examples: ex1: value: ClientGatewayId: cgw-12345678 + schema: + "$ref": "#/components/schemas/DeleteClientGatewayRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteClientGatewayResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteClientGatewayResponse" description: The HTTP 200 response (OK). tags: - ClientGateway @@ -16034,8 +16155,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteDedicatedGroupRequest" examples: ex1: summary: Deleting a dedicated group without any resource in it. @@ -16047,17 +16166,19 @@ paths: value: DedicatedGroupId: ded-12345678 Force: true + schema: + "$ref": "#/components/schemas/DeleteDedicatedGroupRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteDedicatedGroupResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteDedicatedGroupResponse" description: The HTTP 200 response (OK). '400': content: @@ -16091,23 +16212,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteDhcpOptionsRequest" examples: ex1: value: DhcpOptionsSetId: dopt-12345678 + schema: + "$ref": "#/components/schemas/DeleteDhcpOptionsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteDhcpOptionsResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteDhcpOptionsResponse" description: The HTTP 200 response (OK). tags: - DhcpOption @@ -16120,23 +16241,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteDirectLinkRequest" examples: ex1: value: DirectLinkId: dxcon-12345678 + schema: + "$ref": "#/components/schemas/DeleteDirectLinkRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteDirectLinkResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteDirectLinkResponse" description: The HTTP 200 response (OK). tags: - DirectLink @@ -16147,23 +16268,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteDirectLinkInterfaceRequest" examples: ex1: value: DirectLinkInterfaceId: dxvif-12345678 + schema: + "$ref": "#/components/schemas/DeleteDirectLinkInterfaceRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteDirectLinkInterfaceResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteDirectLinkInterfaceResponse" description: The HTTP 200 response (OK). tags: - DirectLinkInterface @@ -16176,8 +16297,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteExportTaskRequest" examples: ex1: summary: Deleting an image export task @@ -16187,12 +16306,12 @@ paths: summary: Deleting a snapshot export task value: ExportTaskId: snap-export-12345678 + schema: + "$ref": "#/components/schemas/DeleteExportTaskRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteExportTaskResponse" examples: ex1: summary: Deleting an image export task @@ -16204,6 +16323,8 @@ paths: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteExportTaskResponse" description: The HTTP 200 response (OK). tags: - Task @@ -16216,23 +16337,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteFlexibleGpuRequest" examples: ex1: value: FlexibleGpuId: fgpu-12345678 + schema: + "$ref": "#/components/schemas/DeleteFlexibleGpuRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteFlexibleGpuResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteFlexibleGpuResponse" description: The HTTP 200 response (OK). tags: - FlexibleGpu @@ -16245,23 +16366,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteImageRequest" examples: ex1: value: ImageId: ami-12345678 + schema: + "$ref": "#/components/schemas/DeleteImageRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteImageResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteImageResponse" description: The HTTP 200 response (OK). '400': content: @@ -16292,23 +16413,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteInternetServiceRequest" examples: ex1: value: InternetServiceId: igw-12345678 + schema: + "$ref": "#/components/schemas/DeleteInternetServiceRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteInternetServiceResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteInternetServiceResponse" description: The HTTP 200 response (OK). '400': content: @@ -16339,8 +16460,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteKeypairRequest" examples: ex1: summary: Deleting a keypair with its name @@ -16350,17 +16469,19 @@ paths: summary: Deleting a keypair with its ID value: KeypairId: key-abcdef1234567890abcdef1234567890 + schema: + "$ref": "#/components/schemas/DeleteKeypairRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteKeypairResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteKeypairResponse" description: The HTTP 200 response (OK). '400': content: @@ -16391,23 +16512,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteListenerRuleRequest" examples: ex1: value: ListenerRuleName: example-listener-rule + schema: + "$ref": "#/components/schemas/DeleteListenerRuleRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteListenerRuleResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteListenerRuleResponse" description: The HTTP 200 response (OK). tags: - Listener @@ -16418,23 +16539,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteLoadBalancerRequest" examples: ex1: value: LoadBalancerName: example-lbu + schema: + "$ref": "#/components/schemas/DeleteLoadBalancerRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteLoadBalancerResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteLoadBalancerResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer @@ -16445,55 +16566,55 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteLoadBalancerListenersRequest" examples: ex1: value: LoadBalancerName: example-lbu LoadBalancerPorts: - 80 + schema: + "$ref": "#/components/schemas/DeleteLoadBalancerListenersRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteLoadBalancerListenersResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 LoadBalancer: - Tags: [] - SourceSecurityGroup: - SecurityGroupName: security-group-example - SecurityGroupAccountId: '123456789012' - SecuredCookies: false - Subnets: - - subnet-12345678 - NetId: vpc-12345678 - BackendVmIds: [] - ApplicationStickyCookiePolicies: [] - SecurityGroups: - - sg-12345678 - LoadBalancerType: internal AccessLog: - PublicationInterval: 60 IsEnabled: false + PublicationInterval: 60 + ApplicationStickyCookiePolicies: [] + BackendVmIds: [] DnsName: internal-example-lbu.123456789.eu-west-2.lbu.outscale.com HealthCheck: - UnhealthyThreshold: 2 - Timeout: 5 CheckInterval: 30 - Protocol: TCP HealthyThreshold: 10 Port: 80 + Protocol: TCP + Timeout: 5 + UnhealthyThreshold: 2 + Listeners: [] + LoadBalancerName: example-lbu LoadBalancerStickyCookiePolicies: [] + LoadBalancerType: internal + NetId: vpc-12345678 + SecuredCookies: false + SecurityGroups: + - sg-12345678 + SourceSecurityGroup: + SecurityGroupAccountId: '123456789012' + SecurityGroupName: security-group-example + Subnets: + - subnet-12345678 SubregionNames: - eu-west-2a - Listeners: [] - LoadBalancerName: example-lbu + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteLoadBalancerListenersResponse" description: The HTTP 200 response (OK). tags: - Listener @@ -16506,59 +16627,59 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteLoadBalancerPolicyRequest" examples: ex1: value: LoadBalancerName: example-lbu PolicyName: example-browser-policy + schema: + "$ref": "#/components/schemas/DeleteLoadBalancerPolicyRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteLoadBalancerPolicyResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 LoadBalancer: - Tags: [] - SourceSecurityGroup: - SecurityGroupName: default - SecurityGroupAccountId: '123456789012' - SecuredCookies: false - PublicIp: 192.0.2.0 - Subnets: - - subnet-12345678 - NetId: vpc-12345678 - BackendVmIds: [] - ApplicationStickyCookiePolicies: [] - SecurityGroups: - - sg-12345678 - LoadBalancerType: internet-facing AccessLog: - PublicationInterval: 60 IsEnabled: false + PublicationInterval: 60 + ApplicationStickyCookiePolicies: [] + BackendVmIds: [] 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 + Protocol: TCP + Timeout: 5 + UnhealthyThreshold: 2 Listeners: - BackendPort: 80 BackendProtocol: HTTP LoadBalancerPort: 80 LoadBalancerProtocol: HTTP LoadBalancerName: example-lbu + LoadBalancerStickyCookiePolicies: [] + LoadBalancerType: internet-facing + NetId: vpc-12345678 + PublicIp: 192.0.2.0 + SecuredCookies: false + SecurityGroups: + - sg-12345678 + SourceSecurityGroup: + SecurityGroupAccountId: '123456789012' + SecurityGroupName: default + Subnets: + - subnet-12345678 + SubregionNames: + - eu-west-2a + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteLoadBalancerPolicyResponse" description: The HTTP 200 response (OK). tags: - LoadBalancerPolicy @@ -16569,8 +16690,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteLoadBalancerTagsRequest" examples: ex1: value: @@ -16578,17 +16697,19 @@ paths: - example-lbu Tags: - Key: key1 + schema: + "$ref": "#/components/schemas/DeleteLoadBalancerTagsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteLoadBalancerTagsResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteLoadBalancerTagsResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer @@ -16601,23 +16722,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteNatServiceRequest" examples: ex1: value: NatServiceId: nat-12345678 + schema: + "$ref": "#/components/schemas/DeleteNatServiceRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteNatServiceResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteNatServiceResponse" description: The HTTP 200 response (OK). '400': content: @@ -16658,23 +16779,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteNetRequest" examples: ex1: value: NetId: vpc-12345678 + schema: + "$ref": "#/components/schemas/DeleteNetRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteNetResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteNetResponse" description: The HTTP 200 response (OK). '400': content: @@ -16705,23 +16826,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteNetAccessPointRequest" examples: ex1: value: NetAccessPointId: vpce-12345678 + schema: + "$ref": "#/components/schemas/DeleteNetAccessPointRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteNetAccessPointResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteNetAccessPointResponse" description: The HTTP 200 response (OK). tags: - NetAccessPoint @@ -16735,24 +16856,24 @@ paths: operationId: DeleteNetPeering requestBody: content: - application/json: - schema: - "$ref": "#/components/schemas/DeleteNetPeeringRequest" + application/json: examples: ex1: value: NetPeeringId: pcx-12345678 + schema: + "$ref": "#/components/schemas/DeleteNetPeeringRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteNetPeeringResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteNetPeeringResponse" description: The HTTP 200 response (OK). '400': content: @@ -16789,23 +16910,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteNicRequest" examples: ex1: value: NicId: eni-12345678 + schema: + "$ref": "#/components/schemas/DeleteNicRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteNicResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteNicResponse" description: The HTTP 200 response (OK). '400': content: @@ -16836,23 +16957,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeletePolicyRequest" examples: ex1: value: PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy + schema: + "$ref": "#/components/schemas/DeletePolicyRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeletePolicyResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeletePolicyResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -16864,24 +16985,24 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeletePolicyVersionRequest" examples: ex1: value: PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy VersionId: v1 + schema: + "$ref": "#/components/schemas/DeletePolicyVersionRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeletePolicyVersionResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeletePolicyVersionResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -16897,23 +17018,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteProductTypeRequest" examples: ex1: value: ProductTypeId: pty-12345678 + schema: + "$ref": "#/components/schemas/DeleteProductTypeRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteProductTypeResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteProductTypeResponse" description: The HTTP 200 response (OK). '400': content: @@ -16944,23 +17065,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeletePublicIpRequest" examples: ex1: value: PublicIp: 192.0.2.0 + schema: + "$ref": "#/components/schemas/DeletePublicIpRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeletePublicIpResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeletePublicIpResponse" description: The HTTP 200 response (OK). '400': content: @@ -16989,34 +17110,34 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteRouteRequest" examples: ex1: value: - RouteTableId: rtb-12345678 DestinationIpRange: 198.51.100.0/24 + RouteTableId: rtb-12345678 + schema: + "$ref": "#/components/schemas/DeleteRouteRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteRouteResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 RouteTable: - Routes: - - DestinationIpRange: 10.0.0.0/16 - CreationMethod: CreateRouteTable - State: active LinkRouteTables: [] NetId: vpc-12345678 - Tags: [] RoutePropagatingVirtualGateways: [] RouteTableId: rtb-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Routes: + - CreationMethod: CreateRouteTable + DestinationIpRange: 10.0.0.0/16 + State: active + Tags: [] + schema: + "$ref": "#/components/schemas/DeleteRouteResponse" description: The HTTP 200 response (OK). '400': content: @@ -17047,23 +17168,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteRouteTableRequest" examples: ex1: value: RouteTableId: rtb-12345678 + schema: + "$ref": "#/components/schemas/DeleteRouteTableRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteRouteTableResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteRouteTableResponse" description: The HTTP 200 response (OK). '400': content: @@ -17095,23 +17216,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteSecurityGroupRequest" examples: ex1: value: SecurityGroupId: sg-12345678 + schema: + "$ref": "#/components/schemas/DeleteSecurityGroupRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteSecurityGroupResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteSecurityGroupResponse" description: The HTTP 200 response (OK). '400': content: @@ -17144,75 +17265,75 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteSecurityGroupRuleRequest" examples: ex1: summary: Deleting an inbound rule from an IP range value: Flow: Inbound - SecurityGroupId: sg-12345678 FromPortRange: 80 - ToPortRange: 80 IpProtocol: tcp IpRange: 10.0.0.0/16 + SecurityGroupId: sg-12345678 + ToPortRange: 80 ex2: summary: Deleting an inbound rule from another security group value: Flow: Inbound - SecurityGroupId: sg-12345678 Rules: - FromPortRange: 22 - ToPortRange: 22 IpProtocol: tcp SecurityGroupsMembers: - AccountId: '123456789012' SecurityGroupName: another-security-group + ToPortRange: 22 + SecurityGroupId: sg-12345678 + schema: + "$ref": "#/components/schemas/DeleteSecurityGroupRuleRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteSecurityGroupRuleResponse" examples: ex1: summary: Deleting an inbound rule from an IP range value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 SecurityGroup: - Tags: [] - SecurityGroupName: security-group-example + AccountId: '123456789012' + Description: Example of security group + InboundRules: [] + NetId: vpc-12345678 OutboundRules: - FromPortRange: -1 IpProtocol: "-1" - ToPortRange: -1 IpRanges: - 0.0.0.0/0 + ToPortRange: -1 SecurityGroupId: sg-12345678 - AccountId: '123456789012' - Description: Example of security group - InboundRules: [] - NetId: vpc-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + SecurityGroupName: security-group-example + Tags: [] ex2: summary: Creating an inbound rule from another security group value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 SecurityGroup: - Tags: [] - SecurityGroupName: security-group-example + AccountId: '123456789012' + Description: Example of security group + InboundRules: [] + NetId: vpc-12345678 OutboundRules: - FromPortRange: -1 IpProtocol: "-1" - ToPortRange: -1 IpRanges: - 0.0.0.0/0 + ToPortRange: -1 SecurityGroupId: sg-12345678 - AccountId: '123456789012' - Description: Example of security group - InboundRules: [] - NetId: vpc-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + SecurityGroupName: security-group-example + Tags: [] + schema: + "$ref": "#/components/schemas/DeleteSecurityGroupRuleResponse" description: The HTTP 200 response (OK). '400': content: @@ -17241,23 +17362,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteServerCertificateRequest" examples: ex1: value: Name: server-cert-example + schema: + "$ref": "#/components/schemas/DeleteServerCertificateRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteServerCertificateResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteServerCertificateResponse" description: The HTTP 200 response (OK). tags: - ServerCertificate @@ -17270,23 +17391,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteSnapshotRequest" examples: ex1: value: SnapshotId: snap-12345678 + schema: + "$ref": "#/components/schemas/DeleteSnapshotRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteSnapshotResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteSnapshotResponse" description: The HTTP 200 response (OK). '400': content: @@ -17322,23 +17443,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteSubnetRequest" examples: ex1: value: SubnetId: subnet-12345678 + schema: + "$ref": "#/components/schemas/DeleteSubnetRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteSubnetResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteSubnetResponse" description: The HTTP 200 response (OK). '400': content: @@ -17367,8 +17488,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteTagsRequest" examples: ex1: value: @@ -17377,17 +17496,19 @@ paths: Tags: - Key: key1 Value: value1 + schema: + "$ref": "#/components/schemas/DeleteTagsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteTagsResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteTagsResponse" description: The HTTP 200 response (OK). '400': content: @@ -17417,23 +17538,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteUserRequest" examples: ex1: value: UserName: example-user + schema: + "$ref": "#/components/schemas/DeleteUserRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteUserResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteUserResponse" description: The HTTP 200 response (OK). tags: - User @@ -17449,25 +17570,25 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteUserGroupRequest" examples: ex1: value: Force: false Path: "/example/" UserGroupName: example-usergroup + schema: + "$ref": "#/components/schemas/DeleteUserGroupRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteUserGroupResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteUserGroupResponse" description: The HTTP 200 response (OK). tags: - UserGroup @@ -17478,25 +17599,25 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteUserGroupPolicyRequest" examples: ex1: value: PolicyName: example-usergroup-policy UserGroupName: example-usergroup UserGroupPath: "/example/" + schema: + "$ref": "#/components/schemas/DeleteUserGroupPolicyRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteUserGroupPolicyResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteUserGroupPolicyResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -17507,24 +17628,24 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteUserPolicyRequest" examples: ex1: value: PolicyName: example-user-policy UserName: example-user + schema: + "$ref": "#/components/schemas/DeleteUserPolicyRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteUserPolicyResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteUserPolicyResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -17537,23 +17658,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteVirtualGatewayRequest" examples: ex1: value: VirtualGatewayId: vgw-12345678 + schema: + "$ref": "#/components/schemas/DeleteVirtualGatewayRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteVirtualGatewayResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteVirtualGatewayResponse" description: The HTTP 200 response (OK). tags: - VirtualGateway @@ -17568,23 +17689,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteVmGroupRequest" examples: ex1: value: VmGroupId: vmgroup-12345678901234567890123456789012 + schema: + "$ref": "#/components/schemas/DeleteVmGroupRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteVmGroupResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteVmGroupResponse" description: The HTTP 200 response (OK). '400': content: @@ -17618,23 +17739,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteVmTemplateRequest" examples: ex1: value: VmTemplateId: vmtemplate-98765432109876543210987654321012 + schema: + "$ref": "#/components/schemas/DeleteVmTemplateRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteVmTemplateResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteVmTemplateResponse" description: The HTTP 200 response (OK). tags: - VmTemplate @@ -17647,28 +17768,28 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteVmsRequest" examples: ex1: value: VmIds: - i-12345678 + schema: + "$ref": "#/components/schemas/DeleteVmsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteVmsResponse" examples: ex1: value: - Vms: - - VmId: i-12345678 - PreviousState: running - CurrentState: shutting-down ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Vms: + - CurrentState: shutting-down + PreviousState: running + VmId: i-12345678 + schema: + "$ref": "#/components/schemas/DeleteVmsResponse" description: The HTTP 200 response (OK). '400': content: @@ -17699,23 +17820,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteVolumeRequest" examples: ex1: value: VolumeId: vol-12345678 + schema: + "$ref": "#/components/schemas/DeleteVolumeRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteVolumeResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteVolumeResponse" description: The HTTP 200 response (OK). '400': content: @@ -17746,23 +17867,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteVpnConnectionRequest" examples: ex1: value: VpnConnectionId: vpn-12345678 + schema: + "$ref": "#/components/schemas/DeleteVpnConnectionRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteVpnConnectionResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteVpnConnectionResponse" description: The HTTP 200 response (OK). tags: - VpnConnection @@ -17774,24 +17895,24 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteVpnConnectionRouteRequest" examples: ex1: value: - VpnConnectionId: vpn-12345678 DestinationIpRange: 10.0.0.0/16 + VpnConnectionId: vpn-12345678 + schema: + "$ref": "#/components/schemas/DeleteVpnConnectionRouteRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteVpnConnectionRouteResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteVpnConnectionRouteResponse" description: The HTTP 200 response (OK). tags: - VpnConnection @@ -17806,26 +17927,26 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeregisterVmsInLoadBalancerRequest" examples: ex1: value: - LoadBalancerName: example-lbu BackendVmIds: - i-12345678 - i-87654321 + LoadBalancerName: example-lbu + schema: + "$ref": "#/components/schemas/DeregisterVmsInLoadBalancerRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeregisterVmsInLoadBalancerResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeregisterVmsInLoadBalancerResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer @@ -17841,24 +17962,24 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/LinkFlexibleGpuRequest" examples: ex1: value: FlexibleGpuId: fgpu-12345678 VmId: i-12345678 + schema: + "$ref": "#/components/schemas/LinkFlexibleGpuRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/LinkFlexibleGpuResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/LinkFlexibleGpuResponse" description: The HTTP 200 response (OK). tags: - FlexibleGpu @@ -17871,24 +17992,24 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/LinkInternetServiceRequest" examples: ex1: value: InternetServiceId: igw-12345678 NetId: vpc-12345678 + schema: + "$ref": "#/components/schemas/LinkInternetServiceRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/LinkInternetServiceResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/LinkInternetServiceResponse" description: The HTTP 200 response (OK). '400': content: @@ -17919,29 +18040,27 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/LinkLoadBalancerBackendMachinesRequest" examples: ex1: summary: Linking VMs to a load balancer value: - LoadBalancerName: example-lbu BackendVmIds: - i-12345678 - i-87654321 + LoadBalancerName: example-lbu ex2: summary: Linking public IPs to a load balancer value: - LoadBalancerName: example-lbu BackendIps: - 192.0.2.0 - 198.51.100.0 + LoadBalancerName: example-lbu + schema: + "$ref": "#/components/schemas/LinkLoadBalancerBackendMachinesRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/LinkLoadBalancerBackendMachinesResponse" examples: ex1: summary: Linking VMs to a load balancer @@ -17953,6 +18072,8 @@ paths: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/LinkLoadBalancerBackendMachinesResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer @@ -17964,24 +18085,24 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/LinkManagedPolicyToUserGroupRequest" examples: ex1: value: PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy UserGroupName: example-usergroup + schema: + "$ref": "#/components/schemas/LinkManagedPolicyToUserGroupRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/LinkManagedPolicyToUserGroupResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/LinkManagedPolicyToUserGroupResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -17994,26 +18115,26 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/LinkNicRequest" examples: ex1: value: + DeviceNumber: 1 NicId: eni-12345678 VmId: i-12345678 - DeviceNumber: 1 + schema: + "$ref": "#/components/schemas/LinkNicRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/LinkNicResponse" examples: ex1: value: + LinkNicId: eni-attach-12345678 ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - LinkNicId: eni-attach-12345678 + schema: + "$ref": "#/components/schemas/LinkNicResponse" description: The HTTP 200 response (OK). '400': content: @@ -18042,24 +18163,24 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/LinkPolicyRequest" examples: ex1: value: PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy UserName: example-user + schema: + "$ref": "#/components/schemas/LinkPolicyRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/LinkPolicyResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/LinkPolicyResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -18076,8 +18197,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/LinkPrivateIpsRequest" examples: ex1: summary: Linking specific secondary private IPs to a NIC @@ -18091,17 +18210,19 @@ paths: value: NicId: eni-12345678 SecondaryPrivateIpCount: 3 + schema: + "$ref": "#/components/schemas/LinkPrivateIpsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/LinkPrivateIpsResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/LinkPrivateIpsResponse" description: The HTTP 200 response (OK). '400': content: @@ -18136,8 +18257,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/LinkPublicIpRequest" examples: ex1: summary: Linking a public IP to a VM @@ -18147,27 +18266,29 @@ paths: ex2: summary: Linking a public IP to a NIC value: - PublicIp: 192.0.2.0 NicId: eni-12345678 + PublicIp: 192.0.2.0 + schema: + "$ref": "#/components/schemas/LinkPublicIpRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/LinkPublicIpResponse" examples: ex1: summary: Linking a public IP to a VM value: + LinkPublicIpId: eipassoc-12345678 ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - LinkPublicIpId: eipassoc-12345678 ex2: summary: Linking a public IP to a NIC value: + LinkPublicIpId: eipassoc-12345678 ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - LinkPublicIpId: eipassoc-12345678 + schema: + "$ref": "#/components/schemas/LinkPublicIpResponse" description: The HTTP 200 response (OK). '400': content: @@ -18198,25 +18319,25 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/LinkRouteTableRequest" examples: ex1: value: RouteTableId: rtb-12345678 SubnetId: subnet-12345678 + schema: + "$ref": "#/components/schemas/LinkRouteTableRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/LinkRouteTableResponse" examples: ex1: value: + LinkRouteTableId: rtbassoc-12345678 ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - LinkRouteTableId: rtbassoc-12345678 + schema: + "$ref": "#/components/schemas/LinkRouteTableResponse" description: The HTTP 200 response (OK). '400': content: @@ -18249,27 +18370,27 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/LinkVirtualGatewayRequest" examples: ex1: value: - VirtualGatewayId: vgw-12345678 NetId: vpc-12345678 + VirtualGatewayId: vgw-12345678 + schema: + "$ref": "#/components/schemas/LinkVirtualGatewayRequest" 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 + State: attached + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/LinkVirtualGatewayResponse" description: The HTTP 200 response (OK). tags: - VirtualGateway @@ -18282,25 +18403,25 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/LinkVolumeRequest" examples: ex1: value: - VolumeId: vol-12345678 - VmId: i-12345678 DeviceName: "/dev/sdb" + VmId: i-12345678 + VolumeId: vol-12345678 + schema: + "$ref": "#/components/schemas/LinkVolumeRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/LinkVolumeResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/LinkVolumeResponse" description: The HTTP 200 response (OK). '400': content: @@ -18331,8 +18452,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/PutUserGroupPolicyRequest" examples: ex1: value: @@ -18341,17 +18460,19 @@ paths: PolicyName: example-usergroup-policy UserGroupName: example-usergroup UserGroupPath: "/example/" + schema: + "$ref": "#/components/schemas/PutUserGroupPolicyRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/PutUserGroupPolicyResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/PutUserGroupPolicyResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -18364,8 +18485,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/PutUserPolicyRequest" examples: ex1: value: @@ -18373,17 +18492,19 @@ paths: "Resource": ["*"]} ]}' PolicyName: example-user-policy UserName: example-user + schema: + "$ref": "#/components/schemas/PutUserPolicyRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/PutUserPolicyResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/PutUserPolicyResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -18394,8 +18515,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadAccessKeysRequest" examples: ex1: value: @@ -18404,24 +18523,26 @@ paths: - ACTIVE Tag: Group1 UserName: example-user + schema: + "$ref": "#/components/schemas/ReadAccessKeysRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadAccessKeysResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 AccessKeys: - - State: ACTIVE - AccessKeyId: ABCDEFGHIJ0123456789 + - AccessKeyId: ABCDEFGHIJ0123456789 CreationDate: 2010-10-01 12:34:56.789000000 +00:00 ExpirationDate: 2063-04-05 00:00:00.000000000 +00:00 LastModificationDate: 2010-10-01 12:34:56.789000000 +00:00 + State: ACTIVE Tag: Group1 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadAccessKeysResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -18435,32 +18556,32 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadAccountsRequest" examples: ex1: value: {} + schema: + "$ref": "#/components/schemas/ReadAccountsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadAccountsResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Accounts: - - ZipCode: '92210' - CompanyName: EXAMPLE SAS - FirstName: JEAN + - AccountId: '123456789012' City: SAINT-CLOUD + CompanyName: EXAMPLE SAS Country: FRANCE - LastName: DUPONT - AccountId: '123456789012' CustomerId: '87654321' Email: example@example.com + FirstName: JEAN + LastName: DUPONT + ZipCode: '92210' + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadAccountsResponse" description: The HTTP 200 response (OK). tags: - Account @@ -18477,25 +18598,25 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadAdminPasswordRequest" examples: ex1: value: VmId: i-12345678 + schema: + "$ref": "#/components/schemas/ReadAdminPasswordRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadAdminPasswordResponse" examples: ex1: value: - VmId: i-12345678 + AdminPassword: "..." ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - AdminPassword: "..." + VmId: i-12345678 + schema: + "$ref": "#/components/schemas/ReadAdminPasswordResponse" description: The HTTP 200 response (OK). '400': content: @@ -18526,25 +18647,25 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadApiAccessPolicyRequest" examples: ex1: value: {} + schema: + "$ref": "#/components/schemas/ReadApiAccessPolicyRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadApiAccessPolicyResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ApiAccessPolicy: - RequireTrustedEnv: false MaxAccessKeyExpirationSeconds: 0 + RequireTrustedEnv: false + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadApiAccessPolicyResponse" description: The HTTP 200 response (OK). '400': content: @@ -18576,38 +18697,38 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadApiAccessRulesRequest" examples: ex1: value: Filters: ApiAccessRuleIds: - aar-1234567890abcdef1234567890abcdef + schema: + "$ref": "#/components/schemas/ReadApiAccessRulesRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadApiAccessRulesResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ApiAccessRules: - - IpRanges: - - 0.0.0.0/0 - ApiAccessRuleId: aar-1234567890abcdef1234567890abcdef + - ApiAccessRuleId: aar-1234567890abcdef1234567890abcdef CaIds: [] Cns: [] Description: Allows all IPv4 domain - - IpRanges: - - 46.231.144.178/32 - ApiAccessRuleId: aar-abcdef1234567890abcdef1234567890 + IpRanges: + - 0.0.0.0/0 + - ApiAccessRuleId: aar-abcdef1234567890abcdef1234567890 CaIds: [] Cns: [] Description: Allows Outscale Cockpit of this region + IpRanges: + - 46.231.144.178/32 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadApiAccessRulesResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -18627,49 +18748,49 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadApiLogsRequest" examples: ex1: value: Filters: + QueryDateAfter: '2017-05-10' + QueryDateBefore: '2017-05-10' QueryIpAddresses: - 192.0.2.0 - 198.51.100.0 - QueryDateAfter: '2017-05-10' - QueryDateBefore: '2017-05-10' + schema: + "$ref": "#/components/schemas/ReadApiLogsRequest" 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 + - AccountId: '123456789012' CallDuration: 47 - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + QueryAccessKey: ABCDEFGHIJ0123456789 + QueryApiName: oapi QueryApiVersion: '1.27' - AccountId: '123456789012' - QueryPayloadSize: 2 QueryCallName: ReadAccessKeys - QueryAccessKey: ABCDEFGHIJ0123456789 - QueryHeaderSize: 287 QueryDate: '2017-05-10T12:34:56.789Z' QueryHeaderRaw: 'Host: api.eu-west-2.outscale.com\nAccept: */*\nConnection: close\nUser-Agent: oAPI CLI v0.1 - 2018-09-28\nX-Osc-Date: 20170510T000000Z\nContent-Type: application/json; charset=utf-8\nAuthorization: *****\nContent-Length: 2\nAccept-Encoding: gzip, deflate\nX-Forwarded-For: 192.0.2.0' + QueryHeaderSize: 287 + QueryIpAddress: 192.0.2.0 + QueryPayloadRaw: "{}" + QueryPayloadSize: 2 + QueryUserAgent: oAPI CLI v0.1 - 2018-09-28 + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ResponseSize: 1887 + ResponseStatusCode: 200 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadApiLogsResponse" description: The HTTP 200 response (OK). tags: - ApiLog @@ -18681,29 +18802,29 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadCasRequest" examples: ex1: value: Filters: CaIds: - ca-fedcba0987654321fedcba0987654321 + schema: + "$ref": "#/components/schemas/ReadCasRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadCasResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Cas: - - Description: CA example + - CaFingerprint: 1234567890abcdef1234567890abcdef12345678 CaId: ca-fedcba0987654321fedcba0987654321 - CaFingerprint: 1234567890abcdef1234567890abcdef12345678 + Description: CA example + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadCasResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -18717,32 +18838,32 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadCatalogRequest" examples: ex1: value: {} + schema: + "$ref": "#/components/schemas/ReadCatalogRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadCatalogResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Catalog: Entries: - - UnitPrice: 0.04 - Type: CustomCore:v5-p1 + - Category: compute + Operation: RunInstances-OD + Service: TinaOS-FCU + SubregionName: eu-west-2 Title: Instance - On demand - Unite de vCore pour une instance Tina v5 CxRy Performance highest - par heure - SubregionName: eu-west-2 - Category: compute - Service: TinaOS-FCU - Operation: RunInstances-OD + Type: CustomCore:v5-p1 + UnitPrice: 0.04 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadCatalogResponse" description: The HTTP 200 response (OK). tags: - Catalog @@ -18754,8 +18875,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadCatalogsRequest" examples: ex1: value: @@ -18763,29 +18882,31 @@ paths: CurrentCatalogOnly: true FromDate: '2021-01-01' ToDate: '2023-01-01' + schema: + "$ref": "#/components/schemas/ReadCatalogsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadCatalogsResponse" examples: ex1: value: - 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 + - Entries: + - Category: compute + Operation: RunInstances-OD + Service: TinaOS-FCU + SubregionName: eu-west-2 Title: Instance - On demand - Unite de vCore pour une instance Tina v5 CxRy Performance highest - par heure - SubregionName: eu-west-2 - Category: compute - Service: TinaOS-FCU - Operation: RunInstances-OD + Type: CustomCore:v5-p1 + UnitPrice: 0.04 + FromDate: 2021-01-01 00:00:00.000000000 +00:00 + State: CURRENT + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadCatalogsResponse" description: The HTTP 200 response (OK). tags: - Catalog @@ -18796,8 +18917,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadClientGatewaysRequest" examples: ex1: value: @@ -18812,24 +18931,26 @@ paths: PublicIps: - 192.0.2.0 - 198.51.100.0 + schema: + "$ref": "#/components/schemas/ReadClientGatewaysRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadClientGatewaysResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ClientGateways: - - State: available - BgpAsn: 65000 - Tags: [] + - BgpAsn: 65000 ClientGatewayId: cgw-12345678 ConnectionType: ipsec.1 PublicIp: 192.0.2.0 + State: available + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadClientGatewaysResponse" description: The HTTP 200 response (OK). tags: - ClientGateway @@ -18844,25 +18965,25 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadConsoleOutputRequest" examples: ex1: value: VmId: i-12345678 + schema: + "$ref": "#/components/schemas/ReadConsoleOutputRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadConsoleOutputResponse" examples: ex1: value: - VmId: i-12345678 + ConsoleOutput: "..." ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - ConsoleOutput: "..." + VmId: i-12345678 + schema: + "$ref": "#/components/schemas/ReadConsoleOutputResponse" description: The HTTP 200 response (OK). '400': content: @@ -18892,41 +19013,41 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadConsumptionAccountRequest" examples: ex1: value: FromDate: '2023-06-01' - ToDate: '2023-07-01' ShowPrice: true + ToDate: '2023-07-01' + schema: + "$ref": "#/components/schemas/ReadConsumptionAccountRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadConsumptionAccountResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ConsumptionEntries: - - UnitPrice: 0.044 - Type: BoxUsage:tinav4.c1r1p2 + - AccountId: '123456789012' + Category: compute + FromDate: 2023-06-01 00:00:00.000000000 +00:00 Operation: RunInstances-OD + PayingAccountId: '123456789012' + Price: 61.248 + Service: TinaOS-FCU SubregionName: eu-west-2a - Value: 1392 Title: Instance - On demand - tinav4.c1r1 high performance - par heure - Category: compute ToDate: 2023-06-30 00:00:00.000000000 +00:00 - Service: TinaOS-FCU - AccountId: '123456789012' - PayingAccountId: '123456789012' - FromDate: 2023-06-01 00:00:00.000000000 +00:00 - Price: 61.248 + Type: BoxUsage:tinav4.c1r1p2 + UnitPrice: 0.044 + Value: 1392 Currency: EUR + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadConsumptionAccountResponse" description: The HTTP 200 response (OK). tags: - Account @@ -18941,8 +19062,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadDedicatedGroupsRequest" examples: ex1: summary: Filtering on a specific dedicated group @@ -18954,30 +19073,32 @@ paths: summary: Filtering on a specific Subregion and CPU generation value: Filters: - SubregionNames: - - eu-west-2a CpuGenerations: - 4 + SubregionNames: + - eu-west-2a + schema: + "$ref": "#/components/schemas/ReadDedicatedGroupsRequest" 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' + - AccountId: '123456789012' CpuGeneration: 4 + DedicatedGroupId: ded-12345678 Name: dedicated-group-example + NetIds: [] SubregionName: eu-west-2a - DedicatedGroupId: ded-12345678 + VmIds: + - i-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadDedicatedGroupsResponse" description: The HTTP 200 response (OK). '400': content: @@ -19006,8 +19127,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadDhcpOptionsRequest" examples: ex1: value: @@ -19022,28 +19141,30 @@ paths: - 198.51.100.0 DomainNames: - example.com + schema: + "$ref": "#/components/schemas/ReadDhcpOptionsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadDhcpOptionsResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 DhcpOptionsSets: - - Tags: [] - NtpServers: - - 203.0.113.0 - - 203.0.113.1 - Default: false + - Default: false DhcpOptionsSetId: dopt-12345678 DomainName: example.com DomainNameServers: - 192.0.2.0 - 198.51.100.0 + NtpServers: + - 203.0.113.0 + - 203.0.113.1 + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadDhcpOptionsResponse" description: The HTTP 200 response (OK). tags: - DhcpOption @@ -19054,39 +19175,39 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadDirectLinkInterfacesRequest" examples: ex1: value: Filters: DirectLinkInterfaceIds: - dxvif-12345678 + schema: + "$ref": "#/components/schemas/ReadDirectLinkInterfacesRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadDirectLinkInterfacesResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 DirectLinkInterfaces: - - Vlan: 101 - OutscalePrivateIp: 172.16.0.4/30 - DirectLinkInterfaceId: dxvif-12345678 + - AccountId: '123456789012' BgpAsn: 65000 - AccountId: '123456789012' ClientPrivateIp: 172.16.0.5/30 - VirtualGatewayId: vgw-12345678 - DirectLinkInterfaceName: MyDirectLinkInterface DirectLinkId: dxcon-12345678 - Mtu: 1500 - State: available + DirectLinkInterfaceId: dxvif-12345678 + DirectLinkInterfaceName: MyDirectLinkInterface InterfaceType: private Location: PAR1 + Mtu: 1500 + OutscalePrivateIp: 172.16.0.4/30 + State: available + VirtualGatewayId: vgw-12345678 + Vlan: 101 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadDirectLinkInterfacesResponse" description: The HTTP 200 response (OK). tags: - DirectLinkInterface @@ -19097,25 +19218,21 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadDirectLinksRequest" examples: ex1: value: Filters: DirectLinkIds: - dxcon-12345678 + schema: + "$ref": "#/components/schemas/ReadDirectLinksRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadDirectLinksResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 DirectLinks: - AccountId: '123456789012' Bandwidth: 1Gbps @@ -19124,6 +19241,10 @@ paths: Location: PAR1 RegionName: eu-west-2 State: available + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadDirectLinksResponse" description: The HTTP 200 response (OK). tags: - DirectLink @@ -19135,8 +19256,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadEntitiesLinkedToPolicyRequest" examples: ex1: summary: Reading all entities linked to a specific policy @@ -19149,23 +19268,17 @@ paths: EntitiesType: - USER PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy + schema: + "$ref": "#/components/schemas/ReadEntitiesLinkedToPolicyRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadEntitiesLinkedToPolicyResponse" examples: ex1: summary: Reading all entities linked to a specific policy value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 PolicyEntities: - Users: - - Id: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 - Name: example-user - Orn: orn:ows:idauth::012345678910:user/example/user-example Groups: - Id: ug-12345678 Name: example-usergroup @@ -19174,16 +19287,24 @@ paths: ItemsCount: 3 MaxResultsLimit: 100 MaxResultsTruncated: false + Users: + - Id: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 + Name: example-user + Orn: orn:ows:idauth::012345678910:user/example/user-example + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Reading only users linked to a specific policy value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 PolicyEntities: Users: - Id: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 Name: example-user Orn: orn:ows:idauth::012345678910:user/example/user-example + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadEntitiesLinkedToPolicyResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -19194,29 +19315,29 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadFlexibleGpuCatalogRequest" examples: ex1: value: {} + schema: + "$ref": "#/components/schemas/ReadFlexibleGpuCatalogRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadFlexibleGpuCatalogResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 FlexibleGpuCatalog: - - VRam: 16000 - Generations: + - Generations: - v5 MaxCpu: 80 MaxRam: 512 ModelName: nvidia-p100 + VRam: 16000 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadFlexibleGpuCatalogResponse" description: The HTTP 200 response (OK). security: [] tags: @@ -19228,8 +19349,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadFlexibleGpusRequest" examples: ex1: value: @@ -19244,17 +19363,15 @@ paths: - nvidia-p100 States: - attached + schema: + "$ref": "#/components/schemas/ReadFlexibleGpusRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadFlexibleGpusResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 FlexibleGpus: - DeleteOnVmDeletion: true FlexibleGpuId: fgpu-12345678 @@ -19263,6 +19380,10 @@ paths: State: attached SubregionName: eu-west-2a VmId: i-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadFlexibleGpusResponse" description: The HTTP 200 response (OK). tags: - FlexibleGpu @@ -19273,36 +19394,36 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadImageExportTasksRequest" examples: ex1: value: Filters: TaskIds: - image-export-12345678 + schema: + "$ref": "#/components/schemas/ReadImageExportTasksRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadImageExportTasksResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ImageExportTasks: - - Tags: [] + - Comment: Export of image ami-12345678 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 + OsuBucket: BUCKET + OsuPrefix: PREFIX/ami-12345678/ Progress: 0 + State: pending/queued + Tags: [] + TaskId: image-export-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadImageExportTasksResponse" description: The HTTP 200 response (OK). tags: - Image @@ -19313,8 +19434,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadImagesRequest" examples: ex1: summary: Reading a specific image @@ -19331,102 +19450,110 @@ paths: ImageNames: - Ubuntu* - RockyLinux* + schema: + "$ref": "#/components/schemas/ReadImagesRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadImagesResponse" examples: ex1: summary: Reading a specific image value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Images: - - StateComment: {} - State: available - RootDeviceType: bsu - RootDeviceName: "/dev/sda1" - ProductCodes: - - '0001' - PermissionsToLaunch: - GlobalPermission: false - AccountIds: [] - AccountId: '123456789012' - Tags: [] - Description: '' - ImageId: ami-12345678 + - AccountId: '123456789012' + Architecture: x86_64 BlockDeviceMappings: - - DeviceName: "/dev/sda1" - Bsu: - VolumeType: standard + - Bsu: DeleteOnVmDeletion: true - VolumeSize: 50 SnapshotId: snap-12345678 - ImageType: machine + VolumeSize: 50 + VolumeType: standard + DeviceName: "/dev/sda1" + BootModes: + - legacy CreationDate: '2010-10-01T12:34:56.789Z' + Description: '' FileLocation: 123456789012/create-image-example - Architecture: x86_64 + ImageId: ami-12345678 ImageName: create-image-example + ImageType: machine + PermissionsToLaunch: + AccountIds: [] + GlobalPermission: false + ProductCodes: + - '0001' + RootDeviceName: "/dev/sda1" + RootDeviceType: bsu + SecureBoot: false + State: available + StateComment: {} + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 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: [] + - AccountAlias: Outscale AccountId: '123456789012' - Tags: [] - Description: '' - ImageId: ami-12345678 + Architecture: x86_64 BlockDeviceMappings: - - DeviceName: "/dev/sda1" - Bsu: - VolumeType: standard + - Bsu: DeleteOnVmDeletion: true - VolumeSize: 10 SnapshotId: snap-12345678 - ImageType: machine - AccountAlias: Outscale + VolumeSize: 10 + VolumeType: standard + DeviceName: "/dev/sda1" CreationDate: '2010-10-01T12:34:56.789Z' + Description: '' FileLocation: Outscale/Ubuntu-2010.10.01-0 - Architecture: x86_64 + ImageId: ami-12345678 ImageName: Ubuntu-2010.10.01-0 - - StateComment: {} - State: available - RootDeviceType: bsu - RootDeviceName: "/dev/sda1" - ProductCodes: - - '0001' + ImageType: machine PermissionsToLaunch: - GlobalPermission: true AccountIds: [] - AccountId: '123456789012' + GlobalPermission: true + ProductCodes: + - '0001' + RootDeviceName: "/dev/sda1" + RootDeviceType: bsu + State: available + StateComment: {} Tags: [] - Description: '' - ImageId: ami-12345678 + - AccountAlias: Outscale + AccountId: '123456789012' + Architecture: x86_64 BlockDeviceMappings: - - DeviceName: "/dev/sda1" - Bsu: - VolumeType: standard + - Bsu: DeleteOnVmDeletion: true - VolumeSize: 10 SnapshotId: snap-12345678 - ImageType: machine - AccountAlias: Outscale + VolumeSize: 10 + VolumeType: standard + DeviceName: "/dev/sda1" + BootModes: + - legacy CreationDate: '2010-10-01T12:34:56.789Z' + Description: '' FileLocation: Outscale/RockyLinux-2010.10.01-0 - Architecture: x86_64 + ImageId: ami-12345678 ImageName: RockyLinux-2010.10.01-0 + ImageType: machine + PermissionsToLaunch: + AccountIds: [] + GlobalPermission: true + ProductCodes: + - '0001' + RootDeviceName: "/dev/sda1" + RootDeviceType: bsu + SecureBoot: false + State: available + StateComment: {} + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadImagesResponse" description: The HTTP 200 response (OK). '400': content: @@ -19457,8 +19584,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadInternetServicesRequest" examples: ex1: value: @@ -19473,24 +19598,26 @@ paths: TagValues: - prod - test + schema: + "$ref": "#/components/schemas/ReadInternetServicesRequest" 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 + - InternetServiceId: igw-12345678 NetId: vpc-12345678 - InternetServiceId: igw-12345678 + State: available + Tags: + - Key: env + Value: prod + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadInternetServicesResponse" description: The HTTP 200 response (OK). '400': content: @@ -19519,30 +19646,30 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadKeypairsRequest" examples: ex1: value: Filters: KeypairNames: - keypair-example + schema: + "$ref": "#/components/schemas/ReadKeypairsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadKeypairsResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Keypairs: - - KeypairType: ssh-rsa - KeypairName: keypair-example + - KeypairFingerprint: 11:22:33:44:55:66:77:88:99:00:aa:bb:cc:dd:ee:ff KeypairId: key-abcdef1234567890abcdef1234567890 - KeypairFingerprint: 11:22:33:44:55:66:77:88:99:00:aa:bb:cc:dd:ee:ff + KeypairName: keypair-example + KeypairType: ssh-rsa + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadKeypairsResponse" description: The HTTP 200 response (OK). '400': content: @@ -19571,8 +19698,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadLinkedPoliciesRequest" examples: ex1: value: @@ -19581,26 +19706,28 @@ paths: FirstItem: 1 ResultsPerPage: 30 UserName: example-user + schema: + "$ref": "#/components/schemas/ReadLinkedPoliciesRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadLinkedPoliciesResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 HasMoreItems: true + MaxResultsLimit: 30 + MaxResultsTruncated: false Policies: - - PolicyName: example-user-policy - CreationDate: 2010-10-01 12:34:56.789000000 +00:00 + - CreationDate: 2010-10-01 12:34:56.789000000 +00:00 LastModificationDate: 2010-10-01 12:34:56.789000000 +00:00 Orn: orn:ows:idauth::012345678910:policy/example/example-user-policy PolicyId: ABCDEFGHIJKLMNOPQRSTUVWXYZ01234 - MaxResultsLimit: 30 - MaxResultsTruncated: false + PolicyName: example-user-policy + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadLinkedPoliciesResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -19612,34 +19739,34 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadListenerRulesRequest" examples: ex1: value: Filters: ListenerRuleNames: - example-listener-rule + schema: + "$ref": "#/components/schemas/ReadListenerRulesRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadListenerRulesResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ListenerRules: - - Priority: 10 - VmIds: - - i-12345678 - ListenerRuleName: example-listener-rule - Action: forward - ListenerId: 123456 + - Action: forward HostNamePattern: "*.example.com" + ListenerId: 123456 ListenerRuleId: 1234 + ListenerRuleName: example-listener-rule + Priority: 10 + VmIds: + - i-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadListenerRulesResponse" description: The HTTP 200 response (OK). tags: - Listener @@ -19650,28 +19777,28 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadLoadBalancerTagsRequest" examples: ex1: value: LoadBalancerNames: - private-lb-example + schema: + "$ref": "#/components/schemas/ReadLoadBalancerTagsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadLoadBalancerTagsResponse" examples: ex1: value: - Tags: - - Value: value1 - LoadBalancerName: private-lb-example - Key: key1 ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Tags: + - Key: key1 + LoadBalancerName: private-lb-example + Value: value1 + schema: + "$ref": "#/components/schemas/ReadLoadBalancerTagsResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer @@ -19682,61 +19809,61 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadLoadBalancersRequest" examples: ex1: value: Filters: LoadBalancerNames: - private* + schema: + "$ref": "#/components/schemas/ReadLoadBalancersRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadLoadBalancersResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 LoadBalancers: - - 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 + - AccessLog: IsEnabled: false + PublicationInterval: 60 + ApplicationStickyCookiePolicies: [] + BackendVmIds: [] DnsName: private-lb-example.123456789.eu-west-2.lbu.outscale.com HealthCheck: - UnhealthyThreshold: 2 - Timeout: 5 CheckInterval: 30 - Protocol: TCP HealthyThreshold: 10 Port: 80 + Protocol: TCP + Timeout: 5 + UnhealthyThreshold: 2 + Listeners: + - BackendPort: 80 + BackendProtocol: HTTP + LoadBalancerPort: 443 + LoadBalancerProtocol: HTTPS + ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate + LoadBalancerName: private-lb-example LoadBalancerStickyCookiePolicies: [] + LoadBalancerType: internet-facing + NetId: vpc-12345678 + PublicIp: 192.0.2.0 + SecuredCookies: false + SecurityGroups: + - sg-12345678 + SourceSecurityGroup: + SecurityGroupAccountId: '123456789012' + SecurityGroupName: security-group-example + Subnets: + - subnet-12345678 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 + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadLoadBalancersResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer @@ -19749,27 +19876,27 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadLocationsRequest" examples: ex1: value: {} + schema: + "$ref": "#/components/schemas/ReadLocationsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadLocationsResponse" examples: ex1: value: + Locations: + - Code: PAR1 + Name: Telehouse 3, France + - Code: PAR4 + Name: Equinix Pantin, France ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - Locations: - - Name: Telehouse 3, France - Code: PAR1 - - Name: Equinix Pantin, France - Code: PAR4 + schema: + "$ref": "#/components/schemas/ReadLocationsResponse" description: The HTTP 200 response (OK). security: [] tags: @@ -19781,8 +19908,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadManagedPoliciesLinkedToUserGroupRequest" examples: ex1: value: @@ -19793,17 +19918,15 @@ paths: FirstItem: 1 ResultsPerPage: 30 UserGroupName: example-usergroup + schema: + "$ref": "#/components/schemas/ReadManagedPoliciesLinkedToUserGroupRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadManagedPoliciesLinkedToUserGroupResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 HasMoreItems: true MaxResultsLimit: 30 MaxResultsTruncated: true @@ -19813,6 +19936,10 @@ paths: Orn: orn:ows:idauth::012345678910:policy/example/example-user-policy PolicyId: ABCDEFGHIJKLMNOPQRSTUVWXYZ01234 PolicyName: example-policy + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadManagedPoliciesLinkedToUserGroupResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -19823,8 +19950,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadNatServicesRequest" examples: ex1: value: @@ -19839,26 +19964,28 @@ paths: - vpc-87654321 SubnetIds: - subnet-12345678 + schema: + "$ref": "#/components/schemas/ReadNatServicesRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadNatServicesResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 NatServices: - - Tags: [] - SubnetId: subnet-12345678 - NatServiceId: nat-12345678 - PublicIps: - - PublicIpId: eipalloc-12345678 - PublicIp: 192.0.2.0 + - NatServiceId: nat-12345678 NetId: vpc-12345678 + PublicIps: + - PublicIp: 192.0.2.0 + PublicIpId: eipalloc-12345678 State: available + SubnetId: subnet-12345678 + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadNatServicesResponse" description: The HTTP 200 response (OK). '400': content: @@ -19889,8 +20016,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadNetAccessPointServicesRequest" examples: ex1: summary: Listing one or more services according to their service IDs @@ -19905,41 +20030,43 @@ paths: Filters: ServiceNames: - com.outscale.eu-west-2.api + schema: + "$ref": "#/components/schemas/ReadNetAccessPointServicesRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadNetAccessPointServicesResponse" examples: ex1: summary: Listing one or more services according to their service IDs value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Services: - - ServiceName: com.outscale.eu-west-2.api - ServiceId: pl-12345678 - IpRanges: + - IpRanges: - 192.0.2.0 - - ServiceName: com.outscale.eu-west-2.oos - ServiceId: pl-87654321 - IpRanges: + ServiceId: pl-12345678 + ServiceName: com.outscale.eu-west-2.api + - IpRanges: - 198.51.100.0 - 203.0.113.0 - 203.0.113.1 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ServiceId: pl-87654321 + ServiceName: com.outscale.eu-west-2.oos 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 + Services: + - IpRanges: + - 192.0.2.0 + ServiceId: pl-12345678 + ServiceName: com.outscale.eu-west-2.api + schema: + "$ref": "#/components/schemas/ReadNetAccessPointServicesResponse" description: The HTTP 200 response (OK). security: [] tags: @@ -19951,8 +20078,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadNetAccessPointsRequest" examples: ex1: value: @@ -19966,25 +20091,27 @@ paths: - vpc-12345678 States: - available + schema: + "$ref": "#/components/schemas/ReadNetAccessPointsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadNetAccessPointsResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 NetAccessPoints: - - Tags: [] - NetAccessPointId: vpce-12345678 + - NetAccessPointId: vpce-12345678 + NetId: vpc-12345678 RouteTableIds: - rtb-12345678 - State: available - NetId: vpc-12345678 ServiceName: com.outscale.eu-west-2.oos + State: available + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadNetAccessPointsResponse" description: The HTTP 200 response (OK). tags: - NetAccessPoint @@ -19995,8 +20122,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadNetPeeringsRequest" examples: ex1: value: @@ -20011,31 +20136,33 @@ paths: StateNames: - active - pending-acceptance + schema: + "$ref": "#/components/schemas/ReadNetPeeringsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadNetPeeringsResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 NetPeerings: - - Tags: [] - State: - Name: active - Message: Active - AccepterNet: - NetId: vpc-12345678 - IpRange: 172.16.0.0/16 + - AccepterNet: AccountId: '123456789012' - SourceNet: + IpRange: 172.16.0.0/16 NetId: vpc-12345678 - IpRange: 10.0.0.0/16 - AccountId: '123456789012' NetPeeringId: pcx-12345678 + SourceNet: + AccountId: '123456789012' + IpRange: 10.0.0.0/16 + NetId: vpc-12345678 + State: + Message: Active + Name: active + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadNetPeeringsResponse" description: The HTTP 200 response (OK). '400': content: @@ -20064,8 +20191,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadNetsRequest" examples: ex1: value: @@ -20077,24 +20202,26 @@ paths: Filters: States: - available + schema: + "$ref": "#/components/schemas/ReadNetsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadNetsResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Nets: - - Tags: [] - DhcpOptionsSetId: dopt-12345678 + - DhcpOptionsSetId: dopt-12345678 IpRange: 10.0.0.0/16 - Tenancy: default NetId: vpc-12345678 State: available + Tags: [] + Tenancy: default + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadNetsResponse" description: The HTTP 200 response (OK). '400': content: @@ -20125,8 +20252,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadNicsRequest" examples: ex1: value: @@ -20138,43 +20263,45 @@ paths: Filters: LinkNicVmIds: - i-12345678 + schema: + "$ref": "#/components/schemas/ReadNicsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadNicsResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Nics: - - SubregionName: eu-west-2a - SubnetId: subnet-12345678 - State: in-use + - AccountId: '123456789012' + Description: Primary network interface + IsSourceDestChecked: true LinkNic: - VmId: i-12345678 - LinkNicId: eni-attach-12345678 - VmAccountId: '123456789012' DeleteOnVmDeletion: false DeviceNumber: 0 + LinkNicId: eni-attach-12345678 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 + VmAccountId: '123456789012' + VmId: i-12345678 MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - IsPrimary: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - IsPrimary: true + SecurityGroups: + - SecurityGroupId: sg-12345678 + SecurityGroupName: security-group-example + State: in-use + SubnetId: subnet-12345678 + SubregionName: eu-west-2a + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadNicsResponse" description: The HTTP 200 response (OK). '400': content: @@ -20203,8 +20330,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadPoliciesRequest" examples: ex1: value: @@ -20214,31 +20339,33 @@ paths: Scope: OWS FirstItem: 1 ResultsPerPage: 30 + schema: + "$ref": "#/components/schemas/ReadPoliciesRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadPoliciesResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 HasMoreItems: true + MaxResultsLimit: 30 + MaxResultsTruncated: false Policies: - - ResourcesCount: 1 - PolicyName: example-user-policy - PolicyDefaultVersionId: v1 - Path: "/example/" - CreationDate: 2010-10-01 12:34:56.789000000 +00:00 + - CreationDate: 2010-10-01 12:34:56.789000000 +00:00 Description: Example of description - PolicyId: ABCDEFGHIJKLMNOPQRSTUVWXYZ01234 - Orn: orn:ows:idauth::012345678910:policy/example/example-user-policy IsLinkable: true LastModificationDate: 2010-10-01 12:34:56.789000000 +00:00 - MaxResultsLimit: 30 - MaxResultsTruncated: false + Orn: orn:ows:idauth::012345678910:policy/example/example-user-policy + Path: "/example/" + PolicyDefaultVersionId: v1 + PolicyId: ABCDEFGHIJKLMNOPQRSTUVWXYZ01234 + PolicyName: example-user-policy + ResourcesCount: 1 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadPoliciesResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -20249,34 +20376,34 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadPolicyRequest" examples: ex1: value: PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy + schema: + "$ref": "#/components/schemas/ReadPolicyRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadPolicyResponse" examples: ex1: value: Policy: - ResourcesCount: 0 - PolicyName: example-user-policy - PolicyDefaultVersionId: v1 - Path: "/example/" CreationDate: 2010-10-01 12:34:56.789000000 +00:00 Description: Example of description - PolicyId: ABCDEFGHIJKLMNOPQRSTUVWXYZ01234 - Orn: orn:ows:idauth::012345678910:policy/example/example-user-policy IsLinkable: true LastModificationDate: 2010-10-01 12:34:56.789000000 +00:00 + Orn: orn:ows:idauth::012345678910:policy/example/example-user-policy + Path: "/example/" + PolicyDefaultVersionId: v1 + PolicyId: ABCDEFGHIJKLMNOPQRSTUVWXYZ01234 + PolicyName: example-user-policy + ResourcesCount: 0 ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadPolicyResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -20287,30 +20414,30 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadPolicyVersionRequest" examples: ex1: value: PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy VersionId: v1 + schema: + "$ref": "#/components/schemas/ReadPolicyVersionRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadPolicyVersionResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 PolicyVersion: - VersionId: v1 - DefaultVersion: true - CreationDate: 2010-10-01 12:34:56.789000000 +00:00 Body: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], "Resource": ["*"]} ]}' + CreationDate: 2010-10-01 12:34:56.789000000 +00:00 + DefaultVersion: true + VersionId: v1 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadPolicyVersionResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -20322,33 +20449,33 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadPolicyVersionsRequest" examples: ex1: value: FirstItem: 1 PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy ResultsPerPage: 30 + schema: + "$ref": "#/components/schemas/ReadPolicyVersionsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadPolicyVersionsResponse" examples: ex1: value: + HasMoreItems: true MaxResultsLimit: 30 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 PolicyVersions: - - VersionId: v1 - DefaultVersion: true - CreationDate: 2010-10-01 12:34:56.789000000 +00:00 - Body: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], + - Body: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], "Resource": ["*"]} ]}' - HasMoreItems: true + CreationDate: 2010-10-01 12:34:56.789000000 +00:00 + DefaultVersion: true + VersionId: v1 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadPolicyVersionsResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -20359,28 +20486,28 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadProductTypesRequest" examples: ex1: value: Filters: ProductTypeIds: - '0001' + schema: + "$ref": "#/components/schemas/ReadProductTypesRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadProductTypesResponse" examples: ex1: value: + ProductTypes: + - Description: Linux + ProductTypeId: '0001' ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - ProductTypes: - - ProductTypeId: '0001' - Description: Linux + schema: + "$ref": "#/components/schemas/ReadProductTypesResponse" description: The HTTP 200 response (OK). security: [] tags: @@ -20394,32 +20521,32 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadPublicCatalogRequest" examples: ex1: value: {} + schema: + "$ref": "#/components/schemas/ReadPublicCatalogRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadPublicCatalogResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Catalog: Entries: - - UnitPrice: 0.04 - Type: CustomCore:v5-p1 + - Category: compute + Operation: RunInstances-OD + Service: TinaOS-FCU + SubregionName: eu-west-2 Title: Instance - On demand - Unite de vCore pour une instance Tina v5 CxRy Performance highest - par heure - SubregionName: eu-west-2 - Category: compute - Service: TinaOS-FCU - Operation: RunInstances-OD + Type: CustomCore:v5-p1 + UnitPrice: 0.04 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadPublicCatalogResponse" description: The HTTP 200 response (OK). security: [] tags: @@ -20433,25 +20560,25 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadPublicIpRangesRequest" examples: ex1: value: {} + schema: + "$ref": "#/components/schemas/ReadPublicIpRangesRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadPublicIpRangesResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 PublicIps: - 198.51.100.0/24 - 203.0.113.0/24 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadPublicIpRangesResponse" description: The HTTP 200 response (OK). security: [] tags: @@ -20465,8 +20592,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadPublicIpsRequest" examples: ex1: value: @@ -20478,26 +20603,28 @@ paths: Filters: VmIds: - i-12345678 + schema: + "$ref": "#/components/schemas/ReadPublicIpsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadPublicIpsResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 PublicIps: - - VmId: i-12345678 - Tags: [] - PublicIpId: eipalloc-12345678 - PublicIp: 192.0.2.0 - LinkPublicIpId: eipassoc-12345678 + - LinkPublicIpId: eipassoc-12345678 NicAccountId: '123456789012' NicId: eni-12345678 PrivateIp: 10.0.0.4 + PublicIp: 192.0.2.0 + PublicIpId: eipalloc-12345678 + Tags: [] + VmId: i-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadPublicIpsResponse" description: The HTTP 200 response (OK). '400': content: @@ -20528,8 +20655,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadQuotasRequest" examples: ex1: summary: Reading specific quota @@ -20543,52 +20668,54 @@ paths: Filters: Collections: - VPC + schema: + "$ref": "#/components/schemas/ReadQuotasRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadQuotasResponse" examples: ex1: summary: Reading specific quota value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 QuotaTypes: - - Quotas: - - ShortDescription: Load Balancer Limit - QuotaCollection: LBU - AccountId: '123456789012' + - QuotaType: global + Quotas: + - AccountId: '123456789012' Description: Maximum number of load balancers per region MaxValue: 20 - UsedValue: 0 Name: lb_limit - QuotaType: global + QuotaCollection: LBU + ShortDescription: Load Balancer Limit + UsedValue: 0 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Reading collection of quotas value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 QuotaTypes: - - Quotas: - - ShortDescription: Example Limit - QuotaCollection: VPC - AccountId: '123456789012' + - QuotaType: global + Quotas: + - 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' + ShortDescription: Example Limit + UsedValue: 0 + - QuotaType: vpc-12345678 + Quotas: + - AccountId: '123456789012' Description: Maximum number of other examples MaxValue: 50 - UsedValue: 1 Name: other_example_limit - QuotaType: vpc-12345678 + QuotaCollection: VPC + ShortDescription: Other Example Limit + UsedValue: 1 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadQuotasResponse" description: The HTTP 200 response (OK). tags: - Quota @@ -20601,29 +20728,29 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadRegionsRequest" examples: ex1: value: {} + schema: + "$ref": "#/components/schemas/ReadRegionsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadRegionsResponse" examples: ex1: value: + Regions: + - Endpoint: api.eu-west-2.outscale.com + RegionName: eu-west-2 + - Endpoint: api.us-east-2.outscale.com + RegionName: us-east-2 + - Endpoint: api.us-west-1.outscale.com + RegionName: us-west-1 ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - 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 + schema: + "$ref": "#/components/schemas/ReadRegionsResponse" description: The HTTP 200 response (OK). security: [] tags: @@ -20637,8 +20764,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadRouteTablesRequest" examples: ex1: value: @@ -20648,35 +20773,37 @@ paths: ex2: value: Filters: + LinkRouteTableMain: true NetIds: - vpc-12345678 - vpc-87654321 - LinkRouteTableMain: true + schema: + "$ref": "#/components/schemas/ReadRouteTablesRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadRouteTablesResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 RouteTables: - - Routes: - - DestinationIpRange: 10.0.0.0/16 - CreationMethod: CreateRouteTable - State: active - LinkRouteTables: - - Main: true - LinkRouteTableId: rtbassoc-12345678 - RouteTableId: rtb-12345678 + - LinkRouteTables: + - LinkRouteTableId: rtbassoc-12345678 + Main: true NetId: vpc-12345678 + RouteTableId: rtb-12345678 NetId: vpc-12345678 - Tags: [] RoutePropagatingVirtualGateways: [] RouteTableId: rtb-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Routes: + - CreationMethod: CreateRouteTable + DestinationIpRange: 10.0.0.0/16 + State: active + Tags: [] + schema: + "$ref": "#/components/schemas/ReadRouteTablesResponse" description: The HTTP 200 response (OK). '400': content: @@ -20707,8 +20834,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadSecurityGroupsRequest" examples: ex1: value: @@ -20720,37 +20845,39 @@ paths: Filters: InboundRuleIpRanges: - 192.0.2.0 + schema: + "$ref": "#/components/schemas/ReadSecurityGroupsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadSecurityGroupsResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 SecurityGroups: - - Tags: [] - SecurityGroupName: security-group-example - OutboundRules: - - FromPortRange: -1 - IpProtocol: "-1" - ToPortRange: -1 - IpRanges: - - 0.0.0.0/0 - SecurityGroupId: sg-12345678 - AccountId: '123456789012' + - AccountId: '123456789012' Description: Example of security group InboundRules: - FromPortRange: 22 IpProtocol: tcp - ToPortRange: 22 IpRanges: - 192.0.2.0 - 198.51.100.0 + ToPortRange: 22 NetId: vpc-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + OutboundRules: + - FromPortRange: -1 + IpProtocol: "-1" + IpRanges: + - 0.0.0.0/0 + ToPortRange: -1 + SecurityGroupId: sg-12345678 + SecurityGroupName: security-group-example + Tags: [] + schema: + "$ref": "#/components/schemas/ReadSecurityGroupsResponse" description: The HTTP 200 response (OK). '400': content: @@ -20779,30 +20906,30 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadServerCertificatesRequest" examples: ex1: value: Filters: Paths: - "/example/" + schema: + "$ref": "#/components/schemas/ReadServerCertificatesRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadServerCertificatesResponse" examples: ex1: value: - 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 + ServerCertificates: + - Id: ABCDEFGHIJKLMNOPQRSTUVWXYZ1234 + Name: server-cert-example + Orn: orn:ows:idauth::012345678910:server-certificate/example/server-cert-example + Path: "/example/" + schema: + "$ref": "#/components/schemas/ReadServerCertificatesResponse" description: The HTTP 200 response (OK). tags: - ServerCertificate @@ -20813,36 +20940,36 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadSnapshotExportTasksRequest" examples: ex1: value: Filters: TaskIds: - snap-export-12345678 + schema: + "$ref": "#/components/schemas/ReadSnapshotExportTasksRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadSnapshotExportTasksResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 SnapshotExportTasks: - - Tags: [] - TaskId: snap-export-12345678 - Comment: Export of snapshot snap-12345678 + - Comment: Export of snapshot snap-12345678 OsuExport: - OsuPrefix: PREFIX - OsuBucket: BUCKET DiskImageFormat: qcow2 - State: pending - SnapshotId: snap-12345678 + OsuBucket: BUCKET + OsuPrefix: PREFIX Progress: 99 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + SnapshotId: snap-12345678 + State: pending + Tags: [] + TaskId: snap-export-12345678 + schema: + "$ref": "#/components/schemas/ReadSnapshotExportTasksResponse" description: The HTTP 200 response (OK). tags: - Snapshot @@ -20854,8 +20981,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadSnapshotsRequest" examples: ex1: value: @@ -20870,49 +20995,51 @@ paths: TagValues: - prod - test + schema: + "$ref": "#/components/schemas/ReadSnapshotsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadSnapshotsResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Snapshots: - - VolumeSize: 10 - AccountId: '123456789012' - VolumeId: vol-12345678 + - AccountId: '123456789012' CreationDate: '2010-10-01T12:34:56.789Z' + Description: Snapshot created from a volume PermissionsToCreateVolume: - GlobalPermission: false AccountIds: [] + GlobalPermission: false Progress: 100 SnapshotId: snap-12345678 State: completed - Description: Snapshot created from a volume Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + VolumeId: vol-12345678 + VolumeSize: 10 ex2: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Snapshots: - - VolumeSize: 10 - AccountId: '123456789012' - VolumeId: vol-12345678 + - AccountId: '123456789012' CreationDate: '2010-10-01T12:34:56.789Z' + Description: Test snapshot PermissionsToCreateVolume: - GlobalPermission: false AccountIds: [] + GlobalPermission: false Progress: 100 SnapshotId: snap-12345678 State: completed - Description: Test snapshot Tags: - - Value: test - Key: env - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + - Key: env + Value: test + VolumeId: vol-12345678 + VolumeSize: 10 + schema: + "$ref": "#/components/schemas/ReadSnapshotsResponse" description: The HTTP 200 response (OK). '400': content: @@ -20943,8 +21070,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadSubnetsRequest" examples: ex1: value: @@ -20959,26 +21084,28 @@ paths: - pending SubregionNames: - eu-west-2a + schema: + "$ref": "#/components/schemas/ReadSubnetsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadSubnetsResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Subnets: - - Tags: [] - SubregionName: eu-west-2a - SubnetId: subnet-12345678 - AvailableIpsCount: 16379 + - AvailableIpsCount: 16379 IpRange: 10.0.0.0/18 MapPublicIpOnLaunch: false - State: available NetId: vpc-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + State: available + SubnetId: subnet-12345678 + SubregionName: eu-west-2a + Tags: [] + schema: + "$ref": "#/components/schemas/ReadSubnetsResponse" description: The HTTP 200 response (OK). '400': content: @@ -21010,8 +21137,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadSubregionsRequest" examples: ex1: summary: Listing a specific Subregion in the current Region @@ -21026,37 +21151,39 @@ paths: SubregionNames: - eu-west-2a - eu-west-2b + schema: + "$ref": "#/components/schemas/ReadSubregionsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadSubregionsResponse" examples: ex1: summary: Listing a specific Subregion in the current Region value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Subregions: - - State: available + - LocationCode: PAR1 RegionName: eu-west-2 + State: available SubregionName: eu-west-2a - LocationCode: PAR1 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Listing two specific Subregions in the current Region value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Subregions: - - State: available + - LocationCode: PAR1 RegionName: eu-west-2 + State: available SubregionName: eu-west-2a - LocationCode: PAR1 - - State: available + - LocationCode: PAR4 RegionName: eu-west-2 + State: available SubregionName: eu-west-2b - LocationCode: PAR4 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadSubregionsResponse" description: The HTTP 200 response (OK). tags: - Subregion @@ -21067,32 +21194,32 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadTagsRequest" examples: ex1: value: Filters: - ResourceTypes: - - snapshot Keys: - key1 + ResourceTypes: + - snapshot + schema: + "$ref": "#/components/schemas/ReadTagsRequest" 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 + Tags: + - Key: key1 + ResourceId: snap-12345678 + ResourceType: snapshot + Value: value1 + schema: + "$ref": "#/components/schemas/ReadTagsResponse" description: The HTTP 200 response (OK). '400': content: @@ -21121,32 +21248,32 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadUnitPriceRequest" examples: ex1: value: Operation: CreateVolume Service: TinaOS-FCU Type: BSU:VolumeIOPS:io1 + schema: + "$ref": "#/components/schemas/ReadUnitPriceRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadUnitPriceResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 UnitPriceEntry: - UnitPrice: 0.01 - Unit: PER_IOPS_PER_MONTH Currency: EUR Operation: CreateVolume - Type: BSU:VolumeIOPS:io1 Service: TinaOS-FCU + Type: BSU:VolumeIOPS:io1 + Unit: PER_IOPS_PER_MONTH + UnitPrice: 0.01 + schema: + "$ref": "#/components/schemas/ReadUnitPriceResponse" description: The HTTP 200 response (OK). tags: - Catalog @@ -21157,19 +21284,17 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadUserGroupRequest" examples: ex1: value: Path: "/example/" UserGroupName: example-usergroup + schema: + "$ref": "#/components/schemas/ReadUserGroupRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadUserGroupResponse" examples: ex1: value: @@ -21189,6 +21314,8 @@ paths: UserEmail: user@example.com UserId: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 UserName: example-user + schema: + "$ref": "#/components/schemas/ReadUserGroupResponse" description: The HTTP 200 response (OK). tags: - UserGroup @@ -21199,8 +21326,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadUserGroupPoliciesRequest" examples: ex1: value: @@ -21208,17 +21333,15 @@ paths: ResultsPerPage: 30 UserGroupName: example-usergroup UserGroupPath: "/example/" + schema: + "$ref": "#/components/schemas/ReadUserGroupPoliciesRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadUserGroupPoliciesResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 HasMoreItems: true MaxResultsLimit: 30 MaxResultsTruncated: true @@ -21226,6 +21349,10 @@ paths: - Body: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], "Resource": ["*"]} ]}' Name: example-policy + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadUserGroupPoliciesResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -21237,29 +21364,29 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadUserGroupPolicyRequest" examples: ex1: value: PolicyName: example-policy UserGroupName: example-usergroup UserGroupPath: "/example/" + schema: + "$ref": "#/components/schemas/ReadUserGroupPolicyRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadUserGroupPolicyResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Policy: Body: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], "Resource": ["*"]} ]}' Name: example-policy + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadUserGroupPolicyResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -21272,8 +21399,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadUserGroupsRequest" examples: ex1: value: @@ -21283,20 +21408,20 @@ paths: - ug-12345678 FirstItem: 1 ResultsPerPage: 30 + schema: + "$ref": "#/components/schemas/ReadUserGroupsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadUserGroupsResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 HasMoreItems: true MaxResultsLimit: 30 MaxResultsTruncated: true + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 UserGroups: - CreationDate: '2010-10-01T12:34:56.789Z' LastModificationDate: '2010-10-01T12:34:56.789Z' @@ -21304,6 +21429,8 @@ paths: Orn: orn:ows:idauth::012345678910:usergroup/example/usergroup-example Path: "/example/" UserGroupId: ug-12345678 + schema: + "$ref": "#/components/schemas/ReadUserGroupsResponse" description: The HTTP 200 response (OK). tags: - UserGroup @@ -21314,19 +21441,17 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadUserGroupsPerUserRequest" examples: ex1: value: UserName: example-user UserPath: "/example/" + schema: + "$ref": "#/components/schemas/ReadUserGroupsPerUserRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadUserGroupsPerUserResponse" examples: ex1: value: @@ -21339,6 +21464,8 @@ paths: Orn: orn:ows:idauth::012345678910:usergroup/example/usergroup-example Path: "/example/" UserGroupId: ug-12345678 + schema: + "$ref": "#/components/schemas/ReadUserGroupsPerUserResponse" description: The HTTP 200 response (OK). tags: - UserGroup @@ -21349,18 +21476,16 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadUserPoliciesRequest" examples: ex1: value: UserName: example-user + schema: + "$ref": "#/components/schemas/ReadUserPoliciesRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadUserPoliciesResponse" examples: ex1: value: @@ -21368,6 +21493,8 @@ paths: - example-policy ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadUserPoliciesResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -21379,19 +21506,17 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadUserPolicyRequest" examples: ex1: value: - UserName: example-user PolicyName: example-user-policy + UserName: example-user + schema: + "$ref": "#/components/schemas/ReadUserPolicyRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadUserPolicyResponse" examples: ex1: value: @@ -21399,6 +21524,8 @@ paths: ["*"], "Resource": ["*"]} ]}' PolicyName: example-user-policy UserName: example-user + schema: + "$ref": "#/components/schemas/ReadUserPolicyResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -21411,30 +21538,30 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadUsersRequest" examples: ex1: value: Filters: UserIds: - ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 + schema: + "$ref": "#/components/schemas/ReadUsersRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadUsersResponse" examples: ex1: value: - Users: - - UserEmail: user@example.com - UserName: example-user - UserId: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 - Path: "/documentation/" ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Users: + - Path: "/documentation/" + UserEmail: user@example.com + UserId: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 + UserName: example-user + schema: + "$ref": "#/components/schemas/ReadUsersResponse" description: The HTTP 200 response (OK). tags: - User @@ -21445,8 +21572,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadVirtualGatewaysRequest" examples: ex1: value: @@ -21456,40 +21581,42 @@ paths: ex2: value: Filters: - States: - - available LinkStates: - attached - detached + States: + - available + schema: + "$ref": "#/components/schemas/ReadVirtualGatewaysRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadVirtualGatewaysResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VirtualGateways: - - VirtualGatewayId: vgw-12345678 - ConnectionType: ipsec.1 + - ConnectionType: ipsec.1 NetToVirtualGatewayLinks: [] State: available Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + VirtualGatewayId: vgw-12345678 ex2: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VirtualGateways: - - VirtualGatewayId: vgw-12345678 - ConnectionType: ipsec.1 + - ConnectionType: ipsec.1 NetToVirtualGatewayLinks: - - State: attached - NetId: vpc-12345678 + - NetId: vpc-12345678 + State: attached State: available Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + VirtualGatewayId: vgw-12345678 + schema: + "$ref": "#/components/schemas/ReadVirtualGatewaysResponse" description: The HTTP 200 response (OK). tags: - VirtualGateway @@ -21504,40 +21631,40 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadVmGroupsRequest" examples: ex1: value: Filters: VmGroupIds: - vmgroup-12345678901234567890123456789012 + schema: + "$ref": "#/components/schemas/ReadVmGroupsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadVmGroupsResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VmGroups: - - SecurityGroupIds: - - sg-87654321 - VmIds: - - i-12345678 - CreationDate: 2010-10-01 12:34:56.789000000 +00:00 - VmCount: 1 - VmGroupName: ClusterLog-PPD01 - SubnetId: subnet-12345678 + - CreationDate: 2010-10-01 12:34:56.789000000 +00:00 PositioningStrategy: attract + SecurityGroupIds: + - sg-87654321 State: available - VmGroupId: vmgroup-12345678901234567890123456789012 + SubnetId: subnet-12345678 Tags: - - Value: value1 - Key: key1 + - Key: key1 + Value: value1 + VmCount: 1 + VmGroupId: vmgroup-12345678901234567890123456789012 + VmGroupName: ClusterLog-PPD01 + VmIds: + - i-12345678 + schema: + "$ref": "#/components/schemas/ReadVmGroupsResponse" description: The HTTP 200 response (OK). '400': content: @@ -21570,8 +21697,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadVmTemplatesRequest" examples: ex1: value: @@ -21585,28 +21710,30 @@ paths: - 2 CpuGenerations: - v4 + schema: + "$ref": "#/components/schemas/ReadVmTemplatesRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadVmTemplatesResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VmTemplates: - - VmTemplateName: vmtemplate-example + - CpuCores: 2 + CpuGeneration: v4 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 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Tags: [] + VmTemplateId: vmtemplate-98765432109876543210987654321012 + VmTemplateName: vmtemplate-example + schema: + "$ref": "#/components/schemas/ReadVmTemplatesResponse" description: The HTTP 200 response (OK). tags: - VmTemplate @@ -21617,32 +21744,32 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadVmTypesRequest" examples: ex1: value: Filters: VmTypeNames: - t2.small + schema: + "$ref": "#/components/schemas/ReadVmTypesRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadVmTypesResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VmTypes: - - VolumeCount: 0 - VmTypeName: t2.small - BsuOptimized: false + - BsuOptimized: false MaxPrivateIps: 4 MemorySize: 2 VcoreCount: 1 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + VmTypeName: t2.small + VolumeCount: 0 + schema: + "$ref": "#/components/schemas/ReadVmTypesResponse" description: The HTTP 200 response (OK). security: [] tags: @@ -21656,8 +21783,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadVmsRequest" examples: ex1: value: @@ -21672,82 +21797,87 @@ paths: TagValues: - prod - test + schema: + "$ref": "#/components/schemas/ReadVmsRequest" 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 + application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Vms: + - ActionsOnNextBoot: + SecureBoot: none Architecture: x86_64 - NestedVirtualization: false BlockDeviceMappings: - - DeviceName: "/dev/sda1" - Bsu: - VolumeId: vol-12345678 - State: attached - LinkDate: '2010-10-01T12:34:56.789Z' + - Bsu: 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 + LinkDate: '2010-10-01T12:34:56.789Z' + State: attached + VolumeId: vol-12345678 + DeviceName: "/dev/sda1" + BootMode: legacy BsuOptimized: false + CreationDate: '2010-10-01T12:34:56.789Z' + DeletionProtection: false + Hypervisor: xen + ImageId: ami-12345678 + IsSourceDestChecked: true + KeypairName: keypair-example LaunchNumber: 0 + NestedVirtualization: false NetId: vpc-12345678 Nics: - - SubnetId: subnet-12345678 - State: in-use + - AccountId: '123456789012' + Description: Primary network interface + IsSourceDestChecked: true LinkNic: - State: attached + DeleteOnVmDeletion: true 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 + State: attached MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - IsPrimary: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - IsPrimary: true + SecurityGroups: + - SecurityGroupId: sg-12345678 + SecurityGroupName: security-group-example + State: in-use + SubnetId: subnet-12345678 Performance: high - Tags: - - Value: prod - Key: env + Placement: + SubregionName: eu-west-2a + Tenancy: default PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + PrivateIp: 10.0.0.4 + ProductCodes: + - '0001' + ReservationId: r-12345678 + RootDeviceName: "/dev/sda1" + RootDeviceType: ebs + SecurityGroups: + - SecurityGroupId: sg-12345678 + SecurityGroupName: security-group-example + State: running + StateReason: '' + SubnetId: subnet-12345678 + Tags: + - Key: env + Value: prod + UserData: '' + VmId: i-12345678 + VmInitiatedShutdownBehavior: stop + VmType: tinav5.c1r1p2 + schema: + "$ref": "#/components/schemas/ReadVmsResponse" description: The HTTP 200 response (OK). '400': content: @@ -21777,33 +21907,33 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadVmsHealthRequest" examples: ex1: value: - LoadBalancerName: example-lbu BackendVmIds: - i-12345678 - i-87654321 + LoadBalancerName: example-lbu + schema: + "$ref": "#/components/schemas/ReadVmsHealthRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadVmsHealthResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 BackendVmHealth: - - VmId: i-12345678 - State: UP - - VmId: i-87654321 - StateReason: ELB + - State: UP + VmId: i-12345678 + - Description: Instance registration is pending State: DOWN - Description: Instance registration is pending + StateReason: ELB + VmId: i-87654321 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadVmsHealthResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer @@ -21814,8 +21944,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadVmsStateRequest" examples: ex1: value: @@ -21825,35 +21953,37 @@ paths: Filters: SubregionNames: - eu-west-2a + schema: + "$ref": "#/components/schemas/ReadVmsStateRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadVmsStateResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VmStates: - - VmId: i-12345678 + - MaintenanceEvents: [] + SubregionName: eu-west-2a + VmId: i-12345678 VmState: running + - MaintenanceEvents: [] SubregionName: eu-west-2a - MaintenanceEvents: [] - - VmId: i-87654321 + 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 + VmStates: + - MaintenanceEvents: [] + SubregionName: eu-west-2a + VmId: i-12345678 + VmState: running + schema: + "$ref": "#/components/schemas/ReadVmsStateResponse" description: The HTTP 200 response (OK). '400': content: @@ -21882,8 +22012,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadVolumesRequest" examples: ex1: value: @@ -21898,32 +22026,34 @@ paths: VolumeTypes: - gp2 - io1 + schema: + "$ref": "#/components/schemas/ReadVolumesRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadVolumesResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Volumes: - - VolumeId: vol-12345678 - Tags: [] - VolumeType: gp2 - SubregionName: eu-west-2a - State: in-use - CreationDate: '2010-10-01T12:34:56.789Z' + - CreationDate: '2010-10-01T12:34:56.789Z' Iops: 100 LinkedVolumes: - - VolumeId: vol-12345678 - DeleteOnVmDeletion: false + - DeleteOnVmDeletion: false DeviceName: "/dev/sdb" State: attached VmId: i-12345678 + VolumeId: vol-12345678 Size: 10 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + State: in-use + SubregionName: eu-west-2a + Tags: [] + VolumeId: vol-12345678 + VolumeType: gp2 + schema: + "$ref": "#/components/schemas/ReadVolumesResponse" description: The HTTP 200 response (OK). '400': content: @@ -21952,8 +22082,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadVpnConnectionsRequest" examples: ex1: value: @@ -21968,32 +22096,34 @@ paths: VirtualGatewayIds: - vgw-12345678 - vgw-87654321 + schema: + "$ref": "#/components/schemas/ReadVpnConnectionsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadVpnConnectionsResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VpnConnections: - - Routes: [] - Tags: [] - ClientGatewayConfiguration: "..." - StaticRoutesOnly: true - VirtualGatewayId: vgw-12345678 - ConnectionType: ipsec.1 + - ClientGatewayConfiguration: "..." ClientGatewayId: cgw-12345678 + ConnectionType: ipsec.1 + Routes: [] State: pending + StaticRoutesOnly: true + Tags: [] VgwTelemetries: - - StateDescription: IPSEC IS DOWN - AcceptedRouteCount: 0 + - AcceptedRouteCount: 0 LastStateChangeDate: '2017-05-10T12:34:56.789Z' OutsideIpAddress: 192.0.2.0 + StateDescription: IPSEC IS DOWN + VirtualGatewayId: vgw-12345678 VpnConnectionId: vpn-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadVpnConnectionsResponse" description: The HTTP 200 response (OK). tags: - VpnConnection @@ -22006,24 +22136,24 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/RebootVmsRequest" examples: ex1: value: VmIds: - i-12345678 + schema: + "$ref": "#/components/schemas/RebootVmsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/RebootVmsResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/RebootVmsResponse" description: The HTTP 200 response (OK). '400': content: @@ -22057,26 +22187,26 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/RegisterVmsInLoadBalancerRequest" examples: ex1: value: - LoadBalancerName: example-lbu BackendVmIds: - i-12345678 - i-87654321 + LoadBalancerName: example-lbu + schema: + "$ref": "#/components/schemas/RegisterVmsInLoadBalancerRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/RegisterVmsInLoadBalancerResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/RegisterVmsInLoadBalancerResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer @@ -22089,23 +22219,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/RejectNetPeeringRequest" examples: ex1: value: NetPeeringId: pcx-12345678 + schema: + "$ref": "#/components/schemas/RejectNetPeeringRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/RejectNetPeeringResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/RejectNetPeeringResponse" description: The HTTP 200 response (OK). '400': content: @@ -22140,8 +22270,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/RemoveUserFromUserGroupRequest" examples: ex1: value: @@ -22149,17 +22277,19 @@ paths: UserGroupPath: "/example/" UserName: example-user UserPath: "/example/" + schema: + "$ref": "#/components/schemas/RemoveUserFromUserGroupRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/RemoveUserFromUserGroupResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/RemoveUserFromUserGroupResponse" description: The HTTP 200 response (OK). tags: - UserGroup @@ -22175,25 +22305,25 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ScaleDownVmGroupRequest" examples: ex1: summary: Removing 1 VM from a VM group value: VmGroupId: vmgroup-12345678901234567890123456789012 VmSubtraction: 1 + schema: + "$ref": "#/components/schemas/ScaleDownVmGroupRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ScaleDownVmGroupResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ScaleDownVmGroupResponse" description: The HTTP 200 response (OK). '400': content: @@ -22227,25 +22357,25 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ScaleUpVmGroupRequest" examples: ex1: summary: Adding 2 VMs in a VM group value: - VmGroupId: vmgroup-12345678901234567890123456789012 VmAddition: 2 + VmGroupId: vmgroup-12345678901234567890123456789012 + schema: + "$ref": "#/components/schemas/ScaleUpVmGroupRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ScaleUpVmGroupResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ScaleUpVmGroupResponse" description: The HTTP 200 response (OK). '400': content: @@ -22276,24 +22406,24 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/SetDefaultPolicyVersionRequest" examples: ex1: value: PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy VersionId: v1 + schema: + "$ref": "#/components/schemas/SetDefaultPolicyVersionRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/SetDefaultPolicyVersionResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/SetDefaultPolicyVersionResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -22306,28 +22436,28 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/StartVmsRequest" examples: ex1: value: VmIds: - i-12345678 + schema: + "$ref": "#/components/schemas/StartVmsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/StartVmsResponse" examples: ex1: value: - Vms: - - VmId: i-12345678 - PreviousState: stopped - CurrentState: pending ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Vms: + - CurrentState: pending + PreviousState: stopped + VmId: i-12345678 + schema: + "$ref": "#/components/schemas/StartVmsResponse" description: The HTTP 200 response (OK). '400': content: @@ -22358,28 +22488,28 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/StopVmsRequest" examples: ex1: value: VmIds: - i-12345678 + schema: + "$ref": "#/components/schemas/StopVmsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/StopVmsResponse" examples: ex1: value: - Vms: - - VmId: i-12345678 - PreviousState: running - CurrentState: stopping ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Vms: + - CurrentState: stopping + PreviousState: running + VmId: i-12345678 + schema: + "$ref": "#/components/schemas/StopVmsResponse" description: The HTTP 200 response (OK). '400': content: @@ -22410,23 +22540,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkFlexibleGpuRequest" examples: ex1: value: FlexibleGpuId: fgpu-12345678 + schema: + "$ref": "#/components/schemas/UnlinkFlexibleGpuRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkFlexibleGpuResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UnlinkFlexibleGpuResponse" description: The HTTP 200 response (OK). tags: - FlexibleGpu @@ -22438,25 +22568,25 @@ paths: operationId: UnlinkInternetService requestBody: content: - application/json: - schema: - "$ref": "#/components/schemas/UnlinkInternetServiceRequest" + application/json: examples: ex1: value: InternetServiceId: igw-12345678 NetId: vpc-12345678 + schema: + "$ref": "#/components/schemas/UnlinkInternetServiceRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkInternetServiceResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UnlinkInternetServiceResponse" description: The HTTP 200 response (OK). '400': content: @@ -22486,29 +22616,27 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkLoadBalancerBackendMachinesRequest" examples: ex1: summary: Unlinking VMs from a load balancer value: - LoadBalancerName: example-lbu BackendVmIds: - i-12345678 - i-87654321 + LoadBalancerName: example-lbu ex2: summary: Unlinking public IPs from a load balancer value: - LoadBalancerName: example-lbu BackendIps: - 192.0.2.0 - 198.51.100.0 + LoadBalancerName: example-lbu + schema: + "$ref": "#/components/schemas/UnlinkLoadBalancerBackendMachinesRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkLoadBalancerBackendMachinesResponse" examples: ex1: summary: Unlinking VMs from a load balancer @@ -22520,6 +22648,8 @@ paths: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UnlinkLoadBalancerBackendMachinesResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer @@ -22530,24 +22660,24 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkManagedPolicyFromUserGroupRequest" examples: ex1: value: PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy UserGroupName: example-usergroup + schema: + "$ref": "#/components/schemas/UnlinkManagedPolicyFromUserGroupRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkManagedPolicyFromUserGroupResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UnlinkManagedPolicyFromUserGroupResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -22560,23 +22690,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkNicRequest" examples: ex1: value: LinkNicId: eni-attach-12345678 + schema: + "$ref": "#/components/schemas/UnlinkNicRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkNicResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UnlinkNicResponse" description: The HTTP 200 response (OK). '400': content: @@ -22605,24 +22735,24 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkPolicyRequest" examples: ex1: value: PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy UserName: example-user + schema: + "$ref": "#/components/schemas/UnlinkPolicyRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkPolicyResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UnlinkPolicyResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -22634,8 +22764,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkPrivateIpsRequest" examples: ex1: value: @@ -22643,17 +22771,19 @@ paths: PrivateIps: - 10.0.0.6 - 10.0.0.7 + schema: + "$ref": "#/components/schemas/UnlinkPrivateIpsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkPrivateIpsResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UnlinkPrivateIpsResponse" description: The HTTP 200 response (OK). '400': content: @@ -22686,23 +22816,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkPublicIpRequest" examples: ex1: value: PublicIp: 192.0.2.0 + schema: + "$ref": "#/components/schemas/UnlinkPublicIpRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkPublicIpResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UnlinkPublicIpResponse" description: The HTTP 200 response (OK). '400': content: @@ -22733,23 +22863,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkRouteTableRequest" examples: ex1: value: LinkRouteTableId: rtbassoc-12345678 + schema: + "$ref": "#/components/schemas/UnlinkRouteTableRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkRouteTableResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UnlinkRouteTableResponse" description: The HTTP 200 response (OK). '400': content: @@ -22780,24 +22910,24 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkVirtualGatewayRequest" examples: ex1: value: - VirtualGatewayId: vgw-12345678 NetId: vpc-12345678 + VirtualGatewayId: vgw-12345678 + schema: + "$ref": "#/components/schemas/UnlinkVirtualGatewayRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkVirtualGatewayResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UnlinkVirtualGatewayResponse" description: The HTTP 200 response (OK). tags: - VirtualGateway @@ -22810,23 +22940,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkVolumeRequest" examples: ex1: value: VolumeId: vol-12345678 + schema: + "$ref": "#/components/schemas/UnlinkVolumeRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkVolumeResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UnlinkVolumeResponse" description: The HTTP 200 response (OK). '400': content: @@ -22857,15 +22987,13 @@ paths: requestBody: content: 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' + State: ACTIVE ex2: summary: Updating the state of one of your own access keys (if you are the root account or an EIM user) @@ -22878,36 +23006,38 @@ paths: AccessKeyId: ABCDEFGHIJ0123456789 State: ACTIVE UserName: example-user + schema: + "$ref": "#/components/schemas/UpdateAccessKeyRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateAccessKeyResponse" examples: ex1: summary: Updating an access key when using the parameter ExpirationDate value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 AccessKey: - State: ACTIVE AccessKeyId: ABCDEFGHIJ0123456789 CreationDate: 2010-10-01 12:34:56.789000000 +00:00 ExpirationDate: 2063-04-05 00:00:00.000000000 +00:00 LastModificationDate: 2017-05-10 12:34:56.789000000 +00:00 + State: ACTIVE Tag: Group1 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Updating an access key when not using the parameter ExpirationDate value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 AccessKey: - State: ACTIVE AccessKeyId: ABCDEFGHIJ0123456789 CreationDate: 2010-10-01 12:34:56.789000000 +00:00 LastModificationDate: 2017-05-10 12:34:56.789000000 +00:00 + State: ACTIVE Tag: Group1 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UpdateAccessKeyResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -22921,38 +23051,38 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateAccountRequest" examples: ex1: value: AdditionalEmails: - another@example.com - yet.another@example.com + schema: + "$ref": "#/components/schemas/UpdateAccountRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateAccountResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Account: - ZipCode: '92210' - CompanyName: EXAMPLE SAS - FirstName: JEAN + AccountId: '123456789012' AdditionalEmails: - another@example.com - yet.another@example.com City: SAINT-CLOUD + CompanyName: EXAMPLE SAS Country: FRANCE - LastName: DUPONT - AccountId: '123456789012' CustomerId: '87654321' Email: example@example.com + FirstName: JEAN + LastName: DUPONT + ZipCode: '92210' + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UpdateAccountResponse" description: The HTTP 200 response (OK). tags: - Account @@ -22967,8 +23097,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateApiAccessPolicyRequest" examples: ex1: summary: Require expiration dates of maximum 1 year @@ -22987,39 +23115,41 @@ paths: value: MaxAccessKeyExpirationSeconds: 0 RequireTrustedEnv: false + schema: + "$ref": "#/components/schemas/UpdateApiAccessPolicyRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateApiAccessPolicyResponse" examples: ex1: summary: Require expiration dates of maximum 1 year value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ApiAccessPolicy: - RequireTrustedEnv: false MaxAccessKeyExpirationSeconds: 31536000 + RequireTrustedEnv: false + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 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 + RequireTrustedEnv: true + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 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 + RequireTrustedEnv: false + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UpdateApiAccessPolicyResponse" description: The HTTP 200 response (OK). '400': content: @@ -23056,33 +23186,33 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateApiAccessRuleRequest" examples: ex1: value: ApiAccessRuleId: aar-1234567890abcdef1234567890abcdef + Description: Allows all Ipv4 domain IpRanges: - 0.0.0.0/0 - Description: Allows all Ipv4 domain + schema: + "$ref": "#/components/schemas/UpdateApiAccessRuleRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateApiAccessRuleResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ApiAccessRule: - IpRanges: - - 0.0.0.0/0 ApiAccessRuleId: aar-1234567890abcdef1234567890abcdef CaIds: [] Cns: [] Description: Allows all IPv4 domain + IpRanges: + - 0.0.0.0/0 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UpdateApiAccessRuleResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -23097,28 +23227,28 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateCaRequest" examples: ex1: value: CaId: ca-fedcba0987654321fedcba0987654321 Description: New description + schema: + "$ref": "#/components/schemas/UpdateCaRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateCaResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Ca: - Description: New description - CaId: ca-fedcba0987654321fedcba0987654321 CaFingerprint: 1234567890abcdef1234567890abcdef12345678 + CaId: ca-fedcba0987654321fedcba0987654321 + Description: New description + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UpdateCaResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -23136,34 +23266,34 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateDedicatedGroupRequest" examples: ex1: value: DedicatedGroupId: ded-12345678 Name: New-dedicated-group-name + schema: + "$ref": "#/components/schemas/UpdateDedicatedGroupRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateDedicatedGroupResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 DedicatedGroup: - VmIds: - - i-12345678 - NetIds: - - vpc-12345678 AccountId: '123456789012' CpuGeneration: 4 + DedicatedGroupId: ded-12345678 Name: New-dedicated-group-name + NetIds: + - vpc-12345678 SubregionName: eu-west-2a - DedicatedGroupId: ded-12345678 + VmIds: + - i-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UpdateDedicatedGroupResponse" description: The HTTP 200 response (OK). '400': content: @@ -23192,38 +23322,38 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateDirectLinkInterfaceRequest" examples: ex1: value: DirectLinkInterfaceId: dxvif-12345678 Mtu: 1500 + schema: + "$ref": "#/components/schemas/UpdateDirectLinkInterfaceRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateDirectLinkInterfaceResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 DirectLinkInterface: - Vlan: 101 - OutscalePrivateIp: 172.16.0.4/30 - DirectLinkInterfaceId: dxvif-12345678 - BgpAsn: 65000 AccountId: '123456789012' + BgpAsn: 65000 ClientPrivateIp: 172.16.0.5/30 - VirtualGatewayId: vgw-12345678 - DirectLinkInterfaceName: MyDirectLinkInterface DirectLinkId: dxcon-12345678 - Mtu: 1500 - State: available + DirectLinkInterfaceId: dxvif-12345678 + DirectLinkInterfaceName: MyDirectLinkInterface InterfaceType: private Location: PAR1 + Mtu: 1500 + OutscalePrivateIp: 172.16.0.4/30 + State: available + VirtualGatewayId: vgw-12345678 + Vlan: 101 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UpdateDirectLinkInterfaceResponse" description: The HTTP 200 response (OK). tags: - DirectLinkInterface @@ -23234,24 +23364,20 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateFlexibleGpuRequest" examples: ex1: value: - FlexibleGpuId: fgpu-12345678 DeleteOnVmDeletion: false + FlexibleGpuId: fgpu-12345678 + schema: + "$ref": "#/components/schemas/UpdateFlexibleGpuRequest" 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 @@ -23259,6 +23385,10 @@ paths: ModelName: nvidia-p100 State: allocated SubregionName: eu-west-2a + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UpdateFlexibleGpuResponse" description: The HTTP 200 response (OK). tags: - FlexibleGpu @@ -23271,9 +23401,7 @@ paths: operationId: UpdateImage requestBody: content: - application/json: - schema: - "$ref": "#/components/schemas/UpdateImageRequest" + application/json: examples: ex1: summary: Adding permission @@ -23301,143 +23429,145 @@ paths: ex4: summary: Making an image private to everyone value: - ImageId: ami-12345678 Description: Private image + ImageId: ami-12345678 PermissionsToLaunch: Removals: GlobalPermission: true + schema: + "$ref": "#/components/schemas/UpdateImageRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateImageResponse" examples: ex1: summary: Adding permission value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Image: - StateComment: {} - State: available - RootDeviceType: bsu - RootDeviceName: "/dev/sda1" - ProductCodes: - - '0001' - PermissionsToLaunch: - GlobalPermission: false - AccountIds: - - '987654321098' AccountId: '123456789012' - Tags: [] - Description: '' - ImageId: ami-12345678 + Architecture: x86_64 BlockDeviceMappings: - - DeviceName: "/dev/sda1" - Bsu: - VolumeType: standard + - Bsu: DeleteOnVmDeletion: true - VolumeSize: 50 SnapshotId: snap-12345678 - ImageType: machine + VolumeSize: 50 + VolumeType: standard + DeviceName: "/dev/sda1" CreationDate: '2010-10-01T12:34:56.789Z' + Description: '' FileLocation: 123456789012/image-example - Architecture: x86_64 + ImageId: ami-12345678 ImageName: image-example + ImageType: machine + PermissionsToLaunch: + AccountIds: + - '987654321098' + GlobalPermission: false + ProductCodes: + - '0001' + RootDeviceName: "/dev/sda1" + RootDeviceType: bsu + State: available + StateComment: {} + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Removing permission value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Image: - StateComment: {} - State: available - RootDeviceType: bsu - RootDeviceName: "/dev/sda1" - ProductCodes: - - '0001' - PermissionsToLaunch: - GlobalPermission: false - AccountIds: [] AccountId: '123456789012' - Tags: [] - Description: '' - ImageId: ami-12345678 + Architecture: x86_64 BlockDeviceMappings: - - DeviceName: "/dev/sda1" - Bsu: - VolumeType: standard + - Bsu: DeleteOnVmDeletion: true - VolumeSize: 50 SnapshotId: snap-12345678 - ImageType: machine + VolumeSize: 50 + VolumeType: standard + DeviceName: "/dev/sda1" CreationDate: '2010-10-01T12:34:56.789Z' + Description: '' FileLocation: 123456789012/image-example - Architecture: x86_64 + ImageId: ami-12345678 ImageName: image-example + ImageType: machine + PermissionsToLaunch: + AccountIds: [] + GlobalPermission: false + ProductCodes: + - '0001' + RootDeviceName: "/dev/sda1" + RootDeviceType: bsu + State: available + StateComment: {} + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex3: summary: Making an image public to everyone value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Image: - StateComment: {} - State: available - RootDeviceType: bsu - RootDeviceName: "/dev/sda1" - ProductCodes: - - '0001' - PermissionsToLaunch: - GlobalPermission: true - AccountIds: [] AccountId: '123456789012' - Tags: [] - Description: '' - ImageId: ami-12345678 + Architecture: x86_64 BlockDeviceMappings: - - DeviceName: "/dev/sda1" - Bsu: - VolumeType: standard + - Bsu: DeleteOnVmDeletion: true - VolumeSize: 50 SnapshotId: snap-12345678 - ImageType: machine + VolumeSize: 50 + VolumeType: standard + DeviceName: "/dev/sda1" CreationDate: '2010-10-01T12:34:56.789Z' + Description: '' FileLocation: 123456789012/image-example - Architecture: x86_64 + ImageId: ami-12345678 ImageName: image-example + ImageType: machine + PermissionsToLaunch: + AccountIds: [] + GlobalPermission: true + ProductCodes: + - '0001' + RootDeviceName: "/dev/sda1" + RootDeviceType: bsu + State: available + StateComment: {} + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex4: summary: Making an image private to everyone value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Image: - StateComment: {} - State: available - RootDeviceType: bsu - RootDeviceName: "/dev/sda1" - ProductCodes: - - '0001' - PermissionsToLaunch: - GlobalPermission: false - AccountIds: [] AccountId: '123456789012' - Tags: [] - Description: Private image - ImageId: ami-12345678 + Architecture: x86_64 BlockDeviceMappings: - - DeviceName: "/dev/sda1" - Bsu: - VolumeType: standard + - Bsu: DeleteOnVmDeletion: true - VolumeSize: 50 SnapshotId: snap-12345678 - ImageType: machine + VolumeSize: 50 + VolumeType: standard + DeviceName: "/dev/sda1" CreationDate: '2010-10-01T12:34:56.789Z' + Description: Private image FileLocation: 123456789012/image-example - Architecture: x86_64 + ImageId: ami-12345678 ImageName: image-example + ImageType: machine + PermissionsToLaunch: + AccountIds: [] + GlobalPermission: false + ProductCodes: + - '0001' + RootDeviceName: "/dev/sda1" + RootDeviceType: bsu + State: available + StateComment: {} + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UpdateImageResponse" description: The HTTP 200 response (OK). '400': content: @@ -23468,33 +23598,33 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateListenerRuleRequest" examples: ex1: value: - ListenerRuleName: example-listener-rule HostPattern: "*.newhost.com" + ListenerRuleName: example-listener-rule + schema: + "$ref": "#/components/schemas/UpdateListenerRuleRequest" 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" + ListenerId: 123456 ListenerRuleId: 1234 + ListenerRuleName: example-listener-rule + Priority: 10 + VmIds: + - i-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UpdateListenerRuleResponse" description: The HTTP 200 response (OK). tags: - Listener @@ -23512,30 +23642,28 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateLoadBalancerRequest" examples: ex1: summary: Updating health checks value: - LoadBalancerName: private-lb-example HealthCheck: - HealthyThreshold: 10 CheckInterval: 30 + HealthyThreshold: 10 Path: "/index.html" Port: 8080 Protocol: HTTPS Timeout: 5 UnhealthyThreshold: 5 + LoadBalancerName: private-lb-example ex2: summary: Updating access logs value: - LoadBalancerName: private-lb-example AccessLog: - PublicationInterval: 5 IsEnabled: true OsuBucketName: BUCKET OsuBucketPrefix: PREFIX + PublicationInterval: 5 + LoadBalancerName: private-lb-example ex3: summary: Updating policies value: @@ -23549,182 +23677,184 @@ paths: LoadBalancerName: private-lb-example LoadBalancerPort: 443 ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/AnotherCertificate + schema: + "$ref": "#/components/schemas/UpdateLoadBalancerRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateLoadBalancerResponse" examples: ex1: summary: Updating health checks value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 LoadBalancer: - Tags: [] - SourceSecurityGroup: - SecurityGroupName: security-group-example - SecurityGroupAccountId: '123456789012' - SecuredCookies: false - PublicIp: 192.0.2.0 - Subnets: - - subnet-12345678 - NetId: vpc-12345678 - BackendVmIds: [] - ApplicationStickyCookiePolicies: [] - SecurityGroups: - - sg-12345678 - LoadBalancerType: internet-facing AccessLog: - PublicationInterval: 60 IsEnabled: false + PublicationInterval: 60 + ApplicationStickyCookiePolicies: [] + BackendVmIds: [] 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 + Path: "/index.html" Port: 8080 - LoadBalancerStickyCookiePolicies: [] - SubregionNames: - - eu-west-2a + Protocol: HTTPS + Timeout: 5 + UnhealthyThreshold: 5 Listeners: - - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate - BackendPort: 80 + - BackendPort: 80 BackendProtocol: HTTP LoadBalancerPort: 443 LoadBalancerProtocol: HTTPS + ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate LoadBalancerName: private-lb-example - ex2: - summary: Updating access logs - value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - LoadBalancer: - Tags: [] + LoadBalancerStickyCookiePolicies: [] + LoadBalancerType: internet-facing + NetId: vpc-12345678 + PublicIp: 192.0.2.0 + SecuredCookies: false + SecurityGroups: + - sg-12345678 SourceSecurityGroup: - SecurityGroupName: security-group-example SecurityGroupAccountId: '123456789012' - SecuredCookies: false - PublicIp: 192.0.2.0 + SecurityGroupName: security-group-example Subnets: - subnet-12345678 - NetId: vpc-12345678 - BackendVmIds: [] - ApplicationStickyCookiePolicies: [] - SecurityGroups: - - sg-12345678 - LoadBalancerType: internet-facing + SubregionNames: + - eu-west-2a + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + summary: Updating access logs + value: + LoadBalancer: AccessLog: - PublicationInterval: 5 - OsuBucketPrefix: PREFIX - OsuBucketName: BUCKET IsEnabled: true + OsuBucketName: BUCKET + OsuBucketPrefix: PREFIX + PublicationInterval: 5 + ApplicationStickyCookiePolicies: [] + BackendVmIds: [] 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 + Protocol: TCP + Timeout: 5 + UnhealthyThreshold: 2 Listeners: - - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate - BackendPort: 80 + - BackendPort: 80 BackendProtocol: HTTP LoadBalancerPort: 443 LoadBalancerProtocol: HTTPS + ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate LoadBalancerName: private-lb-example - ex3: - summary: Updating policies - value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - LoadBalancer: - Tags: [] + LoadBalancerStickyCookiePolicies: [] + LoadBalancerType: internet-facing + NetId: vpc-12345678 + PublicIp: 192.0.2.0 + SecuredCookies: false + SecurityGroups: + - sg-12345678 SourceSecurityGroup: - SecurityGroupName: security-group-example SecurityGroupAccountId: '123456789012' - SecuredCookies: false - PublicIp: 192.0.2.0 + SecurityGroupName: security-group-example Subnets: - subnet-12345678 - NetId: vpc-12345678 - BackendVmIds: [] - ApplicationStickyCookiePolicies: [] - SecurityGroups: - - sg-12345678 - LoadBalancerType: internet-facing + SubregionNames: + - eu-west-2a + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex3: + summary: Updating policies + value: + LoadBalancer: AccessLog: - PublicationInterval: 60 IsEnabled: false + PublicationInterval: 60 + ApplicationStickyCookiePolicies: [] + BackendVmIds: [] 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 + Protocol: TCP + Timeout: 5 + UnhealthyThreshold: 2 Listeners: - - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate - BackendPort: 80 + - BackendPort: 80 BackendProtocol: HTTP LoadBalancerPort: 443 LoadBalancerProtocol: HTTPS + ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate LoadBalancerName: private-lb-example - ex4: - summary: Updating SSL certificate - value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - LoadBalancer: - Tags: [] + LoadBalancerStickyCookiePolicies: + - CookieExpirationPeriod: 1 + PolicyName: example-browser-policy + LoadBalancerType: internet-facing + NetId: vpc-12345678 + PublicIp: 192.0.2.0 + SecuredCookies: false + SecurityGroups: + - sg-12345678 SourceSecurityGroup: - SecurityGroupName: security-group-example SecurityGroupAccountId: '123456789012' - SecuredCookies: false - PublicIp: 192.0.2.0 + SecurityGroupName: security-group-example Subnets: - subnet-12345678 - NetId: vpc-12345678 - BackendVmIds: [] - ApplicationStickyCookiePolicies: [] - SecurityGroups: - - sg-12345678 - LoadBalancerType: internet-facing + SubregionNames: + - eu-west-2a + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex4: + summary: Updating SSL certificate + value: + LoadBalancer: AccessLog: - PublicationInterval: 60 IsEnabled: false + PublicationInterval: 60 + ApplicationStickyCookiePolicies: [] + BackendVmIds: [] 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 + Protocol: TCP + Timeout: 5 + UnhealthyThreshold: 2 Listeners: - - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/AnotherCertificate - BackendPort: 80 + - BackendPort: 80 BackendProtocol: HTTP LoadBalancerPort: 443 LoadBalancerProtocol: HTTPS + ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/AnotherCertificate LoadBalancerName: private-lb-example + LoadBalancerStickyCookiePolicies: [] + LoadBalancerType: internet-facing + NetId: vpc-12345678 + PublicIp: 192.0.2.0 + SecuredCookies: false + SecurityGroups: + - sg-12345678 + SourceSecurityGroup: + SecurityGroupAccountId: '123456789012' + SecurityGroupName: security-group-example + Subnets: + - subnet-12345678 + SubregionNames: + - eu-west-2a + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UpdateLoadBalancerResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer @@ -23735,31 +23865,31 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateNetRequest" examples: ex1: value: - NetId: vpc-12345678 DhcpOptionsSetId: dopt-12345678 + NetId: vpc-12345678 + schema: + "$ref": "#/components/schemas/UpdateNetRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateNetResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Net: - Tags: [] DhcpOptionsSetId: dopt-12345678 IpRange: 10.0.0.0/16 - Tenancy: default NetId: vpc-12345678 State: available + Tags: [] + Tenancy: default + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UpdateNetResponse" description: The HTTP 200 response (OK). '400': content: @@ -23790,54 +23920,54 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateNetAccessPointRequest" examples: ex1: summary: Adding a route table value: - NetAccessPointId: vpce-12345678 AddRouteTableIds: - rtb-87654321 + NetAccessPointId: vpce-12345678 ex2: summary: Removing a route table value: NetAccessPointId: vpce-12345678 RemoveRouteTableIds: - rtb-12345678 + schema: + "$ref": "#/components/schemas/UpdateNetAccessPointRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateNetAccessPointResponse" examples: ex1: summary: Adding a route table value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 NetAccessPoint: - Tags: [] NetAccessPointId: vpce-12345678 + NetId: vpc-12345678 RouteTableIds: - rtb-12345678 - rtb-87654321 - State: available - NetId: vpc-12345678 ServiceName: com.outscale.eu-west-2.oos + State: available + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 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 + RouteTableIds: [] ServiceName: com.outscale.eu-west-2.oos + State: available + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UpdateNetAccessPointResponse" description: The HTTP 200 response (OK). tags: - NetAccessPoint @@ -23849,16 +23979,14 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateNicRequest" examples: ex1: summary: Modifying the DeleteOnVmDeletion value of a NIC value: - NicId: eni-12345678 LinkNic: DeleteOnVmDeletion: false LinkNicId: eni-attach-12345678 + NicId: eni-12345678 ex2: summary: Modifying the security groups of a NIC value: @@ -23868,108 +23996,110 @@ paths: ex3: summary: Modifying the description of a NIC value: - NicId: eni-12345678 Description: Example of description + NicId: eni-12345678 + schema: + "$ref": "#/components/schemas/UpdateNicRequest" 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 + AccountId: '123456789012' + Description: Primary network interface + IsSourceDestChecked: true LinkNic: - VmId: i-12345678 - LinkNicId: eni-attach-12345678 - VmAccountId: '123456789012' DeleteOnVmDeletion: false DeviceNumber: 0 + LinkNicId: eni-attach-12345678 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 + VmAccountId: '123456789012' + VmId: i-12345678 MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - IsPrimary: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - IsPrimary: true + SecurityGroups: + - SecurityGroupId: sg-12345678 + SecurityGroupName: default + State: in-use + SubnetId: subnet-12345678 + SubregionName: eu-west-2a + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 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 + AccountId: '123456789012' + Description: Primary network interface + IsSourceDestChecked: true LinkNic: - VmId: i-12345678 - LinkNicId: eni-attach-12345678 - VmAccountId: '123456789012' DeleteOnVmDeletion: true DeviceNumber: 0 + LinkNicId: eni-attach-12345678 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 + VmAccountId: '123456789012' + VmId: i-12345678 MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - IsPrimary: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - IsPrimary: true + SecurityGroups: + - SecurityGroupId: sg-12345678 + SecurityGroupName: security-group-example + State: in-use + SubnetId: subnet-12345678 + SubregionName: eu-west-2a + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 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 + AccountId: '123456789012' + Description: Example of description + IsSourceDestChecked: true LinkNic: - VmId: i-12345678 - LinkNicId: eni-attach-12345678 - VmAccountId: '123456789012' DeleteOnVmDeletion: true DeviceNumber: 0 + LinkNicId: eni-attach-12345678 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 + VmAccountId: '123456789012' + VmId: i-12345678 MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - IsPrimary: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - IsPrimary: true + SecurityGroups: + - SecurityGroupId: sg-12345678 + SecurityGroupName: default + State: in-use + SubnetId: subnet-12345678 + SubregionName: eu-west-2a + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UpdateNicResponse" description: The HTTP 200 response (OK). '400': content: @@ -24009,45 +24139,45 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateRouteRequest" examples: ex1: summary: Updating a route to a virtual gateway value: - RouteTableId: rtb-12345678 DestinationIpRange: 198.51.100.0/24 GatewayId: vgw-12345678 + RouteTableId: rtb-12345678 + schema: + "$ref": "#/components/schemas/UpdateRouteRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateRouteResponse" examples: ex1: summary: Updating a route to a virtual gateway value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 RouteTable: - Routes: - - DestinationIpRange: 10.0.0.0/16 - CreationMethod: CreateRouteTable - State: active - - GatewayId: vgw-12345678 - DestinationIpRange: 198.51.100.0/24 - CreationMethod: CreateRoute - State: active LinkRouteTables: - - RouteTableId: rtb-12345678 + - LinkRouteTableId: rtbassoc-12345678 Main: false + RouteTableId: rtb-12345678 SubnetId: subnet-12345678 - LinkRouteTableId: rtbassoc-12345678 NetId: vpc-12345678 - Tags: [] RoutePropagatingVirtualGateways: [] RouteTableId: rtb-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Routes: + - CreationMethod: CreateRouteTable + DestinationIpRange: 10.0.0.0/16 + State: active + - CreationMethod: CreateRoute + DestinationIpRange: 198.51.100.0/24 + GatewayId: vgw-12345678 + State: active + Tags: [] + schema: + "$ref": "#/components/schemas/UpdateRouteResponse" description: The HTTP 200 response (OK). '400': content: @@ -24077,39 +24207,39 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateRoutePropagationRequest" examples: ex1: value: - VirtualGatewayId: vgw-12345678 - RouteTableId: rtb-12345678 Enable: true + RouteTableId: rtb-12345678 + VirtualGatewayId: vgw-12345678 + schema: + "$ref": "#/components/schemas/UpdateRoutePropagationRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateRoutePropagationResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 RouteTable: - Routes: - - DestinationIpRange: 10.0.0.0/16 - CreationMethod: CreateRouteTable - State: active LinkRouteTables: - - RouteTableId: rtb-12345678 + - LinkRouteTableId: rtbassoc-12345678 Main: true - LinkRouteTableId: rtbassoc-12345678 + RouteTableId: rtb-12345678 NetId: vpc-12345678 - Tags: [] RoutePropagatingVirtualGateways: - VirtualGatewayId: vgw-12345678 RouteTableId: rtb-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Routes: + - CreationMethod: CreateRouteTable + DestinationIpRange: 10.0.0.0/16 + State: active + Tags: [] + schema: + "$ref": "#/components/schemas/UpdateRoutePropagationResponse" description: The HTTP 200 response (OK). tags: - VirtualGateway @@ -24122,25 +24252,25 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateRouteTableLinkRequest" examples: ex1: value: LinkRouteTableId: rtbassoc-12345678 RouteTableId: rtb-12345678 + schema: + "$ref": "#/components/schemas/UpdateRouteTableLinkRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateRouteTableLinkResponse" examples: ex1: value: + LinkRouteTableId: rtbassoc-12345678 ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - LinkRouteTableId: rtbassoc-12345678 + schema: + "$ref": "#/components/schemas/UpdateRouteTableLinkResponse" description: The HTTP 200 response (OK). '400': content: @@ -24169,28 +24299,28 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateServerCertificateRequest" examples: ex1: value: Name: server-cert-example NewName: new-name + schema: + "$ref": "#/components/schemas/UpdateServerCertificateRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateServerCertificateResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ServerCertificate: - Path: "/example/" Id: ABCDEFGHIJKLMNOPQRSTUVWXYZ1234 Name: new-name - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Path: "/example/" + schema: + "$ref": "#/components/schemas/UpdateServerCertificateResponse" description: The HTTP 200 response (OK). tags: - ServerCertificate @@ -24204,119 +24334,119 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateSnapshotRequest" examples: ex1: summary: Adding permission value: - SnapshotId: snap-12345678 PermissionsToCreateVolume: Additions: AccountIds: - '987654321098' + SnapshotId: snap-12345678 ex2: summary: Removing permission value: - SnapshotId: snap-12345678 PermissionsToCreateVolume: Removals: AccountIds: - '987654321098' + SnapshotId: snap-12345678 ex3: summary: Making an image public to everyone value: - SnapshotId: snap-12345678 PermissionsToCreateVolume: Additions: GlobalPermission: true + SnapshotId: snap-12345678 ex4: summary: Making an image private to everyone value: - SnapshotId: snap-12345678 PermissionsToCreateVolume: Removals: GlobalPermission: true + SnapshotId: snap-12345678 + schema: + "$ref": "#/components/schemas/UpdateSnapshotRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateSnapshotResponse" examples: ex1: summary: Adding permission value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Snapshot: - VolumeSize: 10 AccountId: '123456789012' - VolumeId: vol-12345678 CreationDate: '2010-10-01T12:34:56.789Z' + Description: Snapshot created from a volume PermissionsToCreateVolume: - GlobalPermission: false AccountIds: - '987654321098' + GlobalPermission: false Progress: 100 SnapshotId: snap-12345678 State: completed - Description: Snapshot created from a volume Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + VolumeId: vol-12345678 + VolumeSize: 10 ex2: summary: Removing permission value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Snapshot: - VolumeSize: 10 AccountId: '123456789012' - VolumeId: vol-12345678 CreationDate: '2010-10-01T12:34:56.789Z' + Description: Snapshot created from a volume PermissionsToCreateVolume: - GlobalPermission: false AccountIds: [] + GlobalPermission: false Progress: 100 SnapshotId: snap-12345678 State: completed - Description: Snapshot created from a volume Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + VolumeId: vol-12345678 + VolumeSize: 10 ex3: summary: Making an image public to everyone value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Snapshot: - VolumeSize: 10 AccountId: '123456789012' - VolumeId: vol-12345678 CreationDate: '2010-10-01T12:34:56.789Z' + Description: Snapshot created from a volume PermissionsToCreateVolume: - GlobalPermission: true AccountIds: [] + GlobalPermission: true Progress: 100 SnapshotId: snap-12345678 State: completed - Description: Snapshot created from a volume Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + VolumeId: vol-12345678 + VolumeSize: 10 ex4: summary: Making an image private to everyone value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Snapshot: - VolumeSize: 10 AccountId: '123456789012' - VolumeId: vol-12345678 CreationDate: '2010-10-01T12:34:56.789Z' + Description: Snapshot created from a volume PermissionsToCreateVolume: - GlobalPermission: false AccountIds: [] + GlobalPermission: false Progress: 100 SnapshotId: snap-12345678 State: completed - Description: Snapshot created from a volume Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + VolumeId: vol-12345678 + VolumeSize: 10 + schema: + "$ref": "#/components/schemas/UpdateSnapshotResponse" description: The HTTP 200 response (OK). '400': content: @@ -24345,33 +24475,33 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateSubnetRequest" examples: ex1: value: - SubnetId: subnet-12345678 MapPublicIpOnLaunch: true + SubnetId: subnet-12345678 + schema: + "$ref": "#/components/schemas/UpdateSubnetRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateSubnetResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Subnet: - Tags: [] - SubregionName: eu-west-2a - SubnetId: subnet-12345678 AvailableIpsCount: 16379 IpRange: 10.0.0.0/18 MapPublicIpOnLaunch: true - State: available NetId: vpc-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + State: available + SubnetId: subnet-12345678 + SubregionName: eu-west-2a + Tags: [] + schema: + "$ref": "#/components/schemas/UpdateSubnetResponse" description: The HTTP 200 response (OK). '400': content: @@ -24400,33 +24530,33 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateUserRequest" examples: ex1: value: - UserName: example-user + NewPath: "/product/" NewUserEmail: user@example.com NewUserName: test-user - NewPath: "/product/" + UserName: example-user + schema: + "$ref": "#/components/schemas/UpdateUserRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateUserResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 User: CreationDate: 2010-10-01 12:34:56.789000000 +00:00 LastModificationDate: 2017-05-10 12:34:56.789000000 +00:00 + Path: "/product/" UserEmail: user@example.com - UserName: test-user UserId: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 - Path: "/product/" - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + UserName: test-user + schema: + "$ref": "#/components/schemas/UpdateUserResponse" description: The HTTP 200 response (OK). tags: - User @@ -24437,8 +24567,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateUserGroupRequest" examples: ex1: value: @@ -24446,12 +24574,12 @@ paths: NewUserGroupName: new-usergroup Path: "/example/" UserGroupName: example-usergroup + schema: + "$ref": "#/components/schemas/UpdateUserGroupRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateUserGroupResponse" examples: ex1: value: @@ -24471,6 +24599,8 @@ paths: UserEmail: user@example.com UserId: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 UserName: example-user + schema: + "$ref": "#/components/schemas/UpdateUserGroupResponse" description: The HTTP 200 response (OK). tags: - UserGroup @@ -24482,13 +24612,13 @@ paths: * `Performance`
* `UserData`
* `VmType` + + To complete the update of secure boot, you need to do a stop/start of the VM. A simple restart is not sufficient, as the update is done when the VM goes through the stopped state. For the difference between stop/start and restart, see [About VM Lifecycle](https://docs.outscale.com/en/userguide/About-VM-Lifecycle.html). post: operationId: UpdateVm requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateVmRequest" examples: ex1: value: @@ -24496,153 +24626,159 @@ paths: VmType: tinav5.c2r2p2 ex2: value: - VmId: i-12345678 UserData: "..." + VmId: i-12345678 + schema: + "$ref": "#/components/schemas/UpdateVmRequest" 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 + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Vm: + ActionsOnNextBoot: + SecureBoot: none + Architecture: x86_64 + BlockDeviceMappings: + - Bsu: + DeleteOnVmDeletion: true + LinkDate: '2010-10-01T12:34:56.789Z' + State: attached + VolumeId: vol-12345678 + DeviceName: "/dev/sda1" BsuOptimized: false + CreationDate: '2010-10-01T12:34:56.789Z' + DeletionProtection: false + Hypervisor: xen + ImageId: ami-12345678 + IsSourceDestChecked: true + KeypairName: keypair-example LaunchNumber: 0 + NestedVirtualization: false NetId: vpc-12345678 Nics: - - SubnetId: subnet-12345678 - State: in-use + - AccountId: '123456789012' + Description: Primary network interface + IsSourceDestChecked: true LinkNic: - State: attached + DeleteOnVmDeletion: true 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 + State: attached MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - IsPrimary: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - IsPrimary: true + SecurityGroups: + - SecurityGroupId: sg-12345678 + SecurityGroupName: security-group-example + State: in-use + SubnetId: subnet-12345678 Performance: high - Tags: - - Value: prod - Key: env + Placement: + SubregionName: eu-west-2a + Tenancy: default PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + PrivateIp: 10.0.0.4 + ProductCodes: + - '0001' + ReservationId: r-12345678 + RootDeviceName: "/dev/sda1" + RootDeviceType: ebs + SecurityGroups: + - SecurityGroupId: sg-12345678 + SecurityGroupName: security-group-example + State: stopped + StateReason: '' + SubnetId: subnet-12345678 + Tags: + - Key: env + Value: prod + UserData: '' + VmId: i-12345678 + VmInitiatedShutdownBehavior: stop + VmType: tinav5.c2r2p2 ex2: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Vm: - VmType: tinav5.c1r1p2 - VmInitiatedShutdownBehavior: stop - State: stopped - StateReason: '' - RootDeviceType: ebs - RootDeviceName: "/dev/sda1" - IsSourceDestChecked: true - KeypairName: keypair-example - ImageId: ami-12345678 - DeletionProtection: true + ActionsOnNextBoot: + SecureBoot: none Architecture: x86_64 - NestedVirtualization: false BlockDeviceMappings: - - DeviceName: "/dev/sda1" - Bsu: - VolumeId: vol-12345678 - State: attached - LinkDate: '2010-10-01T12:34:56.789Z' + - Bsu: 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 + LinkDate: '2010-10-01T12:34:56.789Z' + State: attached + VolumeId: vol-12345678 + DeviceName: "/dev/sda1" BsuOptimized: false + CreationDate: '2010-10-01T12:34:56.789Z' + DeletionProtection: true + Hypervisor: xen + ImageId: ami-12345678 + IsSourceDestChecked: true + KeypairName: keypair-example LaunchNumber: 0 + NestedVirtualization: false NetId: vpc-12345678 Nics: - - SubnetId: subnet-12345678 - State: in-use + - AccountId: '123456789012' + Description: Primary network interface + IsSourceDestChecked: true LinkNic: - State: attached + DeleteOnVmDeletion: true 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 + State: attached MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - IsPrimary: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - IsPrimary: true + SecurityGroups: + - SecurityGroupId: sg-12345678 + SecurityGroupName: security-group-example + State: in-use + SubnetId: subnet-12345678 Performance: high - Tags: - - Value: prod - Key: env + Placement: + SubregionName: eu-west-2a + Tenancy: default PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + PrivateIp: 10.0.0.4 + ProductCodes: + - '0001' + ReservationId: r-12345678 + RootDeviceName: "/dev/sda1" + RootDeviceType: ebs + SecurityGroups: + - SecurityGroupId: sg-12345678 + SecurityGroupName: security-group-example + State: stopped + StateReason: '' + SubnetId: subnet-12345678 + Tags: + - Key: env + Value: prod + UserData: "..." + VmId: i-12345678 + VmInitiatedShutdownBehavior: stop + VmType: tinav5.c1r1p2 + schema: + "$ref": "#/components/schemas/UpdateVmResponse" description: The HTTP 200 response (OK). '400': content: @@ -24675,45 +24811,45 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateVmGroupRequest" examples: ex1: summary: Updating the name and description of a VM group value: + Description: New description of the VM group VmGroupId: vmgroup-12345678901234567890123456789012 VmGroupName: new-name - Description: New description of the VM group ex2: summary: Updating the VM template of a VM group value: VmGroupId: vmgroup-12345678901234567890123456789012 VmTemplateId: vmtemplate-98765432109876543210987654321012 + schema: + "$ref": "#/components/schemas/UpdateVmGroupRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateVmGroupResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VmGroup: - 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 + Description: New description of the VM group PositioningStrategy: attract + SecurityGroupIds: + - sg-12345678 State: available - VmGroupId: vmgroup-12345678901234567890123456789012 - Description: New description of the VM group + SubnetId: subnet-12345678 Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + VmCount: 2 + VmGroupId: vmgroup-12345678901234567890123456789012 + VmGroupName: new-name + VmIds: [] + VmTemplateId: vmtemplate-98765432109876543210987654321012 + schema: + "$ref": "#/components/schemas/UpdateVmGroupResponse" description: The HTTP 200 response (OK). '400': content: @@ -24746,36 +24882,36 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateVmTemplateRequest" examples: ex1: value: Description: The new description of the VM template VmTemplateId: vmtemplate-98765432109876543210987654321012 VmTemplateName: second-name + schema: + "$ref": "#/components/schemas/UpdateVmTemplateRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateVmTemplateResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VmTemplate: - VmTemplateName: second-name + CpuCores: 2 + CpuGeneration: v4 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 + Tags: [] + VmTemplateId: vmtemplate-98765432109876543210987654321012 + VmTemplateName: second-name + schema: + "$ref": "#/components/schemas/UpdateVmTemplateResponse" description: The HTTP 200 response (OK). tags: - VmTemplate @@ -24791,57 +24927,57 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateVolumeRequest" examples: ex1: summary: Updating the size of a volume value: - VolumeId: vol-12345678 Size: 50 + VolumeId: vol-12345678 ex2: summary: Updating the type of a volume to io1 value: + Iops: 200 VolumeId: vol-12345678 VolumeType: io1 - Iops: 200 + schema: + "$ref": "#/components/schemas/UpdateVolumeRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateVolumeResponse" examples: ex1: summary: Updating the size of a volume value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Volume: - VolumeId: vol-12345678 - Tags: [] - VolumeType: gp2 - SubregionName: eu-west-2a - State: available CreationDate: '2010-10-01T12:34:56.789Z' Iops: 100 LinkedVolumes: [] Size: 10 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + State: available + SubregionName: eu-west-2a + Tags: [] + VolumeId: vol-12345678 + VolumeType: gp2 ex2: summary: Updating the type of a volume to io1 value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Volume: - VolumeId: vol-12345678 - Tags: [] - VolumeType: io1 - SubregionName: eu-west-2a - State: available CreationDate: '2010-10-01T12:34:56.789Z' Iops: 200 LinkedVolumes: [] Size: 10 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + State: available + SubregionName: eu-west-2a + Tags: [] + VolumeId: vol-12345678 + VolumeType: io1 + schema: + "$ref": "#/components/schemas/UpdateVolumeResponse" description: The HTTP 200 response (OK). '400': content: @@ -24870,42 +25006,42 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateVpnConnectionRequest" examples: ex1: value: VpnConnectionId: vpn-12345678 VpnOptions: TunnelInsideIpRange: 169.254.254.22/30 + schema: + "$ref": "#/components/schemas/UpdateVpnConnectionRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateVpnConnectionResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VpnConnection: - VpnOptions: - TunnelInsideIpRange: 169.254.254.22/30 - Routes: [] - Tags: [] ClientGatewayConfiguration: "..." - StaticRoutesOnly: true - VirtualGatewayId: vgw-12345678 - ConnectionType: ipsec.1 ClientGatewayId: cgw-12345678 + ConnectionType: ipsec.1 + Routes: [] State: pending + StaticRoutesOnly: true + Tags: [] VgwTelemetries: - - StateDescription: IPSEC IS DOWN - AcceptedRouteCount: 0 + - AcceptedRouteCount: 0 LastStateChangeDate: '2017-05-10T12:34:56.789Z' OutsideIpAddress: 192.0.2.0 + StateDescription: IPSEC IS DOWN + VirtualGatewayId: vgw-12345678 VpnConnectionId: vpn-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + VpnOptions: + TunnelInsideIpRange: 169.254.254.22/30 + schema: + "$ref": "#/components/schemas/UpdateVpnConnectionResponse" description: The HTTP 200 response (OK). '400': content: diff --git a/outscale.yaml b/outscale.yaml index f09aa34..217bc37 100644 --- a/outscale.yaml +++ b/outscale.yaml @@ -171,6 +171,12 @@ components: description: The ZIP code of the city. type: string type: object + ActionsOnNextBoot: + description: The action to perform on the next boot of the VM. + properties: + SecureBoot: + "$ref": "#/components/schemas/SecureBootAction" + type: object AddUserToUserGroupRequest: additionalProperties: false properties: @@ -344,6 +350,12 @@ components: description: The name of the virtual device (`ephemeralN`). type: string type: object + BootMode: + description: Information about the boot mode of the OMI (`legacy` and/or `uefi`). + enum: + - uefi + - legacy + type: string BsuCreated: additionalProperties: false description: Information about the created BSU volume. @@ -997,6 +1009,11 @@ components: items: "$ref": "#/components/schemas/BlockDeviceMappingImage" type: array + BootModes: + description: The boot modes compatible with the OMI (`legacy` and/or `uefi`). + items: + "$ref": "#/components/schemas/BootMode" + type: array Description: description: A description for the new OMI. type: string @@ -1774,6 +1791,9 @@ components: CreateSnapshotRequest: additionalProperties: false properties: + ClientToken: + description: A unique identifier which enables you to manage the idempotency. + type: string Description: description: A description for the snapshot. type: string @@ -2069,11 +2089,15 @@ components: CreateVmsRequest: additionalProperties: false properties: + ActionsOnNextBoot: + "$ref": "#/components/schemas/ActionsOnNextBoot" BlockDeviceMappings: description: One or more block device mappings. items: "$ref": "#/components/schemas/BlockDeviceMappingVmCreation" type: array + BootMode: + "$ref": "#/components/schemas/BootMode" BootOnCreation: default: true description: By default or if true, the VM is started on creation. If false, @@ -2188,6 +2212,9 @@ components: CreateVolumeRequest: additionalProperties: false properties: + ClientToken: + description: A unique identifier which enables you to manage the idempotency. + type: string DryRun: description: If true, checks whether you have the required permissions to perform the action. @@ -3913,6 +3940,11 @@ components: items: type: string type: array + BootModes: + description: The boot modes compatible with the OMIs (`legacy` and/or `uefi`). + items: + "$ref": "#/components/schemas/BootMode" + type: array Descriptions: description: The descriptions of the OMIs, provided when they were created. items: @@ -3967,6 +3999,9 @@ components: items: type: string type: array + SecureBoot: + description: Whether secure boot is activated or not. + type: boolean States: description: The states of the OMIs (`pending` \| `available` \| `failed`). items: @@ -4804,6 +4839,11 @@ components: items: type: string type: array + ClientTokens: + description: The idempotency tokens provided when creating the snapshots. + items: + type: string + type: array Descriptions: description: The descriptions of the snapshots. items: @@ -5086,6 +5126,11 @@ components: items: type: string type: array + BootModes: + description: The boot modes of the VMs (`legacy` \| `uefi`). + items: + "$ref": "#/components/schemas/BootMode" + type: array ClientTokens: description: The idempotency tokens provided when launching the VMs. items: @@ -5094,6 +5139,7 @@ components: CreationDates: description: The dates when the VMs were launched. items: + format: date type: string type: array ImageIds: @@ -5612,6 +5658,11 @@ components: additionalProperties: false description: One or more filters. properties: + ClientTokens: + description: The idempotency tokens provided when creating the volumes. + items: + type: string + type: array CreationDates: description: The dates and times at which the volumes were created, in ISO 8601 date-time format (for example, `2020-06-30T00:00:00.000Z`). @@ -5825,6 +5876,7 @@ components: type: integer Path: description: If you use the HTTP or HTTPS protocols, the request URL path. + Always starts with a slash (`/`). type: string Port: description: The port number (between `1` and `65535`, both included). @@ -5867,6 +5919,11 @@ components: items: "$ref": "#/components/schemas/BlockDeviceMappingImage" type: array + BootModes: + description: The boot modes compatible with the OMI (`legacy` and/or `uefi`). + items: + "$ref": "#/components/schemas/BootMode" + type: array CreationDate: description: The date and time (UTC) at which the OMI was created. format: date @@ -5899,6 +5956,9 @@ components: RootDeviceType: description: The type of root device used by the OMI (always `bsu`). type: string + SecureBoot: + description: Whether secure boot is activated or not. + type: boolean State: description: The state of the OMI (`pending` \| `available` \| `failed`). type: string @@ -8688,10 +8748,24 @@ components: type: boolean Filters: "$ref": "#/components/schemas/FiltersNic" + 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 ReadNicsResponse: 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 Nics: description: Information about one or more NICs. items: @@ -9965,7 +10039,7 @@ components: description: Information about the tag. properties: Key: - description: The key of the tag, with a minimum of 1 character. + description: The key of the tag, between 1 and 128 characters. type: string required: - Key @@ -10133,6 +10207,15 @@ components: ResponseContext: "$ref": "#/components/schemas/ResponseContext" type: object + SecureBootAction: + description: One action to perform on the next boot of the VM (`enable` | `disable` + | `setup-mode` |`none`). + enum: + - enable + - disable + - setup-mode + - none + type: string SecurityGroup: additionalProperties: false description: Information about the security group. @@ -10306,6 +10389,9 @@ components: AccountId: description: The account ID of the owner of the snapshot. type: string + ClientToken: + description: The idempotency token provided when creating the snapshot. + type: string CreationDate: description: The date and time (UTC) at which the snapshot was created. format: datetime @@ -11103,6 +11189,13 @@ components: type: string PermissionsToLaunch: "$ref": "#/components/schemas/PermissionsOnResourceCreation" + ProductCodes: + description: The product codes associated with the OMI. Any previously set + value is deleted. Make sure to specify all product codes you want to associate + with the OMI. + items: + type: string + type: array required: - ImageId type: object @@ -11580,6 +11673,8 @@ components: UpdateVmRequest: additionalProperties: false properties: + ActionsOnNextBoot: + "$ref": "#/components/schemas/ActionsOnNextBoot" BlockDeviceMappings: description: One or more block device mappings of the VM. items: @@ -11851,6 +11946,8 @@ components: additionalProperties: false description: Information about the VM. properties: + ActionsOnNextBoot: + "$ref": "#/components/schemas/ActionsOnNextBoot" Architecture: description: The architecture of the VM (`i386` \| `x86_64`). type: string @@ -11859,6 +11956,8 @@ components: items: "$ref": "#/components/schemas/BlockDeviceMappingCreated" type: array + BootMode: + "$ref": "#/components/schemas/BootMode" BsuOptimized: description: This parameter is not available. It is present in our API for the sake of historical compatibility with AWS. @@ -12168,6 +12267,9 @@ components: additionalProperties: false description: Information about the volume. properties: + ClientToken: + description: The idempotency token provided when creating the volume. + type: string CreationDate: description: The date and time (UTC) at which the volume was created. format: datetime @@ -12426,10 +12528,10 @@ info: url: https://opensource.org/licenses/BSD-3-Clause termsOfService: https://en.outscale.com/terms-of-service/ title: 3DS OUTSCALE API - version: 1.34.3 - x-osc-api-osc-billing: 1.34.0 - x-osc-api-osc-cloud-vision: 1.34.0 - x-osc-api-osc-core-iaas: 1.34.4 + version: 1.35.3 + x-osc-api-osc-billing: 1.35.0 + x-osc-api-osc-cloud-vision: 1.35.0 + x-osc-api-osc-core-iaas: 1.35.3 x-osc-api-type: external openapi: 3.0.0 paths: @@ -12445,38 +12547,38 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/AcceptNetPeeringRequest" examples: ex1: value: NetPeeringId: pcx-12345678 + schema: + "$ref": "#/components/schemas/AcceptNetPeeringRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/AcceptNetPeeringResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 NetPeering: - Tags: [] - State: - Name: active - Message: Active AccepterNet: - NetId: vpc-12345678 - IpRange: 172.16.0.0/16 AccountId: '123456789012' + IpRange: 172.16.0.0/16 + NetId: vpc-12345678 ExpirationDate: '2063-04-05T00:00:00.000Z' + NetPeeringId: pcx-12345678 SourceNet: - NetId: vpc-12345678 - IpRange: 10.0.0.0/16 AccountId: '123456789012' - NetPeeringId: pcx-12345678 + IpRange: 10.0.0.0/16 + NetId: vpc-12345678 + State: + Message: Active + Name: active + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/AcceptNetPeeringResponse" description: The HTTP 200 response (OK). '400': content: @@ -12511,8 +12613,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/AddUserToUserGroupRequest" examples: ex1: value: @@ -12520,17 +12620,19 @@ paths: UserGroupPath: "/example/" UserName: example-user UserPath: "/example/" + schema: + "$ref": "#/components/schemas/AddUserToUserGroupRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/AddUserToUserGroupResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/AddUserToUserGroupResponse" description: The HTTP 200 response (OK). tags: - UserGroup @@ -12541,24 +12643,24 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CheckAuthenticationRequest" examples: ex1: value: Login: example@example.com Password: "$OSC_PASSWORD" + schema: + "$ref": "#/components/schemas/CheckAuthenticationRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CheckAuthenticationResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CheckAuthenticationResponse" description: The HTTP 200 response (OK). tags: - Account @@ -12571,33 +12673,33 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateAccessKeyRequest" examples: ex1: value: ExpirationDate: '2063-04-05' Tag: Group1 UserName: example-user + schema: + "$ref": "#/components/schemas/CreateAccessKeyRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateAccessKeyResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 AccessKey: - State: ACTIVE AccessKeyId: ABCDEFGHIJ0123456789 CreationDate: 2010-10-01 12:34:56.789000000 +00:00 ExpirationDate: 2063-04-05 00:00:00.000000000 +00:00 - SecretKey: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX LastModificationDate: 2010-10-01 12:34:56.789000000 +00:00 + SecretKey: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + State: ACTIVE Tag: Group1 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateAccessKeyResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -12618,8 +12720,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateAccountRequest" examples: ex1: value: @@ -12631,26 +12731,28 @@ paths: FirstName: JEAN LastName: DUPONT ZipCode: '92210' + schema: + "$ref": "#/components/schemas/CreateAccountRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateAccountResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Account: - ZipCode: '92210' - CompanyName: EXAMPLE SAS - FirstName: JEAN + AccountId: '123456789012' City: SAINT-CLOUD + CompanyName: EXAMPLE SAS Country: FRANCE - LastName: DUPONT - AccountId: '123456789012' Email: example@example.com + FirstName: JEAN + LastName: DUPONT + ZipCode: '92210' + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateAccountResponse" description: The HTTP 200 response (OK). tags: - Account @@ -12667,61 +12769,61 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateApiAccessRuleRequest" examples: ex1: summary: Creating an API access rule based on IPs value: + Description: Basic API Access Rule with IPs IpRanges: - 192.0.2.0 - 198.51.100.0/24 - Description: Basic API Access Rule with IPs ex2: summary: Creating an API access rule based on IPs and Certificate Authority (CA) value: - IpRanges: - - 192.0.2.0 - - 198.51.100.0/24 CaIds: - ca-fedcba0987654321fedcba0987654321 Description: API Access Rule with IPs and CA + IpRanges: + - 192.0.2.0 + - 198.51.100.0/24 + schema: + "$ref": "#/components/schemas/CreateApiAccessRuleRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateApiAccessRuleResponse" examples: ex1: summary: Creating an API access rule based on IPs value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ApiAccessRule: - IpRanges: - - 192.0.2.0 - - 198.51.100.0/24 ApiAccessRuleId: aar-fedcba0987654321fedcba0987654321 CaIds: [] Cns: [] Description: Basic API Access Rule with IPs + IpRanges: + - 192.0.2.0 + - 198.51.100.0/24 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Creating an API access rule based on IPs and Certificate Authority (CA) value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ApiAccessRule: - IpRanges: - - 192.0.2.0 - - 198.51.100.0/24 ApiAccessRuleId: aar-fedcba0987654321fedcba0987654321 CaIds: - ca-fedcba0987654321fedcba0987654321 Cns: [] Description: API Access Rule with IPs and CA + IpRanges: + - 192.0.2.0 + - 198.51.100.0/24 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateApiAccessRuleResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -12737,28 +12839,28 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateCaRequest" examples: ex1: value: CaPem: XXXX Description: CA example + schema: + "$ref": "#/components/schemas/CreateCaRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateCaResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Ca: - Description: CA example - CaId: ca-fedcba0987654321fedcba0987654321 CaFingerprint: 1234567890abcdef1234567890abcdef12345678 + CaId: ca-fedcba0987654321fedcba0987654321 + Description: CA example + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateCaResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -12776,32 +12878,32 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateClientGatewayRequest" examples: ex1: value: + BgpAsn: 65000 ConnectionType: ipsec.1 PublicIp: 192.0.2.0 - BgpAsn: 65000 + schema: + "$ref": "#/components/schemas/CreateClientGatewayRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateClientGatewayResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ClientGateway: - State: available BgpAsn: 65000 - Tags: [] ClientGatewayId: cgw-12345678 ConnectionType: ipsec.1 PublicIp: 192.0.2.0 + State: available + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateClientGatewayResponse" description: The HTTP 200 response (OK). tags: - ClientGateway @@ -12817,33 +12919,33 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateDedicatedGroupRequest" examples: ex1: value: CpuGeneration: 4 Name: dedicated-group-example SubregionName: eu-west-2a + schema: + "$ref": "#/components/schemas/CreateDedicatedGroupRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateDedicatedGroupResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 DedicatedGroup: - VmIds: [] - NetIds: [] AccountId: '123456789012' CpuGeneration: 4 + DedicatedGroupId: ded-12345678 Name: dedicated-group-example + NetIds: [] SubregionName: eu-west-2a - DedicatedGroupId: ded-12345678 + VmIds: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateDedicatedGroupResponse" description: The HTTP 200 response (OK). '400': content: @@ -12874,8 +12976,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateDhcpOptionsRequest" examples: ex1: value: @@ -12886,28 +12986,30 @@ paths: NtpServers: - 203.0.113.0 - 203.0.113.1 + schema: + "$ref": "#/components/schemas/CreateDhcpOptionsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateDhcpOptionsResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 DhcpOptionsSet: - Tags: [] - NtpServers: - - 203.0.113.0 - - 203.0.113.1 Default: false DhcpOptionsSetId: dopt-12345678 DomainName: example.com DomainNameServers: - 192.0.2.0 - 198.51.100.0 + NtpServers: + - 203.0.113.0 + - 203.0.113.1 + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateDhcpOptionsResponse" description: The HTTP 200 response (OK). tags: - DhcpOption @@ -12920,25 +13022,21 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateDirectLinkRequest" examples: ex1: value: - Location: PAR1 Bandwidth: 1Gbps DirectLinkName: Connection to Outscale + Location: PAR1 + schema: + "$ref": "#/components/schemas/CreateDirectLinkRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateDirectLinkResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 DirectLink: AccountId: '123456789012' Bandwidth: 1Gbps @@ -12947,8 +13045,12 @@ paths: Location: PAR1 RegionName: eu-west-2 State: requested - description: The HTTP 200 response (OK). - tags: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateDirectLinkResponse" + description: The HTTP 200 response (OK). + tags: - DirectLink "/CreateDirectLinkInterface": description: |- @@ -12960,45 +13062,45 @@ paths: requestBody: content: 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 + DirectLinkInterfaceName: MyDirectLinkInterface + OutscalePrivateIp: 172.16.0.4/30 VirtualGatewayId: vgw-12345678 + Vlan: 101 + schema: + "$ref": "#/components/schemas/CreateDirectLinkInterfaceRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateDirectLinkInterfaceResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 DirectLinkInterface: - Vlan: 101 - OutscalePrivateIp: 172.16.0.4/30 - DirectLinkInterfaceId: dxvif-12345678 - BgpAsn: 65000 AccountId: '123456789012' + BgpAsn: 65000 ClientPrivateIp: 172.16.0.5/30 - VirtualGatewayId: vgw-12345678 - DirectLinkInterfaceName: MyDirectLinkInterface DirectLinkId: dxcon-12345678 - Mtu: 1500 - State: pending + DirectLinkInterfaceId: dxvif-12345678 + DirectLinkInterfaceName: MyDirectLinkInterface InterfaceType: private Location: PAR1 + Mtu: 1500 + OutscalePrivateIp: 172.16.0.4/30 + State: pending + VirtualGatewayId: vgw-12345678 + Vlan: 101 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateDirectLinkInterfaceResponse" description: The HTTP 200 response (OK). tags: - DirectLinkInterface @@ -13012,33 +13114,33 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateFlexibleGpuRequest" examples: ex1: value: - ModelName: nvidia-p100 + DeleteOnVmDeletion: true Generation: v5 + ModelName: nvidia-p100 SubregionName: eu-west-2a - DeleteOnVmDeletion: true + schema: + "$ref": "#/components/schemas/CreateFlexibleGpuRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateFlexibleGpuResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 FlexibleGpu: - SubregionName: eu-west-2a DeleteOnVmDeletion: true + FlexibleGpuId: fgpu-12345678 Generation: v5 ModelName: nvidia-p100 State: allocated - FlexibleGpuId: fgpu-12345678 + SubregionName: eu-west-2a + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateFlexibleGpuResponse" description: The HTTP 200 response (OK). tags: - FlexibleGpu @@ -13060,15 +13162,13 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateImageRequest" examples: ex1: summary: Creating from a VM value: ImageName: create-image-example - VmId: i-12345678 NoReboot: true + VmId: i-12345678 ex2: summary: Copying an OMI value: @@ -13078,153 +13178,163 @@ paths: ex3: summary: Registering from a snapshot value: - ImageName: register-image-from-snapshot-example BlockDeviceMappings: - - DeviceName: "/dev/sda1" - Bsu: + - Bsu: + DeleteOnVmDeletion: true + Iops: 150 SnapshotId: snap-12345678 VolumeSize: 120 VolumeType: io1 - Iops: 150 - DeleteOnVmDeletion: true + DeviceName: "/dev/sda1" + ImageName: register-image-from-snapshot-example 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 + ImageName: register-image-from-bucket-example + schema: + "$ref": "#/components/schemas/CreateImageRequest" 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 + Architecture: x86_64 BlockDeviceMappings: - - DeviceName: "/dev/sda1" - Bsu: - VolumeType: standard + - Bsu: DeleteOnVmDeletion: true - VolumeSize: 50 SnapshotId: snap-12345678 - ImageType: machine + VolumeSize: 50 + VolumeType: standard + DeviceName: "/dev/sda1" + BootModes: + - legacy CreationDate: '2010-10-01T12:34:56.789Z' + Description: '' FileLocation: 123456789012/create-image-example - Architecture: x86_64 + ImageId: ami-12345678 ImageName: create-image-example + ImageType: machine + PermissionsToLaunch: + AccountIds: [] + GlobalPermission: false + ProductCodes: + - '0001' + RootDeviceName: "/dev/sda1" + RootDeviceType: bsu + State: pending + StateComment: {} + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Copying an OMI value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Image: - StateComment: {} - State: available - RootDeviceType: bsu - RootDeviceName: "/dev/sda1" - ProductCodes: - - '0001' - PermissionsToLaunch: - GlobalPermission: false - AccountIds: [] AccountId: '123456789012' - Tags: [] - Description: '' - ImageId: ami-12345678 + Architecture: x86_64 BlockDeviceMappings: - - DeviceName: "/dev/sda1" - Bsu: - VolumeType: standard + - Bsu: DeleteOnVmDeletion: true - VolumeSize: 50 SnapshotId: snap-12345678 - ImageType: machine + VolumeSize: 50 + VolumeType: standard + DeviceName: "/dev/sda1" + BootModes: + - legacy CreationDate: '2010-10-01T12:34:56.789Z' + Description: '' FileLocation: 123456789012/copy-image-example - Architecture: x86_64 + ImageId: ami-12345678 ImageName: copy-image-example + ImageType: machine + PermissionsToLaunch: + AccountIds: [] + GlobalPermission: false + ProductCodes: + - '0001' + RootDeviceName: "/dev/sda1" + RootDeviceType: bsu + State: available + StateComment: {} + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex3: summary: Registering from a snapshot value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Image: - StateComment: {} - State: available - RootDeviceType: bsu - RootDeviceName: "/dev/sda1" - ProductCodes: - - '0001' - PermissionsToLaunch: - GlobalPermission: false - AccountIds: [] AccountId: '123456789012' - Tags: [] - Description: '' - ImageId: ami-12345678 + Architecture: x86_64 BlockDeviceMappings: - - DeviceName: "/dev/sda1" - Bsu: - VolumeType: io1 + - Bsu: DeleteOnVmDeletion: true - VolumeSize: 120 Iops: 150 SnapshotId: snap-12345678 - ImageType: machine + VolumeSize: 120 + VolumeType: io1 + DeviceName: "/dev/sda1" + BootModes: + - legacy CreationDate: '2010-10-01T12:34:56.789Z' + Description: '' FileLocation: 123456789012/register-image-from-snapshot-example - Architecture: x86_64 + ImageId: ami-12345678 ImageName: register-image-from-snapshot-example + ImageType: machine + PermissionsToLaunch: + AccountIds: [] + GlobalPermission: false + ProductCodes: + - '0001' + RootDeviceName: "/dev/sda1" + RootDeviceType: bsu + State: available + StateComment: {} + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex4: summary: Registering from a bucket by using a manifest file value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Image: - StateComment: {} - State: pending - RootDeviceType: bsu - RootDeviceName: "/dev/sda1" - ProductCodes: - - '0001' - PermissionsToLaunch: - GlobalPermission: false - AccountIds: [] AccountId: '123456789012' - Tags: [] - Description: '' - ImageId: ami-12345678 + Architecture: x86_64 BlockDeviceMappings: - - DeviceName: "/dev/sda1" - Bsu: - VolumeType: standard + - Bsu: DeleteOnVmDeletion: true - VolumeSize: 50 SnapshotId: snap-12345678 - ImageType: machine + VolumeSize: 50 + VolumeType: standard + DeviceName: "/dev/sda1" + BootModes: + - legacy CreationDate: '2010-10-01T12:34:56.789Z' + Description: '' FileLocation: https://oos.eu-west-2.outscale.com/BUCKET/KEY?AWSAccessKeyId=ABCDEFGHIJ0123456789&Expires=1493372309&Signature=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - Architecture: x86_64 + ImageId: ami-12345678 ImageName: register-image-from-bucket-example + ImageType: machine + PermissionsToLaunch: + AccountIds: [] + GlobalPermission: false + ProductCodes: + - '0001' + RootDeviceName: "/dev/sda1" + RootDeviceType: bsu + State: pending + StateComment: {} + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateImageResponse" description: The HTTP 200 response (OK). '400': content: @@ -13261,8 +13371,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateImageExportTaskRequest" examples: ex1: value: @@ -13271,28 +13379,30 @@ paths: DiskImageFormat: qcow2 OsuBucket: BUCKET OsuPrefix: PREFIX + schema: + "$ref": "#/components/schemas/CreateImageExportTaskRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateImageExportTaskResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ImageExportTask: - Tags: [] - ImageId: ami-12345678 - TaskId: image-export-12345678 Comment: Export of image ami-12345678 + ImageId: ami-12345678 OsuExport: - OsuPrefix: PREFIX/ami-12345678/ - OsuBucket: BUCKET DiskImageFormat: qcow2 - State: pending/queued + OsuBucket: BUCKET + OsuPrefix: PREFIX/ami-12345678/ Progress: 0 + State: pending/queued + Tags: [] + TaskId: image-export-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateImageExportTaskResponse" description: The HTTP 200 response (OK). tags: - Image @@ -13306,26 +13416,26 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateInternetServiceRequest" examples: ex1: value: {} + schema: + "$ref": "#/components/schemas/CreateInternetServiceRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateInternetServiceResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 InternetService: - Tags: [] InternetServiceId: igw-12345678 - description: The HTTP 200 response (OK). + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateInternetServiceResponse" + description: The HTTP 200 response (OK). '400': content: application/json: @@ -13360,8 +13470,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateKeypairRequest" examples: ex1: summary: Creating a keypair @@ -13372,37 +13480,39 @@ paths: value: KeypairName: import-keypair-example PublicKey: "..." + schema: + "$ref": "#/components/schemas/CreateKeypairRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateKeypairResponse" examples: ex1: summary: Creating a keypair value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Keypair: + KeypairFingerprint: 11:22:33:44:55:66:77:88:99:00:aa:bb:cc:dd:ee:ff + KeypairId: key-abcdef1234567890abcdef1234567890 + KeypairName: create-keypair-example + KeypairType: ssh-rsa PrivateKey: |- -----BEGIN RSA PRIVATE KEY----- ... -----END RSA PRIVATE KEY----- - KeypairType: ssh-rsa - KeypairName: create-keypair-example - KeypairId: key-abcdef1234567890abcdef1234567890 - KeypairFingerprint: 11:22:33:44:55:66:77:88:99:00:aa:bb:cc:dd:ee:ff + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Importing a keypair created locally value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Keypair: - KeypairType: ssh-rsa - KeypairName: create-keypair-example - KeypairId: key-abcdef1234567890abcdef1234567890 KeypairFingerprint: 11:22:33:44:55:66:77:88:99:00:aa:bb:cc:dd:ee:ff + KeypairId: key-abcdef1234567890abcdef1234567890 + KeypairName: create-keypair-example + KeypairType: ssh-rsa + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateKeypairResponse" description: The HTTP 200 response (OK). '400': content: @@ -13440,8 +13550,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateListenerRuleRequest" examples: ex1: summary: Creating a listener rule based on a host pattern @@ -13464,46 +13572,48 @@ paths: LoadBalancerPort: 80 ListenerRule: Action: forward - PathPattern: "/docs/*" ListenerRuleName: example-listener-rule + PathPattern: "/docs/*" Priority: 100 VmIds: - i-12345678 + schema: + "$ref": "#/components/schemas/CreateListenerRuleRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateListenerRuleResponse" examples: ex1: summary: Creating a listener rule based on a host pattern value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ListenerRule: - Priority: 10 - VmIds: - - i-12345678 - ListenerRuleName: example-listener-rule Action: forward - ListenerId: 123456 HostNamePattern: "*.example.com" + ListenerId: 123456 ListenerRuleId: 1234 + ListenerRuleName: example-listener-rule + Priority: 10 + VmIds: + - i-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 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 + ListenerRuleName: example-listener-rule + PathPattern: "/docs/*" + Priority: 100 + VmIds: + - i-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateListenerRuleResponse" description: The HTTP 200 response (OK). tags: - Listener @@ -13519,173 +13629,173 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateLoadBalancerRequest" examples: ex1: summary: Creating an internal load balancer in a Net value: - LoadBalancerName: private-lb-example Listeners: - BackendPort: 80 BackendProtocol: TCP LoadBalancerPort: 80 LoadBalancerProtocol: TCP - Subnets: - - subnet-12345678 + LoadBalancerName: private-lb-example + LoadBalancerType: internal SecurityGroups: - sg-12345678 - LoadBalancerType: internal + Subnets: + - subnet-12345678 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 + LoadBalancerName: private-lb-example LoadBalancerType: internet-facing PublicIp: 192.0.2.0 + SecurityGroups: + - sg-12345678 + Subnets: + - subnet-12345678 ex3: summary: Creating an internet-facing load balancer in the public Cloud value: - LoadBalancerName: public-lb-example - SubregionNames: - - eu-west-2a Listeners: - BackendPort: 8080 BackendProtocol: HTTP LoadBalancerPort: 8080 LoadBalancerProtocol: HTTP + LoadBalancerName: public-lb-example + SubregionNames: + - eu-west-2a + schema: + "$ref": "#/components/schemas/CreateLoadBalancerRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateLoadBalancerResponse" examples: ex1: summary: Creating an internal load balancer in a Net value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 LoadBalancer: - Tags: [] - SourceSecurityGroup: - SecurityGroupName: security-group-example - SecurityGroupAccountId: '123456789012' - SecuredCookies: false - Subnets: - - subnet-12345678 - NetId: vpc-12345678 - BackendVmIds: [] - ApplicationStickyCookiePolicies: [] - SecurityGroups: - - sg-12345678 - LoadBalancerType: internal AccessLog: - PublicationInterval: 60 IsEnabled: false + PublicationInterval: 60 + ApplicationStickyCookiePolicies: [] + BackendVmIds: [] 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 + Protocol: TCP + Timeout: 5 + UnhealthyThreshold: 2 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: [] + LoadBalancerStickyCookiePolicies: [] + LoadBalancerType: internal + NetId: vpc-12345678 + SecuredCookies: false + SecurityGroups: + - sg-12345678 SourceSecurityGroup: - SecurityGroupName: security-group-example SecurityGroupAccountId: '123456789012' - SecuredCookies: false - PublicIp: 192.0.2.0 + SecurityGroupName: security-group-example Subnets: - subnet-12345678 - NetId: vpc-12345678 - BackendVmIds: [] - ApplicationStickyCookiePolicies: [] - SecurityGroups: - - sg-12345678 - LoadBalancerType: internet-facing + SubregionNames: + - eu-west-2a + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + summary: Creating an internet-facing load balancer in a Net + value: + LoadBalancer: AccessLog: - PublicationInterval: 60 IsEnabled: false + PublicationInterval: 60 + ApplicationStickyCookiePolicies: [] + BackendVmIds: [] 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 + Protocol: TCP + Timeout: 5 + UnhealthyThreshold: 2 Listeners: - - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate - BackendPort: 80 + - BackendPort: 80 BackendProtocol: HTTP LoadBalancerPort: 443 LoadBalancerProtocol: HTTPS + ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate LoadBalancerName: private-lb-example + LoadBalancerStickyCookiePolicies: [] + LoadBalancerType: internet-facing + NetId: vpc-12345678 + PublicIp: 192.0.2.0 + SecuredCookies: false + SecurityGroups: + - sg-12345678 + SourceSecurityGroup: + SecurityGroupAccountId: '123456789012' + SecurityGroupName: security-group-example + Subnets: + - subnet-12345678 + SubregionNames: + - eu-west-2a + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex3: summary: 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 + PublicationInterval: 60 + ApplicationStickyCookiePolicies: [] + BackendVmIds: [] 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 + Protocol: TCP + Timeout: 5 + UnhealthyThreshold: 2 Listeners: - BackendPort: 8080 BackendProtocol: HTTP LoadBalancerPort: 8080 LoadBalancerProtocol: HTTP LoadBalancerName: public-lb-example + LoadBalancerStickyCookiePolicies: [] + LoadBalancerType: internet-facing + SecuredCookies: false + SourceSecurityGroup: + SecurityGroupAccountId: outscale-elb + SecurityGroupName: outscale-elb-sg + Subnets: [] + SubregionNames: + - eu-west-2a + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateLoadBalancerResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer @@ -13698,56 +13808,38 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateLoadBalancerListenersRequest" examples: ex1: value: - LoadBalancerName: example-lbu Listeners: - BackendPort: 58 BackendProtocol: TCP LoadBalancerPort: 62 LoadBalancerProtocol: TCP + LoadBalancerName: example-lbu + schema: + "$ref": "#/components/schemas/CreateLoadBalancerListenersRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateLoadBalancerListenersResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 LoadBalancer: - Tags: [] - SourceSecurityGroup: - SecurityGroupName: security-group-example - SecurityGroupAccountId: '123456789012' - SecuredCookies: false - Subnets: - - subnet-12345678 - NetId: vpc-12345678 - BackendVmIds: [] - ApplicationStickyCookiePolicies: [] - SecurityGroups: - - sg-12345678 - LoadBalancerType: internal AccessLog: - PublicationInterval: 60 IsEnabled: false + PublicationInterval: 60 + ApplicationStickyCookiePolicies: [] + BackendVmIds: [] 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 + Protocol: TCP + Timeout: 5 + UnhealthyThreshold: 2 Listeners: - BackendPort: 58 BackendProtocol: TCP @@ -13758,6 +13850,24 @@ paths: LoadBalancerPort: 80 LoadBalancerProtocol: TCP LoadBalancerName: example-lbu + LoadBalancerStickyCookiePolicies: [] + LoadBalancerType: internal + NetId: vpc-12345678 + SecuredCookies: false + SecurityGroups: + - sg-12345678 + SourceSecurityGroup: + SecurityGroupAccountId: '123456789012' + SecurityGroupName: security-group-example + Subnets: + - subnet-12345678 + SubregionNames: + - eu-west-2a + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateLoadBalancerListenersResponse" description: The HTTP 200 response (OK). tags: - Listener @@ -13776,8 +13886,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateLoadBalancerPolicyRequest" examples: ex1: summary: Creating a load balancer policy based on browser @@ -13788,97 +13896,99 @@ paths: ex2: summary: Creating a load balancer policy based on application cookie value: + CookieName: example-cookie LoadBalancerName: example-lbu PolicyName: example-app-policy PolicyType: app - CookieName: example-cookie + schema: + "$ref": "#/components/schemas/CreateLoadBalancerPolicyRequest" 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 + PublicationInterval: 60 + ApplicationStickyCookiePolicies: [] + BackendVmIds: [] 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 + Protocol: TCP + Timeout: 5 + UnhealthyThreshold: 2 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: [] + LoadBalancerStickyCookiePolicies: + - CookieExpirationPeriod: 1 + PolicyName: example-browser-policy + LoadBalancerType: internet-facing + NetId: vpc-12345678 + SecurityGroups: + - sg-12345678 SourceSecurityGroup: - SecurityGroupName: default SecurityGroupAccountId: '123456789012' + SecurityGroupName: default Subnets: - subnet-12345678 - NetId: vpc-12345678 - BackendVmIds: [] - ApplicationStickyCookiePolicies: - - PolicyName: example-app-policy - CookieName: example-cookie - SecurityGroups: - - sg-12345678 - LoadBalancerType: internet-facing + SubregionNames: + - eu-west-2a + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + summary: Creating a load balancer policy based on application cookie + value: + LoadBalancer: AccessLog: - PublicationInterval: 60 IsEnabled: false + PublicationInterval: 60 + ApplicationStickyCookiePolicies: + - CookieName: example-cookie + PolicyName: example-app-policy + BackendVmIds: [] 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 + Protocol: TCP + Timeout: 5 + UnhealthyThreshold: 2 Listeners: - BackendPort: 80 BackendProtocol: HTTP LoadBalancerPort: 80 LoadBalancerProtocol: HTTP LoadBalancerName: example-lbu + LoadBalancerStickyCookiePolicies: [] + LoadBalancerType: internet-facing + NetId: vpc-12345678 + SecurityGroups: + - sg-12345678 + SourceSecurityGroup: + SecurityGroupAccountId: '123456789012' + SecurityGroupName: default + Subnets: + - subnet-12345678 + SubregionNames: + - eu-west-2a + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateLoadBalancerPolicyResponse" description: The HTTP 200 response (OK). tags: - LoadBalancerPolicy @@ -13892,8 +14002,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateLoadBalancerTagsRequest" examples: ex1: value: @@ -13902,17 +14010,19 @@ paths: Tags: - Key: key1 Value: value1 + schema: + "$ref": "#/components/schemas/CreateLoadBalancerTagsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateLoadBalancerTagsResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateLoadBalancerTagsResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer @@ -13931,33 +14041,33 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateNatServiceRequest" examples: ex1: value: - SubnetId: subnet-12345678 PublicIpId: eipalloc-12345678 + SubnetId: subnet-12345678 + schema: + "$ref": "#/components/schemas/CreateNatServiceRequest" 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 + PublicIps: + - PublicIp: 192.0.2.0 + PublicIpId: eipalloc-12345678 State: available + SubnetId: subnet-12345678 + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateNatServiceResponse" description: The HTTP 200 response (OK). '400': content: @@ -13989,30 +14099,30 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateNetRequest" examples: ex1: value: IpRange: 10.0.0.0/16 + schema: + "$ref": "#/components/schemas/CreateNetRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateNetResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Net: - Tags: [] DhcpOptionsSetId: dopt-12345678 IpRange: 10.0.0.0/16 - Tenancy: default NetId: vpc-12345678 State: available + Tags: [] + Tenancy: default + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateNetResponse" description: The HTTP 200 response (OK). '400': content: @@ -14052,8 +14162,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateNetAccessPointRequest" examples: ex1: value: @@ -14061,25 +14169,27 @@ paths: RouteTableIds: - rtb-12345678 ServiceName: com.outscale.eu-west-2.oos + schema: + "$ref": "#/components/schemas/CreateNetAccessPointRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateNetAccessPointResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 NetAccessPoint: - Tags: [] NetAccessPointId: vpce-12345678 + NetId: vpc-12345678 RouteTableIds: - rtb-12345678 - State: pending - NetId: vpc-12345678 ServiceName: com.outscale.eu-west-2.oos + State: pending + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateNetAccessPointResponse" description: The HTTP 200 response (OK). tags: - NetAccessPoint @@ -14099,67 +14209,67 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateNetPeeringRequest" examples: ex1: summary: Creating a Net peering between two Nets belonging to you value: - SourceNetId: vpc-12345678 AccepterNetId: vpc-87654321 + SourceNetId: vpc-12345678 ex2: summary: Creating a Net peering with a Net that belongs to another account value: - SourceNetId: vpc-12345678 AccepterNetId: vpc-87654321 AccepterOwnerId: '987654321098' + SourceNetId: vpc-12345678 + schema: + "$ref": "#/components/schemas/CreateNetPeeringRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateNetPeeringResponse" examples: ex1: summary: Creating a Net peering between two Nets belonging to you value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 NetPeering: - Tags: [] - State: - Name: pending-acceptance - Message: Pending acceptance by 123456789012 AccepterNet: - NetId: vpc-12345678 - IpRange: 172.16.0.0/16 AccountId: '123456789012' + IpRange: 172.16.0.0/16 + NetId: vpc-12345678 + NetPeeringId: pcx-12345678 SourceNet: - NetId: vpc-87654321 - IpRange: 10.0.0.0/16 AccountId: '123456789012' - NetPeeringId: pcx-12345678 + IpRange: 10.0.0.0/16 + NetId: vpc-87654321 + State: + Message: Pending acceptance by 123456789012 + Name: pending-acceptance + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Creating a Net peering with a Net that belongs to another account value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 NetPeering: - Tags: [] - State: - Name: pending-acceptance - Message: Pending acceptance by 123456789012 AccepterNet: - NetId: vpc-87654321 - IpRange: 172.16.0.0/16 AccountId: '987654321098' + IpRange: 172.16.0.0/16 + NetId: vpc-87654321 + NetPeeringId: pcx-12345678 SourceNet: - NetId: vpc-12345678 - IpRange: 10.0.0.0/16 AccountId: '123456789012' - NetPeeringId: pcx-12345678 + IpRange: 10.0.0.0/16 + NetId: vpc-12345678 + State: + Message: Pending acceptance by 123456789012 + Name: pending-acceptance + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateNetPeeringResponse" description: The HTTP 200 response (OK). '400': content: @@ -14190,85 +14300,85 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateNicRequest" examples: ex1: summary: Creating a NIC value: - SubnetId: subnet-12345678 SecurityGroupIds: - sg-12345678 + SubnetId: subnet-12345678 ex2: summary: Creating a NIC with specific private IPs value: Description: Terraform nic with private IPs - SubnetId: subnet-12345678 - SecurityGroupIds: - - sg-12345678 PrivateIps: - IsPrimary: true PrivateIp: 10.0.0.4 - IsPrimary: false PrivateIp: 10.0.0.5 + SecurityGroupIds: + - sg-12345678 + SubnetId: subnet-12345678 + schema: + "$ref": "#/components/schemas/CreateNicRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateNicResponse" examples: ex1: summary: Creating a NIC value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Nic: - 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 + Description: '' + IsSourceDestChecked: true MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - IsPrimary: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - IsPrimary: true + SecurityGroups: + - SecurityGroupId: sg-12345678 + SecurityGroupName: security-group-example + State: available + SubnetId: subnet-12345678 + SubregionName: eu-west-2a + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 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 + Description: '' + IsSourceDestChecked: true MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - IsPrimary: true + 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 + - IsPrimary: false + PrivateDnsName: ip-10-0-0-5.eu-west-2.compute.internal PrivateIp: 10.0.0.5 - IsPrimary: false + SecurityGroups: + - SecurityGroupId: sg-12345678 + SecurityGroupName: security-group-example + State: available + SubnetId: subnet-12345678 + SubregionName: eu-west-2a + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateNicResponse" description: The HTTP 200 response (OK). '400': content: @@ -14299,8 +14409,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreatePolicyRequest" examples: ex1: value: @@ -14309,28 +14417,30 @@ paths: "Resource": ["*"]} ]}' Path: "/example/" PolicyName: example-user-policy + schema: + "$ref": "#/components/schemas/CreatePolicyRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreatePolicyResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Policy: - ResourcesCount: 0 - PolicyName: example-user-policy - PolicyDefaultVersionId: v1 - Path: "/example/" CreationDate: 2010-10-01 12:34:56.789000000 +00:00 Description: Example of description - PolicyId: ABCDEFGHIJKLMNOPQRSTUVWXYZ01234 - Orn: orn:ows:idauth::012345678910:policy/example/example-user-policy IsLinkable: true LastModificationDate: 2010-10-01 12:34:56.789000000 +00:00 + Orn: orn:ows:idauth::012345678910:policy/example/example-user-policy + Path: "/example/" + PolicyDefaultVersionId: v1 + PolicyId: ABCDEFGHIJKLMNOPQRSTUVWXYZ01234 + PolicyName: example-user-policy + ResourcesCount: 0 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreatePolicyResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -14343,8 +14453,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreatePolicyVersionRequest" examples: ex1: value: @@ -14352,23 +14460,25 @@ paths: "Resource": ["*"]} ]}' PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy SetAsDefault: true + schema: + "$ref": "#/components/schemas/CreatePolicyVersionRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreatePolicyVersionResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 PolicyVersion: - VersionId: v2 - DefaultVersion: true - CreationDate: 2017-05-10 12:34:56.789000000 +00:00 Body: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], "Resource": ["*"]} ]}' + CreationDate: 2017-05-10 12:34:56.789000000 +00:00 + DefaultVersion: true + VersionId: v2 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreatePolicyVersionResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -14380,28 +14490,28 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateProductTypeRequest" examples: ex1: value: - Vendor: vendor-name Description: Example of description + Vendor: vendor-name + schema: + "$ref": "#/components/schemas/CreateProductTypeRequest" 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 + ProductTypeId: pty-12345678 + Vendor: vendor-name + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateProductTypeResponse" description: The HTTP 200 response (OK). tags: - ProductType @@ -14415,26 +14525,26 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreatePublicIpRequest" examples: ex1: value: {} + schema: + "$ref": "#/components/schemas/CreatePublicIpRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreatePublicIpResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 PublicIp: - Tags: [] - PublicIpId: eipalloc-12345678 PublicIp: 192.0.2.0 + PublicIpId: eipalloc-12345678 + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreatePublicIpResponse" description: The HTTP 200 response (OK). '400': content: @@ -14475,41 +14585,41 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateRouteRequest" examples: ex1: summary: Creating a route to an Internet service value: - RouteTableId: rtb-12345678 DestinationIpRange: 0.0.0.0/0 GatewayId: igw-12345678 + RouteTableId: rtb-12345678 + schema: + "$ref": "#/components/schemas/CreateRouteRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateRouteResponse" examples: ex1: summary: Creating a route to an Internet service value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 RouteTable: + LinkRouteTables: [] + NetId: vpc-12345678 + RoutePropagatingVirtualGateways: [] + RouteTableId: rtb-12345678 Routes: - - DestinationIpRange: 10.0.0.0/16 - CreationMethod: CreateRouteTable + - CreationMethod: CreateRouteTable + DestinationIpRange: 10.0.0.0/16 State: active - - GatewayId: igw-12345678 + - CreationMethod: CreateRoute DestinationIpRange: 0.0.0.0/0 - CreationMethod: CreateRoute + GatewayId: igw-12345678 State: active - LinkRouteTables: [] - NetId: vpc-12345678 Tags: [] - RoutePropagatingVirtualGateways: [] - RouteTableId: rtb-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateRouteResponse" description: The HTTP 200 response (OK). '400': content: @@ -14541,33 +14651,33 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateRouteTableRequest" examples: ex1: value: NetId: vpc-12345678 + schema: + "$ref": "#/components/schemas/CreateRouteTableRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateRouteTableResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 RouteTable: - Routes: - - DestinationIpRange: 10.0.0.0/16 - CreationMethod: CreateRouteTable - State: active LinkRouteTables: [] NetId: vpc-12345678 - Tags: [] RoutePropagatingVirtualGateways: [] RouteTableId: rtb-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Routes: + - CreationMethod: CreateRouteTable + DestinationIpRange: 10.0.0.0/16 + State: active + Tags: [] + schema: + "$ref": "#/components/schemas/CreateRouteTableResponse" description: The HTTP 200 response (OK). '400': content: @@ -14603,39 +14713,39 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateSecurityGroupRequest" examples: ex1: value: + Description: Security group example NetId: vpc-12345678 SecurityGroupName: security-group-example - Description: Security group example + schema: + "$ref": "#/components/schemas/CreateSecurityGroupRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateSecurityGroupResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 SecurityGroup: - Tags: [] - SecurityGroupName: security-group-example + AccountId: '123456789012' + Description: Example of security group + InboundRules: [] + NetId: vpc-12345678 OutboundRules: - FromPortRange: -1 IpProtocol: "-1" - ToPortRange: -1 IpRanges: - 0.0.0.0/0 + ToPortRange: -1 SecurityGroupId: sg-12345678 - AccountId: '123456789012' - Description: Example of security group - InboundRules: [] - NetId: vpc-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + SecurityGroupName: security-group-example + Tags: [] + schema: + "$ref": "#/components/schemas/CreateSecurityGroupResponse" description: The HTTP 200 response (OK). '400': content: @@ -14680,87 +14790,87 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateSecurityGroupRuleRequest" examples: ex1: summary: Creating an inbound rule from an IP range value: Flow: Inbound - SecurityGroupId: sg-12345678 FromPortRange: 80 - ToPortRange: 80 IpProtocol: tcp IpRange: 10.0.0.0/16 + SecurityGroupId: sg-12345678 + ToPortRange: 80 ex2: summary: Creating an inbound rule from another security group value: Flow: Inbound - SecurityGroupId: sg-12345678 Rules: - FromPortRange: 22 - ToPortRange: 22 IpProtocol: tcp SecurityGroupsMembers: - AccountId: '123456789012' SecurityGroupName: another-security-group + ToPortRange: 22 + SecurityGroupId: sg-12345678 + schema: + "$ref": "#/components/schemas/CreateSecurityGroupRuleRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateSecurityGroupRuleResponse" examples: ex1: summary: Creating an inbound rule from an IP range value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 SecurityGroup: - Tags: [] - SecurityGroupName: security-group-example - OutboundRules: - - FromPortRange: -1 - IpProtocol: "-1" - ToPortRange: -1 - IpRanges: - - 0.0.0.0/0 - SecurityGroupId: sg-12345678 AccountId: '123456789012' Description: Example of security group InboundRules: - FromPortRange: 80 IpProtocol: tcp - ToPortRange: 80 IpRanges: - 10.0.0.0/16 + ToPortRange: 80 NetId: vpc-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - ex2: - summary: Creating an inbound rule from another security group - value: - SecurityGroup: - Tags: [] - SecurityGroupName: security-group-example OutboundRules: - FromPortRange: -1 IpProtocol: "-1" - ToPortRange: -1 IpRanges: - 0.0.0.0/0 + ToPortRange: -1 SecurityGroupId: sg-12345678 + SecurityGroupName: security-group-example + Tags: [] + ex2: + summary: Creating an inbound rule from another security group + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + SecurityGroup: AccountId: '123456789012' Description: Example of security group InboundRules: - FromPortRange: 22 IpProtocol: tcp - ToPortRange: 22 SecurityGroupsMembers: - - SecurityGroupName: another-security-group + - AccountId: '987654321098' SecurityGroupId: sg-87654321 - AccountId: '987654321098' + SecurityGroupName: another-security-group + ToPortRange: 22 NetId: vpc-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + OutboundRules: + - FromPortRange: -1 + IpProtocol: "-1" + IpRanges: + - 0.0.0.0/0 + ToPortRange: -1 + SecurityGroupId: sg-12345678 + SecurityGroupName: security-group-example + Tags: [] + schema: + "$ref": "#/components/schemas/CreateSecurityGroupRuleResponse" description: The HTTP 200 response (OK). '400': content: @@ -14796,32 +14906,32 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateServerCertificateRequest" examples: ex1: value: - Name: server-cert-example Body: "..." Chain: "..." - PrivateKey: "..." + Name: server-cert-example Path: "/example/" + PrivateKey: "..." + schema: + "$ref": "#/components/schemas/CreateServerCertificateRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateServerCertificateResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ServerCertificate: - Path: "/example/" Id: ABCDEFGHIJKLMNOPQRSTUVWXYZ1234 - Orn: orn:ows:idauth::012345678910:server-certificate/example/server-cert-example Name: server-cert-example - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Orn: orn:ows:idauth::012345678910:server-certificate/example/server-cert-example + Path: "/example/" + schema: + "$ref": "#/components/schemas/CreateServerCertificateResponse" description: The HTTP 200 response (OK). tags: - ServerCertificate @@ -14842,87 +14952,87 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateSnapshotRequest" examples: ex1: summary: Creating from a volume value: - VolumeId: vol-12345678 Description: Snapshot created from a volume + VolumeId: vol-12345678 ex2: summary: Copying a snapshot value: - SourceSnapshotId: snap-12345678 - SourceRegionName: eu-west-2 Description: Snapshot created from another snapshot + SourceRegionName: eu-west-2 + SourceSnapshotId: snap-12345678 ex3: summary: Importing from a bucket value: + Description: Snapshot imported from a bucket FileLocation: https://oos.eu-west-2.outscale.com/BUCKET/KEY?AWSAccessKeyId=ABCDEFGHIJ0123456789&Expires=1493372309&Signature=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX SnapshotSize: 10737418240 - Description: Snapshot imported from a bucket + schema: + "$ref": "#/components/schemas/CreateSnapshotRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateSnapshotResponse" examples: ex1: summary: Creating from a volume value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Snapshot: - VolumeSize: 10 AccountId: '123456789012' - VolumeId: vol-12345678 CreationDate: '2010-10-01T12:34:56.789Z' + Description: Snapshot created from a volume PermissionsToCreateVolume: - GlobalPermission: false AccountIds: [] + GlobalPermission: false Progress: 0 SnapshotId: snap-12345678 State: pending/queued - Description: Snapshot created from a volume Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + VolumeId: vol-12345678 + VolumeSize: 10 ex2: summary: Copying a snapshot value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Snapshot: - VolumeSize: 10 AccountId: '123456789012' - VolumeId: vol-12345678 CreationDate: '2010-10-01T12:34:56.789Z' + Description: Snapshot copied from another snapshot PermissionsToCreateVolume: - GlobalPermission: false AccountIds: [] + GlobalPermission: false Progress: 100 SnapshotId: snap-12345678 State: completed - Description: Snapshot copied from another snapshot Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + VolumeId: vol-12345678 + VolumeSize: 10 ex3: summary: Importing from a bucket value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Snapshot: - VolumeSize: 10 AccountId: '123456789012' - VolumeId: vol-12345678 CreationDate: '2010-10-01T12:34:56.789Z' + Description: Snapshot imported from a bucket PermissionsToCreateVolume: - GlobalPermission: false AccountIds: [] + GlobalPermission: false Progress: 0 SnapshotId: snap-12345678 State: importing - Description: Snapshot imported from a bucket Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + VolumeId: vol-12345678 + VolumeSize: 10 + schema: + "$ref": "#/components/schemas/CreateSnapshotResponse" description: The HTTP 200 response (OK). '400': content: @@ -14954,38 +15064,38 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateSnapshotExportTaskRequest" examples: ex1: value: - SnapshotId: snap-12345678 OsuExport: DiskImageFormat: qcow2 OsuBucket: BUCKET OsuPrefix: PREFIX + SnapshotId: snap-12345678 + schema: + "$ref": "#/components/schemas/CreateSnapshotExportTaskRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateSnapshotExportTaskResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 SnapshotExportTask: - Tags: [] - TaskId: snap-export-12345678 Comment: Export of snapshot snap-12345678 OsuExport: - OsuPrefix: PREFIX - OsuBucket: BUCKET DiskImageFormat: qcow2 - State: pending - SnapshotId: snap-12345678 + OsuBucket: BUCKET + OsuPrefix: PREFIX Progress: 0 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + SnapshotId: snap-12345678 + State: pending + Tags: [] + TaskId: snap-export-12345678 + schema: + "$ref": "#/components/schemas/CreateSnapshotExportTaskResponse" description: The HTTP 200 response (OK). tags: - Snapshot @@ -14999,33 +15109,33 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateSubnetRequest" examples: ex1: value: - NetId: vpc-12345678 IpRange: 10.0.0.0/18 + NetId: vpc-12345678 + schema: + "$ref": "#/components/schemas/CreateSubnetRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateSubnetResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Subnet: - Tags: [] - SubregionName: eu-west-2a - SubnetId: subnet-12345678 AvailableIpsCount: 16379 IpRange: 10.0.0.0/18 MapPublicIpOnLaunch: false - State: available NetId: vpc-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + State: available + SubnetId: subnet-12345678 + SubregionName: eu-west-2a + Tags: [] + schema: + "$ref": "#/components/schemas/CreateSubnetResponse" description: The HTTP 200 response (OK). '400': content: @@ -15088,8 +15198,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateTagsRequest" examples: ex1: value: @@ -15098,17 +15206,19 @@ paths: Tags: - Key: key1 Value: value1 + schema: + "$ref": "#/components/schemas/CreateTagsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateTagsResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateTagsResponse" description: The HTTP 200 response (OK). '400': content: @@ -15139,32 +15249,32 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateUserRequest" examples: ex1: value: + Path: "/documentation/" UserEmail: user@example.com UserName: example-user - Path: "/documentation/" + schema: + "$ref": "#/components/schemas/CreateUserRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateUserResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 User: CreationDate: 2010-10-01 12:34:56.789000000 +00:00 LastModificationDate: 2017-05-10 12:34:56.789000000 +00:00 + Path: "/documentation/" UserEmail: user@example.com - UserName: example-user UserId: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 - Path: "/documentation/" - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + UserName: example-user + schema: + "$ref": "#/components/schemas/CreateUserResponse" description: The HTTP 200 response (OK). tags: - User @@ -15177,19 +15287,17 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateUserGroupRequest" examples: ex1: value: Path: "/example/" UserGroupName: example-usergroup + schema: + "$ref": "#/components/schemas/CreateUserGroupRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateUserGroupResponse" examples: ex1: value: @@ -15202,6 +15310,8 @@ paths: Orn: orn:ows:idauth::012345678910:usergroup/example/usergroup-example Path: "/example/" UserGroupId: ug-12345678 + schema: + "$ref": "#/components/schemas/CreateUserGroupResponse" description: The HTTP 200 response (OK). tags: - UserGroup @@ -15215,29 +15325,29 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateVirtualGatewayRequest" examples: ex1: value: ConnectionType: ipsec.1 + schema: + "$ref": "#/components/schemas/CreateVirtualGatewayRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateVirtualGatewayResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VirtualGateway: - VirtualGatewayId: vgw-12345678 ConnectionType: ipsec.1 NetToVirtualGatewayLinks: [] State: available Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + VirtualGatewayId: vgw-12345678 + schema: + "$ref": "#/components/schemas/CreateVirtualGatewayResponse" description: The HTTP 200 response (OK). tags: - VirtualGateway @@ -15253,8 +15363,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateVmGroupRequest" examples: ex1: value: @@ -15269,15 +15377,17 @@ paths: VmCount: 2 VmGroupName: ClusterLog-PPD01 VmTemplateId: vmtemplate-98765432109876543210987654321012 + schema: + "$ref": "#/components/schemas/CreateVmGroupRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateVmGroupResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VmGroup: CreationDate: '2010-10-01T12:34:56.789Z' Description: Production log collector @@ -15294,8 +15404,8 @@ paths: VmGroupName: ClusterLog-PPD01 VmIds: [] VmTemplateId: vmtemplate-98765432109876543210987654321012 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateVmGroupResponse" description: The HTTP 200 response (OK). '400': content: @@ -15329,8 +15439,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateVmTemplateRequest" examples: ex1: value: @@ -15345,30 +15453,32 @@ paths: - Key: key1 Value: value1 VmTemplateName: vmtemplate-example + schema: + "$ref": "#/components/schemas/CreateVmTemplateRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateVmTemplateResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VmTemplate: - VmTemplateName: vmtemplate-example + CpuCores: 2 + CpuGeneration: v4 CpuPerformance: high CreationDate: 2010-10-01 12:34:56.789000000 +00:00 - CpuCores: 2 + Description: Log collector template + ImageId: ami-12345678 + Ram: 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 + VmTemplateName: vmtemplate-example + schema: + "$ref": "#/components/schemas/CreateVmTemplateResponse" description: The HTTP 200 response (OK). tags: - VmTemplate @@ -15386,8 +15496,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateVmsRequest" examples: ex1: summary: Creating a VM (minimal syntax) @@ -15397,303 +15505,317 @@ paths: summary: Creating a VM in a Net value: ImageId: ami-12345678 - VmType: tinav5.c1r1p2 KeypairName: keypair-example SecurityGroupIds: - sg-12345678 SubnetId: subnet-12345678 UserData: "..." + VmType: tinav5.c1r1p2 ex3: summary: Creating a VM with block device mappings value: - ImageId: ami-12345678 - VmType: tinav5.c1r1p2 - KeypairName: keypair-example - SecurityGroupIds: - - sg-12345678 - SubnetId: subnet-12345678 - UserData: "..." BlockDeviceMappings: - - DeviceName: "/dev/sda1" - Bsu: + - Bsu: VolumeSize: 15 VolumeType: gp2 - - DeviceName: "/dev/sdb" - Bsu: + DeviceName: "/dev/sda1" + - Bsu: + Iops: 150 SnapshotId: snap-12345678 VolumeSize: 22 VolumeType: io1 - Iops: 150 + DeviceName: "/dev/sdb" + ImageId: ami-12345678 + KeypairName: keypair-example + SecurityGroupIds: + - sg-12345678 + SubnetId: subnet-12345678 + UserData: "..." + VmType: tinav5.c1r1p2 ex4: summary: Creating a VM with a NIC value: ImageId: ami-12345678 - VmType: tinav5.c1r1p2 KeypairName: keypair-example - UserData: "..." Nics: - DeviceNumber: 0 NicId: eni-12345678 + UserData: "..." + VmType: tinav5.c1r1p2 + schema: + "$ref": "#/components/schemas/CreateVmsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateVmsResponse" examples: ex1: summary: Creating a VM (minimal syntax) value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Vms: - - VmType: t2.small - VmInitiatedShutdownBehavior: stop - State: pending - StateReason: '' - RootDeviceType: ebs - RootDeviceName: "/dev/sda1" - IsSourceDestChecked: true - ImageId: ami-12345678 - DeletionProtection: false + - ActionsOnNextBoot: + SecureBoot: none Architecture: x86_64 - NestedVirtualization: false BlockDeviceMappings: - - DeviceName: "/dev/sda1" - Bsu: - VolumeId: vol-12345678 - State: attaching - LinkDate: '2010-10-01T12:34:56.789Z' + - Bsu: DeleteOnVmDeletion: true - VmId: i-12345678 - ReservationId: r-12345678 + LinkDate: '2010-10-01T12:34:56.789Z' + State: attaching + VolumeId: vol-12345678 + DeviceName: "/dev/sda1" + BootMode: legacy + BsuOptimized: false + CreationDate: '2010-10-01T12:34:56.789Z' + DeletionProtection: false Hypervisor: xen + ImageId: ami-12345678 + IsSourceDestChecked: true + LaunchNumber: 0 + NestedVirtualization: false + Performance: medium Placement: - Tenancy: default SubregionName: eu-west-2a - ProductCodes: - - '0001' - CreationDate: '2010-10-01T12:34:56.789Z' - UserData: "..." + Tenancy: default + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 + ProductCodes: + - '0001' + ReservationId: r-12345678 + RootDeviceName: "/dev/sda1" + RootDeviceType: ebs SecurityGroups: - - SecurityGroupName: default - SecurityGroupId: sg-12345678 - BsuOptimized: false - LaunchNumber: 0 - Performance: medium + - SecurityGroupId: sg-12345678 + SecurityGroupName: default + State: pending + StateReason: '' Tags: [] - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + UserData: "..." + VmId: i-12345678 + VmInitiatedShutdownBehavior: stop + VmType: t2.small ex2: summary: Creating a VM in a Net value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Vms: - - VmType: tinav5.c1r1p2 - VmInitiatedShutdownBehavior: stop - State: pending - StateReason: '' - RootDeviceType: ebs - RootDeviceName: "/dev/sda1" - IsSourceDestChecked: true - KeypairName: keypair-example - ImageId: ami-12345678 - DeletionProtection: false + - ActionsOnNextBoot: + SecureBoot: none Architecture: x86_64 - NestedVirtualization: false BlockDeviceMappings: - - DeviceName: "/dev/sda1" - Bsu: - VolumeId: vol-12345678 - State: attaching - LinkDate: '2010-10-01T12:34:56.789Z' + - Bsu: 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 + LinkDate: '2010-10-01T12:34:56.789Z' + State: attaching + VolumeId: vol-12345678 + DeviceName: "/dev/sda1" + BootMode: legacy BsuOptimized: false + CreationDate: '2010-10-01T12:34:56.789Z' + DeletionProtection: false + Hypervisor: xen + ImageId: ami-12345678 + IsSourceDestChecked: true + KeypairName: keypair-example LaunchNumber: 0 + NestedVirtualization: false NetId: vpc-12345678 Nics: - - SubnetId: subnet-12345678 - State: in-use + - AccountId: '123456789012' + Description: Primary network interface + IsSourceDestChecked: true LinkNic: - State: attached + DeleteOnVmDeletion: true 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 + State: attached MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - IsPrimary: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - IsPrimary: true + SecurityGroups: + - SecurityGroupId: sg-12345678 + SecurityGroupName: security-group-example + State: in-use + SubnetId: subnet-12345678 Performance: high - Tags: [] + Placement: + SubregionName: eu-west-2a + Tenancy: default PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + PrivateIp: 10.0.0.4 + ProductCodes: + - '0001' + ReservationId: r-12345678 + RootDeviceName: "/dev/sda1" + RootDeviceType: ebs + SecurityGroups: + - SecurityGroupId: sg-12345678 + SecurityGroupName: security-group-example + State: pending + StateReason: '' + SubnetId: subnet-12345678 + Tags: [] + UserData: "..." + VmId: i-12345678 + VmInitiatedShutdownBehavior: stop + VmType: tinav5.c1r1p2 ex3: summary: Creating a VM with block device mappings value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Vms: - - VmType: tinav5.c1r1p2 - VmInitiatedShutdownBehavior: stop - State: pending - StateReason: '' - RootDeviceType: ebs - RootDeviceName: "/dev/sda1" - IsSourceDestChecked: true - KeypairName: keypair-example - ImageId: ami-12345678 - DeletionProtection: false + - ActionsOnNextBoot: + SecureBoot: none Architecture: x86_64 - NestedVirtualization: false BlockDeviceMappings: - - DeviceName: "/dev/sda1" - Bsu: - VolumeId: vol-12345678 - State: attaching - LinkDate: '2010-10-01T12:34:56.789Z' + - Bsu: DeleteOnVmDeletion: true - - DeviceName: "/dev/sda1" - Bsu: - VolumeId: vol-87654321 - State: attaching LinkDate: '2010-10-01T12:34:56.789Z' + State: attaching + VolumeId: vol-12345678 + DeviceName: "/dev/sda1" + - Bsu: 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 + LinkDate: '2010-10-01T12:34:56.789Z' + State: attaching + VolumeId: vol-87654321 + DeviceName: "/dev/sda1" + BootMode: legacy BsuOptimized: false + CreationDate: '2010-10-01T12:34:56.789Z' + DeletionProtection: false + Hypervisor: xen + ImageId: ami-12345678 + IsSourceDestChecked: true + KeypairName: keypair-example LaunchNumber: 0 + NestedVirtualization: false NetId: vpc-12345678 Nics: - - SubnetId: subnet-12345678 - State: in-use + - AccountId: '123456789012' + Description: Primary network interface + IsSourceDestChecked: true LinkNic: - State: attached + DeleteOnVmDeletion: true 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 + State: attached MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - IsPrimary: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - IsPrimary: true + SecurityGroups: + - SecurityGroupId: sg-12345678 + SecurityGroupName: security-group-example + State: in-use + SubnetId: subnet-12345678 Performance: high - Tags: [] + Placement: + SubregionName: eu-west-2a + Tenancy: default PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + PrivateIp: 10.0.0.4 + ProductCodes: + - '0001' + ReservationId: r-12345678 + RootDeviceName: "/dev/sda1" + RootDeviceType: ebs + SecurityGroups: + - SecurityGroupId: sg-12345678 + SecurityGroupName: security-group-example + State: pending + StateReason: '' + SubnetId: subnet-12345678 + Tags: [] + UserData: "..." + VmId: i-12345678 + VmInitiatedShutdownBehavior: stop + VmType: tinav5.c1r1p2 ex4: summary: Creating a VM with a NIC value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Vms: - - VmType: tinav5.c1r1p2 - VmInitiatedShutdownBehavior: stop - State: pending - StateReason: '' - RootDeviceType: ebs - RootDeviceName: "/dev/sda1" - IsSourceDestChecked: true - KeypairName: keypair-example - ImageId: ami-12345678 - DeletionProtection: false + - ActionsOnNextBoot: + SecureBoot: none Architecture: x86_64 - NestedVirtualization: false BlockDeviceMappings: - - DeviceName: "/dev/sda1" - Bsu: - VolumeId: vol-12345678 - State: attaching - LinkDate: '2010-10-01T12:34:56.789Z' + - Bsu: 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 + LinkDate: '2010-10-01T12:34:56.789Z' + State: attaching + VolumeId: vol-12345678 + DeviceName: "/dev/sda1" + BootMode: legacy BsuOptimized: false + CreationDate: '2010-10-01T12:34:56.789Z' + DeletionProtection: false + Hypervisor: xen + ImageId: ami-12345678 + IsSourceDestChecked: true + KeypairName: keypair-example LaunchNumber: 0 + NestedVirtualization: false NetId: vpc-12345678 Nics: - - SubnetId: subnet-12345678 - State: in-use + - AccountId: '123456789012' + Description: Example NIC + IsSourceDestChecked: true LinkNic: - State: attached + DeleteOnVmDeletion: true 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 + State: attached MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - IsPrimary: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - IsPrimary: true + SecurityGroups: + - SecurityGroupId: sg-12345678 + SecurityGroupName: security-group-example + State: in-use + SubnetId: subnet-12345678 Performance: high - Tags: [] + Placement: + SubregionName: eu-west-2a + Tenancy: default PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + PrivateIp: 10.0.0.4 + ProductCodes: + - '0001' + ReservationId: r-12345678 + RootDeviceName: "/dev/sda1" + RootDeviceType: ebs + SecurityGroups: + - SecurityGroupId: sg-12345678 + SecurityGroupName: security-group-example + State: pending + StateReason: '' + SubnetId: subnet-12345678 + Tags: [] + UserData: "..." + VmId: i-12345678 + VmInitiatedShutdownBehavior: stop + VmType: tinav5.c1r1p2 + schema: + "$ref": "#/components/schemas/CreateVmsResponse" description: The HTTP 200 response (OK). '400': content: @@ -15726,61 +15848,61 @@ paths: requestBody: content: 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 + Size: 10 + SubregionName: eu-west-2a + VolumeType: io1 ex2: summary: Creating a volume from a snapshot value: + Size: 10 SnapshotId: snap-12345678 - VolumeType: gp2 SubregionName: eu-west-2a - Size: 10 + VolumeType: gp2 + schema: + "$ref": "#/components/schemas/CreateVolumeRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateVolumeResponse" examples: ex1: summary: Creating an io1 volume value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Volume: - VolumeId: vol-12345678 - Tags: [] - VolumeType: io1 - SubregionName: eu-west-2a - State: creating CreationDate: '2010-10-01T12:34:56.789Z' Iops: 100 LinkedVolumes: [] Size: 10 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + State: creating + SubregionName: eu-west-2a + Tags: [] + VolumeId: vol-12345678 + VolumeType: io1 ex2: summary: Creating a volume from a snapshot value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Volume: - VolumeId: vol-12345678 - Tags: [] - VolumeType: gp2 - SubregionName: eu-west-2a - State: creating - SnapshotId: snap-12345678 CreationDate: '2010-10-01T12:34:56.789Z' Iops: 100 LinkedVolumes: [] Size: 10 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + SnapshotId: snap-12345678 + State: creating + SubregionName: eu-west-2a + Tags: [] + VolumeId: vol-12345678 + VolumeType: gp2 + schema: + "$ref": "#/components/schemas/CreateVolumeResponse" description: The HTTP 200 response (OK). '400': content: @@ -15815,41 +15937,41 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateVpnConnectionRequest" examples: ex1: value: ClientGatewayId: cgw-12345678 - VirtualGatewayId: vgw-12345678 ConnectionType: ipsec.1 StaticRoutesOnly: true + VirtualGatewayId: vgw-12345678 + schema: + "$ref": "#/components/schemas/CreateVpnConnectionRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateVpnConnectionResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VpnConnection: - Routes: [] - Tags: [] ClientGatewayConfiguration: "..." - StaticRoutesOnly: true - VirtualGatewayId: vgw-12345678 - ConnectionType: ipsec.1 ClientGatewayId: cgw-12345678 + ConnectionType: ipsec.1 + Routes: [] State: pending + StaticRoutesOnly: true + Tags: [] VgwTelemetries: - - StateDescription: IPSEC IS DOWN - AcceptedRouteCount: 0 + - AcceptedRouteCount: 0 LastStateChangeDate: '2017-05-10T12:34:56.789Z' OutsideIpAddress: 192.0.2.0 + StateDescription: IPSEC IS DOWN + VirtualGatewayId: vgw-12345678 VpnConnectionId: vpn-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateVpnConnectionResponse" description: The HTTP 200 response (OK). tags: - VpnConnection @@ -15863,24 +15985,24 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/CreateVpnConnectionRouteRequest" examples: ex1: value: - VpnConnectionId: vpn-12345678 DestinationIpRange: 10.0.0.0/16 + VpnConnectionId: vpn-12345678 + schema: + "$ref": "#/components/schemas/CreateVpnConnectionRouteRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/CreateVpnConnectionRouteResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/CreateVpnConnectionRouteResponse" description: The HTTP 200 response (OK). tags: - VpnConnection @@ -15893,8 +16015,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteAccessKeyRequest" examples: ex1: summary: Deleting one of your own access keys (if you are the root @@ -15906,17 +16026,19 @@ paths: value: AccessKeyId: ABCDEFGHIJ0123456789 UserName: example-user + schema: + "$ref": "#/components/schemas/DeleteAccessKeyRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteAccessKeyResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteAccessKeyResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -15934,23 +16056,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteApiAccessRuleRequest" examples: ex1: value: ApiAccessRuleId: aar-1234567890abcdef1234567890abcdef + schema: + "$ref": "#/components/schemas/DeleteApiAccessRuleRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteApiAccessRuleResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteApiAccessRuleResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -15964,23 +16086,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteCaRequest" examples: ex1: value: CaId: ca-fedcba0987654321fedcba0987654321 + schema: + "$ref": "#/components/schemas/DeleteCaRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteCaResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteCaResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -15996,23 +16118,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteClientGatewayRequest" examples: ex1: value: ClientGatewayId: cgw-12345678 + schema: + "$ref": "#/components/schemas/DeleteClientGatewayRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteClientGatewayResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteClientGatewayResponse" description: The HTTP 200 response (OK). tags: - ClientGateway @@ -16033,8 +16155,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteDedicatedGroupRequest" examples: ex1: summary: Deleting a dedicated group without any resource in it. @@ -16046,17 +16166,19 @@ paths: value: DedicatedGroupId: ded-12345678 Force: true + schema: + "$ref": "#/components/schemas/DeleteDedicatedGroupRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteDedicatedGroupResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteDedicatedGroupResponse" description: The HTTP 200 response (OK). '400': content: @@ -16090,23 +16212,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteDhcpOptionsRequest" examples: ex1: value: DhcpOptionsSetId: dopt-12345678 + schema: + "$ref": "#/components/schemas/DeleteDhcpOptionsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteDhcpOptionsResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteDhcpOptionsResponse" description: The HTTP 200 response (OK). tags: - DhcpOption @@ -16119,23 +16241,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteDirectLinkRequest" examples: ex1: value: DirectLinkId: dxcon-12345678 + schema: + "$ref": "#/components/schemas/DeleteDirectLinkRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteDirectLinkResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteDirectLinkResponse" description: The HTTP 200 response (OK). tags: - DirectLink @@ -16146,23 +16268,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteDirectLinkInterfaceRequest" examples: ex1: value: DirectLinkInterfaceId: dxvif-12345678 + schema: + "$ref": "#/components/schemas/DeleteDirectLinkInterfaceRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteDirectLinkInterfaceResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteDirectLinkInterfaceResponse" description: The HTTP 200 response (OK). tags: - DirectLinkInterface @@ -16175,8 +16297,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteExportTaskRequest" examples: ex1: summary: Deleting an image export task @@ -16186,12 +16306,12 @@ paths: summary: Deleting a snapshot export task value: ExportTaskId: snap-export-12345678 + schema: + "$ref": "#/components/schemas/DeleteExportTaskRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteExportTaskResponse" examples: ex1: summary: Deleting an image export task @@ -16203,6 +16323,8 @@ paths: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteExportTaskResponse" description: The HTTP 200 response (OK). tags: - Task @@ -16215,23 +16337,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteFlexibleGpuRequest" examples: ex1: value: FlexibleGpuId: fgpu-12345678 + schema: + "$ref": "#/components/schemas/DeleteFlexibleGpuRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteFlexibleGpuResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteFlexibleGpuResponse" description: The HTTP 200 response (OK). tags: - FlexibleGpu @@ -16244,23 +16366,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteImageRequest" examples: ex1: value: ImageId: ami-12345678 + schema: + "$ref": "#/components/schemas/DeleteImageRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteImageResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteImageResponse" description: The HTTP 200 response (OK). '400': content: @@ -16291,23 +16413,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteInternetServiceRequest" examples: ex1: value: InternetServiceId: igw-12345678 + schema: + "$ref": "#/components/schemas/DeleteInternetServiceRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteInternetServiceResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteInternetServiceResponse" description: The HTTP 200 response (OK). '400': content: @@ -16338,8 +16460,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteKeypairRequest" examples: ex1: summary: Deleting a keypair with its name @@ -16349,17 +16469,19 @@ paths: summary: Deleting a keypair with its ID value: KeypairId: key-abcdef1234567890abcdef1234567890 + schema: + "$ref": "#/components/schemas/DeleteKeypairRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteKeypairResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteKeypairResponse" description: The HTTP 200 response (OK). '400': content: @@ -16390,23 +16512,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteListenerRuleRequest" examples: ex1: value: ListenerRuleName: example-listener-rule + schema: + "$ref": "#/components/schemas/DeleteListenerRuleRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteListenerRuleResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteListenerRuleResponse" description: The HTTP 200 response (OK). tags: - Listener @@ -16417,23 +16539,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteLoadBalancerRequest" examples: ex1: value: LoadBalancerName: example-lbu + schema: + "$ref": "#/components/schemas/DeleteLoadBalancerRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteLoadBalancerResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteLoadBalancerResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer @@ -16444,55 +16566,55 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteLoadBalancerListenersRequest" examples: ex1: value: LoadBalancerName: example-lbu LoadBalancerPorts: - 80 + schema: + "$ref": "#/components/schemas/DeleteLoadBalancerListenersRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteLoadBalancerListenersResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 LoadBalancer: - Tags: [] - SourceSecurityGroup: - SecurityGroupName: security-group-example - SecurityGroupAccountId: '123456789012' - SecuredCookies: false - Subnets: - - subnet-12345678 - NetId: vpc-12345678 - BackendVmIds: [] - ApplicationStickyCookiePolicies: [] - SecurityGroups: - - sg-12345678 - LoadBalancerType: internal AccessLog: - PublicationInterval: 60 IsEnabled: false + PublicationInterval: 60 + ApplicationStickyCookiePolicies: [] + BackendVmIds: [] DnsName: internal-example-lbu.123456789.eu-west-2.lbu.outscale.com HealthCheck: - UnhealthyThreshold: 2 - Timeout: 5 CheckInterval: 30 - Protocol: TCP HealthyThreshold: 10 Port: 80 + Protocol: TCP + Timeout: 5 + UnhealthyThreshold: 2 + Listeners: [] + LoadBalancerName: example-lbu LoadBalancerStickyCookiePolicies: [] + LoadBalancerType: internal + NetId: vpc-12345678 + SecuredCookies: false + SecurityGroups: + - sg-12345678 + SourceSecurityGroup: + SecurityGroupAccountId: '123456789012' + SecurityGroupName: security-group-example + Subnets: + - subnet-12345678 SubregionNames: - eu-west-2a - Listeners: [] - LoadBalancerName: example-lbu + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteLoadBalancerListenersResponse" description: The HTTP 200 response (OK). tags: - Listener @@ -16505,59 +16627,59 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteLoadBalancerPolicyRequest" examples: ex1: value: LoadBalancerName: example-lbu PolicyName: example-browser-policy + schema: + "$ref": "#/components/schemas/DeleteLoadBalancerPolicyRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteLoadBalancerPolicyResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 LoadBalancer: - Tags: [] - SourceSecurityGroup: - SecurityGroupName: default - SecurityGroupAccountId: '123456789012' - SecuredCookies: false - PublicIp: 192.0.2.0 - Subnets: - - subnet-12345678 - NetId: vpc-12345678 - BackendVmIds: [] - ApplicationStickyCookiePolicies: [] - SecurityGroups: - - sg-12345678 - LoadBalancerType: internet-facing AccessLog: - PublicationInterval: 60 IsEnabled: false + PublicationInterval: 60 + ApplicationStickyCookiePolicies: [] + BackendVmIds: [] 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 + Protocol: TCP + Timeout: 5 + UnhealthyThreshold: 2 Listeners: - BackendPort: 80 BackendProtocol: HTTP LoadBalancerPort: 80 LoadBalancerProtocol: HTTP LoadBalancerName: example-lbu + LoadBalancerStickyCookiePolicies: [] + LoadBalancerType: internet-facing + NetId: vpc-12345678 + PublicIp: 192.0.2.0 + SecuredCookies: false + SecurityGroups: + - sg-12345678 + SourceSecurityGroup: + SecurityGroupAccountId: '123456789012' + SecurityGroupName: default + Subnets: + - subnet-12345678 + SubregionNames: + - eu-west-2a + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteLoadBalancerPolicyResponse" description: The HTTP 200 response (OK). tags: - LoadBalancerPolicy @@ -16568,8 +16690,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteLoadBalancerTagsRequest" examples: ex1: value: @@ -16577,17 +16697,19 @@ paths: - example-lbu Tags: - Key: key1 + schema: + "$ref": "#/components/schemas/DeleteLoadBalancerTagsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteLoadBalancerTagsResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteLoadBalancerTagsResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer @@ -16600,23 +16722,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteNatServiceRequest" examples: ex1: value: NatServiceId: nat-12345678 + schema: + "$ref": "#/components/schemas/DeleteNatServiceRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteNatServiceResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteNatServiceResponse" description: The HTTP 200 response (OK). '400': content: @@ -16657,23 +16779,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteNetRequest" examples: ex1: value: NetId: vpc-12345678 + schema: + "$ref": "#/components/schemas/DeleteNetRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteNetResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteNetResponse" description: The HTTP 200 response (OK). '400': content: @@ -16704,23 +16826,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteNetAccessPointRequest" examples: ex1: value: NetAccessPointId: vpce-12345678 + schema: + "$ref": "#/components/schemas/DeleteNetAccessPointRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteNetAccessPointResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteNetAccessPointResponse" description: The HTTP 200 response (OK). tags: - NetAccessPoint @@ -16734,24 +16856,24 @@ paths: operationId: DeleteNetPeering requestBody: content: - application/json: - schema: - "$ref": "#/components/schemas/DeleteNetPeeringRequest" + application/json: examples: ex1: value: NetPeeringId: pcx-12345678 + schema: + "$ref": "#/components/schemas/DeleteNetPeeringRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteNetPeeringResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteNetPeeringResponse" description: The HTTP 200 response (OK). '400': content: @@ -16788,23 +16910,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteNicRequest" examples: ex1: value: NicId: eni-12345678 + schema: + "$ref": "#/components/schemas/DeleteNicRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteNicResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteNicResponse" description: The HTTP 200 response (OK). '400': content: @@ -16835,23 +16957,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeletePolicyRequest" examples: ex1: value: PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy + schema: + "$ref": "#/components/schemas/DeletePolicyRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeletePolicyResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeletePolicyResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -16863,24 +16985,24 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeletePolicyVersionRequest" examples: ex1: value: PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy VersionId: v1 + schema: + "$ref": "#/components/schemas/DeletePolicyVersionRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeletePolicyVersionResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeletePolicyVersionResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -16896,23 +17018,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteProductTypeRequest" examples: ex1: value: ProductTypeId: pty-12345678 + schema: + "$ref": "#/components/schemas/DeleteProductTypeRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteProductTypeResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteProductTypeResponse" description: The HTTP 200 response (OK). '400': content: @@ -16943,23 +17065,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeletePublicIpRequest" examples: ex1: value: PublicIp: 192.0.2.0 + schema: + "$ref": "#/components/schemas/DeletePublicIpRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeletePublicIpResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeletePublicIpResponse" description: The HTTP 200 response (OK). '400': content: @@ -16988,34 +17110,34 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteRouteRequest" examples: ex1: value: - RouteTableId: rtb-12345678 DestinationIpRange: 198.51.100.0/24 + RouteTableId: rtb-12345678 + schema: + "$ref": "#/components/schemas/DeleteRouteRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteRouteResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 RouteTable: - Routes: - - DestinationIpRange: 10.0.0.0/16 - CreationMethod: CreateRouteTable - State: active LinkRouteTables: [] NetId: vpc-12345678 - Tags: [] RoutePropagatingVirtualGateways: [] RouteTableId: rtb-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Routes: + - CreationMethod: CreateRouteTable + DestinationIpRange: 10.0.0.0/16 + State: active + Tags: [] + schema: + "$ref": "#/components/schemas/DeleteRouteResponse" description: The HTTP 200 response (OK). '400': content: @@ -17046,23 +17168,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteRouteTableRequest" examples: ex1: value: RouteTableId: rtb-12345678 + schema: + "$ref": "#/components/schemas/DeleteRouteTableRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteRouteTableResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteRouteTableResponse" description: The HTTP 200 response (OK). '400': content: @@ -17094,23 +17216,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteSecurityGroupRequest" examples: ex1: value: SecurityGroupId: sg-12345678 + schema: + "$ref": "#/components/schemas/DeleteSecurityGroupRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteSecurityGroupResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteSecurityGroupResponse" description: The HTTP 200 response (OK). '400': content: @@ -17143,75 +17265,75 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteSecurityGroupRuleRequest" examples: ex1: summary: Deleting an inbound rule from an IP range value: Flow: Inbound - SecurityGroupId: sg-12345678 FromPortRange: 80 - ToPortRange: 80 IpProtocol: tcp IpRange: 10.0.0.0/16 + SecurityGroupId: sg-12345678 + ToPortRange: 80 ex2: summary: Deleting an inbound rule from another security group value: Flow: Inbound - SecurityGroupId: sg-12345678 Rules: - FromPortRange: 22 - ToPortRange: 22 IpProtocol: tcp SecurityGroupsMembers: - AccountId: '123456789012' SecurityGroupName: another-security-group + ToPortRange: 22 + SecurityGroupId: sg-12345678 + schema: + "$ref": "#/components/schemas/DeleteSecurityGroupRuleRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteSecurityGroupRuleResponse" examples: ex1: summary: Deleting an inbound rule from an IP range value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 SecurityGroup: - Tags: [] - SecurityGroupName: security-group-example + AccountId: '123456789012' + Description: Example of security group + InboundRules: [] + NetId: vpc-12345678 OutboundRules: - FromPortRange: -1 IpProtocol: "-1" - ToPortRange: -1 IpRanges: - 0.0.0.0/0 + ToPortRange: -1 SecurityGroupId: sg-12345678 - AccountId: '123456789012' - Description: Example of security group - InboundRules: [] - NetId: vpc-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + SecurityGroupName: security-group-example + Tags: [] ex2: summary: Creating an inbound rule from another security group value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 SecurityGroup: - Tags: [] - SecurityGroupName: security-group-example + AccountId: '123456789012' + Description: Example of security group + InboundRules: [] + NetId: vpc-12345678 OutboundRules: - FromPortRange: -1 IpProtocol: "-1" - ToPortRange: -1 IpRanges: - 0.0.0.0/0 + ToPortRange: -1 SecurityGroupId: sg-12345678 - AccountId: '123456789012' - Description: Example of security group - InboundRules: [] - NetId: vpc-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + SecurityGroupName: security-group-example + Tags: [] + schema: + "$ref": "#/components/schemas/DeleteSecurityGroupRuleResponse" description: The HTTP 200 response (OK). '400': content: @@ -17240,23 +17362,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteServerCertificateRequest" examples: ex1: value: Name: server-cert-example + schema: + "$ref": "#/components/schemas/DeleteServerCertificateRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteServerCertificateResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteServerCertificateResponse" description: The HTTP 200 response (OK). tags: - ServerCertificate @@ -17269,23 +17391,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteSnapshotRequest" examples: ex1: value: SnapshotId: snap-12345678 + schema: + "$ref": "#/components/schemas/DeleteSnapshotRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteSnapshotResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteSnapshotResponse" description: The HTTP 200 response (OK). '400': content: @@ -17321,23 +17443,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteSubnetRequest" examples: ex1: value: SubnetId: subnet-12345678 + schema: + "$ref": "#/components/schemas/DeleteSubnetRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteSubnetResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteSubnetResponse" description: The HTTP 200 response (OK). '400': content: @@ -17366,8 +17488,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteTagsRequest" examples: ex1: value: @@ -17376,17 +17496,19 @@ paths: Tags: - Key: key1 Value: value1 + schema: + "$ref": "#/components/schemas/DeleteTagsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteTagsResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteTagsResponse" description: The HTTP 200 response (OK). '400': content: @@ -17416,23 +17538,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteUserRequest" examples: ex1: value: UserName: example-user + schema: + "$ref": "#/components/schemas/DeleteUserRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteUserResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteUserResponse" description: The HTTP 200 response (OK). tags: - User @@ -17448,25 +17570,25 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteUserGroupRequest" examples: ex1: value: Force: false Path: "/example/" UserGroupName: example-usergroup + schema: + "$ref": "#/components/schemas/DeleteUserGroupRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteUserGroupResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteUserGroupResponse" description: The HTTP 200 response (OK). tags: - UserGroup @@ -17477,25 +17599,25 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteUserGroupPolicyRequest" examples: ex1: value: PolicyName: example-usergroup-policy UserGroupName: example-usergroup UserGroupPath: "/example/" + schema: + "$ref": "#/components/schemas/DeleteUserGroupPolicyRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteUserGroupPolicyResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteUserGroupPolicyResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -17506,24 +17628,24 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteUserPolicyRequest" examples: ex1: value: PolicyName: example-user-policy UserName: example-user + schema: + "$ref": "#/components/schemas/DeleteUserPolicyRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteUserPolicyResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteUserPolicyResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -17536,23 +17658,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteVirtualGatewayRequest" examples: ex1: value: VirtualGatewayId: vgw-12345678 + schema: + "$ref": "#/components/schemas/DeleteVirtualGatewayRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteVirtualGatewayResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteVirtualGatewayResponse" description: The HTTP 200 response (OK). tags: - VirtualGateway @@ -17567,23 +17689,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteVmGroupRequest" examples: ex1: value: VmGroupId: vmgroup-12345678901234567890123456789012 + schema: + "$ref": "#/components/schemas/DeleteVmGroupRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteVmGroupResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteVmGroupResponse" description: The HTTP 200 response (OK). '400': content: @@ -17617,23 +17739,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteVmTemplateRequest" examples: ex1: value: VmTemplateId: vmtemplate-98765432109876543210987654321012 + schema: + "$ref": "#/components/schemas/DeleteVmTemplateRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteVmTemplateResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteVmTemplateResponse" description: The HTTP 200 response (OK). tags: - VmTemplate @@ -17646,28 +17768,28 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteVmsRequest" examples: ex1: value: VmIds: - i-12345678 + schema: + "$ref": "#/components/schemas/DeleteVmsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteVmsResponse" examples: ex1: value: - Vms: - - VmId: i-12345678 - PreviousState: running - CurrentState: shutting-down ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Vms: + - CurrentState: shutting-down + PreviousState: running + VmId: i-12345678 + schema: + "$ref": "#/components/schemas/DeleteVmsResponse" description: The HTTP 200 response (OK). '400': content: @@ -17698,23 +17820,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteVolumeRequest" examples: ex1: value: VolumeId: vol-12345678 + schema: + "$ref": "#/components/schemas/DeleteVolumeRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteVolumeResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteVolumeResponse" description: The HTTP 200 response (OK). '400': content: @@ -17745,23 +17867,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteVpnConnectionRequest" examples: ex1: value: VpnConnectionId: vpn-12345678 + schema: + "$ref": "#/components/schemas/DeleteVpnConnectionRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteVpnConnectionResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteVpnConnectionResponse" description: The HTTP 200 response (OK). tags: - VpnConnection @@ -17773,24 +17895,24 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeleteVpnConnectionRouteRequest" examples: ex1: value: - VpnConnectionId: vpn-12345678 DestinationIpRange: 10.0.0.0/16 + VpnConnectionId: vpn-12345678 + schema: + "$ref": "#/components/schemas/DeleteVpnConnectionRouteRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeleteVpnConnectionRouteResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeleteVpnConnectionRouteResponse" description: The HTTP 200 response (OK). tags: - VpnConnection @@ -17805,26 +17927,26 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/DeregisterVmsInLoadBalancerRequest" examples: ex1: value: - LoadBalancerName: example-lbu BackendVmIds: - i-12345678 - i-87654321 + LoadBalancerName: example-lbu + schema: + "$ref": "#/components/schemas/DeregisterVmsInLoadBalancerRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/DeregisterVmsInLoadBalancerResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/DeregisterVmsInLoadBalancerResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer @@ -17840,24 +17962,24 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/LinkFlexibleGpuRequest" examples: ex1: value: FlexibleGpuId: fgpu-12345678 VmId: i-12345678 + schema: + "$ref": "#/components/schemas/LinkFlexibleGpuRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/LinkFlexibleGpuResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/LinkFlexibleGpuResponse" description: The HTTP 200 response (OK). tags: - FlexibleGpu @@ -17870,24 +17992,24 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/LinkInternetServiceRequest" examples: ex1: value: InternetServiceId: igw-12345678 NetId: vpc-12345678 + schema: + "$ref": "#/components/schemas/LinkInternetServiceRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/LinkInternetServiceResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/LinkInternetServiceResponse" description: The HTTP 200 response (OK). '400': content: @@ -17918,29 +18040,27 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/LinkLoadBalancerBackendMachinesRequest" examples: ex1: summary: Linking VMs to a load balancer value: - LoadBalancerName: example-lbu BackendVmIds: - i-12345678 - i-87654321 + LoadBalancerName: example-lbu ex2: summary: Linking public IPs to a load balancer value: - LoadBalancerName: example-lbu BackendIps: - 192.0.2.0 - 198.51.100.0 + LoadBalancerName: example-lbu + schema: + "$ref": "#/components/schemas/LinkLoadBalancerBackendMachinesRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/LinkLoadBalancerBackendMachinesResponse" examples: ex1: summary: Linking VMs to a load balancer @@ -17952,6 +18072,8 @@ paths: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/LinkLoadBalancerBackendMachinesResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer @@ -17963,24 +18085,24 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/LinkManagedPolicyToUserGroupRequest" examples: ex1: value: PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy UserGroupName: example-usergroup + schema: + "$ref": "#/components/schemas/LinkManagedPolicyToUserGroupRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/LinkManagedPolicyToUserGroupResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/LinkManagedPolicyToUserGroupResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -17993,26 +18115,26 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/LinkNicRequest" examples: ex1: value: + DeviceNumber: 1 NicId: eni-12345678 VmId: i-12345678 - DeviceNumber: 1 + schema: + "$ref": "#/components/schemas/LinkNicRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/LinkNicResponse" examples: ex1: value: + LinkNicId: eni-attach-12345678 ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - LinkNicId: eni-attach-12345678 + schema: + "$ref": "#/components/schemas/LinkNicResponse" description: The HTTP 200 response (OK). '400': content: @@ -18041,24 +18163,24 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/LinkPolicyRequest" examples: ex1: value: PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy UserName: example-user + schema: + "$ref": "#/components/schemas/LinkPolicyRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/LinkPolicyResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/LinkPolicyResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -18075,8 +18197,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/LinkPrivateIpsRequest" examples: ex1: summary: Linking specific secondary private IPs to a NIC @@ -18090,17 +18210,19 @@ paths: value: NicId: eni-12345678 SecondaryPrivateIpCount: 3 + schema: + "$ref": "#/components/schemas/LinkPrivateIpsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/LinkPrivateIpsResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/LinkPrivateIpsResponse" description: The HTTP 200 response (OK). '400': content: @@ -18135,8 +18257,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/LinkPublicIpRequest" examples: ex1: summary: Linking a public IP to a VM @@ -18146,27 +18266,29 @@ paths: ex2: summary: Linking a public IP to a NIC value: - PublicIp: 192.0.2.0 NicId: eni-12345678 + PublicIp: 192.0.2.0 + schema: + "$ref": "#/components/schemas/LinkPublicIpRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/LinkPublicIpResponse" examples: ex1: summary: Linking a public IP to a VM value: + LinkPublicIpId: eipassoc-12345678 ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - LinkPublicIpId: eipassoc-12345678 ex2: summary: Linking a public IP to a NIC value: + LinkPublicIpId: eipassoc-12345678 ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - LinkPublicIpId: eipassoc-12345678 + schema: + "$ref": "#/components/schemas/LinkPublicIpResponse" description: The HTTP 200 response (OK). '400': content: @@ -18197,25 +18319,25 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/LinkRouteTableRequest" examples: ex1: value: RouteTableId: rtb-12345678 SubnetId: subnet-12345678 + schema: + "$ref": "#/components/schemas/LinkRouteTableRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/LinkRouteTableResponse" examples: ex1: value: + LinkRouteTableId: rtbassoc-12345678 ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - LinkRouteTableId: rtbassoc-12345678 + schema: + "$ref": "#/components/schemas/LinkRouteTableResponse" description: The HTTP 200 response (OK). '400': content: @@ -18248,27 +18370,27 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/LinkVirtualGatewayRequest" examples: ex1: value: - VirtualGatewayId: vgw-12345678 NetId: vpc-12345678 + VirtualGatewayId: vgw-12345678 + schema: + "$ref": "#/components/schemas/LinkVirtualGatewayRequest" 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 + State: attached + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/LinkVirtualGatewayResponse" description: The HTTP 200 response (OK). tags: - VirtualGateway @@ -18281,25 +18403,25 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/LinkVolumeRequest" examples: ex1: value: - VolumeId: vol-12345678 - VmId: i-12345678 DeviceName: "/dev/sdb" + VmId: i-12345678 + VolumeId: vol-12345678 + schema: + "$ref": "#/components/schemas/LinkVolumeRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/LinkVolumeResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/LinkVolumeResponse" description: The HTTP 200 response (OK). '400': content: @@ -18330,8 +18452,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/PutUserGroupPolicyRequest" examples: ex1: value: @@ -18340,17 +18460,19 @@ paths: PolicyName: example-usergroup-policy UserGroupName: example-usergroup UserGroupPath: "/example/" + schema: + "$ref": "#/components/schemas/PutUserGroupPolicyRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/PutUserGroupPolicyResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/PutUserGroupPolicyResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -18363,8 +18485,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/PutUserPolicyRequest" examples: ex1: value: @@ -18372,17 +18492,19 @@ paths: "Resource": ["*"]} ]}' PolicyName: example-user-policy UserName: example-user + schema: + "$ref": "#/components/schemas/PutUserPolicyRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/PutUserPolicyResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/PutUserPolicyResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -18393,8 +18515,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadAccessKeysRequest" examples: ex1: value: @@ -18403,24 +18523,26 @@ paths: - ACTIVE Tag: Group1 UserName: example-user + schema: + "$ref": "#/components/schemas/ReadAccessKeysRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadAccessKeysResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 AccessKeys: - - State: ACTIVE - AccessKeyId: ABCDEFGHIJ0123456789 + - AccessKeyId: ABCDEFGHIJ0123456789 CreationDate: 2010-10-01 12:34:56.789000000 +00:00 ExpirationDate: 2063-04-05 00:00:00.000000000 +00:00 LastModificationDate: 2010-10-01 12:34:56.789000000 +00:00 + State: ACTIVE Tag: Group1 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadAccessKeysResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -18434,32 +18556,32 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadAccountsRequest" examples: ex1: value: {} + schema: + "$ref": "#/components/schemas/ReadAccountsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadAccountsResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Accounts: - - ZipCode: '92210' - CompanyName: EXAMPLE SAS - FirstName: JEAN + - AccountId: '123456789012' City: SAINT-CLOUD + CompanyName: EXAMPLE SAS Country: FRANCE - LastName: DUPONT - AccountId: '123456789012' CustomerId: '87654321' Email: example@example.com + FirstName: JEAN + LastName: DUPONT + ZipCode: '92210' + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadAccountsResponse" description: The HTTP 200 response (OK). tags: - Account @@ -18476,25 +18598,25 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadAdminPasswordRequest" examples: ex1: value: VmId: i-12345678 + schema: + "$ref": "#/components/schemas/ReadAdminPasswordRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadAdminPasswordResponse" examples: ex1: value: - VmId: i-12345678 + AdminPassword: "..." ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - AdminPassword: "..." + VmId: i-12345678 + schema: + "$ref": "#/components/schemas/ReadAdminPasswordResponse" description: The HTTP 200 response (OK). '400': content: @@ -18525,25 +18647,25 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadApiAccessPolicyRequest" examples: ex1: value: {} + schema: + "$ref": "#/components/schemas/ReadApiAccessPolicyRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadApiAccessPolicyResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ApiAccessPolicy: - RequireTrustedEnv: false MaxAccessKeyExpirationSeconds: 0 + RequireTrustedEnv: false + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadApiAccessPolicyResponse" description: The HTTP 200 response (OK). '400': content: @@ -18575,38 +18697,38 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadApiAccessRulesRequest" examples: ex1: value: Filters: ApiAccessRuleIds: - aar-1234567890abcdef1234567890abcdef + schema: + "$ref": "#/components/schemas/ReadApiAccessRulesRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadApiAccessRulesResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ApiAccessRules: - - IpRanges: - - 0.0.0.0/0 - ApiAccessRuleId: aar-1234567890abcdef1234567890abcdef + - ApiAccessRuleId: aar-1234567890abcdef1234567890abcdef CaIds: [] Cns: [] Description: Allows all IPv4 domain - - IpRanges: - - 46.231.144.178/32 - ApiAccessRuleId: aar-abcdef1234567890abcdef1234567890 + IpRanges: + - 0.0.0.0/0 + - ApiAccessRuleId: aar-abcdef1234567890abcdef1234567890 CaIds: [] Cns: [] Description: Allows Outscale Cockpit of this region + IpRanges: + - 46.231.144.178/32 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadApiAccessRulesResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -18626,49 +18748,49 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadApiLogsRequest" examples: ex1: value: Filters: + QueryDateAfter: '2017-05-10' + QueryDateBefore: '2017-05-10' QueryIpAddresses: - 192.0.2.0 - 198.51.100.0 - QueryDateAfter: '2017-05-10' - QueryDateBefore: '2017-05-10' + schema: + "$ref": "#/components/schemas/ReadApiLogsRequest" 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 + - AccountId: '123456789012' CallDuration: 47 - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + QueryAccessKey: ABCDEFGHIJ0123456789 + QueryApiName: oapi QueryApiVersion: '1.27' - AccountId: '123456789012' - QueryPayloadSize: 2 QueryCallName: ReadAccessKeys - QueryAccessKey: ABCDEFGHIJ0123456789 - QueryHeaderSize: 287 QueryDate: '2017-05-10T12:34:56.789Z' QueryHeaderRaw: 'Host: api.eu-west-2.outscale.com\nAccept: */*\nConnection: close\nUser-Agent: oAPI CLI v0.1 - 2018-09-28\nX-Osc-Date: 20170510T000000Z\nContent-Type: application/json; charset=utf-8\nAuthorization: *****\nContent-Length: 2\nAccept-Encoding: gzip, deflate\nX-Forwarded-For: 192.0.2.0' + QueryHeaderSize: 287 + QueryIpAddress: 192.0.2.0 + QueryPayloadRaw: "{}" + QueryPayloadSize: 2 + QueryUserAgent: oAPI CLI v0.1 - 2018-09-28 + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ResponseSize: 1887 + ResponseStatusCode: 200 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadApiLogsResponse" description: The HTTP 200 response (OK). tags: - ApiLog @@ -18680,29 +18802,29 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadCasRequest" examples: ex1: value: Filters: CaIds: - ca-fedcba0987654321fedcba0987654321 + schema: + "$ref": "#/components/schemas/ReadCasRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadCasResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Cas: - - Description: CA example + - CaFingerprint: 1234567890abcdef1234567890abcdef12345678 CaId: ca-fedcba0987654321fedcba0987654321 - CaFingerprint: 1234567890abcdef1234567890abcdef12345678 + Description: CA example + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadCasResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -18716,32 +18838,32 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadCatalogRequest" examples: ex1: value: {} + schema: + "$ref": "#/components/schemas/ReadCatalogRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadCatalogResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Catalog: Entries: - - UnitPrice: 0.04 - Type: CustomCore:v5-p1 + - Category: compute + Operation: RunInstances-OD + Service: TinaOS-FCU + SubregionName: eu-west-2 Title: Instance - On demand - Unite de vCore pour une instance Tina v5 CxRy Performance highest - par heure - SubregionName: eu-west-2 - Category: compute - Service: TinaOS-FCU - Operation: RunInstances-OD + Type: CustomCore:v5-p1 + UnitPrice: 0.04 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadCatalogResponse" description: The HTTP 200 response (OK). tags: - Catalog @@ -18753,8 +18875,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadCatalogsRequest" examples: ex1: value: @@ -18762,29 +18882,31 @@ paths: CurrentCatalogOnly: true FromDate: '2021-01-01' ToDate: '2023-01-01' + schema: + "$ref": "#/components/schemas/ReadCatalogsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadCatalogsResponse" examples: ex1: value: - 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 + - Entries: + - Category: compute + Operation: RunInstances-OD + Service: TinaOS-FCU + SubregionName: eu-west-2 Title: Instance - On demand - Unite de vCore pour une instance Tina v5 CxRy Performance highest - par heure - SubregionName: eu-west-2 - Category: compute - Service: TinaOS-FCU - Operation: RunInstances-OD + Type: CustomCore:v5-p1 + UnitPrice: 0.04 + FromDate: 2021-01-01 00:00:00.000000000 +00:00 + State: CURRENT + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadCatalogsResponse" description: The HTTP 200 response (OK). tags: - Catalog @@ -18795,8 +18917,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadClientGatewaysRequest" examples: ex1: value: @@ -18811,24 +18931,26 @@ paths: PublicIps: - 192.0.2.0 - 198.51.100.0 + schema: + "$ref": "#/components/schemas/ReadClientGatewaysRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadClientGatewaysResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ClientGateways: - - State: available - BgpAsn: 65000 - Tags: [] + - BgpAsn: 65000 ClientGatewayId: cgw-12345678 ConnectionType: ipsec.1 PublicIp: 192.0.2.0 + State: available + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadClientGatewaysResponse" description: The HTTP 200 response (OK). tags: - ClientGateway @@ -18843,25 +18965,25 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadConsoleOutputRequest" examples: ex1: value: VmId: i-12345678 + schema: + "$ref": "#/components/schemas/ReadConsoleOutputRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadConsoleOutputResponse" examples: ex1: value: - VmId: i-12345678 + ConsoleOutput: "..." ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - ConsoleOutput: "..." + VmId: i-12345678 + schema: + "$ref": "#/components/schemas/ReadConsoleOutputResponse" description: The HTTP 200 response (OK). '400': content: @@ -18891,41 +19013,41 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadConsumptionAccountRequest" examples: ex1: value: FromDate: '2023-06-01' - ToDate: '2023-07-01' ShowPrice: true + ToDate: '2023-07-01' + schema: + "$ref": "#/components/schemas/ReadConsumptionAccountRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadConsumptionAccountResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ConsumptionEntries: - - UnitPrice: 0.044 - Type: BoxUsage:tinav4.c1r1p2 + - AccountId: '123456789012' + Category: compute + FromDate: 2023-06-01 00:00:00.000000000 +00:00 Operation: RunInstances-OD + PayingAccountId: '123456789012' + Price: 61.248 + Service: TinaOS-FCU SubregionName: eu-west-2a - Value: 1392 Title: Instance - On demand - tinav4.c1r1 high performance - par heure - Category: compute ToDate: 2023-06-30 00:00:00.000000000 +00:00 - Service: TinaOS-FCU - AccountId: '123456789012' - PayingAccountId: '123456789012' - FromDate: 2023-06-01 00:00:00.000000000 +00:00 - Price: 61.248 + Type: BoxUsage:tinav4.c1r1p2 + UnitPrice: 0.044 + Value: 1392 Currency: EUR + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadConsumptionAccountResponse" description: The HTTP 200 response (OK). tags: - Account @@ -18940,8 +19062,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadDedicatedGroupsRequest" examples: ex1: summary: Filtering on a specific dedicated group @@ -18953,30 +19073,32 @@ paths: summary: Filtering on a specific Subregion and CPU generation value: Filters: - SubregionNames: - - eu-west-2a CpuGenerations: - 4 + SubregionNames: + - eu-west-2a + schema: + "$ref": "#/components/schemas/ReadDedicatedGroupsRequest" 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' + - AccountId: '123456789012' CpuGeneration: 4 + DedicatedGroupId: ded-12345678 Name: dedicated-group-example + NetIds: [] SubregionName: eu-west-2a - DedicatedGroupId: ded-12345678 + VmIds: + - i-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadDedicatedGroupsResponse" description: The HTTP 200 response (OK). '400': content: @@ -19005,8 +19127,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadDhcpOptionsRequest" examples: ex1: value: @@ -19021,28 +19141,30 @@ paths: - 198.51.100.0 DomainNames: - example.com + schema: + "$ref": "#/components/schemas/ReadDhcpOptionsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadDhcpOptionsResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 DhcpOptionsSets: - - Tags: [] - NtpServers: - - 203.0.113.0 - - 203.0.113.1 - Default: false + - Default: false DhcpOptionsSetId: dopt-12345678 DomainName: example.com DomainNameServers: - 192.0.2.0 - 198.51.100.0 + NtpServers: + - 203.0.113.0 + - 203.0.113.1 + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadDhcpOptionsResponse" description: The HTTP 200 response (OK). tags: - DhcpOption @@ -19053,39 +19175,39 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadDirectLinkInterfacesRequest" examples: ex1: value: Filters: DirectLinkInterfaceIds: - dxvif-12345678 + schema: + "$ref": "#/components/schemas/ReadDirectLinkInterfacesRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadDirectLinkInterfacesResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 DirectLinkInterfaces: - - Vlan: 101 - OutscalePrivateIp: 172.16.0.4/30 - DirectLinkInterfaceId: dxvif-12345678 + - AccountId: '123456789012' BgpAsn: 65000 - AccountId: '123456789012' ClientPrivateIp: 172.16.0.5/30 - VirtualGatewayId: vgw-12345678 - DirectLinkInterfaceName: MyDirectLinkInterface DirectLinkId: dxcon-12345678 - Mtu: 1500 - State: available + DirectLinkInterfaceId: dxvif-12345678 + DirectLinkInterfaceName: MyDirectLinkInterface InterfaceType: private Location: PAR1 + Mtu: 1500 + OutscalePrivateIp: 172.16.0.4/30 + State: available + VirtualGatewayId: vgw-12345678 + Vlan: 101 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadDirectLinkInterfacesResponse" description: The HTTP 200 response (OK). tags: - DirectLinkInterface @@ -19096,25 +19218,21 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadDirectLinksRequest" examples: ex1: value: Filters: DirectLinkIds: - dxcon-12345678 + schema: + "$ref": "#/components/schemas/ReadDirectLinksRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadDirectLinksResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 DirectLinks: - AccountId: '123456789012' Bandwidth: 1Gbps @@ -19123,6 +19241,10 @@ paths: Location: PAR1 RegionName: eu-west-2 State: available + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadDirectLinksResponse" description: The HTTP 200 response (OK). tags: - DirectLink @@ -19134,8 +19256,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadEntitiesLinkedToPolicyRequest" examples: ex1: summary: Reading all entities linked to a specific policy @@ -19148,23 +19268,17 @@ paths: EntitiesType: - USER PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy + schema: + "$ref": "#/components/schemas/ReadEntitiesLinkedToPolicyRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadEntitiesLinkedToPolicyResponse" examples: ex1: summary: Reading all entities linked to a specific policy value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 PolicyEntities: - Users: - - Id: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 - Name: example-user - Orn: orn:ows:idauth::012345678910:user/example/user-example Groups: - Id: ug-12345678 Name: example-usergroup @@ -19173,16 +19287,24 @@ paths: ItemsCount: 3 MaxResultsLimit: 100 MaxResultsTruncated: false + Users: + - Id: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 + Name: example-user + Orn: orn:ows:idauth::012345678910:user/example/user-example + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Reading only users linked to a specific policy value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 PolicyEntities: Users: - Id: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 Name: example-user Orn: orn:ows:idauth::012345678910:user/example/user-example + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadEntitiesLinkedToPolicyResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -19193,29 +19315,29 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadFlexibleGpuCatalogRequest" examples: ex1: value: {} + schema: + "$ref": "#/components/schemas/ReadFlexibleGpuCatalogRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadFlexibleGpuCatalogResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 FlexibleGpuCatalog: - - VRam: 16000 - Generations: + - Generations: - v5 MaxCpu: 80 MaxRam: 512 ModelName: nvidia-p100 + VRam: 16000 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadFlexibleGpuCatalogResponse" description: The HTTP 200 response (OK). security: [] tags: @@ -19227,8 +19349,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadFlexibleGpusRequest" examples: ex1: value: @@ -19243,17 +19363,15 @@ paths: - nvidia-p100 States: - attached + schema: + "$ref": "#/components/schemas/ReadFlexibleGpusRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadFlexibleGpusResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 FlexibleGpus: - DeleteOnVmDeletion: true FlexibleGpuId: fgpu-12345678 @@ -19262,6 +19380,10 @@ paths: State: attached SubregionName: eu-west-2a VmId: i-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadFlexibleGpusResponse" description: The HTTP 200 response (OK). tags: - FlexibleGpu @@ -19272,36 +19394,36 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadImageExportTasksRequest" examples: ex1: value: Filters: TaskIds: - image-export-12345678 + schema: + "$ref": "#/components/schemas/ReadImageExportTasksRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadImageExportTasksResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ImageExportTasks: - - Tags: [] + - Comment: Export of image ami-12345678 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 + OsuBucket: BUCKET + OsuPrefix: PREFIX/ami-12345678/ Progress: 0 + State: pending/queued + Tags: [] + TaskId: image-export-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadImageExportTasksResponse" description: The HTTP 200 response (OK). tags: - Image @@ -19312,8 +19434,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadImagesRequest" examples: ex1: summary: Reading a specific image @@ -19330,102 +19450,110 @@ paths: ImageNames: - Ubuntu* - RockyLinux* + schema: + "$ref": "#/components/schemas/ReadImagesRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadImagesResponse" examples: ex1: summary: Reading a specific image value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Images: - - StateComment: {} - State: available - RootDeviceType: bsu - RootDeviceName: "/dev/sda1" - ProductCodes: - - '0001' - PermissionsToLaunch: - GlobalPermission: false - AccountIds: [] - AccountId: '123456789012' - Tags: [] - Description: '' - ImageId: ami-12345678 + - AccountId: '123456789012' + Architecture: x86_64 BlockDeviceMappings: - - DeviceName: "/dev/sda1" - Bsu: - VolumeType: standard + - Bsu: DeleteOnVmDeletion: true - VolumeSize: 50 SnapshotId: snap-12345678 - ImageType: machine + VolumeSize: 50 + VolumeType: standard + DeviceName: "/dev/sda1" + BootModes: + - legacy CreationDate: '2010-10-01T12:34:56.789Z' + Description: '' FileLocation: 123456789012/create-image-example - Architecture: x86_64 + ImageId: ami-12345678 ImageName: create-image-example + ImageType: machine + PermissionsToLaunch: + AccountIds: [] + GlobalPermission: false + ProductCodes: + - '0001' + RootDeviceName: "/dev/sda1" + RootDeviceType: bsu + SecureBoot: false + State: available + StateComment: {} + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 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: [] + - AccountAlias: Outscale AccountId: '123456789012' - Tags: [] - Description: '' - ImageId: ami-12345678 + Architecture: x86_64 BlockDeviceMappings: - - DeviceName: "/dev/sda1" - Bsu: - VolumeType: standard + - Bsu: DeleteOnVmDeletion: true - VolumeSize: 10 SnapshotId: snap-12345678 - ImageType: machine - AccountAlias: Outscale + VolumeSize: 10 + VolumeType: standard + DeviceName: "/dev/sda1" CreationDate: '2010-10-01T12:34:56.789Z' + Description: '' FileLocation: Outscale/Ubuntu-2010.10.01-0 - Architecture: x86_64 + ImageId: ami-12345678 ImageName: Ubuntu-2010.10.01-0 - - StateComment: {} - State: available - RootDeviceType: bsu - RootDeviceName: "/dev/sda1" - ProductCodes: - - '0001' + ImageType: machine PermissionsToLaunch: - GlobalPermission: true AccountIds: [] - AccountId: '123456789012' + GlobalPermission: true + ProductCodes: + - '0001' + RootDeviceName: "/dev/sda1" + RootDeviceType: bsu + State: available + StateComment: {} Tags: [] - Description: '' - ImageId: ami-12345678 + - AccountAlias: Outscale + AccountId: '123456789012' + Architecture: x86_64 BlockDeviceMappings: - - DeviceName: "/dev/sda1" - Bsu: - VolumeType: standard + - Bsu: DeleteOnVmDeletion: true - VolumeSize: 10 SnapshotId: snap-12345678 - ImageType: machine - AccountAlias: Outscale + VolumeSize: 10 + VolumeType: standard + DeviceName: "/dev/sda1" + BootModes: + - legacy CreationDate: '2010-10-01T12:34:56.789Z' + Description: '' FileLocation: Outscale/RockyLinux-2010.10.01-0 - Architecture: x86_64 + ImageId: ami-12345678 ImageName: RockyLinux-2010.10.01-0 + ImageType: machine + PermissionsToLaunch: + AccountIds: [] + GlobalPermission: true + ProductCodes: + - '0001' + RootDeviceName: "/dev/sda1" + RootDeviceType: bsu + SecureBoot: false + State: available + StateComment: {} + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadImagesResponse" description: The HTTP 200 response (OK). '400': content: @@ -19456,8 +19584,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadInternetServicesRequest" examples: ex1: value: @@ -19472,24 +19598,26 @@ paths: TagValues: - prod - test + schema: + "$ref": "#/components/schemas/ReadInternetServicesRequest" 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 + - InternetServiceId: igw-12345678 NetId: vpc-12345678 - InternetServiceId: igw-12345678 + State: available + Tags: + - Key: env + Value: prod + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadInternetServicesResponse" description: The HTTP 200 response (OK). '400': content: @@ -19518,30 +19646,30 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadKeypairsRequest" examples: ex1: value: Filters: KeypairNames: - keypair-example + schema: + "$ref": "#/components/schemas/ReadKeypairsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadKeypairsResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Keypairs: - - KeypairType: ssh-rsa - KeypairName: keypair-example + - KeypairFingerprint: 11:22:33:44:55:66:77:88:99:00:aa:bb:cc:dd:ee:ff KeypairId: key-abcdef1234567890abcdef1234567890 - KeypairFingerprint: 11:22:33:44:55:66:77:88:99:00:aa:bb:cc:dd:ee:ff + KeypairName: keypair-example + KeypairType: ssh-rsa + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadKeypairsResponse" description: The HTTP 200 response (OK). '400': content: @@ -19570,8 +19698,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadLinkedPoliciesRequest" examples: ex1: value: @@ -19580,26 +19706,28 @@ paths: FirstItem: 1 ResultsPerPage: 30 UserName: example-user + schema: + "$ref": "#/components/schemas/ReadLinkedPoliciesRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadLinkedPoliciesResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 HasMoreItems: true + MaxResultsLimit: 30 + MaxResultsTruncated: false Policies: - - PolicyName: example-user-policy - CreationDate: 2010-10-01 12:34:56.789000000 +00:00 + - CreationDate: 2010-10-01 12:34:56.789000000 +00:00 LastModificationDate: 2010-10-01 12:34:56.789000000 +00:00 Orn: orn:ows:idauth::012345678910:policy/example/example-user-policy PolicyId: ABCDEFGHIJKLMNOPQRSTUVWXYZ01234 - MaxResultsLimit: 30 - MaxResultsTruncated: false + PolicyName: example-user-policy + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadLinkedPoliciesResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -19611,34 +19739,34 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadListenerRulesRequest" examples: ex1: value: Filters: ListenerRuleNames: - example-listener-rule + schema: + "$ref": "#/components/schemas/ReadListenerRulesRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadListenerRulesResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ListenerRules: - - Priority: 10 - VmIds: - - i-12345678 - ListenerRuleName: example-listener-rule - Action: forward - ListenerId: 123456 + - Action: forward HostNamePattern: "*.example.com" + ListenerId: 123456 ListenerRuleId: 1234 + ListenerRuleName: example-listener-rule + Priority: 10 + VmIds: + - i-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadListenerRulesResponse" description: The HTTP 200 response (OK). tags: - Listener @@ -19649,28 +19777,28 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadLoadBalancerTagsRequest" examples: ex1: value: LoadBalancerNames: - private-lb-example + schema: + "$ref": "#/components/schemas/ReadLoadBalancerTagsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadLoadBalancerTagsResponse" examples: ex1: value: - Tags: - - Value: value1 - LoadBalancerName: private-lb-example - Key: key1 ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Tags: + - Key: key1 + LoadBalancerName: private-lb-example + Value: value1 + schema: + "$ref": "#/components/schemas/ReadLoadBalancerTagsResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer @@ -19681,61 +19809,61 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadLoadBalancersRequest" examples: ex1: value: Filters: LoadBalancerNames: - private* + schema: + "$ref": "#/components/schemas/ReadLoadBalancersRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadLoadBalancersResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 LoadBalancers: - - 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 + - AccessLog: IsEnabled: false + PublicationInterval: 60 + ApplicationStickyCookiePolicies: [] + BackendVmIds: [] DnsName: private-lb-example.123456789.eu-west-2.lbu.outscale.com HealthCheck: - UnhealthyThreshold: 2 - Timeout: 5 CheckInterval: 30 - Protocol: TCP HealthyThreshold: 10 Port: 80 + Protocol: TCP + Timeout: 5 + UnhealthyThreshold: 2 + Listeners: + - BackendPort: 80 + BackendProtocol: HTTP + LoadBalancerPort: 443 + LoadBalancerProtocol: HTTPS + ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate + LoadBalancerName: private-lb-example LoadBalancerStickyCookiePolicies: [] + LoadBalancerType: internet-facing + NetId: vpc-12345678 + PublicIp: 192.0.2.0 + SecuredCookies: false + SecurityGroups: + - sg-12345678 + SourceSecurityGroup: + SecurityGroupAccountId: '123456789012' + SecurityGroupName: security-group-example + Subnets: + - subnet-12345678 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 + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadLoadBalancersResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer @@ -19748,27 +19876,27 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadLocationsRequest" examples: ex1: value: {} + schema: + "$ref": "#/components/schemas/ReadLocationsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadLocationsResponse" examples: ex1: value: + Locations: + - Code: PAR1 + Name: Telehouse 3, France + - Code: PAR4 + Name: Equinix Pantin, France ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - Locations: - - Name: Telehouse 3, France - Code: PAR1 - - Name: Equinix Pantin, France - Code: PAR4 + schema: + "$ref": "#/components/schemas/ReadLocationsResponse" description: The HTTP 200 response (OK). security: [] tags: @@ -19780,8 +19908,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadManagedPoliciesLinkedToUserGroupRequest" examples: ex1: value: @@ -19792,17 +19918,15 @@ paths: FirstItem: 1 ResultsPerPage: 30 UserGroupName: example-usergroup + schema: + "$ref": "#/components/schemas/ReadManagedPoliciesLinkedToUserGroupRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadManagedPoliciesLinkedToUserGroupResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 HasMoreItems: true MaxResultsLimit: 30 MaxResultsTruncated: true @@ -19812,6 +19936,10 @@ paths: Orn: orn:ows:idauth::012345678910:policy/example/example-user-policy PolicyId: ABCDEFGHIJKLMNOPQRSTUVWXYZ01234 PolicyName: example-policy + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadManagedPoliciesLinkedToUserGroupResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -19822,8 +19950,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadNatServicesRequest" examples: ex1: value: @@ -19838,26 +19964,28 @@ paths: - vpc-87654321 SubnetIds: - subnet-12345678 + schema: + "$ref": "#/components/schemas/ReadNatServicesRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadNatServicesResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 NatServices: - - Tags: [] - SubnetId: subnet-12345678 - NatServiceId: nat-12345678 - PublicIps: - - PublicIpId: eipalloc-12345678 - PublicIp: 192.0.2.0 + - NatServiceId: nat-12345678 NetId: vpc-12345678 + PublicIps: + - PublicIp: 192.0.2.0 + PublicIpId: eipalloc-12345678 State: available + SubnetId: subnet-12345678 + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadNatServicesResponse" description: The HTTP 200 response (OK). '400': content: @@ -19888,8 +20016,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadNetAccessPointServicesRequest" examples: ex1: summary: Listing one or more services according to their service IDs @@ -19904,41 +20030,43 @@ paths: Filters: ServiceNames: - com.outscale.eu-west-2.api + schema: + "$ref": "#/components/schemas/ReadNetAccessPointServicesRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadNetAccessPointServicesResponse" examples: ex1: summary: Listing one or more services according to their service IDs value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Services: - - ServiceName: com.outscale.eu-west-2.api - ServiceId: pl-12345678 - IpRanges: + - IpRanges: - 192.0.2.0 - - ServiceName: com.outscale.eu-west-2.oos - ServiceId: pl-87654321 - IpRanges: + ServiceId: pl-12345678 + ServiceName: com.outscale.eu-west-2.api + - IpRanges: - 198.51.100.0 - 203.0.113.0 - 203.0.113.1 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ServiceId: pl-87654321 + ServiceName: com.outscale.eu-west-2.oos 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 + Services: + - IpRanges: + - 192.0.2.0 + ServiceId: pl-12345678 + ServiceName: com.outscale.eu-west-2.api + schema: + "$ref": "#/components/schemas/ReadNetAccessPointServicesResponse" description: The HTTP 200 response (OK). security: [] tags: @@ -19950,8 +20078,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadNetAccessPointsRequest" examples: ex1: value: @@ -19965,25 +20091,27 @@ paths: - vpc-12345678 States: - available + schema: + "$ref": "#/components/schemas/ReadNetAccessPointsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadNetAccessPointsResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 NetAccessPoints: - - Tags: [] - NetAccessPointId: vpce-12345678 + - NetAccessPointId: vpce-12345678 + NetId: vpc-12345678 RouteTableIds: - rtb-12345678 - State: available - NetId: vpc-12345678 ServiceName: com.outscale.eu-west-2.oos + State: available + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadNetAccessPointsResponse" description: The HTTP 200 response (OK). tags: - NetAccessPoint @@ -19994,8 +20122,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadNetPeeringsRequest" examples: ex1: value: @@ -20010,31 +20136,33 @@ paths: StateNames: - active - pending-acceptance + schema: + "$ref": "#/components/schemas/ReadNetPeeringsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadNetPeeringsResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 NetPeerings: - - Tags: [] - State: - Name: active - Message: Active - AccepterNet: - NetId: vpc-12345678 - IpRange: 172.16.0.0/16 + - AccepterNet: AccountId: '123456789012' - SourceNet: + IpRange: 172.16.0.0/16 NetId: vpc-12345678 - IpRange: 10.0.0.0/16 - AccountId: '123456789012' NetPeeringId: pcx-12345678 + SourceNet: + AccountId: '123456789012' + IpRange: 10.0.0.0/16 + NetId: vpc-12345678 + State: + Message: Active + Name: active + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadNetPeeringsResponse" description: The HTTP 200 response (OK). '400': content: @@ -20063,8 +20191,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadNetsRequest" examples: ex1: value: @@ -20076,24 +20202,26 @@ paths: Filters: States: - available + schema: + "$ref": "#/components/schemas/ReadNetsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadNetsResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Nets: - - Tags: [] - DhcpOptionsSetId: dopt-12345678 + - DhcpOptionsSetId: dopt-12345678 IpRange: 10.0.0.0/16 - Tenancy: default NetId: vpc-12345678 State: available + Tags: [] + Tenancy: default + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadNetsResponse" description: The HTTP 200 response (OK). '400': content: @@ -20124,8 +20252,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadNicsRequest" examples: ex1: value: @@ -20137,43 +20263,45 @@ paths: Filters: LinkNicVmIds: - i-12345678 + schema: + "$ref": "#/components/schemas/ReadNicsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadNicsResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Nics: - - SubregionName: eu-west-2a - SubnetId: subnet-12345678 - State: in-use + - AccountId: '123456789012' + Description: Primary network interface + IsSourceDestChecked: true LinkNic: - VmId: i-12345678 - LinkNicId: eni-attach-12345678 - VmAccountId: '123456789012' DeleteOnVmDeletion: false DeviceNumber: 0 + LinkNicId: eni-attach-12345678 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 + VmAccountId: '123456789012' + VmId: i-12345678 MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - IsPrimary: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - IsPrimary: true + SecurityGroups: + - SecurityGroupId: sg-12345678 + SecurityGroupName: security-group-example + State: in-use + SubnetId: subnet-12345678 + SubregionName: eu-west-2a + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadNicsResponse" description: The HTTP 200 response (OK). '400': content: @@ -20202,8 +20330,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadPoliciesRequest" examples: ex1: value: @@ -20213,31 +20339,33 @@ paths: Scope: OWS FirstItem: 1 ResultsPerPage: 30 + schema: + "$ref": "#/components/schemas/ReadPoliciesRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadPoliciesResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 HasMoreItems: true + MaxResultsLimit: 30 + MaxResultsTruncated: false Policies: - - ResourcesCount: 1 - PolicyName: example-user-policy - PolicyDefaultVersionId: v1 - Path: "/example/" - CreationDate: 2010-10-01 12:34:56.789000000 +00:00 + - CreationDate: 2010-10-01 12:34:56.789000000 +00:00 Description: Example of description - PolicyId: ABCDEFGHIJKLMNOPQRSTUVWXYZ01234 - Orn: orn:ows:idauth::012345678910:policy/example/example-user-policy IsLinkable: true LastModificationDate: 2010-10-01 12:34:56.789000000 +00:00 - MaxResultsLimit: 30 - MaxResultsTruncated: false + Orn: orn:ows:idauth::012345678910:policy/example/example-user-policy + Path: "/example/" + PolicyDefaultVersionId: v1 + PolicyId: ABCDEFGHIJKLMNOPQRSTUVWXYZ01234 + PolicyName: example-user-policy + ResourcesCount: 1 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadPoliciesResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -20248,34 +20376,34 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadPolicyRequest" examples: ex1: value: PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy + schema: + "$ref": "#/components/schemas/ReadPolicyRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadPolicyResponse" examples: ex1: value: Policy: - ResourcesCount: 0 - PolicyName: example-user-policy - PolicyDefaultVersionId: v1 - Path: "/example/" CreationDate: 2010-10-01 12:34:56.789000000 +00:00 Description: Example of description - PolicyId: ABCDEFGHIJKLMNOPQRSTUVWXYZ01234 - Orn: orn:ows:idauth::012345678910:policy/example/example-user-policy IsLinkable: true LastModificationDate: 2010-10-01 12:34:56.789000000 +00:00 + Orn: orn:ows:idauth::012345678910:policy/example/example-user-policy + Path: "/example/" + PolicyDefaultVersionId: v1 + PolicyId: ABCDEFGHIJKLMNOPQRSTUVWXYZ01234 + PolicyName: example-user-policy + ResourcesCount: 0 ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadPolicyResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -20286,30 +20414,30 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadPolicyVersionRequest" examples: ex1: value: PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy VersionId: v1 + schema: + "$ref": "#/components/schemas/ReadPolicyVersionRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadPolicyVersionResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 PolicyVersion: - VersionId: v1 - DefaultVersion: true - CreationDate: 2010-10-01 12:34:56.789000000 +00:00 Body: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], "Resource": ["*"]} ]}' + CreationDate: 2010-10-01 12:34:56.789000000 +00:00 + DefaultVersion: true + VersionId: v1 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadPolicyVersionResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -20321,33 +20449,33 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadPolicyVersionsRequest" examples: ex1: value: FirstItem: 1 PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy ResultsPerPage: 30 + schema: + "$ref": "#/components/schemas/ReadPolicyVersionsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadPolicyVersionsResponse" examples: ex1: value: + HasMoreItems: true MaxResultsLimit: 30 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 PolicyVersions: - - VersionId: v1 - DefaultVersion: true - CreationDate: 2010-10-01 12:34:56.789000000 +00:00 - Body: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], + - Body: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], "Resource": ["*"]} ]}' - HasMoreItems: true + CreationDate: 2010-10-01 12:34:56.789000000 +00:00 + DefaultVersion: true + VersionId: v1 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadPolicyVersionsResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -20358,28 +20486,28 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadProductTypesRequest" examples: ex1: value: Filters: ProductTypeIds: - '0001' + schema: + "$ref": "#/components/schemas/ReadProductTypesRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadProductTypesResponse" examples: ex1: value: + ProductTypes: + - Description: Linux + ProductTypeId: '0001' ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - ProductTypes: - - ProductTypeId: '0001' - Description: Linux + schema: + "$ref": "#/components/schemas/ReadProductTypesResponse" description: The HTTP 200 response (OK). security: [] tags: @@ -20393,32 +20521,32 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadPublicCatalogRequest" examples: ex1: value: {} + schema: + "$ref": "#/components/schemas/ReadPublicCatalogRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadPublicCatalogResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Catalog: Entries: - - UnitPrice: 0.04 - Type: CustomCore:v5-p1 + - Category: compute + Operation: RunInstances-OD + Service: TinaOS-FCU + SubregionName: eu-west-2 Title: Instance - On demand - Unite de vCore pour une instance Tina v5 CxRy Performance highest - par heure - SubregionName: eu-west-2 - Category: compute - Service: TinaOS-FCU - Operation: RunInstances-OD + Type: CustomCore:v5-p1 + UnitPrice: 0.04 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadPublicCatalogResponse" description: The HTTP 200 response (OK). security: [] tags: @@ -20432,25 +20560,25 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadPublicIpRangesRequest" examples: ex1: value: {} + schema: + "$ref": "#/components/schemas/ReadPublicIpRangesRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadPublicIpRangesResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 PublicIps: - 198.51.100.0/24 - 203.0.113.0/24 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadPublicIpRangesResponse" description: The HTTP 200 response (OK). security: [] tags: @@ -20464,8 +20592,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadPublicIpsRequest" examples: ex1: value: @@ -20477,26 +20603,28 @@ paths: Filters: VmIds: - i-12345678 + schema: + "$ref": "#/components/schemas/ReadPublicIpsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadPublicIpsResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 PublicIps: - - VmId: i-12345678 - Tags: [] - PublicIpId: eipalloc-12345678 - PublicIp: 192.0.2.0 - LinkPublicIpId: eipassoc-12345678 + - LinkPublicIpId: eipassoc-12345678 NicAccountId: '123456789012' NicId: eni-12345678 PrivateIp: 10.0.0.4 + PublicIp: 192.0.2.0 + PublicIpId: eipalloc-12345678 + Tags: [] + VmId: i-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadPublicIpsResponse" description: The HTTP 200 response (OK). '400': content: @@ -20527,8 +20655,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadQuotasRequest" examples: ex1: summary: Reading specific quota @@ -20542,52 +20668,54 @@ paths: Filters: Collections: - VPC + schema: + "$ref": "#/components/schemas/ReadQuotasRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadQuotasResponse" examples: ex1: summary: Reading specific quota value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 QuotaTypes: - - Quotas: - - ShortDescription: Load Balancer Limit - QuotaCollection: LBU - AccountId: '123456789012' + - QuotaType: global + Quotas: + - AccountId: '123456789012' Description: Maximum number of load balancers per region MaxValue: 20 - UsedValue: 0 Name: lb_limit - QuotaType: global + QuotaCollection: LBU + ShortDescription: Load Balancer Limit + UsedValue: 0 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Reading collection of quotas value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 QuotaTypes: - - Quotas: - - ShortDescription: Example Limit - QuotaCollection: VPC - AccountId: '123456789012' + - QuotaType: global + Quotas: + - 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' + ShortDescription: Example Limit + UsedValue: 0 + - QuotaType: vpc-12345678 + Quotas: + - AccountId: '123456789012' Description: Maximum number of other examples MaxValue: 50 - UsedValue: 1 Name: other_example_limit - QuotaType: vpc-12345678 + QuotaCollection: VPC + ShortDescription: Other Example Limit + UsedValue: 1 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadQuotasResponse" description: The HTTP 200 response (OK). tags: - Quota @@ -20600,29 +20728,29 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadRegionsRequest" examples: ex1: value: {} + schema: + "$ref": "#/components/schemas/ReadRegionsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadRegionsResponse" examples: ex1: value: + Regions: + - Endpoint: api.eu-west-2.outscale.com + RegionName: eu-west-2 + - Endpoint: api.us-east-2.outscale.com + RegionName: us-east-2 + - Endpoint: api.us-west-1.outscale.com + RegionName: us-west-1 ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - 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 + schema: + "$ref": "#/components/schemas/ReadRegionsResponse" description: The HTTP 200 response (OK). security: [] tags: @@ -20636,8 +20764,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadRouteTablesRequest" examples: ex1: value: @@ -20647,35 +20773,37 @@ paths: ex2: value: Filters: + LinkRouteTableMain: true NetIds: - vpc-12345678 - vpc-87654321 - LinkRouteTableMain: true + schema: + "$ref": "#/components/schemas/ReadRouteTablesRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadRouteTablesResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 RouteTables: - - Routes: - - DestinationIpRange: 10.0.0.0/16 - CreationMethod: CreateRouteTable - State: active - LinkRouteTables: - - Main: true - LinkRouteTableId: rtbassoc-12345678 - RouteTableId: rtb-12345678 + - LinkRouteTables: + - LinkRouteTableId: rtbassoc-12345678 + Main: true NetId: vpc-12345678 + RouteTableId: rtb-12345678 NetId: vpc-12345678 - Tags: [] RoutePropagatingVirtualGateways: [] RouteTableId: rtb-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Routes: + - CreationMethod: CreateRouteTable + DestinationIpRange: 10.0.0.0/16 + State: active + Tags: [] + schema: + "$ref": "#/components/schemas/ReadRouteTablesResponse" description: The HTTP 200 response (OK). '400': content: @@ -20706,8 +20834,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadSecurityGroupsRequest" examples: ex1: value: @@ -20719,37 +20845,39 @@ paths: Filters: InboundRuleIpRanges: - 192.0.2.0 + schema: + "$ref": "#/components/schemas/ReadSecurityGroupsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadSecurityGroupsResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 SecurityGroups: - - Tags: [] - SecurityGroupName: security-group-example - OutboundRules: - - FromPortRange: -1 - IpProtocol: "-1" - ToPortRange: -1 - IpRanges: - - 0.0.0.0/0 - SecurityGroupId: sg-12345678 - AccountId: '123456789012' + - AccountId: '123456789012' Description: Example of security group InboundRules: - FromPortRange: 22 IpProtocol: tcp - ToPortRange: 22 IpRanges: - 192.0.2.0 - 198.51.100.0 + ToPortRange: 22 NetId: vpc-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + OutboundRules: + - FromPortRange: -1 + IpProtocol: "-1" + IpRanges: + - 0.0.0.0/0 + ToPortRange: -1 + SecurityGroupId: sg-12345678 + SecurityGroupName: security-group-example + Tags: [] + schema: + "$ref": "#/components/schemas/ReadSecurityGroupsResponse" description: The HTTP 200 response (OK). '400': content: @@ -20778,30 +20906,30 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadServerCertificatesRequest" examples: ex1: value: Filters: Paths: - "/example/" + schema: + "$ref": "#/components/schemas/ReadServerCertificatesRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadServerCertificatesResponse" examples: ex1: value: - 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 + ServerCertificates: + - Id: ABCDEFGHIJKLMNOPQRSTUVWXYZ1234 + Name: server-cert-example + Orn: orn:ows:idauth::012345678910:server-certificate/example/server-cert-example + Path: "/example/" + schema: + "$ref": "#/components/schemas/ReadServerCertificatesResponse" description: The HTTP 200 response (OK). tags: - ServerCertificate @@ -20812,36 +20940,36 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadSnapshotExportTasksRequest" examples: ex1: value: Filters: TaskIds: - snap-export-12345678 + schema: + "$ref": "#/components/schemas/ReadSnapshotExportTasksRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadSnapshotExportTasksResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 SnapshotExportTasks: - - Tags: [] - TaskId: snap-export-12345678 - Comment: Export of snapshot snap-12345678 + - Comment: Export of snapshot snap-12345678 OsuExport: - OsuPrefix: PREFIX - OsuBucket: BUCKET DiskImageFormat: qcow2 - State: pending - SnapshotId: snap-12345678 + OsuBucket: BUCKET + OsuPrefix: PREFIX Progress: 99 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + SnapshotId: snap-12345678 + State: pending + Tags: [] + TaskId: snap-export-12345678 + schema: + "$ref": "#/components/schemas/ReadSnapshotExportTasksResponse" description: The HTTP 200 response (OK). tags: - Snapshot @@ -20853,8 +20981,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadSnapshotsRequest" examples: ex1: value: @@ -20869,49 +20995,51 @@ paths: TagValues: - prod - test + schema: + "$ref": "#/components/schemas/ReadSnapshotsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadSnapshotsResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Snapshots: - - VolumeSize: 10 - AccountId: '123456789012' - VolumeId: vol-12345678 + - AccountId: '123456789012' CreationDate: '2010-10-01T12:34:56.789Z' + Description: Snapshot created from a volume PermissionsToCreateVolume: - GlobalPermission: false AccountIds: [] + GlobalPermission: false Progress: 100 SnapshotId: snap-12345678 State: completed - Description: Snapshot created from a volume Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + VolumeId: vol-12345678 + VolumeSize: 10 ex2: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Snapshots: - - VolumeSize: 10 - AccountId: '123456789012' - VolumeId: vol-12345678 + - AccountId: '123456789012' CreationDate: '2010-10-01T12:34:56.789Z' + Description: Test snapshot PermissionsToCreateVolume: - GlobalPermission: false AccountIds: [] + GlobalPermission: false Progress: 100 SnapshotId: snap-12345678 State: completed - Description: Test snapshot Tags: - - Value: test - Key: env - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + - Key: env + Value: test + VolumeId: vol-12345678 + VolumeSize: 10 + schema: + "$ref": "#/components/schemas/ReadSnapshotsResponse" description: The HTTP 200 response (OK). '400': content: @@ -20942,8 +21070,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadSubnetsRequest" examples: ex1: value: @@ -20958,26 +21084,28 @@ paths: - pending SubregionNames: - eu-west-2a + schema: + "$ref": "#/components/schemas/ReadSubnetsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadSubnetsResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Subnets: - - Tags: [] - SubregionName: eu-west-2a - SubnetId: subnet-12345678 - AvailableIpsCount: 16379 + - AvailableIpsCount: 16379 IpRange: 10.0.0.0/18 MapPublicIpOnLaunch: false - State: available NetId: vpc-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + State: available + SubnetId: subnet-12345678 + SubregionName: eu-west-2a + Tags: [] + schema: + "$ref": "#/components/schemas/ReadSubnetsResponse" description: The HTTP 200 response (OK). '400': content: @@ -21009,8 +21137,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadSubregionsRequest" examples: ex1: summary: Listing a specific Subregion in the current Region @@ -21025,37 +21151,39 @@ paths: SubregionNames: - eu-west-2a - eu-west-2b + schema: + "$ref": "#/components/schemas/ReadSubregionsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadSubregionsResponse" examples: ex1: summary: Listing a specific Subregion in the current Region value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Subregions: - - State: available + - LocationCode: PAR1 RegionName: eu-west-2 + State: available SubregionName: eu-west-2a - LocationCode: PAR1 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Listing two specific Subregions in the current Region value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Subregions: - - State: available + - LocationCode: PAR1 RegionName: eu-west-2 + State: available SubregionName: eu-west-2a - LocationCode: PAR1 - - State: available + - LocationCode: PAR4 RegionName: eu-west-2 + State: available SubregionName: eu-west-2b - LocationCode: PAR4 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadSubregionsResponse" description: The HTTP 200 response (OK). tags: - Subregion @@ -21066,32 +21194,32 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadTagsRequest" examples: ex1: value: Filters: - ResourceTypes: - - snapshot Keys: - key1 + ResourceTypes: + - snapshot + schema: + "$ref": "#/components/schemas/ReadTagsRequest" 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 + Tags: + - Key: key1 + ResourceId: snap-12345678 + ResourceType: snapshot + Value: value1 + schema: + "$ref": "#/components/schemas/ReadTagsResponse" description: The HTTP 200 response (OK). '400': content: @@ -21120,32 +21248,32 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadUnitPriceRequest" examples: ex1: value: Operation: CreateVolume Service: TinaOS-FCU Type: BSU:VolumeIOPS:io1 + schema: + "$ref": "#/components/schemas/ReadUnitPriceRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadUnitPriceResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 UnitPriceEntry: - UnitPrice: 0.01 - Unit: PER_IOPS_PER_MONTH Currency: EUR Operation: CreateVolume - Type: BSU:VolumeIOPS:io1 Service: TinaOS-FCU + Type: BSU:VolumeIOPS:io1 + Unit: PER_IOPS_PER_MONTH + UnitPrice: 0.01 + schema: + "$ref": "#/components/schemas/ReadUnitPriceResponse" description: The HTTP 200 response (OK). tags: - Catalog @@ -21156,19 +21284,17 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadUserGroupRequest" examples: ex1: value: Path: "/example/" UserGroupName: example-usergroup + schema: + "$ref": "#/components/schemas/ReadUserGroupRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadUserGroupResponse" examples: ex1: value: @@ -21188,6 +21314,8 @@ paths: UserEmail: user@example.com UserId: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 UserName: example-user + schema: + "$ref": "#/components/schemas/ReadUserGroupResponse" description: The HTTP 200 response (OK). tags: - UserGroup @@ -21198,8 +21326,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadUserGroupPoliciesRequest" examples: ex1: value: @@ -21207,17 +21333,15 @@ paths: ResultsPerPage: 30 UserGroupName: example-usergroup UserGroupPath: "/example/" + schema: + "$ref": "#/components/schemas/ReadUserGroupPoliciesRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadUserGroupPoliciesResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 HasMoreItems: true MaxResultsLimit: 30 MaxResultsTruncated: true @@ -21225,6 +21349,10 @@ paths: - Body: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], "Resource": ["*"]} ]}' Name: example-policy + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadUserGroupPoliciesResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -21236,29 +21364,29 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadUserGroupPolicyRequest" examples: ex1: value: PolicyName: example-policy UserGroupName: example-usergroup UserGroupPath: "/example/" + schema: + "$ref": "#/components/schemas/ReadUserGroupPolicyRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadUserGroupPolicyResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Policy: Body: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], "Resource": ["*"]} ]}' Name: example-policy + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadUserGroupPolicyResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -21271,8 +21399,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadUserGroupsRequest" examples: ex1: value: @@ -21282,20 +21408,20 @@ paths: - ug-12345678 FirstItem: 1 ResultsPerPage: 30 + schema: + "$ref": "#/components/schemas/ReadUserGroupsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadUserGroupsResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 HasMoreItems: true MaxResultsLimit: 30 MaxResultsTruncated: true + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 UserGroups: - CreationDate: '2010-10-01T12:34:56.789Z' LastModificationDate: '2010-10-01T12:34:56.789Z' @@ -21303,6 +21429,8 @@ paths: Orn: orn:ows:idauth::012345678910:usergroup/example/usergroup-example Path: "/example/" UserGroupId: ug-12345678 + schema: + "$ref": "#/components/schemas/ReadUserGroupsResponse" description: The HTTP 200 response (OK). tags: - UserGroup @@ -21313,19 +21441,17 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadUserGroupsPerUserRequest" examples: ex1: value: UserName: example-user UserPath: "/example/" + schema: + "$ref": "#/components/schemas/ReadUserGroupsPerUserRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadUserGroupsPerUserResponse" examples: ex1: value: @@ -21338,6 +21464,8 @@ paths: Orn: orn:ows:idauth::012345678910:usergroup/example/usergroup-example Path: "/example/" UserGroupId: ug-12345678 + schema: + "$ref": "#/components/schemas/ReadUserGroupsPerUserResponse" description: The HTTP 200 response (OK). tags: - UserGroup @@ -21348,18 +21476,16 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadUserPoliciesRequest" examples: ex1: value: UserName: example-user + schema: + "$ref": "#/components/schemas/ReadUserPoliciesRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadUserPoliciesResponse" examples: ex1: value: @@ -21367,6 +21493,8 @@ paths: - example-policy ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadUserPoliciesResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -21378,19 +21506,17 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadUserPolicyRequest" examples: ex1: value: - UserName: example-user PolicyName: example-user-policy + UserName: example-user + schema: + "$ref": "#/components/schemas/ReadUserPolicyRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadUserPolicyResponse" examples: ex1: value: @@ -21398,6 +21524,8 @@ paths: ["*"], "Resource": ["*"]} ]}' PolicyName: example-user-policy UserName: example-user + schema: + "$ref": "#/components/schemas/ReadUserPolicyResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -21410,30 +21538,30 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadUsersRequest" examples: ex1: value: Filters: UserIds: - ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 + schema: + "$ref": "#/components/schemas/ReadUsersRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadUsersResponse" examples: ex1: value: - Users: - - UserEmail: user@example.com - UserName: example-user - UserId: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 - Path: "/documentation/" ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Users: + - Path: "/documentation/" + UserEmail: user@example.com + UserId: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 + UserName: example-user + schema: + "$ref": "#/components/schemas/ReadUsersResponse" description: The HTTP 200 response (OK). tags: - User @@ -21444,8 +21572,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadVirtualGatewaysRequest" examples: ex1: value: @@ -21455,40 +21581,42 @@ paths: ex2: value: Filters: - States: - - available LinkStates: - attached - detached + States: + - available + schema: + "$ref": "#/components/schemas/ReadVirtualGatewaysRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadVirtualGatewaysResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VirtualGateways: - - VirtualGatewayId: vgw-12345678 - ConnectionType: ipsec.1 + - ConnectionType: ipsec.1 NetToVirtualGatewayLinks: [] State: available Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + VirtualGatewayId: vgw-12345678 ex2: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VirtualGateways: - - VirtualGatewayId: vgw-12345678 - ConnectionType: ipsec.1 + - ConnectionType: ipsec.1 NetToVirtualGatewayLinks: - - State: attached - NetId: vpc-12345678 + - NetId: vpc-12345678 + State: attached State: available Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + VirtualGatewayId: vgw-12345678 + schema: + "$ref": "#/components/schemas/ReadVirtualGatewaysResponse" description: The HTTP 200 response (OK). tags: - VirtualGateway @@ -21503,40 +21631,40 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadVmGroupsRequest" examples: ex1: value: Filters: VmGroupIds: - vmgroup-12345678901234567890123456789012 + schema: + "$ref": "#/components/schemas/ReadVmGroupsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadVmGroupsResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VmGroups: - - SecurityGroupIds: - - sg-87654321 - VmIds: - - i-12345678 - CreationDate: 2010-10-01 12:34:56.789000000 +00:00 - VmCount: 1 - VmGroupName: ClusterLog-PPD01 - SubnetId: subnet-12345678 + - CreationDate: 2010-10-01 12:34:56.789000000 +00:00 PositioningStrategy: attract + SecurityGroupIds: + - sg-87654321 State: available - VmGroupId: vmgroup-12345678901234567890123456789012 + SubnetId: subnet-12345678 Tags: - - Value: value1 - Key: key1 + - Key: key1 + Value: value1 + VmCount: 1 + VmGroupId: vmgroup-12345678901234567890123456789012 + VmGroupName: ClusterLog-PPD01 + VmIds: + - i-12345678 + schema: + "$ref": "#/components/schemas/ReadVmGroupsResponse" description: The HTTP 200 response (OK). '400': content: @@ -21569,8 +21697,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadVmTemplatesRequest" examples: ex1: value: @@ -21584,28 +21710,30 @@ paths: - 2 CpuGenerations: - v4 + schema: + "$ref": "#/components/schemas/ReadVmTemplatesRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadVmTemplatesResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VmTemplates: - - VmTemplateName: vmtemplate-example + - CpuCores: 2 + CpuGeneration: v4 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 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Tags: [] + VmTemplateId: vmtemplate-98765432109876543210987654321012 + VmTemplateName: vmtemplate-example + schema: + "$ref": "#/components/schemas/ReadVmTemplatesResponse" description: The HTTP 200 response (OK). tags: - VmTemplate @@ -21616,32 +21744,32 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadVmTypesRequest" examples: ex1: value: Filters: VmTypeNames: - t2.small + schema: + "$ref": "#/components/schemas/ReadVmTypesRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadVmTypesResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VmTypes: - - VolumeCount: 0 - VmTypeName: t2.small - BsuOptimized: false + - BsuOptimized: false MaxPrivateIps: 4 MemorySize: 2 VcoreCount: 1 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + VmTypeName: t2.small + VolumeCount: 0 + schema: + "$ref": "#/components/schemas/ReadVmTypesResponse" description: The HTTP 200 response (OK). security: [] tags: @@ -21655,8 +21783,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadVmsRequest" examples: ex1: value: @@ -21671,82 +21797,87 @@ paths: TagValues: - prod - test + schema: + "$ref": "#/components/schemas/ReadVmsRequest" 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 + application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Vms: + - ActionsOnNextBoot: + SecureBoot: none Architecture: x86_64 - NestedVirtualization: false BlockDeviceMappings: - - DeviceName: "/dev/sda1" - Bsu: - VolumeId: vol-12345678 - State: attached - LinkDate: '2010-10-01T12:34:56.789Z' + - Bsu: 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 + LinkDate: '2010-10-01T12:34:56.789Z' + State: attached + VolumeId: vol-12345678 + DeviceName: "/dev/sda1" + BootMode: legacy BsuOptimized: false + CreationDate: '2010-10-01T12:34:56.789Z' + DeletionProtection: false + Hypervisor: xen + ImageId: ami-12345678 + IsSourceDestChecked: true + KeypairName: keypair-example LaunchNumber: 0 + NestedVirtualization: false NetId: vpc-12345678 Nics: - - SubnetId: subnet-12345678 - State: in-use + - AccountId: '123456789012' + Description: Primary network interface + IsSourceDestChecked: true LinkNic: - State: attached + DeleteOnVmDeletion: true 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 + State: attached MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - IsPrimary: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - IsPrimary: true + SecurityGroups: + - SecurityGroupId: sg-12345678 + SecurityGroupName: security-group-example + State: in-use + SubnetId: subnet-12345678 Performance: high - Tags: - - Value: prod - Key: env + Placement: + SubregionName: eu-west-2a + Tenancy: default PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + PrivateIp: 10.0.0.4 + ProductCodes: + - '0001' + ReservationId: r-12345678 + RootDeviceName: "/dev/sda1" + RootDeviceType: ebs + SecurityGroups: + - SecurityGroupId: sg-12345678 + SecurityGroupName: security-group-example + State: running + StateReason: '' + SubnetId: subnet-12345678 + Tags: + - Key: env + Value: prod + UserData: '' + VmId: i-12345678 + VmInitiatedShutdownBehavior: stop + VmType: tinav5.c1r1p2 + schema: + "$ref": "#/components/schemas/ReadVmsResponse" description: The HTTP 200 response (OK). '400': content: @@ -21776,33 +21907,33 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadVmsHealthRequest" examples: ex1: value: - LoadBalancerName: example-lbu BackendVmIds: - i-12345678 - i-87654321 + LoadBalancerName: example-lbu + schema: + "$ref": "#/components/schemas/ReadVmsHealthRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadVmsHealthResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 BackendVmHealth: - - VmId: i-12345678 - State: UP - - VmId: i-87654321 - StateReason: ELB + - State: UP + VmId: i-12345678 + - Description: Instance registration is pending State: DOWN - Description: Instance registration is pending + StateReason: ELB + VmId: i-87654321 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadVmsHealthResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer @@ -21813,8 +21944,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadVmsStateRequest" examples: ex1: value: @@ -21824,35 +21953,37 @@ paths: Filters: SubregionNames: - eu-west-2a + schema: + "$ref": "#/components/schemas/ReadVmsStateRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadVmsStateResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VmStates: - - VmId: i-12345678 + - MaintenanceEvents: [] + SubregionName: eu-west-2a + VmId: i-12345678 VmState: running + - MaintenanceEvents: [] SubregionName: eu-west-2a - MaintenanceEvents: [] - - VmId: i-87654321 + 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 + VmStates: + - MaintenanceEvents: [] + SubregionName: eu-west-2a + VmId: i-12345678 + VmState: running + schema: + "$ref": "#/components/schemas/ReadVmsStateResponse" description: The HTTP 200 response (OK). '400': content: @@ -21881,8 +22012,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadVolumesRequest" examples: ex1: value: @@ -21897,32 +22026,34 @@ paths: VolumeTypes: - gp2 - io1 + schema: + "$ref": "#/components/schemas/ReadVolumesRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadVolumesResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Volumes: - - VolumeId: vol-12345678 - Tags: [] - VolumeType: gp2 - SubregionName: eu-west-2a - State: in-use - CreationDate: '2010-10-01T12:34:56.789Z' + - CreationDate: '2010-10-01T12:34:56.789Z' Iops: 100 LinkedVolumes: - - VolumeId: vol-12345678 - DeleteOnVmDeletion: false + - DeleteOnVmDeletion: false DeviceName: "/dev/sdb" State: attached VmId: i-12345678 + VolumeId: vol-12345678 Size: 10 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + State: in-use + SubregionName: eu-west-2a + Tags: [] + VolumeId: vol-12345678 + VolumeType: gp2 + schema: + "$ref": "#/components/schemas/ReadVolumesResponse" description: The HTTP 200 response (OK). '400': content: @@ -21951,8 +22082,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ReadVpnConnectionsRequest" examples: ex1: value: @@ -21967,32 +22096,34 @@ paths: VirtualGatewayIds: - vgw-12345678 - vgw-87654321 + schema: + "$ref": "#/components/schemas/ReadVpnConnectionsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ReadVpnConnectionsResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VpnConnections: - - Routes: [] - Tags: [] - ClientGatewayConfiguration: "..." - StaticRoutesOnly: true - VirtualGatewayId: vgw-12345678 - ConnectionType: ipsec.1 + - ClientGatewayConfiguration: "..." ClientGatewayId: cgw-12345678 + ConnectionType: ipsec.1 + Routes: [] State: pending + StaticRoutesOnly: true + Tags: [] VgwTelemetries: - - StateDescription: IPSEC IS DOWN - AcceptedRouteCount: 0 + - AcceptedRouteCount: 0 LastStateChangeDate: '2017-05-10T12:34:56.789Z' OutsideIpAddress: 192.0.2.0 + StateDescription: IPSEC IS DOWN + VirtualGatewayId: vgw-12345678 VpnConnectionId: vpn-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ReadVpnConnectionsResponse" description: The HTTP 200 response (OK). tags: - VpnConnection @@ -22005,24 +22136,24 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/RebootVmsRequest" examples: ex1: value: VmIds: - i-12345678 + schema: + "$ref": "#/components/schemas/RebootVmsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/RebootVmsResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/RebootVmsResponse" description: The HTTP 200 response (OK). '400': content: @@ -22056,26 +22187,26 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/RegisterVmsInLoadBalancerRequest" examples: ex1: value: - LoadBalancerName: example-lbu BackendVmIds: - i-12345678 - i-87654321 + LoadBalancerName: example-lbu + schema: + "$ref": "#/components/schemas/RegisterVmsInLoadBalancerRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/RegisterVmsInLoadBalancerResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/RegisterVmsInLoadBalancerResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer @@ -22088,23 +22219,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/RejectNetPeeringRequest" examples: ex1: value: NetPeeringId: pcx-12345678 + schema: + "$ref": "#/components/schemas/RejectNetPeeringRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/RejectNetPeeringResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/RejectNetPeeringResponse" description: The HTTP 200 response (OK). '400': content: @@ -22139,8 +22270,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/RemoveUserFromUserGroupRequest" examples: ex1: value: @@ -22148,17 +22277,19 @@ paths: UserGroupPath: "/example/" UserName: example-user UserPath: "/example/" + schema: + "$ref": "#/components/schemas/RemoveUserFromUserGroupRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/RemoveUserFromUserGroupResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/RemoveUserFromUserGroupResponse" description: The HTTP 200 response (OK). tags: - UserGroup @@ -22174,25 +22305,25 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ScaleDownVmGroupRequest" examples: ex1: summary: Removing 1 VM from a VM group value: VmGroupId: vmgroup-12345678901234567890123456789012 VmSubtraction: 1 + schema: + "$ref": "#/components/schemas/ScaleDownVmGroupRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ScaleDownVmGroupResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ScaleDownVmGroupResponse" description: The HTTP 200 response (OK). '400': content: @@ -22226,25 +22357,25 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/ScaleUpVmGroupRequest" examples: ex1: summary: Adding 2 VMs in a VM group value: - VmGroupId: vmgroup-12345678901234567890123456789012 VmAddition: 2 + VmGroupId: vmgroup-12345678901234567890123456789012 + schema: + "$ref": "#/components/schemas/ScaleUpVmGroupRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/ScaleUpVmGroupResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/ScaleUpVmGroupResponse" description: The HTTP 200 response (OK). '400': content: @@ -22275,24 +22406,24 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/SetDefaultPolicyVersionRequest" examples: ex1: value: PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy VersionId: v1 + schema: + "$ref": "#/components/schemas/SetDefaultPolicyVersionRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/SetDefaultPolicyVersionResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/SetDefaultPolicyVersionResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -22305,28 +22436,28 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/StartVmsRequest" examples: ex1: value: VmIds: - i-12345678 + schema: + "$ref": "#/components/schemas/StartVmsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/StartVmsResponse" examples: ex1: value: - Vms: - - VmId: i-12345678 - PreviousState: stopped - CurrentState: pending ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Vms: + - CurrentState: pending + PreviousState: stopped + VmId: i-12345678 + schema: + "$ref": "#/components/schemas/StartVmsResponse" description: The HTTP 200 response (OK). '400': content: @@ -22357,28 +22488,28 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/StopVmsRequest" examples: ex1: value: VmIds: - i-12345678 + schema: + "$ref": "#/components/schemas/StopVmsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/StopVmsResponse" examples: ex1: value: - Vms: - - VmId: i-12345678 - PreviousState: running - CurrentState: stopping ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Vms: + - CurrentState: stopping + PreviousState: running + VmId: i-12345678 + schema: + "$ref": "#/components/schemas/StopVmsResponse" description: The HTTP 200 response (OK). '400': content: @@ -22409,23 +22540,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkFlexibleGpuRequest" examples: ex1: value: FlexibleGpuId: fgpu-12345678 + schema: + "$ref": "#/components/schemas/UnlinkFlexibleGpuRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkFlexibleGpuResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UnlinkFlexibleGpuResponse" description: The HTTP 200 response (OK). tags: - FlexibleGpu @@ -22437,25 +22568,25 @@ paths: operationId: UnlinkInternetService requestBody: content: - application/json: - schema: - "$ref": "#/components/schemas/UnlinkInternetServiceRequest" + application/json: examples: ex1: value: InternetServiceId: igw-12345678 NetId: vpc-12345678 + schema: + "$ref": "#/components/schemas/UnlinkInternetServiceRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkInternetServiceResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UnlinkInternetServiceResponse" description: The HTTP 200 response (OK). '400': content: @@ -22485,29 +22616,27 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkLoadBalancerBackendMachinesRequest" examples: ex1: summary: Unlinking VMs from a load balancer value: - LoadBalancerName: example-lbu BackendVmIds: - i-12345678 - i-87654321 + LoadBalancerName: example-lbu ex2: summary: Unlinking public IPs from a load balancer value: - LoadBalancerName: example-lbu BackendIps: - 192.0.2.0 - 198.51.100.0 + LoadBalancerName: example-lbu + schema: + "$ref": "#/components/schemas/UnlinkLoadBalancerBackendMachinesRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkLoadBalancerBackendMachinesResponse" examples: ex1: summary: Unlinking VMs from a load balancer @@ -22519,6 +22648,8 @@ paths: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UnlinkLoadBalancerBackendMachinesResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer @@ -22529,24 +22660,24 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkManagedPolicyFromUserGroupRequest" examples: ex1: value: PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy UserGroupName: example-usergroup + schema: + "$ref": "#/components/schemas/UnlinkManagedPolicyFromUserGroupRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkManagedPolicyFromUserGroupResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UnlinkManagedPolicyFromUserGroupResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -22559,23 +22690,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkNicRequest" examples: ex1: value: LinkNicId: eni-attach-12345678 + schema: + "$ref": "#/components/schemas/UnlinkNicRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkNicResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UnlinkNicResponse" description: The HTTP 200 response (OK). '400': content: @@ -22604,24 +22735,24 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkPolicyRequest" examples: ex1: value: PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy UserName: example-user + schema: + "$ref": "#/components/schemas/UnlinkPolicyRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkPolicyResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UnlinkPolicyResponse" description: The HTTP 200 response (OK). tags: - Policy @@ -22633,8 +22764,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkPrivateIpsRequest" examples: ex1: value: @@ -22642,17 +22771,19 @@ paths: PrivateIps: - 10.0.0.6 - 10.0.0.7 + schema: + "$ref": "#/components/schemas/UnlinkPrivateIpsRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkPrivateIpsResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UnlinkPrivateIpsResponse" description: The HTTP 200 response (OK). '400': content: @@ -22685,23 +22816,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkPublicIpRequest" examples: ex1: value: PublicIp: 192.0.2.0 + schema: + "$ref": "#/components/schemas/UnlinkPublicIpRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkPublicIpResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UnlinkPublicIpResponse" description: The HTTP 200 response (OK). '400': content: @@ -22732,23 +22863,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkRouteTableRequest" examples: ex1: value: LinkRouteTableId: rtbassoc-12345678 + schema: + "$ref": "#/components/schemas/UnlinkRouteTableRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkRouteTableResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UnlinkRouteTableResponse" description: The HTTP 200 response (OK). '400': content: @@ -22779,24 +22910,24 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkVirtualGatewayRequest" examples: ex1: value: - VirtualGatewayId: vgw-12345678 NetId: vpc-12345678 + VirtualGatewayId: vgw-12345678 + schema: + "$ref": "#/components/schemas/UnlinkVirtualGatewayRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkVirtualGatewayResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UnlinkVirtualGatewayResponse" description: The HTTP 200 response (OK). tags: - VirtualGateway @@ -22809,23 +22940,23 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkVolumeRequest" examples: ex1: value: VolumeId: vol-12345678 + schema: + "$ref": "#/components/schemas/UnlinkVolumeRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UnlinkVolumeResponse" examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UnlinkVolumeResponse" description: The HTTP 200 response (OK). '400': content: @@ -22856,15 +22987,13 @@ paths: requestBody: content: 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' + State: ACTIVE ex2: summary: Updating the state of one of your own access keys (if you are the root account or an EIM user) @@ -22877,36 +23006,38 @@ paths: AccessKeyId: ABCDEFGHIJ0123456789 State: ACTIVE UserName: example-user + schema: + "$ref": "#/components/schemas/UpdateAccessKeyRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateAccessKeyResponse" examples: ex1: summary: Updating an access key when using the parameter ExpirationDate value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 AccessKey: - State: ACTIVE AccessKeyId: ABCDEFGHIJ0123456789 CreationDate: 2010-10-01 12:34:56.789000000 +00:00 ExpirationDate: 2063-04-05 00:00:00.000000000 +00:00 LastModificationDate: 2017-05-10 12:34:56.789000000 +00:00 + State: ACTIVE Tag: Group1 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Updating an access key when not using the parameter ExpirationDate value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 AccessKey: - State: ACTIVE AccessKeyId: ABCDEFGHIJ0123456789 CreationDate: 2010-10-01 12:34:56.789000000 +00:00 LastModificationDate: 2017-05-10 12:34:56.789000000 +00:00 + State: ACTIVE Tag: Group1 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UpdateAccessKeyResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -22920,38 +23051,38 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateAccountRequest" examples: ex1: value: AdditionalEmails: - another@example.com - yet.another@example.com + schema: + "$ref": "#/components/schemas/UpdateAccountRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateAccountResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Account: - ZipCode: '92210' - CompanyName: EXAMPLE SAS - FirstName: JEAN + AccountId: '123456789012' AdditionalEmails: - another@example.com - yet.another@example.com City: SAINT-CLOUD + CompanyName: EXAMPLE SAS Country: FRANCE - LastName: DUPONT - AccountId: '123456789012' CustomerId: '87654321' Email: example@example.com + FirstName: JEAN + LastName: DUPONT + ZipCode: '92210' + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UpdateAccountResponse" description: The HTTP 200 response (OK). tags: - Account @@ -22966,8 +23097,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateApiAccessPolicyRequest" examples: ex1: summary: Require expiration dates of maximum 1 year @@ -22986,39 +23115,41 @@ paths: value: MaxAccessKeyExpirationSeconds: 0 RequireTrustedEnv: false + schema: + "$ref": "#/components/schemas/UpdateApiAccessPolicyRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateApiAccessPolicyResponse" examples: ex1: summary: Require expiration dates of maximum 1 year value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ApiAccessPolicy: - RequireTrustedEnv: false MaxAccessKeyExpirationSeconds: 31536000 + RequireTrustedEnv: false + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 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 + RequireTrustedEnv: true + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 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 + RequireTrustedEnv: false + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UpdateApiAccessPolicyResponse" description: The HTTP 200 response (OK). '400': content: @@ -23055,33 +23186,33 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateApiAccessRuleRequest" examples: ex1: value: ApiAccessRuleId: aar-1234567890abcdef1234567890abcdef + Description: Allows all Ipv4 domain IpRanges: - 0.0.0.0/0 - Description: Allows all Ipv4 domain + schema: + "$ref": "#/components/schemas/UpdateApiAccessRuleRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateApiAccessRuleResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ApiAccessRule: - IpRanges: - - 0.0.0.0/0 ApiAccessRuleId: aar-1234567890abcdef1234567890abcdef CaIds: [] Cns: [] Description: Allows all IPv4 domain + IpRanges: + - 0.0.0.0/0 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UpdateApiAccessRuleResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -23096,28 +23227,28 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateCaRequest" examples: ex1: value: CaId: ca-fedcba0987654321fedcba0987654321 Description: New description + schema: + "$ref": "#/components/schemas/UpdateCaRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateCaResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Ca: - Description: New description - CaId: ca-fedcba0987654321fedcba0987654321 CaFingerprint: 1234567890abcdef1234567890abcdef12345678 + CaId: ca-fedcba0987654321fedcba0987654321 + Description: New description + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UpdateCaResponse" description: The HTTP 200 response (OK). security: - ApiKeyAuthSec: [] @@ -23135,34 +23266,34 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateDedicatedGroupRequest" examples: ex1: value: DedicatedGroupId: ded-12345678 Name: New-dedicated-group-name + schema: + "$ref": "#/components/schemas/UpdateDedicatedGroupRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateDedicatedGroupResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 DedicatedGroup: - VmIds: - - i-12345678 - NetIds: - - vpc-12345678 AccountId: '123456789012' CpuGeneration: 4 + DedicatedGroupId: ded-12345678 Name: New-dedicated-group-name + NetIds: + - vpc-12345678 SubregionName: eu-west-2a - DedicatedGroupId: ded-12345678 + VmIds: + - i-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UpdateDedicatedGroupResponse" description: The HTTP 200 response (OK). '400': content: @@ -23191,38 +23322,38 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateDirectLinkInterfaceRequest" examples: ex1: value: DirectLinkInterfaceId: dxvif-12345678 Mtu: 1500 + schema: + "$ref": "#/components/schemas/UpdateDirectLinkInterfaceRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateDirectLinkInterfaceResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 DirectLinkInterface: - Vlan: 101 - OutscalePrivateIp: 172.16.0.4/30 - DirectLinkInterfaceId: dxvif-12345678 - BgpAsn: 65000 AccountId: '123456789012' + BgpAsn: 65000 ClientPrivateIp: 172.16.0.5/30 - VirtualGatewayId: vgw-12345678 - DirectLinkInterfaceName: MyDirectLinkInterface DirectLinkId: dxcon-12345678 - Mtu: 1500 - State: available + DirectLinkInterfaceId: dxvif-12345678 + DirectLinkInterfaceName: MyDirectLinkInterface InterfaceType: private Location: PAR1 + Mtu: 1500 + OutscalePrivateIp: 172.16.0.4/30 + State: available + VirtualGatewayId: vgw-12345678 + Vlan: 101 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UpdateDirectLinkInterfaceResponse" description: The HTTP 200 response (OK). tags: - DirectLinkInterface @@ -23233,24 +23364,20 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateFlexibleGpuRequest" examples: ex1: value: - FlexibleGpuId: fgpu-12345678 DeleteOnVmDeletion: false + FlexibleGpuId: fgpu-12345678 + schema: + "$ref": "#/components/schemas/UpdateFlexibleGpuRequest" 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 @@ -23258,6 +23385,10 @@ paths: ModelName: nvidia-p100 State: allocated SubregionName: eu-west-2a + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UpdateFlexibleGpuResponse" description: The HTTP 200 response (OK). tags: - FlexibleGpu @@ -23270,9 +23401,7 @@ paths: operationId: UpdateImage requestBody: content: - application/json: - schema: - "$ref": "#/components/schemas/UpdateImageRequest" + application/json: examples: ex1: summary: Adding permission @@ -23300,143 +23429,145 @@ paths: ex4: summary: Making an image private to everyone value: - ImageId: ami-12345678 Description: Private image + ImageId: ami-12345678 PermissionsToLaunch: Removals: GlobalPermission: true + schema: + "$ref": "#/components/schemas/UpdateImageRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateImageResponse" examples: ex1: summary: Adding permission value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Image: - StateComment: {} - State: available - RootDeviceType: bsu - RootDeviceName: "/dev/sda1" - ProductCodes: - - '0001' - PermissionsToLaunch: - GlobalPermission: false - AccountIds: - - '987654321098' AccountId: '123456789012' - Tags: [] - Description: '' - ImageId: ami-12345678 + Architecture: x86_64 BlockDeviceMappings: - - DeviceName: "/dev/sda1" - Bsu: - VolumeType: standard + - Bsu: DeleteOnVmDeletion: true - VolumeSize: 50 SnapshotId: snap-12345678 - ImageType: machine + VolumeSize: 50 + VolumeType: standard + DeviceName: "/dev/sda1" CreationDate: '2010-10-01T12:34:56.789Z' + Description: '' FileLocation: 123456789012/image-example - Architecture: x86_64 + ImageId: ami-12345678 ImageName: image-example + ImageType: machine + PermissionsToLaunch: + AccountIds: + - '987654321098' + GlobalPermission: false + ProductCodes: + - '0001' + RootDeviceName: "/dev/sda1" + RootDeviceType: bsu + State: available + StateComment: {} + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: summary: Removing permission value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Image: - StateComment: {} - State: available - RootDeviceType: bsu - RootDeviceName: "/dev/sda1" - ProductCodes: - - '0001' - PermissionsToLaunch: - GlobalPermission: false - AccountIds: [] AccountId: '123456789012' - Tags: [] - Description: '' - ImageId: ami-12345678 + Architecture: x86_64 BlockDeviceMappings: - - DeviceName: "/dev/sda1" - Bsu: - VolumeType: standard + - Bsu: DeleteOnVmDeletion: true - VolumeSize: 50 SnapshotId: snap-12345678 - ImageType: machine + VolumeSize: 50 + VolumeType: standard + DeviceName: "/dev/sda1" CreationDate: '2010-10-01T12:34:56.789Z' + Description: '' FileLocation: 123456789012/image-example - Architecture: x86_64 + ImageId: ami-12345678 ImageName: image-example + ImageType: machine + PermissionsToLaunch: + AccountIds: [] + GlobalPermission: false + ProductCodes: + - '0001' + RootDeviceName: "/dev/sda1" + RootDeviceType: bsu + State: available + StateComment: {} + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex3: summary: Making an image public to everyone value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Image: - StateComment: {} - State: available - RootDeviceType: bsu - RootDeviceName: "/dev/sda1" - ProductCodes: - - '0001' - PermissionsToLaunch: - GlobalPermission: true - AccountIds: [] AccountId: '123456789012' - Tags: [] - Description: '' - ImageId: ami-12345678 + Architecture: x86_64 BlockDeviceMappings: - - DeviceName: "/dev/sda1" - Bsu: - VolumeType: standard + - Bsu: DeleteOnVmDeletion: true - VolumeSize: 50 SnapshotId: snap-12345678 - ImageType: machine + VolumeSize: 50 + VolumeType: standard + DeviceName: "/dev/sda1" CreationDate: '2010-10-01T12:34:56.789Z' + Description: '' FileLocation: 123456789012/image-example - Architecture: x86_64 + ImageId: ami-12345678 ImageName: image-example + ImageType: machine + PermissionsToLaunch: + AccountIds: [] + GlobalPermission: true + ProductCodes: + - '0001' + RootDeviceName: "/dev/sda1" + RootDeviceType: bsu + State: available + StateComment: {} + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex4: summary: Making an image private to everyone value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Image: - StateComment: {} - State: available - RootDeviceType: bsu - RootDeviceName: "/dev/sda1" - ProductCodes: - - '0001' - PermissionsToLaunch: - GlobalPermission: false - AccountIds: [] AccountId: '123456789012' - Tags: [] - Description: Private image - ImageId: ami-12345678 + Architecture: x86_64 BlockDeviceMappings: - - DeviceName: "/dev/sda1" - Bsu: - VolumeType: standard + - Bsu: DeleteOnVmDeletion: true - VolumeSize: 50 SnapshotId: snap-12345678 - ImageType: machine + VolumeSize: 50 + VolumeType: standard + DeviceName: "/dev/sda1" CreationDate: '2010-10-01T12:34:56.789Z' + Description: Private image FileLocation: 123456789012/image-example - Architecture: x86_64 + ImageId: ami-12345678 ImageName: image-example + ImageType: machine + PermissionsToLaunch: + AccountIds: [] + GlobalPermission: false + ProductCodes: + - '0001' + RootDeviceName: "/dev/sda1" + RootDeviceType: bsu + State: available + StateComment: {} + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UpdateImageResponse" description: The HTTP 200 response (OK). '400': content: @@ -23467,33 +23598,33 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateListenerRuleRequest" examples: ex1: value: - ListenerRuleName: example-listener-rule HostPattern: "*.newhost.com" + ListenerRuleName: example-listener-rule + schema: + "$ref": "#/components/schemas/UpdateListenerRuleRequest" 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" + ListenerId: 123456 ListenerRuleId: 1234 + ListenerRuleName: example-listener-rule + Priority: 10 + VmIds: + - i-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UpdateListenerRuleResponse" description: The HTTP 200 response (OK). tags: - Listener @@ -23511,30 +23642,28 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateLoadBalancerRequest" examples: ex1: summary: Updating health checks value: - LoadBalancerName: private-lb-example HealthCheck: - HealthyThreshold: 10 CheckInterval: 30 + HealthyThreshold: 10 Path: "/index.html" Port: 8080 Protocol: HTTPS Timeout: 5 UnhealthyThreshold: 5 + LoadBalancerName: private-lb-example ex2: summary: Updating access logs value: - LoadBalancerName: private-lb-example AccessLog: - PublicationInterval: 5 IsEnabled: true OsuBucketName: BUCKET OsuBucketPrefix: PREFIX + PublicationInterval: 5 + LoadBalancerName: private-lb-example ex3: summary: Updating policies value: @@ -23548,182 +23677,184 @@ paths: LoadBalancerName: private-lb-example LoadBalancerPort: 443 ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/AnotherCertificate + schema: + "$ref": "#/components/schemas/UpdateLoadBalancerRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateLoadBalancerResponse" examples: ex1: summary: Updating health checks value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 LoadBalancer: - Tags: [] - SourceSecurityGroup: - SecurityGroupName: security-group-example - SecurityGroupAccountId: '123456789012' - SecuredCookies: false - PublicIp: 192.0.2.0 - Subnets: - - subnet-12345678 - NetId: vpc-12345678 - BackendVmIds: [] - ApplicationStickyCookiePolicies: [] - SecurityGroups: - - sg-12345678 - LoadBalancerType: internet-facing AccessLog: - PublicationInterval: 60 IsEnabled: false + PublicationInterval: 60 + ApplicationStickyCookiePolicies: [] + BackendVmIds: [] 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 + Path: "/index.html" Port: 8080 - LoadBalancerStickyCookiePolicies: [] - SubregionNames: - - eu-west-2a + Protocol: HTTPS + Timeout: 5 + UnhealthyThreshold: 5 Listeners: - - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate - BackendPort: 80 + - BackendPort: 80 BackendProtocol: HTTP LoadBalancerPort: 443 LoadBalancerProtocol: HTTPS + ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate LoadBalancerName: private-lb-example - ex2: - summary: Updating access logs - value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - LoadBalancer: - Tags: [] + LoadBalancerStickyCookiePolicies: [] + LoadBalancerType: internet-facing + NetId: vpc-12345678 + PublicIp: 192.0.2.0 + SecuredCookies: false + SecurityGroups: + - sg-12345678 SourceSecurityGroup: - SecurityGroupName: security-group-example SecurityGroupAccountId: '123456789012' - SecuredCookies: false - PublicIp: 192.0.2.0 + SecurityGroupName: security-group-example Subnets: - subnet-12345678 - NetId: vpc-12345678 - BackendVmIds: [] - ApplicationStickyCookiePolicies: [] - SecurityGroups: - - sg-12345678 - LoadBalancerType: internet-facing + SubregionNames: + - eu-west-2a + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + summary: Updating access logs + value: + LoadBalancer: AccessLog: - PublicationInterval: 5 - OsuBucketPrefix: PREFIX - OsuBucketName: BUCKET IsEnabled: true + OsuBucketName: BUCKET + OsuBucketPrefix: PREFIX + PublicationInterval: 5 + ApplicationStickyCookiePolicies: [] + BackendVmIds: [] 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 + Protocol: TCP + Timeout: 5 + UnhealthyThreshold: 2 Listeners: - - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate - BackendPort: 80 + - BackendPort: 80 BackendProtocol: HTTP LoadBalancerPort: 443 LoadBalancerProtocol: HTTPS + ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate LoadBalancerName: private-lb-example - ex3: - summary: Updating policies - value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - LoadBalancer: - Tags: [] + LoadBalancerStickyCookiePolicies: [] + LoadBalancerType: internet-facing + NetId: vpc-12345678 + PublicIp: 192.0.2.0 + SecuredCookies: false + SecurityGroups: + - sg-12345678 SourceSecurityGroup: - SecurityGroupName: security-group-example SecurityGroupAccountId: '123456789012' - SecuredCookies: false - PublicIp: 192.0.2.0 + SecurityGroupName: security-group-example Subnets: - subnet-12345678 - NetId: vpc-12345678 - BackendVmIds: [] - ApplicationStickyCookiePolicies: [] - SecurityGroups: - - sg-12345678 - LoadBalancerType: internet-facing + SubregionNames: + - eu-west-2a + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex3: + summary: Updating policies + value: + LoadBalancer: AccessLog: - PublicationInterval: 60 IsEnabled: false + PublicationInterval: 60 + ApplicationStickyCookiePolicies: [] + BackendVmIds: [] 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 + Protocol: TCP + Timeout: 5 + UnhealthyThreshold: 2 Listeners: - - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate - BackendPort: 80 + - BackendPort: 80 BackendProtocol: HTTP LoadBalancerPort: 443 LoadBalancerProtocol: HTTPS + ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate LoadBalancerName: private-lb-example - ex4: - summary: Updating SSL certificate - value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - LoadBalancer: - Tags: [] + LoadBalancerStickyCookiePolicies: + - CookieExpirationPeriod: 1 + PolicyName: example-browser-policy + LoadBalancerType: internet-facing + NetId: vpc-12345678 + PublicIp: 192.0.2.0 + SecuredCookies: false + SecurityGroups: + - sg-12345678 SourceSecurityGroup: - SecurityGroupName: security-group-example SecurityGroupAccountId: '123456789012' - SecuredCookies: false - PublicIp: 192.0.2.0 + SecurityGroupName: security-group-example Subnets: - subnet-12345678 - NetId: vpc-12345678 - BackendVmIds: [] - ApplicationStickyCookiePolicies: [] - SecurityGroups: - - sg-12345678 - LoadBalancerType: internet-facing + SubregionNames: + - eu-west-2a + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex4: + summary: Updating SSL certificate + value: + LoadBalancer: AccessLog: - PublicationInterval: 60 IsEnabled: false + PublicationInterval: 60 + ApplicationStickyCookiePolicies: [] + BackendVmIds: [] 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 + Protocol: TCP + Timeout: 5 + UnhealthyThreshold: 2 Listeners: - - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/AnotherCertificate - BackendPort: 80 + - BackendPort: 80 BackendProtocol: HTTP LoadBalancerPort: 443 LoadBalancerProtocol: HTTPS + ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/AnotherCertificate LoadBalancerName: private-lb-example + LoadBalancerStickyCookiePolicies: [] + LoadBalancerType: internet-facing + NetId: vpc-12345678 + PublicIp: 192.0.2.0 + SecuredCookies: false + SecurityGroups: + - sg-12345678 + SourceSecurityGroup: + SecurityGroupAccountId: '123456789012' + SecurityGroupName: security-group-example + Subnets: + - subnet-12345678 + SubregionNames: + - eu-west-2a + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UpdateLoadBalancerResponse" description: The HTTP 200 response (OK). tags: - LoadBalancer @@ -23734,31 +23865,31 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateNetRequest" examples: ex1: value: - NetId: vpc-12345678 DhcpOptionsSetId: dopt-12345678 + NetId: vpc-12345678 + schema: + "$ref": "#/components/schemas/UpdateNetRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateNetResponse" examples: ex1: value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Net: - Tags: [] DhcpOptionsSetId: dopt-12345678 IpRange: 10.0.0.0/16 - Tenancy: default NetId: vpc-12345678 State: available + Tags: [] + Tenancy: default + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UpdateNetResponse" description: The HTTP 200 response (OK). '400': content: @@ -23789,54 +23920,54 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateNetAccessPointRequest" examples: ex1: summary: Adding a route table value: - NetAccessPointId: vpce-12345678 AddRouteTableIds: - rtb-87654321 + NetAccessPointId: vpce-12345678 ex2: summary: Removing a route table value: NetAccessPointId: vpce-12345678 RemoveRouteTableIds: - rtb-12345678 + schema: + "$ref": "#/components/schemas/UpdateNetAccessPointRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateNetAccessPointResponse" examples: ex1: summary: Adding a route table value: - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 NetAccessPoint: - Tags: [] NetAccessPointId: vpce-12345678 + NetId: vpc-12345678 RouteTableIds: - rtb-12345678 - rtb-87654321 - State: available - NetId: vpc-12345678 ServiceName: com.outscale.eu-west-2.oos + State: available + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 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 + RouteTableIds: [] ServiceName: com.outscale.eu-west-2.oos + State: available + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UpdateNetAccessPointResponse" description: The HTTP 200 response (OK). tags: - NetAccessPoint @@ -23848,16 +23979,14 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateNicRequest" examples: ex1: summary: Modifying the DeleteOnVmDeletion value of a NIC value: - NicId: eni-12345678 LinkNic: DeleteOnVmDeletion: false LinkNicId: eni-attach-12345678 + NicId: eni-12345678 ex2: summary: Modifying the security groups of a NIC value: @@ -23867,108 +23996,110 @@ paths: ex3: summary: Modifying the description of a NIC value: - NicId: eni-12345678 Description: Example of description + NicId: eni-12345678 + schema: + "$ref": "#/components/schemas/UpdateNicRequest" 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 + AccountId: '123456789012' + Description: Primary network interface + IsSourceDestChecked: true LinkNic: - VmId: i-12345678 - LinkNicId: eni-attach-12345678 - VmAccountId: '123456789012' DeleteOnVmDeletion: false DeviceNumber: 0 + LinkNicId: eni-attach-12345678 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 + VmAccountId: '123456789012' + VmId: i-12345678 MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - IsPrimary: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - IsPrimary: true + SecurityGroups: + - SecurityGroupId: sg-12345678 + SecurityGroupName: default + State: in-use + SubnetId: subnet-12345678 + SubregionName: eu-west-2a + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 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 + AccountId: '123456789012' + Description: Primary network interface + IsSourceDestChecked: true LinkNic: - VmId: i-12345678 - LinkNicId: eni-attach-12345678 - VmAccountId: '123456789012' DeleteOnVmDeletion: true DeviceNumber: 0 + LinkNicId: eni-attach-12345678 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 + VmAccountId: '123456789012' + VmId: i-12345678 MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - IsPrimary: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - IsPrimary: true + SecurityGroups: + - SecurityGroupId: sg-12345678 + SecurityGroupName: security-group-example + State: in-use + SubnetId: subnet-12345678 + SubregionName: eu-west-2a + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 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 + AccountId: '123456789012' + Description: Example of description + IsSourceDestChecked: true LinkNic: - VmId: i-12345678 - LinkNicId: eni-attach-12345678 - VmAccountId: '123456789012' DeleteOnVmDeletion: true DeviceNumber: 0 + LinkNicId: eni-attach-12345678 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 + VmAccountId: '123456789012' + VmId: i-12345678 MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - IsPrimary: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - IsPrimary: true + SecurityGroups: + - SecurityGroupId: sg-12345678 + SecurityGroupName: default + State: in-use + SubnetId: subnet-12345678 + SubregionName: eu-west-2a + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + "$ref": "#/components/schemas/UpdateNicResponse" description: The HTTP 200 response (OK). '400': content: @@ -24008,45 +24139,45 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateRouteRequest" examples: ex1: summary: Updating a route to a virtual gateway value: - RouteTableId: rtb-12345678 DestinationIpRange: 198.51.100.0/24 GatewayId: vgw-12345678 + RouteTableId: rtb-12345678 + schema: + "$ref": "#/components/schemas/UpdateRouteRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateRouteResponse" examples: ex1: summary: Updating a route to a virtual gateway value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 RouteTable: - Routes: - - DestinationIpRange: 10.0.0.0/16 - CreationMethod: CreateRouteTable - State: active - - GatewayId: vgw-12345678 - DestinationIpRange: 198.51.100.0/24 - CreationMethod: CreateRoute - State: active LinkRouteTables: - - RouteTableId: rtb-12345678 + - LinkRouteTableId: rtbassoc-12345678 Main: false + RouteTableId: rtb-12345678 SubnetId: subnet-12345678 - LinkRouteTableId: rtbassoc-12345678 NetId: vpc-12345678 - Tags: [] RoutePropagatingVirtualGateways: [] RouteTableId: rtb-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Routes: + - CreationMethod: CreateRouteTable + DestinationIpRange: 10.0.0.0/16 + State: active + - CreationMethod: CreateRoute + DestinationIpRange: 198.51.100.0/24 + GatewayId: vgw-12345678 + State: active + Tags: [] + schema: + "$ref": "#/components/schemas/UpdateRouteResponse" description: The HTTP 200 response (OK). '400': content: @@ -24076,39 +24207,39 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateRoutePropagationRequest" examples: ex1: value: - VirtualGatewayId: vgw-12345678 - RouteTableId: rtb-12345678 Enable: true + RouteTableId: rtb-12345678 + VirtualGatewayId: vgw-12345678 + schema: + "$ref": "#/components/schemas/UpdateRoutePropagationRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateRoutePropagationResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 RouteTable: - Routes: - - DestinationIpRange: 10.0.0.0/16 - CreationMethod: CreateRouteTable - State: active LinkRouteTables: - - RouteTableId: rtb-12345678 + - LinkRouteTableId: rtbassoc-12345678 Main: true - LinkRouteTableId: rtbassoc-12345678 + RouteTableId: rtb-12345678 NetId: vpc-12345678 - Tags: [] RoutePropagatingVirtualGateways: - VirtualGatewayId: vgw-12345678 RouteTableId: rtb-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Routes: + - CreationMethod: CreateRouteTable + DestinationIpRange: 10.0.0.0/16 + State: active + Tags: [] + schema: + "$ref": "#/components/schemas/UpdateRoutePropagationResponse" description: The HTTP 200 response (OK). tags: - VirtualGateway @@ -24121,25 +24252,25 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateRouteTableLinkRequest" examples: ex1: value: LinkRouteTableId: rtbassoc-12345678 RouteTableId: rtb-12345678 + schema: + "$ref": "#/components/schemas/UpdateRouteTableLinkRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateRouteTableLinkResponse" examples: ex1: value: + LinkRouteTableId: rtbassoc-12345678 ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - LinkRouteTableId: rtbassoc-12345678 + schema: + "$ref": "#/components/schemas/UpdateRouteTableLinkResponse" description: The HTTP 200 response (OK). '400': content: @@ -24168,28 +24299,28 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateServerCertificateRequest" examples: ex1: value: Name: server-cert-example NewName: new-name + schema: + "$ref": "#/components/schemas/UpdateServerCertificateRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateServerCertificateResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ServerCertificate: - Path: "/example/" Id: ABCDEFGHIJKLMNOPQRSTUVWXYZ1234 Name: new-name - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Path: "/example/" + schema: + "$ref": "#/components/schemas/UpdateServerCertificateResponse" description: The HTTP 200 response (OK). tags: - ServerCertificate @@ -24203,119 +24334,119 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateSnapshotRequest" examples: ex1: summary: Adding permission value: - SnapshotId: snap-12345678 PermissionsToCreateVolume: Additions: AccountIds: - '987654321098' + SnapshotId: snap-12345678 ex2: summary: Removing permission value: - SnapshotId: snap-12345678 PermissionsToCreateVolume: Removals: AccountIds: - '987654321098' + SnapshotId: snap-12345678 ex3: summary: Making an image public to everyone value: - SnapshotId: snap-12345678 PermissionsToCreateVolume: Additions: GlobalPermission: true + SnapshotId: snap-12345678 ex4: summary: Making an image private to everyone value: - SnapshotId: snap-12345678 PermissionsToCreateVolume: Removals: GlobalPermission: true + SnapshotId: snap-12345678 + schema: + "$ref": "#/components/schemas/UpdateSnapshotRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateSnapshotResponse" examples: ex1: summary: Adding permission value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Snapshot: - VolumeSize: 10 AccountId: '123456789012' - VolumeId: vol-12345678 CreationDate: '2010-10-01T12:34:56.789Z' + Description: Snapshot created from a volume PermissionsToCreateVolume: - GlobalPermission: false AccountIds: - '987654321098' + GlobalPermission: false Progress: 100 SnapshotId: snap-12345678 State: completed - Description: Snapshot created from a volume Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + VolumeId: vol-12345678 + VolumeSize: 10 ex2: summary: Removing permission value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Snapshot: - VolumeSize: 10 AccountId: '123456789012' - VolumeId: vol-12345678 CreationDate: '2010-10-01T12:34:56.789Z' + Description: Snapshot created from a volume PermissionsToCreateVolume: - GlobalPermission: false AccountIds: [] + GlobalPermission: false Progress: 100 SnapshotId: snap-12345678 State: completed - Description: Snapshot created from a volume Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + VolumeId: vol-12345678 + VolumeSize: 10 ex3: summary: Making an image public to everyone value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Snapshot: - VolumeSize: 10 AccountId: '123456789012' - VolumeId: vol-12345678 CreationDate: '2010-10-01T12:34:56.789Z' + Description: Snapshot created from a volume PermissionsToCreateVolume: - GlobalPermission: true AccountIds: [] + GlobalPermission: true Progress: 100 SnapshotId: snap-12345678 State: completed - Description: Snapshot created from a volume Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + VolumeId: vol-12345678 + VolumeSize: 10 ex4: summary: Making an image private to everyone value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Snapshot: - VolumeSize: 10 AccountId: '123456789012' - VolumeId: vol-12345678 CreationDate: '2010-10-01T12:34:56.789Z' + Description: Snapshot created from a volume PermissionsToCreateVolume: - GlobalPermission: false AccountIds: [] + GlobalPermission: false Progress: 100 SnapshotId: snap-12345678 State: completed - Description: Snapshot created from a volume Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + VolumeId: vol-12345678 + VolumeSize: 10 + schema: + "$ref": "#/components/schemas/UpdateSnapshotResponse" description: The HTTP 200 response (OK). '400': content: @@ -24344,33 +24475,33 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateSubnetRequest" examples: ex1: value: - SubnetId: subnet-12345678 MapPublicIpOnLaunch: true + SubnetId: subnet-12345678 + schema: + "$ref": "#/components/schemas/UpdateSubnetRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateSubnetResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Subnet: - Tags: [] - SubregionName: eu-west-2a - SubnetId: subnet-12345678 AvailableIpsCount: 16379 IpRange: 10.0.0.0/18 MapPublicIpOnLaunch: true - State: available NetId: vpc-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + State: available + SubnetId: subnet-12345678 + SubregionName: eu-west-2a + Tags: [] + schema: + "$ref": "#/components/schemas/UpdateSubnetResponse" description: The HTTP 200 response (OK). '400': content: @@ -24399,33 +24530,33 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateUserRequest" examples: ex1: value: - UserName: example-user + NewPath: "/product/" NewUserEmail: user@example.com NewUserName: test-user - NewPath: "/product/" + UserName: example-user + schema: + "$ref": "#/components/schemas/UpdateUserRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateUserResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 User: CreationDate: 2010-10-01 12:34:56.789000000 +00:00 LastModificationDate: 2017-05-10 12:34:56.789000000 +00:00 + Path: "/product/" UserEmail: user@example.com - UserName: test-user UserId: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 - Path: "/product/" - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + UserName: test-user + schema: + "$ref": "#/components/schemas/UpdateUserResponse" description: The HTTP 200 response (OK). tags: - User @@ -24436,8 +24567,6 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateUserGroupRequest" examples: ex1: value: @@ -24445,12 +24574,12 @@ paths: NewUserGroupName: new-usergroup Path: "/example/" UserGroupName: example-usergroup + schema: + "$ref": "#/components/schemas/UpdateUserGroupRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateUserGroupResponse" examples: ex1: value: @@ -24470,6 +24599,8 @@ paths: UserEmail: user@example.com UserId: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 UserName: example-user + schema: + "$ref": "#/components/schemas/UpdateUserGroupResponse" description: The HTTP 200 response (OK). tags: - UserGroup @@ -24481,13 +24612,13 @@ paths: * `Performance`
* `UserData`
* `VmType` + + To complete the update of secure boot, you need to do a stop/start of the VM. A simple restart is not sufficient, as the update is done when the VM goes through the stopped state. For the difference between stop/start and restart, see [About VM Lifecycle](https://docs.outscale.com/en/userguide/About-VM-Lifecycle.html). post: operationId: UpdateVm requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateVmRequest" examples: ex1: value: @@ -24495,153 +24626,159 @@ paths: VmType: tinav5.c2r2p2 ex2: value: - VmId: i-12345678 UserData: "..." + VmId: i-12345678 + schema: + "$ref": "#/components/schemas/UpdateVmRequest" 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 + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Vm: + ActionsOnNextBoot: + SecureBoot: none + Architecture: x86_64 + BlockDeviceMappings: + - Bsu: + DeleteOnVmDeletion: true + LinkDate: '2010-10-01T12:34:56.789Z' + State: attached + VolumeId: vol-12345678 + DeviceName: "/dev/sda1" BsuOptimized: false + CreationDate: '2010-10-01T12:34:56.789Z' + DeletionProtection: false + Hypervisor: xen + ImageId: ami-12345678 + IsSourceDestChecked: true + KeypairName: keypair-example LaunchNumber: 0 + NestedVirtualization: false NetId: vpc-12345678 Nics: - - SubnetId: subnet-12345678 - State: in-use + - AccountId: '123456789012' + Description: Primary network interface + IsSourceDestChecked: true LinkNic: - State: attached + DeleteOnVmDeletion: true 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 + State: attached MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - IsPrimary: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - IsPrimary: true + SecurityGroups: + - SecurityGroupId: sg-12345678 + SecurityGroupName: security-group-example + State: in-use + SubnetId: subnet-12345678 Performance: high - Tags: - - Value: prod - Key: env + Placement: + SubregionName: eu-west-2a + Tenancy: default PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + PrivateIp: 10.0.0.4 + ProductCodes: + - '0001' + ReservationId: r-12345678 + RootDeviceName: "/dev/sda1" + RootDeviceType: ebs + SecurityGroups: + - SecurityGroupId: sg-12345678 + SecurityGroupName: security-group-example + State: stopped + StateReason: '' + SubnetId: subnet-12345678 + Tags: + - Key: env + Value: prod + UserData: '' + VmId: i-12345678 + VmInitiatedShutdownBehavior: stop + VmType: tinav5.c2r2p2 ex2: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Vm: - VmType: tinav5.c1r1p2 - VmInitiatedShutdownBehavior: stop - State: stopped - StateReason: '' - RootDeviceType: ebs - RootDeviceName: "/dev/sda1" - IsSourceDestChecked: true - KeypairName: keypair-example - ImageId: ami-12345678 - DeletionProtection: true + ActionsOnNextBoot: + SecureBoot: none Architecture: x86_64 - NestedVirtualization: false BlockDeviceMappings: - - DeviceName: "/dev/sda1" - Bsu: - VolumeId: vol-12345678 - State: attached - LinkDate: '2010-10-01T12:34:56.789Z' + - Bsu: 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 + LinkDate: '2010-10-01T12:34:56.789Z' + State: attached + VolumeId: vol-12345678 + DeviceName: "/dev/sda1" BsuOptimized: false + CreationDate: '2010-10-01T12:34:56.789Z' + DeletionProtection: true + Hypervisor: xen + ImageId: ami-12345678 + IsSourceDestChecked: true + KeypairName: keypair-example LaunchNumber: 0 + NestedVirtualization: false NetId: vpc-12345678 Nics: - - SubnetId: subnet-12345678 - State: in-use + - AccountId: '123456789012' + Description: Primary network interface + IsSourceDestChecked: true LinkNic: - State: attached + DeleteOnVmDeletion: true 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 + State: attached MacAddress: A1:B2:C3:D4:E5:F6 NetId: vpc-12345678 NicId: eni-12345678 + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIps: - - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + - IsPrimary: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal PrivateIp: 10.0.0.4 - IsPrimary: true + SecurityGroups: + - SecurityGroupId: sg-12345678 + SecurityGroupName: security-group-example + State: in-use + SubnetId: subnet-12345678 Performance: high - Tags: - - Value: prod - Key: env + Placement: + SubregionName: eu-west-2a + Tenancy: default PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + PrivateIp: 10.0.0.4 + ProductCodes: + - '0001' + ReservationId: r-12345678 + RootDeviceName: "/dev/sda1" + RootDeviceType: ebs + SecurityGroups: + - SecurityGroupId: sg-12345678 + SecurityGroupName: security-group-example + State: stopped + StateReason: '' + SubnetId: subnet-12345678 + Tags: + - Key: env + Value: prod + UserData: "..." + VmId: i-12345678 + VmInitiatedShutdownBehavior: stop + VmType: tinav5.c1r1p2 + schema: + "$ref": "#/components/schemas/UpdateVmResponse" description: The HTTP 200 response (OK). '400': content: @@ -24674,45 +24811,45 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateVmGroupRequest" examples: ex1: summary: Updating the name and description of a VM group value: + Description: New description of the VM group VmGroupId: vmgroup-12345678901234567890123456789012 VmGroupName: new-name - Description: New description of the VM group ex2: summary: Updating the VM template of a VM group value: VmGroupId: vmgroup-12345678901234567890123456789012 VmTemplateId: vmtemplate-98765432109876543210987654321012 + schema: + "$ref": "#/components/schemas/UpdateVmGroupRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateVmGroupResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VmGroup: - 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 + Description: New description of the VM group PositioningStrategy: attract + SecurityGroupIds: + - sg-12345678 State: available - VmGroupId: vmgroup-12345678901234567890123456789012 - Description: New description of the VM group + SubnetId: subnet-12345678 Tags: [] - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + VmCount: 2 + VmGroupId: vmgroup-12345678901234567890123456789012 + VmGroupName: new-name + VmIds: [] + VmTemplateId: vmtemplate-98765432109876543210987654321012 + schema: + "$ref": "#/components/schemas/UpdateVmGroupResponse" description: The HTTP 200 response (OK). '400': content: @@ -24745,36 +24882,36 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateVmTemplateRequest" examples: ex1: value: Description: The new description of the VM template VmTemplateId: vmtemplate-98765432109876543210987654321012 VmTemplateName: second-name + schema: + "$ref": "#/components/schemas/UpdateVmTemplateRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateVmTemplateResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VmTemplate: - VmTemplateName: second-name + CpuCores: 2 + CpuGeneration: v4 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 + Tags: [] + VmTemplateId: vmtemplate-98765432109876543210987654321012 + VmTemplateName: second-name + schema: + "$ref": "#/components/schemas/UpdateVmTemplateResponse" description: The HTTP 200 response (OK). tags: - VmTemplate @@ -24790,57 +24927,57 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateVolumeRequest" examples: ex1: summary: Updating the size of a volume value: - VolumeId: vol-12345678 Size: 50 + VolumeId: vol-12345678 ex2: summary: Updating the type of a volume to io1 value: + Iops: 200 VolumeId: vol-12345678 VolumeType: io1 - Iops: 200 + schema: + "$ref": "#/components/schemas/UpdateVolumeRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateVolumeResponse" examples: ex1: summary: Updating the size of a volume value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Volume: - VolumeId: vol-12345678 - Tags: [] - VolumeType: gp2 - SubregionName: eu-west-2a - State: available CreationDate: '2010-10-01T12:34:56.789Z' Iops: 100 LinkedVolumes: [] Size: 10 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + State: available + SubregionName: eu-west-2a + Tags: [] + VolumeId: vol-12345678 + VolumeType: gp2 ex2: summary: Updating the type of a volume to io1 value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Volume: - VolumeId: vol-12345678 - Tags: [] - VolumeType: io1 - SubregionName: eu-west-2a - State: available CreationDate: '2010-10-01T12:34:56.789Z' Iops: 200 LinkedVolumes: [] Size: 10 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + State: available + SubregionName: eu-west-2a + Tags: [] + VolumeId: vol-12345678 + VolumeType: io1 + schema: + "$ref": "#/components/schemas/UpdateVolumeResponse" description: The HTTP 200 response (OK). '400': content: @@ -24869,42 +25006,42 @@ paths: requestBody: content: application/json: - schema: - "$ref": "#/components/schemas/UpdateVpnConnectionRequest" examples: ex1: value: VpnConnectionId: vpn-12345678 VpnOptions: TunnelInsideIpRange: 169.254.254.22/30 + schema: + "$ref": "#/components/schemas/UpdateVpnConnectionRequest" responses: '200': content: application/json: - schema: - "$ref": "#/components/schemas/UpdateVpnConnectionResponse" examples: ex1: value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 VpnConnection: - VpnOptions: - TunnelInsideIpRange: 169.254.254.22/30 - Routes: [] - Tags: [] ClientGatewayConfiguration: "..." - StaticRoutesOnly: true - VirtualGatewayId: vgw-12345678 - ConnectionType: ipsec.1 ClientGatewayId: cgw-12345678 + ConnectionType: ipsec.1 + Routes: [] State: pending + StaticRoutesOnly: true + Tags: [] VgwTelemetries: - - StateDescription: IPSEC IS DOWN - AcceptedRouteCount: 0 + - AcceptedRouteCount: 0 LastStateChangeDate: '2017-05-10T12:34:56.789Z' OutsideIpAddress: 192.0.2.0 + StateDescription: IPSEC IS DOWN + VirtualGatewayId: vgw-12345678 VpnConnectionId: vpn-12345678 - ResponseContext: - RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + VpnOptions: + TunnelInsideIpRange: 169.254.254.22/30 + schema: + "$ref": "#/components/schemas/UpdateVpnConnectionResponse" description: The HTTP 200 response (OK). '400': content: