You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: osc/README.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -10,8 +10,8 @@ An OpenAPI description of the OUTSCALE API is also available in this [GitHub rep
10
10
## Overview
11
11
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client.
The modifications are effective at virtual machine (VM) level as quickly as possible, but a small delay may occur.<br /><br />
908
+
Adds one or more rules to a security group.<br />
909
+
Use the `SecurityGroupId` parameter to specify the security group for which you want to create a rule.<br />
910
+
Use the `Flow` parameter to specify if you want an inbound rule or an outbound rule.<br /><br />
911
+
An inbound rule allows the security group to receive traffic:
912
+
* Either from a specific IP range (`IpRange` parameter) on a specific port range (`FromPortRange` and `ToPortRange` parameters) and specific protocol (`IpProtocol` parameter).
913
+
* Or from another specific security group (`SecurityGroupAccountIdToLink` and `SecurityGroupNameToLink` parameters).<br />
910
914
911
-
You can add one or more egress rules to a security group for use with a Net.<br />
912
-
It allows VMs to send traffic to either one or more destination IP ranges or destination security groups for the same Net.<br />
913
-
We recommend using a set of IP permissions to authorize outbound access to a destination security group. We also recommended this method to create a rule with a specific IP protocol and a specific port range. In a set of IP permissions, we recommend to specify the the protocol.<br /><br />
915
+
(Net only) An outbound rule works similarly but allows the security group to send traffic rather than receive traffic.<br />
914
916
915
-
You can also add one or more ingress rules to a security group.<br />
916
-
In the public Cloud, this action allows one or more 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.<br />
917
-
In a Net, this action allows one or more IP ranges to access a security group for your Net, or allows one or more other security groups (source groups) to access a security group for your Net. All the security groups must be for the same Net.<br /><br />
917
+
Alternatively, you can use the `Rules` parameter to add several rules at the same time.
918
918
919
919
**[NOTE]**<br />
920
-
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: [email protected].
920
+
* The modifications are effective as quickly as possible, but a small delay may occur.<br />
921
+
* By default, traffic between two security groups is allowed through both public and private IPs. To restrict traffic to private IPs only, contact our Support team at [email protected].
921
922
post:
922
923
operationId: CreateSecurityGroupRule
923
924
requestBody:
@@ -4812,8 +4813,9 @@ paths:
4812
4813
- FlexibleGpu
4813
4814
/UpdateImage:
4814
4815
description: |-
4815
-
Modifies the specified attribute of an OUTSCALE machine image (OMI).<br />
4816
-
You can specify only one attribute at a time. 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 [CreateImage](#createimage).
4816
+
Modifies the access permissions for an OUTSCALE machine image (OMI).<br />
4817
+
You must specify either the `Additions` or the `Removals` parameter.<br />
4818
+
After sharing an OMI with an account, the other account can create a copy of it that they own. For more information about copying OMIs, see [CreateImage](#createimage).
4817
4819
post:
4818
4820
operationId: UpdateImage
4819
4821
requestBody:
@@ -5073,7 +5075,8 @@ paths:
5073
5075
/UpdateSnapshot:
5074
5076
description: |-
5075
5077
Modifies the permissions for a specified snapshot.<br />
5076
-
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.
5078
+
You must specify either the `Additions` or the `Removals` parameter.<br />
5079
+
After sharing a snapshot with an account, the other account can create a copy of it that they own. For more information about copying snapshots, see [CreateSnapshot](#createsnapshot).
5077
5080
post:
5078
5081
operationId: UpdateSnapshot
5079
5082
requestBody:
@@ -5188,7 +5191,8 @@ paths:
5188
5191
- Vm
5189
5192
/UpdateVolume:
5190
5193
description: |-
5191
-
Modifies the specified attributes of a volume. Cold volumes are volumes that are attached to stopped VMs or that are detached. Hot volumes are volumes that are attached to running VMs.<br /><br />
5194
+
Modifies the specified attributes of a volume.<br />
5195
+
Cold volumes are volumes that are attached to stopped or stopping VMs, or that are detached. Hot volumes are volumes that are attached to running VMs.<br /><br />
5192
5196
5193
5197
**[NOTE]**<br />
5194
5198
When the modification is not instantaneous, the response displays the previous value. You can use the [ReadVolumes](#readvolumes) method to see the new value.
@@ -7973,16 +7977,16 @@ components:
7973
7977
$ref: '#/components/schemas/SecurityGroupRule'
7974
7978
type: array
7975
7979
SecurityGroupAccountIdToLink:
7976
-
description: The account ID of the owner of the security group for which
7977
-
you want to create a rule.
7980
+
description: The account ID that owns the source or destination security
7981
+
group specified in the `SecurityGroupNameToLink` parameter.
7978
7982
type: string
7979
7983
SecurityGroupId:
7980
7984
description: The ID of the security group for which you want to create a
7981
7985
rule.
7982
7986
type: string
7983
7987
SecurityGroupNameToLink:
7984
-
description: The ID of the source security group. If you are in the Public
7985
-
Cloud, you can also specify the name of the source security group.
7988
+
description: The ID of a source or destination security group that you want
7989
+
to link to the security group of the rule.
7986
7990
type: string
7987
7991
ToPortRange:
7988
7992
description: The end of the port range for the TCP and UDP protocols, or
@@ -10541,7 +10545,8 @@ components:
10541
10545
properties:
10542
10546
BgpAsn:
10543
10547
description: The BGP (Border Gateway Protocol) ASN (Autonomous System Number)
10544
-
on the customer's side of the DirectLink interface.
10548
+
on the customer's side of the DirectLink interface. This number must be
10549
+
between `64512` and `65534`.
10545
10550
type: integer
10546
10551
BgpKey:
10547
10552
description: The BGP authentication key.
@@ -10616,7 +10621,7 @@ components:
10616
10621
type: string
10617
10622
Mtu:
10618
10623
description: The maximum transmission unit (MTU) of the DirectLink interface,
10619
-
in bytes (by default, `1500`).
10624
+
in bytes (always `1500`).
10620
10625
type: integer
10621
10626
OutscalePrivateIp:
10622
10627
description: The IP on the OUTSCALE side of the DirectLink interface.
@@ -15011,27 +15016,30 @@ components:
15011
15016
type: object
15012
15017
PermissionsOnResource:
15013
15018
additionalProperties: false
15014
-
description: Information about the users who have permissions for the resource.
15019
+
description: Permissions for the resource.
15015
15020
example:
15016
15021
AccountIds:
15017
15022
- AccountIds
15018
15023
- AccountIds
15019
15024
GlobalPermission: true
15020
15025
properties:
15021
15026
AccountIds:
15022
-
description: The account ID of one or more users who have permissions for
15023
-
the resource.
15027
+
description: One or more account IDs that the permission is associated with.
15024
15028
items:
15025
15029
type: string
15026
15030
type: array
15027
15031
GlobalPermission:
15028
-
description: If true, the resource is public. If false, the resource is
15029
-
private.
15032
+
description: |-
15033
+
A global permission for all accounts.<br />
15034
+
(Request) Set this parameter to true to make the resource public (if the parent parameter is `Additions`) or to make the resource private (if the parent parameter is `Removals`).<br />
15035
+
(Response) If true, the resource is public. If false, the resource is private.
15030
15036
type: boolean
15031
15037
type: object
15032
15038
PermissionsOnResourceCreation:
15033
15039
additionalProperties: false
15034
-
description: Information about the permissions for the resource.
15040
+
description: |-
15041
+
Information about the permissions for the resource.<br />
15042
+
Specify either the `Additions` or the `Removals` parameter.
15035
15043
example:
15036
15044
Additions:
15037
15045
AccountIds:
@@ -19953,7 +19961,8 @@ components:
19953
19961
type: string
19954
19962
type: array
19955
19963
SecurityGroupsMembers:
19956
-
description: Information about one or more members of a security group.
19964
+
description: Information about one or more source or destination security
19965
+
groups.
19957
19966
items:
19958
19967
$ref: '#/components/schemas/SecurityGroupsMember'
19959
19968
type: array
@@ -19970,20 +19979,23 @@ components:
19970
19979
type: object
19971
19980
SecurityGroupsMember:
19972
19981
additionalProperties: false
19973
-
description: Information about the member of a security group.
19982
+
description: Information about a source or destination security group.
19974
19983
example:
19975
19984
AccountId: AccountId
19976
19985
SecurityGroupName: SecurityGroupName
19977
19986
SecurityGroupId: SecurityGroupId
19978
19987
properties:
19979
19988
AccountId:
19980
-
description: The account ID of a user.
19989
+
description: The account ID that owns the source or destination security
19990
+
group.
19981
19991
type: string
19982
19992
SecurityGroupId:
19983
-
description: The ID of the security group.
19993
+
description: The ID of a source or destination security group that you want
19994
+
to link to the security group of the rule.
19984
19995
type: string
19985
19996
SecurityGroupName:
19986
-
description: The name of the security group.
19997
+
description: (Public Cloud only) The name of a source or destination security
19998
+
group that you want to link to the security group of the rule.
19987
19999
type: string
19988
20000
type: object
19989
20001
SendResetPasswordEmailRequest:
@@ -20978,7 +20990,7 @@ components:
20978
20990
type: boolean
20979
20991
Mtu:
20980
20992
description: The maximum transmission unit (MTU) of the DirectLink interface,
20981
-
in bytes (either `1500` or `9000`).
20993
+
in bytes (always `1500`).
20982
20994
enum:
20983
20995
- 1500
20984
20996
- 9000
@@ -21934,8 +21946,8 @@ components:
21934
21946
type: boolean
21935
21947
KeypairName:
21936
21948
description: |-
21937
-
The name of the keypair.<br />
21938
-
To complete the replacement, manually replace the old public key with the new public key in the ~/.ssh/authorized_keys file located in the VM. Restart the VM to apply the change.
21949
+
The name of a keypair you want to associate with the VM.<br />
21950
+
When you replace the keypair of a VM with another one, the metadata of the VM is modified to reflect the new public key, but the replacement is still not effective in the operating system of the VM. To complete the replacement and effectively apply the new keypair, you need to perform other actions inside the VM. For more information, see [Modifying the Keypair of an Instance](https://docs.outscale.com/en/userguide/Modifying-the-Keypair-of-an-Instance.html).
21939
21951
type: string
21940
21952
NestedVirtualization:
21941
21953
description: (dedicated tenancy only) If true, nested virtualization is
Copy file name to clipboardexpand all lines: osc/api_access_key.go
+1-1
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@
3
3
*
4
4
* Welcome to the OUTSCALE API documentation.<br /> The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.<br /><br /> You can learn more about errors returned by the API in the dedicated [errors page](api/errors).<br /><br /> Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.<br /> You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.<br /><br /> An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
Copy file name to clipboardexpand all lines: osc/api_account.go
+1-1
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@
3
3
*
4
4
* Welcome to the OUTSCALE API documentation.<br /> The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.<br /><br /> You can learn more about errors returned by the API in the dedicated [errors page](api/errors).<br /><br /> Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.<br /> You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.<br /><br /> An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
Copy file name to clipboardexpand all lines: osc/api_api_access_policy.go
+1-1
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@
3
3
*
4
4
* Welcome to the OUTSCALE API documentation.<br /> The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.<br /><br /> You can learn more about errors returned by the API in the dedicated [errors page](api/errors).<br /><br /> Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.<br /> You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.<br /><br /> An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
Copy file name to clipboardexpand all lines: osc/api_api_access_rule.go
+1-1
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@
3
3
*
4
4
* Welcome to the OUTSCALE API documentation.<br /> The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.<br /><br /> You can learn more about errors returned by the API in the dedicated [errors page](api/errors).<br /><br /> Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.<br /> You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.<br /><br /> An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
Copy file name to clipboardexpand all lines: osc/api_api_log.go
+1-1
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@
3
3
*
4
4
* Welcome to the OUTSCALE API documentation.<br /> The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.<br /><br /> You can learn more about errors returned by the API in the dedicated [errors page](api/errors).<br /><br /> Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.<br /> You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.<br /><br /> An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
Copy file name to clipboardexpand all lines: osc/api_ca.go
+1-1
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@
3
3
*
4
4
* Welcome to the OUTSCALE API documentation.<br /> The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.<br /><br /> You can learn more about errors returned by the API in the dedicated [errors page](api/errors).<br /><br /> Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.<br /> You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.<br /><br /> An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
Copy file name to clipboardexpand all lines: osc/api_catalog.go
+1-1
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@
3
3
*
4
4
* Welcome to the OUTSCALE API documentation.<br /> The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.<br /><br /> You can learn more about errors returned by the API in the dedicated [errors page](api/errors).<br /><br /> Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.<br /> You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.<br /><br /> An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
0 commit comments