NAV Navigation
OSC CLI Shell

FCU API 2016-09-15

The Flexible Compute Unit (FCU) API enables you to manage your instances in the OUTSCALE Cloud.
It is compliant with the Elastic Compute Cloud (EC2) API of Amazon Web Services (AWS). See the AWS Compatibility Matrix.

Authentication: About Signatures of API Requests
Throttling: If you exceed the number of identical requests allowed for a configured time period, a RequestLimitExceeded error message is returned.

Base URLs:

Terms of service Email: Support License: BSD 3 Clause

Authentication

Addresses

AllocateAddress

GET /AllocateAddress

Acquires an External IP (EIP) for your account.
An EIP is a static IP designed for dynamic Cloud computing. It can be used for instances in the public Cloud (standard) or in a Virtual Private Cloud (VPC), for a network interface, or for a NAT gateway.

Code samples

osc-cli fcu AllocateAddress --profile "default" \
  --Domain "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=AllocateAddress' \
  --data-urlencode 'Domain=string'

Parameters

Parameter Type Required Description
Domain string false The type of platform in which you want to use the EIP (standard | vpc).

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). AllocateAddressResponse

Example responses

200 Response

{
  "allocationId": "string",
  "domain": "string",
  "publicIp": "string",
  "requestId": "string"
}

AssociateAddress

GET /AssociateAddress

Associates an External IP (EIP) with an instance or a network interface, in the public Cloud or in a Virtual Private Cloud (VPC). You can associate an EIP with only one instance or network interface at a time.
To associate an EIP in a VPC, ensure that the VPC has an Internet gateway attached. For more information, see the AttachInternetGateway method.
By default, the EIP is disassociated every time you stop and start the instance. For a persistent association, you can add the osc.fcu.eip.auto-attach tag to the instance with the EIP as value. For more information, see the CreateTags method.

[NOTE]
You can associate an EIP with a NAT gateway only when creating the NAT gateway. To modify its EIP, you need to delete the NAT gateway and re-create it with the new EIP. For more information, see the CreateNatGateway method.

Code samples

osc-cli fcu AssociateAddress --profile "default" \
  --AllocationId "string" \
  --AllowReassociation True \
  --InstanceId "string" \
  --NetworkInterfaceId "string" \
  --PrivateIpAddress "string" \
  --PublicIp "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=AssociateAddress' \
  --data-urlencode 'AllocationId=string' \
  --data-urlencode 'AllowReassociation=true' \
  --data-urlencode 'InstanceId=string' \
  --data-urlencode 'NetworkInterfaceId=string' \
  --data-urlencode 'PrivateIpAddress=string' \
  --data-urlencode 'PublicIp=string'

Parameters

Parameter Type Required Description
AllocationId string false The allocation ID of the EIP. In a VPC, this parameter is required.
AllowReassociation boolean false - If set to true, allows the EIP to be associated with the instance or network interface that you specify even if it is already associated with another instance or network interface.
- If set to false, prevents the EIP from being associated with the instance or network interface that you specify if it is already associated with another instance or network interface.

(By default, true in the public Cloud, false in a VPC.)
InstanceId string false The ID of the instance.
- In the public Cloud, this parameter is required.
- In a VPC, this parameter is required if the instance has only one network interface. Otherwise, you need to specify the NetworkInterfaceId parameter instead. You cannot specify both parameters at the same time.
NetworkInterfaceId string false (VPC only) The ID of the network interface.
This parameter is required if the instance has more than one network interface attached. Otherwise, you need to specify the InstanceId parameter instead. You cannot specify both parameters at the same time.
PrivateIpAddress string false (VPC only) The primary or secondary private IP of the specified network interface. By default, the primary private IP.
PublicIp string false The EIP. In the public Cloud, this parameter is required.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). AssociateAddressResponse

Example responses

200 Response

{
  "associationId": "string",
  "requestId": "string",
  "return": true
}

DescribeAddresses

GET /DescribeAddresses

Describes one or more External IPs (EIPs) allocated to your account.
By default, this action returns information about all your EIPs: available, associated with an instance or network interface, or used for a NAT gateway.
You can use the Filter.N parameter to filter your EIPs on the following properties:

Code samples

osc-cli fcu DescribeAddresses --profile "default" \
  --AllocationId '["string"]' \
  --Filter '[ \
      { \
        "Name": "string", \
        "Value": ["string"] \
      } \
    ]' \
  --PublicIp '["string"]'


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeAddresses' \
  --data-urlencode 'AllocationId.1=string' \
  --data-urlencode 'Filter.1.Name=string' \
  --data-urlencode 'Filter.1.Value.1=string' \
  --data-urlencode 'PublicIp.1=string'

Parameters

Parameter Type Required Description
AllocationId [string] false One ore more allocation IDs.
Filter [Filter] false One or more filters.
» Name string false The name of the filter.
» Value [string] false One or more filter values.
PublicIp [string] false One or more EIPs.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DescribeAddressesResponse

Example responses

200 Response

{
  "addressesSet": [
    {
      "allocationId": "string",
      "associationId": "string",
      "domain": "string",
      "instanceId": "string",
      "networkInterfaceId": "string",
      "networkInterfaceOwnerId": "string",
      "privateIpAddress": "string",
      "publicIp": "string"
    }
  ],
  "requestId": "string"
}

DisassociateAddress

GET /DisassociateAddress

Disassociates an External IP (EIP) from the instance or network interface it is associated with.

[NOTE]
To disassociate an EIP from a NAT gateway, you need to delete the NAT gateway. For more information, see the DeleteNatGateway method.

Code samples

osc-cli fcu DisassociateAddress --profile "default" \
  --AssociationId "string" \
  --PublicIp "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DisassociateAddress' \
  --data-urlencode 'AssociationId=string' \
  --data-urlencode 'PublicIp=string'

Parameters

Parameter Type Required Description
AssociationId string false The ID that represents the association of the EIP with the instance or the network interface (required in a VPC).
PublicIp string false The EIP (required in the public Cloud).

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DisassociateAddressResponse

Example responses

200 Response

{
  "requestId": "string",
  "return": true
}

ReleaseAddress

GET /ReleaseAddress

Releases an External IP (EIP).
You can release an EIP associated with your account. This address is released in the EIP pool and can be used by someone else. Before releasing an EIP, ensure you updated all your resources communicating with this address.

Code samples

osc-cli fcu ReleaseAddress --profile "default" \
  --AllocationId "string" \
  --PublicIp "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=ReleaseAddress' \
  --data-urlencode 'AllocationId=string' \
  --data-urlencode 'PublicIp=string'

Parameters

Parameter Type Required Description
AllocationId string false The allocation ID of the EIP in your account (required in a VPC).
PublicIp string false The EIP (required in the public Cloud).

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ReleaseAddressResponse

Example responses

200 Response

{
  "requestId": "string",
  "return": true
}

Customer Gateways

CreateCustomerGateway

GET /CreateCustomerGateway

Provides information about your customer gateway.
This action registers information to identify the customer gateway that you deployed in your network.
To open a tunnel to the customer gateway, you must provide the communication protocol type, the fixed public IP of the gateway, and an Autonomous System Number (ASN).

Code samples

osc-cli fcu CreateCustomerGateway --profile "default" \
  --BgpAsn 0 \
  --IpAddress "string" \
  --Type "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=CreateCustomerGateway' \
  --data-urlencode 'BgpAsn=0' \
  --data-urlencode 'IpAddress=string' \
  --data-urlencode 'Type=string'

Parameters

Parameter Type Required Description
BgpAsn integer(int64) false The Autonomous System Number (ASN) used by the Border Gateway Protocol (BGP) to find the path to your customer gateway through the Internet (by default, 65000). This number must be between 1 and 4294967295.
IpAddress string true The public fixed IPv4 address of your customer gateway.
Type string true The communication protocol used to establish tunnel with your customer gateway (only ipsec.1 is supported).

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreateCustomerGatewayResponse

Example responses

200 Response

{
  "customerGateway": {
    "bgpAsn": 0,
    "customerGatewayId": "string",
    "ipAddress": "string",
    "state": "string",
    "tagSet": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "type": "string"
  },
  "requestId": "string"
}

DeleteCustomerGateway

GET /DeleteCustomerGateway

Deletes a customer gateway.
You must delete the VPN connection before deleting the customer gateway.

Code samples

osc-cli fcu DeleteCustomerGateway --profile "default" \
  --CustomerGatewayId "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DeleteCustomerGateway' \
  --data-urlencode 'CustomerGatewayId=string'

Parameters

Parameter Type Required Description
CustomerGatewayId string true The ID of the customer gateway you want to delete.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeleteCustomerGatewayResponse

Example responses

200 Response

{
  "requestId": "string",
  "return": true
}

DescribeCustomerGateways

GET /DescribeCustomerGateways

Describes one or more of your customer gateways.
You can use the Filter.N parameter to filter the customer gateways on the following properties:

[NOTE]
If you provide an invalid customer gateway ID, a response 400 is returned without any information about customer gateways for which you provided a valid ID.

Code samples

osc-cli fcu DescribeCustomerGateways --profile "default" \
  --CustomerGatewayId '["string"]' \
  --Filter '[ \
      { \
        "Name": "string", \
        "Value": ["string"] \
      } \
    ]'


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeCustomerGateways' \
  --data-urlencode 'CustomerGatewayId.1=string' \
  --data-urlencode 'Filter.1.Name=string' \
  --data-urlencode 'Filter.1.Value.1=string'

Parameters

Parameter Type Required Description
CustomerGatewayId [string] false One or more customer gateways IDs.
Filter [Filter] false One or more filters.
Example:
osc-cli fcu DescribeCustomerGateways \
  --Filter.1.Name "tag:KEYOFTHETAG" \
  --Filter.1.Value.1 "VALUEOFTHETAG"
» Name string false The name of the filter.
» Value [string] false One or more filter values.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DescribeCustomerGatewaysResponse

Example responses

200 Response

{
  "customerGatewaySet": [
    {
      "bgpAsn": 0,
      "customerGatewayId": "string",
      "ipAddress": "string",
      "state": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "type": "string"
    }
  ],
  "requestId": "string"
}

DHCP Options

AssociateDhcpOptions

GET /AssociateDhcpOptions

Associates a DHCP options set with a specified Virtual Private Cloud (VPC).

Code samples

osc-cli fcu AssociateDhcpOptions --profile "default" \
  --DhcpOptionsId "string" \
  --VpcId "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=AssociateDhcpOptions' \
  --data-urlencode 'DhcpOptionsId=string' \
  --data-urlencode 'VpcId=string'

Parameters

Parameter Type Required Description
DhcpOptionsId string true The ID of the DHCP options set, or default if you want to associate the default one.
VpcId string true The ID of the VPC.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). AssociateDhcpOptionsResponse

Example responses

200 Response

{
  "requestId": "string",
  "return": true
}

CreateDhcpOptions

GET /CreateDhcpOptions

Creates a set of DHCP options that you can then associate with a Virtual Private Cloud (VPC).

Code samples

osc-cli fcu CreateDhcpOptions --profile "default" \
  --DhcpConfiguration '[ \
      { \
        "Key": "string", \
        "Value": ["string"] \
      } \
    ]'


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=CreateDhcpOptions' \
  --data-urlencode 'DhcpConfiguration.1.Key=string' \
  --data-urlencode 'DhcpConfiguration.1.Value.1=string'

Parameters

Parameter Type Required Description
DhcpConfiguration [DhcpConfiguration] true A DHCP configuration option.
» Key string false The type of DHCP option (domain-name-servers | domain-name | ntp-servers | log-servers). For more information, see About DHCP Options.
» Value [string] false The values for the DHCP option (one to four IPs for the domain-name-servers, ntp-servers and log-servers options, or a domain name for the domain-name option). For more information, see About DHCP Options.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreateDhcpOptionsResponse

Example responses

200 Response

{
  "dhcpOptions": {
    "dhcpConfigurationSet": [
      {
        "key": "string",
        "valueSet": [
          {
            "value": "string"
          }
        ]
      }
    ],
    "dhcpOptionsId": "string",
    "tagSet": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  },
  "requestId": "string"
}

DeleteDhcpOptions

GET /DeleteDhcpOptions

Deletes a specified DHCP options set.
Before deleting a DHCP options set, you must disassociate it from the VPCs you associated it with. To do so, you need to associate with each VPC a new set of DHCP options, or the default one if you do not want to associate any DHCP options with the VPC.

[NOTE]
You cannot delete the default set.

Code samples

osc-cli fcu DeleteDhcpOptions --profile "default" \
  --DhcpOptionsId "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DeleteDhcpOptions' \
  --data-urlencode 'DhcpOptionsId=string'

Parameters

Parameter Type Required Description
DhcpOptionsId string true The ID of the DHCP options set.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeleteDhcpOptionsResponse

Example responses

200 Response

{
  "requestId": "string",
  "return": true
}

DescribeDhcpOptions

GET /DescribeDhcpOptions

Retrieves information about the content of one or more DHCP options sets.
You can use the Filter.N parameter to filter the described DHCP options sets on the following properties:

Code samples

osc-cli fcu DescribeDhcpOptions --profile "default" \
  --DhcpOptionsId '["string"]' \
  --Filter '[ \
      { \
        "Name": "string", \
        "Value": ["string"] \
      } \
    ]'


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeDhcpOptions' \
  --data-urlencode 'DhcpOptionsId.1=string' \
  --data-urlencode 'Filter.1.Name=string' \
  --data-urlencode 'Filter.1.Value.1=string'

Parameters

Parameter Type Required Description
DhcpOptionsId [string] false One or more IDs of DHCP options sets.
If you do not specify any ID, this action describes all your DHCP options sets.
Filter [Filter] false One or more filters.
Example:
osc-cli fcu DescribeDhcpOptions \
  --Filter.1.Name "tag:KEYOFTHETAG" \
  --Filter.1.Value.1 "VALUEOFTHETAG"
» Name string false The name of the filter.
» Value [string] false One or more filter values.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DescribeDhcpOptionsResponse

Example responses

200 Response

{
  "dhcpOptionsSet": [
    {
      "dhcpConfigurationSet": [
        {
          "key": "string",
          "valueSet": [
            {
              "value": "string"
            }
          ]
        }
      ],
      "dhcpOptionsId": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ]
    }
  ],
  "requestId": "string"
}

Images

CopyImage

GET /CopyImage

Copies an OUTSCALE machine image (OMI) to your account, from an account in the same Region.
To do so, the owner of the source OMI must share it with your account. For more information about how to share an OMI with another account, see ModifyImageAttribute.
The copy of the source OMI is independent and belongs to you.

[NOTE]
To copy an OMI between accounts in different Regions, the owner of the source OMI must export it to an OUTSCALE Object Storage (OOS) bucket using the CreateImageExportTask method, and then you need to import it using the RegisterImage method. For more information, see CreateImageExportTask and RegisterImage.

Code samples

osc-cli fcu CopyImage --profile "default" \
  --Description "string" \
  --DryRun False \
  --Name "string" \
  --SourceImageId "string" \
  --SourceRegion "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=CopyImage' \
  --data-urlencode 'Description=string' \
  --data-urlencode 'DryRun=false' \
  --data-urlencode 'Name=string' \
  --data-urlencode 'SourceImageId=string' \
  --data-urlencode 'SourceRegion=string'

Parameters

Parameter Type Required Description
Description string false A description of the new OMI.
DryRun boolean false If set to true, checks whether you have the required permissions to perform the action.
Name string false The name of the new OMI. This name must be unique for your account.
If no name is specified, the name of the new OMI follows this pattern: "source OMI name-copyX", where X is the number of the copy.
SourceImageId string true The ID of the OMI you want to copy.
SourceRegion string true The name of the source Region, which must be the same as the Region of your account.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CopyImageResponse

Example responses

200 Response

{
  "imageId": "string",
  "requestId": "string"
}

CreateImage

GET /CreateImage

Creates an OMI from an existing instance which is either running or stopped.
This action also creates a snapshot of the root volume of the instance, as well as a snapshot of each BSU volume attached to the instance.

Code samples

osc-cli fcu CreateImage --profile "default" \
  --Description "string" \
  --DryRun False \
  --InstanceId "string" \
  --Name "string" \
  --NoReboot True


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=CreateImage' \
  --data-urlencode 'Description=string' \
  --data-urlencode 'DryRun=false' \
  --data-urlencode 'InstanceId=string' \
  --data-urlencode 'Name=string' \
  --data-urlencode 'NoReboot=true'

Parameters

Parameter Type Required Description
Description string false A description for the new OMI.
DryRun boolean false If set to true, checks whether you have the required permissions to perform the action.
InstanceId string true The ID of the instance from which you want to create the OMI.
Name string true A unique name for the new OMI.
Constraints: 3-128 alphanumeric characters, underscores (_), spaces ( ), parentheses (()), slashes (/), periods (.), or dashes (-).
NoReboot boolean false If set to false, the instance shuts down before creating the OMI and then reboots. If set to true, the instance does not.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreateImageResponse

Example responses

200 Response

{
  "imageId": "string",
  "requestId": "string"
}

CreateImageExportTask

GET /CreateImageExportTask

Exports an OUTSCALE machine image (OMI) to an OUTSCALE Object Storage (OOS) bucket.
This action enables you to copy an OMI between accounts in in different Regions. To copy an OMI in the same Region, you can also use the CopyImage method. For more information, see CopyImage.
The copy of the OMI belongs to you and is independent from the source OMI.

[NOTE]
You cannot export a shared or public OMI, as they do not belong to you. To do so, you must first copy it to your account. The copy then belongs to you and you can export it. For more information, see CopyImage.

Code samples

osc-cli fcu CreateImageExportTask --profile "default" \
  --ExportToOsu '{ \
      "DiskImageFormat": "string", \
      "OsuAkSk": { \
        "AccessKey": "string", \
        "SecretKey": "string" \
      }, \
      "OsuBucket": "string", \
      "OsuPrefix": "string" \
    }' \
  --ImageId "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=CreateImageExportTask' \
  --data-urlencode 'ExportToOsu.DiskImageFormat=string' \
  --data-urlencode 'ExportToOsu.OsuAkSk.AccessKey=string' \
  --data-urlencode 'ExportToOsu.OsuAkSk.SecretKey=string' \
  --data-urlencode 'ExportToOsu.OsuBucket=string' \
  --data-urlencode 'ExportToOsu.OsuPrefix=string' \
  --data-urlencode 'ImageId=string'

Parameters

Parameter Type Required Description
ExportToOsu ExportToOsu_0 true Information about the OMI export task.
» DiskImageFormat string true The format of the export disk (qcow2 | raw).
» OsuAkSk OsuAkSk false The access key and secret key of the OOS account used to access the bucket.
»» AccessKey string false The access key of the OOS account that enables you to access the bucket.
»» SecretKey string false The secret key of the OOS account that enables you to access the bucket.
» OsuBucket string true The name of the OOS bucket where you want to export the OMI.
» OsuPrefix string false The prefix for the key of the OOS object corresponding to the image.
ImageId string true The ID of the OMI to export.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreateImageExportTaskResponse

Example responses

200 Response

{
  "imageExportTask": {
    "exportToOsu": {
      "diskImageFormat": "string",
      "osuAkSk": {
        "AccessKey": "string",
        "SecretKey": "string"
      },
      "osuBucket": "string",
      "osuManifestUrl": "string",
      "osuPrefix": "string"
    },
    "imageExport": {
      "imageId": "string"
    },
    "imageExportTaskId": "string",
    "state": "string",
    "statusMessage": "string",
    "tagSet": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  },
  "requestId": "string"
}

DeregisterImage

GET /DeregisterImage

Deregisters an OUTSCALE machine image (OMI) so that you cannot use it anymore to launch instances. However, you can still use instances already launched from this OMI.

Code samples

osc-cli fcu DeregisterImage --profile "default" \
  --ImageId "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DeregisterImage' \
  --data-urlencode 'ImageId=string'

Parameters

Parameter Type Required Description
ImageId string true The ID of the OMI you want to deregister.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeregisterImageResponse

Example responses

200 Response

{
  "requestId": "string",
  "return": true
}

DescribeImageAttribute

GET /DescribeImageAttribute

Describes a specified attribute of an OMI.
You can specify only one attribute at a time.

Code samples

osc-cli fcu DescribeImageAttribute --profile "default" \
  --Attribute "string" \
  --ImageId "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeImageAttribute' \
  --data-urlencode 'Attribute=string' \
  --data-urlencode 'ImageId=string'

Parameters

Parameter Type Required Description
Attribute string true The OMI attribute (description | launchPermission | productCodes).
ImageId string true The ID of the OMI.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DescribeImageAttributeResponse

Example responses

200 Response

{
  "description": {
    "value": "string"
  },
  "imageId": "string",
  "launchPermission": [
    {
      "group": "string",
      "userId": "string"
    }
  ],
  "productCodes": [
    {
      "productCode": "string",
      "type": "string"
    }
  ],
  "requestId": "string"
}

DescribeImageExportTasks

GET /DescribeImageExportTasks

Describes one or more image export tasks.

Code samples

osc-cli fcu DescribeImageExportTasks --profile "default" \
  --ImageExportTaskId '["string"]'


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeImageExportTasks' \
  --data-urlencode 'ImageExportTaskId.1=string'

Parameters

Parameter Type Required Description
ImageExportTaskId [string] false One or more image export tasks IDs.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DescribeImageExportTasksResponse

Example responses

200 Response

{
  "imageExportTaskSet": [
    {
      "exportToOsu": {
        "diskImageFormat": "string",
        "osuAkSk": {
          "AccessKey": "string",
          "SecretKey": "string"
        },
        "osuBucket": "string",
        "osuManifestUrl": "string",
        "osuPrefix": "string"
      },
      "imageExport": {
        "imageId": "string"
      },
      "imageExportTaskId": "string",
      "state": "string",
      "statusMessage": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ]
    }
  ],
  "requestId": "string"
}

DescribeImages

GET /DescribeImages

Describes one or more OMIs you can use.
You can filter the described OMIs using the ImageId.N, the Owner.N or the ExecutableBy.N parameters.
You can also use the Filter.N parameter to filter the OMIs on the following properties:

Code samples

osc-cli fcu DescribeImages --profile "default" \
  --ExecutableBy '["string"]' \
  --Filter '[ \
      { \
        "Name": "string", \
        "Value": ["string"] \
      } \
    ]' \
  --ImageId '["string"]' \
  --Owner '["string"]'


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeImages' \
  --data-urlencode 'ExecutableBy.1=string' \
  --data-urlencode 'Filter.1.Name=string' \
  --data-urlencode 'Filter.1.Value.1=string' \
  --data-urlencode 'ImageId.1=string' \
  --data-urlencode 'Owner.1=string'

Parameters

Parameter Type Required Description
ExecutableBy [string] false The account ID of one or more users who have launch permissions for the OMIs.
Filter [Filter] false One or more filters.
Example:
osc-cli fcu DescribeImages \
  --Filter.1.Name "tag:KEYOFTHETAG" \
  --Filter.1.Value.1 "VALUEOFTHETAG"
» Name string false The name of the filter.
» Value [string] false One or more filter values.
ImageId [string] false One or more OMI IDs.
Owner [string] false The account ID of one or more owners of OMIs. By default, all the OMIs for which you have launch permissions are described.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DescribeImagesResponse

Example responses

200 Response

{
  "imagesSet": [
    {
      "architecture": "string",
      "blockDeviceMapping": [
        {
          "deviceName": "string",
          "ebs": {
            "deleteOnTermination": true,
            "iops": 0,
            "snapshotId": "string",
            "volumeSize": 0,
            "volumeType": "string"
          },
          "noDevice": "string",
          "virtualName": "string"
        }
      ],
      "description": "string",
      "hypervisor": "string",
      "imageId": "string",
      "imageLocation": "string",
      "imageOwnerAlias": "string",
      "imageOwnerId": "string",
      "imageState": "string",
      "imageType": "string",
      "isPublic": true,
      "name": "string",
      "platform": "string",
      "productCodes": [
        {
          "productCode": "string",
          "type": "string"
        }
      ],
      "rootDeviceName": "string",
      "rootDeviceType": "string",
      "stateReason": {
        "code": "string",
        "message": "string"
      },
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "virtualizationType": "string"
    }
  ],
  "requestId": "string"
}

ModifyImageAttribute

GET /ModifyImageAttribute

Modifies the specified attribute of an OUTSCALE machine image (OMI).
You can modify the permissions to access the OMI by adding or removing account IDs or groups. You can share an OMI with a user that is in the same Region. The user can create a copy of the OMI you shared, obtaining all the rights for the copy of the OMI. For more information, see CopyImage.

Code samples

osc-cli fcu ModifyImageAttribute --profile "default" \
  --Description '{ \
      "Value": "string" \
    }' \
  --ImageId "string" \
  --LaunchPermission '{ \
      "Add": [ \
        {"Group": "string", "UserId": "string"} \
      ], \
      "Remove": [ \
        {"Group": "string", "UserId": "string"} \
      ] \
    }' \
  --ProductCode '["string"]'


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=ModifyImageAttribute' \
  --data-urlencode 'Description.Value=string' \
  --data-urlencode 'ImageId=string' \
  --data-urlencode 'LaunchPermission.Add.1.Group=string' \
  --data-urlencode 'LaunchPermission.Add.1.UserId=string' \
  --data-urlencode 'LaunchPermission.Remove.1.Group=string' \
  --data-urlencode 'LaunchPermission.Remove.1.UserId=string' \
  --data-urlencode 'ProductCode.1=string'

Parameters

Parameter Type Required Description
Description Description_0 false A new description of the resource.
» Value string false The value specified for the resource attribute.
ImageId string true The ID of the OMI.
LaunchPermission LaunchPermission_0 false Permissions to access the OMI. If you specify both Add and Remove attributes in the request, only Add is taken into account.
» Add [Add] false The account ID you want to add to the list of launch permissions for the OMI.
»» Group string false The name of the group (all if public).
»» UserId string false The account ID of the user.
» Remove [Remove] false The account ID you want to remove from the list of launch permissions for the OMI.
»» Group string false The name of the group (all if public).
»» UserId string false The account ID of the user.
» ProductCode [string] false One or more product codes to add to the OMI. Once a product code is applied to an OMI, it cannot be removed.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ModifyImageAttributeResponse

Example responses

200 Response

{
  "requestId": "string",
  "return": true
}

RegisterImage

GET /RegisterImage

Registers an OUTSCALE machine image (OMI) to finalize its creation process.
You can register an OMI from a snapshot of a root device to create an OMI based on this snapshot. You can also register an OMI that has been exported to an S3-compatible bucket to create a copy of it in your account. For more information about OMI export to an OUTSCALE Storage Service (OOS) bucket, see CreateImageExportTask.
You can register an OMI using a pre-signed URL of the manifest file of the OMI. You do not need any permission for this OMI, or the bucket in which it is contained. The manifest file is obsolete seven days after a completed export as it contains pre-signed URLs to the appropriate snapshots (pre-signed URL are valid for only seven days).
Once the OMI is registered, you can launch an instance from this OMI. The copy of the source OMI is independent and belongs to you.

Code samples

osc-cli fcu RegisterImage --profile "default" \
  --Architecture "string" \
  --BlockDeviceMapping '[ \
      { \
        "DeviceName": "string", \
        "Ebs": {"DeleteOnTermination": True, "Iops": 0, "SnapshotId": "string", "VolumeSize": 0, "VolumeType": "string"}, \
        "NoDevice": "string", \
        "VirtualName": "string" \
      } \
    ]' \
  --Description "string" \
  --ImageLocation "string" \
  --Name "string" \
  --RootDeviceName "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=RegisterImage' \
  --data-urlencode 'Architecture=string' \
  --data-urlencode 'BlockDeviceMapping.1.DeviceName=string' \
  --data-urlencode 'BlockDeviceMapping.1.Ebs.DeleteOnTermination=true' \
  --data-urlencode 'BlockDeviceMapping.1.Ebs.Iops=0' \
  --data-urlencode 'BlockDeviceMapping.1.Ebs.SnapshotId=string' \
  --data-urlencode 'BlockDeviceMapping.1.Ebs.VolumeSize=0' \
  --data-urlencode 'BlockDeviceMapping.1.Ebs.VolumeType=string' \
  --data-urlencode 'BlockDeviceMapping.1.NoDevice=string' \
  --data-urlencode 'BlockDeviceMapping.1.VirtualName=string' \
  --data-urlencode 'Description=string' \
  --data-urlencode 'ImageLocation=string' \
  --data-urlencode 'Name=string' \
  --data-urlencode 'RootDeviceName=string'

Parameters

Parameter Type Required Description
Architecture string false The architecture of the OMI (set to i386 by default).
BlockDeviceMapping [BlockDeviceMapping_1] false One or more Block Device Mapping entries.
» DeviceName string false The device name for the volume. For a root device, you must use /dev/sda1. For other volumes, you must use /dev/sdX, /dev/sdXX, /dev/xvdX, or /dev/xvdXX (where the first X is a letter between b and z, and the second X is a letter between a and z).
» Ebs Ebs_0 false One or more parameters to map a volume to DeviceName at launch.You can specify either Ebs or VirtualName, but not both.
»» DeleteOnTermination boolean false By default or if set to true, the volume is deleted when terminating the instance. If false, the volume is not deleted when terminating the instance.
»» Iops integer false The number of I/O operations per second. This parameter must be specified only if you create an io1 volume. The maximum number of IOPS allowed for io1 volumes is 13000 with a maximum performance ratio of 300 IOPS per gibibyte.
»» SnapshotId string false The ID of the snapshot used to create the volume.
»» VolumeSize integer false The size of the volume, in gibibytes (GiB).
If you specify a snapshot ID, the volume size must be at least equal to the snapshot size.
If you specify a snapshot ID but no volume size, the volume is created with a size similar to the snapshot one.
»» VolumeType string false The type of the volume (standard | io1 | gp2). If not specified in the request, a standard volume is created. For more information about volumes types, see Volume Types and IOPS.
» NoDevice string false Prevents a device from being mapped to DeviceName at launch, if the OMI used contains a mapping for DeviceName.
To use this parameter, specify any value other than null, for example an empty string. Example with OSC CLI:
  --BlockDeviceMapping.1.DeviceName "/dev/xvdb" \
  --BlockDeviceMapping.1.NoDevice ""
» VirtualName string false The name of an ephemeral storage disk (ephemeralN) to map to DeviceName at launch.
You can specify either Ebs or VirtualName, but not both.
Description string false A description for the OMI.
ImageLocation string false The pre-signed URL of the OMI manifest file, or the full path to the OMI stored in a bucket. If you specify this parameter, a copy of the OMI is created in your account.
Name string true A unique name for the OMI.
RootDeviceName string false The name of the root device. This value must be /dev/sda1.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). RegisterImageResponse

Example responses

200 Response

{
  "imageId": "string",
  "requestId": "string"
}

Instances

DescribeInstanceAttribute

GET /DescribeInstanceAttribute

Describes a specified attribute of an instance.
You can specify only one attribute at a time. You can describe the sourceDestCheck attribute only if the instance is in a Virtual Private Cloud (VPC).

Code samples

osc-cli fcu DescribeInstanceAttribute --profile "default" \
  --Attribute "string" \
  --InstanceId "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeInstanceAttribute' \
  --data-urlencode 'Attribute=string' \
  --data-urlencode 'InstanceId=string'

Parameters

Parameter Type Required Description
Attribute string true The instance attribute (ramdisk | userData | instanceInitiatedShutdownBehavior | rootDeviceName | instanceType | blockDeviceMapping | groupSet | sourceDestCheck | disableApiTermination).
InstanceId string true The ID of the instance.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DescribeInstanceAttributeResponse

Example responses

200 Response

{
  "blockDeviceMapping": [
    {
      "deviceName": "string",
      "ebs": {
        "attachTime": "string",
        "deleteOnTermination": true,
        "status": "string",
        "volumeId": "string"
      }
    }
  ],
  "disableApiTermination": {
    "value": true
  },
  "ebsOptimized": {
    "value": true
  },
  "groupSet": [
    {
      "groupId": "string",
      "groupName": "string"
    }
  ],
  "instanceId": "string",
  "instanceInitiatedShutdownBehavior": {
    "value": "string"
  },
  "instanceType": {
    "value": "string"
  },
  "ramdisk": {
    "Value": "string"
  },
  "requestId": "string",
  "rootDeviceName": {
    "Value": "string"
  },
  "sourceDestCheck": {
    "value": true
  },
  "userData": {
    "value": "string"
  }
}

DescribeInstanceStatus

GET /DescribeInstanceStatus

Describes the status of one or more instances.
You can use the Filter.N parameter to filter the described instances status on the following properties:

Code samples

osc-cli fcu DescribeInstanceStatus --profile "default" \
  --Filter '[ \
      { \
        "Name": "string", \
        "Value": ["string"] \
      } \
    ]' \
  --IncludeAllInstances True \
  --InstanceId '["string"]' \
  --MaxResults 0 \
  --NextToken "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeInstanceStatus' \
  --data-urlencode 'Filter.1.Name=string' \
  --data-urlencode 'Filter.1.Value.1=string' \
  --data-urlencode 'IncludeAllInstances=true' \
  --data-urlencode 'InstanceId.1=string' \
  --data-urlencode 'MaxResults=0' \
  --data-urlencode 'NextToken=string'

Parameters

Parameter Type Required Description
Filter [Filter] false One or more filters.
Example:
osc-cli fcu DescribeInstanceStatus \
  --Filter.1.Name "availability-zone" \
  --Filter.1.Value.1 "eu-west-2a"
» Name string false The name of the filter.
» Value [string] false One or more filter values.
IncludeAllInstances boolean false If set to true, includes the status of all instances. By default or if set to false, only includes the status of running instances.
InstanceId [string] false One or more instance IDs.
MaxResults integer false The maximum number of results that can be returned in a single page. You can use NextToken to request the next results pages. This value is between 5 and 1000. If you provide a value larger than 1000, only 1000 results are returned. You cannot specify both this parameter and the InstanceId parameter in the same request.
NextToken string false The token to request the next results page.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DescribeInstanceStatusResponse

Example responses

200 Response

{
  "instanceStatusSet": [
    {
      "availabilityZone": "string",
      "eventsSet": [
        {
          "code": "string",
          "description": "string",
          "notAfter": "string",
          "notBefore": "string"
        }
      ],
      "instanceId": "string",
      "instanceState": {
        "code": 0,
        "name": "string"
      },
      "instanceStatus": {
        "details": [
          {
            "impairedSince": "string",
            "name": "string",
            "status": "string"
          }
        ],
        "status": "string"
      },
      "systemStatus": {
        "details": [
          {
            "impairedSince": "string",
            "name": "string",
            "status": "string"
          }
        ],
        "status": "string"
      }
    }
  ],
  "nextToken": "string",
  "requestId": "string"
}

DescribeInstances

GET /DescribeInstances

Describes one or more of your instances.
If you provide one or more instance IDs, this action returns a description for all of these instances. If you do not provide any instance ID, this action returns a description for all of the instances that belong to you. If you provide an invalid instance ID, an error is returned. If you provide the ID of an instance that does not belong to you, the description of this instance is not included in the response. The refresh interval for data returned by this action is one hour, meaning that a terminated instance may appear in the response.
You can use the Filter.N parameter to filter the described instances on the following properties:

Code samples

osc-cli fcu DescribeInstances --profile "default" \
  --Filter '[ \
      { \
        "Name": "string", \
        "Value": ["string"] \
      } \
    ]' \
  --InstanceId '["string"]' \
  --MaxResults 0 \
  --NextToken "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeInstances' \
  --data-urlencode 'Filter.1.Name=string' \
  --data-urlencode 'Filter.1.Value.1=string' \
  --data-urlencode 'InstanceId.1=string' \
  --data-urlencode 'MaxResults=0' \
  --data-urlencode 'NextToken=string'

Parameters

Parameter Type Required Description
Filter [Filter] false One or more filters.
Example:
osc-cli fcu DescribeInstances \
  --Filter.1.Name "tag:KEYOFTHETAG" \
  --Filter.1.Value.1 "VALUEOFTHETAG"
» Name string false The name of the filter.
» Value [string] false One or more filter values.
InstanceId [string] false One or more instance IDs.
MaxResults integer false The maximum number of results that can be returned in a single page. You can use NextToken to retrieve next results pages. This value is in between 5 and 1000. If you provide a value larger than 1000, only 1000 results are returned. You cannot specify both this parameter and the InstanceId parameter in the same request.
NextToken string false The token to request the next results page.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DescribeInstancesResponse

Example responses

200 Response

{
  "nextToken": "string",
  "requestId": "string",
  "reservationSet": [
    {
      "groupSet": [
        {
          "groupId": "string",
          "groupName": "string"
        }
      ],
      "instancesSet": [
        {
          "amiLaunchIndex": 0,
          "architecture": "string",
          "blockDeviceMapping": [
            {
              "deviceName": "string",
              "ebs": {
                "attachTime": "string",
                "deleteOnTermination": true,
                "status": "string",
                "volumeId": "string"
              }
            }
          ],
          "clientToken": "string",
          "dnsName": "string",
          "ebsOptimized": true,
          "groupSet": [
            {
              "groupId": "string",
              "groupName": "string"
            }
          ],
          "hypervisor": "string",
          "iamInstanceProfile": {
            "arn": "string",
            "id": "string"
          },
          "imageId": "string",
          "instanceId": "string",
          "instanceLifecycle": "string",
          "instanceState": {
            "code": 0,
            "name": "string"
          },
          "instanceType": "string",
          "ipAddress": "string",
          "kernelId": "string",
          "keyName": "string",
          "launchTime": "string",
          "monitoring": {
            "state": "string"
          },
          "networkInterfaceSet": [
            {
              "association": {
                "ipOwnerId": "string",
                "publicDnsName": "string",
                "publicIp": "string"
              },
              "attachment": {
                "attachTime": "string",
                "attachmentId": "string",
                "deleteOnTermination": true,
                "deviceIndex": 0,
                "status": "string"
              },
              "description": "string",
              "groupSet": [
                {
                  "groupId": "string",
                  "groupName": "string"
                }
              ],
              "macAddress": "string",
              "networkInterfaceId": "string",
              "ownerId": "string",
              "privateDnsName": "string",
              "privateIpAddress": "string",
              "privateIpAddressesSet": [
                {
                  "association": {
                    "ipOwnerId": "string",
                    "publicDnsName": "string",
                    "publicIp": "string"
                  },
                  "primary": true,
                  "privateDnsName": "string",
                  "privateIpAddress": "string"
                }
              ],
              "sourceDestCheck": true,
              "status": "string",
              "subnetId": "string",
              "vpcId": "string"
            }
          ],
          "placement": {
            "availabilityZone": "string",
            "groupName": "string",
            "tenancy": "string"
          },
          "platform": "string",
          "privateDnsName": "string",
          "privateIpAddress": "string",
          "productCodes": [
            {
              "productCode": "string",
              "type": "string"
            }
          ],
          "ramdiskId": "string",
          "reason": "string",
          "rootDeviceName": "string",
          "rootDeviceType": "string",
          "sourceDestCheck": true,
          "spotInstanceRequestId": "string",
          "sriovNetSupport": "string",
          "stateReason": {
            "code": "string",
            "message": "string"
          },
          "subnetId": "string",
          "tagSet": [
            {
              "key": "string",
              "value": "string"
            }
          ],
          "virtualizationType": "string",
          "vpcId": "string"
        }
      ],
      "ownerId": "string",
      "requesterId": "string",
      "reservationId": "string"
    }
  ]
}

GetConsoleOutput

GET /GetConsoleOutput

Gets the console output for an instance. This console provides the most recent 64 KiB output.

[NOTE]
On Windows instances, the console is handled only on the first boot. It returns no output after the first boot.

Code samples

osc-cli fcu GetConsoleOutput --profile "default" \
  --InstanceId "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=GetConsoleOutput' \
  --data-urlencode 'InstanceId=string'

Parameters

Parameter Type Required Description
InstanceId string true The ID of the instance.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). GetConsoleOutputResponse

Example responses

200 Response

{
  "instanceId": "string",
  "output": "string",
  "requestId": "string",
  "timestamp": "string"
}

GetPasswordData

GET /GetPasswordData

Retrieves the administrator password for a Windows running instance.
The administrator password is encrypted using the keypair you specified when launching the instance.

[NOTE]
The administrator password is generated only on the first boot of the Windows instance. It is not returned after the first boot.

Code samples

osc-cli fcu GetPasswordData --profile "default" \
  --InstanceId "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=GetPasswordData' \
  --data-urlencode 'InstanceId=string'

Parameters

Parameter Type Required Description
InstanceId string true The ID of the instance.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). GetPasswordDataResponse

Example responses

200 Response

{
  "instanceId": "string",
  "passwordData": "string",
  "requestId": "string",
  "timestamp": "string"
}

ModifyInstanceAttribute

GET /ModifyInstanceAttribute

Modifies a specific attribute of an instance.
You can modify only one attribute at a time. You can modify the sourceDestCheck attribute only if the instance is in a Virtual Private Cloud (VPC).
You must stop the instance before modifying the following attributes:

Code samples

osc-cli fcu ModifyInstanceAttribute --profile "default" \
  --BlockDeviceMapping '[ \
      { \
        "DeviceName": "string", \
        "Ebs": {"DeleteOnTermination": True, "VolumeId": "string"}, \
        "NoDevice": "string", \
        "VirtualName": "string" \
      } \
    ]' \
  --DisableApiTermination '{ \
      "Value": True \
    }' \
  --EbsOptimized '{ \
      "Value": True \
    }' \
  --GroupId '["string"]' \
  --InstanceId "string" \
  --InstanceInitiatedShutdownBehavior '{ \
      "Value": "string" \
    }' \
  --InstanceType '{ \
      "Value": "string" \
    }' \
  --SourceDestCheck '{ \
      "Value": True \
    }' \
  --UserData '{ \
      "Value": "string" \
    }'


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=ModifyInstanceAttribute' \
  --data-urlencode 'BlockDeviceMapping.1.DeviceName=string' \
  --data-urlencode 'BlockDeviceMapping.1.Ebs.DeleteOnTermination=true' \
  --data-urlencode 'BlockDeviceMapping.1.Ebs.VolumeId=string' \
  --data-urlencode 'BlockDeviceMapping.1.NoDevice=string' \
  --data-urlencode 'BlockDeviceMapping.1.VirtualName=string' \
  --data-urlencode 'DisableApiTermination.Value=true' \
  --data-urlencode 'EbsOptimized.Value=true' \
  --data-urlencode 'GroupId.1=string' \
  --data-urlencode 'InstanceId=string' \
  --data-urlencode 'InstanceInitiatedShutdownBehavior.Value=string' \
  --data-urlencode 'InstanceType.Value=string' \
  --data-urlencode 'SourceDestCheck.Value=true' \
  --data-urlencode 'UserData.Value=string'

Parameters

Parameter Type Required Description
BlockDeviceMapping [BlockDeviceMapping_0] false The block device mapping of the instance. This parameter modifies the DeleteOnTermination attribute for volumes attached to the instance.
» DeviceName string false The device name for the volume. For a root device, you must use /dev/sda1. For other volumes, you must use /dev/sdX, /dev/sdXX, /dev/xvdX, or /dev/xvdXX (where the first X is a letter between b and z, and the second X is a letter between a and z).
» Ebs Ebs_1 false One or more parameters used to automatically set up volumes when you launch the instance.
»» DeleteOnTermination boolean false By default or if set to true, the volume is deleted when terminating the instance. If false, the volume is not deleted when terminating the instance.
»» VolumeId string false The ID of the volume.
» NoDevice string false Removes the specified device included in the block device mapping.
» VirtualName string false The name of the virtual device.
DisableApiTermination DisableApiTermination_0 false If true, you cannot terminate the instance unless you change this parameter back to false.
» Value boolean false A boolean value (true or false) that can be used when the resource is of boolean type.
EbsOptimized EbsOptimized_0 false This parameter is not available. It is present in our API for the sake of historical compatiblity with AWS.
» Value boolean false A boolean value (true or false) that can be used when the resource is of boolean type.
GroupId [string] false A list of security groups IDs associated with the instance.
InstanceId string true The ID of the instance.
InstanceInitiatedShutdownBehavior InstanceInitiatedShutdownBehavior_0 false The instance behavior when you stop it. By default or if set to stop, the instance stops. If set to restart, the instance stops then automatically restarts. If set to terminate, the instance stops and is terminated.
» Value string false The value specified for the resource attribute.
InstanceType InstanceType_0 false The type of instance. For more information, see Instance Types.
» Value string false The value specified for the resource attribute.
SourceDestCheck SourceDestCheck_0 false (VPC only)If true, the source/destination check is enabled. If false, it is disabled. This value must be false for a NAT instance to perform Network Address Translation (NAT) in a VPC.
» Value boolean false A boolean value (true or false) that can be used when the resource is of boolean type.
UserData UserData_0 false The Base64-encoded MIME user data, limited to 500 kibibytes (KiB).
» Value string false The value to use for the resource attribute.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ModifyInstanceAttributeResponse

Example responses

200 Response

{
  "requestId": "string",
  "return": true
}

ModifyInstanceKeypair

GET /ModifyInstanceKeypair

Modifies the keypair associated with a specified instance.
When you replace the keypair of an instance with another one, the metadata of the instance is modified to reflect the new public key, but the replacement is still not effective in the operating system of the instance. To complete the replacement and effectively apply the new keypair, you need to perform other actions inside the instance. For more information, see Modifying the Keypair of an Instance.

Code samples

osc-cli fcu ModifyInstanceKeypair --profile "default" \
  --InstanceId "string" \
  --KeyName "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=ModifyInstanceKeypair' \
  --data-urlencode 'InstanceId=string' \
  --data-urlencode 'KeyName=string'

Parameters

Parameter Type Required Description
InstanceId string true The ID of the instance.
KeyName string true The name of the keypair.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ModifyInstanceKeypairResponse

Example responses

200 Response

{
  "requestId": "string"
}

RebootInstances

GET /RebootInstances

Reboots one or more instances.
This operation sends a reboot request to one or more specified instance. This is an asynchronous action that queues this reboot request. This action only reboots instances that are valid and that belong to you.

Code samples

osc-cli fcu RebootInstances --profile "default" \
  --InstanceId '["string"]'


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=RebootInstances' \
  --data-urlencode 'InstanceId.1=string'

Parameters

Parameter Type Required Description
InstanceId [string] true The IDs of the instances you want to reboot.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). RebootInstancesResponse

Example responses

200 Response

{
  "requestId": "string",
  "return": true
}

RunInstances

GET /RunInstances

Creates instances, and then launches them.
This action enables you to create a specified number of instances using an OMI which you are allowed to use, and then to automatically launch them.
The instances remain in the pending state until they are created and ready to be used. Once automatically launched, they are in the running state.
To check the state of your instance, call the DescribeInstances method.
If not specified, the security group used by the service is the default one.
The metadata server enables you to get the public key provided when the instance is launched. Official OMIs contain a script to get this public key and put it inside the instance to provide secure access without password.

Code samples

osc-cli fcu RunInstances --profile "default" \
  --BlockDeviceMapping '[ \
      { \
        "DeviceName": "string", \
        "Ebs": {"DeleteOnTermination": True, "Iops": 0, "SnapshotId": "string", "VolumeSize": 0, "VolumeType": "string"}, \
        "NoDevice": "string", \
        "VirtualName": "string" \
      } \
    ]' \
  --ClientToken "string" \
  --DisableApiTermination True \
  --DryRun False \
  --EbsOptimized True \
  --ImageId "string" \
  --InstanceInitiatedShutdownBehavior "string" \
  --InstanceType "string" \
  --KeyName "string" \
  --MaxCount 0 \
  --MinCount 0 \
  --NetworkInterface '[ \
      { \
        "DeleteOnTermination": True, \
        "Description": "string", \
        "DeviceIndex": 0, \
        "NetworkInterfaceId": "string", \
        "PrivateIpAddress": "string", \
        "PrivateIpAddressesSet": [{"Primary": True, "PrivateIpAddress": "string"}], \
        "SecondaryPrivateIpAddressCount": 0, \
        "SecurityGroupId": ["string"], \
        "SubnetId": "string" \
      } \
    ]' \
  --Placement '{ \
      "AvailabilityZone": "string", \
      "Tenancy": "string" \
    }' \
  --PrivateIpAddress "string" \
  --PrivateIpAddresses "string" \
  --SecurityGroup '["string"]' \
  --SecurityGroupId '["string"]' \
  --SubnetId "string" \
  --UserData "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=RunInstances' \
  --data-urlencode 'BlockDeviceMapping.1.DeviceName=string' \
  --data-urlencode 'BlockDeviceMapping.1.Ebs.DeleteOnTermination=true' \
  --data-urlencode 'BlockDeviceMapping.1.Ebs.Iops=0' \
  --data-urlencode 'BlockDeviceMapping.1.Ebs.SnapshotId=string' \
  --data-urlencode 'BlockDeviceMapping.1.Ebs.VolumeSize=0' \
  --data-urlencode 'BlockDeviceMapping.1.Ebs.VolumeType=string' \
  --data-urlencode 'BlockDeviceMapping.1.NoDevice=string' \
  --data-urlencode 'BlockDeviceMapping.1.VirtualName=string' \
  --data-urlencode 'ClientToken=string' \
  --data-urlencode 'DisableApiTermination=true' \
  --data-urlencode 'DryRun=false' \
  --data-urlencode 'EbsOptimized=true' \
  --data-urlencode 'ImageId=string' \
  --data-urlencode 'InstanceInitiatedShutdownBehavior=string' \
  --data-urlencode 'InstanceType=string' \
  --data-urlencode 'KeyName=string' \
  --data-urlencode 'MaxCount=0' \
  --data-urlencode 'MinCount=0' \
  --data-urlencode 'NetworkInterface.1.DeleteOnTermination=true' \
  --data-urlencode 'NetworkInterface.1.Description=string' \
  --data-urlencode 'NetworkInterface.1.DeviceIndex=0' \
  --data-urlencode 'NetworkInterface.1.NetworkInterfaceId=string' \
  --data-urlencode 'NetworkInterface.1.PrivateIpAddress=string' \
  --data-urlencode 'NetworkInterface.1.PrivateIpAddressesSet.1.Primary=true' \
  --data-urlencode 'NetworkInterface.1.PrivateIpAddressesSet.1.PrivateIpAddress=string' \
  --data-urlencode 'NetworkInterface.1.SecondaryPrivateIpAddressCount=0' \
  --data-urlencode 'NetworkInterface.1.SecurityGroupId.1=string' \
  --data-urlencode 'NetworkInterface.1.SubnetId=string' \
  --data-urlencode 'Placement.AvailabilityZone=string' \
  --data-urlencode 'Placement.Tenancy=string' \
  --data-urlencode 'PrivateIpAddress=string' \
  --data-urlencode 'PrivateIpAddresses=string' \
  --data-urlencode 'SecurityGroup.1=string' \
  --data-urlencode 'SecurityGroupId.1=string' \
  --data-urlencode 'SubnetId=string' \
  --data-urlencode 'UserData=string'

Parameters

Parameter Type Required Description
BlockDeviceMapping [BlockDeviceMapping_1] false One or more block device mappings of the instance.
» DeviceName string false The device name for the volume. For a root device, you must use /dev/sda1. For other volumes, you must use /dev/sdX, /dev/sdXX, /dev/xvdX, or /dev/xvdXX (where the first X is a letter between b and z, and the second X is a letter between a and z).
» Ebs Ebs_0 false One or more parameters to map a volume to DeviceName at launch.You can specify either Ebs or VirtualName, but not both.
»» DeleteOnTermination boolean false By default or if set to true, the volume is deleted when terminating the instance. If false, the volume is not deleted when terminating the instance.
»» Iops integer false The number of I/O operations per second. This parameter must be specified only if you create an io1 volume. The maximum number of IOPS allowed for io1 volumes is 13000 with a maximum performance ratio of 300 IOPS per gibibyte.
»» SnapshotId string false The ID of the snapshot used to create the volume.
»» VolumeSize integer false The size of the volume, in gibibytes (GiB).
If you specify a snapshot ID, the volume size must be at least equal to the snapshot size.
If you specify a snapshot ID but no volume size, the volume is created with a size similar to the snapshot one.
»» VolumeType string false The type of the volume (standard | io1 | gp2). If not specified in the request, a standard volume is created. For more information about volumes types, see Volume Types and IOPS.
» NoDevice string false Prevents a device from being mapped to DeviceName at launch, if the OMI used contains a mapping for DeviceName.
To use this parameter, specify any value other than null, for example an empty string. Example with OSC CLI:
  --BlockDeviceMapping.1.DeviceName "/dev/xvdb" \
  --BlockDeviceMapping.1.NoDevice ""
» VirtualName string false The name of an ephemeral storage disk (ephemeralN) to map to DeviceName at launch.
You can specify either Ebs or VirtualName, but not both.
ClientToken string false A unique identifier which enables you to manage the idempotency.
DisableApiTermination boolean false If true, you cannot terminate the instance unless you change this parameter back to false.
DryRun boolean false If true, checks whether you have the required permissions to perform the action.
EbsOptimized boolean false This parameter is not available. It is present in our API for the sake of historical compatibility with AWS.
ImageId string true The ID of the OMI. You can find the list of OMIs by calling the DescribeImages method.
InstanceInitiatedShutdownBehavior string false The instance behavior when you stop it. By default or if set to stop, the instance stops. If set to restart, the instance stops then automatically restarts. If set to terminate, the instance stops and is terminated.
InstanceType string false The type of instance. You can specify a TINA type (in the tinavW.cXrYpZ or tinavW.cXrY format), or an AWS type (for example, t2.small, which is the default value).
If you specify an AWS type, it is converted in the background to its corresponding TINA type, but the AWS type is still returned. The TINA type is associated with a performance flag. For more information, see Instance Types.
KeyName string false The name of the keypair.
MaxCount integer true The maximum number of instances you want to launch. If all the instances cannot be created, the largest possible number of instances above MinCount are created and launched.
MinCount integer true The minimum number of instances you want to launch. If this number of instances cannot be created, FCU does not create and launch any instance.
NetworkInterface [NetworkInterface_0] false One or more network interfaces. If you specify this parameter, you must define one network interface as the primary one of the instance with 0 as its device index.
» DeleteOnTermination boolean false By default or if set to true, the network interface is deleted when the instance is terminated. You can specify this parameter only for a new network interface. To modify this value for an existing network interface, see ModifyNetworkInterfaceAttribute.
» Description string false The description of the network interface, if you are creating a network interface when launching an instance.
» DeviceIndex integer false The index of the instance device for the network interface attachment (between 0 and 7, both included). This parameter is required if you create a network interface when launching an instance.
» NetworkInterfaceId string false The ID of the network interface, if you are attaching an existing network interface when launching an instance.
» PrivateIpAddress string false The private IP of the network interface, if you are creating a network interface when launching an instance.
» PrivateIpAddressesSet [PrivateIpAddressesSet] false One or more private IPs to assign to the network interface (only one can be primary), if you are creating a network interface when launching an instance.
»» Primary boolean false Indicates whether it is the primary private IP.
»» PrivateIpAddress string false The private IPs.
» SecondaryPrivateIpAddressCount integer false The number of secondary private IPs (cannot be specified if you specified more than one private IP in the PrivateIPAddressesSet.N parameter), if you are creating a network interface when launching an instance.
» SecurityGroupId [string] false One or more IDs of the security groups of the network interface, if you are creating a network interface when launching an instance.
» SubnetId string false The ID of the subnet associated with the network string, if you are creating a network interface when launching an instance.
Placement Placement_0 false A specific placement where you want to create the instances (tenancy options).
» AvailabilityZone string false The Availability Zone of the instance.
» Tenancy string false The tenancy of the instance (default | dedicated).
PrivateIpAddress string false In a VPC, the unique primary IP. The IP must come from the IP range of the subnet.
PrivateIpAddresses string false In a VPC, the list of primary IPs when you create several instances. The IPs must come from the IP range of the subnet.
SecurityGroup [string] false One or more security group names.
SecurityGroupId [string] false One or more security group IDs.
SubnetId string false In a VPC, the ID of the subnet in which you want to launch the instance.
UserData string false Data or script used to add a specific configuration to the instance. It must be Base64-encoded and is limited to 500 kibibytes (KiB).

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). RunInstancesResponse

Example responses

200 Response

{
  "groupSet": [
    {
      "groupId": "string",
      "groupName": "string"
    }
  ],
  "instancesSet": [
    {
      "amiLaunchIndex": 0,
      "architecture": "string",
      "blockDeviceMapping": [
        {
          "deviceName": "string",
          "ebs": {
            "attachTime": "string",
            "deleteOnTermination": true,
            "status": "string",
            "volumeId": "string"
          }
        }
      ],
      "clientToken": "string",
      "dnsName": "string",
      "ebsOptimized": true,
      "groupSet": [
        {
          "groupId": "string",
          "groupName": "string"
        }
      ],
      "hypervisor": "string",
      "iamInstanceProfile": {
        "arn": "string",
        "id": "string"
      },
      "imageId": "string",
      "instanceId": "string",
      "instanceLifecycle": "string",
      "instanceState": {
        "code": 0,
        "name": "string"
      },
      "instanceType": "string",
      "ipAddress": "string",
      "kernelId": "string",
      "keyName": "string",
      "launchTime": "string",
      "monitoring": {
        "state": "string"
      },
      "networkInterfaceSet": [
        {
          "association": {
            "ipOwnerId": "string",
            "publicDnsName": "string",
            "publicIp": "string"
          },
          "attachment": {
            "attachTime": "string",
            "attachmentId": "string",
            "deleteOnTermination": true,
            "deviceIndex": 0,
            "status": "string"
          },
          "description": "string",
          "groupSet": [
            {
              "groupId": "string",
              "groupName": "string"
            }
          ],
          "macAddress": "string",
          "networkInterfaceId": "string",
          "ownerId": "string",
          "privateDnsName": "string",
          "privateIpAddress": "string",
          "privateIpAddressesSet": [
            {
              "association": {
                "ipOwnerId": "string",
                "publicDnsName": "string",
                "publicIp": "string"
              },
              "primary": true,
              "privateDnsName": "string",
              "privateIpAddress": "string"
            }
          ],
          "sourceDestCheck": true,
          "status": "string",
          "subnetId": "string",
          "vpcId": "string"
        }
      ],
      "placement": {
        "availabilityZone": "string",
        "groupName": "string",
        "tenancy": "string"
      },
      "platform": "string",
      "privateDnsName": "string",
      "privateIpAddress": "string",
      "productCodes": [
        {
          "productCode": "string",
          "type": "string"
        }
      ],
      "ramdiskId": "string",
      "reason": "string",
      "rootDeviceName": "string",
      "rootDeviceType": "string",
      "sourceDestCheck": true,
      "spotInstanceRequestId": "string",
      "sriovNetSupport": "string",
      "stateReason": {
        "code": "string",
        "message": "string"
      },
      "subnetId": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "virtualizationType": "string",
      "vpcId": "string"
    }
  ],
  "ownerId": "string",
  "requestId": "string",
  "requesterId": "string",
  "reservationId": "string"
}

StartInstances

GET /StartInstances

Start one or more instances.
You can start only instances that are valid and that belong to you.

Code samples

osc-cli fcu StartInstances --profile "default" \
  --InstanceId '["string"]'


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=StartInstances' \
  --data-urlencode 'InstanceId.1=string'

Parameters

Parameter Type Required Description
InstanceId [string] true One or more instance IDs.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). StartInstancesResponse

Example responses

200 Response

{
  "instancesSet": [
    {
      "currentState": {
        "code": 0,
        "name": "string"
      },
      "instanceId": "string",
      "previousState": {
        "code": 0,
        "name": "string"
      }
    }
  ],
  "requestId": "string"
}

StopInstances

GET /StopInstances

Stops one or more running instances.
You can stop only instances that are valid and that belong to you. Data stored in the instance RAM is lost.

Code samples

osc-cli fcu StopInstances --profile "default" \
  --Force True \
  --InstanceId '["string"]'


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=StopInstances' \
  --data-urlencode 'Force=true' \
  --data-urlencode 'InstanceId.1=string'

Parameters

Parameter Type Required Description
Force boolean false Forces the instance to stop.
InstanceId [string] true One or more instance IDs.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). StopInstancesResponse

Example responses

200 Response

{
  "instancesSet": [
    {
      "currentState": {
        "code": 0,
        "name": "string"
      },
      "instanceId": "string",
      "previousState": {
        "code": 0,
        "name": "string"
      }
    }
  ],
  "requestId": "string"
}

TerminateInstances

GET /TerminateInstances

Terminates one or more instances.
This operation is idempotent, which means that all calls succeed if you terminate an instance more than once.

Code samples

osc-cli fcu TerminateInstances --profile "default" \
  --InstanceId '["string"]'


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=TerminateInstances' \
  --data-urlencode 'InstanceId.1=string'

Parameters

Parameter Type Required Description
InstanceId [string] true One or more instance IDs.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). TerminateInstancesResponse

Example responses

200 Response

{
  "instancesSet": [
    {
      "currentState": {
        "code": 0,
        "name": "string"
      },
      "instanceId": "string",
      "previousState": {
        "code": 0,
        "name": "string"
      }
    }
  ],
  "requestId": "string"
}

Internet Gateways

AttachInternetGateway

GET /AttachInternetGateway

Attaches an Internet gateway to a Virtual Private Cloud (VPC).
To enable the connection between the Internet and a VPC, you must attach an Internet gateway to this VPC.

Code samples

osc-cli fcu AttachInternetGateway --profile "default" \
  --InternetGatewayId "string" \
  --VpcId "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=AttachInternetGateway' \
  --data-urlencode 'InternetGatewayId=string' \
  --data-urlencode 'VpcId=string'

Parameters

Parameter Type Required Description
InternetGatewayId string true The ID of the Internet gateway.
VpcId string true The ID of the VPC.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). AttachInternetGatewayResponse

Example responses

200 Response

{
  "requestId": "string",
  "return": true
}

CreateInternetGateway

GET /CreateInternetGateway

Creates an Internet gateway you can use with a VPC.
An Internet gateway enables your instances launched in a VPC to connect to the Internet. By default, a VPC includes an Internet gateway, and each subnet is public. Every instance launched within a default subnet has a private IP and a public IP (External IP).

Code samples

osc-cli fcu CreateInternetGateway --profile "default"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=CreateInternetGateway'

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreateInternetGatewayResponse

Example responses

200 Response

{
  "internetGateway": {
    "attachmentSet": [
      {
        "state": "string",
        "vpcId": "string"
      }
    ],
    "internetGatewayId": "string",
    "tagSet": [
      {
        "Key": "string",
        "Value": "string"
      }
    ]
  },
  "requestId": "string"
}

DeleteInternetGateway

GET /DeleteInternetGateway

Deletes an Internet gateway.
Before deleting an Internet gateway, you must detach it from any Virtual Private Cloud (VPC) it is attached to.

Code samples

osc-cli fcu DeleteInternetGateway --profile "default" \
  --InternetGatewayId "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DeleteInternetGateway' \
  --data-urlencode 'InternetGatewayId=string'

Parameters

Parameter Type Required Description
InternetGatewayId string true The ID of the Internet gateway.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeleteInternetGatewayResponse

Example responses

200 Response

{
  "requestId": "string",
  "return": true
}

DescribeInternetGateways

GET /DescribeInternetGateways

Describes one or more of your Internet gateways.
An Internet gateway enables your instances launched in a VPC to connect to the Internet. By default, a VPC includes an Internet gateway, and each subnet is public. Every instance launched within a default subnet has a private IP and a public IP (External IP).
You can use the Filter.N parameter to filter the described Internet gateways on the following properties:

Code samples

osc-cli fcu DescribeInternetGateways --profile "default" \
  --Filter '[ \
      { \
        "Name": "string", \
        "Value": ["string"] \
      } \
    ]' \
  --InternetGatewayId '["string"]'


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeInternetGateways' \
  --data-urlencode 'Filter.1.Name=string' \
  --data-urlencode 'Filter.1.Value.1=string' \
  --data-urlencode 'InternetGatewayId.1=string'

Parameters

Parameter Type Required Description
Filter [Filter] false One or more filters.
Example:
osc-cli fcu DescribeInternetGateways \
  --Filter.1.Name "tag:KEYOFTHETAG" \
  --Filter.1.Value.1 "VALUEOFTHETAG"
» Name string false The name of the filter.
» Value [string] false One or more filter values.
InternetGatewayId [string] false One or more Internet gateways IDs.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DescribeInternetGatewaysResponse

Example responses

200 Response

{
  "internetGatewaySet": [
    {
      "attachmentSet": [
        {
          "state": "string",
          "vpcId": "string"
        }
      ],
      "internetGatewayId": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ]
    }
  ],
  "requestId": "string"
}

DetachInternetGateway

GET /DetachInternetGateway

Detaches an Internet gateway from a Virtual Private Cloud (VPC).
This action disables and detaches an Internet gateway from a VPC. The VPC must not contain instances using External IPs (EIPs) nor internet-facing load balancers.

Code samples

osc-cli fcu DetachInternetGateway --profile "default" \
  --InternetGatewayId "string" \
  --VpcId "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DetachInternetGateway' \
  --data-urlencode 'InternetGatewayId=string' \
  --data-urlencode 'VpcId=string'

Parameters

Parameter Type Required Description
InternetGatewayId string true The ID of the Internet gateway.
VpcId string true The ID of the VPC.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DetachInternetGatewayResponse

Example responses

200 Response

{
  "requestId": "string",
  "return": true
}

Keypairs

CreateKeyPair

GET /CreateKeyPair

Creates a 2048-bit RSA keypair with a specified name.
This action returns the private key that you need to save. The public key is stored by 3DS OUTSCALE.

Code samples

osc-cli fcu CreateKeyPair --profile "default" \
  --KeyName "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=CreateKeyPair' \
  --data-urlencode 'KeyName=string'

Parameters

Parameter Type Required Description
KeyName string true A unique name for the keypair, with a maximum length of 255 ASCII printable characters.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreateKeyPairResponse

Example responses

200 Response

{
  "keyFingerprint": "string",
  "keyMaterial": "string",
  "keyName": "string",
  "requestId": "string"
}

DeleteKeyPair

GET /DeleteKeyPair

Deletes the specified keypair.
This action deletes the public key stored by 3DS OUTSCALE, thus deleting the keypair.

Code samples

osc-cli fcu DeleteKeyPair --profile "default" \
  --KeyName "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DeleteKeyPair' \
  --data-urlencode 'KeyName=string'

Parameters

Parameter Type Required Description
KeyName string true The name of the keypair.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeleteKeyPairResponse

Example responses

200 Response

{
  "requestId": "string",
  "return": true
}

DescribeKeyPairs

GET /DescribeKeyPairs

Describes one or more of your keypairs.
You can use the Filter.N parameter to filter the described instances on the following properties:

Code samples

osc-cli fcu DescribeKeyPairs --profile "default" \
  --Filter '[ \
      { \
        "Name": "string", \
        "Value": ["string"] \
      } \
    ]' \
  --KeyName '["string"]'


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeKeyPairs' \
  --data-urlencode 'Filter.1.Name=string' \
  --data-urlencode 'Filter.1.Value.1=string' \
  --data-urlencode 'KeyName.1=string'

Parameters

Parameter Type Required Description
Filter [Filter] false One or more filters.
Example:
osc-cli fcu DescribeKeyPairs \
  --Filter.1.Name "key-name" \
  --Filter.1.Value.1 "Keypair1"
» Name string false The name of the filter.
» Value [string] false One or more filter values.
KeyName [string] false One or more keypair names.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DescribeKeyPairsResponse

Example responses

200 Response

{
  "keySet": [
    {
      "keyFingerprint": "string",
      "keyName": "string"
    }
  ],
  "requestId": "string"
}

ImportKeyPair

GET /ImportKeyPair

Imports a provided public key and creates a keypair.
This action imports the public key of a keypair created by a third-party tool and uses it to create a keypair. The private key is never provided to 3DS OUTSCALE.
The following types of key can be imported: RSA (minimum 2048 bits, recommended 4096 bits), ECDSA (minimum and recommended 256 bits), and Ed25519. The following formats can be used: PEM, PKCS8, RFC4716, and OpenSSH.

Code samples

osc-cli fcu ImportKeyPair --profile "default" \
  --KeyName "string" \
  --PublicKeyMaterial "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=ImportKeyPair' \
  --data-urlencode 'KeyName=string' \
  --data-urlencode 'PublicKeyMaterial=string'

Parameters

Parameter Type Required Description
KeyName string true A unique name for the keypair, with a maximum length of 255 ASCII printable characters.
PublicKeyMaterial string true The public key. It must be Base64-encoded.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ImportKeyPairResponse

Example responses

200 Response

{
  "keyFingerprint": "string",
  "keyName": "string",
  "requestId": "string"
}

NAT Gateways

CreateNatGateway

GET /CreateNatGateway

Creates a network address translation (NAT) gateway in the specified public subnet of a VPC.
A NAT gateway enables instances placed in private subnet of this VPC to connect to the Internet, without being accessible from the Internet.
When creating a NAT gateway, you specify the allocation ID of the External IP (EIP) you want to use for the NAT gateway. Once the NAT gateway is created, you need to create a route in the route table of the private subnet, with 0.0.0.0/0 as destination and the ID of the NAT gateway as target. For more information, see AssociateAddress and CreateRoute.
This action also enables you to create multiple NAT gateways in the same VPC (one per public subnet).

[NOTE]
You cannot modify the EIP associated with a NAT gateway after its creation. To do so, you need to delete the NAT gateway and create a new one with another EIP.

Code samples

osc-cli fcu CreateNatGateway --profile "default" \
  --AllocationId "string" \
  --ClientToken "string" \
  --SubnetId "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=CreateNatGateway' \
  --data-urlencode 'AllocationId=string' \
  --data-urlencode 'ClientToken=string' \
  --data-urlencode 'SubnetId=string'

Parameters

Parameter Type Required Description
AllocationId string true The allocation ID of the EIP to associate with the NAT gateway.
If the EIP is already associated with another resource, you must first disassociate it.
ClientToken string false A unique identifier to manage the idempotency.
SubnetId string true The public subnet where you want to create the NAT gateway.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreateNatGatewayResponse

Example responses

200 Response

{
  "clientToken": "string",
  "natGateway": {
    "createTime": "string",
    "deleteTime": "string",
    "natGatewayAddressSet": [
      {
        "allocationId": "string",
        "networkInterfaceId": "string",
        "privateIp": "string",
        "publicIp": "string"
      }
    ],
    "natGatewayId": "string",
    "state": "string",
    "subnetId": "string",
    "tagSet": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "vpcId": "string"
  },
  "requestId": "string"
}

DeleteNatGateway

GET /DeleteNatGateway

Deletes a specified network address translation (NAT) gateway.
This action disassociates the External IP (EIP) from the NAT gateway, but does not release this EIP from your account. However, it does not delete any NAT gateway routes in your route tables.

Code samples

osc-cli fcu DeleteNatGateway --profile "default" \
  --NatGatewayId "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DeleteNatGateway' \
  --data-urlencode 'NatGatewayId=string'

Parameters

Parameter Type Required Description
NatGatewayId string true The ID of the NAT gateway.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeleteNatGatewayResponse

Example responses

200 Response

{
  "natGatewayId": "string",
  "requestId": "string"
}

DescribeNatGateways

GET /DescribeNatGateways

Describes one or more network address translation (NAT) gateways.
You can use the Filter.N parameter to filter the NAT gateways on the following properties:

Code samples

osc-cli fcu DescribeNatGateways --profile "default" \
  --Filter '[ \
      { \
        "Name": "string", \
        "Value": ["string"] \
      } \
    ]' \
  --MaxResults 0 \
  --NatGatewayId '["string"]' \
  --NextToken "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeNatGateways' \
  --data-urlencode 'Filter.1.Name=string' \
  --data-urlencode 'Filter.1.Value.1=string' \
  --data-urlencode 'MaxResults=0' \
  --data-urlencode 'NatGatewayId.1=string' \
  --data-urlencode 'NextToken=string'

Parameters

Parameter Type Required Description
Filter [Filter] false One or more filters.
Example:
osc-cli fcu DescribeNatGateways \
  --Filter.1.Name "tag:KEYOFTHETAG" \
  --Filter.1.Value.1 "VALUEOFTHETAG"
» Name string false The name of the filter.
» Value [string] false One or more filter values.
MaxResults integer false The maximum number of results that can be returned in a single page. You can use NextToken to request the next results pages. This value is between 5 and 1000. If you provide a value larger than 1000, only 1000 results are returned.
NatGatewayId [string] false One or more IDs of NAT gateways.
NextToken string false The token to request the next results page.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DescribeNatGatewaysResponse

Example responses

200 Response

{
  "natGatewaySet": [
    {
      "createTime": "string",
      "deleteTime": "string",
      "natGatewayAddressSet": [
        {
          "allocationId": "string",
          "networkInterfaceId": "string",
          "privateIp": "string",
          "publicIp": "string"
        }
      ],
      "natGatewayId": "string",
      "state": "string",
      "subnetId": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "vpcId": "string"
    }
  ],
  "nextToken": "string",
  "requestId": "string"
}

Network Interfaces

AssignPrivateIpAddresses

GET /AssignPrivateIpAddresses

Assigns one or more secondary private IPs to an FNI.
This action is only available in a VPC.
The private IPs to be assigned can be added individually using the PrivateIpAddress.N parameter, or you can specify the number of private IPs to be automatically chosen within the subnet range using the SecondaryPrivateIpAddressCount parameter. You can specify only one of these two parameters. If none of these parameters are specified, a private IP is chosen within the subnet range.

Code samples

osc-cli fcu AssignPrivateIpAddresses --profile "default" \
  --AllowReassignment True \
  --NetworkInterfaceId "string" \
  --PrivateIpAddress '["string"]' \
  --SecondaryPrivateIpAddressCount 0


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=AssignPrivateIpAddresses' \
  --data-urlencode 'AllowReassignment=true' \
  --data-urlencode 'NetworkInterfaceId=string' \
  --data-urlencode 'PrivateIpAddress.1=string' \
  --data-urlencode 'SecondaryPrivateIpAddressCount=0'

Parameters

Parameter Type Required Description
AllowReassignment boolean false If set to true, allows a private IP already assigned to another FNI in the same subnet to be reassigned to the specified FNI.
NetworkInterfaceId string true The ID of the FNI.
PrivateIpAddress [string] false One or more secondary private IPs to assign to the FNI within the IP range of the subnet.
SecondaryPrivateIpAddressCount integer false A number of secondary private IPs to assign to the FNI.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). AssignPrivateIpAddressesResponse

Example responses

200 Response

{
  "requestId": "string",
  "return": true
}

AttachNetworkInterface

GET /AttachNetworkInterface

Attaches an FNI to an instance.
The FNI and the instance must be in the same Availability Zone (AZ). The instance can be either running or stopped. The FNI must be in the available state. For more information, see Attaching an FNI to an Instance.

Code samples

osc-cli fcu AttachNetworkInterface --profile "default" \
  --DeviceIndex 0 \
  --DryRun False \
  --InstanceId "string" \
  --NetworkInterfaceId "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=AttachNetworkInterface' \
  --data-urlencode 'DeviceIndex=0' \
  --data-urlencode 'DryRun=false' \
  --data-urlencode 'InstanceId=string' \
  --data-urlencode 'NetworkInterfaceId=string'

Parameters

Parameter Type Required Description
DeviceIndex integer true The device index for the FNI attachment (between 1 and 7, both included).
DryRun boolean false If set to true, checks whether you have the required permissions to perform the action.
InstanceId string true The ID of the instance to which you want to attach the FNI.
NetworkInterfaceId string true The ID of the FNI to attach.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). AttachNetworkInterfaceResponse

Example responses

200 Response

{
  "attachmentId": "string",
  "requestId": "string"
}

CreateNetworkInterface

GET /CreateNetworkInterface

Creates an FNI in the specified subnet.

Code samples

osc-cli fcu CreateNetworkInterface --profile "default" \
  --Description "string" \
  --DryRun False \
  --PrivateIpAddress "string" \
  --SecurityGroupId '["string"]' \
  --SubnetId "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=CreateNetworkInterface' \
  --data-urlencode 'Description=string' \
  --data-urlencode 'DryRun=false' \
  --data-urlencode 'PrivateIpAddress=string' \
  --data-urlencode 'SecurityGroupId.1=string' \
  --data-urlencode 'SubnetId=string'

Parameters

Parameter Type Required Description
Description string false A description for the FNI. This description can contain any Unicode character, with no length limit.
DryRun boolean false If set to true, checks whether you have the required permissions to perform the action.
PrivateIpAddress string false The primary private IP for the FNI.
- This IP must be within the IP range of the subnet that you specified with the subnet-id attribute.
- If you do not specify this attribute, a random private IP is selected within the IP range of the subnet.
SecurityGroupId [string] false One or more IDs of security groups for the FNI.
SubnetId string true The ID of the subnet in which you want to create the FNI.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreateNetworkInterfaceResponse

Example responses

200 Response

{
  "networkInterface": {
    "association": {
      "allocationId": "string",
      "associationId": "string",
      "ipOwnerId": "string",
      "publicDnsName": "string",
      "publicIp": "string"
    },
    "attachment": {
      "attachTime": "string",
      "attachmentId": "string",
      "deleteOnTermination": true,
      "deviceIndex": 0,
      "instanceId": "string",
      "instanceOwnerId": "string",
      "status": "string"
    },
    "availabilityZone": "string",
    "description": "string",
    "groupSet": [
      {
        "groupId": "string",
        "groupName": "string"
      }
    ],
    "macAddress": "string",
    "networkInterfaceId": "string",
    "ownerId": "string",
    "privateDnsName": "string",
    "privateIpAddress": "string",
    "privateIpAddressesSet": [
      {
        "association": {
          "allocationId": "string",
          "associationId": "string",
          "ipOwnerId": "string",
          "publicDnsName": "string",
          "publicIp": "string"
        },
        "primary": true,
        "privateDnsName": "string",
        "privateIpAddress": "string"
      }
    ],
    "sourceDestCheck": true,
    "status": "string",
    "subnetId": "string",
    "tagSet": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "vpcId": "string"
  },
  "requestId": "string"
}

DeleteNetworkInterface

GET /DeleteNetworkInterface

Deletes the specified FNI.
The FNI must not be attached to any instance.

Code samples

osc-cli fcu DeleteNetworkInterface --profile "default" \
  --DryRun False \
  --NetworkInterfaceId "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DeleteNetworkInterface' \
  --data-urlencode 'DryRun=false' \
  --data-urlencode 'NetworkInterfaceId=string'

Parameters

Parameter Type Required Description
DryRun boolean false If set to true, checks whether you have the required permissions to perform the action.
NetworkInterfaceId string true The ID of the FNI.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeleteNetworkInterfaceResponse

Example responses

200 Response

{
  "requestId": "string",
  "return": true
}

DescribeNetworkInterfaces

GET /DescribeNetworkInterfaces

Describes one or more Flexible Network Interface (FNI).
An FNI is a virtual network interface that you can attach to an instance in a Virtual Private Cloud (VPC).
You can use the Filter.N parameter to filter FNIs on the following properties:

Code samples

osc-cli fcu DescribeNetworkInterfaces --profile "default" \
  --Filter '[ \
      { \
        "Name": "string", \
        "Value": ["string"] \
      } \
    ]' \
  --NetworkInterfaceId '["string"]'


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeNetworkInterfaces' \
  --data-urlencode 'Filter.1.Name=string' \
  --data-urlencode 'Filter.1.Value.1=string' \
  --data-urlencode 'NetworkInterfaceId.1=string'

Parameters

Parameter Type Required Description
Filter [Filter] false One or more filters.
Example:
osc-cli fcu DescribeNetworkInterfaces \
  --Filter.1.Name "network-interface-id" \
  --Filter.1.Value.1 "eni-12345678"
» Name string false The name of the filter.
» Value [string] false One or more filter values.
NetworkInterfaceId [string] false One or more FNI IDs.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DescribeNetworkInterfacesResponse

Example responses

200 Response

{
  "networkInterfaceSet": [
    {
      "association": {
        "allocationId": "string",
        "associationId": "string",
        "ipOwnerId": "string",
        "publicDnsName": "string",
        "publicIp": "string"
      },
      "attachment": {
        "attachTime": "string",
        "attachmentId": "string",
        "deleteOnTermination": true,
        "deviceIndex": 0,
        "instanceId": "string",
        "instanceOwnerId": "string",
        "status": "string"
      },
      "availabilityZone": "string",
      "description": "string",
      "groupSet": [
        {
          "groupId": "string",
          "groupName": "string"
        }
      ],
      "macAddress": "string",
      "networkInterfaceId": "string",
      "ownerId": "string",
      "privateDnsName": "string",
      "privateIpAddress": "string",
      "privateIpAddressesSet": [
        {
          "association": {
            "allocationId": "string",
            "associationId": "string",
            "ipOwnerId": "string",
            "publicDnsName": "string",
            "publicIp": "string"
          },
          "primary": true,
          "privateDnsName": "string",
          "privateIpAddress": "string"
        }
      ],
      "sourceDestCheck": true,
      "status": "string",
      "subnetId": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "vpcId": "string"
    }
  ],
  "requestId": "string"
}

DetachNetworkInterface

GET /DetachNetworkInterface

Detaches an FNI from an instance.
The primary FNI cannot be detached.

Code samples

osc-cli fcu DetachNetworkInterface --profile "default" \
  --AttachmentId "string" \
  --DryRun False


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DetachNetworkInterface' \
  --data-urlencode 'AttachmentId=string' \
  --data-urlencode 'DryRun=false'

Parameters

Parameter Type Required Description
AttachmentId string true The ID of the attachment operation.
DryRun boolean false If set to true, checks whether you have the required permissions to perform the action.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DetachNetworkInterfaceResponse

Example responses

200 Response

{
  "requestId": "string",
  "return": true
}

ModifyNetworkInterfaceAttribute

GET /ModifyNetworkInterfaceAttribute

Modifies the specified FNI Interfaces attribute. You can specify only one attribute at a time.

Code samples

osc-cli fcu ModifyNetworkInterfaceAttribute --profile "default" \
  --Attachment '{ \
      "AttachmentId": "string", \
      "DeleteOnTermination": True \
    }' \
  --Description '{ \
      "Value": "string" \
    }' \
  --DryRun False \
  --NetworkInterfaceId "string" \
  --SecurityGroupId '["string"]'


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=ModifyNetworkInterfaceAttribute' \
  --data-urlencode 'Attachment.AttachmentId=string' \
  --data-urlencode 'Attachment.DeleteOnTermination=true' \
  --data-urlencode 'Description.Value=string' \
  --data-urlencode 'DryRun=false' \
  --data-urlencode 'NetworkInterfaceId=string' \
  --data-urlencode 'SecurityGroupId.1=string'

Parameters

Parameter Type Required Description
Attachment Attachment false A new configuration for the attachment.
» AttachmentId string false The ID of the FNI attachment.
» DeleteOnTermination boolean false By default or if set to false, the FNI is detached from the instance when the instance is terminated. If true, the FNI is deleted.
Description Description_0 false A new description of the resource.
» Value string false The value specified for the resource attribute.
DryRun boolean false If set to true, checks whether you have the required permissions to perform the action.
NetworkInterfaceId string true The ID of the FNI.
SecurityGroupId [string] false One or more IDs of security groups to associate with the FNI.
The FNI must be associated with at least one security group.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ModifyNetworkInterfaceAttributeResponse

Example responses

200 Response

{
  "requestId": "string",
  "return": true
}

UnassignPrivateIpAddresses

GET /UnassignPrivateIpAddresses

Unassigns one or more secondary private IPs from an FNI.

Code samples

osc-cli fcu UnassignPrivateIpAddresses --profile "default" \
  --NetworkInterfaceId "string" \
  --PrivateIpAddress '["string"]'


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=UnassignPrivateIpAddresses' \
  --data-urlencode 'NetworkInterfaceId=string' \
  --data-urlencode 'PrivateIpAddress.1=string'

Parameters

Parameter Type Required Description
NetworkInterfaceId string true The ID of the FNI.
PrivateIpAddress [string] true One or more secondary private IPs you want to unassign from the FNI.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). UnassignPrivateIpAddressesResponse

Example responses

200 Response

{
  "requestId": "string",
  "return": true
}

Peering Connections

AcceptVpcPeeringConnection

GET /AcceptVpcPeeringConnection

Accepts a VPC peering connection request.
To accept this request, you must be the owner of the peer VPC. If you do not accept the request within 7 days, the state of the VPC peering connection becomes expired.

[NOTE]
A peering connection between two VPCs works both ways. Therefore, when an A-to-B peering connection is accepted, any pending B-to-A peering connection is automatically rejected as redundant.

Code samples

osc-cli fcu AcceptVpcPeeringConnection --profile "default" \
  --VpcPeeringConnectionId "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=AcceptVpcPeeringConnection' \
  --data-urlencode 'VpcPeeringConnectionId=string'

Parameters

Parameter Type Required Description
VpcPeeringConnectionId string true The ID of the VPC peering connection you want to accept.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). AcceptVpcPeeringConnectionResponse

Example responses

200 Response

{
  "requestId": "string",
  "vpcPeeringConnection": {
    "accepterVpcInfo": {
      "cidrBlock": "string",
      "ownerId": "string",
      "vpcId": "string"
    },
    "expirationTime": "string",
    "requesterVpcInfo": {
      "cidrBlock": "string",
      "ownerId": "string",
      "vpcId": "string"
    },
    "status": {
      "code": "string",
      "message": "string"
    },
    "tagSet": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "vpcPeeringConnectionId": "string"
  }
}

CreateVpcPeeringConnection

GET /CreateVpcPeeringConnection

Requests a VPC peering connection between a VPC you own and a peer VPC that belongs to you or another account.
This action creates a VPC peering connection that remains in the pending-acceptance state until it is accepted by the owner of the peer VPC. If the owner of the peer VPC does not accept the request within 7 days, the state of the VPC peering connection becomes expired. For more information, see AcceptVpcPeeringConnection.

[NOTE]

Code samples

osc-cli fcu CreateVpcPeeringConnection --profile "default" \
  --PeerOwnerId "string" \
  --PeerVpcId "string" \
  --VpcId "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=CreateVpcPeeringConnection' \
  --data-urlencode 'PeerOwnerId=string' \
  --data-urlencode 'PeerVpcId=string' \
  --data-urlencode 'VpcId=string'

Parameters

Parameter Type Required Description
PeerOwnerId string false The account ID of the owner of the VPC you want to connect with. By default, it is your account ID.
PeerVpcId string true The ID of the VPC you want to connect with.
VpcId string true The ID of the VPC you send the request from.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreateVpcPeeringConnectionResponse

Example responses

200 Response

{
  "requestId": "string",
  "vpcPeeringConnection": {
    "accepterVpcInfo": {
      "cidrBlock": "string",
      "ownerId": "string",
      "vpcId": "string"
    },
    "expirationTime": "string",
    "requesterVpcInfo": {
      "cidrBlock": "string",
      "ownerId": "string",
      "vpcId": "string"
    },
    "status": {
      "code": "string",
      "message": "string"
    },
    "tagSet": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "vpcPeeringConnectionId": "string"
  }
}

DeleteVpcPeeringConnection

GET /DeleteVpcPeeringConnection

Deletes a VPC peering connection.
If the VPC peering connection is in the active state, it can be deleted either by the owner of the requester VPC or the owner of the peer VPC.
If it is in the pending-acceptance state, it can be deleted only by the owner of the requester VPC.
If it is in the rejected, failed, or expired states, it cannot be deleted.

Code samples

osc-cli fcu DeleteVpcPeeringConnection --profile "default" \
  --VpcPeeringConnectionId "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DeleteVpcPeeringConnection' \
  --data-urlencode 'VpcPeeringConnectionId=string'

Parameters

Parameter Type Required Description
VpcPeeringConnectionId string true The ID of the VPC peering connection you want to delete.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeleteVpcPeeringConnectionResponse

Example responses

200 Response

{
  "requestId": "string",
  "return": true
}

DescribeVpcPeeringConnections

GET /DescribeVpcPeeringConnections

Describes one or more peering connections between two Virtual Private Clouds (VPCs).
You can use the Filter.N parameter to filter the described VPC peering connections on the following properties:

Code samples

osc-cli fcu DescribeVpcPeeringConnections --profile "default" \
  --Filter '[ \
      { \
        "Name": "string", \
        "Value": ["string"] \
      } \
    ]' \
  --VpcPeeringConnectionId '["string"]'


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeVpcPeeringConnections' \
  --data-urlencode 'Filter.1.Name=string' \
  --data-urlencode 'Filter.1.Value.1=string' \
  --data-urlencode 'VpcPeeringConnectionId.1=string'

Parameters

Parameter Type Required Description
Filter [Filter] false One or more filters.
Example:
osc-cli fcu DescribeVpcPeeringConnections \
  --Filter.1.Name "tag:KEYOFTHETAG" \
  --Filter.1.Value.1 "VALUEOFTHETAG"
» Name string false The name of the filter.
» Value [string] false One or more filter values.
VpcPeeringConnectionId [string] false One or more VPC peering connection IDs.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DescribeVpcPeeringConnectionsResponse

Example responses

200 Response

{
  "requestId": "string",
  "vpcPeeringConnectionSet": [
    {
      "accepterVpcInfo": {
        "cidrBlock": "string",
        "ownerId": "string",
        "vpcId": "string"
      },
      "expirationTime": "string",
      "requesterVpcInfo": {
        "cidrBlock": "string",
        "ownerId": "string",
        "vpcId": "string"
      },
      "status": {
        "code": "string",
        "message": "string"
      },
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "vpcPeeringConnectionId": "string"
    }
  ]
}

RejectVpcPeeringConnection

GET /RejectVpcPeeringConnection

Rejects a VPC peering connection request.
The VPC peering connection must be in the pending-acceptance state to be rejected. The rejected VPC peering connection is then in the rejected state.

Code samples

osc-cli fcu RejectVpcPeeringConnection --profile "default" \
  --VpcPeeringConnectionId "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=RejectVpcPeeringConnection' \
  --data-urlencode 'VpcPeeringConnectionId=string'

Parameters

Parameter Type Required Description
VpcPeeringConnectionId string true The ID of the VPC peering connection you want to reject.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). RejectVpcPeeringConnectionResponse

Example responses

200 Response

{
  "requestId": "string",
  "return": true
}

Prefix Lists

DescribePrefixLists

GET /DescribePrefixLists

Describes one or more prefix lists for available OUTSCALE services.
Each prefix list is composed of an ID, a name to identify the service it is associated with and a list of network prefixes used by this service, in CIDR notation.
You can use prefix list IDs in outbound security group rules to allow traffic from a VPC to access the corresponding service. For more information, see the AuthorizeSecurityGroupEgress method.
You can filter the described prefix lists using the PrefixListId.N parameter.
You can also use the Filter.N parameter to filter the prefix lists on the following properties:

Code samples

osc-cli fcu DescribePrefixLists --profile "default" \
  --DryRun False \
  --Filter '[ \
      { \
        "Name": "string", \
        "Value": ["string"] \
      } \
    ]' \
  --MaxResults 0 \
  --NextToken "string" \
  --PrefixListId '["string"]'


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribePrefixLists' \
  --data-urlencode 'DryRun=false' \
  --data-urlencode 'Filter.1.Name=string' \
  --data-urlencode 'Filter.1.Value.1=string' \
  --data-urlencode 'MaxResults=0' \
  --data-urlencode 'NextToken=string' \
  --data-urlencode 'PrefixListId.1=string'

Parameters

Parameter Type Required Description
DryRun boolean false If set to true, checks whether you have the required permissions to perform the action.
Filter [Filter] false One or more filters.
Example:
osc-cli fcu DescribePrefixLists \
  --Filter.1.Name "prefix-list-id" \
  --Filter.1.Value.1 "pl-12345678"
» Name string false The name of the filter.
» Value [string] false One or more filter values.
MaxResults integer false The maximum number of results that can be returned in a single page. You can use NextToken to request the next results pages. This value is between 5 and 1000. If you provide a value larger than 1000, only 1000 results are returned.
NextToken string false The token to request the next results page.
PrefixListId [string] false One or more prefix list IDs.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DescribePrefixListsResponse

Example responses

200 Response

{
  "nextToken": "string",
  "prefixListSet": [
    {
      "cidrSet": [
        "string"
      ],
      "prefixListId": "string",
      "prefixListName": "string"
    }
  ],
  "requestId": "string"
}

Product Types

DescribeInstanceTypes

GET /DescribeInstanceTypes

Describes one or more predefined instance types.

You can use the Filter.N parameter to filter the instance types on the following properties:

Code samples

osc-cli fcu DescribeInstanceTypes --profile "default" \
  --Filter '[ \
      { \
        "Name": "string", \
        "Value": ["string"] \
      } \
    ]'


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeInstanceTypes' \
  --data-urlencode 'Filter.1.Name=string' \
  --data-urlencode 'Filter.1.Value.1=string'

Parameters

Parameter Type Required Description
Filter [Filter] false One or more filters.
Example:
osc-cli fcu DescribeInstanceTypes \
  --Filter.1.Name "description" \
  --Filter.1.Value.1 "Windows"
» Name string false The name of the filter.
» Value [string] false One or more filter values.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DescribeInstanceTypesResponse

Example responses

200 Response

{
  "instanceTypeSet": [
    {
      "ebsOptimizedAvailable": true,
      "ephemeralsType": "string",
      "eth": 0,
      "gpu": 0,
      "maxIpAddresses": 0,
      "memory": 0,
      "name": "string",
      "storageCount": 0,
      "storageSize": 0,
      "vcpu": 0
    }
  ],
  "requestId": "string"
}

DescribeProductTypes

GET /DescribeProductTypes

Describes one or more product types.
You can use the Filter.N parameter to filter the product types on the description property:

Code samples

osc-cli fcu DescribeProductTypes --profile "default" \
  --Filter '[ \
      { \
        "Name": "string", \
        "Value": ["string"] \
      } \
    ]'


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeProductTypes' \
  --data-urlencode 'Filter.1.Name=string' \
  --data-urlencode 'Filter.1.Value.1=string'

Parameters

Parameter Type Required Description
Filter [Filter] false One or more filters.
Example:
osc-cli fcu DescribeProductTypes \
  --Filter.1.Name "description" \
  --Filter.1.Value.1 "Windows"
» Name string false The name of the filter.
» Value [string] false One or more filter values.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DescribeProductTypesResponse

Example responses

200 Response

{
  "productTypeSet": [
    {
      "description": "string",
      "productTypeId": "string",
      "vendor": "string"
    }
  ],
  "requestId": "string"
}

GetProductType

GET /GetProductType

Gets the product type of a specified OUTSCALE machine image (OMI) or snapshot.

[NOTE]
This function is deprecated. Use the GetProductTypes method instead to get the product type of all products installed on an OMI or snapshot.

Code samples

osc-cli fcu GetProductType --profile "default" \
  --ImageId "string" \
  --SnapshotId "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=GetProductType' \
  --data-urlencode 'ImageId=string' \
  --data-urlencode 'SnapshotId=string'

Parameters

Parameter Type Required Description
ImageId string false The ID of the OMI.
SnapshotId string false The ID of the snapshot.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). GetProductTypeResponse

Example responses

200 Response

{
  "productType": {
    "description": "string",
    "productTypeId": "string",
    "vendor": "string"
  },
  "requestId": "string"
}

GetProductTypes

GET /GetProductTypes

Gets the product types of all products installed on a specified OUTSCALE machine image (OMI) or snapshot.

Code samples

osc-cli fcu GetProductTypes --profile "default" \
  --ImageId "string" \
  --SnapshotId "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=GetProductTypes' \
  --data-urlencode 'ImageId=string' \
  --data-urlencode 'SnapshotId=string'

Parameters

Parameter Type Required Description
ImageId string false The ID of the OMI.
SnapshotId string false The ID of the snapshot.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). GetProductTypesResponse

Example responses

200 Response

{
  "productTypeSet": [
    {
      "description": "string",
      "productTypeId": "string",
      "vendor": "string"
    }
  ],
  "requestId": "string"
}

Quotas

DescribeQuotas

GET /DescribeQuotas

Describes one or more of your quotas.
You can use the QuotaName.N parameter to filter on the name of one or more quotas.
You can also use the Filter.N parameter to filter the described quotas on the following properties:

Code samples

osc-cli fcu DescribeQuotas --profile "default" \
  --Filter '[ \
      { \
        "Name": "string", \
        "Value": ["string"] \
      } \
    ]' \
  --MaxResults 0 \
  --NextToken "string" \
  --QuotaName '["string"]'


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeQuotas' \
  --data-urlencode 'Filter.1.Name=string' \
  --data-urlencode 'Filter.1.Value.1=string' \
  --data-urlencode 'MaxResults=0' \
  --data-urlencode 'NextToken=string' \
  --data-urlencode 'QuotaName.1=string'

Parameters

Parameter Type Required Description
Filter [Filter] false One or more filters.
Example:
osc-cli fcu DescribeQuotas \
  --Filter.1.Name "quota.display-name" \
  --Filter.1.Value.1 "DisplayName"
» Name string false The name of the filter.
» Value [string] false One or more filter values.
MaxResults integer false The maximum number of items that can be returned in a single page (by default, 100).
NextToken string false The token to request the next results page.
QuotaName [string] false One or more names of quotas.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DescribeQuotasResponse

Example responses

200 Response

{
  "nextToken": "string",
  "referenceQuotaSet": [
    {
      "quotaSet": [],
      "reference": "string"
    }
  ],
  "requestId": "string"
}

Regions

DescribeAvailabilityZones

GET /DescribeAvailabilityZones

Describes one or more of the enabled Availability Zones that you can access in the current Region.
You can use the ZoneName.N parameter to filter on the name of one or more Availability Zones.
You can also use the Filter.N parameter to filter the described Availability Zones on the following properties:

[NOTE]
You can use this command to get information about Availability Zones only in a Region for which you have an account. Otherwise, the AuthFailure error message is returned.

Code samples

osc-cli fcu DescribeAvailabilityZones --profile "default" \
  --Filter '[ \
      { \
        "Name": "string", \
        "Value": ["string"] \
      } \
    ]' \
  --ZoneName '["string"]'


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeAvailabilityZones' \
  --data-urlencode 'Filter.1.Name=string' \
  --data-urlencode 'Filter.1.Value.1=string' \
  --data-urlencode 'ZoneName.1=string'

Parameters

Parameter Type Required Description
Filter [Filter] false One or more filters.
Example:
osc-cli fcu DescribeAvailabilityZones \
  --Filter.1.Name "state" \
  --Filter.1.Value.1 "available"
» Name string false The name of the filter.
» Value [string] false One or more filter values.
ZoneName [string] false Information about one or more Availability Zones.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DescribeAvailabilityZonesResponse

Example responses

200 Response

{
  "availabilityZoneInfo": [
    {
      "regionName": "string",
      "zoneName": "string",
      "zoneState": "string"
    }
  ],
  "requestId": "string"
}

DescribeRegions

GET /DescribeRegions

Describes one or more Regions of the OUTSCALE Cloud.
You can use the RegionName.N parameter to filter on the name of one or more Regions.
You can also use the Filter.N parameter to filter the described Regions on the following properties:

Code samples

osc-cli fcu DescribeRegions --profile "default" \
  --Filter '[ \
      { \
        "Name": "string", \
        "Value": ["string"] \
      } \
    ]' \
  --RegionName '["string"]'


curl https://fcu.$OSC_REGION.outscale.com \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeRegions' \
  --data-urlencode 'Filter.1.Name=string' \
  --data-urlencode 'Filter.1.Value.1=string' \
  --data-urlencode 'RegionName.1=string'

Parameters

Parameter Type Required Description
Filter [Filter] false One or more filters.
Example:
osc-cli fcu DescribeRegions \
  --Filter.1.Name "region-name" \
  --Filter.1.Value.1 "eu-west-2"
» Name string false The name of the filter.
» Value [string] false One or more filter values.
RegionName [string] false The name of one or more Regions.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DescribeRegionsResponse

Example responses

200 Response

{
  "regionInfo": [
    {
      "regionEndpoint": "string",
      "regionName": "string"
    }
  ],
  "requestId": "string"
}

ReadPublicIpRanges

GET /ReadPublicIpRanges

Returns the public IPv4 addresses in CIDR notation for the Region specified in the endpoint of the request. For more information, see Regions, Endpoints and Availability Zones Reference.

Code samples

osc-cli fcu ReadPublicIpRanges --profile "default"


curl https://fcu.$OSC_REGION.outscale.com \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=ReadPublicIpRanges'

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ReadPublicIpRangesResponse

Example responses

200 Response

{
  "publicIpSet": [
    "string"
  ],
  "requestId": "string"
}

Route Tables

AssociateRouteTable

GET /AssociateRouteTable

Associates a subnet with a route table.
The subnet and the route table must be in the same VPC. The traffic is routed according to the route table defined within this VPC. You can associate a route table with several subnets.

Code samples

osc-cli fcu AssociateRouteTable --profile "default" \
  --RouteTableId "string" \
  --SubnetId "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=AssociateRouteTable' \
  --data-urlencode 'RouteTableId=string' \
  --data-urlencode 'SubnetId=string'

Parameters

Parameter Type Required Description
RouteTableId string true The ID of the route table.
SubnetId string true The ID of the subnet.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). AssociateRouteTableResponse

Example responses

200 Response

{
  "associationId": "string",
  "requestId": "string"
}

CreateRoute

GET /CreateRoute

Creates a route in a specified route table within a specified VPC.
You must specify one of the following elements as the target:

Code samples

osc-cli fcu CreateRoute --profile "default" \
  --DestinationCidrBlock "string" \
  --GatewayId "string" \
  --InstanceId "string" \
  --NatGatewayId "string" \
  --NetworkInterfaceId "string" \
  --RouteTableId "string" \
  --VpcPeeringConnectionId "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=CreateRoute' \
  --data-urlencode 'DestinationCidrBlock=string' \
  --data-urlencode 'GatewayId=string' \
  --data-urlencode 'InstanceId=string' \
  --data-urlencode 'NatGatewayId=string' \
  --data-urlencode 'NetworkInterfaceId=string' \
  --data-urlencode 'RouteTableId=string' \
  --data-urlencode 'VpcPeeringConnectionId=string'

Parameters

Parameter Type Required Description
DestinationCidrBlock string true The CIDR block used for the destination match.
GatewayId string false The ID of an Internet gateway or virtual private gateway attached to your VPC.
InstanceId string false The ID of a NAT instance in your VPC (attached to exactly one network interface).
NatGatewayId string false The ID of a NAT gateway.
NetworkInterfaceId string false The ID of a network interface.
RouteTableId string true The ID of the route table.
VpcPeeringConnectionId string false The ID of a VPC peering connection.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreateRouteResponse

Example responses

200 Response

{
  "requestId": "string",
  "return": true
}

CreateRouteTable

GET /CreateRouteTable

Creates a route table for a specified VPC.
You can then add routes and associate this route table with a subnet.

Code samples

osc-cli fcu CreateRouteTable --profile "default" \
  --VpcId "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=CreateRouteTable' \
  --data-urlencode 'VpcId=string'

Parameters

Parameter Type Required Description
VpcId string true The ID of the VPC.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreateRouteTableResponse

Example responses

200 Response

{
  "requestId": "string",
  "routeTable": {
    "associationSet": [
      {
        "main": true,
        "routeTableAssociationId": "string",
        "routeTableId": "string",
        "subnetId": "string"
      }
    ],
    "propagatingVgwSet": [
      {
        "gatewayId": "string"
      }
    ],
    "routeSet": [
      {
        "destinationCidrBlock": "string",
        "destinationPrefixListId": "string",
        "gatewayId": "string",
        "instanceId": "string",
        "instanceOwnerId": "string",
        "networkInterfaceId": "string",
        "origin": "string",
        "state": "string",
        "vpcPeeringConnectionId": "string"
      }
    ],
    "routeTableId": "string",
    "tagSet": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "vpcId": "string"
  }
}

DeleteRoute

GET /DeleteRoute

Deletes a route from a specified route table.

Code samples

osc-cli fcu DeleteRoute --profile "default" \
  --DestinationCidrBlock "string" \
  --RouteTableId "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DeleteRoute' \
  --data-urlencode 'DestinationCidrBlock=string' \
  --data-urlencode 'RouteTableId=string'

Parameters

Parameter Type Required Description
DestinationCidrBlock string true The exact CIDR range for the route.
RouteTableId string true The ID of the route table you want to delete.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeleteRouteResponse

Example responses

200 Response

{
  "requestId": "string",
  "return": true
}

DeleteRouteTable

GET /DeleteRouteTable

Deletes a specified route table.
Before deleting a route table, you must disassociate it from any subnet. You cannot delete the main route table.

Code samples

osc-cli fcu DeleteRouteTable --profile "default" \
  --RouteTableId "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DeleteRouteTable' \
  --data-urlencode 'RouteTableId=string'

Parameters

Parameter Type Required Description
RouteTableId string true The ID of the route table.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeleteRouteTableResponse

Example responses

200 Response

{
  "requestId": "string",
  "return": true
}

DescribeRouteTables

GET /DescribeRouteTables

Describes one or more of your route tables.
In your Virtual Private Cloud (VPC), each subnet must be associated with a route table. If a subnet is not explicitly associated with a route table, it is implicitly associated with the main route table of the VPC.
You can use the Filter.N parameter to filter the route tables on the following properties:

Code samples

osc-cli fcu DescribeRouteTables --profile "default" \
  --Filter '[ \
      { \
        "Name": "string", \
        "Value": ["string"] \
      } \
    ]' \
  --RouteTableId '["string"]'


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeRouteTables' \
  --data-urlencode 'Filter.1.Name=string' \
  --data-urlencode 'Filter.1.Value.1=string' \
  --data-urlencode 'RouteTableId.1=string'

Parameters

Parameter Type Required Description
Filter [Filter] false One or more filters.
Example:
osc-cli fcu DescribeRouteTables \
  --Filter.1.Name "tag:KEYOFTHETAG" \
  --Filter.1.Value.1 "VALUEOFTHETAG"
» Name string false The name of the filter.
» Value [string] false One or more filter values.
RouteTableId [string] false One or more route table IDs.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DescribeRouteTablesResponse

Example responses

200 Response

{
  "requestId": "string",
  "routeTableSet": [
    {
      "associationSet": [
        {
          "main": true,
          "routeTableAssociationId": "string",
          "routeTableId": "string",
          "subnetId": "string"
        }
      ],
      "propagatingVgwSet": [
        {
          "gatewayId": "string"
        }
      ],
      "routeSet": [
        {
          "destinationCidrBlock": "string",
          "destinationPrefixListId": "string",
          "gatewayId": "string",
          "instanceId": "string",
          "instanceOwnerId": "string",
          "networkInterfaceId": "string",
          "origin": "string",
          "state": "string",
          "vpcPeeringConnectionId": "string"
        }
      ],
      "routeTableId": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "vpcId": "string"
    }
  ]
}

DisassociateRouteTable

GET /DisassociateRouteTable

Disassociates a subnet from a route table.
After disassociation, the subnet can no longer use the routes in this route table, but uses the routes in the main route table of the VPC instead.

Code samples

osc-cli fcu DisassociateRouteTable --profile "default" \
  --AssociationId "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DisassociateRouteTable' \
  --data-urlencode 'AssociationId=string'

Parameters

Parameter Type Required Description
AssociationId string true The ID of the current association between the route table and the subnet.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DisassociateRouteTableResponse

Example responses

200 Response

{
  "requestId": "string",
  "return": true
}

ReplaceRoute

GET /ReplaceRoute

Replaces an existing route within a route table in a VPC.
You must specify one of the following elements as the target:

Code samples

osc-cli fcu ReplaceRoute --profile "default" \
  --DestinationCidrBlock "string" \
  --GatewayId "string" \
  --InstanceId "string" \
  --NatGatewayId "string" \
  --NetworkInterfaceId "string" \
  --RouteTableId "string" \
  --VpcPeeringConnectionId "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=ReplaceRoute' \
  --data-urlencode 'DestinationCidrBlock=string' \
  --data-urlencode 'GatewayId=string' \
  --data-urlencode 'InstanceId=string' \
  --data-urlencode 'NatGatewayId=string' \
  --data-urlencode 'NetworkInterfaceId=string' \
  --data-urlencode 'RouteTableId=string' \
  --data-urlencode 'VpcPeeringConnectionId=string'

Parameters

Parameter Type Required Description
DestinationCidrBlock string true The CIDR block used for the destination match.
GatewayId string false The ID of an Internet gateway or virtual private gateway attached to your VPC.
InstanceId string false The ID of a NAT instance in your VPC.
NatGatewayId string false The ID of a NAT gateway.
NetworkInterfaceId string false The ID of a network interface.
RouteTableId string true The ID of the route table.
VpcPeeringConnectionId string false The ID of a VPC peering connection.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ReplaceRouteResponse

Example responses

200 Response

{
  "requestId": "string",
  "return": true
}

ReplaceRouteTableAssociation

GET /ReplaceRouteTableAssociation

Replaces the route table associated with a specific subnet in a VPC with another one.
After the route table is replaced, the subnet uses the routes in the new route table it is associated with.

Code samples

osc-cli fcu ReplaceRouteTableAssociation --profile "default" \
  --AssociationId "string" \
  --RouteTableId "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=ReplaceRouteTableAssociation' \
  --data-urlencode 'AssociationId=string' \
  --data-urlencode 'RouteTableId=string'

Parameters

Parameter Type Required Description
AssociationId string true The ID of the current route table association.
RouteTableId string true The ID of the new route table to associate with the subnet.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ReplaceRouteTableAssociationResponse

Example responses

200 Response

{
  "newAssociationId": "string",
  "requestId": "string"
}

Security Groups

AuthorizeSecurityGroupEgress

GET /AuthorizeSecurityGroupEgress

Adds one or more egress rules to a security group for use with a Virtual Private Cloud (VPC).
It allows instances to send traffic to either one or more destination CIDR IP ranges or destination security groups for the same VPC.
We recommend using a set of IP permissions to authorize outbound access to a destination security group. We also recommend specifying the protocol in a set of IP permissions.

[NOTE]
By default, traffic between two security groups is allowed through both public and private IPs. To restrict it to private IPs only, contact our Support team: support@outscale.com.

Code samples

osc-cli fcu AuthorizeSecurityGroupEgress --profile "default" \
  --CidrIp "string" \
  --FromPort 0 \
  --GroupId "string" \
  --IpPermissions '[ \
      { \
        "FromPort": 0, \
        "Groups": [{"GroupId": "string", "GroupName": "string", "UserId": "string"}], \
        "IpProtocol": "string", \
        "IpRanges": [{"CidrIp": "string"}], \
        "PrefixListIds": [{"PrefixListId": "string"}], \
        "ToPort": 0 \
      } \
    ]' \
  --IpProtocol "string" \
  --SourceSecurityGroupName "string" \
  --SourceSecurityGroupOwnerId "string" \
  --ToPort 0


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=AuthorizeSecurityGroupEgress' \
  --data-urlencode 'CidrIp=string' \
  --data-urlencode 'FromPort=0' \
  --data-urlencode 'GroupId=string' \
  --data-urlencode 'IpPermissions.1.FromPort=0' \
  --data-urlencode 'IpPermissions.1.Groups.1.GroupId=string' \
  --data-urlencode 'IpPermissions.1.Groups.1.GroupName=string' \
  --data-urlencode 'IpPermissions.1.Groups.1.UserId=string' \
  --data-urlencode 'IpPermissions.1.IpProtocol=string' \
  --data-urlencode 'IpPermissions.1.IpRanges.1.CidrIp=string' \
  --data-urlencode 'IpPermissions.1.PrefixListIds.1.PrefixListId=string' \
  --data-urlencode 'IpPermissions.1.ToPort=0' \
  --data-urlencode 'IpProtocol=string' \
  --data-urlencode 'SourceSecurityGroupName=string' \
  --data-urlencode 'SourceSecurityGroupOwnerId=string' \
  --data-urlencode 'ToPort=0'

Parameters

Parameter Type Required Description
CidrIp string false The CIDR IP range.
FromPort integer false The beginning of the port range for the TCP and UDP protocols, or an ICMP type number.
GroupId string true The ID of the security group.
IpPermissions [IpPermissions_0] false One or more IP permissions.
» FromPort integer false The beginning of the port range for TCP and UDP protocols, or an ICMP type number.
» Groups [Groups_0] false One or more security groups and account ID pairs.
»» GroupId string false The ID of the security group (in case of a security group in a nondefault VPC).
»» GroupName string false The name of the security group (in case of a security group in FCU or a default VPC).
»» UserId string false The account ID of the user.
» IpProtocol string false The IP protocol name (tcp, udp, icmp, or -1 for all protocols). By default, -1. In a VPC, this can also be an IP protocol number. For more information, see the IANA.org website.
» IpRanges [IpRanges_0] false One or more IP ranges.
»» CidrIp string false The range of IPs.
» PrefixListIds [PrefixListIds_0] false One or more prefix list IDs to allow traffic from a VPC to access the corresponding OUTSCALE services. For more information, see DescribePrefixLists.
»» PrefixListId string false The ID of the prefix.
» ToPort integer false The end of the port range for TCP and UDP protocols, or an ICMP code number.
IpProtocol string false The IP protocol name (tcp, udp, icmp, or -1 for all protocols). By default, -1. In a VPC, this can also be an IP protocol number. For more information, see the IANA.org website.
SourceSecurityGroupName string false The name of a destination security group.
SourceSecurityGroupOwnerId string false The account ID of the owner of a destination security group.
ToPort integer false The end of port range for the TCP and UDP protocols, or an ICMP code number.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). AuthorizeSecurityGroupEgressResponse

Example responses

200 Response

{
  "requestId": "string",
  "return": true
}

AuthorizeSecurityGroupIngress

GET /AuthorizeSecurityGroupIngress

Adds one or more ingress rules to a security group.
The modifications are effective at instance level as quickly as possible, but a small delay may occur.
In the public Cloud, this action allows one or more CIDR IP ranges to access a security group for your account, or allows one or more security groups (source groups) to access a security group for your own OUTSCALE account or another one.
In a Virtual Private Cloud (VPC), this action allows one or more CIDR IP ranges to access a security group for your VPC, or allows one or more other security groups (source groups) to access a security group for your VPC. All the security groups must be for the same VPC.
To create a rule with a specific IP protocol and a specific port range, we recommend using a set of IP permissions. We also recommend specifying the protocol in a set of IP permissions.

[NOTE]
By default, traffic between two security groups is allowed through both public and private IPs. To restrict it to private IPs only, contact our Support team: support@outscale.com.

Code samples

osc-cli fcu AuthorizeSecurityGroupIngress --profile "default" \
  --CidrIp "string" \
  --FromPort 0 \
  --GroupId "string" \
  --GroupName "string" \
  --IpPermissions '[ \
      { \
        "FromPort": 0, \
        "Groups": [{"GroupId": "string", "GroupName": "string", "UserId": "string"}], \
        "IpProtocol": "string", \
        "IpRanges": [{"CidrIp": "string"}], \
        "PrefixListIds": [{"PrefixListId": "string"}], \
        "ToPort": 0 \
      } \
    ]' \
  --IpProtocol "string" \
  --SourceSecurityGroupName "string" \
  --SourceSecurityGroupOwnerId "string" \
  --ToPort 0


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=AuthorizeSecurityGroupIngress' \
  --data-urlencode 'CidrIp=string' \
  --data-urlencode 'FromPort=0' \
  --data-urlencode 'GroupId=string' \
  --data-urlencode 'GroupName=string' \
  --data-urlencode 'IpPermissions.1.FromPort=0' \
  --data-urlencode 'IpPermissions.1.Groups.1.GroupId=string' \
  --data-urlencode 'IpPermissions.1.Groups.1.GroupName=string' \
  --data-urlencode 'IpPermissions.1.Groups.1.UserId=string' \
  --data-urlencode 'IpPermissions.1.IpProtocol=string' \
  --data-urlencode 'IpPermissions.1.IpRanges.1.CidrIp=string' \
  --data-urlencode 'IpPermissions.1.PrefixListIds.1.PrefixListId=string' \
  --data-urlencode 'IpPermissions.1.ToPort=0' \
  --data-urlencode 'IpProtocol=string' \
  --data-urlencode 'SourceSecurityGroupName=string' \
  --data-urlencode 'SourceSecurityGroupOwnerId=string' \
  --data-urlencode 'ToPort=0'

Parameters

Parameter Type Required Description
CidrIp string false The CIDR IP range.
FromPort integer false The beginning of the port range for the TCP and UDP protocols, or an ICMP type number.
GroupId string false The ID of the security group.
GroupName string false The name of the security group, if you are in the public Cloud.
IpPermissions [IpPermissions_0] false Describes a security group rule.
» FromPort integer false The beginning of the port range for TCP and UDP protocols, or an ICMP type number.
» Groups [Groups_0] false One or more security groups and account ID pairs.
»» GroupId string false The ID of the security group (in case of a security group in a nondefault VPC).
»» GroupName string false The name of the security group (in case of a security group in FCU or a default VPC).
»» UserId string false The account ID of the user.
» IpProtocol string false The IP protocol name (tcp, udp, icmp, or -1 for all protocols). By default, -1. In a VPC, this can also be an IP protocol number. For more information, see the IANA.org website.
» IpRanges [IpRanges_0] false One or more IP ranges.
»» CidrIp string false The range of IPs.
» PrefixListIds [PrefixListIds_0] false One or more prefix list IDs to allow traffic from a VPC to access the corresponding OUTSCALE services. For more information, see DescribePrefixLists.
»» PrefixListId string false The ID of the prefix.
» ToPort integer false The end of the port range for TCP and UDP protocols, or an ICMP code number.
IpProtocol string false The IP protocol name (tcp, udp, icmp, or -1 for all protocols). By default, -1. In a VPC, this can also be an IP protocol number. For more information, see the IANA.org website.
SourceSecurityGroupName string false The name of the source security group (cannot be combined with the FromPort, ToPort, CidrIp and IpProtocol parameters).
SourceSecurityGroupOwnerId string false The OUTSCALE account ID of the owner of the source security group, creating rules that grant full ICMP, UDP, and TCP access (cannot be combined with the FromPort, ToPort, CidrIp and IpProtocol parameters).
ToPort integer false The end of port range for the TCP and UDP protocols, or an ICMP code number.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). AuthorizeSecurityGroupIngressResponse

Example responses

200 Response

{
  "requestId": "string",
  "return": true
}

CreateSecurityGroup

GET /CreateSecurityGroup

Creates a security group.
This action creates a security group either in the public Cloud or in a specified Virtual Private Cloud (VPC). By default, a default security group for use in the public Cloud and a default security group for use in a VPC are created.
When launching an instance, if no security group is explicitly specified, the appropriate default security group is assigned to the instance. Default security groups include a default rule granting instances network access to each other.
When creating a security group, you specify a name. Two security groups for use in the public Cloud or for use in a VPC cannot have the same name.
You can have up to 500 security groups in the public Cloud. You can create up to 500 security groups per VPC.
To add or remove rules, use the AuthorizeSecurityGroupIngress, AuthorizeSecurityGroupEgress, RevokeSecurityGroupIngress or RevokeSecurityGroupEgress methods.

Code samples

osc-cli fcu CreateSecurityGroup --profile "default" \
  --DryRun False \
  --GroupDescription "string" \
  --GroupName "string" \
  --VpcId "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=CreateSecurityGroup' \
  --data-urlencode 'DryRun=false' \
  --data-urlencode 'GroupDescription=string' \
  --data-urlencode 'GroupName=string' \
  --data-urlencode 'VpcId=string'

Parameters

Parameter Type Required Description
DryRun boolean false If set to true, checks whether you have the required permissions to perform the action.
GroupDescription string true A description for the security group, between 1 and 255 ASCII characters.
GroupName string true The name of the security group.
This name must not start with sg-.
This name must be unique and contain between 1 and 255 ASCII characters. Accented letters are not allowed.
VpcId string false The ID of the VPC.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreateSecurityGroupResponse

Example responses

200 Response

{
  "groupId": "string",
  "requestId": "string",
  "return": true
}

DeleteSecurityGroup

GET /DeleteSecurityGroup

Deletes a specified security group.
You can specify either the name of the security group or its ID.
This action fails if the specified group is associated with an instance or referenced by another security group.

Code samples

osc-cli fcu DeleteSecurityGroup --profile "default" \
  --GroupId "string" \
  --GroupName "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DeleteSecurityGroup' \
  --data-urlencode 'GroupId=string' \
  --data-urlencode 'GroupName=string'

Parameters

Parameter Type Required Description
GroupId string false The ID of the security group. In a Virtual Private Cloud (VPC), this parameter is required.
GroupName string false (Public Cloud only) The name of the security group.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeleteSecurityGroupResponse

Example responses

200 Response

{
  "requestId": "string",
  "return": true
}

DescribeSecurityGroups

GET /DescribeSecurityGroups

Describes one or more security groups.
You can specify either the name of the security groups or their IDs.
You can use the Filter.N parameter to filter the security groups on the following properties:

Code samples

osc-cli fcu DescribeSecurityGroups --profile "default" \
  --Filter '[ \
      { \
        "Name": "string", \
        "Value": ["string"] \
      } \
    ]' \
  --GroupId '["string"]' \
  --GroupName '["string"]'


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeSecurityGroups' \
  --data-urlencode 'Filter.1.Name=string' \
  --data-urlencode 'Filter.1.Value.1=string' \
  --data-urlencode 'GroupId.1=string' \
  --data-urlencode 'GroupName.1=string'

Parameters

Parameter Type Required Description
Filter [Filter] false One or more filters.
Example:
osc-cli fcu DescribeSecurityGroups \
  --Filter.1.Name "tag:KEYOFTHETAG" \
  --Filter.1.Value.1 "VALUEOFTHETAG"
» Name string false The name of the filter.
» Value [string] false One or more filter values.
GroupId [string] false The ID of one or more security groups.
GroupName [string] false The name of one or more security groups. This parameter only matches security groups in the public Cloud. To match security groups in a VPC, use the group-name filter instead.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DescribeSecurityGroupsResponse

Example responses

200 Response

{
  "requestId": "string",
  "securityGroupInfo": [
    {
      "groupDescription": "string",
      "groupId": "string",
      "groupName": "string",
      "ipPermissions": [
        {
          "fromPort": 0,
          "groups": [
            {
              "groupId": "string",
              "groupName": "string",
              "userId": "string"
            }
          ],
          "ipProtocol": "string",
          "ipRanges": [
            {
              "cidrIp": "string"
            }
          ],
          "prefixListIds": [
            {
              "prefixListId": "string"
            }
          ],
          "toPort": 0
        }
      ],
      "ipPermissionsEgress": [
        {
          "fromPort": 0,
          "groups": [
            {
              "groupId": "string",
              "groupName": "string",
              "userId": "string"
            }
          ],
          "ipProtocol": "string",
          "ipRanges": [
            {
              "cidrIp": "string"
            }
          ],
          "prefixListIds": [
            {
              "prefixListId": "string"
            }
          ],
          "toPort": 0
        }
      ],
      "ownerId": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "vpcId": "string"
    }
  ]
}

RevokeSecurityGroupEgress

GET /RevokeSecurityGroupEgress

Removes one or more egress rules from a security group for a VPC.
In case of TCP and UDP protocols, you have to indicate the destination port or range of ports. In case of ICMP protocol, you have to indicate ICMP type and code numbers.
Rules (IP permissions) consist of the protocol, CIDR range or source security group.
To revoke outbound access to a destination security group, we recommand to use a set of IP permissions. We also recommand to specify the protocol in a set of IP permissions.

Code samples

osc-cli fcu RevokeSecurityGroupEgress --profile "default" \
  --CidrIp "string" \
  --FromPort 0 \
  --GroupId "string" \
  --IpPermissions '[ \
      { \
        "FromPort": 0, \
        "Groups": [{"GroupId": "string", "GroupName": "string", "UserId": "string"}], \
        "IpProtocol": "string", \
        "IpRanges": [{"CidrIp": "string"}], \
        "PrefixListIds": [{"PrefixListId": "string"}], \
        "ToPort": 0 \
      } \
    ]' \
  --IpProtocol "string" \
  --SourceSecurityGroupName "string" \
  --SourceSecurityGroupOwnerId "string" \
  --ToPort 0


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=RevokeSecurityGroupEgress' \
  --data-urlencode 'CidrIp=string' \
  --data-urlencode 'FromPort=0' \
  --data-urlencode 'GroupId=string' \
  --data-urlencode 'IpPermissions.1.FromPort=0' \
  --data-urlencode 'IpPermissions.1.Groups.1.GroupId=string' \
  --data-urlencode 'IpPermissions.1.Groups.1.GroupName=string' \
  --data-urlencode 'IpPermissions.1.Groups.1.UserId=string' \
  --data-urlencode 'IpPermissions.1.IpProtocol=string' \
  --data-urlencode 'IpPermissions.1.IpRanges.1.CidrIp=string' \
  --data-urlencode 'IpPermissions.1.PrefixListIds.1.PrefixListId=string' \
  --data-urlencode 'IpPermissions.1.ToPort=0' \
  --data-urlencode 'IpProtocol=string' \
  --data-urlencode 'SourceSecurityGroupName=string' \
  --data-urlencode 'SourceSecurityGroupOwnerId=string' \
  --data-urlencode 'ToPort=0'

Parameters

Parameter Type Required Description
CidrIp string false The CIDR IP range.
FromPort integer false The beginning of port range for the TCP and UDP protocols, or an ICMP type number.
GroupId string true The ID of the security group.
IpPermissions [IpPermissions_0] false Information about one or more IP permissions.
» FromPort integer false The beginning of the port range for TCP and UDP protocols, or an ICMP type number.
» Groups [Groups_0] false One or more security groups and account ID pairs.
»» GroupId string false The ID of the security group (in case of a security group in a nondefault VPC).
»» GroupName string false The name of the security group (in case of a security group in FCU or a default VPC).
»» UserId string false The account ID of the user.
» IpProtocol string false The IP protocol name (tcp, udp, icmp, or -1 for all protocols). By default, -1. In a VPC, this can also be an IP protocol number. For more information, see the IANA.org website.
» IpRanges [IpRanges_0] false One or more IP ranges.
»» CidrIp string false The range of IPs.
» PrefixListIds [PrefixListIds_0] false One or more prefix list IDs to allow traffic from a VPC to access the corresponding OUTSCALE services. For more information, see DescribePrefixLists.
»» PrefixListId string false The ID of the prefix.
» ToPort integer false The end of the port range for TCP and UDP protocols, or an ICMP code number.
IpProtocol string false The IP protocol name (tcp, udp, icmp, or -1 for all protocols). By default, -1. In a VPC, this can also be an IP protocol number. For more information, see the IANA.org website.
SourceSecurityGroupName string false The name of a destination security group.
SourceSecurityGroupOwnerId string false The OUTSCALE account ID of the owner of a destination security group.
ToPort integer false The end of port range for the TCP and UDP protocols, or an ICMP code number.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). RevokeSecurityGroupEgressResponse

Example responses

200 Response

{
  "requestId": "string",
  "return": true
}

RevokeSecurityGroupIngress

GET /RevokeSecurityGroupIngress

Removes one or more ingress rules from a security group. The values specified in the revoke request must exactly match the value of the existing rule for the rule to be removed.
In case of TCP and UDP protocols, you have to indicate the destination port or range of ports. In case of ICMP protocol, you have to specify the ICMP type and code numbers.
Rules (IP permissions) consist of the protocol, the CIDR range and the source security group.

Code samples

osc-cli fcu RevokeSecurityGroupIngress --profile "default" \
  --CidrIp "string" \
  --FromPort 0 \
  --GroupId "string" \
  --GroupName "string" \
  --IpPermissions '[ \
      { \
        "FromPort": 0, \
        "Groups": [{"GroupId": "string", "GroupName": "string", "UserId": "string"}], \
        "IpProtocol": "string", \
        "IpRanges": [{"CidrIp": "string"}], \
        "PrefixListIds": [{"PrefixListId": "string"}], \
        "ToPort": 0 \
      } \
    ]' \
  --IpProtocol "string" \
  --SourceSecurityGroupName "string" \
  --SourceSecurityGroupOwnerId "string" \
  --ToPort 0


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=RevokeSecurityGroupIngress' \
  --data-urlencode 'CidrIp=string' \
  --data-urlencode 'FromPort=0' \
  --data-urlencode 'GroupId=string' \
  --data-urlencode 'GroupName=string' \
  --data-urlencode 'IpPermissions.1.FromPort=0' \
  --data-urlencode 'IpPermissions.1.Groups.1.GroupId=string' \
  --data-urlencode 'IpPermissions.1.Groups.1.GroupName=string' \
  --data-urlencode 'IpPermissions.1.Groups.1.UserId=string' \
  --data-urlencode 'IpPermissions.1.IpProtocol=string' \
  --data-urlencode 'IpPermissions.1.IpRanges.1.CidrIp=string' \
  --data-urlencode 'IpPermissions.1.PrefixListIds.1.PrefixListId=string' \
  --data-urlencode 'IpPermissions.1.ToPort=0' \
  --data-urlencode 'IpProtocol=string' \
  --data-urlencode 'SourceSecurityGroupName=string' \
  --data-urlencode 'SourceSecurityGroupOwnerId=string' \
  --data-urlencode 'ToPort=0'

Parameters

Parameter Type Required Description
CidrIp string false The CIDR IP range.
FromPort integer false The beginning of the port range for the TCP and UDP protocols, or an ICMP type number.
GroupId string false The ID of the security group.
GroupName string false The name of the security group, if you are in the public Cloud.
IpPermissions [IpPermissions_0] false A set of IP permissions.
» FromPort integer false The beginning of the port range for TCP and UDP protocols, or an ICMP type number.
» Groups [Groups_0] false One or more security groups and account ID pairs.
»» GroupId string false The ID of the security group (in case of a security group in a nondefault VPC).
»» GroupName string false The name of the security group (in case of a security group in FCU or a default VPC).
»» UserId string false The account ID of the user.
» IpProtocol string false The IP protocol name (tcp, udp, icmp, or -1 for all protocols). By default, -1. In a VPC, this can also be an IP protocol number. For more information, see the IANA.org website.
» IpRanges [IpRanges_0] false One or more IP ranges.
»» CidrIp string false The range of IPs.
» PrefixListIds [PrefixListIds_0] false One or more prefix list IDs to allow traffic from a VPC to access the corresponding OUTSCALE services. For more information, see DescribePrefixLists.
»» PrefixListId string false The ID of the prefix.
» ToPort integer false The end of the port range for TCP and UDP protocols, or an ICMP code number.
IpProtocol string false The IP protocol name (tcp, udp, icmp, or -1 for all protocols). By default, -1. In a VPC, this can also be an IP protocol number. For more information, see the IANA.org website.
SourceSecurityGroupName string false The name of the source security group (cannot be specified alongside the CIDR IP range, the start of the port range, the IP protocol, and the end of the port range).
SourceSecurityGroupOwnerId string false The account ID of the owner of the source security group.
ToPort integer false The end of the port range for the TCP and UDP protocols, or an ICMP code number.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). RevokeSecurityGroupIngressResponse

Example responses

200 Response

{
  "requestId": "string",
  "return": true
}

Snapshots

CopySnapshot

GET /CopySnapshot

Copies a snapshot to your account, from an account in the same Region.
To do so, the owner of the source snapshot must share it with your account. For more information about how to share a snapshot with another account, see ModifySnapshotAttribute.
The copy of the source snapshot is independent and belongs to you.

[NOTE]
To copy a snapshot between accounts in different Regions, the owner of the source snapshot must export it to an OUTSCALE Object Storage (OOS) bucket using the CreateSnapshotExportTask method, and then you need to import it using the ImportSnapshot method. For more information, see CreateSnapshotExportTask and ImportSnapshot.

Code samples

osc-cli fcu CopySnapshot --profile "default" \
  --Description "string" \
  --DestinationRegion "string" \
  --DryRun False \
  --SourceRegion "string" \
  --SourceSnapshotId "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=CopySnapshot' \
  --data-urlencode 'Description=string' \
  --data-urlencode 'DestinationRegion=string' \
  --data-urlencode 'DryRun=false' \
  --data-urlencode 'SourceRegion=string' \
  --data-urlencode 'SourceSnapshotId=string'

Parameters

Parameter Type Required Description
Description string false A description for the new snapshot (if different from the source snapshot one).
DestinationRegion string false The name of the destination Region, which must be the same as the source Region.
DryRun boolean false If set to true, checks whether you have the required permissions to perform the action.
SourceRegion string true The name of the source Region, which must be the same as the Region of your account.
SourceSnapshotId string true The ID of the snapshot you want to copy.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CopySnapshotResponse

Example responses

200 Response

{
  "requestId": "string",
  "snapshotId": "string"
}

CreateSnapshot

GET /CreateSnapshot

Creates a snapshot of a BSU volume.
Snapshots are point-in-time images of a volume you can use to back up your data or to create replicas of this volume at the time the snapshot was created.

Code samples

osc-cli fcu CreateSnapshot --profile "default" \
  --Description "string" \
  --DryRun False \
  --VolumeId "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=CreateSnapshot' \
  --data-urlencode 'Description=string' \
  --data-urlencode 'DryRun=false' \
  --data-urlencode 'VolumeId=string'

Parameters

Parameter Type Required Description
Description string false A description for the new snapshot.
DryRun boolean false If set to true, checks whether you have the required permissions to perform the action.
VolumeId string true The ID of the BSU volume you want to create a snapshot of.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreateSnapshotResponse

Example responses

200 Response

{
  "description": "string",
  "encrypted": true,
  "ownerId": "string",
  "progress": "string",
  "requestId": "string",
  "snapshotId": "string",
  "startTime": "string",
  "status": "string",
  "tagSet": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "volumeId": "string",
  "volumeSize": 0
}

CreateSnapshotExportTask

GET /CreateSnapshotExportTask

Exports a snapshot to an OUTSCALE Object Storage (OOS) bucket.
This action enables you to create a backup of your snapshot or to copy it to another account. You or other users you send a pre-signed URL to can then download this snapshot from the bucket using the ImportSnapshot method. For more information, see ImportSnapshot.
This procedure enables you to copy a snapshot between accounts within the same Region or in different Regions. To copy a snapshot within the same Region, you can also use the CopySnapshot direct method. For more information, see CopySnapshot.
The copy of the source snapshot is independent and belongs to you.

Code samples

osc-cli fcu CreateSnapshotExportTask --profile "default" \
  --ExportToOsu '{ \
      "DiskImageFormat": "string", \
      "OsuBucket": "string", \
      "OsuPrefix": "string", \
      "aksk": { \
        "AccessKey": "string", \
        "SecretKey": "string" \
      } \
    }' \
  --SnapshotId "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=CreateSnapshotExportTask' \
  --data-urlencode 'ExportToOsu.DiskImageFormat=string' \
  --data-urlencode 'ExportToOsu.OsuBucket=string' \
  --data-urlencode 'ExportToOsu.OsuPrefix=string' \
  --data-urlencode 'ExportToOsu.aksk.AccessKey=string' \
  --data-urlencode 'ExportToOsu.aksk.SecretKey=string' \
  --data-urlencode 'SnapshotId=string'

Parameters

Parameter Type Required Description
ExportToOsu ExportToOsu_1 true Information about the snapshot export task.
» DiskImageFormat string true The format of the export disk (qcow2 | raw).
» OsuBucket string true The name of the OOS bucket where you want to export the snapshot.
» OsuPrefix string false The prefix for the key of the OOS object corresponding to the snapshot.
» aksk aksk false The access key and secret key of the OOS account used to access the bucket.
»» AccessKey string false The access key of the OOS account that enables you to access the bucket.
»» SecretKey string false The secret key of the OOS account that enables you to access the bucket.
» SnapshotId string true The ID of the snapshot to export.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreateSnapshotExportTaskResponse

Example responses

200 Response

{
  "requestId": "string",
  "snapshotExportTask": {
    "completion": 0,
    "exportToOsu": {
      "aksk": {
        "AccessKey": "string",
        "SecretKey": "string"
      },
      "diskImageFormat": "string",
      "osuBucket": "string",
      "osuKey": "string",
      "osuPrefix": "string"
    },
    "snapshotExport": {
      "snapshotId": "string"
    },
    "snapshotExportTaskId": "string",
    "state": "string",
    "statusMessage": "string",
    "tagSet": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  }
}

DeleteSnapshot

GET /DeleteSnapshot

Deletes a specified snapshot.
You cannot delete a snapshot that is currently used by an OUTSCALE machine image (OMI). To do so, you first need to delete the corresponding OMI. For more information, see the DeregisterImage method.

Code samples

osc-cli fcu DeleteSnapshot --profile "default" \
  --SnapshotId "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DeleteSnapshot' \
  --data-urlencode 'SnapshotId=string'

Parameters

Parameter Type Required Description
SnapshotId string true The ID of the snapshot you want to delete.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeleteSnapshotResponse

Example responses

200 Response

{
  "requestId": "string",
  "return": true
}

DescribeSnapshotAttribute

GET /DescribeSnapshotAttribute

Describes the permissions to create a volume from a specified snapshot.

Code samples

osc-cli fcu DescribeSnapshotAttribute --profile "default" \
  --Attribute "string" \
  --SnapshotId "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeSnapshotAttribute' \
  --data-urlencode 'Attribute=string' \
  --data-urlencode 'SnapshotId=string'

Parameters

Parameter Type Required Description
Attribute string true The snapshot attribute (always createVolumePermission).
SnapshotId string true The ID of the snapshot.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DescribeSnapshotAttributeResponse

Example responses

200 Response

{
  "createVolumePermission": [
    {
      "Group": "string",
      "UserId": "string"
    }
  ],
  "requestId": "string",
  "snapshotId": "string"
}

DescribeSnapshotExportTasks

GET /DescribeSnapshotExportTasks

Describes one or more snapshot export tasks.

Code samples

osc-cli fcu DescribeSnapshotExportTasks --profile "default" \
  --SnapshotExportTaskId '["string"]'


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeSnapshotExportTasks' \
  --data-urlencode 'SnapshotExportTaskId.1=string'

Parameters

Parameter Type Required Description
SnapshotExportTaskId [string] false One or more snapshot export tasks IDs.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DescribeSnapshotExportTasksResponse

Example responses

200 Response

{
  "requestId": "string",
  "snapshotExportTaskSet": [
    {
      "completion": 0,
      "exportToOsu": {
        "aksk": {
          "AccessKey": "string",
          "SecretKey": "string"
        },
        "diskImageFormat": "string",
        "osuBucket": "string",
        "osuKey": "string",
        "osuPrefix": "string"
      },
      "snapshotExport": {
        "snapshotId": "string"
      },
      "snapshotExportTaskId": "string",
      "state": "string",
      "statusMessage": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ]
    }
  ]
}

DescribeSnapshots

GET /DescribeSnapshots

Describes one or more snapshots that are available to you.
You can filter the described snapshots using the SnapshotId.N, the Owner.N and the RestorableBy.N parameters.
You can also use the Filter.N parameter to filter the snapshots on the following properties:

Code samples

osc-cli fcu DescribeSnapshots --profile "default" \
  --DryRun False \
  --Filter '[ \
      { \
        "Name": "string", \
        "Value": ["string"] \
      } \
    ]' \
  --MaxResults 0 \
  --NextToken "string" \
  --Owner '["string"]' \
  --RestorableBy '["string"]' \
  --SnapshotId '["string"]'


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeSnapshots' \
  --data-urlencode 'DryRun=false' \
  --data-urlencode 'Filter.1.Name=string' \
  --data-urlencode 'Filter.1.Value.1=string' \
  --data-urlencode 'MaxResults=0' \
  --data-urlencode 'NextToken=string' \
  --data-urlencode 'Owner.1=string' \
  --data-urlencode 'RestorableBy.1=string' \
  --data-urlencode 'SnapshotId.1=string'

Parameters

Parameter Type Required Description
DryRun boolean false If set to true, checks whether you have the required permissions to perform the action.
Filter [Filter] false One or more filters.
Example:
osc-cli fcu DescribeSnapshotss \
  --Filter.1.Name "tag:KEYOFTHETAG" \
  --Filter.1.Value.1 "VALUEOFTHETAG"
» Name string false The name of the filter.
» Value [string] false One or more filter values.
MaxResults integer false The maximum number of results that can be returned in a single page. You can use NextToken to request the next results pages. This value is between 5 and 1000. If you provide a value larger than 1000, only 1000 results are returned.
NextToken string false The token to request the next results page.
Owner [string] false One or more owners of the snapshots.
RestorableBy [string] false One or more accounts IDs that have the permissions to create volumes from the snapshot.
SnapshotId [string] false One or more snapshot IDs.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DescribeSnapshotsResponse

Example responses

200 Response

{
  "nextToken": "string",
  "requestId": "string",
  "snapshotSet": [
    {
      "description": "string",
      "encrypted": true,
      "ownerAlias": "string",
      "ownerId": "string",
      "progress": "string",
      "snapshotId": "string",
      "startTime": "string",
      "status": "string",
      "statusMessage": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "volumeId": "string",
      "volumeSize": 0
    }
  ]
}

ImportSnapshot

GET /ImportSnapshot

Imports a snapshot from an S3-compatible bucket to create a copy of this snapshot in your account.
This method enables you to copy a snapshot from another account that is either within the same Region as the bucket, or in a different one. To copy a snapshot within the same Region, you can also use the CopySnapshot direct method. For more information, see CopySnapshot.
The copy of the source snapshot is independent and belongs to you.
You can import a snapshot using a pre-signed URL. You do not need any permission for this snapshot, or the bucket in which it is contained. The pre-signed URL is valid for seven days (you can generate a new one if needed). For more information about how to export a snapshot to an OUTSCALE Object Storage (OOS) bucket, see CreateSnapshotExportTask.

Code samples

osc-cli fcu ImportSnapshot --profile "default" \
  --description "string" \
  --snapshotLocation "string" \
  --snapshotSize "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=ImportSnapshot' \
  --data-urlencode 'description=string' \
  --data-urlencode 'snapshotLocation=string' \
  --data-urlencode 'snapshotSize=string'

Parameters

Parameter Type Required Description
description string false The description for the snapshot you want to create in your account.
snapshotLocation string true The pre-signed URL of the snapshot you want to import from the bucket.
snapshotSize string true The size of the snapshot you want to create in your account, in bytes. This size must be greater than or equal to the size of the original, uncompressed snapshot.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ImportSnapshotResponse

Example responses

200 Response

{
  "description": "string",
  "encrypted": true,
  "ownerAlias": "string",
  "ownerId": "string",
  "progress": "string",
  "requestId": "string",
  "snapshotId": "string",
  "startTime": "string",
  "status": "string",
  "volumeId": "string",
  "volumeSize": 0
}

ModifySnapshotAttribute

GET /ModifySnapshotAttribute

Modifies the permissions for a specified snapshot.
You can add or remove permissions for specified account IDs or groups. You can share a snapshot with a user that is in the same Region. The user can create a copy of the snapshot you shared, obtaining all the rights for the copy of the snapshot. For more information, see CopySnapshot.

Code samples

osc-cli fcu ModifySnapshotAttribute --profile "default" \
  --CreateVolumePermission '{ \
      "Add": [ \
        {"Group": "string", "UserId": "string"} \
      ], \
      "Remove": [ \
        {"Group": "string", "UserId": "string"} \
      ] \
    }' \
  --DryRun False \
  --SnapshotId "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=ModifySnapshotAttribute' \
  --data-urlencode 'CreateVolumePermission.Add.1.Group=string' \
  --data-urlencode 'CreateVolumePermission.Add.1.UserId=string' \
  --data-urlencode 'CreateVolumePermission.Remove.1.Group=string' \
  --data-urlencode 'CreateVolumePermission.Remove.1.UserId=string' \
  --data-urlencode 'DryRun=false' \
  --data-urlencode 'SnapshotId=string'

Parameters

Parameter Type Required Description
CreateVolumePermission CreateVolumePermission_0 false Enables you to modify the permissions to create a volume for account IDs or groups. If you specify both Add and Remove attributes in the request, only Add is taken into account.
» Add [Add] false The account ID you want to add to the list of permissions for the volume.
»» Group string false The name of the group (all if public).
»» UserId string false The account ID of the user.
» Remove [Remove] false The account ID you want to remove from the list of permissions for the volume.
»» Group string false The name of the group (all if public).
»» UserId string false The account ID of the user.
» DryRun boolean false If set to true, checks whether you have the required permissions to perform the action.
» SnapshotId string true The ID of the snapshot.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ModifySnapshotAttributeResponse

Example responses

200 Response

{
  "requestId": "string",
  "return": true
}

Subnets

CreateSubnet

GET /CreateSubnet

Creates a subnet in an existing VPC.
To create a subnet in a VPC, you have to provide the ID of the VPC and the CIDR block for the subnet (its network range). Once the subnet is created, you cannot modify its CIDR block.

Code samples

osc-cli fcu CreateSubnet --profile "default" \
  --AvailabilityZone "string" \
  --CidrBlock "string" \
  --VpcId "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=CreateSubnet' \
  --data-urlencode 'AvailabilityZone=string' \
  --data-urlencode 'CidrBlock=string' \
  --data-urlencode 'VpcId=string'

Parameters

Parameter Type Required Description
AvailabilityZone string false The name of the Availability Zone in which you want to create the subnet.
CidrBlock string true The CIDR block for the subnet (for example, 10.0.0.0/24).
The CIDR block of the subnet can be either the same as the VPC one if you create only a single subnet in this VPC, or a subset of the VPC one. In case of several subnets in a VPC, their CIDR blocks must no overlap. The smallest subnet you can create uses a /29 netmask (eight IPs). For more information, see About VPCs.
VpcId string true The ID of the VPC.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreateSubnetResponse

Example responses

200 Response

{
  "requestId": "string",
  "subnet": {
    "availabilityZone": "string",
    "availableIpAddressCount": 0,
    "cidrBlock": "string",
    "mapPublicIpOnLaunch": true,
    "state": "string",
    "subnetId": "string",
    "tagSet": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "vpcId": "string"
  }
}

DeleteSubnet

GET /DeleteSubnet

Deletes a specified subnet.
You must terminate all the running instances in the subnet before deleting it.

Code samples

osc-cli fcu DeleteSubnet --profile "default" \
  --SubnetId "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DeleteSubnet' \
  --data-urlencode 'SubnetId=string'

Parameters

Parameter Type Required Description
SubnetId string true The ID of the subnet you want to delete.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeleteSubnetResponse

Example responses

200 Response

{
  "requestId": "string",
  "return": true
}

DescribeSubnets

GET /DescribeSubnets

Describes one or more of your subnets.
If you do not specify any subnet ID, this action describes all of your subnets.
You can use the Filter.N parameter to filter the subnets on the following properties:

Code samples

osc-cli fcu DescribeSubnets --profile "default" \
  --Filter '[ \
      { \
        "Name": "string", \
        "Value": ["string"] \
      } \
    ]' \
  --SubnetId '["string"]'


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeSubnets' \
  --data-urlencode 'Filter.1.Name=string' \
  --data-urlencode 'Filter.1.Value.1=string' \
  --data-urlencode 'SubnetId.1=string'

Parameters

Parameter Type Required Description
Filter [Filter] false One or more filters.
» Name string false The name of the filter.
» Value [string] false One or more filter values.
SubnetId [string] false One or more subnet IDs.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DescribeSubnetsResponse

Example responses

200 Response

{
  "requestId": "string",
  "subnetSet": [
    {
      "availabilityZone": "string",
      "availableIpAddressCount": 0,
      "cidrBlock": "string",
      "mapPublicIpOnLaunch": true,
      "state": "string",
      "subnetId": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "vpcId": "string"
    }
  ]
}

ModifySubnetAttribute

GET /ModifySubnetAttribute

Modifies the specified attribute of a subnet.

Code samples

osc-cli fcu ModifySubnetAttribute --profile "default" \
  --MapPublicIpOnLaunch '{ \
      "Value": True \
    }' \
  --SubnetId "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=ModifySubnetAttribute' \
  --data-urlencode 'MapPublicIpOnLaunch.Value=true' \
  --data-urlencode 'SubnetId=string'

Parameters

Parameter Type Required Description
MapPublicIpOnLaunch MapPublicIpOnLaunch false If set to true, an External IP (EIP) is automatically assigned to the instance launched with this subnet. The EIP remains assigned to the instance, even when it is stopped, and is released when the instance is terminated.
» Value boolean false A boolean value (true or false) that can be used when the resource is of boolean type.
SubnetId string true The ID of the subnet.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ModifySubnetAttributeResponse

Example responses

200 Response

{
  "requestId": "string",
  "return": true
}

Tags

CreateTags

GET /CreateTags

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

Code samples

osc-cli fcu CreateTags --profile "default" \
  --ResourceId '["string"]' \
  --Tag '[ \
      { \
        "Key": "string", \
        "Value": "string" \
      } \
    ]'


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=CreateTags' \
  --data-urlencode 'ResourceId.1=string' \
  --data-urlencode 'Tag.1.Key=string' \
  --data-urlencode 'Tag.1.Value=string'

Parameters

Parameter Type Required Description
ResourceId [string] true One or more resource IDs.
Tag [Tag] true One or more tags you want to add to the specified resources. Example for an instance:
osc-cli fcu CreateTags \
  --ResourceId i-xxxxxxxx \
  --Tag.1.Key "AAAA" --Tag.1.Value "BBBB"\
  --Tag.2.Key "CCCC" --Tag.2.Value "DDDD"
» Key string false The key of the tag, with a minimum of 1 character.
» Value string false The value of the tag, between 0 and 255 characters.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreateTagsResponse

Example responses

200 Response

{
  "requestId": "string",
  "return": true
}

DeleteTags

GET /DeleteTags

Deletes one or more tags from the specified resources.

Code samples

osc-cli fcu DeleteTags --profile "default" \
  --ResourceId '["string"]' \
  --Tag '[ \
      { \
        "Key": "string", \
        "Value": "string" \
      } \
    ]'


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DeleteTags' \
  --data-urlencode 'ResourceId.1=string' \
  --data-urlencode 'Tag.1.Key=string' \
  --data-urlencode 'Tag.1.Value=string'

Parameters

Parameter Type Required Description
ResourceId [string] true One or more resource IDs.
Tag [Tag] false One or more tags you want to delete from the specified resources. (if you set a tag value, only the tags matching exactly this value are deleted)
» Key string false The key of the tag, with a minimum of 1 character.
» Value string false The value of the tag, between 0 and 255 characters.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeleteTagsResponse

Example responses

200 Response

{
  "requestId": "string",
  "return": true
}

DescribeTags

GET /DescribeTags

Describes one or more tags for your resources.
You can use the Filter.N parameter to filter the tags on the following properties:

Code samples

osc-cli fcu DescribeTags --profile "default" \
  --Filter '[ \
      { \
        "Name": "string", \
        "Value": ["string"] \
      } \
    ]' \
  --MaxResults 0 \
  --NextToken "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeTags' \
  --data-urlencode 'Filter.1.Name=string' \
  --data-urlencode 'Filter.1.Value.1=string' \
  --data-urlencode 'MaxResults=0' \
  --data-urlencode 'NextToken=string'

Parameters

Parameter Type Required Description
Filter [Filter] false One or more filters.
Example:
osc-cli fcu DescribeTags \
  --Filter.1.Name "resource-id" \
  --Filter.1.Value.1 "i-12345678"
» Name string false The name of the filter.
» Value [string] false One or more filter values.
MaxResults integer false The maximum number of results that can be returned in a single page. You can use the NextToken attribute to request the next results pages. This value is between 5 and 1000. If you provide a value larger than 1000, only 1000 results are returned.
NextToken string false The token to request the next results page.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DescribeTagsResponse

Example responses

200 Response

{
  "nextToken": "string",
  "requestId": "string",
  "tagSet": [
    {
      "key": "string",
      "resourceId": "string",
      "resourceType": "string",
      "value": "string"
    }
  ]
}

Tasks

CancelExportTask

GET /CancelExportTask

Cancels an export task.
If the export task is not running, the command fails and an error is returned.

Code samples

osc-cli fcu CancelExportTask --profile "default" \
  --ExportTaskId "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=CancelExportTask' \
  --data-urlencode 'ExportTaskId=string'

Parameters

Parameter Type Required Description
ExportTaskId string true The ID of the export task to cancel.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CancelExportTaskResponse

Example responses

200 Response

{
  "requestId": "string",
  "return": true
}

VPC

CreateVpc

GET /CreateVpc

Creates a Virtual Private Cloud (VPC) with a specified CIDR block.
The CIDR block (network range) of your VPC must be between a /28 netmask (16 IPs) and a /16 netmask (65536 IPs).

Code samples

osc-cli fcu CreateVpc --profile "default" \
  --CidrBlock "string" \
  --InstanceTenancy "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=CreateVpc' \
  --data-urlencode 'CidrBlock=string' \
  --data-urlencode 'InstanceTenancy=string'

Parameters

Parameter Type Required Description
CidrBlock string true The CIDR block for the VPC (for example, 10.0.0.0/16).
InstanceTenancy string false The tenancy options of the instances (default if an instance created in a VPC can be lauched with any tenancy, dedicated if it can be launched with dedicated tenancy instances running on single-tenant hardware).

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreateVpcResponse

Example responses

200 Response

{
  "requestId": "string",
  "vpc": {
    "cidrBlock": "string",
    "dhcpOptionsId": "string",
    "instanceTenancy": "string",
    "isDefault": true,
    "state": "string",
    "tagSet": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "vpcId": "string"
  }
}

DeleteVpc

GET /DeleteVpc

Deletes a specified VPC.
Before deleting the VPC, you need to delete or detach all the resources associated with the VPC:

Code samples

osc-cli fcu DeleteVpc --profile "default" \
  --VpcId "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DeleteVpc' \
  --data-urlencode 'VpcId=string'

Parameters

Parameter Type Required Description
VpcId string true The ID of the VPC you want to delete.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeleteVpcResponse

Example responses

200 Response

{
  "requestId": "string",
  "return": true
}

DescribeVpcAttribute

GET /DescribeVpcAttribute

Describes a specified attribute of a VPC.

You can specify only one attribute at a time. You can get information about the two following attributes:

The description of these attributes always returns true, as the VPCs do not support their deactivation.

Code samples

osc-cli fcu DescribeVpcAttribute --profile "default" \
  --Attribute "string" \
  --VpcId "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeVpcAttribute' \
  --data-urlencode 'Attribute=string' \
  --data-urlencode 'VpcId=string'

Parameters

Parameter Type Required Description
Attribute string true The attribute name (enableDnsSupport or enableDnsHostnames).
VpcId string true The ID of the VPC.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DescribeVpcAttributeResponse

Example responses

200 Response

{
  "enableDnsHostnames": {
    "value": true
  },
  "enableDnsSupport": {
    "value": true
  },
  "requestId": "string",
  "vpcId": "string"
}

DescribeVpcs

GET /DescribeVpcs

Describes one or more Virtual Private Clouds (VPCs).
You can use the Filter.N parameter to filter the VPCs on the following properties:

Code samples

osc-cli fcu DescribeVpcs --profile "default" \
  --Filter '[ \
      { \
        "Name": "string", \
        "Value": ["string"] \
      } \
    ]' \
  --VpcId '["string"]'


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeVpcs' \
  --data-urlencode 'Filter.1.Name=string' \
  --data-urlencode 'Filter.1.Value.1=string' \
  --data-urlencode 'VpcId.1=string'

Parameters

Parameter Type Required Description
Filter [Filter] false One or more filters.
Example:
osc-cli fcu DescribeVpcs \
  --Filter.1.Name "tag:KEYOFTHETAG" \
  --Filter.1.Value.1 "VALUEOFTHETAG"
» Name string false The name of the filter.
» Value [string] false One or more filter values.
VpcId [string] false One or more VPC IDs.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DescribeVpcsResponse

Example responses

200 Response

{
  "requestId": "string",
  "vpcSet": [
    {
      "cidrBlock": "string",
      "dhcpOptionsId": "string",
      "instanceTenancy": "string",
      "isDefault": true,
      "state": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "vpcId": "string"
    }
  ]
}

ModifyVpcAttribute

GET /ModifyVpcAttribute

Modifies a specified attribute of a VPC.
You can modify only one attribute at a time.

Code samples

osc-cli fcu ModifyVpcAttribute --profile "default" \
  --EnableDnsHostnames '{ \
      "Value": True \
    }' \
  --EnableDnsSupport '{ \
      "Value": True \
    }' \
  --VpcId "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=ModifyVpcAttribute' \
  --data-urlencode 'EnableDnsHostnames.Value=true' \
  --data-urlencode 'EnableDnsSupport.Value=true' \
  --data-urlencode 'VpcId=string'

Parameters

Parameter Type Required Description
EnableDnsHostnames EnableDnsHostnames_0 false If set to true, instances launched in the VPC get DNS hostnames (by default, true).
» Value boolean false A boolean value (true or false) that can be used when the resource is of boolean type.
EnableDnsSupport EnableDnsSupport_0 false If set to true, DNS resolution is supported for the VPC (by default, true).
» Value boolean false A boolean value (true or false) that can be used when the resource is of boolean type.
VpcId string true The ID of the VPC.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ModifyVpcAttributeResponse

Example responses

200 Response

{
  "requestId": "string",
  "return": true
}

VPC Endpoints

CreateVpcEndpoint

GET /CreateVpcEndpoint

Creates a Virtual Private Cloud (VPC) endpoint to access an OUTSCALE service from this VPC without using the Internet and External IPs (EIPs).
You specify the service using its prefix list name. For more information, see DescribePrefixLists.
To control the routing of traffic between the VPC and the specified service, you can specify one or more route tables. Instances placed in subnets associated with the specified route table thus use the VPC endpoint to access the service. When you specify a route table, a route is automatically added to it with the destination set to the prefix list ID of the service, and the target set to the ID of the endpoint.

Code samples

osc-cli fcu CreateVpcEndpoint --profile "default" \
  --RouteTableId '["string"]' \
  --ServiceName "string" \
  --VpcId "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=CreateVpcEndpoint' \
  --data-urlencode 'RouteTableId.1=string' \
  --data-urlencode 'ServiceName=string' \
  --data-urlencode 'VpcId=string'

Parameters

Parameter Type Required Description
RouteTableId [string] false One or more IDs of route tables to use for the connection.
ServiceName string true The prefix list name corresponding to the service (for example, com.outscale.eu-west-2.oos for OOS).
VpcId string true The ID of the VPC.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreateVpcEndpointResponse

Example responses

200 Response

{
  "requestId": "string",
  "vpcEndpoint": {
    "creationTimestamp": "string",
    "routeTableIdSet": [
      "string"
    ],
    "serviceName": "string",
    "state": "string",
    "vpcEndpointId": "string",
    "vpcId": "string"
  }
}

DeleteVpcEndpoints

GET /DeleteVpcEndpoints

Deletes one or more Virtual Private Cloud (VPC) endpoint.
This action also deletes the corresponding routes added to the route tables you specified for the VPC endpoint.

Code samples

osc-cli fcu DeleteVpcEndpoints --profile "default" \
  --VpcEndpointId '["string"]'


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DeleteVpcEndpoints' \
  --data-urlencode 'VpcEndpointId.1=string'

Parameters

Parameter Type Required Description
VpcEndpointId [string] true One or more IDs of VPC endpoints you want to delete.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeleteVpcEndpointsResponse

Example responses

200 Response

{
  "requestId": "string",
  "unsuccessful": [
    {
      "error": {
        "code": "string",
        "message": "string"
      },
      "resourceId": "string"
    }
  ]
}

DescribeVpcEndpointServices

GET /DescribeVpcEndpointServices

Describes OUTSCALE services available to create VPC endpoints.
For more information, see CreateVpcEndpoint.

Code samples

osc-cli fcu DescribeVpcEndpointServices --profile "default" \
  --DryRun False \
  --MaxResults 0 \
  --NextToken "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeVpcEndpointServices' \
  --data-urlencode 'DryRun=false' \
  --data-urlencode 'MaxResults=0' \
  --data-urlencode 'NextToken=string'

Parameters

Parameter Type Required Description
DryRun boolean false If set to true, checks whether you have the required permissions to perform the action.
MaxResults integer false The maximum number of results that can be returned in a single page. You can use the NextToken attribute to request the next results pages. This value is between 5 and 1000. If you provide a value larger than 1000, only 1000 results are returned.
NextToken string false The token to request the next results page.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DescribeVpcEndpointServicesResponse

Example responses

200 Response

{
  "nextToken": "string",
  "requestId": "string",
  "serviceNameSet": [
    "string"
  ]
}

DescribeVpcEndpoints

GET /DescribeVpcEndpoints

Describes one or more Virtual Private Cloud (VPC) endpoints.
You can use the Filter.N parameter to filter the VPCs on the following properties:

Code samples

osc-cli fcu DescribeVpcEndpoints --profile "default" \
  --Filter '[ \
      { \
        "Name": "string", \
        "Value": ["string"] \
      } \
    ]' \
  --VpcEndpointId '["string"]'


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeVpcEndpoints' \
  --data-urlencode 'Filter.1.Name=string' \
  --data-urlencode 'Filter.1.Value.1=string' \
  --data-urlencode 'VpcEndpointId.1=string'

Parameters

Parameter Type Required Description
Filter [Filter] false One or more filters.
Example:
osc-cli fcu DescribeVpcEndpoints \
  --Filter.1.Name "vpc-endpoint-id" \
  --Filter.1.Value.1 "vpce-12345678"
» Name string false The name of the filter.
» Value [string] false One or more filter values.
VpcEndpointId [string] false One or more IDs of VPC endpoints.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DescribeVpcEndpointsResponse

Example responses

200 Response

{
  "requestId": "string",
  "vpcEndpointSet": [
    {
      "creationTimestamp": "string",
      "routeTableIdSet": [
        "string"
      ],
      "serviceName": "string",
      "state": "string",
      "vpcEndpointId": "string",
      "vpcId": "string"
    }
  ]
}

ModifyVpcEndpoint

GET /ModifyVpcEndpoint

Modifies the attributes of a Virtual Private Cloud (VPC) endpoint.
This action enables you to add or remove route tables associated with the specified VPC endpoint.

Code samples

osc-cli fcu ModifyVpcEndpoint --profile "default" \
  --AddRouteTableId '["string"]' \
  --RemoveRouteTableId '["string"]' \
  --VpcEndpointId "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=ModifyVpcEndpoint' \
  --data-urlencode 'AddRouteTableId.1=string' \
  --data-urlencode 'RemoveRouteTableId.1=string' \
  --data-urlencode 'VpcEndpointId=string'

Parameters

Parameter Type Required Description
AddRouteTableId [string] false One or more IDs of route tables to associate with the specified VPC endpoint.
RemoveRouteTableId [string] false One or more IDs of route tables to dissasociate from the specified VPC endpoint.
VpcEndpointId string true The ID of the VPC endpoint.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ModifyVpcEndpointResponse

Example responses

200 Response

{
  "requestId": "string",
  "return": true
}

VPN Connections

CreateVpnConnection

GET /CreateVpnConnection

Creates a VPN connection between a specified virtual private gateway and a specified customer gateway.
You can create only one VPN connection between a virtual private gateway and a customer gateway.

Code samples

osc-cli fcu CreateVpnConnection --profile "default" \
  --CustomerGatewayId "string" \
  --DryRun False \
  --Options '{ \
      "StaticRoutesOnly": True \
    }' \
  --Type "string" \
  --VpnGatewayId "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=CreateVpnConnection' \
  --data-urlencode 'CustomerGatewayId=string' \
  --data-urlencode 'DryRun=false' \
  --data-urlencode 'Options.StaticRoutesOnly=true' \
  --data-urlencode 'Type=string' \
  --data-urlencode 'VpnGatewayId=string'

Parameters

Parameter Type Required Description
CustomerGatewayId string true The ID of the customer gateway.
DryRun boolean false If set to true, checks whether you have the required permissions to perform the action.
Options Options_0 false Options for a VPN connection.
» StaticRoutesOnly boolean false If set to false, the VPN connection uses dynamic routing with Border Gateway Protocol (BGP). If set to true, routing is controlled using static routes. For more information about how to create and delete static routes, see CreateVpnConnectionRoute and DeleteVpnConnectionRoute.
Type string true The type of VPN connection (only ipsec.1 is supported).
VpnGatewayId string true The ID of the virtual private gateway.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreateVpnConnectionResponse

Example responses

200 Response

{
  "requestId": "string",
  "vpnConnection": {
    "customerGatewayConfiguration": "string",
    "customerGatewayId": "string",
    "options": {
      "staticRoutesOnly": true
    },
    "routes": [
      {
        "destinationCidrBlock": "string",
        "source": "string",
        "state": "string"
      }
    ],
    "state": "string",
    "tagSet": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "type": "string",
    "vgwTelemetry": [
      {
        "acceptedRouteCount": 0,
        "lastStatusChange": "string",
        "outsideIpAddress": "string",
        "status": "string",
        "statusMessage": "string"
      }
    ],
    "vpnConnectionId": "string",
    "vpnGatewayId": "string"
  }
}

CreateVpnConnectionRoute

GET /CreateVpnConnectionRoute

Creates a static route to a VPN connection.
This enables you to select the network flows sent by the virtual private gateway to the target VPN connection.

Code samples

osc-cli fcu CreateVpnConnectionRoute --profile "default" \
  --DestinationCidrBlock "string" \
  --DryRun False \
  --VpnConnectionId "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=CreateVpnConnectionRoute' \
  --data-urlencode 'DestinationCidrBlock=string' \
  --data-urlencode 'DryRun=false' \
  --data-urlencode 'VpnConnectionId=string'

Parameters

Parameter Type Required Description
DestinationCidrBlock string true The network prefix of the route, in CIDR notation (for example, 10.12.0.0/16).
DryRun boolean false If set to true, checks whether you have the required permissions to perform the action.
VpnConnectionId string true The ID of target VPN connection of the static route.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreateVpnConnectionRouteResponse

Example responses

200 Response

{
  "requestId": "string",
  "return": true
}

DeleteVpnConnection

GET /DeleteVpnConnection

Deletes a specified VPN connection.
If you want to delete a VPC and all its dependencies, we recommand to detach the virtual private gateway from the VPC and delete the VPC before deleting the VPN connection. This enables you to delete the VPC without waiting for the VPN connection to be deleted.

Code samples

osc-cli fcu DeleteVpnConnection --profile "default" \
  --DryRun False \
  --VpnConnectionId "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DeleteVpnConnection' \
  --data-urlencode 'DryRun=false' \
  --data-urlencode 'VpnConnectionId=string'

Parameters

Parameter Type Required Description
DryRun boolean false If set to true, checks whether you have the required permissions to perform the action.
VpnConnectionId string true The ID of the VPN connection you want to delete.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeleteVpnConnectionResponse

Example responses

200 Response

{
  "requestId": "string",
  "return": true
}

DeleteVpnConnectionRoute

GET /DeleteVpnConnectionRoute

Deletes a static route to a VPN connection previously created using the CreateVpnConnectionRoute method.

Code samples

osc-cli fcu DeleteVpnConnectionRoute --profile "default" \
  --DestinationCidrBlock "string" \
  --DryRun False \
  --VpnConnectionId "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DeleteVpnConnectionRoute' \
  --data-urlencode 'DestinationCidrBlock=string' \
  --data-urlencode 'DryRun=false' \
  --data-urlencode 'VpnConnectionId=string'

Parameters

Parameter Type Required Description
DestinationCidrBlock string true The network prefix of the route to delete, in CIDR notation (for example, 10.12.0.0/16).
DryRun boolean false If set to true, checks whether you have the required permissions to perform the action.
VpnConnectionId string true The ID of the target VPN connection of the static route to delete.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeleteVpnConnectionRouteResponse

Example responses

200 Response

{
  "requestId": "string",
  "return": true
}

DescribeVpnConnections

GET /DescribeVpnConnections

Describes one or more VPN connections.
You can use the Filter.N parameter to filter the VPN connections on the following properties:

Code samples

osc-cli fcu DescribeVpnConnections --profile "default" \
  --DryRun False \
  --Filter '[ \
      { \
        "Name": "string", \
        "Value": ["string"] \
      } \
    ]' \
  --VpnConnectionId '["string"]'


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeVpnConnections' \
  --data-urlencode 'DryRun=false' \
  --data-urlencode 'Filter.1.Name=string' \
  --data-urlencode 'Filter.1.Value.1=string' \
  --data-urlencode 'VpnConnectionId.1=string'

Parameters

Parameter Type Required Description
DryRun boolean false If set to true, checks whether you have the required permissions to perform the action.
Filter [Filter] false One or more filters.
Example:
osc-cli fcu DescribeVpnConnections \
  --Filter.1.Name "tag:KEYOFTHETAG" \
  --Filter.1.Value.1 "VALUEOFTHETAG"
» Name string false The name of the filter.
» Value [string] false One or more filter values.
VpnConnectionId [string] false One or more VPN connections IDs.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DescribeVpnConnectionsResponse

Example responses

200 Response

{
  "requestId": "string",
  "vpnConnectionSet": [
    {
      "customerGatewayConfiguration": "string",
      "customerGatewayId": "string",
      "options": {
        "staticRoutesOnly": true
      },
      "routes": [
        {
          "destinationCidrBlock": "string",
          "source": "string",
          "state": "string"
        }
      ],
      "state": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "type": "string",
      "vgwTelemetry": [
        {
          "acceptedRouteCount": 0,
          "lastStatusChange": "string",
          "outsideIpAddress": "string",
          "status": "string",
          "statusMessage": "string"
        }
      ],
      "vpnConnectionId": "string",
      "vpnGatewayId": "string"
    }
  ]
}

Virtual Private Gateways

AttachVpnGateway

GET /AttachVpnGateway

Attaches a virtual private gateway to a VPC.

Code samples

osc-cli fcu AttachVpnGateway --profile "default" \
  --DryRun False \
  --VpcId "string" \
  --VpnGatewayId "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=AttachVpnGateway' \
  --data-urlencode 'DryRun=false' \
  --data-urlencode 'VpcId=string' \
  --data-urlencode 'VpnGatewayId=string'

Parameters

Parameter Type Required Description
DryRun boolean false If set to true, checks whether you have the required permissions to perform the action.
VpcId string true The ID of the VPC.
VpnGatewayId string true The ID of the virtual private gateway.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). AttachVpnGatewayResponse

Example responses

200 Response

{
  "attachment": {
    "state": "string",
    "vpcId": "string"
  },
  "requestId": "string"
}

CreateVpnGateway

GET /CreateVpnGateway

Creates a virtual private gateway.
A virtual private gateway is the endpoint on the VPC side of a VPN connection.

Code samples

osc-cli fcu CreateVpnGateway --profile "default" \
  --DryRun False \
  --Type "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=CreateVpnGateway' \
  --data-urlencode 'DryRun=false' \
  --data-urlencode 'Type=string'

Parameters

Parameter Type Required Description
DryRun boolean false If set to true, checks whether you have the required permissions to perform the action.
Type string true The type of VPN connection supported by the virtual private gateway (only ipsec.1 is supported).

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreateVpnGatewayResponse

Example responses

200 Response

{
  "requestId": "string",
  "vpnGateway": {
    "attachments": [
      {
        "state": "string",
        "vpcId": "string"
      }
    ],
    "state": "string",
    "tagSet": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "type": "string",
    "vpnGatewayId": "string"
  }
}

DeleteVpnGateway

GET /DeleteVpnGateway

Deletes a specified virtual private gateway.
Before deleting a virtual private gateway, we recommand to detach it from the VPC and delete the VPN connection.

Code samples

osc-cli fcu DeleteVpnGateway --profile "default" \
  --DryRun False \
  --VpnGatewayId "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DeleteVpnGateway' \
  --data-urlencode 'DryRun=false' \
  --data-urlencode 'VpnGatewayId=string'

Parameters

Parameter Type Required Description
DryRun boolean false If set to true, checks whether you have the required permissions to perform the action.
VpnGatewayId string true The ID of the virtual private gateway.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeleteVpnGatewayResponse

Example responses

200 Response

{
  "requestId": "string",
  "return": true
}

DescribeVpnGateways

GET /DescribeVpnGateways

Describes one or more virtual private gateways.
You can use the Filter.N parameter to filter the virtual private gateways on the following properties:

Code samples

osc-cli fcu DescribeVpnGateways --profile "default" \
  --DryRun False \
  --Filter '[ \
      { \
        "Name": "string", \
        "Value": ["string"] \
      } \
    ]' \
  --VpnGatewayId '["string"]'


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeVpnGateways' \
  --data-urlencode 'DryRun=false' \
  --data-urlencode 'Filter.1.Name=string' \
  --data-urlencode 'Filter.1.Value.1=string' \
  --data-urlencode 'VpnGatewayId.1=string'

Parameters

Parameter Type Required Description
DryRun boolean false If set to true, checks whether you have the required permissions to perform the action.
Filter [Filter] false One or more filters.
Example:
osc-cli fcu DescribeVpnGateways \
  --Filter.1.Name "tag:KEYOFTHETAG" \
  --Filter.1.Value.1 "VALUEOFTHETAG"
» Name string false The name of the filter.
» Value [string] false One or more filter values.
VpnGatewayId [string] false One or more virtual private gateways.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DescribeVpnGatewaysResponse

Example responses

200 Response

{
  "requestId": "string",
  "vpnGatewaySet": [
    {
      "attachments": [],
      "state": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "type": "string",
      "vpnGatewayId": "string"
    }
  ]
}

DetachVpnGateway

GET /DetachVpnGateway

Detaches a virtual private gateway from a VPC.
You must wait until the virtual private gateway is in the detached state before you can attach another VPC to it or delete the VPC it was previously attached to.

Code samples

osc-cli fcu DetachVpnGateway --profile "default" \
  --DryRun False \
  --VpcId "string" \
  --VpnGatewayId "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DetachVpnGateway' \
  --data-urlencode 'DryRun=false' \
  --data-urlencode 'VpcId=string' \
  --data-urlencode 'VpnGatewayId=string'

Parameters

Parameter Type Required Description
DryRun boolean false If set to true, checks whether you have the required permissions to perform the action.
VpcId string true The ID of the VPC.
VpnGatewayId string true The ID of the virtual private gateway.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DetachVpnGatewayResponse

Example responses

200 Response

{
  "requestId": "string",
  "return": true
}

DisableVgwRoutePropagation

GET /DisableVgwRoutePropagation

Disables a virtual private gateway from propagating routes to a specified route table of a VPC.

Code samples

osc-cli fcu DisableVgwRoutePropagation --profile "default" \
  --GatewayId "string" \
  --RouteTableId "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DisableVgwRoutePropagation' \
  --data-urlencode 'GatewayId=string' \
  --data-urlencode 'RouteTableId=string'

Parameters

Parameter Type Required Description
GatewayId string true The ID of the virtual private gateway.
RouteTableId string true The ID of the route table.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DisableVgwRoutePropagationResponse

Example responses

200 Response

{
  "requestId": "string",
  "return": true
}

EnableVgwRoutePropagation

GET /EnableVgwRoutePropagation

Enables a virtual private gateway to propagate routes to a specified route table of a VPC.

Code samples

osc-cli fcu EnableVgwRoutePropagation --profile "default" \
  --GatewayId "string" \
  --RouteTableId "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=EnableVgwRoutePropagation' \
  --data-urlencode 'GatewayId=string' \
  --data-urlencode 'RouteTableId=string'

Parameters

Parameter Type Required Description
GatewayId string true The ID of the virtual private gateway.
RouteTableId string true The ID of the route table.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). EnableVgwRoutePropagationResponse

Example responses

200 Response

{
  "requestId": "string",
  "return": true
}

Volumes

AttachVolume

GET /AttachVolume

Attaches a BSU volume to an instance.
The volume and the instance must be in the same Availability Zone. The instance can be running or stopped. The volume is attached to the specified instance device.

Code samples

osc-cli fcu AttachVolume --profile "default" \
  --Device "string" \
  --DryRun False \
  --InstanceId "string" \
  --VolumeId "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=AttachVolume' \
  --data-urlencode 'Device=string' \
  --data-urlencode 'DryRun=false' \
  --data-urlencode 'InstanceId=string' \
  --data-urlencode 'VolumeId=string'

Parameters

Parameter Type Required Description
Device string true The instance device name. For a root device, you must use /dev/sda1. For other volumes, you must use /dev/sdX, /dev/sdXX, /dev/xvdX, or /dev/xvdXX (where the first X is a letter between b and z, and the second X is a letter between a and z).
DryRun boolean false If set to true, checks whether you have the required permissions to perform the action.
InstanceId string true The ID of the instance you want to attach the volume to.
VolumeId string true The ID of the volume you want to attach.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). AttachVolumeResponse

Example responses

200 Response

{
  "attachTime": "string",
  "deleteOnTermination": true,
  "device": "string",
  "instanceId": "string",
  "requestId": "string",
  "status": "string",
  "volumeId": "string"
}

CreateVolume

GET /CreateVolume

Creates a BSU volume in a specified Region.
BSU volumes can be attached to an instance in the same Availability Zone. You can create an empty volume or restore a volume from an existing snapshot.
You can create the following volume types: Enterprise (io1) for provisioned IOPS SSD volumes, Performance (gp2) for general purpose SSD volumes, or Magnetic (standard) volumes.

Code samples

osc-cli fcu CreateVolume --profile "default" \
  --AvailabilityZone "string" \
  --DryRun False \
  --Iops 0 \
  --Size 0 \
  --SnapshotId "string" \
  --VolumeType "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=CreateVolume' \
  --data-urlencode 'AvailabilityZone=string' \
  --data-urlencode 'DryRun=false' \
  --data-urlencode 'Iops=0' \
  --data-urlencode 'Size=0' \
  --data-urlencode 'SnapshotId=string' \
  --data-urlencode 'VolumeType=string'

Parameters

Parameter Type Required Description
AvailabilityZone string true The Availability Zone in which you want to create the volume.
DryRun boolean false If set to true, checks whether you have the required permissions to perform the action.
Iops integer false The number of I/O operations per second (only for io1 volumes). The maximum number of IOPS allowed for io1 volumes is 13000 with a maximum performance ratio of 300 IOPS per gibibyte.
Size integer false The size of the volume, in gibibytes (GiB). The maximum allowed size for a volume is 14901 GiB. This parameter is required if the volume is not created from a snapshot (SnapshotId unspecified).
SnapshotId string false The ID of the snapshot from which you want to create the volume.
VolumeType string false The type of volume you want to create (io1 | gp2 | standard). If not specified, a standard volume is created. For more information about volumes types, see Volume Types and IOPS.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreateVolumeResponse

Example responses

200 Response

{
  "availabilityZone": "string",
  "createTime": "string",
  "iops": 0,
  "requestId": "string",
  "size": 0,
  "snapshotId": "string",
  "status": "string",
  "tagSet": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "volumeId": "string",
  "volumeType": "string"
}

DeleteVolume

GET /DeleteVolume

Deletes a specified BSU volume.
You can delete available volumes only, that is, volumes that are not attached to an instance.

Code samples

osc-cli fcu DeleteVolume --profile "default" \
  --DryRun False \
  --VolumeId "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DeleteVolume' \
  --data-urlencode 'DryRun=false' \
  --data-urlencode 'VolumeId=string'

Parameters

Parameter Type Required Description
DryRun boolean false If set to true, checks whether you have the required permissions to perform the action.
VolumeId string true The ID of the volume.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeleteVolumeResponse

Example responses

200 Response

{
  "requestId": "string",
  "return": true
}

DescribeVolumes

GET /DescribeVolumes

Describes one or more specified Block Storage Unit (BSU) volume.
You can use the Filter.N parameter to filter the described volumes on the following properties:

Code samples

osc-cli fcu DescribeVolumes --profile "default" \
  --Filter '[ \
      { \
        "Name": "string", \
        "Value": ["string"] \
      } \
    ]' \
  --MaxResults 0 \
  --NextToken "string" \
  --VolumeId '["string"]'


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeVolumes' \
  --data-urlencode 'Filter.1.Name=string' \
  --data-urlencode 'Filter.1.Value.1=string' \
  --data-urlencode 'MaxResults=0' \
  --data-urlencode 'NextToken=string' \
  --data-urlencode 'VolumeId.1=string'

Parameters

Parameter Type Required Description
Filter [Filter] false One or more filters.
Example:
osc-cli fcu DescribeVolumes \
  --Filter.1.Name "tag:KEYOFTHETAG" \
  --Filter.1.Value.1 "VALUEOFTHETAG"
» Name string false The name of the filter.
» Value [string] false One or more filter values.
MaxResults integer false The maximum number of results that can be returned in a single page. You can use the NextToken attribute to request the next results pages. This value is between 5 and 1000. If you provide a value larger than 1000, only 1000 results are returned.
NextToken string false The token to request the next results page.
VolumeId [string] false One or more volume IDs.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DescribeVolumesResponse

Example responses

200 Response

{
  "nextToken": "string",
  "requestId": "string",
  "volumeSet": [
    {
      "attachmentSet": [
        {
          "attachTime": "string",
          "deleteOnTermination": true,
          "device": "string",
          "instanceId": "string",
          "status": "string",
          "volumeId": "string"
        }
      ],
      "availabilityZone": "string",
      "createTime": "string",
      "iops": 0,
      "size": 0,
      "snapshotId": "string",
      "status": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "volumeId": "string",
      "volumeType": "string"
    }
  ]
}

DetachVolume

GET /DetachVolume

Detaches a BSU volume from an instance.
To detach the root device of an instance, this instance must be stopped.

Code samples

osc-cli fcu DetachVolume --profile "default" \
  --Device "string" \
  --DryRun False \
  --Force True \
  --InstanceId "string" \
  --VolumeId "string"


# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DetachVolume' \
  --data-urlencode 'Device=string' \
  --data-urlencode 'DryRun=false' \
  --data-urlencode 'Force=true' \
  --data-urlencode 'InstanceId=string' \
  --data-urlencode 'VolumeId=string'

Parameters

Parameter Type Required Description
Device string false The name of the device.
DryRun boolean false If set to true, checks whether you have the required permissions to perform the action.
Force boolean false Forces the detachment of the volume in case of previous failure (this action may damage your data or file systems).
InstanceId string false The ID of the instance.
VolumeId string true The ID of the volume.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DetachVolumeResponse

Example responses

200 Response

{
  "attachTime": "string",
  "deleteOnTermination": true,
  "device": "string",
  "instanceId": "string",
  "requestId": "string",
  "status": "string",
  "volumeId": "string"
}

Schemas

AcceptVpcPeeringConnectionResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
vpcPeeringConnection vpcPeeringConnection false none Information about the created VPC peering connection.

Schema

{
  "requestId": "string",
  "vpcPeeringConnection": {
    "accepterVpcInfo": {
      "cidrBlock": "string",
      "ownerId": "string",
      "vpcId": "string"
    },
    "expirationTime": "string",
    "requesterVpcInfo": {
      "cidrBlock": "string",
      "ownerId": "string",
      "vpcId": "string"
    },
    "status": {
      "code": "string",
      "message": "string"
    },
    "tagSet": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "vpcPeeringConnectionId": "string"
  }
}

Add

The account ID you want to add to the list of permissions for the volume.

Properties

Name Type Required Restrictions Description
Group string false none The name of the group (all if public).
UserId string false none The account ID of the user.

Schema

{
  "Group": "string",
  "UserId": "string"
}

AllocateAddressResponse

Properties

Name Type Required Restrictions Description
allocationId string false none The ID that represents the allocation of the EIP for use with instances in a VPC.
domain string false none The type of platform in which you can use the EIP.
publicIp string false none The EIP.
requestId string false none The ID of the request.

Schema

{
  "allocationId": "string",
  "domain": "string",
  "publicIp": "string",
  "requestId": "string"
}

AssignPrivateIpAddressesResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
return boolean false none If true, the private IP is assigned. Otherwise, you receive an error.

Schema

{
  "requestId": "string",
  "return": true
}

AssociateAddressResponse

Properties

Name Type Required Restrictions Description
associationId string false none (VPC only) The ID that represents the association of the EIP with the instance or the network interface.
requestId string false none The ID of the request.
return boolean false none If true, the request succeeds. Otherwise, an error is returned.

Schema

{
  "associationId": "string",
  "requestId": "string",
  "return": true
}

AssociateDhcpOptionsResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
return boolean false none If true, the request succeeds. Otherwise, an error is returned.

Schema

{
  "requestId": "string",
  "return": true
}

AssociateRouteTableResponse

Properties

Name Type Required Restrictions Description
associationId string false none The ID of the route table association.
requestId string false none The ID of the request.

Schema

{
  "associationId": "string",
  "requestId": "string"
}

AttachInternetGatewayResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
return boolean false none If true, the request succeeds. Otherwise, an error is returned.

Schema

{
  "requestId": "string",
  "return": true
}

AttachNetworkInterfaceResponse

Properties

Name Type Required Restrictions Description
attachmentId string false none The ID of the attachment operation.
requestId string false none The ID of the request.

Schema

{
  "attachmentId": "string",
  "requestId": "string"
}

AttachVolumeResponse

Properties

Name Type Required Restrictions Description
attachTime string false none The time at which the attachment was initiated.
deleteOnTermination boolean false none If true, the volume is deleted when terminating the instance. If false, the volume is not deleted when terminating the instance.
device string false none The instance device name.
instanceId string false none The ID of the instance the volume is attached to.
requestId string false none The ID of the request.
status string false none The attachment state of the volume (attaching | detaching | attached | detached).
volumeId string false none The ID of the attached volume.

Schema

{
  "attachTime": "string",
  "deleteOnTermination": true,
  "device": "string",
  "instanceId": "string",
  "requestId": "string",
  "status": "string",
  "volumeId": "string"
}

AttachVpnGatewayResponse

Properties

Name Type Required Restrictions Description
attachment attachment_0 false none Information about the attachment.
requestId string false none The ID of the request.

Schema

{
  "attachment": {
    "state": "string",
    "vpcId": "string"
  },
  "requestId": "string"
}

Attachment

A new configuration for the attachment.

Properties

Name Type Required Restrictions Description
AttachmentId string false none The ID of the FNI attachment.
DeleteOnTermination boolean false none By default or if set to false, the FNI is detached from the instance when the instance is terminated. If true, the FNI is deleted.

Schema

{
  "AttachmentId": "string",
  "DeleteOnTermination": true
}

AuthorizeSecurityGroupEgressResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
return boolean false none If true, the request succeeds. Otherwise, an error is returned.

Schema

{
  "requestId": "string",
  "return": true
}

AuthorizeSecurityGroupIngressResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
return boolean false none If true, the request succeeds. Otherwise, an error is returned.

Schema

{
  "requestId": "string",
  "return": true
}

BlockDeviceMapping_0

The block device mapping of the instance. This parameter modifies the DeleteOnTermination attribute for volumes attached to the instance.

Properties

Name Type Required Restrictions Description
DeviceName string false none The device name for the volume. For a root device, you must use /dev/sda1. For other volumes, you must use /dev/sdX, /dev/sdXX, /dev/xvdX, or /dev/xvdXX (where the first X is a letter between b and z, and the second X is a letter between a and z).
Ebs Ebs_1 false none One or more parameters used to automatically set up volumes when you launch the instance.
NoDevice string false none Removes the specified device included in the block device mapping.
VirtualName string false none The name of the virtual device.

Schema

{
  "DeviceName": "string",
  "Ebs": {
    "DeleteOnTermination": true,
    "VolumeId": "string"
  },
  "NoDevice": "string",
  "VirtualName": "string"
}

BlockDeviceMapping_1

One or more block device mappings of the instance.

Properties

Name Type Required Restrictions Description
DeviceName string false none The device name for the volume. For a root device, you must use /dev/sda1. For other volumes, you must use /dev/sdX, /dev/sdXX, /dev/xvdX, or /dev/xvdXX (where the first X is a letter between b and z, and the second X is a letter between a and z).
Ebs Ebs_0 false none One or more parameters to map a volume to DeviceName at launch. You can specify either Ebs or VirtualName, but not both.
NoDevice string false none Prevents a device from being mapped to DeviceName at launch, if the OMI used contains a mapping for DeviceName.
To use this parameter, specify any value other than null, for example an empty string. Example with OSC CLI:
  --BlockDeviceMapping.1.DeviceName "/dev/xvdb" \
  --BlockDeviceMapping.1.NoDevice ""
VirtualName string false none The name of an ephemeral storage disk (ephemeralN) to map to DeviceName at launch.
You can specify either Ebs or VirtualName, but not both.

Schema

{
  "DeviceName": "string",
  "Ebs": {
    "DeleteOnTermination": true,
    "Iops": 0,
    "SnapshotId": "string",
    "VolumeSize": 0,
    "VolumeType": "string"
  },
  "NoDevice": "string",
  "VirtualName": "string"
}

BlockDeviceMapping_2

One or more entries of block device mapping.

Properties

Name Type Required Restrictions Description
deviceName string false none The name of the device.
ebs Ebs_2 false none One or more parameters used to automatically set up volumes when you launch the instance.
noDevice string false none Prevents a device from being mapped to DeviceName at launch, if the OMI used contains a mapping for DeviceName.
To use this parameter, specify any value other than null, for example an empty string. Example with OSC CLI:
  --BlockDeviceMapping.1.DeviceName "/dev/xvdb" \
  --BlockDeviceMapping.1.NoDevice ""
virtualName string false none The name of an ephemeral storage disk (ephemeralN) to map to DeviceName at launch.
You can specify either Ebs or VirtualName, but not both.

Schema

{
  "deviceName": "string",
  "ebs": {
    "deleteOnTermination": true,
    "iops": 0,
    "snapshotId": "string",
    "volumeSize": 0,
    "volumeType": "string"
  },
  "noDevice": "string",
  "virtualName": "string"
}

BlockDeviceMapping_3

One or more entries of block device mapping.

Properties

Name Type Required Restrictions Description
deviceName string false none The name of the instance device name.
ebs ebs false none One or more parameters used to automatically set up volumes when the instance is launched.

Schema

{
  "deviceName": "string",
  "ebs": {
    "attachTime": "string",
    "deleteOnTermination": true,
    "status": "string",
    "volumeId": "string"
  }
}

CancelExportTaskResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
return boolean false none If true, the export task has been canceled.

Schema

{
  "requestId": "string",
  "return": true
}

CopyImageResponse

Properties

Name Type Required Restrictions Description
imageId string false none The ID of the new OMI.
requestId string false none The ID of the request.

Schema

{
  "imageId": "string",
  "requestId": "string"
}

CopySnapshotResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
snapshotId string false none The ID of the new snapshot.

Schema

{
  "requestId": "string",
  "snapshotId": "string"
}

CreateCustomerGatewayResponse

Properties

Name Type Required Restrictions Description
customerGateway customerGateway false none Information about the newly created customer gateway.
requestId string false none The ID of the request.

Schema

{
  "customerGateway": {
    "bgpAsn": 0,
    "customerGatewayId": "string",
    "ipAddress": "string",
    "state": "string",
    "tagSet": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "type": "string"
  },
  "requestId": "string"
}

CreateDhcpOptionsResponse

Properties

Name Type Required Restrictions Description
dhcpOptions dhcpOptions false none A set of DHCP options.
requestId string false none The ID of the request.

Schema

{
  "dhcpOptions": {
    "dhcpConfigurationSet": [
      {
        "key": "string",
        "valueSet": [
          {
            "value": "string"
          }
        ]
      }
    ],
    "dhcpOptionsId": "string",
    "tagSet": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  },
  "requestId": "string"
}

CreateImageExportTaskResponse

Properties

Name Type Required Restrictions Description
imageExportTask imageExportTask false none Information about one or more image export tasks.
requestId string false none The ID of the request.

Schema

{
  "imageExportTask": {
    "exportToOsu": {
      "diskImageFormat": "string",
      "osuAkSk": {
        "AccessKey": "string",
        "SecretKey": "string"
      },
      "osuBucket": "string",
      "osuManifestUrl": "string",
      "osuPrefix": "string"
    },
    "imageExport": {
      "imageId": "string"
    },
    "imageExportTaskId": "string",
    "state": "string",
    "statusMessage": "string",
    "tagSet": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  },
  "requestId": "string"
}

CreateImageResponse

Properties

Name Type Required Restrictions Description
imageId string false none The ID of the new OMI.
requestId string false none The ID of the request.

Schema

{
  "imageId": "string",
  "requestId": "string"
}

CreateInternetGatewayResponse

Properties

Name Type Required Restrictions Description
internetGateway internetGateway false none Information about the newly created Internet gateway.
requestId string false none The ID of the request.

Schema

{
  "internetGateway": {
    "attachmentSet": [
      {
        "state": "string",
        "vpcId": "string"
      }
    ],
    "internetGatewayId": "string",
    "tagSet": [
      {
        "Key": "string",
        "Value": "string"
      }
    ]
  },
  "requestId": "string"
}

CreateKeyPairResponse

Properties

Name Type Required Restrictions Description
keyFingerprint string false none The MD5 public key fingerprint as specified in section 4 of RFC 4716.
keyMaterial string false none The private key. When saving the private key in a .rsa file, replace the \n escape sequences with line breaks.
keyName string false none A unique name for the keypair.
requestId string false none The ID of the request.

Schema

{
  "keyFingerprint": "string",
  "keyMaterial": "string",
  "keyName": "string",
  "requestId": "string"
}

CreateNatGatewayResponse

Properties

Name Type Required Restrictions Description
clientToken string false none A unique identifier to manage the idempotency.
natGateway natGateway false none Information about the newly created NAT gateway.
requestId string false none The ID of the request.

Schema

{
  "clientToken": "string",
  "natGateway": {
    "createTime": "string",
    "deleteTime": "string",
    "natGatewayAddressSet": [
      {
        "allocationId": "string",
        "networkInterfaceId": "string",
        "privateIp": "string",
        "publicIp": "string"
      }
    ],
    "natGatewayId": "string",
    "state": "string",
    "subnetId": "string",
    "tagSet": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "vpcId": "string"
  },
  "requestId": "string"
}

CreateNetworkInterfaceResponse

Properties

Name Type Required Restrictions Description
networkInterface NetworkInterface_1 false none Information about the newly created FNI.
requestId string false none The ID of the request.

Schema

{
  "networkInterface": {
    "association": {
      "allocationId": "string",
      "associationId": "string",
      "ipOwnerId": "string",
      "publicDnsName": "string",
      "publicIp": "string"
    },
    "attachment": {
      "attachTime": "string",
      "attachmentId": "string",
      "deleteOnTermination": true,
      "deviceIndex": 0,
      "instanceId": "string",
      "instanceOwnerId": "string",
      "status": "string"
    },
    "availabilityZone": "string",
    "description": "string",
    "groupSet": [
      {
        "groupId": "string",
        "groupName": "string"
      }
    ],
    "macAddress": "string",
    "networkInterfaceId": "string",
    "ownerId": "string",
    "privateDnsName": "string",
    "privateIpAddress": "string",
    "privateIpAddressesSet": [
      {
        "association": {
          "allocationId": "string",
          "associationId": "string",
          "ipOwnerId": "string",
          "publicDnsName": "string",
          "publicIp": "string"
        },
        "primary": true,
        "privateDnsName": "string",
        "privateIpAddress": "string"
      }
    ],
    "sourceDestCheck": true,
    "status": "string",
    "subnetId": "string",
    "tagSet": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "vpcId": "string"
  },
  "requestId": "string"
}

CreateRouteResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
return boolean false none If true, the request succeeded. Otherwise, an error is returned.

Schema

{
  "requestId": "string",
  "return": true
}

CreateRouteTableResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
routeTable routeTable false none Information about the newly created route table.

Schema

{
  "requestId": "string",
  "routeTable": {
    "associationSet": [
      {
        "main": true,
        "routeTableAssociationId": "string",
        "routeTableId": "string",
        "subnetId": "string"
      }
    ],
    "propagatingVgwSet": [
      {
        "gatewayId": "string"
      }
    ],
    "routeSet": [
      {
        "destinationCidrBlock": "string",
        "destinationPrefixListId": "string",
        "gatewayId": "string",
        "instanceId": "string",
        "instanceOwnerId": "string",
        "networkInterfaceId": "string",
        "origin": "string",
        "state": "string",
        "vpcPeeringConnectionId": "string"
      }
    ],
    "routeTableId": "string",
    "tagSet": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "vpcId": "string"
  }
}

CreateSecurityGroupResponse

Properties

Name Type Required Restrictions Description
groupId string false none The ID of the security group.
requestId string false none The ID of the request.
return boolean false none If true, the request succeeds. Otherwise, an error is returned.

Schema

{
  "groupId": "string",
  "requestId": "string",
  "return": true
}

CreateSnapshotExportTaskResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
snapshotExportTask snapshotExportTask false none Information about one or more snapshot export tasks.

Schema

{
  "requestId": "string",
  "snapshotExportTask": {
    "completion": 0,
    "exportToOsu": {
      "aksk": {
        "AccessKey": "string",
        "SecretKey": "string"
      },
      "diskImageFormat": "string",
      "osuBucket": "string",
      "osuKey": "string",
      "osuPrefix": "string"
    },
    "snapshotExport": {
      "snapshotId": "string"
    },
    "snapshotExportTaskId": "string",
    "state": "string",
    "statusMessage": "string",
    "tagSet": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  }
}

CreateSnapshotResponse

Properties

Name Type Required Restrictions Description
description string false none A description of the snapshot, if provided in the request.
encrypted boolean false none Indicates whether the snapshot is encrypted or not (always false).
ownerId string false none The account ID of the owner of the snapshot.
progress string false none The progress of the snapshot (a percentage).
requestId string false none The ID of the request.
snapshotId string false none The ID of the newly created snapshot.
startTime string false none The time at which the snapshot was initiated.
status string false none The state of the snapshot (in-queue | pending | completed).
tagSet [tagSet_0] false none One or more tags associated with the snapshot.
volumeId string false none The ID of the volume used to create the snapshot.
volumeSize integer false none The size of the volume, in gibibytes (GiB).

Schema

{
  "description": "string",
  "encrypted": true,
  "ownerId": "string",
  "progress": "string",
  "requestId": "string",
  "snapshotId": "string",
  "startTime": "string",
  "status": "string",
  "tagSet": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "volumeId": "string",
  "volumeSize": 0
}

CreateSubnetResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
subnet subnet false none Information about the newly created subnet.

Schema

{
  "requestId": "string",
  "subnet": {
    "availabilityZone": "string",
    "availableIpAddressCount": 0,
    "cidrBlock": "string",
    "mapPublicIpOnLaunch": true,
    "state": "string",
    "subnetId": "string",
    "tagSet": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "vpcId": "string"
  }
}

CreateTagsResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
return boolean false none If true, the request succeeds. Otherwise, an error is returned.

Schema

{
  "requestId": "string",
  "return": true
}

CreateVolumePermission_0

Enables you to modify the permissions to create a volume for account IDs or groups. If you specify both Add and Remove attributes in the request, only Add is taken into account.

Properties

Name Type Required Restrictions Description
Add [Add] false none The account ID you want to add to the list of permissions for the volume.
Remove [Remove] false none The account ID you want to remove from the list of permissions for the volume.

Schema

{
  "Add": [
    {
      "Group": "string",
      "UserId": "string"
    }
  ],
  "Remove": [
    {
      "Group": "string",
      "UserId": "string"
    }
  ]
}

CreateVolumePermission_1

A list of permissions for creating volumes from the snapshot.

Properties

Name Type Required Restrictions Description
Group string false none The name of the group (all if public).
UserId string false none The account ID of the user.

Schema

{
  "Group": "string",
  "UserId": "string"
}

CreateVolumeResponse

Properties

Name Type Required Restrictions Description
availabilityZone string false none The Availability Zone of the volume.
createTime string false none The time at which the volume was created.
iops integer false none The number of I/O operations per second (only for io1 and gp2 volumes).
requestId string false none The ID of the request.
size integer false none The size of the volume, in GiB.
snapshotId string false none The ID of the snapshot from which the volume was created.
status string false none The state of the volume (always creating when creating a volume).
tagSet [tagSet_0] false none The tags associated with the volume.
volumeId string false none The ID of the newly created volume.
volumeType string false none The type of the volume.

Schema

{
  "availabilityZone": "string",
  "createTime": "string",
  "iops": 0,
  "requestId": "string",
  "size": 0,
  "snapshotId": "string",
  "status": "string",
  "tagSet": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "volumeId": "string",
  "volumeType": "string"
}

CreateVpcEndpointResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
vpcEndpoint vpcEndpoint false none Information about the newly created VPC endpoint.

Schema

{
  "requestId": "string",
  "vpcEndpoint": {
    "creationTimestamp": "string",
    "routeTableIdSet": [
      "string"
    ],
    "serviceName": "string",
    "state": "string",
    "vpcEndpointId": "string",
    "vpcId": "string"
  }
}

CreateVpcPeeringConnectionResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
vpcPeeringConnection vpcPeeringConnection false none Information about the created VPC peering connection.

Schema

{
  "requestId": "string",
  "vpcPeeringConnection": {
    "accepterVpcInfo": {
      "cidrBlock": "string",
      "ownerId": "string",
      "vpcId": "string"
    },
    "expirationTime": "string",
    "requesterVpcInfo": {
      "cidrBlock": "string",
      "ownerId": "string",
      "vpcId": "string"
    },
    "status": {
      "code": "string",
      "message": "string"
    },
    "tagSet": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "vpcPeeringConnectionId": "string"
  }
}

CreateVpcResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
vpc vpc false none Information about the newly created VPC.

Schema

{
  "requestId": "string",
  "vpc": {
    "cidrBlock": "string",
    "dhcpOptionsId": "string",
    "instanceTenancy": "string",
    "isDefault": true,
    "state": "string",
    "tagSet": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "vpcId": "string"
  }
}

CreateVpnConnectionResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
vpnConnection vpnConnection false none Information about the VPN connection.

Schema

{
  "requestId": "string",
  "vpnConnection": {
    "customerGatewayConfiguration": "string",
    "customerGatewayId": "string",
    "options": {
      "staticRoutesOnly": true
    },
    "routes": [
      {
        "destinationCidrBlock": "string",
        "source": "string",
        "state": "string"
      }
    ],
    "state": "string",
    "tagSet": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "type": "string",
    "vgwTelemetry": [
      {
        "acceptedRouteCount": 0,
        "lastStatusChange": "string",
        "outsideIpAddress": "string",
        "status": "string",
        "statusMessage": "string"
      }
    ],
    "vpnConnectionId": "string",
    "vpnGatewayId": "string"
  }
}

CreateVpnConnectionRouteResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
return boolean false none If true, the request succeeds. Otherwise, an error is returned.

Schema

{
  "requestId": "string",
  "return": true
}

CreateVpnGatewayResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
vpnGateway vpnGateway false none Information about the newly created virtual private gateway.

Schema

{
  "requestId": "string",
  "vpnGateway": {
    "attachments": [
      {
        "state": "string",
        "vpcId": "string"
      }
    ],
    "state": "string",
    "tagSet": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "type": "string",
    "vpnGatewayId": "string"
  }
}

DeleteCustomerGatewayResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
return boolean false none If true, the request succeeds. Otherwise, an error is returned.

Schema

{
  "requestId": "string",
  "return": true
}

DeleteDhcpOptionsResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
return boolean false none If true, the request succeeds. Otherwise, an error is returned.

Schema

{
  "requestId": "string",
  "return": true
}

DeleteInternetGatewayResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
return boolean false none If true, the request succeeds. Otherwise, an error is returned.

Schema

{
  "requestId": "string",
  "return": true
}

DeleteKeyPairResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
return boolean false none If true, the request succeeds. Otherwise, an error is returned.

Schema

{
  "requestId": "string",
  "return": true
}

DeleteNatGatewayResponse

Properties

Name Type Required Restrictions Description
natGatewayId string false none The ID of the deleted NAT gateway.
requestId string false none The ID if the request.

Schema

{
  "natGatewayId": "string",
  "requestId": "string"
}

DeleteNetworkInterfaceResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
return boolean false none If true, the FNI is deleted. Otherwise, you receive an error.

Schema

{
  "requestId": "string",
  "return": true
}

DeleteRouteResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
return boolean false none If true, the request succeeds. Otherwise, an error is returned.

Schema

{
  "requestId": "string",
  "return": true
}

DeleteRouteTableResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
return boolean false none If true, the request succeeds. Otherwise, an error is returned.

Schema

{
  "requestId": "string",
  "return": true
}

DeleteSecurityGroupResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
return boolean false none If true, the request succeeds. Otherwise, an error is returned.

Schema

{
  "requestId": "string",
  "return": true
}

DeleteSnapshotResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
return boolean false none If true, the request succeeds. Otherwise, an error is returned.

Schema

{
  "requestId": "string",
  "return": true
}

DeleteSubnetResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
return boolean false none If true, the request succeeds. Otherwise, an error is returned.

Schema

{
  "requestId": "string",
  "return": true
}

DeleteTagsResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
return boolean false none If true, the request succeeds. Otherwise, an error is returned.

Schema

{
  "requestId": "string",
  "return": true
}

DeleteVolumeResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
return boolean false none If true, the request succeeds. Otherwise, an error is returned.

Schema

{
  "requestId": "string",
  "return": true
}

DeleteVpcEndpointsResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
unsuccessful [unsuccessful] false none Information about one or more unsuccessfully deleted VPC endpoints.

Schema

{
  "requestId": "string",
  "unsuccessful": [
    {
      "error": {
        "code": "string",
        "message": "string"
      },
      "resourceId": "string"
    }
  ]
}

DeleteVpcPeeringConnectionResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
return boolean false none If true, the VPC peering connection is deleted. Otherwise, you receive an error.

Schema

{
  "requestId": "string",
  "return": true
}

DeleteVpcResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
return boolean false none If true, the request succeeds. Otherwise, an error is returned.

Schema

{
  "requestId": "string",
  "return": true
}

DeleteVpnConnectionResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
return boolean false none If true, the request succeeds. Otherwise, an error is returned.

Schema

{
  "requestId": "string",
  "return": true
}

DeleteVpnConnectionRouteResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
return boolean false none If true, the request succeeds. Otherwise, an error is returned.

Schema

{
  "requestId": "string",
  "return": true
}

DeleteVpnGatewayResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
return boolean false none If true, the request succeeds. Otherwise, an error is returned.

Schema

{
  "requestId": "string",
  "return": true
}

DeregisterImageResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
return boolean false none If true, the request succeeds. Otherwise, an error is returned.

Schema

{
  "requestId": "string",
  "return": true
}

DescribeAddressesResponse

Properties

Name Type Required Restrictions Description
addressesSet [addressesSet] false none Information about one or more EIPs.
requestId string false none The ID of the request.

Schema

{
  "addressesSet": [
    {
      "allocationId": "string",
      "associationId": "string",
      "domain": "string",
      "instanceId": "string",
      "networkInterfaceId": "string",
      "networkInterfaceOwnerId": "string",
      "privateIpAddress": "string",
      "publicIp": "string"
    }
  ],
  "requestId": "string"
}

DescribeAvailabilityZonesResponse

Properties

Name Type Required Restrictions Description
availabilityZoneInfo [availabilityZoneInfo] false none Information about the Availability Zones.
requestId string false none The ID of the request.

Schema

{
  "availabilityZoneInfo": [
    {
      "regionName": "string",
      "zoneName": "string",
      "zoneState": "string"
    }
  ],
  "requestId": "string"
}

DescribeCustomerGatewaysResponse

Properties

Name Type Required Restrictions Description
customerGatewaySet [customerGatewaySet] false none One or more customer gateways.
requestId string false none The ID of the request.

Schema

{
  "customerGatewaySet": [
    {
      "bgpAsn": 0,
      "customerGatewayId": "string",
      "ipAddress": "string",
      "state": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "type": "string"
    }
  ],
  "requestId": "string"
}

DescribeDhcpOptionsResponse

Properties

Name Type Required Restrictions Description
dhcpOptionsSet [dhcpOptionsSet] false none One or more DHCP options sets.
requestId string false none The ID of the request.

Schema

{
  "dhcpOptionsSet": [
    {
      "dhcpConfigurationSet": [
        {
          "key": "string",
          "valueSet": [
            {
              "value": "string"
            }
          ]
        }
      ],
      "dhcpOptionsId": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ]
    }
  ],
  "requestId": "string"
}

DescribeImageAttributeResponse

Properties

Name Type Required Restrictions Description
description Description_1 false none The description of the resource.
imageId string false none The ID of the OMI.
launchPermission [launchPermission_1] false none One or more launch permissions.
productCodes [productCodes] false none One or more product codes associated with the OMI.
requestId string false none The ID of the request.

Schema

{
  "description": {
    "value": "string"
  },
  "imageId": "string",
  "launchPermission": [
    {
      "group": "string",
      "userId": "string"
    }
  ],
  "productCodes": [
    {
      "productCode": "string",
      "type": "string"
    }
  ],
  "requestId": "string"
}

DescribeImageExportTasksResponse

Properties

Name Type Required Restrictions Description
imageExportTaskSet [imageExportTask] false none Information about one or more image export tasks.
requestId string false none The ID of the request.

Schema

{
  "imageExportTaskSet": [
    {
      "exportToOsu": {
        "diskImageFormat": "string",
        "osuAkSk": {
          "AccessKey": "string",
          "SecretKey": "string"
        },
        "osuBucket": "string",
        "osuManifestUrl": "string",
        "osuPrefix": "string"
      },
      "imageExport": {
        "imageId": "string"
      },
      "imageExportTaskId": "string",
      "state": "string",
      "statusMessage": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ]
    }
  ],
  "requestId": "string"
}

DescribeImagesResponse

Properties

Name Type Required Restrictions Description
imagesSet [imagesSet] false none Information about one or more OMIs.
requestId string false none The ID of the request.

Schema

{
  "imagesSet": [
    {
      "architecture": "string",
      "blockDeviceMapping": [
        {
          "deviceName": "string",
          "ebs": {
            "deleteOnTermination": true,
            "iops": 0,
            "snapshotId": "string",
            "volumeSize": 0,
            "volumeType": "string"
          },
          "noDevice": "string",
          "virtualName": "string"
        }
      ],
      "description": "string",
      "hypervisor": "string",
      "imageId": "string",
      "imageLocation": "string",
      "imageOwnerAlias": "string",
      "imageOwnerId": "string",
      "imageState": "string",
      "imageType": "string",
      "isPublic": true,
      "name": "string",
      "platform": "string",
      "productCodes": [
        {
          "productCode": "string",
          "type": "string"
        }
      ],
      "rootDeviceName": "string",
      "rootDeviceType": "string",
      "stateReason": {
        "code": "string",
        "message": "string"
      },
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "virtualizationType": "string"
    }
  ],
  "requestId": "string"
}

DescribeInstanceAttributeResponse

Properties

Name Type Required Restrictions Description
blockDeviceMapping [BlockDeviceMapping_3] false none The block device mapping of the instance.
disableApiTermination DisableApiTermination_1 false none If true, you cannot terminate the instance unless you change this parameter back to false.
ebsOptimized EbsOptimized_1 false none This parameter is not available. It is present in our API for the sake of historical compatiblity with AWS.
groupSet [groupSet] false none The security groups associated with the instance.
instanceId string false none The ID of the instance.
instanceInitiatedShutdownBehavior InstanceInitiatedShutdownBehavior_1 false none Indicates whether the instance stops, terminates or restarts when you stop or terminate it.
instanceType InstanceType_1 false none The type of instance. For more information, see Instance Types.
ramdisk ramdisk false none The ID of the RAM disk.
requestId string false none The ID of the request.
rootDeviceName rootDeviceName false none The name of the root device.
sourceDestCheck SourceDestCheck_1 false none (VPC only) If true, the source/destination check is enabled. If false, it is disabled. This value must be false for a NAT instance to perform Network Address Translation (NAT) in a VPC.
userData UserData_1 false none The Base64-encoded MIME user data.

Schema

{
  "blockDeviceMapping": [
    {
      "deviceName": "string",
      "ebs": {
        "attachTime": "string",
        "deleteOnTermination": true,
        "status": "string",
        "volumeId": "string"
      }
    }
  ],
  "disableApiTermination": {
    "value": true
  },
  "ebsOptimized": {
    "value": true
  },
  "groupSet": [
    {
      "groupId": "string",
      "groupName": "string"
    }
  ],
  "instanceId": "string",
  "instanceInitiatedShutdownBehavior": {
    "value": "string"
  },
  "instanceType": {
    "value": "string"
  },
  "ramdisk": {
    "Value": "string"
  },
  "requestId": "string",
  "rootDeviceName": {
    "Value": "string"
  },
  "sourceDestCheck": {
    "value": true
  },
  "userData": {
    "value": "string"
  }
}

DescribeInstanceStatusResponse

Properties

Name Type Required Restrictions Description
instanceStatusSet [instanceStatusSet] false none One or more instance status descriptions.
nextToken string false none The token to request the next results page. If the value is null, there is no results left to be returned.
requestId string false none The ID of the request.

Schema

{
  "instanceStatusSet": [
    {
      "availabilityZone": "string",
      "eventsSet": [
        {
          "code": "string",
          "description": "string",
          "notAfter": "string",
          "notBefore": "string"
        }
      ],
      "instanceId": "string",
      "instanceState": {
        "code": 0,
        "name": "string"
      },
      "instanceStatus": {
        "details": [
          {
            "impairedSince": "string",
            "name": "string",
            "status": "string"
          }
        ],
        "status": "string"
      },
      "systemStatus": {
        "details": [
          {
            "impairedSince": "string",
            "name": "string",
            "status": "string"
          }
        ],
        "status": "string"
      }
    }
  ],
  "nextToken": "string",
  "requestId": "string"
}

DescribeInstanceTypesResponse

Properties

Name Type Required Restrictions Description
instanceTypeSet [instanceTypeSet] false none One or more instance types.
requestId string false none The ID of the request.

Schema

{
  "instanceTypeSet": [
    {
      "ebsOptimizedAvailable": true,
      "ephemeralsType": "string",
      "eth": 0,
      "gpu": 0,
      "maxIpAddresses": 0,
      "memory": 0,
      "name": "string",
      "storageCount": 0,
      "storageSize": 0,
      "vcpu": 0
    }
  ],
  "requestId": "string"
}

DescribeInstancesResponse

Properties

Name Type Required Restrictions Description
nextToken string false none The token to specify to request the next results page. If the value is null, there is no results left to be returned.
requestId string false none The ID of the request.
reservationSet [reservationSet] false none Zero or more reservations.

Schema

{
  "nextToken": "string",
  "requestId": "string",
  "reservationSet": [
    {
      "groupSet": [
        {
          "groupId": "string",
          "groupName": "string"
        }
      ],
      "instancesSet": [
        {
          "amiLaunchIndex": 0,
          "architecture": "string",
          "blockDeviceMapping": [
            {
              "deviceName": "string",
              "ebs": {
                "attachTime": "string",
                "deleteOnTermination": true,
                "status": "string",
                "volumeId": "string"
              }
            }
          ],
          "clientToken": "string",
          "dnsName": "string",
          "ebsOptimized": true,
          "groupSet": [
            {
              "groupId": "string",
              "groupName": "string"
            }
          ],
          "hypervisor": "string",
          "iamInstanceProfile": {
            "arn": "string",
            "id": "string"
          },
          "imageId": "string",
          "instanceId": "string",
          "instanceLifecycle": "string",
          "instanceState": {
            "code": 0,
            "name": "string"
          },
          "instanceType": "string",
          "ipAddress": "string",
          "kernelId": "string",
          "keyName": "string",
          "launchTime": "string",
          "monitoring": {
            "state": "string"
          },
          "networkInterfaceSet": [
            {
              "association": {
                "ipOwnerId": "string",
                "publicDnsName": "string",
                "publicIp": "string"
              },
              "attachment": {
                "attachTime": "string",
                "attachmentId": "string",
                "deleteOnTermination": true,
                "deviceIndex": 0,
                "status": "string"
              },
              "description": "string",
              "groupSet": [
                {
                  "groupId": "string",
                  "groupName": "string"
                }
              ],
              "macAddress": "string",
              "networkInterfaceId": "string",
              "ownerId": "string",
              "privateDnsName": "string",
              "privateIpAddress": "string",
              "privateIpAddressesSet": [
                {
                  "association": {
                    "ipOwnerId": "string",
                    "publicDnsName": "string",
                    "publicIp": "string"
                  },
                  "primary": true,
                  "privateDnsName": "string",
                  "privateIpAddress": "string"
                }
              ],
              "sourceDestCheck": true,
              "status": "string",
              "subnetId": "string",
              "vpcId": "string"
            }
          ],
          "placement": {
            "availabilityZone": "string",
            "groupName": "string",
            "tenancy": "string"
          },
          "platform": "string",
          "privateDnsName": "string",
          "privateIpAddress": "string",
          "productCodes": [
            {
              "productCode": "string",
              "type": "string"
            }
          ],
          "ramdiskId": "string",
          "reason": "string",
          "rootDeviceName": "string",
          "rootDeviceType": "string",
          "sourceDestCheck": true,
          "spotInstanceRequestId": "string",
          "sriovNetSupport": "string",
          "stateReason": {
            "code": "string",
            "message": "string"
          },
          "subnetId": "string",
          "tagSet": [
            {
              "key": "string",
              "value": "string"
            }
          ],
          "virtualizationType": "string",
          "vpcId": "string"
        }
      ],
      "ownerId": "string",
      "requesterId": "string",
      "reservationId": "string"
    }
  ]
}

DescribeInternetGatewaysResponse

Properties

Name Type Required Restrictions Description
internetGatewaySet [internetGatewaySet] false none Information about one or more Internet gateways.
requestId string false none The ID of the request.

Schema

{
  "internetGatewaySet": [
    {
      "attachmentSet": [
        {
          "state": "string",
          "vpcId": "string"
        }
      ],
      "internetGatewayId": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ]
    }
  ],
  "requestId": "string"
}

DescribeKeyPairsResponse

Properties

Name Type Required Restrictions Description
keySet [keySet] false none Information about one or more keypairs.
requestId string false none The ID of the request.

Schema

{
  "keySet": [
    {
      "keyFingerprint": "string",
      "keyName": "string"
    }
  ],
  "requestId": "string"
}

DescribeNatGatewaysResponse

Properties

Name Type Required Restrictions Description
natGatewaySet [natGatewaySet] false none Information about one or more NAT gateways.
nextToken string false none The token to request the next results page. If the value is null, there is no results left to be returned.
requestId string false none The ID of the request.

Schema

{
  "natGatewaySet": [
    {
      "createTime": "string",
      "deleteTime": "string",
      "natGatewayAddressSet": [
        {
          "allocationId": "string",
          "networkInterfaceId": "string",
          "privateIp": "string",
          "publicIp": "string"
        }
      ],
      "natGatewayId": "string",
      "state": "string",
      "subnetId": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "vpcId": "string"
    }
  ],
  "nextToken": "string",
  "requestId": "string"
}

DescribeNetworkInterfacesResponse

Properties

Name Type Required Restrictions Description
networkInterfaceSet [networkInterfaceSet_1] false none Information about the FNIs.
requestId string false none The ID of the request.

Schema

{
  "networkInterfaceSet": [
    {
      "association": {
        "allocationId": "string",
        "associationId": "string",
        "ipOwnerId": "string",
        "publicDnsName": "string",
        "publicIp": "string"
      },
      "attachment": {
        "attachTime": "string",
        "attachmentId": "string",
        "deleteOnTermination": true,
        "deviceIndex": 0,
        "instanceId": "string",
        "instanceOwnerId": "string",
        "status": "string"
      },
      "availabilityZone": "string",
      "description": "string",
      "groupSet": [
        {
          "groupId": "string",
          "groupName": "string"
        }
      ],
      "macAddress": "string",
      "networkInterfaceId": "string",
      "ownerId": "string",
      "privateDnsName": "string",
      "privateIpAddress": "string",
      "privateIpAddressesSet": [
        {
          "association": {
            "allocationId": "string",
            "associationId": "string",
            "ipOwnerId": "string",
            "publicDnsName": "string",
            "publicIp": "string"
          },
          "primary": true,
          "privateDnsName": "string",
          "privateIpAddress": "string"
        }
      ],
      "sourceDestCheck": true,
      "status": "string",
      "subnetId": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "vpcId": "string"
    }
  ],
  "requestId": "string"
}

DescribePrefixListsResponse

Properties

Name Type Required Restrictions Description
nextToken string false none The token to request the next results page. If the value is null, there is no results left to be returned.
prefixListSet [prefixListSet] false none Information about one or more prefix lists.
requestId string false none The ID of the request.

Schema

{
  "nextToken": "string",
  "prefixListSet": [
    {
      "cidrSet": [
        "string"
      ],
      "prefixListId": "string",
      "prefixListName": "string"
    }
  ],
  "requestId": "string"
}

DescribeProductTypesResponse

Properties

Name Type Required Restrictions Description
productTypeSet [productTypeSet] false none One or more product types.
requestId string false none The ID of the request.

Schema

{
  "productTypeSet": [
    {
      "description": "string",
      "productTypeId": "string",
      "vendor": "string"
    }
  ],
  "requestId": "string"
}

DescribeQuotasResponse

Properties

Name Type Required Restrictions Description
nextToken string false none The token to request the next results page. If the value is null, there are no results left to be returned.
referenceQuotaSet [referenceQuotaSet] false none One or more reference quotas.
requestId string false none The ID of the request.

Schema

{
  "nextToken": "string",
  "referenceQuotaSet": [
    {
      "quotaSet": [],
      "reference": "string"
    }
  ],
  "requestId": "string"
}

DescribeRegionsResponse

Properties

Name Type Required Restrictions Description
regionInfo [regionInfo] false none Information about one or more Regions.
requestId string false none The ID of the request.

Schema

{
  "regionInfo": [
    {
      "regionEndpoint": "string",
      "regionName": "string"
    }
  ],
  "requestId": "string"
}

DescribeRouteTablesResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
routeTableSet [routeTableSet] false none Information about one or more route tables.

Schema

{
  "requestId": "string",
  "routeTableSet": [
    {
      "associationSet": [
        {
          "main": true,
          "routeTableAssociationId": "string",
          "routeTableId": "string",
          "subnetId": "string"
        }
      ],
      "propagatingVgwSet": [
        {
          "gatewayId": "string"
        }
      ],
      "routeSet": [
        {
          "destinationCidrBlock": "string",
          "destinationPrefixListId": "string",
          "gatewayId": "string",
          "instanceId": "string",
          "instanceOwnerId": "string",
          "networkInterfaceId": "string",
          "origin": "string",
          "state": "string",
          "vpcPeeringConnectionId": "string"
        }
      ],
      "routeTableId": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "vpcId": "string"
    }
  ]
}

DescribeSecurityGroupsResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
securityGroupInfo [securityGroupInfo] false none Information about one or more security groups.

Schema

{
  "requestId": "string",
  "securityGroupInfo": [
    {
      "groupDescription": "string",
      "groupId": "string",
      "groupName": "string",
      "ipPermissions": [
        {
          "fromPort": 0,
          "groups": [
            {
              "groupId": "string",
              "groupName": "string",
              "userId": "string"
            }
          ],
          "ipProtocol": "string",
          "ipRanges": [
            {
              "cidrIp": "string"
            }
          ],
          "prefixListIds": [
            {
              "prefixListId": "string"
            }
          ],
          "toPort": 0
        }
      ],
      "ipPermissionsEgress": [
        {
          "fromPort": 0,
          "groups": [
            {
              "groupId": "string",
              "groupName": "string",
              "userId": "string"
            }
          ],
          "ipProtocol": "string",
          "ipRanges": [
            {
              "cidrIp": "string"
            }
          ],
          "prefixListIds": [
            {
              "prefixListId": "string"
            }
          ],
          "toPort": 0
        }
      ],
      "ownerId": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "vpcId": "string"
    }
  ]
}

DescribeSnapshotAttributeResponse

Properties

Name Type Required Restrictions Description
createVolumePermission [CreateVolumePermission_1] false none A list of permissions for creating volumes from the snapshot.
requestId string false none The ID of the request.
snapshotId string false none The ID of the snapshot.

Schema

{
  "createVolumePermission": [
    {
      "Group": "string",
      "UserId": "string"
    }
  ],
  "requestId": "string",
  "snapshotId": "string"
}

DescribeSnapshotExportTasksResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
snapshotExportTaskSet [snapshotExportTask] false none Information about one or more snapshot export tasks.

Schema

{
  "requestId": "string",
  "snapshotExportTaskSet": [
    {
      "completion": 0,
      "exportToOsu": {
        "aksk": {
          "AccessKey": "string",
          "SecretKey": "string"
        },
        "diskImageFormat": "string",
        "osuBucket": "string",
        "osuKey": "string",
        "osuPrefix": "string"
      },
      "snapshotExport": {
        "snapshotId": "string"
      },
      "snapshotExportTaskId": "string",
      "state": "string",
      "statusMessage": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ]
    }
  ]
}

DescribeSnapshotsResponse

Properties

Name Type Required Restrictions Description
nextToken string false none The token to request the next results page. If the value is null, there is no results left to be returned.
requestId string false none The ID of the request.
snapshotSet [snapshotSet] false none Information about one or more snapshots.

Schema

{
  "nextToken": "string",
  "requestId": "string",
  "snapshotSet": [
    {
      "description": "string",
      "encrypted": true,
      "ownerAlias": "string",
      "ownerId": "string",
      "progress": "string",
      "snapshotId": "string",
      "startTime": "string",
      "status": "string",
      "statusMessage": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "volumeId": "string",
      "volumeSize": 0
    }
  ]
}

DescribeSubnetsResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
subnetSet [subnetSet] false none Information about one or more of your subnets.

Schema

{
  "requestId": "string",
  "subnetSet": [
    {
      "availabilityZone": "string",
      "availableIpAddressCount": 0,
      "cidrBlock": "string",
      "mapPublicIpOnLaunch": true,
      "state": "string",
      "subnetId": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "vpcId": "string"
    }
  ]
}

DescribeTagsResponse

Properties

Name Type Required Restrictions Description
nextToken string false none The token to request the next results page. If the value is null, there is no results left to be returned.
requestId string false none The ID of the request.
tagSet [tagSet_1] false none Information about one or more tags.

Schema

{
  "nextToken": "string",
  "requestId": "string",
  "tagSet": [
    {
      "key": "string",
      "resourceId": "string",
      "resourceType": "string",
      "value": "string"
    }
  ]
}

DescribeVolumesResponse

Properties

Name Type Required Restrictions Description
nextToken string false none The token to request the next results page. If the value is null, there is no results left to be returned.
requestId string false none The ID of the request.
volumeSet [volumeSet] false none Information about one or more volumes.

Schema

{
  "nextToken": "string",
  "requestId": "string",
  "volumeSet": [
    {
      "attachmentSet": [
        {
          "attachTime": "string",
          "deleteOnTermination": true,
          "device": "string",
          "instanceId": "string",
          "status": "string",
          "volumeId": "string"
        }
      ],
      "availabilityZone": "string",
      "createTime": "string",
      "iops": 0,
      "size": 0,
      "snapshotId": "string",
      "status": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "volumeId": "string",
      "volumeType": "string"
    }
  ]
}

DescribeVpcAttributeResponse

Properties

Name Type Required Restrictions Description
enableDnsHostnames EnableDnsHostnames_1 false none The state of the enableDnsHostnames attribute.
enableDnsSupport EnableDnsSupport_1 false none The state of the enableDnsSupport attribute.
requestId string false none The ID of the request.
vpcId string false none The ID of the VPC.

Schema

{
  "enableDnsHostnames": {
    "value": true
  },
  "enableDnsSupport": {
    "value": true
  },
  "requestId": "string",
  "vpcId": "string"
}

DescribeVpcEndpointServicesResponse

Properties

Name Type Required Restrictions Description
nextToken string false none The token to request the next results page. If the value is null, there is no results left to be returned.
requestId string false none The ID of the request.
serviceNameSet [string] false none The names of the services you can use for VPC endpoints.

Schema

{
  "nextToken": "string",
  "requestId": "string",
  "serviceNameSet": [
    "string"
  ]
}

DescribeVpcEndpointsResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
vpcEndpointSet [vpcEndpointSet] false none Information about one or more VPC endpoints.

Schema

{
  "requestId": "string",
  "vpcEndpointSet": [
    {
      "creationTimestamp": "string",
      "routeTableIdSet": [
        "string"
      ],
      "serviceName": "string",
      "state": "string",
      "vpcEndpointId": "string",
      "vpcId": "string"
    }
  ]
}

DescribeVpcPeeringConnectionsResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
vpcPeeringConnectionSet [vpcPeeringConnectionSet] false none Information about one or more VPC peering connections.

Schema

{
  "requestId": "string",
  "vpcPeeringConnectionSet": [
    {
      "accepterVpcInfo": {
        "cidrBlock": "string",
        "ownerId": "string",
        "vpcId": "string"
      },
      "expirationTime": "string",
      "requesterVpcInfo": {
        "cidrBlock": "string",
        "ownerId": "string",
        "vpcId": "string"
      },
      "status": {
        "code": "string",
        "message": "string"
      },
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "vpcPeeringConnectionId": "string"
    }
  ]
}

DescribeVpcsResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
vpcSet [vpcSet] false none Information about one or more VPCs.

Schema

{
  "requestId": "string",
  "vpcSet": [
    {
      "cidrBlock": "string",
      "dhcpOptionsId": "string",
      "instanceTenancy": "string",
      "isDefault": true,
      "state": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "vpcId": "string"
    }
  ]
}

DescribeVpnConnectionsResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
vpnConnectionSet [vpnConnectionSet] false none Information about one or more VPN connections.

Schema

{
  "requestId": "string",
  "vpnConnectionSet": [
    {
      "customerGatewayConfiguration": "string",
      "customerGatewayId": "string",
      "options": {
        "staticRoutesOnly": true
      },
      "routes": [
        {
          "destinationCidrBlock": "string",
          "source": "string",
          "state": "string"
        }
      ],
      "state": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "type": "string",
      "vgwTelemetry": [
        {
          "acceptedRouteCount": 0,
          "lastStatusChange": "string",
          "outsideIpAddress": "string",
          "status": "string",
          "statusMessage": "string"
        }
      ],
      "vpnConnectionId": "string",
      "vpnGatewayId": "string"
    }
  ]
}

DescribeVpnGatewaysResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
vpnGatewaySet [vpnGatewaySet] false none Information about one or more virtual private gateways.

Schema

{
  "requestId": "string",
  "vpnGatewaySet": [
    {
      "attachments": [],
      "state": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "type": "string",
      "vpnGatewayId": "string"
    }
  ]
}

Description_0

A new description of the resource.

Properties

Name Type Required Restrictions Description
Value string false none The value specified for the resource attribute.

Schema

{
  "Value": "string"
}

Description_1

The description of the resource.

Properties

Name Type Required Restrictions Description
value string false none The value specified for the resource attribute.

Schema

{
  "value": "string"
}

DetachInternetGatewayResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
return boolean false none If true, the request succeeds. Otherwise, an error is returned.

Schema

{
  "requestId": "string",
  "return": true
}

DetachNetworkInterfaceResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
return boolean false none If true, the request succeeds. Otherwise, an error is returned.

Schema

{
  "requestId": "string",
  "return": true
}

DetachVolumeResponse

Properties

Name Type Required Restrictions Description
attachTime string false none The time at which the attachment was initiated.
deleteOnTermination boolean false none If true, the volume is deleted when terminating the instance. If false, the volume is not deleted when terminating the instance.
device string false none The name of the device.
instanceId string false none The ID of the instance.
requestId string false none The ID of the request.
status string false none The attachment state of the volume (attaching | detaching | attached | detached).
volumeId string false none The ID of the volume.

Schema

{
  "attachTime": "string",
  "deleteOnTermination": true,
  "device": "string",
  "instanceId": "string",
  "requestId": "string",
  "status": "string",
  "volumeId": "string"
}

DetachVpnGatewayResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
return boolean false none If true, the request succeeds. Otherwise, an error is returned.

Schema

{
  "requestId": "string",
  "return": true
}

DhcpConfiguration

A DHCP configuration option.

Properties

Name Type Required Restrictions Description
Key string false none The type of DHCP option (domain-name-servers | domain-name | ntp-servers | log-servers). For more information, see About DHCP Options.
Value [string] false none The values for the DHCP option (one to four IPs for the domain-name-servers, ntp-servers and log-servers options, or a domain name for the domain-name option). For more information, see About DHCP Options.

Schema

{
  "Key": "string",
  "Value": [
    "string"
  ]
}

DisableApiTermination_0

If true, you cannot terminate the instance unless you change this parameter back to false.

Properties

Name Type Required Restrictions Description
Value boolean false none A boolean value (true or false) that can be used when the resource is of boolean type.

Schema

{
  "Value": true
}

DisableApiTermination_1

If true, you cannot terminate the instance unless you change this parameter back to false.

Properties

Name Type Required Restrictions Description
value boolean false none A boolean value (true or false) that can be used when the resource is of boolean type.

Schema

{
  "value": true
}

DisableVgwRoutePropagationResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
return boolean false none If true, the request succeeds. Otherwise, an error is returned.

Schema

{
  "requestId": "string",
  "return": true
}

DisassociateAddressResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
return boolean false none If true, the request succeeds. Otherwise, an error is returned.

Schema

{
  "requestId": "string",
  "return": true
}

DisassociateRouteTableResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
return boolean false none If true, the request succeeds. Otherwise, an error is returned.

Schema

{
  "requestId": "string",
  "return": true
}

EbsOptimized_0

This parameter is not available. It is present in our API for the sake of historical compatiblity with AWS.

Properties

Name Type Required Restrictions Description
Value boolean false none A boolean value (true or false) that can be used when the resource is of boolean type.

Schema

{
  "Value": true
}

EbsOptimized_1

This parameter is not available. It is present in our API for the sake of historical compatiblity with AWS.

Properties

Name Type Required Restrictions Description
value boolean false none A boolean value (true or false) that can be used when the resource is of boolean type.

Schema

{
  "value": true
}

Ebs_0

One or more parameters to map a volume to DeviceName at launch. You can specify either Ebs or VirtualName, but not both.

Properties

Name Type Required Restrictions Description
DeleteOnTermination boolean false none By default or if set to true, the volume is deleted when terminating the instance. If false, the volume is not deleted when terminating the instance.
Iops integer false none The number of I/O operations per second. This parameter must be specified only if you create an io1 volume. The maximum number of IOPS allowed for io1 volumes is 13000 with a maximum performance ratio of 300 IOPS per gibibyte.
SnapshotId string false none The ID of the snapshot used to create the volume.
VolumeSize integer false none The size of the volume, in gibibytes (GiB).
If you specify a snapshot ID, the volume size must be at least equal to the snapshot size.
If you specify a snapshot ID but no volume size, the volume is created with a size similar to the snapshot one.
VolumeType string false none The type of the volume (standard | io1 | gp2). If not specified in the request, a standard volume is created. For more information about volumes types, see Volume Types and IOPS.

Schema

{
  "DeleteOnTermination": true,
  "Iops": 0,
  "SnapshotId": "string",
  "VolumeSize": 0,
  "VolumeType": "string"
}

Ebs_1

One or more parameters used to automatically set up volumes when you launch the instance.

Properties

Name Type Required Restrictions Description
DeleteOnTermination boolean false none By default or if set to true, the volume is deleted when terminating the instance. If false, the volume is not deleted when terminating the instance.
VolumeId string false none The ID of the volume.

Schema

{
  "DeleteOnTermination": true,
  "VolumeId": "string"
}

Ebs_2

One or more parameters used to automatically set up volumes when you launch the instance.

Properties

Name Type Required Restrictions Description
deleteOnTermination boolean false none If true, the volume is deleted when terminating the instance. If false, the volume is not deleted when terminating the instance.
iops integer false none The number of I/O operations per second. This parameter must be specified only if you create an io1 volume. The maximum number of IOPS allowed for io1 volumes is 13000 with a maximum performance ratio of 300 IOPS per gibibyte.
snapshotId string false none The ID of the snapshot used to create the volume.
volumeSize integer false none The size of the volume, in gibibytes (GiB).
If you specify a snapshot ID, the volume size must be at least equal to the snapshot size.
If you specify a snapshot ID but no volume size, the volume is created with a size similar to the snapshot one.
volumeType string false none The type of the volume (standard | io1 | gp2). If not specified in the request, a standard volume is created. For more information about volumes types, see Volume Types and IOPS.

Schema

{
  "deleteOnTermination": true,
  "iops": 0,
  "snapshotId": "string",
  "volumeSize": 0,
  "volumeType": "string"
}

EnableDnsHostnames_0

If set to true, instances launched in the VPC get DNS hostnames (by default, true).

Properties

Name Type Required Restrictions Description
Value boolean false none A boolean value (true or false) that can be used when the resource is of boolean type.

Schema

{
  "Value": true
}

EnableDnsHostnames_1

The state of the enableDnsHostnames attribute.

Properties

Name Type Required Restrictions Description
value boolean false none A boolean value (true or false) that can be used when the resource is of boolean type.

Schema

{
  "value": true
}

EnableDnsSupport_0

If set to true, DNS resolution is supported for the VPC (by default, true).

Properties

Name Type Required Restrictions Description
Value boolean false none A boolean value (true or false) that can be used when the resource is of boolean type.

Schema

{
  "Value": true
}

EnableDnsSupport_1

The state of the enableDnsSupport attribute.

Properties

Name Type Required Restrictions Description
value boolean false none A boolean value (true or false) that can be used when the resource is of boolean type.

Schema

{
  "value": true
}

EnableVgwRoutePropagationResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
return boolean false none If true, the request succeeds. Otherwise, an error is returned.

Schema

{
  "requestId": "string",
  "return": true
}

ExportToOsu_0

Information about the OMI export task.

Properties

Name Type Required Restrictions Description
DiskImageFormat string true none The format of the export disk (qcow2 | raw).
OsuAkSk OsuAkSk false none The access key and secret key of the OOS account used to access the bucket.
OsuBucket string true none The name of the OOS bucket where you want to export the OMI.
OsuPrefix string false none The prefix for the key of the OOS object corresponding to the image.

Schema

{
  "DiskImageFormat": "string",
  "OsuAkSk": {
    "AccessKey": "string",
    "SecretKey": "string"
  },
  "OsuBucket": "string",
  "OsuPrefix": "string"
}

ExportToOsu_1

Information about the snapshot export task.

Properties

Name Type Required Restrictions Description
DiskImageFormat string true none The format of the export disk (qcow2 | raw).
OsuBucket string true none The name of the OOS bucket where you want to export the snapshot.
OsuPrefix string false none The prefix for the key of the OOS object corresponding to the snapshot.
aksk aksk false none The access key and secret key of the OOS account used to access the bucket.

Schema

{
  "DiskImageFormat": "string",
  "OsuBucket": "string",
  "OsuPrefix": "string",
  "aksk": {
    "AccessKey": "string",
    "SecretKey": "string"
  }
}

Filter

One or more filters.

Properties

Name Type Required Restrictions Description
Name string false none The name of the filter.
Value [string] false none One or more filter values.

Schema

{
  "Name": "string",
  "Value": [
    "string"
  ]
}

GetConsoleOutputResponse

Properties

Name Type Required Restrictions Description
instanceId string false none The ID of the instance.
output string false none The Base64 encoded output of the console. If a command line tool is used, the output is decoded by the tools.
requestId string false none The ID of the request.
timestamp string false none The date and time the output was last updated, in ISO 8601 format.

Schema

{
  "instanceId": "string",
  "output": "string",
  "requestId": "string",
  "timestamp": "string"
}

GetPasswordDataResponse

Properties

Name Type Required Restrictions Description
instanceId string false none The ID of the instance.
passwordData string false none The password of the instance. After the first boot, returns an empty string.
requestId string false none The ID of the request.
timestamp string false none The date and time the output was last updated, in ISO 8601 format.

Schema

{
  "instanceId": "string",
  "passwordData": "string",
  "requestId": "string",
  "timestamp": "string"
}

GetProductTypeResponse

Properties

Name Type Required Restrictions Description
productType productType false none Information about the product type of the specified OMI or snapshot.
requestId string false none The ID of the request.

Schema

{
  "productType": {
    "description": "string",
    "productTypeId": "string",
    "vendor": "string"
  },
  "requestId": "string"
}

GetProductTypesResponse

Properties

Name Type Required Restrictions Description
productTypeSet [productTypeSet] false none Information about one or more product types.
requestId string false none The ID of the request.

Schema

{
  "productTypeSet": [
    {
      "description": "string",
      "productTypeId": "string",
      "vendor": "string"
    }
  ],
  "requestId": "string"
}

Groups_0

One or more security groups and account ID pairs.

Properties

Name Type Required Restrictions Description
GroupId string false none The ID of the security group (in case of a security group in a nondefault VPC).
GroupName string false none The name of the security group (in case of a security group in FCU or a default VPC).
UserId string false none The account ID of the user.

Schema

{
  "GroupId": "string",
  "GroupName": "string",
  "UserId": "string"
}

Groups_1

Information about one or more security groups associated with the FNI.

Properties

Name Type Required Restrictions Description
groupId string false none The ID of the security group.xx
groupName string false none The name of the security group.

Schema

{
  "groupId": "string",
  "groupName": "string"
}

ImportKeyPairResponse

Properties

Name Type Required Restrictions Description
keyFingerprint string false none The MD5 public key fingerprint as specified in section 4 of RFC 4716.
keyName string false none The keypair name you specified.
requestId string false none The ID of the request.

Schema

{
  "keyFingerprint": "string",
  "keyName": "string",
  "requestId": "string"
}

ImportSnapshotResponse

Properties

Name Type Required Restrictions Description
description string false none The description of the snapshot created in your account.
encrypted boolean false none Indicates whether the snapshot is encrypted or not (always false).
ownerAlias string false none The alias of the owner of the snapshot created in your account.
ownerId string false none The ID of the owner of the snapshot created in your account.
progress string false none The percentage of the task completed.
requestId string false none The ID of the request.
snapshotId string false none The ID of the snapshot created in your account.
startTime string false none The date and time at which the import task started.
status string false none The state of the snapshot created in your account (error | completed).
volumeId string false none The ID of the volume.
volumeSize integer false none The size of the volume, in gibibytes (GiB).

Schema

{
  "description": "string",
  "encrypted": true,
  "ownerAlias": "string",
  "ownerId": "string",
  "progress": "string",
  "requestId": "string",
  "snapshotId": "string",
  "startTime": "string",
  "status": "string",
  "volumeId": "string",
  "volumeSize": 0
}

InstanceInitiatedShutdownBehavior_0

The instance behavior when you stop it. By default or if set to stop, the instance stops. If set to restart, the instance stops then automatically restarts. If set to terminate, the instance stops and is terminated.

Properties

Name Type Required Restrictions Description
Value string false none The value specified for the resource attribute.

Schema

{
  "Value": "string"
}

InstanceInitiatedShutdownBehavior_1

Indicates whether the instance stops, terminates or restarts when you stop or terminate it.

Properties

Name Type Required Restrictions Description
value string false none The value specified for the resource attribute.

Schema

{
  "value": "string"
}

InstanceType_0

The type of instance. For more information, see Instance Types.

Properties

Name Type Required Restrictions Description
Value string false none The value specified for the resource attribute.

Schema

{
  "Value": "string"
}

InstanceType_1

The type of instance. For more information, see Instance Types.

Properties

Name Type Required Restrictions Description
value string false none The value specified for the resource attribute.

Schema

{
  "value": "string"
}

IpPermissions_0

Information about one or more IP permissions.

Properties

Name Type Required Restrictions Description
FromPort integer false none The beginning of the port range for TCP and UDP protocols, or an ICMP type number.
Groups [Groups_0] false none One or more security groups and account ID pairs.
IpProtocol string false none The IP protocol name (tcp, udp, icmp, or -1 for all protocols). By default, -1. In a VPC, this can also be an IP protocol number. For more information, see the IANA.org website.
IpRanges [IpRanges_0] false none One or more IP ranges.
PrefixListIds [PrefixListIds_0] false none One or more prefix list IDs to allow traffic from a VPC to access the corresponding OUTSCALE services. For more information, see DescribePrefixLists.
ToPort integer false none The end of the port range for TCP and UDP protocols, or an ICMP code number.

Schema

{
  "FromPort": 0,
  "Groups": [
    {
      "GroupId": "string",
      "GroupName": "string",
      "UserId": "string"
    }
  ],
  "IpProtocol": "string",
  "IpRanges": [
    {
      "CidrIp": "string"
    }
  ],
  "PrefixListIds": [
    {
      "PrefixListId": "string"
    }
  ],
  "ToPort": 0
}

IpPermissions_1

The inbound rules associated with the security group.

Properties

Name Type Required Restrictions Description
fromPort integer false none The beginning of the port range for TCP and UDP protocols, or an ICMP type number.
groups [groups_2] false none One or more security groups and account ID pairs.
ipProtocol string false none The IP protocol name (tcp, udp, icmp, or -1 for all protocols). By default, -1. In a VPC, this can also be an IP protocol number. For more information, see the IANA.org website.
ipRanges [ipRanges_1] false none One or more IP ranges.
prefixListIds [PrefixListIds_1] false none One or more prefix list IDs to allow traffic from a VPC to access the corresponding OUTSCALE services. For more information, see DescribePrefixLists.
toPort integer false none The end of the port range for TCP and UDP protocols, or an ICMP code number.

Schema

{
  "fromPort": 0,
  "groups": [
    {
      "groupId": "string",
      "groupName": "string",
      "userId": "string"
    }
  ],
  "ipProtocol": "string",
  "ipRanges": [
    {
      "cidrIp": "string"
    }
  ],
  "prefixListIds": [
    {
      "prefixListId": "string"
    }
  ],
  "toPort": 0
}

IpRanges_0

One or more IP ranges.

Properties

Name Type Required Restrictions Description
CidrIp string false none The range of IPs.

Schema

{
  "CidrIp": "string"
}

LaunchPermission_0

Permissions to access the OMI. If you specify both Add and Remove attributes in the request, only Add is taken into account.

Properties

Name Type Required Restrictions Description
Add [Add] false none The account ID you want to add to the list of launch permissions for the OMI.
Remove [Remove] false none The account ID you want to remove from the list of launch permissions for the OMI.

Schema

{
  "Add": [
    {
      "Group": "string",
      "UserId": "string"
    }
  ],
  "Remove": [
    {
      "Group": "string",
      "UserId": "string"
    }
  ]
}

MapPublicIpOnLaunch

If set to true, an External IP (EIP) is automatically assigned to the instance launched with this subnet. The EIP remains assigned to the instance, even when it is stopped, and is released when the instance is terminated.

Properties

Name Type Required Restrictions Description
Value boolean false none A boolean value (true or false) that can be used when the resource is of boolean type.

Schema

{
  "Value": true
}

ModifyImageAttributeResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
return boolean false none If true, the request succeeds. Otherwise, an error is returned.

Schema

{
  "requestId": "string",
  "return": true
}

ModifyInstanceAttributeResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
return boolean false none If true, the request succeeds. Otherwise, an error is returned.

Schema

{
  "requestId": "string",
  "return": true
}

ModifyInstanceKeypairResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.

Schema

{
  "requestId": "string"
}

ModifyNetworkInterfaceAttributeResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
return boolean false none If true, the attribute of the specified FNI is modified. Otherwise, you receive an error message.

Schema

{
  "requestId": "string",
  "return": true
}

ModifySnapshotAttributeResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
return boolean false none If true, the request succeeds. Otherwise, an error is returned.

Schema

{
  "requestId": "string",
  "return": true
}

ModifySubnetAttributeResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
return boolean false none If true, the request succeeds. Otherwise, an error is returned.

Schema

{
  "requestId": "string",
  "return": true
}

ModifyVpcAttributeResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
return boolean false none If true, the request succeeds. Otherwise, an error is returned.

Schema

{
  "requestId": "string",
  "return": true
}

ModifyVpcEndpointResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
return boolean false none If true, the request succeeds. Otherwise, an error is returned.

Schema

{
  "requestId": "string",
  "return": true
}

NetworkInterface_0

One or more network interfaces. If you specify this parameter, you must define one network interface as the primary one of the instance with 0 as its device index.

Properties

Name Type Required Restrictions Description
DeleteOnTermination boolean false none By default or if set to true, the network interface is deleted when the instance is terminated. You can specify this parameter only for a new network interface. To modify this value for an existing network interface, see ModifyNetworkInterfaceAttribute.
Description string false none The description of the network interface, if you are creating a network interface when launching an instance.
DeviceIndex integer false none The index of the instance device for the network interface attachment (between 0 and 7, both included). This parameter is required if you create a network interface when launching an instance.
NetworkInterfaceId string false none The ID of the network interface, if you are attaching an existing network interface when launching an instance.
PrivateIpAddress string false none The private IP of the network interface, if you are creating a network interface when launching an instance.
PrivateIpAddressesSet [PrivateIpAddressesSet] false none One or more private IPs to assign to the network interface (only one can be primary), if you are creating a network interface when launching an instance.
SecondaryPrivateIpAddressCount integer false none The number of secondary private IPs (cannot be specified if you specified more than one private IP in the PrivateIPAddressesSet.N parameter), if you are creating a network interface when launching an instance.
SecurityGroupId [string] false none One or more IDs of the security groups of the network interface, if you are creating a network interface when launching an instance.
SubnetId string false none The ID of the subnet associated with the network string, if you are creating a network interface when launching an instance.

Schema

{
  "DeleteOnTermination": true,
  "Description": "string",
  "DeviceIndex": 0,
  "NetworkInterfaceId": "string",
  "PrivateIpAddress": "string",
  "PrivateIpAddressesSet": [
    {
      "Primary": true,
      "PrivateIpAddress": "string"
    }
  ],
  "SecondaryPrivateIpAddressCount": 0,
  "SecurityGroupId": [
    "string"
  ],
  "SubnetId": "string"
}

NetworkInterface_1

Information about the newly created FNI.

Properties

Name Type Required Restrictions Description
association association_0 false none Information about the association between the FNI and an EIP.
attachment attachment_1 false none Information about the FNI attachment.
availabilityZone string false none The AZ where the FNI is located.
description string false none The description of the FNI.
groupSet [groupSet] false none One or more security groups for the instance.
macAddress string false none The Media Access Control (MAC) address of the FNI.
networkInterfaceId string false none The ID of the FNI.
ownerId string false none The account ID of the FNI owner.
privateDnsName string false none The private DNS name associated with the primary private IP of the FNI.
privateIpAddress string false none The primary private IP of the FNI.
privateIpAddressesSet [privateIpAddressesSet_0] false none Information about the EIP and the private IPs assigned to the FNI.
sourceDestCheck boolean false none If true, the traffic to or from the instance is validated. If false, it is not.
status string false none The state of the FNI.
subnetId string false none The ID of the subnet where the FNI is located.
tagSet [tagSet_0] false none One or more tags associated with the FNI.
vpcId string false none The ID of the VPC where the FNI is located.

Schema

{
  "association": {
    "allocationId": "string",
    "associationId": "string",
    "ipOwnerId": "string",
    "publicDnsName": "string",
    "publicIp": "string"
  },
  "attachment": {
    "attachTime": "string",
    "attachmentId": "string",
    "deleteOnTermination": true,
    "deviceIndex": 0,
    "instanceId": "string",
    "instanceOwnerId": "string",
    "status": "string"
  },
  "availabilityZone": "string",
  "description": "string",
  "groupSet": [
    {
      "groupId": "string",
      "groupName": "string"
    }
  ],
  "macAddress": "string",
  "networkInterfaceId": "string",
  "ownerId": "string",
  "privateDnsName": "string",
  "privateIpAddress": "string",
  "privateIpAddressesSet": [
    {
      "association": {
        "allocationId": "string",
        "associationId": "string",
        "ipOwnerId": "string",
        "publicDnsName": "string",
        "publicIp": "string"
      },
      "primary": true,
      "privateDnsName": "string",
      "privateIpAddress": "string"
    }
  ],
  "sourceDestCheck": true,
  "status": "string",
  "subnetId": "string",
  "tagSet": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "vpcId": "string"
}

Options_0

Options for a VPN connection.

Properties

Name Type Required Restrictions Description
StaticRoutesOnly boolean false none If set to false, the VPN connection uses dynamic routing with Border Gateway Protocol (BGP). If set to true, routing is controlled using static routes. For more information about how to create and delete static routes, see CreateVpnConnectionRoute and DeleteVpnConnectionRoute.

Schema

{
  "StaticRoutesOnly": true
}

Options_1

Options for a VPN connection.

Properties

Name Type Required Restrictions Description
staticRoutesOnly boolean false none If set to false, the VPN connection uses dynamic routing with Border Gateway Protocol (BGP). If set to true, routing is controlled using static routes. For more information about how to create and delete static routes, see CreateVpnConnectionRoute and DeleteVpnConnectionRoute.

Schema

{
  "staticRoutesOnly": true
}

OsuAkSk

The access key and secret key of the OOS account used to access the bucket.

Properties

Name Type Required Restrictions Description
AccessKey string false none The access key of the OOS account that enables you to access the bucket.
SecretKey string false none The secret key of the OOS account that enables you to access the bucket.

Schema

{
  "AccessKey": "string",
  "SecretKey": "string"
}

Placement_0

A specific placement where you want to create the instances (tenancy options).

Properties

Name Type Required Restrictions Description
AvailabilityZone string false none The Availability Zone of the instance.
Tenancy string false none The tenancy of the instance (default | dedicated).

Schema

{
  "AvailabilityZone": "string",
  "Tenancy": "string"
}

Placement_1

A specific placement where you want to create the instances.

Properties

Name Type Required Restrictions Description
availabilityZone string false none The Availability Zone of the instance.
groupName string false none The name of the placement group of the instance (always null).
tenancy string false none The tenancy of the instance (default | dedicated).

Schema

{
  "availabilityZone": "string",
  "groupName": "string",
  "tenancy": "string"
}

PrefixListIds_0

One or more prefix list IDs to allow traffic from a VPC to access the corresponding OUTSCALE services. For more information, see DescribePrefixLists.

Properties

Name Type Required Restrictions Description
PrefixListId string false none The ID of the prefix.

Schema

{
  "PrefixListId": "string"
}

PrefixListIds_1

One or more prefix list IDs to allow traffic from a VPC to access the corresponding OUTSCALE services. For more information, see DescribePrefixLists.

Properties

Name Type Required Restrictions Description
prefixListId string false none The ID of the prefix.

Schema

{
  "prefixListId": "string"
}

PrivateIpAddressesSet

One or more private IPs to assign to the network interface (only one can be primary), if you are creating a network interface when launching an instance.

Properties

Name Type Required Restrictions Description
Primary boolean false none Indicates whether it is the primary private IP.
PrivateIpAddress string false none The private IPs.

Schema

{
  "Primary": true,
  "PrivateIpAddress": "string"
}

QuotaSet

One or more quotas associated with the user.

Properties

Name Type Required Restrictions Description
description string false none The description of the quota.
displayName string false none The display name of the quota.
groupName string false none The group name the quota belongs to.
maxQuotaValue integer false none The maximum value of the quota for the OUTSCALE user account (if there is no limit, 0).
name string false none The unique name of the quota.
ownerId string false none The account ID of owner of the quota.
usedQuotaValue integer false none The limit value currently used by the OUTSCALE user account.

Schema

{
  "description": "string",
  "displayName": "string",
  "groupName": "string",
  "maxQuotaValue": 0,
  "name": "string",
  "ownerId": "string",
  "usedQuotaValue": 0
}

ReadPublicIpRangesResponse

Properties

Name Type Required Restrictions Description
publicIpSet [string] false none The list of public IPv4 addresses used in the Region, in CIDR notation.
requestId string false none The ID of the request.

Schema

{
  "publicIpSet": [
    "string"
  ],
  "requestId": "string"
}

RebootInstancesResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
return boolean false none If true, the request succeeds. Otherwise, an error is returned.

Schema

{
  "requestId": "string",
  "return": true
}

RegisterImageResponse

Properties

Name Type Required Restrictions Description
imageId string false none The ID of the newly registered OMI.
requestId string false none The ID of the request.

Schema

{
  "imageId": "string",
  "requestId": "string"
}

RejectVpcPeeringConnectionResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
return boolean false none If true, the VPC peering connection is rejected. Otherwise, you receive an error.

Schema

{
  "requestId": "string",
  "return": true
}

ReleaseAddressResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
return boolean false none If true, the request succeeds. Otherwise, an error is returned.

Schema

{
  "requestId": "string",
  "return": true
}

Remove

The account ID you want to remove from the list of permissions for the volume.

Properties

Name Type Required Restrictions Description
Group string false none The name of the group (all if public).
UserId string false none The account ID of the user.

Schema

{
  "Group": "string",
  "UserId": "string"
}

ReplaceRouteResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
return boolean false none If true, the request succeeded. Otherwise, an error is returned.

Schema

{
  "requestId": "string",
  "return": true
}

ReplaceRouteTableAssociationResponse

Properties

Name Type Required Restrictions Description
newAssociationId string false none The ID of the new route table association.
requestId string false none The ID of the request.

Schema

{
  "newAssociationId": "string",
  "requestId": "string"
}

RevokeSecurityGroupEgressResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
return boolean false none If true, the request succeeds. Otherwise, an error is returned.

Schema

{
  "requestId": "string",
  "return": true
}

RevokeSecurityGroupIngressResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
return boolean false none If true, the request succeeds. Otherwise, an error is returned.

Schema

{
  "requestId": "string",
  "return": true
}

RunInstancesResponse

Properties

Name Type Required Restrictions Description
groupSet [groupSet] false none One or more security groups.
instancesSet [instancesSet_0] false none One or more instances.
ownerId string false none The ID of the account which has reserved the instances.
requestId string false none The ID of the request.
requesterId string false none The ID of the requester.
reservationId string false none Zero or more reservations, giving you information about your request.

Schema

{
  "groupSet": [
    {
      "groupId": "string",
      "groupName": "string"
    }
  ],
  "instancesSet": [
    {
      "amiLaunchIndex": 0,
      "architecture": "string",
      "blockDeviceMapping": [
        {
          "deviceName": "string",
          "ebs": {
            "attachTime": "string",
            "deleteOnTermination": true,
            "status": "string",
            "volumeId": "string"
          }
        }
      ],
      "clientToken": "string",
      "dnsName": "string",
      "ebsOptimized": true,
      "groupSet": [
        {
          "groupId": "string",
          "groupName": "string"
        }
      ],
      "hypervisor": "string",
      "iamInstanceProfile": {
        "arn": "string",
        "id": "string"
      },
      "imageId": "string",
      "instanceId": "string",
      "instanceLifecycle": "string",
      "instanceState": {
        "code": 0,
        "name": "string"
      },
      "instanceType": "string",
      "ipAddress": "string",
      "kernelId": "string",
      "keyName": "string",
      "launchTime": "string",
      "monitoring": {
        "state": "string"
      },
      "networkInterfaceSet": [
        {
          "association": {
            "ipOwnerId": "string",
            "publicDnsName": "string",
            "publicIp": "string"
          },
          "attachment": {
            "attachTime": "string",
            "attachmentId": "string",
            "deleteOnTermination": true,
            "deviceIndex": 0,
            "status": "string"
          },
          "description": "string",
          "groupSet": [
            {
              "groupId": "string",
              "groupName": "string"
            }
          ],
          "macAddress": "string",
          "networkInterfaceId": "string",
          "ownerId": "string",
          "privateDnsName": "string",
          "privateIpAddress": "string",
          "privateIpAddressesSet": [
            {
              "association": {
                "ipOwnerId": "string",
                "publicDnsName": "string",
                "publicIp": "string"
              },
              "primary": true,
              "privateDnsName": "string",
              "privateIpAddress": "string"
            }
          ],
          "sourceDestCheck": true,
          "status": "string",
          "subnetId": "string",
          "vpcId": "string"
        }
      ],
      "placement": {
        "availabilityZone": "string",
        "groupName": "string",
        "tenancy": "string"
      },
      "platform": "string",
      "privateDnsName": "string",
      "privateIpAddress": "string",
      "productCodes": [
        {
          "productCode": "string",
          "type": "string"
        }
      ],
      "ramdiskId": "string",
      "reason": "string",
      "rootDeviceName": "string",
      "rootDeviceType": "string",
      "sourceDestCheck": true,
      "spotInstanceRequestId": "string",
      "sriovNetSupport": "string",
      "stateReason": {
        "code": "string",
        "message": "string"
      },
      "subnetId": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "virtualizationType": "string",
      "vpcId": "string"
    }
  ],
  "ownerId": "string",
  "requestId": "string",
  "requesterId": "string",
  "reservationId": "string"
}

SourceDestCheck_0

(VPC only) If true, the source/destination check is enabled. If false, it is disabled. This value must be false for a NAT instance to perform Network Address Translation (NAT) in a VPC.

Properties

Name Type Required Restrictions Description
Value boolean false none A boolean value (true or false) that can be used when the resource is of boolean type.

Schema

{
  "Value": true
}

SourceDestCheck_1

(VPC only) If true, the source/destination check is enabled. If false, it is disabled. This value must be false for a NAT instance to perform Network Address Translation (NAT) in a VPC.

Properties

Name Type Required Restrictions Description
value boolean false none A boolean value (true or false) that can be used when the resource is of boolean type.

Schema

{
  "value": true
}

StartInstancesResponse

Properties

Name Type Required Restrictions Description
instancesSet [instancesSet_1] false none Information about the started instances.
requestId string false none The ID of the request.

Schema

{
  "instancesSet": [
    {
      "currentState": {
        "code": 0,
        "name": "string"
      },
      "instanceId": "string",
      "previousState": {
        "code": 0,
        "name": "string"
      }
    }
  ],
  "requestId": "string"
}

StopInstancesResponse

Properties

Name Type Required Restrictions Description
instancesSet [instancesSet_1] false none Information about one or more stopped instances.
requestId string false none The ID of the request.

Schema

{
  "instancesSet": [
    {
      "currentState": {
        "code": 0,
        "name": "string"
      },
      "instanceId": "string",
      "previousState": {
        "code": 0,
        "name": "string"
      }
    }
  ],
  "requestId": "string"
}

Tag

One or more tags you want to add to the specified resources.
Example for an instance:
osc-cli fcu CreateTags \
  --ResourceId i-xxxxxxxx \
  --Tag.1.Key "AAAA" --Tag.1.Value "BBBB" \
  --Tag.2.Key "CCCC" --Tag.2.Value "DDDD"

Properties

Name Type Required Restrictions Description
Key string false none The key of the tag, with a minimum of 1 character.
Value string false none The value of the tag, between 0 and 255 characters.

Schema

{
  "Key": "string",
  "Value": "string"
}

TerminateInstancesResponse

Properties

Name Type Required Restrictions Description
instancesSet [instancesSet_1] false none Information about one or more terminated instances.
requestId string false none The ID of the request.

Schema

{
  "instancesSet": [
    {
      "currentState": {
        "code": 0,
        "name": "string"
      },
      "instanceId": "string",
      "previousState": {
        "code": 0,
        "name": "string"
      }
    }
  ],
  "requestId": "string"
}

UnassignPrivateIpAddressesResponse

Properties

Name Type Required Restrictions Description
requestId string false none The ID of the request.
return boolean false none If true, the private IP is unassigned. Otherwise, you receive an error.

Schema

{
  "requestId": "string",
  "return": true
}

UserData_0

The Base64-encoded MIME user data, limited to 500 kibibytes (KiB).

Properties

Name Type Required Restrictions Description
Value string false none The value to use for the resource attribute.

Schema

{
  "Value": "string"
}

UserData_1

The Base64-encoded MIME user data.

Properties

Name Type Required Restrictions Description
value string false none The value specified for the resource attribute.

Schema

{
  "value": "string"
}

accepterVpcInfo

Information about the peer VPC of the VPC peering connection.

Properties

Name Type Required Restrictions Description
cidrBlock string false none The CIDR block of the VPC.
ownerId string false none The account ID of the owner of the VPC.
vpcId string false none The ID of the VPC.

Schema

{
  "cidrBlock": "string",
  "ownerId": "string",
  "vpcId": "string"
}

addressesSet

Information about one or more External IPs.

Properties

Name Type Required Restrictions Description
allocationId string false none The ID of the address allocation for use with a VPC.
associationId string false none The ID of the address association with an instance in a VPC.
domain string false none Indicates whether the External IP is for use with instances in the public Cloud or in a VPC.
instanceId string false none The ID of the instance the address is associated with.
networkInterfaceId string false none The ID of the network interface.
networkInterfaceOwnerId string false none The account ID of the owner of the network interface.
privateIpAddress string false none The private IP associated with the External IP.
publicIp string false none The External IP.

Schema

{
  "allocationId": "string",
  "associationId": "string",
  "domain": "string",
  "instanceId": "string",
  "networkInterfaceId": "string",
  "networkInterfaceOwnerId": "string",
  "privateIpAddress": "string",
  "publicIp": "string"
}

aksk

The access key and secret key of the OOS account used to access the bucket.

Properties

Name Type Required Restrictions Description
AccessKey string false none The access key of the OOS account that enables you to access the bucket.
SecretKey string false none The secret key of the OOS account that enables you to access the bucket.

Schema

{
  "AccessKey": "string",
  "SecretKey": "string"
}

associationSet

One or more associations between the route table and the subnets.

Properties

Name Type Required Restrictions Description
main boolean false none If true, the route table is the main one.
routeTableAssociationId string false none The ID of the association between a route table and a subnet.
routeTableId string false none The ID of the route table.
subnetId string false none The ID of the subnet.

Schema

{
  "main": true,
  "routeTableAssociationId": "string",
  "routeTableId": "string",
  "subnetId": "string"
}

association_0

Information about the association between the FNI and an EIP.

Properties

Name Type Required Restrictions Description
allocationId string false none The allocation ID returned when you allocated the EIP to your account.
associationId string false none The association ID returned when the FNI was associated with an EIP.
ipOwnerId string false none The account ID of the owner of the EIP associated with the FNI.
publicDnsName string false none The public DNS name associated with the EIP.
publicIp string false none The EIP associated with the FNI.

Schema

{
  "allocationId": "string",
  "associationId": "string",
  "ipOwnerId": "string",
  "publicDnsName": "string",
  "publicIp": "string"
}

association_1

Information about an External IP associated with the interface.

Properties

Name Type Required Restrictions Description
ipOwnerId string false none The account ID of the owner of the External IP.
publicDnsName string false none The name of the public DNS.
publicIp string false none The External IP (EIP) associated with the network interface.

Schema

{
  "ipOwnerId": "string",
  "publicDnsName": "string",
  "publicIp": "string"
}

attachmentSet_0

Information about the attachment.

Properties

Name Type Required Restrictions Description
attachTime string false none The time at which the attachment was initiated.
deleteOnTermination boolean false none If true, the volume is deleted when terminating the instance. If false, the volume is not deleted when terminating the instance.
device string false none The name of the device.
instanceId string false none The ID of the instance.
status string false none The attachment state of the volume (attaching | detaching | attached | detached).
volumeId string false none The ID of the volume.

Schema

{
  "attachTime": "string",
  "deleteOnTermination": true,
  "device": "string",
  "instanceId": "string",
  "status": "string",
  "volumeId": "string"
}

attachmentSet_1

One or more VPCs attached to the Internet gateway.

Properties

Name Type Required Restrictions Description
state string false none The state of the attachment (always available).
vpcId string false none The ID of the VPC.

Schema

{
  "state": "string",
  "vpcId": "string"
}

attachment_0

Information about the attachment.

Properties

Name Type Required Restrictions Description
state string false none The current state of the attachment (attaching | attached | detaching | detached).
vpcId string false none The ID of the Virtual Private Cloud (VPC).

Schema

{
  "state": "string",
  "vpcId": "string"
}

attachment_1

Information about the FNI attachment.

Properties

Name Type Required Restrictions Description
attachTime string false none The time at which the FNI was attached to an instance.
attachmentId string false none The attachment ID of the FNI.
deleteOnTermination boolean false none If true, the FNI is deleted when terminating the instance. If false, it is only detached.
deviceIndex integer false none The device index used for the FNI attachment.
instanceId string false none The ID of the instance the FNI is attached to.
instanceOwnerId string false none The account ID of the owner of the instance the FNI is attached to.
status string false none The state of the attachment.

Schema

{
  "attachTime": "string",
  "attachmentId": "string",
  "deleteOnTermination": true,
  "deviceIndex": 0,
  "instanceId": "string",
  "instanceOwnerId": "string",
  "status": "string"
}

attachment_2

The attachment of the network interface.

Properties

Name Type Required Restrictions Description
attachTime string false none The time at which the attachment was initiated.
attachmentId string false none The ID of the network interface attachment.
deleteOnTermination boolean false none If true, the network interface is deleted when the instance is terminated.
deviceIndex integer false none The index of the instance device for the attachment.
status string false none The state of the netowrk interface (attaching | attached | detaching | detached).

Schema

{
  "attachTime": "string",
  "attachmentId": "string",
  "deleteOnTermination": true,
  "deviceIndex": 0,
  "status": "string"
}

attachments

The VPC to which the virtual private gateway is attached.

Properties

Name Type Required Restrictions Description
state string false none The current state of the attachment (attaching | attached | detaching | detached).
vpcId string false none The ID of the Virtual Private Cloud (VPC).

Schema

{
  "state": "string",
  "vpcId": "string"
}

availabilityZoneInfo

Information about the Availability Zones.

Properties

Name Type Required Restrictions Description
regionName string false none The name of the Region containing the Availability Zone.
zoneName string false none The name of the Availability Zone.
zoneState string false none The state of Availability Zone (always available if the user has access to the Region containing the Availability Zone).

Schema

{
  "regionName": "string",
  "zoneName": "string",
  "zoneState": "string"
}

currentState

The current state of the instance.

Properties

Name Type Required Restrictions Description
code integer false none The code of the state of the instance: -1 (quarantine), 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
name string false none The state of the instance (pending | running | stopping | stopped | shutting-down | terminated | quarantine).

Schema

{
  "code": 0,
  "name": "string"
}

customerGateway

Information about the newly created customer gateway.

Properties

Name Type Required Restrictions Description
bgpAsn integer(int64) false none The Autonomous System Number (ASN) used by the Border Gateway Protocol (BGP) to find the path to your customer gateway through the Internet.
customerGatewayId string false none The ID of the customer gateway.
ipAddress string false none The public IPv4 address of the customer gateway (must be a fixed address into a NATed network).
state string false none The state of the customer gateway (pending | available | deleting | deleted).
tagSet [tagSet_0] false none One or more tags associated with the customer gateway.
type string false none The type of communication tunnel used by the customer gateway (only ipsec.1 is supported).

Schema

{
  "bgpAsn": 0,
  "customerGatewayId": "string",
  "ipAddress": "string",
  "state": "string",
  "tagSet": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "type": "string"
}

customerGatewaySet

Information about one or more customer gateways.

Properties

Name Type Required Restrictions Description
bgpAsn integer(int64) false none The Autonomous System Number (ASN) used by the Border Gateway Protocol (BGP) to find the path to your customer gateway through the Internet.
customerGatewayId string false none The ID of the customer gateway.
ipAddress string false none The public IPv4 address of the customer gateway (must be a fixed address into a NATed network).
state string false none The state of the customer gateway (pending | available | deleting | deleted).
tagSet [tagSet_0] false none One or more tags associated with the customer gateway.
type string false none The type of communication tunnel used by the customer gateway (only ipsec.1 is supported).

Schema

{
  "bgpAsn": 0,
  "customerGatewayId": "string",
  "ipAddress": "string",
  "state": "string",
  "tagSet": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "type": "string"
}

details

The system instance health or application instance health.

Properties

Name Type Required Restrictions Description
impairedSince string false none The time at which a state check failed (for an instance that was launched and impaired, the time at which the instance was launched).
name string false none The type of instance state (always reachability).
status string false none The state of the instance.

Schema

{
  "impairedSince": "string",
  "name": "string",
  "status": "string"
}

dhcpConfigurationSet

One or more DHCP options in the set.

Properties

Name Type Required Restrictions Description
key string false none The name of an option in the DHCP configuration.
valueSet [valueSet] false none The value for the option in the DHCP configuration.

Schema

{
  "key": "string",
  "valueSet": [
    {
      "value": "string"
    }
  ]
}

dhcpOptions

A set of DHCP options.

Properties

Name Type Required Restrictions Description
dhcpConfigurationSet [dhcpConfigurationSet] false none One or more DHCP options in the set.
dhcpOptionsId string false none The ID of the DHCP options set.
tagSet [tagSet_0] false none One or more tags associated with the DHCP options set.

Schema

{
  "dhcpConfigurationSet": [
    {
      "key": "string",
      "valueSet": [
        {
          "value": "string"
        }
      ]
    }
  ],
  "dhcpOptionsId": "string",
  "tagSet": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}

dhcpOptionsSet

Information about one or more DHCP options sets.

Properties

Name Type Required Restrictions Description
dhcpConfigurationSet [dhcpConfigurationSet] false none One or more DHCP options in the set.
dhcpOptionsId string false none The ID of the DHCP options set.
tagSet [tagSet_0] false none One or more tags associated with the DHCP options set.

Schema

{
  "dhcpConfigurationSet": [
    {
      "key": "string",
      "valueSet": [
        {
          "value": "string"
        }
      ]
    }
  ],
  "dhcpOptionsId": "string",
  "tagSet": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}

ebs

One or more parameters used to automatically set up volumes when the instance is launched.

Properties

Name Type Required Restrictions Description
attachTime string false none The time at which the attachment was initiated.
deleteOnTermination boolean false none If true, the volume is deleted when terminating the instance. If false, the volume is not deleted when terminating the instance.
status string false none The attachment state (attaching | attached | detaching | detached).
volumeId string false none The ID of the volume.

Schema

{
  "attachTime": "string",
  "deleteOnTermination": true,
  "status": "string",
  "volumeId": "string"
}

error

Information about the error.

Properties

Name Type Required Restrictions Description
code string false none The error code.
message string false none The error message corresponding to the error code.

Schema

{
  "code": "string",
  "message": "string"
}

eventsSet

One or more scheduled events associated with the instance.

Properties

Name Type Required Restrictions Description
code string false none The event code (system-reboot | system-maintenance).
description string false none A description of the event.
notAfter string false none The latest scheduled end time for the event.
notBefore string false none The earliest scheduled start time for the event.

Schema

{
  "code": "string",
  "description": "string",
  "notAfter": "string",
  "notBefore": "string"
}

exportToOsu_2

Information about the OMI export task.

Properties

Name Type Required Restrictions Description
diskImageFormat string false none The format of the export disk (qcow2 | raw).
osuAkSk OsuAkSk false none The access key and secret key of the OOS account used to access the bucket.
osuBucket string false none The name of the OOS bucket where the OMI is exported.
osuManifestUrl string false none The URL of the manifest file.
osuPrefix string false none The prefix for the key of the OOS object corresponding to the image.

Schema

{
  "diskImageFormat": "string",
  "osuAkSk": {
    "AccessKey": "string",
    "SecretKey": "string"
  },
  "osuBucket": "string",
  "osuManifestUrl": "string",
  "osuPrefix": "string"
}

exportToOsu_3

Information about the snapshot export task.

Properties

Name Type Required Restrictions Description
aksk aksk false none The access key and secret key of the OOS account used to access the bucket.
diskImageFormat string false none The format of the export disk (qcow2 | raw).
osuBucket string false none The name of the OOS bucket where the snapshot is exported.
osuKey string false none The key of the OOS object corresponding to the snapshot.
osuPrefix string false none The prefix for the key of the OOS object corresponding to the snapshot.

Schema

{
  "aksk": {
    "AccessKey": "string",
    "SecretKey": "string"
  },
  "diskImageFormat": "string",
  "osuBucket": "string",
  "osuKey": "string",
  "osuPrefix": "string"
}

groupSet

One or more security groups for the instance.

Properties

Name Type Required Restrictions Description
groupId string false none The ID of the security group.
groupName string false none The name of the security group.

Schema

{
  "groupId": "string",
  "groupName": "string"
}

groups_2

One or more security groups and account ID pairs.

Properties

Name Type Required Restrictions Description
groupId string false none The ID of the security group (in case of a security group in a nondefault VPC).
groupName string false none The name of the security group (in case of a security group in FCU or a default VPC).
userId string false none The account ID of the user.

Schema

{
  "groupId": "string",
  "groupName": "string",
  "userId": "string"
}

iamInstanceProfile

The EIM instance profile associated with the instance.

Properties

Name Type Required Restrictions Description
arn string false none The unique identifier of the ressource (between 20 and 2048 characters).
id string false none The ID of the instance profile.

Schema

{
  "arn": "string",
  "id": "string"
}

imageExport

Information about the OMI you want to export.

Properties

Name Type Required Restrictions Description
imageId string false none The ID of the OMI to be exported.

Schema

{
  "imageId": "string"
}

imageExportTask

Information about one or more image export tasks.

Properties

Name Type Required Restrictions Description
exportToOsu exportToOsu_2 false none Information about the OMI export task.
imageExport imageExport false none Information about the OMI you want to export.
imageExportTaskId string false none The ID of the OMI export task.
state string false none The state of the OMI export task (pending/queued | pending | completed | failed | cancelled).
statusMessage string false none If the OMI export task fails, an error message appears.
tagSet [tagSet_0] false none One or more tags associated with the OMI export task.

Schema

{
  "exportToOsu": {
    "diskImageFormat": "string",
    "osuAkSk": {
      "AccessKey": "string",
      "SecretKey": "string"
    },
    "osuBucket": "string",
    "osuManifestUrl": "string",
    "osuPrefix": "string"
  },
  "imageExport": {
    "imageId": "string"
  },
  "imageExportTaskId": "string",
  "state": "string",
  "statusMessage": "string",
  "tagSet": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}

imagesSet

Information about one or more OMIs.

Properties

Name Type Required Restrictions Description
architecture string false none The architecture of the OMI.
blockDeviceMapping [BlockDeviceMapping_2] false none One or more block device mapping entries.
description string false none The description of the OMI, provided when it was created.
hypervisor string false none The hypervisor type of the instance (always xen).
imageId string false none The ID of OUTSCALE machine image (OMI).
imageLocation string false none The location of the bucket where the OMI files are stored.
imageOwnerAlias string false none The account alias of the owner of the OMI.
imageOwnerId string false none The account ID of the owner of the OMI.
imageState string false none The current state of the OMI (pending | available | failed).
imageType string false none The type of the OMI.
isPublic boolean false none If true, the OMI has public launch permissions.
name string false none The name of the OMI, provided when it was created.
platform string false none The value is Windows for Windows OMIs, or blank otherwise.
productCodes [productCodes] false none One or more product codes associated with the OMI.
rootDeviceName string false none The name of the device to which the root device is plugged in (for example, /dev/sda1).
rootDeviceType string false none The type of root device used by the OMI.
stateReason stateReason false none The reason for the OMI state change.
tagSet [tagSet_0] false none One or more tags associated with the OMI.
virtualizationType string false none The virtualization type.

Schema

{
  "architecture": "string",
  "blockDeviceMapping": [
    {
      "deviceName": "string",
      "ebs": {
        "deleteOnTermination": true,
        "iops": 0,
        "snapshotId": "string",
        "volumeSize": 0,
        "volumeType": "string"
      },
      "noDevice": "string",
      "virtualName": "string"
    }
  ],
  "description": "string",
  "hypervisor": "string",
  "imageId": "string",
  "imageLocation": "string",
  "imageOwnerAlias": "string",
  "imageOwnerId": "string",
  "imageState": "string",
  "imageType": "string",
  "isPublic": true,
  "name": "string",
  "platform": "string",
  "productCodes": [
    {
      "productCode": "string",
      "type": "string"
    }
  ],
  "rootDeviceName": "string",
  "rootDeviceType": "string",
  "stateReason": {
    "code": "string",
    "message": "string"
  },
  "tagSet": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "virtualizationType": "string"
}

instanceState

The state of the instance.

Properties

Name Type Required Restrictions Description
code integer false none The code of the state of the instance: -1 (quarantine), 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
name string false none The state of the instance (pending | running | stopping | stopped | shutting-down | terminated | quarantine).

Schema

{
  "code": 0,
  "name": "string"
}

instanceStatus

Impaired functionality that stems from issues internal to the instance (for example, impaired reachability).

Properties

Name Type Required Restrictions Description
details [details] false none The system instance health or application instance health.
status string false none The state of the instance.

Schema

{
  "details": [
    {
      "impairedSince": "string",
      "name": "string",
      "status": "string"
    }
  ],
  "status": "string"
}

instanceStatusSet

One or more instance status descriptions.

Properties

Name Type Required Restrictions Description
availabilityZone string false none The Availability Zone in which the instance is located.
eventsSet [eventsSet] false none One or more scheduled events associated with the instance.
instanceId string false none The ID of the instance.
instanceState instanceState false none The state of the instance.
instanceStatus instanceStatus false none Impaired functionality that stems from issues internal to the instance (for example, impaired reachability).
systemStatus systemStatus false none Impaired functionality that stems from issues related to the systems supporting an instance (for example, hardware failures or network connectivity problems).

Schema

{
  "availabilityZone": "string",
  "eventsSet": [
    {
      "code": "string",
      "description": "string",
      "notAfter": "string",
      "notBefore": "string"
    }
  ],
  "instanceId": "string",
  "instanceState": {
    "code": 0,
    "name": "string"
  },
  "instanceStatus": {
    "details": [
      {
        "impairedSince": "string",
        "name": "string",
        "status": "string"
      }
    ],
    "status": "string"
  },
  "systemStatus": {
    "details": [
      {
        "impairedSince": "string",
        "name": "string",
        "status": "string"
      }
    ],
    "status": "string"
  }
}

instanceTypeSet

Information about one or more instance types.

Properties

Name Type Required Restrictions Description
ebsOptimizedAvailable boolean false none This parameter is not available. It is present in our API for the sake of historical compatiblity with AWS.
ephemeralsType string false none The type of ephemeral storage disk.
eth integer false none The number of Ethernet interfaces available.
gpu integer false none The number of GPUs available.
maxIpAddresses integer false none The maximum number of private IPs per network interface.
memory integer false none The amount of memory, in bytes.
name string false none The name of the instance type.
storageCount integer false none The maximum number of ephemeral storage disks.
storageSize integer false none The size of one ephemeral storage disk, in bytes.
vcpu integer false none The number of vCPUs.

Schema

{
  "ebsOptimizedAvailable": true,
  "ephemeralsType": "string",
  "eth": 0,
  "gpu": 0,
  "maxIpAddresses": 0,
  "memory": 0,
  "name": "string",
  "storageCount": 0,
  "storageSize": 0,
  "vcpu": 0
}

instancesSet_0

One or more instances.

Properties

Name Type Required Restrictions Description
amiLaunchIndex integer false none The launch index of the OMI.
architecture string false none The architecture of the image.
blockDeviceMapping [BlockDeviceMapping_3] false none One or more entries of block device mapping.
clientToken string false none A unique identifier which enables you to manage the idempotency.
dnsName string false none The name of the public DNS assigned to the instance.
ebsOptimized boolean false none This parameter is not available. It is present in our API for the sake of historical compatiblity with AWS.
groupSet [groupSet] false none One or more security groups for the instance.
hypervisor string false none The hypervisor type of the instance.
iamInstanceProfile iamInstanceProfile false none The EIM instance profile associated with the instance.
imageId string false none The ID of the OMI.
instanceId string false none The ID of the instance.
instanceLifecycle string false none Indicates whether it is a spot instance.
instanceState instanceState false none The state of the instance.
instanceType string false none The type of instance. For more information, see Instance Types.
ipAddress string false none The External IP (EIP) assigned to the instance.
kernelId string false none The ID of the kernel (always null).
keyName string false none The name of the keypair.
launchTime string false none The time at which the instance was launched.
monitoring monitoring false none The monitoring information for the instance.
networkInterfaceSet [networkInterfaceSet_0] false none In a VPC, one or more network interfaces for the instance.
placement Placement_1 false none A specific placement where you want to create the instances.
platform string false none Indicates whether it is a Windows instance.
privateDnsName string false none The name of the private DNS assigned to the instance.
privateIpAddress string false none The private IP assigned to the instance.
productCodes [productCodes] false none The code of the product attached to the instance.
ramdiskId string false none The ID of the associated RAM disk.
reason string false none Information about the latest state change.
rootDeviceName string false none The name of the root device.
rootDeviceType string false none The type of root device used by the OMI.
sourceDestCheck boolean false none If true in a VPC, the check to perform NAT is enabled.
spotInstanceRequestId string false none The ID of the spot instance request.
sriovNetSupport string false none If true, the enhanced networking is enabled.
stateReason stateReason false none The reason for the OMI state change.
subnetId string false none In a VPC, the ID of the subnet in which you want to launch the instance.
tagSet [tagSet_0] false none One or more tags associated with the instance.
virtualizationType string false none The virtualization type.
vpcId string false none The ID of the VPC in which the instance is launched.

Schema

{
  "amiLaunchIndex": 0,
  "architecture": "string",
  "blockDeviceMapping": [
    {
      "deviceName": "string",
      "ebs": {
        "attachTime": "string",
        "deleteOnTermination": true,
        "status": "string",
        "volumeId": "string"
      }
    }
  ],
  "clientToken": "string",
  "dnsName": "string",
  "ebsOptimized": true,
  "groupSet": [
    {
      "groupId": "string",
      "groupName": "string"
    }
  ],
  "hypervisor": "string",
  "iamInstanceProfile": {
    "arn": "string",
    "id": "string"
  },
  "imageId": "string",
  "instanceId": "string",
  "instanceLifecycle": "string",
  "instanceState": {
    "code": 0,
    "name": "string"
  },
  "instanceType": "string",
  "ipAddress": "string",
  "kernelId": "string",
  "keyName": "string",
  "launchTime": "string",
  "monitoring": {
    "state": "string"
  },
  "networkInterfaceSet": [
    {
      "association": {
        "ipOwnerId": "string",
        "publicDnsName": "string",
        "publicIp": "string"
      },
      "attachment": {
        "attachTime": "string",
        "attachmentId": "string",
        "deleteOnTermination": true,
        "deviceIndex": 0,
        "status": "string"
      },
      "description": "string",
      "groupSet": [
        {
          "groupId": "string",
          "groupName": "string"
        }
      ],
      "macAddress": "string",
      "networkInterfaceId": "string",
      "ownerId": "string",
      "privateDnsName": "string",
      "privateIpAddress": "string",
      "privateIpAddressesSet": [
        {
          "association": {
            "ipOwnerId": "string",
            "publicDnsName": "string",
            "publicIp": "string"
          },
          "primary": true,
          "privateDnsName": "string",
          "privateIpAddress": "string"
        }
      ],
      "sourceDestCheck": true,
      "status": "string",
      "subnetId": "string",
      "vpcId": "string"
    }
  ],
  "placement": {
    "availabilityZone": "string",
    "groupName": "string",
    "tenancy": "string"
  },
  "platform": "string",
  "privateDnsName": "string",
  "privateIpAddress": "string",
  "productCodes": [
    {
      "productCode": "string",
      "type": "string"
    }
  ],
  "ramdiskId": "string",
  "reason": "string",
  "rootDeviceName": "string",
  "rootDeviceType": "string",
  "sourceDestCheck": true,
  "spotInstanceRequestId": "string",
  "sriovNetSupport": "string",
  "stateReason": {
    "code": "string",
    "message": "string"
  },
  "subnetId": "string",
  "tagSet": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "virtualizationType": "string",
  "vpcId": "string"
}

instancesSet_1

One or more instances.

Properties

Name Type Required Restrictions Description
currentState currentState false none The current state of the instance.
instanceId string false none The ID of the instance.
previousState previousState false none The previous state of the instance.

Schema

{
  "currentState": {
    "code": 0,
    "name": "string"
  },
  "instanceId": "string",
  "previousState": {
    "code": 0,
    "name": "string"
  }
}

internetGateway

Information about the newly created Internet gateway.

Properties

Name Type Required Restrictions Description
attachmentSet [attachmentSet_1] false none One or more VPCs attached to the Internet gateway.
internetGatewayId string false none The ID of the Internet gateway.
tagSet [Tag] false none One or more tags associated with the Internet gateway.

Schema

{
  "attachmentSet": [
    {
      "state": "string",
      "vpcId": "string"
    }
  ],
  "internetGatewayId": "string",
  "tagSet": [
    {
      "Key": "string",
      "Value": "string"
    }
  ]
}

internetGatewaySet

Information about the newly created Internet gateway.

Properties

Name Type Required Restrictions Description
attachmentSet [attachmentSet_1] false none One or more VPCs attached to the Internet gateway.
internetGatewayId string false none The ID of the Internet gateway.
tagSet [tagSet_0] false none One or more tags associated with the Internet gateway.

Schema

{
  "attachmentSet": [
    {
      "state": "string",
      "vpcId": "string"
    }
  ],
  "internetGatewayId": "string",
  "tagSet": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}

ipPermissionsEgress

The outbound rules associated with the security group.

Properties

Name Type Required Restrictions Description
fromPort integer false none The beginning of the port range for TCP and UDP protocols, or an ICMP type number.
groups [groups_2] false none One or more security groups and account ID pairs.
ipProtocol string false none The IP protocol name (tcp, udp, icmp, or -1 for all protocols). By default, -1. In a VPC, this can also be an IP protocol number. For more information, see the IANA.org website.
ipRanges [ipRanges_1] false none One or more IP ranges.
prefixListIds [PrefixListIds_1] false none One or more prefix list IDs to allow traffic from a VPC to access the corresponding OUTSCALE services. For more information, see DescribePrefixLists.
toPort integer false none The end of the port range for TCP and UDP protocols, or an ICMP code number.

Schema

{
  "fromPort": 0,
  "groups": [
    {
      "groupId": "string",
      "groupName": "string",
      "userId": "string"
    }
  ],
  "ipProtocol": "string",
  "ipRanges": [
    {
      "cidrIp": "string"
    }
  ],
  "prefixListIds": [
    {
      "prefixListId": "string"
    }
  ],
  "toPort": 0
}

ipRanges_1

One or more IP ranges.

Properties

Name Type Required Restrictions Description
cidrIp string false none The range of IPs.

Schema

{
  "cidrIp": "string"
}

keySet

Information about one or more keypairs.

Properties

Name Type Required Restrictions Description
keyFingerprint string false none The MD5 public key fingerprint as specified in section 4 of RFC 4716.
keyName string false none The name of the keypair.

Schema

{
  "keyFingerprint": "string",
  "keyName": "string"
}

launchPermission_1

One or more launch permissions.

Properties

Name Type Required Restrictions Description
group string false none The name of the group (all if public).
userId string false none The account ID of the user.

Schema

{
  "group": "string",
  "userId": "string"
}

monitoring

The monitoring information for the instance.

Properties

Name Type Required Restrictions Description
state string false none The state of detail monitoring (enabled | disabled | disabling | pending).

Schema

{
  "state": "string"
}

natGateway

Information about the newly created NAT gateway.

Properties

Name Type Required Restrictions Description
createTime string false none The date and time when the NAT gateway was created.
deleteTime string false none The date and time when the NAT gateway was deleted, if applicable.
natGatewayAddressSet [natGatewayAddressSet] false none Information about the External IP (EIP) associated with the NAT gateway.
natGatewayId string false none The ID of the NAT gateway.
state string false none The state of the NAT gateway (pending | available | deleting | deleted).
subnetId string false none The ID of the public subnet in which the NAT gateway is.
tagSet [tagSet_0] false none One or more tags associated with the NAT gateway.
vpcId string false none The ID of the VPC in which the NAT gateway is.

Schema

{
  "createTime": "string",
  "deleteTime": "string",
  "natGatewayAddressSet": [
    {
      "allocationId": "string",
      "networkInterfaceId": "string",
      "privateIp": "string",
      "publicIp": "string"
    }
  ],
  "natGatewayId": "string",
  "state": "string",
  "subnetId": "string",
  "tagSet": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "vpcId": "string"
}

natGatewayAddressSet

Information about the External IP (EIP) associated with the NAT gateway.

Properties

Name Type Required Restrictions Description
allocationId string false none The allocation ID of the External IP (EIP) associated with the NAT gateway.
networkInterfaceId string false none The ID of the network interface associated with the NAT gateway.
privateIp string false none The private IP associated with the EIP.
publicIp string false none The EIP associated with the NAT gateway.

Schema

{
  "allocationId": "string",
  "networkInterfaceId": "string",
  "privateIp": "string",
  "publicIp": "string"
}

natGatewaySet

Information about one or more NAT gateways.

Properties

Name Type Required Restrictions Description
createTime string false none The date and time when the NAT gateway was created.
deleteTime string false none The date and time when the NAT gateway was deleted, if applicable.
natGatewayAddressSet [natGatewayAddressSet] false none Information about the External IP (EIP) associated with the NAT gateway.
natGatewayId string false none The ID of the NAT gateway.
state string false none The state of the NAT gateway (pending | available | deleting | deleted).
subnetId string false none The ID of the public subnet in which the NAT gateway is.
tagSet [tagSet_0] false none One or more tags associated with the NAT gateway.
vpcId string false none The ID of the VPC in which the NAT gateway is.

Schema

{
  "createTime": "string",
  "deleteTime": "string",
  "natGatewayAddressSet": [
    {
      "allocationId": "string",
      "networkInterfaceId": "string",
      "privateIp": "string",
      "publicIp": "string"
    }
  ],
  "natGatewayId": "string",
  "state": "string",
  "subnetId": "string",
  "tagSet": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "vpcId": "string"
}

networkInterfaceSet_0

In a VPC, one or more network interfaces for the instance.

Properties

Name Type Required Restrictions Description
association association_1 false none Information about an External IP associated with the interface.
attachment attachment_2 false none The attachment of the network interface.
description string false none The description of the network interface.
groupSet [groupSet] false none One or more security groups for the FNI.
macAddress string false none The MAC address of the interface.
networkInterfaceId string false none The ID of the network interface.
ownerId string false none The account ID of the owner of the instance reservation.
privateDnsName string false none The name of the private DNS assigned to the instance.
privateIpAddress string false none The private IP assigned to the instance.
privateIpAddressesSet [privateIpAddressesSet_1] false none The private IPs assigned to the network interface.
sourceDestCheck boolean false none If true in a VPC, the check to perform NAT is enabled.
status string false none The state of the interface.
subnetId string false none In a VPC, the ID of the subnet in which to launch the instance.
vpcId string false none The ID of the VPC in which the instance is launched.

Schema

{
  "association": {
    "ipOwnerId": "string",
    "publicDnsName": "string",
    "publicIp": "string"
  },
  "attachment": {
    "attachTime": "string",
    "attachmentId": "string",
    "deleteOnTermination": true,
    "deviceIndex": 0,
    "status": "string"
  },
  "description": "string",
  "groupSet": [
    {
      "groupId": "string",
      "groupName": "string"
    }
  ],
  "macAddress": "string",
  "networkInterfaceId": "string",
  "ownerId": "string",
  "privateDnsName": "string",
  "privateIpAddress": "string",
  "privateIpAddressesSet": [
    {
      "association": {
        "ipOwnerId": "string",
        "publicDnsName": "string",
        "publicIp": "string"
      },
      "primary": true,
      "privateDnsName": "string",
      "privateIpAddress": "string"
    }
  ],
  "sourceDestCheck": true,
  "status": "string",
  "subnetId": "string",
  "vpcId": "string"
}

networkInterfaceSet_1

Information about the FNIs.

Properties

Name Type Required Restrictions Description
association association_0 false none Information about the association between the FNI and an EIP.
attachment attachment_1 false none Information about the FNI attachment.
availabilityZone string false none The AZ where the FNI is located.
description string false none The description of the FNI.
groupSet [groupSet] false none One or more security groups for the FNI.
macAddress string false none The Media Access Control (MAC) address of the FNI.
networkInterfaceId string false none The ID of the FNI.
ownerId string false none The account ID of the FNI owner.
privateDnsName string false none The private DNS name associated with the primary private IP of the FNI.
privateIpAddress string false none The primary private IP of the FNI.
privateIpAddressesSet [privateIpAddressesSet_0] false none Information about the EIP and the private IPs assigned to the FNI.
sourceDestCheck boolean false none If true, the traffic to or from the instance is validated. If false, it is not.
status string false none The state of the FNI.
subnetId string false none The ID of the subnet where the FNI is located.
tagSet [tagSet_0] false none One or more tags associated with the FNI.
vpcId string false none The ID of the VPC where the FNI is located.

Schema

{
  "association": {
    "allocationId": "string",
    "associationId": "string",
    "ipOwnerId": "string",
    "publicDnsName": "string",
    "publicIp": "string"
  },
  "attachment": {
    "attachTime": "string",
    "attachmentId": "string",
    "deleteOnTermination": true,
    "deviceIndex": 0,
    "instanceId": "string",
    "instanceOwnerId": "string",
    "status": "string"
  },
  "availabilityZone": "string",
  "description": "string",
  "groupSet": [
    {
      "groupId": "string",
      "groupName": "string"
    }
  ],
  "macAddress": "string",
  "networkInterfaceId": "string",
  "ownerId": "string",
  "privateDnsName": "string",
  "privateIpAddress": "string",
  "privateIpAddressesSet": [
    {
      "association": {
        "allocationId": "string",
        "associationId": "string",
        "ipOwnerId": "string",
        "publicDnsName": "string",
        "publicIp": "string"
      },
      "primary": true,
      "privateDnsName": "string",
      "privateIpAddress": "string"
    }
  ],
  "sourceDestCheck": true,
  "status": "string",
  "subnetId": "string",
  "tagSet": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "vpcId": "string"
}

prefixListSet

Information about one or more prefix lists.

Properties

Name Type Required Restrictions Description
cidrSet [string] false none The list of network prefixes